Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`calendar` --- General calendar-related functions |
| 2 | ====================================================== |
| 3 | |
| 4 | .. module:: calendar |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 5 | :synopsis: Functions for working with calendars, including some emulation |
| 6 | of the Unix cal program. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 7 | .. sectionauthor:: Drew Csillag <drew_csillag@geocities.com> |
| 8 | |
| 9 | |
| 10 | This module allows you to output calendars like the Unix :program:`cal` program, |
| 11 | and provides additional useful functions related to the calendar. By default, |
| 12 | these calendars have Monday as the first day of the week, and Sunday as the last |
| 13 | (the European convention). Use :func:`setfirstweekday` to set the first day of |
| 14 | the week to Sunday (6) or to any other weekday. Parameters that specify dates |
| 15 | are given as integers. For related |
| 16 | functionality, see also the :mod:`datetime` and :mod:`time` modules. |
| 17 | |
Benjamin Peterson | d7c3ed5 | 2010-06-27 22:32:30 +0000 | [diff] [blame] | 18 | Most of these functions and classes rely on the :mod:`datetime` module which |
Alexander Belopolsky | d4bbab2 | 2010-11-22 03:06:56 +0000 | [diff] [blame] | 19 | uses an idealized calendar, the current Gregorian calendar extended |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 20 | in both directions. This matches the definition of the "proleptic Gregorian" |
| 21 | calendar in Dershowitz and Reingold's book "Calendrical Calculations", where |
| 22 | it's the base calendar for all computations. |
| 23 | |
Éric Araujo | 6e6cb8e | 2010-11-16 19:13:50 +0000 | [diff] [blame] | 24 | .. seealso:: |
| 25 | |
| 26 | Latest version of the :source:`calendar module Python source code |
| 27 | <Lib/calendar.py>` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 28 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 29 | .. class:: Calendar(firstweekday=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 30 | |
| 31 | Creates a :class:`Calendar` object. *firstweekday* is an integer specifying the |
| 32 | first day of the week. ``0`` is Monday (the default), ``6`` is Sunday. |
| 33 | |
| 34 | A :class:`Calendar` object provides several methods that can be used for |
| 35 | preparing the calendar data for formatting. This class doesn't do any formatting |
| 36 | itself. This is the job of subclasses. |
| 37 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 38 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 39 | :class:`Calendar` instances have the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 40 | |
Alexandre Vassalotti | bee3253 | 2008-05-16 18:15:12 +0000 | [diff] [blame] | 41 | .. method:: iterweekdays() |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 42 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 43 | Return an iterator for the week day numbers that will be used for one |
| 44 | week. The first value from the iterator will be the same as the value of |
| 45 | the :attr:`firstweekday` property. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 46 | |
| 47 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 48 | .. method:: itermonthdates(year, month) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 49 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 50 | Return an iterator for the month *month* (1-12) in the year *year*. This |
| 51 | iterator will return all days (as :class:`datetime.date` objects) for the |
| 52 | month and all days before the start of the month or after the end of the |
| 53 | month that are required to get a complete week. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 54 | |
| 55 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 56 | .. method:: itermonthdays2(year, month) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 57 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 58 | Return an iterator for the month *month* in the year *year* similar to |
| 59 | :meth:`itermonthdates`. Days returned will be tuples consisting of a day |
| 60 | number and a week day number. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 61 | |
| 62 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 63 | .. method:: itermonthdays(year, month) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 64 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 65 | Return an iterator for the month *month* in the year *year* similar to |
| 66 | :meth:`itermonthdates`. Days returned will simply be day numbers. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 67 | |
| 68 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 69 | .. method:: monthdatescalendar(year, month) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 70 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 71 | Return a list of the weeks in the month *month* of the *year* as full |
| 72 | weeks. Weeks are lists of seven :class:`datetime.date` objects. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 73 | |
| 74 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 75 | .. method:: monthdays2calendar(year, month) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 76 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 77 | Return a list of the weeks in the month *month* of the *year* as full |
| 78 | weeks. Weeks are lists of seven tuples of day numbers and weekday |
| 79 | numbers. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 80 | |
| 81 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 82 | .. method:: monthdayscalendar(year, month) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 83 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 84 | Return a list of the weeks in the month *month* of the *year* as full |
| 85 | weeks. Weeks are lists of seven day numbers. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 86 | |
| 87 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 88 | .. method:: yeardatescalendar(year, width=3) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 89 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 90 | Return the data for the specified year ready for formatting. The return |
| 91 | value is a list of month rows. Each month row contains up to *width* |
| 92 | months (defaulting to 3). Each month contains between 4 and 6 weeks and |
| 93 | each week contains 1--7 days. Days are :class:`datetime.date` objects. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 94 | |
| 95 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 96 | .. method:: yeardays2calendar(year, width=3) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 97 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 98 | Return the data for the specified year ready for formatting (similar to |
| 99 | :meth:`yeardatescalendar`). Entries in the week lists are tuples of day |
| 100 | numbers and weekday numbers. Day numbers outside this month are zero. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 101 | |
| 102 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 103 | .. method:: yeardayscalendar(year, width=3) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 104 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 105 | Return the data for the specified year ready for formatting (similar to |
| 106 | :meth:`yeardatescalendar`). Entries in the week lists are day numbers. Day |
| 107 | numbers outside this month are zero. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 108 | |
| 109 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 110 | .. class:: TextCalendar(firstweekday=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 111 | |
| 112 | This class can be used to generate plain text calendars. |
| 113 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 114 | :class:`TextCalendar` instances have the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 115 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 116 | .. method:: formatmonth(theyear, themonth, w=0, l=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 117 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 118 | Return a month's calendar in a multi-line string. If *w* is provided, it |
| 119 | specifies the width of the date columns, which are centered. If *l* is |
| 120 | given, it specifies the number of lines that each week will use. Depends |
| 121 | on the first weekday as specified in the constructor or set by the |
| 122 | :meth:`setfirstweekday` method. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 123 | |
| 124 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 125 | .. method:: prmonth(theyear, themonth, w=0, l=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 126 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 127 | Print a month's calendar as returned by :meth:`formatmonth`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 128 | |
| 129 | |
Benjamin Peterson | 2021100 | 2009-11-25 18:34:42 +0000 | [diff] [blame] | 130 | .. method:: formatyear(theyear, w=2, l=1, c=6, m=3) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 131 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 132 | Return a *m*-column calendar for an entire year as a multi-line string. |
| 133 | Optional parameters *w*, *l*, and *c* are for date column width, lines per |
| 134 | week, and number of spaces between month columns, respectively. Depends on |
| 135 | the first weekday as specified in the constructor or set by the |
| 136 | :meth:`setfirstweekday` method. The earliest year for which a calendar |
| 137 | can be generated is platform-dependent. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 138 | |
| 139 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 140 | .. method:: pryear(theyear, w=2, l=1, c=6, m=3) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 141 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 142 | Print the calendar for an entire year as returned by :meth:`formatyear`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 143 | |
| 144 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 145 | .. class:: HTMLCalendar(firstweekday=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 146 | |
| 147 | This class can be used to generate HTML calendars. |
| 148 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 149 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 150 | :class:`HTMLCalendar` instances have the following methods: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 151 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 152 | .. method:: formatmonth(theyear, themonth, withyear=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 153 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 154 | Return a month's calendar as an HTML table. If *withyear* is true the year |
| 155 | will be included in the header, otherwise just the month name will be |
| 156 | used. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 157 | |
| 158 | |
Benjamin Peterson | 2021100 | 2009-11-25 18:34:42 +0000 | [diff] [blame] | 159 | .. method:: formatyear(theyear, width=3) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 160 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 161 | Return a year's calendar as an HTML table. *width* (defaulting to 3) |
| 162 | specifies the number of months per row. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 163 | |
| 164 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 165 | .. method:: formatyearpage(theyear, width=3, css='calendar.css', encoding=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 166 | |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 167 | Return a year's calendar as a complete HTML page. *width* (defaulting to |
| 168 | 3) specifies the number of months per row. *css* is the name for the |
| 169 | cascading style sheet to be used. :const:`None` can be passed if no style |
| 170 | sheet should be used. *encoding* specifies the encoding to be used for the |
| 171 | output (defaulting to the system default encoding). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 172 | |
| 173 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 174 | .. class:: LocaleTextCalendar(firstweekday=0, locale=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 175 | |
| 176 | This subclass of :class:`TextCalendar` can be passed a locale name in the |
Georg Brandl | 7004bd1 | 2010-10-19 18:54:25 +0000 | [diff] [blame] | 177 | constructor and will return month and weekday names in the specified locale. |
| 178 | If this locale includes an encoding all strings containing month and weekday |
| 179 | names will be returned as unicode. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 180 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 181 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 182 | .. class:: LocaleHTMLCalendar(firstweekday=0, locale=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 183 | |
| 184 | This subclass of :class:`HTMLCalendar` can be passed a locale name in the |
Benjamin Peterson | e41251e | 2008-04-25 01:59:09 +0000 | [diff] [blame] | 185 | constructor and will return month and weekday names in the specified |
| 186 | locale. If this locale includes an encoding all strings containing month and |
| 187 | weekday names will be returned as unicode. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 188 | |
Georg Brandl | 7004bd1 | 2010-10-19 18:54:25 +0000 | [diff] [blame] | 189 | .. note:: |
| 190 | |
| 191 | The :meth:`formatweekday` and :meth:`formatmonthname` methods of these two |
| 192 | classes temporarily change the current locale to the given *locale*. Because |
| 193 | the current locale is a process-wide setting, they are not thread-safe. |
| 194 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 195 | |
| 196 | For simple text calendars this module provides the following functions. |
| 197 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 198 | .. function:: setfirstweekday(weekday) |
| 199 | |
| 200 | Sets the weekday (``0`` is Monday, ``6`` is Sunday) to start each week. The |
| 201 | values :const:`MONDAY`, :const:`TUESDAY`, :const:`WEDNESDAY`, :const:`THURSDAY`, |
| 202 | :const:`FRIDAY`, :const:`SATURDAY`, and :const:`SUNDAY` are provided for |
| 203 | convenience. For example, to set the first weekday to Sunday:: |
| 204 | |
| 205 | import calendar |
| 206 | calendar.setfirstweekday(calendar.SUNDAY) |
| 207 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 208 | |
| 209 | .. function:: firstweekday() |
| 210 | |
| 211 | Returns the current setting for the weekday to start each week. |
| 212 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 213 | |
| 214 | .. function:: isleap(year) |
| 215 | |
| 216 | Returns :const:`True` if *year* is a leap year, otherwise :const:`False`. |
| 217 | |
| 218 | |
| 219 | .. function:: leapdays(y1, y2) |
| 220 | |
| 221 | Returns the number of leap years in the range from *y1* to *y2* (exclusive), |
| 222 | where *y1* and *y2* are years. |
| 223 | |
Georg Brandl | 55ac8f0 | 2007-09-01 13:51:09 +0000 | [diff] [blame] | 224 | This function works for ranges spanning a century change. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 225 | |
| 226 | |
| 227 | .. function:: weekday(year, month, day) |
| 228 | |
| 229 | Returns the day of the week (``0`` is Monday) for *year* (``1970``--...), |
| 230 | *month* (``1``--``12``), *day* (``1``--``31``). |
| 231 | |
| 232 | |
| 233 | .. function:: weekheader(n) |
| 234 | |
| 235 | Return a header containing abbreviated weekday names. *n* specifies the width in |
| 236 | characters for one weekday. |
| 237 | |
| 238 | |
| 239 | .. function:: monthrange(year, month) |
| 240 | |
| 241 | Returns weekday of first day of the month and number of days in month, for the |
| 242 | specified *year* and *month*. |
| 243 | |
| 244 | |
| 245 | .. function:: monthcalendar(year, month) |
| 246 | |
| 247 | Returns a matrix representing a month's calendar. Each row represents a week; |
| 248 | days outside of the month a represented by zeros. Each week begins with Monday |
| 249 | unless set by :func:`setfirstweekday`. |
| 250 | |
| 251 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 252 | .. function:: prmonth(theyear, themonth, w=0, l=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 253 | |
| 254 | Prints a month's calendar as returned by :func:`month`. |
| 255 | |
| 256 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 257 | .. function:: month(theyear, themonth, w=0, l=0) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 258 | |
| 259 | Returns a month's calendar in a multi-line string using the :meth:`formatmonth` |
| 260 | of the :class:`TextCalendar` class. |
| 261 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 262 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 263 | .. function:: prcal(year, w=0, l=0, c=6, m=3) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 264 | |
| 265 | Prints the calendar for an entire year as returned by :func:`calendar`. |
| 266 | |
| 267 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 268 | .. function:: calendar(year, w=2, l=1, c=6, m=3) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 269 | |
Georg Brandl | 0d8f073 | 2009-04-05 22:20:44 +0000 | [diff] [blame] | 270 | Returns a 3-column calendar for an entire year as a multi-line string using |
| 271 | the :meth:`formatyear` of the :class:`TextCalendar` class. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 272 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 273 | |
| 274 | .. function:: timegm(tuple) |
| 275 | |
| 276 | An unrelated but handy function that takes a time tuple such as returned by the |
| 277 | :func:`gmtime` function in the :mod:`time` module, and returns the corresponding |
| 278 | Unix timestamp value, assuming an epoch of 1970, and the POSIX encoding. In |
| 279 | fact, :func:`time.gmtime` and :func:`timegm` are each others' inverse. |
| 280 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 281 | |
| 282 | The :mod:`calendar` module exports the following data attributes: |
| 283 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 284 | .. data:: day_name |
| 285 | |
| 286 | An array that represents the days of the week in the current locale. |
| 287 | |
| 288 | |
| 289 | .. data:: day_abbr |
| 290 | |
| 291 | An array that represents the abbreviated days of the week in the current locale. |
| 292 | |
| 293 | |
| 294 | .. data:: month_name |
| 295 | |
| 296 | An array that represents the months of the year in the current locale. This |
| 297 | follows normal convention of January being month number 1, so it has a length of |
| 298 | 13 and ``month_name[0]`` is the empty string. |
| 299 | |
| 300 | |
| 301 | .. data:: month_abbr |
| 302 | |
| 303 | An array that represents the abbreviated months of the year in the current |
| 304 | locale. This follows normal convention of January being month number 1, so it |
| 305 | has a length of 13 and ``month_abbr[0]`` is the empty string. |
| 306 | |
| 307 | |
| 308 | .. seealso:: |
| 309 | |
| 310 | Module :mod:`datetime` |
| 311 | Object-oriented interface to dates and times with similar functionality to the |
| 312 | :mod:`time` module. |
| 313 | |
| 314 | Module :mod:`time` |
| 315 | Low-level time related functions. |
| 316 | |