bc96c830f9693f69b4f71c46848fbb1e410cb115
1 #
2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
3 # This module is free software, and you may redistribute it and/or modify
4 # under the same terms as Python, so long as this copyright message and
5 # disclaimer are retained in their original form.
6 #
7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
10 # POSSIBILITY OF SUCH DAMAGE.
11 #
12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
17 #
18 # $Id: date.py,v 1.17 2002-01-16 07:02:57 richard Exp $
20 __doc__ = """
21 Date, time and time interval handling.
22 """
24 import time, re, calendar
25 from i18n import _
27 class Date:
28 '''
29 As strings, date-and-time stamps are specified with the date in
30 international standard format (yyyy-mm-dd) joined to the time
31 (hh:mm:ss) by a period ("."). Dates in this form can be easily compared
32 and are fairly readable when printed. An example of a valid stamp is
33 "2000-06-24.13:03:59". We'll call this the "full date format". When
34 Timestamp objects are printed as strings, they appear in the full date
35 format with the time always given in GMT. The full date format is
36 always exactly 19 characters long.
38 For user input, some partial forms are also permitted: the whole time
39 or just the seconds may be omitted; and the whole date may be omitted
40 or just the year may be omitted. If the time is given, the time is
41 interpreted in the user's local time zone. The Date constructor takes
42 care of these conversions. In the following examples, suppose that yyyy
43 is the current year, mm is the current month, and dd is the current day
44 of the month; and suppose that the user is on Eastern Standard Time.
46 "2000-04-17" means <Date 2000-04-17.00:00:00>
47 "01-25" means <Date yyyy-01-25.00:00:00>
48 "2000-04-17.03:45" means <Date 2000-04-17.08:45:00>
49 "08-13.22:13" means <Date yyyy-08-14.03:13:00>
50 "11-07.09:32:43" means <Date yyyy-11-07.14:32:43>
51 "14:25" means <Date yyyy-mm-dd.19:25:00>
52 "8:47:11" means <Date yyyy-mm-dd.13:47:11>
53 "." means "right now"
55 The Date class should understand simple date expressions of the form
56 stamp + interval and stamp - interval. When adding or subtracting
57 intervals involving months or years, the components are handled
58 separately. For example, when evaluating "2000-06-25 + 1m 10d", we
59 first add one month to get 2000-07-25, then add 10 days to get
60 2000-08-04 (rather than trying to decide whether 1m 10d means 38 or 40
61 or 41 days).
63 Example usage:
64 >>> Date(".")
65 <Date 2000-06-26.00:34:02>
66 >>> _.local(-5)
67 "2000-06-25.19:34:02"
68 >>> Date(". + 2d")
69 <Date 2000-06-28.00:34:02>
70 >>> Date("1997-04-17", -5)
71 <Date 1997-04-17.00:00:00>
72 >>> Date("01-25", -5)
73 <Date 2000-01-25.00:00:00>
74 >>> Date("08-13.22:13", -5)
75 <Date 2000-08-14.03:13:00>
76 >>> Date("14:25", -5)
77 <Date 2000-06-25.19:25:00>
78 '''
79 def __init__(self, spec='.', offset=0):
80 """Construct a date given a specification and a time zone offset.
82 'spec' is a full date or a partial form, with an optional
83 added or subtracted interval. Or a date 9-tuple.
84 'offset' is the local time zone offset from GMT in hours.
85 """
86 if type(spec) == type(''):
87 self.set(spec, offset=offset)
88 else:
89 y,m,d,H,M,S,x,x,x = spec
90 ts = calendar.timegm((y,m,d,H+offset,M,S,0,0,0))
91 self.year, self.month, self.day, self.hour, self.minute, \
92 self.second, x, x, x = time.gmtime(ts)
94 def applyInterval(self, interval):
95 ''' Apply the interval to this date
96 '''
97 t = (self.year + interval.year,
98 self.month + interval.month,
99 self.day + interval.day,
100 self.hour + interval.hour,
101 self.minute + interval.minute,
102 self.second + interval.second, 0, 0, 0)
103 self.year, self.month, self.day, self.hour, self.minute, \
104 self.second, x, x, x = time.gmtime(calendar.timegm(t))
106 def __add__(self, other):
107 """Add an interval to this date to produce another date."""
108 t = (self.year + other.sign * other.year,
109 self.month + other.sign * other.month,
110 self.day + other.sign * other.day,
111 self.hour + other.sign * other.hour,
112 self.minute + other.sign * other.minute,
113 self.second + other.sign * other.second, 0, 0, 0)
114 return Date(time.gmtime(calendar.timegm(t)))
116 # XXX deviates from spec to allow subtraction of dates as well
117 def __sub__(self, other):
118 """ Subtract:
119 1. an interval from this date to produce another date.
120 2. a date from this date to produce an interval.
121 """
122 if isinstance(other, Date):
123 # TODO this code will fall over laughing if the dates cross
124 # leap years, phases of the moon, ....
125 a = calendar.timegm((self.year, self.month, self.day, self.hour,
126 self.minute, self.second, 0, 0, 0))
127 b = calendar.timegm((other.year, other.month, other.day, other.hour,
128 other.minute, other.second, 0, 0, 0))
129 diff = a - b
130 if diff < 0:
131 sign = -1
132 diff = -diff
133 else:
134 sign = 1
135 S = diff%60
136 M = (diff/60)%60
137 H = (diff/(60*60))%60
138 if H>1: S = 0
139 d = (diff/(24*60*60))%30
140 if d>1: H = S = M = 0
141 m = (diff/(30*24*60*60))%12
142 if m>1: H = S = M = 0
143 y = (diff/(365*24*60*60))
144 if y>1: d = H = S = M = 0
145 return Interval((y, m, d, H, M, S), sign=sign)
146 t = (self.year - other.sign * other.year,
147 self.month - other.sign * other.month,
148 self.day - other.sign * other.day,
149 self.hour - other.sign * other.hour,
150 self.minute - other.sign * other.minute,
151 self.second - other.sign * other.second, 0, 0, 0)
152 return Date(time.gmtime(calendar.timegm(t)))
154 def __cmp__(self, other):
155 """Compare this date to another date."""
156 if other is None:
157 return 1
158 for attr in ('year', 'month', 'day', 'hour', 'minute', 'second'):
159 r = cmp(getattr(self, attr), getattr(other, attr))
160 if r: return r
161 return 0
163 def __str__(self):
164 """Return this date as a string in the yyyy-mm-dd.hh:mm:ss format."""
165 return '%4d-%02d-%02d.%02d:%02d:%02d'%(self.year, self.month, self.day,
166 self.hour, self.minute, self.second)
168 def pretty(self):
169 ''' print up the date date using a pretty format...
170 '''
171 return time.strftime('%e %B %Y', (self.year, self.month,
172 self.day, self.hour, self.minute, self.second, 0, 0, 0))
174 def set(self, spec, offset=0, date_re=re.compile(r'''
175 (((?P<y>\d\d\d\d)-)?((?P<m>\d\d?)-(?P<d>\d\d?))?)? # yyyy-mm-dd
176 (?P<n>\.)? # .
177 (((?P<H>\d?\d):(?P<M>\d\d))?(:(?P<S>\d\d))?)? # hh:mm:ss
178 (?P<o>.+)? # offset
179 ''', re.VERBOSE)):
180 ''' set the date to the value in spec
181 '''
182 m = date_re.match(spec)
183 if not m:
184 raise ValueError, _('Not a date spec: [[yyyy-]mm-dd].[[h]h:mm[:ss]]'
185 '[offset]')
186 info = m.groupdict()
188 # get the current date/time using the offset
189 y,m,d,H,M,S,x,x,x = time.gmtime(time.time())
191 # override year, month, day parts
192 if info['m'] is not None and info['d'] is not None:
193 m = int(info['m'])
194 d = int(info['d'])
195 if info['y'] is not None: y = int(info['y'])
196 H = M = S = 0
198 # override hour, minute, second parts
199 if info['H'] is not None and info['M'] is not None:
200 H = int(info['H']) - offset
201 M = int(info['M'])
202 S = 0
203 if info['S'] is not None: S = int(info['S'])
205 # now handle the adjustment of hour
206 ts = calendar.timegm((y,m,d,H,M,S,0,0,0))
207 self.year, self.month, self.day, self.hour, self.minute, \
208 self.second, x, x, x = time.gmtime(ts)
210 if info['o']:
211 self.applyInterval(Interval(info['o']))
213 def __repr__(self):
214 return '<Date %s>'%self.__str__()
216 def local(self, offset):
217 """Return this date as yyyy-mm-dd.hh:mm:ss in a local time zone."""
218 t = (self.year, self.month, self.day, self.hour + offset, self.minute,
219 self.second, 0, 0, 0)
220 self.year, self.month, self.day, self.hour, self.minute, \
221 self.second, x, x, x = time.gmtime(calendar.timegm(t))
223 def get_tuple(self):
224 return (self.year, self.month, self.day, self.hour, self.minute,
225 self.second, 0, 0, 0)
227 class Interval:
228 '''
229 Date intervals are specified using the suffixes "y", "m", and "d". The
230 suffix "w" (for "week") means 7 days. Time intervals are specified in
231 hh:mm:ss format (the seconds may be omitted, but the hours and minutes
232 may not).
234 "3y" means three years
235 "2y 1m" means two years and one month
236 "1m 25d" means one month and 25 days
237 "2w 3d" means two weeks and three days
238 "1d 2:50" means one day, two hours, and 50 minutes
239 "14:00" means 14 hours
240 "0:04:33" means four minutes and 33 seconds
242 Example usage:
243 >>> Interval(" 3w 1 d 2:00")
244 <Interval 22d 2:00>
245 >>> Date(". + 2d") - Interval("3w")
246 <Date 2000-06-07.00:34:02>
247 '''
248 def __init__(self, spec, sign=1):
249 """Construct an interval given a specification."""
250 if type(spec) == type(''):
251 self.set(spec)
252 else:
253 self.sign = sign
254 self.year, self.month, self.day, self.hour, self.minute, \
255 self.second = spec
257 def __cmp__(self, other):
258 """Compare this interval to another interval."""
259 if other is None:
260 return 1
261 for attr in ('year', 'month', 'day', 'hour', 'minute', 'second'):
262 r = cmp(getattr(self, attr), getattr(other, attr))
263 if r: return r
264 return 0
266 def __str__(self):
267 """Return this interval as a string."""
268 sign = {1:'+', -1:'-'}[self.sign]
269 l = [sign]
270 if self.year: l.append('%sy'%self.year)
271 if self.month: l.append('%sm'%self.month)
272 if self.day: l.append('%sd'%self.day)
273 if self.second:
274 l.append('%d:%02d:%02d'%(self.hour, self.minute, self.second))
275 elif self.hour or self.minute:
276 l.append('%d:%02d'%(self.hour, self.minute))
277 return ' '.join(l)
279 def set(self, spec, interval_re = re.compile('''
280 \s*
281 (?P<s>[-+])? # + or -
282 \s*
283 ((?P<y>\d+\s*)y)? # year
284 \s*
285 ((?P<m>\d+\s*)m)? # month
286 \s*
287 ((?P<w>\d+\s*)w)? # week
288 \s*
289 ((?P<d>\d+\s*)d)? # day
290 \s*
291 (((?P<H>\d?\d):(?P<M>\d\d))?(:(?P<S>\d\d))?)? # time
292 \s*
293 ''', re.VERBOSE)):
294 ''' set the date to the value in spec
295 '''
296 self.year = self.month = self.week = self.day = self.hour = \
297 self.minute = self.second = 0
298 self.sign = 1
299 m = interval_re.match(spec)
300 if not m:
301 raise ValueError, _('Not an interval spec: [+-] [#y] [#m] [#w] '
302 '[#d] [[[H]H:MM]:SS]')
304 info = m.groupdict()
305 for group, attr in {'y':'year', 'm':'month', 'w':'week', 'd':'day',
306 'H':'hour', 'M':'minute', 'S':'second'}.items():
307 if info[group] is not None:
308 setattr(self, attr, int(info[group]))
310 if self.week:
311 self.day = self.day + self.week*7
313 if info['s'] is not None:
314 self.sign = {'+':1, '-':-1}[info['s']]
316 def __repr__(self):
317 return '<Interval %s>'%self.__str__()
319 def pretty(self):
320 ''' print up the date date using one of these nice formats..
321 '''
322 if self.year or self.month > 2:
323 return None
324 if self.month or self.day > 13:
325 days = (self.month * 30) + self.day
326 if days > 28:
327 if int(days/30) > 1:
328 return _('%(number)s months')%{'number': int(days/30)}
329 else:
330 return _('1 month')
331 else:
332 return _('%(number)s weeks')%{'number': int(days/7)}
333 if self.day > 7:
334 return _('1 week')
335 if self.day > 1:
336 return _('%(number)s days')%{'number': self.day}
337 if self.day == 1 or self.hour > 12:
338 return _('yesterday')
339 if self.hour > 1:
340 return _('%(number)s hours')%{'number': self.hour}
341 if self.hour == 1:
342 if self.minute < 15:
343 return _('an hour')
344 quart = self.minute/15
345 if quart == 2:
346 return _('1 1/2 hours')
347 return _('1 %(number)s/4 hours')%{'number': quart}
348 if self.minute < 1:
349 return _('just now')
350 if self.minute == 1:
351 return _('1 minute')
352 if self.minute < 15:
353 return _('%(number)s minutes')%{'number': self.minute}
354 quart = int(self.minute/15)
355 if quart == 2:
356 return _('1/2 an hour')
357 return _('%(number)s/4 hour')%{'number': quart}
359 def get_tuple(self):
360 return (self.year, self.month, self.day, self.hour, self.minute,
361 self.second)
364 def test():
365 intervals = (" 3w 1 d 2:00", " + 2d", "3w")
366 for interval in intervals:
367 print '>>> Interval("%s")'%interval
368 print `Interval(interval)`
370 dates = (".", "2000-06-25.19:34:02", ". + 2d", "1997-04-17", "01-25",
371 "08-13.22:13", "14:25")
372 for date in dates:
373 print '>>> Date("%s")'%date
374 print `Date(date)`
376 sums = ((". + 2d", "3w"), (".", " 3w 1 d 2:00"))
377 for date, interval in sums:
378 print '>>> Date("%s") + Interval("%s")'%(date, interval)
379 print `Date(date) + Interval(interval)`
381 if __name__ == '__main__':
382 test()
384 #
385 # $Log: not supported by cvs2svn $
386 # Revision 1.16 2002/01/08 11:56:24 richard
387 # missed an import _
388 #
389 # Revision 1.15 2002/01/05 02:27:00 richard
390 # I18N'ification
391 #
392 # Revision 1.14 2001/11/22 15:46:42 jhermann
393 # Added module docstrings to all modules.
394 #
395 # Revision 1.13 2001/09/18 22:58:37 richard
396 #
397 # Added some more help to roundu-admin
398 #
399 # Revision 1.12 2001/08/17 03:08:11 richard
400 # fixed prettification of intervals of 1 week
401 #
402 # Revision 1.11 2001/08/15 23:43:18 richard
403 # Fixed some isFooTypes that I missed.
404 # Refactored some code in the CGI code.
405 #
406 # Revision 1.10 2001/08/07 00:24:42 richard
407 # stupid typo
408 #
409 # Revision 1.9 2001/08/07 00:15:51 richard
410 # Added the copyright/license notice to (nearly) all files at request of
411 # Bizar Software.
412 #
413 # Revision 1.8 2001/08/05 07:46:12 richard
414 # Changed date.Date to use regular string formatting instead of strftime -
415 # win32 seems to have problems with %T and no hour... or something...
416 #
417 # Revision 1.7 2001/08/02 00:27:04 richard
418 # Extended the range of intervals that are pretty-printed before actual dates
419 # are displayed.
420 #
421 # Revision 1.6 2001/07/31 09:54:18 richard
422 # Fixed the 2.1-specific gmtime() (no arg) call in roundup.date. (Paul Wright)
423 #
424 # Revision 1.5 2001/07/29 07:01:39 richard
425 # Added vim command to all source so that we don't get no steenkin' tabs :)
426 #
427 # Revision 1.4 2001/07/25 04:09:34 richard
428 # Fixed offset handling (shoulda read the spec a little better)
429 #
430 # Revision 1.3 2001/07/23 07:56:05 richard
431 # Storing only marshallable data in the db - no nasty pickled class references.
432 #
433 # Revision 1.2 2001/07/22 12:09:32 richard
434 # Final commit of Grande Splite
435 #
436 # Revision 1.1 2001/07/22 11:58:35 richard
437 # More Grande Splite
438 #
439 #
440 # vim: set filetype=python ts=4 sw=4 et si