Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 1 | """Calendar printing functions |
| 2 | |
| 3 | Note when comparing these calendars to the ones printed by cal(1): By |
| 4 | default, these calendars have Monday as the first day of the week, and |
| 5 | Sunday as the last (the European convention). Use setfirstweekday() to |
| 6 | set the first day of the week (0=Monday, 6=Sunday).""" |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 7 | |
Raymond Hettinger | e11b510 | 2002-12-25 16:37:19 +0000 | [diff] [blame] | 8 | import datetime |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 9 | |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 10 | __all__ = ["error","setfirstweekday","firstweekday","isleap", |
| 11 | "leapdays","weekday","monthrange","monthcalendar", |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 12 | "prmonth","month","prcal","calendar","timegm", |
| 13 | "month_name", "month_abbr", "day_name", "day_abbr"] |
Skip Montanaro | e99d5ea | 2001-01-20 19:54:20 +0000 | [diff] [blame] | 14 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 15 | # Exception raised for bad input (with string parameter for details) |
Guido van Rossum | 00245cf | 1999-05-03 18:07:40 +0000 | [diff] [blame] | 16 | error = ValueError |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 17 | |
Guido van Rossum | 9b3bc71 | 1993-06-20 21:02:22 +0000 | [diff] [blame] | 18 | # Constants for months referenced later |
| 19 | January = 1 |
| 20 | February = 2 |
| 21 | |
| 22 | # Number of days per month (except for February in leap years) |
| 23 | mdays = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31] |
| 24 | |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 25 | # This module used to have hard-coded lists of day and month names, as |
| 26 | # English strings. The classes following emulate a read-only version of |
| 27 | # that, but supply localized names. Note that the values are computed |
| 28 | # fresh on each call, in case the user changes locale between calls. |
| 29 | |
Raymond Hettinger | 9c051d7 | 2002-06-20 03:38:12 +0000 | [diff] [blame] | 30 | class _localized_month: |
Tim Peters | bbc0d44 | 2004-11-13 16:18:32 +0000 | [diff] [blame] | 31 | |
| 32 | _months = [datetime.date(2001, i+1, 1).strftime for i in range(12)] |
| 33 | _months.insert(0, lambda x: "") |
| 34 | |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 35 | def __init__(self, format): |
Barry Warsaw | 1d09910 | 2001-05-22 15:58:30 +0000 | [diff] [blame] | 36 | self.format = format |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 37 | |
| 38 | def __getitem__(self, i): |
Tim Peters | bbc0d44 | 2004-11-13 16:18:32 +0000 | [diff] [blame] | 39 | funcs = self._months[i] |
| 40 | if isinstance(i, slice): |
| 41 | return [f(self.format) for f in funcs] |
| 42 | else: |
| 43 | return funcs(self.format) |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 44 | |
Skip Montanaro | 4c83495 | 2002-03-15 04:08:38 +0000 | [diff] [blame] | 45 | def __len__(self): |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 46 | return 13 |
| 47 | |
Raymond Hettinger | 9c051d7 | 2002-06-20 03:38:12 +0000 | [diff] [blame] | 48 | class _localized_day: |
Tim Peters | bbc0d44 | 2004-11-13 16:18:32 +0000 | [diff] [blame] | 49 | |
| 50 | # January 1, 2001, was a Monday. |
| 51 | _days = [datetime.date(2001, 1, i+1).strftime for i in range(7)] |
| 52 | |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 53 | def __init__(self, format): |
| 54 | self.format = format |
| 55 | |
| 56 | def __getitem__(self, i): |
Tim Peters | bbc0d44 | 2004-11-13 16:18:32 +0000 | [diff] [blame] | 57 | funcs = self._days[i] |
| 58 | if isinstance(i, slice): |
| 59 | return [f(self.format) for f in funcs] |
| 60 | else: |
| 61 | return funcs(self.format) |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 62 | |
Neal Norwitz | 492faa5 | 2004-06-07 03:47:06 +0000 | [diff] [blame] | 63 | def __len__(self): |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 64 | return 7 |
Barry Warsaw | 1d09910 | 2001-05-22 15:58:30 +0000 | [diff] [blame] | 65 | |
Guido van Rossum | 9b3bc71 | 1993-06-20 21:02:22 +0000 | [diff] [blame] | 66 | # Full and abbreviated names of weekdays |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 67 | day_name = _localized_day('%A') |
| 68 | day_abbr = _localized_day('%a') |
Guido van Rossum | 9b3bc71 | 1993-06-20 21:02:22 +0000 | [diff] [blame] | 69 | |
Guido van Rossum | 5cfa5df | 1993-06-23 09:30:50 +0000 | [diff] [blame] | 70 | # Full and abbreviated names of months (1-based arrays!!!) |
Tim Peters | 0c2c8e7 | 2002-03-23 03:26:53 +0000 | [diff] [blame] | 71 | month_name = _localized_month('%B') |
| 72 | month_abbr = _localized_month('%b') |
Guido van Rossum | 9b3bc71 | 1993-06-20 21:02:22 +0000 | [diff] [blame] | 73 | |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 74 | # Constants for weekdays |
| 75 | (MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY) = range(7) |
| 76 | |
| 77 | _firstweekday = 0 # 0 = Monday, 6 = Sunday |
| 78 | |
| 79 | def firstweekday(): |
| 80 | return _firstweekday |
| 81 | |
| 82 | def setfirstweekday(weekday): |
| 83 | """Set weekday (Monday=0, Sunday=6) to start each week.""" |
| 84 | global _firstweekday |
| 85 | if not MONDAY <= weekday <= SUNDAY: |
| 86 | raise ValueError, \ |
| 87 | 'bad weekday number; must be 0 (Monday) to 6 (Sunday)' |
| 88 | _firstweekday = weekday |
| 89 | |
Guido van Rossum | 9b3bc71 | 1993-06-20 21:02:22 +0000 | [diff] [blame] | 90 | def isleap(year): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 91 | """Return 1 for leap years, 0 for non-leap years.""" |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 92 | return year % 4 == 0 and (year % 100 != 0 or year % 400 == 0) |
Guido van Rossum | 9b3bc71 | 1993-06-20 21:02:22 +0000 | [diff] [blame] | 93 | |
Guido van Rossum | 9b3bc71 | 1993-06-20 21:02:22 +0000 | [diff] [blame] | 94 | def leapdays(y1, y2): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 95 | """Return number of leap years in range [y1, y2). |
Guido van Rossum | 46735ad | 2000-10-09 12:42:04 +0000 | [diff] [blame] | 96 | Assume y1 <= y2.""" |
| 97 | y1 -= 1 |
| 98 | y2 -= 1 |
Raymond Hettinger | e11b510 | 2002-12-25 16:37:19 +0000 | [diff] [blame] | 99 | return (y2//4 - y1//4) - (y2//100 - y1//100) + (y2//400 - y1//400) |
Guido van Rossum | 9b3bc71 | 1993-06-20 21:02:22 +0000 | [diff] [blame] | 100 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 101 | def weekday(year, month, day): |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 102 | """Return weekday (0-6 ~ Mon-Sun) for year (1970-...), month (1-12), |
| 103 | day (1-31).""" |
Raymond Hettinger | e11b510 | 2002-12-25 16:37:19 +0000 | [diff] [blame] | 104 | return datetime.date(year, month, day).weekday() |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 105 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 106 | def monthrange(year, month): |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 107 | """Return weekday (0-6 ~ Mon-Sun) and number of days (28-31) for |
| 108 | year, month.""" |
| 109 | if not 1 <= month <= 12: |
| 110 | raise ValueError, 'bad month number' |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 111 | day1 = weekday(year, month, 1) |
| 112 | ndays = mdays[month] + (month == February and isleap(year)) |
| 113 | return day1, ndays |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 114 | |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 115 | def monthcalendar(year, month): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 116 | """Return a matrix representing a month's calendar. |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 117 | Each row represents a week; days outside this month are zero.""" |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 118 | day1, ndays = monthrange(year, month) |
| 119 | rows = [] |
| 120 | r7 = range(7) |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 121 | day = (_firstweekday - day1 + 6) % 7 - 5 # for leading 0's in first week |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 122 | while day <= ndays: |
| 123 | row = [0, 0, 0, 0, 0, 0, 0] |
| 124 | for i in r7: |
| 125 | if 1 <= day <= ndays: row[i] = day |
| 126 | day = day + 1 |
| 127 | rows.append(row) |
| 128 | return rows |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 129 | |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 130 | def prweek(theweek, width): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 131 | """Print a single week (no newline).""" |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 132 | print week(theweek, width), |
| 133 | |
| 134 | def week(theweek, width): |
| 135 | """Returns a single week in a string (no newline).""" |
| 136 | days = [] |
| 137 | for day in theweek: |
| 138 | if day == 0: |
| 139 | s = '' |
| 140 | else: |
| 141 | s = '%2i' % day # right-align single-digit days |
Raymond Hettinger | 9ecf9ce | 2002-10-22 05:15:17 +0000 | [diff] [blame] | 142 | days.append(s.center(width)) |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 143 | return ' '.join(days) |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 144 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 145 | def weekheader(width): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 146 | """Return a header for a week.""" |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 147 | if width >= 9: |
| 148 | names = day_name |
| 149 | else: |
| 150 | names = day_abbr |
| 151 | days = [] |
| 152 | for i in range(_firstweekday, _firstweekday + 7): |
Raymond Hettinger | 9ecf9ce | 2002-10-22 05:15:17 +0000 | [diff] [blame] | 153 | days.append(names[i%7][:width].center(width)) |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 154 | return ' '.join(days) |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 155 | |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 156 | def prmonth(theyear, themonth, w=0, l=0): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 157 | """Print a month's calendar.""" |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 158 | print month(theyear, themonth, w, l), |
| 159 | |
| 160 | def month(theyear, themonth, w=0, l=0): |
| 161 | """Return a month's calendar string (multi-line).""" |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 162 | w = max(2, w) |
| 163 | l = max(1, l) |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 164 | s = ("%s %r" % (month_name[themonth], theyear)).center( |
| 165 | 7 * (w + 1) - 1).rstrip() + \ |
| 166 | '\n' * l + weekheader(w).rstrip() + '\n' * l |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 167 | for aweek in monthcalendar(theyear, themonth): |
| 168 | s = s + week(aweek, w).rstrip() + '\n' * l |
| 169 | return s[:-l] + '\n' |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 170 | |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 171 | # Spacing of month columns for 3-column year calendar |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 172 | _colwidth = 7*3 - 1 # Amount printed by prweek() |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 173 | _spacing = 6 # Number of spaces between columns |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 174 | |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 175 | def format3c(a, b, c, colwidth=_colwidth, spacing=_spacing): |
| 176 | """Prints 3-column formatting for year calendars""" |
| 177 | print format3cstring(a, b, c, colwidth, spacing) |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 178 | |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 179 | def format3cstring(a, b, c, colwidth=_colwidth, spacing=_spacing): |
| 180 | """Returns a string formatted from 3 strings, centered within 3 columns.""" |
Raymond Hettinger | 9ecf9ce | 2002-10-22 05:15:17 +0000 | [diff] [blame] | 181 | return (a.center(colwidth) + ' ' * spacing + b.center(colwidth) + |
| 182 | ' ' * spacing + c.center(colwidth)) |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 183 | |
| 184 | def prcal(year, w=0, l=0, c=_spacing): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 185 | """Print a year's calendar.""" |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 186 | print calendar(year, w, l, c), |
| 187 | |
| 188 | def calendar(year, w=0, l=0, c=_spacing): |
| 189 | """Returns a year's calendar as a multi-line string.""" |
| 190 | w = max(2, w) |
| 191 | l = max(1, l) |
| 192 | c = max(2, c) |
| 193 | colwidth = (w + 1) * 7 - 1 |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 194 | s = repr(year).center(colwidth * 3 + c * 2).rstrip() + '\n' * l |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 195 | header = weekheader(w) |
| 196 | header = format3cstring(header, header, header, colwidth, c).rstrip() |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 197 | for q in range(January, January+12, 3): |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 198 | s = (s + '\n' * l + |
| 199 | format3cstring(month_name[q], month_name[q+1], month_name[q+2], |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 200 | colwidth, c).rstrip() + |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 201 | '\n' * l + header + '\n' * l) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 202 | data = [] |
| 203 | height = 0 |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 204 | for amonth in range(q, q + 3): |
| 205 | cal = monthcalendar(year, amonth) |
| 206 | if len(cal) > height: |
| 207 | height = len(cal) |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 208 | data.append(cal) |
| 209 | for i in range(height): |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 210 | weeks = [] |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 211 | for cal in data: |
| 212 | if i >= len(cal): |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 213 | weeks.append('') |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 214 | else: |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 215 | weeks.append(week(cal[i], w)) |
Tim Peters | 88869f9 | 2001-01-14 23:36:06 +0000 | [diff] [blame] | 216 | s = s + format3cstring(weeks[0], weeks[1], weeks[2], |
Skip Montanaro | ad3bc44 | 2000-08-30 14:01:28 +0000 | [diff] [blame] | 217 | colwidth, c).rstrip() + '\n' * l |
| 218 | return s[:-l] + '\n' |
Guido van Rossum | b39aff8 | 1999-06-09 15:07:38 +0000 | [diff] [blame] | 219 | |
Guido van Rossum | b39aff8 | 1999-06-09 15:07:38 +0000 | [diff] [blame] | 220 | EPOCH = 1970 |
Raymond Hettinger | e11b510 | 2002-12-25 16:37:19 +0000 | [diff] [blame] | 221 | _EPOCH_ORD = datetime.date(EPOCH, 1, 1).toordinal() |
| 222 | |
Guido van Rossum | b39aff8 | 1999-06-09 15:07:38 +0000 | [diff] [blame] | 223 | def timegm(tuple): |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 224 | """Unrelated but handy function to calculate Unix timestamp from GMT.""" |
| 225 | year, month, day, hour, minute, second = tuple[:6] |
Raymond Hettinger | 6143648 | 2003-02-13 22:58:02 +0000 | [diff] [blame] | 226 | days = datetime.date(year, month, 1).toordinal() - _EPOCH_ORD + day - 1 |
Guido van Rossum | 4acc25b | 2000-02-02 15:10:15 +0000 | [diff] [blame] | 227 | hours = days*24 + hour |
| 228 | minutes = hours*60 + minute |
| 229 | seconds = minutes*60 + second |
| 230 | return seconds |