calendar.rst 10.7 KB
Newer Older
1 2 3 4
:mod:`calendar` --- General calendar-related functions
======================================================

.. module:: calendar
5 6
   :synopsis: Functions for working with calendars, including some emulation
              of the Unix cal program.
7 8
.. sectionauthor:: Drew Csillag <drew_csillag@geocities.com>

9
**Source code:** :source:`Lib/calendar.py`
10

11 12
--------------

13 14 15 16 17 18 19 20
This module allows you to output calendars like the Unix :program:`cal` program,
and provides additional useful functions related to the calendar. By default,
these calendars have Monday as the first day of the week, and Sunday as the last
(the European convention). Use :func:`setfirstweekday` to set the first day of
the week to Sunday (6) or to any other weekday.  Parameters that specify dates
are given as integers. For related
functionality, see also the :mod:`datetime` and :mod:`time` modules.

Benjamin Peterson's avatar
Benjamin Peterson committed
21
Most of these functions and classes rely on the :mod:`datetime` module which
22
uses an idealized calendar, the current Gregorian calendar extended
23 24 25 26 27
in both directions.  This matches the definition of the "proleptic Gregorian"
calendar in Dershowitz and Reingold's book "Calendrical Calculations", where
it's the base calendar for all computations.


28
.. class:: Calendar(firstweekday=0)
29 30 31 32 33 34 35 36 37

   Creates a :class:`Calendar` object. *firstweekday* is an integer specifying the
   first day of the week. ``0`` is Monday (the default), ``6`` is Sunday.

   A :class:`Calendar` object provides several methods that can be used for
   preparing the calendar data for formatting. This class doesn't do any formatting
   itself. This is the job of subclasses.


38
   :class:`Calendar` instances have the following methods:
39

40
   .. method:: iterweekdays()
41

42 43 44
      Return an iterator for the week day numbers that will be used for one
      week.  The first value from the iterator will be the same as the value of
      the :attr:`firstweekday` property.
45 46


47
   .. method:: itermonthdates(year, month)
48

49 50 51 52
      Return an iterator for the month *month* (1-12) in the year *year*. This
      iterator will return all days (as :class:`datetime.date` objects) for the
      month and all days before the start of the month or after the end of the
      month that are required to get a complete week.
53 54


55
   .. method:: itermonthdays2(year, month)
56

57 58 59
      Return an iterator for the month *month* in the year *year* similar to
      :meth:`itermonthdates`. Days returned will be tuples consisting of a day
      number and a week day number.
60 61


62
   .. method:: itermonthdays(year, month)
63

64 65
      Return an iterator for the month *month* in the year *year* similar to
      :meth:`itermonthdates`. Days returned will simply be day numbers.
66 67


68
   .. method:: monthdatescalendar(year, month)
69

70 71
      Return a list of the weeks in the month *month* of the *year* as full
      weeks.  Weeks are lists of seven :class:`datetime.date` objects.
72 73


74
   .. method:: monthdays2calendar(year, month)
75

76 77 78
      Return a list of the weeks in the month *month* of the *year* as full
      weeks.  Weeks are lists of seven tuples of day numbers and weekday
      numbers.
79 80


81
   .. method:: monthdayscalendar(year, month)
82

83 84
      Return a list of the weeks in the month *month* of the *year* as full
      weeks.  Weeks are lists of seven day numbers.
85 86


87
   .. method:: yeardatescalendar(year, width=3)
88

89 90 91 92
      Return the data for the specified year ready for formatting. The return
      value is a list of month rows. Each month row contains up to *width*
      months (defaulting to 3). Each month contains between 4 and 6 weeks and
      each week contains 1--7 days. Days are :class:`datetime.date` objects.
93 94


95
   .. method:: yeardays2calendar(year, width=3)
96

97 98 99
      Return the data for the specified year ready for formatting (similar to
      :meth:`yeardatescalendar`). Entries in the week lists are tuples of day
      numbers and weekday numbers. Day numbers outside this month are zero.
100 101


102
   .. method:: yeardayscalendar(year, width=3)
103

104 105 106
      Return the data for the specified year ready for formatting (similar to
      :meth:`yeardatescalendar`). Entries in the week lists are day numbers. Day
      numbers outside this month are zero.
107 108


109
.. class:: TextCalendar(firstweekday=0)
110 111 112

   This class can be used to generate plain text calendars.

113
   :class:`TextCalendar` instances have the following methods:
114

115
   .. method:: formatmonth(theyear, themonth, w=0, l=0)
116

117 118 119 120 121
      Return a month's calendar in a multi-line string. If *w* is provided, it
      specifies the width of the date columns, which are centered. If *l* is
      given, it specifies the number of lines that each week will use. Depends
      on the first weekday as specified in the constructor or set by the
      :meth:`setfirstweekday` method.
122 123


124
   .. method:: prmonth(theyear, themonth, w=0, l=0)
125

126
      Print a month's calendar as returned by :meth:`formatmonth`.
127 128


129
   .. method:: formatyear(theyear, w=2, l=1, c=6, m=3)
130

131 132 133 134 135 136
      Return a *m*-column calendar for an entire year as a multi-line string.
      Optional parameters *w*, *l*, and *c* are for date column width, lines per
      week, and number of spaces between month columns, respectively. Depends on
      the first weekday as specified in the constructor or set by the
      :meth:`setfirstweekday` method.  The earliest year for which a calendar
      can be generated is platform-dependent.
137 138


139
   .. method:: pryear(theyear, w=2, l=1, c=6, m=3)
140

141
      Print the calendar for an entire year as returned by :meth:`formatyear`.
142 143


144
.. class:: HTMLCalendar(firstweekday=0)
145 146 147 148

   This class can be used to generate HTML calendars.


149
   :class:`HTMLCalendar` instances have the following methods:
150

151
   .. method:: formatmonth(theyear, themonth, withyear=True)
152

153 154 155
      Return a month's calendar as an HTML table. If *withyear* is true the year
      will be included in the header, otherwise just the month name will be
      used.
156 157


158
   .. method:: formatyear(theyear, width=3)
159

160 161
      Return a year's calendar as an HTML table. *width* (defaulting to 3)
      specifies the number of months per row.
162 163


164
   .. method:: formatyearpage(theyear, width=3, css='calendar.css', encoding=None)
165

166 167 168 169 170
      Return a year's calendar as a complete HTML page. *width* (defaulting to
      3) specifies the number of months per row. *css* is the name for the
      cascading style sheet to be used. :const:`None` can be passed if no style
      sheet should be used. *encoding* specifies the encoding to be used for the
      output (defaulting to the system default encoding).
171 172


173
.. class:: LocaleTextCalendar(firstweekday=0, locale=None)
174 175

   This subclass of :class:`TextCalendar` can be passed a locale name in the
176 177 178
   constructor and will return month and weekday names in the specified locale.
   If this locale includes an encoding all strings containing month and weekday
   names will be returned as unicode.
179 180


181
.. class:: LocaleHTMLCalendar(firstweekday=0, locale=None)
182 183

   This subclass of :class:`HTMLCalendar` can be passed a locale name in the
184 185 186
   constructor and will return month and weekday names in the specified
   locale. If this locale includes an encoding all strings containing month and
   weekday names will be returned as unicode.
187

188 189 190 191 192 193
.. note::

   The :meth:`formatweekday` and :meth:`formatmonthname` methods of these two
   classes temporarily change the current locale to the given *locale*.  Because
   the current locale is a process-wide setting, they are not thread-safe.

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222

For simple text calendars this module provides the following functions.

.. function:: setfirstweekday(weekday)

   Sets the weekday (``0`` is Monday, ``6`` is Sunday) to start each week. The
   values :const:`MONDAY`, :const:`TUESDAY`, :const:`WEDNESDAY`, :const:`THURSDAY`,
   :const:`FRIDAY`, :const:`SATURDAY`, and :const:`SUNDAY` are provided for
   convenience. For example, to set the first weekday to Sunday::

      import calendar
      calendar.setfirstweekday(calendar.SUNDAY)


.. function:: firstweekday()

   Returns the current setting for the weekday to start each week.


.. function:: isleap(year)

   Returns :const:`True` if *year* is a leap year, otherwise :const:`False`.


.. function:: leapdays(y1, y2)

   Returns the number of leap years in the range from *y1* to *y2* (exclusive),
   where *y1* and *y2* are years.

223
   This function works for ranges spanning a century change.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250


.. function:: weekday(year, month, day)

   Returns the day of the week (``0`` is Monday) for *year* (``1970``--...),
   *month* (``1``--``12``), *day* (``1``--``31``).


.. function:: weekheader(n)

   Return a header containing abbreviated weekday names. *n* specifies the width in
   characters for one weekday.


.. function:: monthrange(year, month)

   Returns weekday of first day of the month and number of days in month,  for the
   specified *year* and *month*.


.. function:: monthcalendar(year, month)

   Returns a matrix representing a month's calendar.  Each row represents a week;
   days outside of the month a represented by zeros. Each week begins with Monday
   unless set by :func:`setfirstweekday`.


251
.. function:: prmonth(theyear, themonth, w=0, l=0)
252 253 254 255

   Prints a month's calendar as returned by :func:`month`.


256
.. function:: month(theyear, themonth, w=0, l=0)
257 258 259 260 261

   Returns a month's calendar in a multi-line string using the :meth:`formatmonth`
   of the :class:`TextCalendar` class.


262
.. function:: prcal(year, w=0, l=0, c=6, m=3)
263 264 265 266

   Prints the calendar for an entire year as returned by  :func:`calendar`.


267
.. function:: calendar(year, w=2, l=1, c=6, m=3)
268

269 270
   Returns a 3-column calendar for an entire year as a multi-line string using
   the :meth:`formatyear` of the :class:`TextCalendar` class.
271 272 273 274


.. function:: timegm(tuple)

275 276 277 278 279
   An unrelated but handy function that takes a time tuple such as returned by
   the :func:`~time.gmtime` function in the :mod:`time` module, and returns the
   corresponding Unix timestamp value, assuming an epoch of 1970, and the POSIX
   encoding.  In fact, :func:`time.gmtime` and :func:`timegm` are each others'
   inverse.
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315


The :mod:`calendar` module exports the following data attributes:

.. data:: day_name

   An array that represents the days of the week in the current locale.


.. data:: day_abbr

   An array that represents the abbreviated days of the week in the current locale.


.. data:: month_name

   An array that represents the months of the year in the current locale.  This
   follows normal convention of January being month number 1, so it has a length of
   13 and  ``month_name[0]`` is the empty string.


.. data:: month_abbr

   An array that represents the abbreviated months of the year in the current
   locale.  This follows normal convention of January being month number 1, so it
   has a length of 13 and  ``month_abbr[0]`` is the empty string.


.. seealso::

   Module :mod:`datetime`
      Object-oriented interface to dates and times with similar functionality to the
      :mod:`time` module.

   Module :mod:`time`
      Low-level time related functions.