# `calendar` — General calendar-related functions

Вихідний код: Lib/calendar.py

Цей модуль дозволяє виводити календарі, як програма Unix cal, і надає додаткові корисні функції, пов’язані з календарем. За замовчуванням у цих календарях першим днем тижня є понеділок, а останнім — неділя (європейська конвенція). Використовуйте `setfirstweekday()`, щоб установити першим днем тижня неділю (6) або будь-який інший день тижня. Параметри, що визначають дати, задаються як цілі числа. Для пов’язаних функцій перегляньте також модулі `datetime` і `time`.

Функції та класи, визначені в цьому модулі, використовують ідеалізований календар, поточний григоріанський календар, розширений на невизначений термін в обох напрямках. Це відповідає визначенню «пролептичного григоріанського» календаря в книзі Дершовіца та Рейнгольда «Календарні обчислення», де це базовий календар для всіх обчислень. Нульові та негативні роки інтерпретуються відповідно до стандарту ISO 8601. Рік 0 — це 1 рік до нашої ери, рік -1 — це 2 рік до нашої ери і так далі.

class calendar.Calendar(firstweekday=0)

  Створює об’єкт `Calendar`. firstweekday — це ціле число, що визначає перший день тижня. `MONDAY` — це `0` (за замовчуванням), `SUNDAY` — `6`.

  Об’єкт `Calendar` надає кілька методів, які можна використовувати для підготовки даних календаря до форматування. Цей клас сам не виконує форматування. Це робота підкласів.

  `Calendar` instances have the following methods and attributes:

  firstweekday

    The first weekday as an integer (0–6).

    This property can also be set and read using `setfirstweekday()` and `getfirstweekday()` respectively.

  getfirstweekday()

    Return an `int` for the current first weekday (0–6).

    Identical to reading the `firstweekday` property.

  setfirstweekday(firstweekday)

    Set the first weekday to firstweekday, passed as an `int` (0–6)

    Identical to setting the `firstweekday` property.

  iterweekdays()

    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 `firstweekday` property.

  itermonthdates(year, month)

    Повертає ітератор для місяця month (1–12) у році year. Цей ітератор поверне всі дні (як об’єкти `datetime.date`) за місяць і всі дні до початку або після кінця місяця, необхідні для отримання повного тижня.

  itermonthdays(year, month)

    Повертає ітератор для місяця місяць у році рік, подібний до `itermonthdates()`, але не обмежений діапазоном `datetime.date`. Повернені дні будуть просто номерами днів місяця. Для днів поза вказаним місяцем номер дня дорівнює `0`.

  itermonthdays2(year, month)

    Повертає ітератор для місяця місяць у році рік, подібний до `itermonthdates()`, але не обмежений діапазоном `datetime.date`. Повернуті дні будуть кортежами, що складаються з номера дня місяця та номера дня тижня.

  itermonthdays3(year, month)

    Повертає ітератор для місяця місяць у році рік, подібний до `itermonthdates()`, але не обмежений діапазоном `datetime.date`. Повернуті дні будуть кортежами, що складаються з номерів року, місяця та дня місяця.

    Added in version 3.7.

  itermonthdays4(year, month)

    Повертає ітератор для місяця місяць у році рік, подібний до `itermonthdates()`, але не обмежений діапазоном `datetime.date`. Повернуті дні будуть кортежами, що складаються з номерів року, місяця, дня місяця та дня тижня.

    Added in version 3.7.

  monthdatescalendar(year, month)

    Повертає список тижнів у місяці місяць року як повні тижні. Тижні — це списки із семи об’єктів `datetime.date`.

  monthdays2calendar(year, month)

    Повертає список тижнів у місяці місяць року як повні тижні. Тижні — це списки із семи кортежів номерів днів і днів тижня.

  monthdayscalendar(year, month)

    Повертає список тижнів у місяці місяць року як повні тижні. Тижні — це списки із семи днів.

  yeardatescalendar(year, width=3)

    Повернути готові до форматування дані за вказаний рік. Поверненим значенням є список рядків місяця. Кожен рядок місяця містить до width місяців (за замовчуванням до 3). Кожен місяць містить від 4 до 6 тижнів, а кожен тиждень містить 1–7 днів. Дні є об’єктами `datetime.date`.

  yeardays2calendar(year, width=3)

    Повертає дані за вказаний рік, готові до форматування (подібно до `yeardatescalendar()`). Записи в тижневих списках є кортежами номерів днів і днів тижня. Номери днів поза цим місяцем дорівнюють нулю.

  yeardayscalendar(year, width=3)

    Повертає дані за вказаний рік, готові до форматування (подібно до `yeardatescalendar()`). Записи в тижневих списках є номерами днів. Номери днів поза цим місяцем дорівнюють нулю.

class calendar.TextCalendar(firstweekday=0)

  Цей клас можна використовувати для створення простих текстових календарів.

  Екземпляри `TextCalendar` мають такі методи:

  formatday(theday, weekday, width)

    Return a string representing a single day formatted with the given width. If theday is `0`, return a string of spaces of the specified width, representing an empty day. The weekday parameter is unused.

  formatweek(theweek, w=0)

    Return a single week in a string with no newline. If w is provided, it specifies the width of the date columns, which are centered. Depends on the first weekday as specified in the constructor or set by the `setfirstweekday()` method.

  formatweekday(weekday, width)

    Return a string representing the name of a single weekday formatted to the specified width. The weekday parameter is an integer representing the day of the week, where `0` is Monday and `6` is Sunday.

  formatweekheader(width)

    Return a string containing the header row of weekday names, formatted with the given width for each column. The names depend on the locale settings and are padded to the specified width.

  formatmonth(theyear, themonth, w=0, l=0)

    Повертає місячний календар у багаторядковому рядку. Якщо вказано w, воно визначає ширину стовпців дати, які розташовані по центру. Якщо задано l, це визначає кількість рядків, які використовуватимуться кожного тижня. Залежить від першого дня тижня, як зазначено в конструкторі або встановлено методом `setfirstweekday()`.

  formatmonthname(theyear, themonth, width=0, withyear=True)

    Return a string representing the month’s name centered within the specified width. If withyear is `True`, include the year in the output. The theyear and themonth parameters specify the year and month for the name to be formatted respectively.

  prmonth(theyear, themonth, w=0, l=0)

    Надрукувати місячний календар, який повертає `formatmonth()`.

  formatyear(theyear, w=2, l=1, c=6, m=3)

    Повертає календар зі стовпцями m для цілого року як багаторядковий рядок. Додаткові параметри w, l і c призначені для ширини стовпця дати, рядків на тиждень і кількості пробілів між стовпцями місяця відповідно. Залежить від першого дня тижня, як зазначено в конструкторі або встановлено методом `setfirstweekday()`. Найперший рік, для якого можна створити календар, залежить від платформи.

  pryear(theyear, w=2, l=1, c=6, m=3)

    Роздрукувати календар на цілий рік, який повертає `formatyear()`.

class calendar.HTMLCalendar(firstweekday=0)

  Цей клас можна використовувати для створення HTML-календарів.

  Екземпляри `HTMLCalendar` мають такі методи:

  formatmonth(theyear, themonth, withyear=True)

    Повертає місячний календар як таблицю HTML. Якщо withyear має значення true, рік буде включено в заголовок, інакше використовуватиметься лише назва місяця.

  formatyear(theyear, width=3)

    Повертає річний календар як таблицю HTML. width (за замовчуванням 3) визначає кількість місяців у рядку.

  formatyearpage(theyear, width=3, css='calendar.css', encoding=None)

    Повертає річний календар як повну сторінку HTML. width (за замовчуванням 3) визначає кількість місяців у рядку. css — назва каскадної таблиці стилів, яка буде використовуватися. `None` можна передати, якщо не потрібно використовувати таблицю стилів. encoding вказує кодування, яке буде використовуватися для виведення (за замовчуванням використовується стандартне кодування системи).

  formatmonthname(theyear, themonth, withyear=True)

    Return a month name as an HTML table row. If withyear is true the year will be included in the row, otherwise just the month name will be used.

  `HTMLCalendar` має такі атрибути, які ви можете замінити, щоб налаштувати класи CSS, які використовує календар:

  cssclasses

    Список класів CSS, які використовуються для кожного дня тижня. Типовий список класів:

        cssclasses = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]

    на кожен день можна додати більше стилів:

        cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]

    Зауважте, що довжина цього списку має складатися із семи пунктів.

  cssclass_noday

    Клас CSS для дня тижня в попередньому або наступному місяці.

    Added in version 3.7.

  cssclasses_weekday_head

    Список класів CSS, які використовуються для назв днів тижня в рядку заголовка. За замовчуванням таке саме, як `cssclasses`.

    Added in version 3.7.

  cssclass_month_head

    Головний клас CSS місяця (використовується `formatmonthname()`). Значенням за замовчуванням є `"місяць"`.

    Added in version 3.7.

  cssclass_month

    Клас CSS для таблиці всього місяця (використовується `formatmonth()`). Значенням за замовчуванням є `"місяць"`.

    Added in version 3.7.

  cssclass_year

    Клас CSS для таблиці таблиць за цілий рік (використовується `formatyear()`). Значення за замовчуванням – `"рік"`.

    Added in version 3.7.

  cssclass_year_head

    Клас CSS для заголовка таблиці за цілий рік (використовується `formatyear()`). Значення за замовчуванням – `"рік"`.

    Added in version 3.7.

  Зауважте, що хоча імена для описаних вище атрибутів класу є одниною (наприклад, `cssclass_month` `cssclass_noday`), можна замінити один клас CSS списком класів CSS, розділених пробілами, наприклад:

      "text-bold text-red"

  Ось приклад того, як `HTMLCalendar` можна налаштувати:

      class CustomHTMLCal(calendar.HTMLCalendar):
          cssclasses = [style + " text-nowrap" for style in
                        calendar.HTMLCalendar.cssclasses]
          cssclass_month_head = "text-center month-head"
          cssclass_month = "text-center month"
          cssclass_year = "text-italic lead"

class calendar.LocaleTextCalendar(firstweekday=0, locale=None)

  This subclass of `TextCalendar` can be passed a locale name in the constructor and will return month and weekday names in the specified locale.

class calendar.LocaleHTMLCalendar(firstweekday=0, locale=None)

  This subclass of `HTMLCalendar` can be passed a locale name in the constructor and will return month and weekday names in the specified locale.

Примітка

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

Для простих текстових календарів цей модуль надає такі функції.

calendar.setfirstweekday(weekday)

  Встановлює день тижня (`0` - понеділок, `6` - неділя), щоб почати кожен тиждень. Значення `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY` і `SUNDAY` надаються для зручності. Наприклад, щоб встановити першим днем тижня неділю:

      import calendar
      calendar.setfirstweekday(calendar.SUNDAY)

calendar.firstweekday()

  Повертає поточне налаштування дня тижня для початку кожного тижня.

calendar.isleap(year)

  Повертає `True`, якщо year є високосним роком, інакше `False`.

calendar.leapdays(y1, y2)

  Повертає кількість високосних років у діапазоні від y1 до y2 (за винятком), де y1 і y2 — роки.

  Ця функція працює для діапазонів, що охоплюють зміну століття.

calendar.weekday(year, month, day)

  Повертає день тижня («0» — понеділок) для року (`1970`–…), місяця (`1`–`12`), день (`1`-`31`).

calendar.weekheader(n)

  Повертає заголовок, що містить скорочені назви днів тижня. n визначає ширину в символах для одного дня тижня.

calendar.monthrange(year, month)

  Повертає день тижня першого дня місяця та кількість днів у місяці для вказаного року та місяця.

calendar.monthcalendar(year, month)

  Повертає матрицю, що представляє місячний календар. Кожен рядок означає тиждень; дні поза місяцем позначаються нулями. Кожен тиждень починається з понеділка, якщо не встановлено `setfirstweekday()`.

calendar.prmonth(theyear, themonth, w=0, l=0)

  Друкує місячний календар, який повертає `month()`.

calendar.month(theyear, themonth, w=0, l=0)

  Returns a month’s calendar in a multi-line string using the `formatmonth()` of the `TextCalendar` class.

calendar.prcal(year, w=0, l=0, c=6, m=3)

  Друкує календар на цілий рік, який повертає `calendar()`.

calendar.calendar(year, w=2, l=1, c=6, m=3)

  Returns a 3-column calendar for an entire year as a multi-line string using the `formatyear()` of the `TextCalendar` class.

calendar.timegm(tuple)

  Непов’язана, але зручна функція, яка приймає кортеж часу, такий як повернутий функцією `gmtime()` в модулі `time`, і повертає відповідне значення мітки часу Unix, припускаючи епоху 1970 року, і кодування POSIX. Насправді `time.gmtime()` і `timegm()` є зворотними один одному.

Модуль `calendar` експортує такі атрибути даних:

calendar.day_name

  A sequence that represents the days of the week in the current locale, where Monday is day number 0.

      >>> import calendar
      >>> list(calendar.day_name)
      ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']

calendar.day_abbr

  A sequence that represents the abbreviated days of the week in the current locale, where Mon is day number 0.

      >>> import calendar
      >>> list(calendar.day_abbr)
      ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']

calendar.MONDAY
calendar.TUESDAY
calendar.WEDNESDAY
calendar.THURSDAY
calendar.FRIDAY
calendar.SATURDAY
calendar.SUNDAY

  Aliases for the days of the week, where `MONDAY` is `0` and `SUNDAY` is `6`.

  Added in version 3.12.

class calendar.Day

  Enumeration defining days of the week as integer constants. The members of this enumeration are exported to the module scope as `MONDAY` through `SUNDAY`.

  Added in version 3.12.

calendar.month_name

  A sequence 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.

      >>> import calendar
      >>> list(calendar.month_name)
      ['', 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']

calendar.month_abbr

  A sequence 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.

      >>> import calendar
      >>> list(calendar.month_abbr)
      ['', 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']

calendar.JANUARY
calendar.FEBRUARY
calendar.MARCH
calendar.APRIL
calendar.MAY
calendar.JUNE
calendar.JULY
calendar.AUGUST
calendar.SEPTEMBER
calendar.OCTOBER
calendar.NOVEMBER
calendar.DECEMBER

  Aliases for the months of the year, where `JANUARY` is `1` and `DECEMBER` is `12`.

  Added in version 3.12.

class calendar.Month

  Enumeration defining months of the year as integer constants. The members of this enumeration are exported to the module scope as `JANUARY` through `DECEMBER`.

  Added in version 3.12.

The `calendar` module defines the following exceptions:

exception calendar.IllegalMonthError(month)

  A subclass of `ValueError`, raised when the given month number is outside of the range 1-12 (inclusive).

  month

    The invalid month number.

exception calendar.IllegalWeekdayError(weekday)

  A subclass of `ValueError`, raised when the given weekday number is outside of the range 0-6 (inclusive).

  weekday

    The invalid weekday number.

Дивись також

Модуль `datetime`

  Об’єктно-орієнтований інтерфейс для дат і часу з аналогічною функціональністю модуля `time`.

Модуль `time`

  Низькорівневі функції, пов’язані з часом.

## Command-line usage

Added in version 2.5.

The `calendar` module can be executed as a script from the command line to interactively print a calendar.

    python -m calendar [-h] [-L LOCALE] [-e ENCODING] [-t {text,html}]
                       [-w WIDTH] [-l LINES] [-s SPACING] [-m MONTHS] [-c CSS]
                       [-f FIRST_WEEKDAY] [year] [month]

For example, to print a calendar for the year 2000:

    $ python -m calendar 2000
                                      2000

          January                   February                   March
    Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                    1  2          1  2  3  4  5  6             1  2  3  4  5
     3  4  5  6  7  8  9       7  8  9 10 11 12 13       6  7  8  9 10 11 12
    10 11 12 13 14 15 16      14 15 16 17 18 19 20      13 14 15 16 17 18 19
    17 18 19 20 21 22 23      21 22 23 24 25 26 27      20 21 22 23 24 25 26
    24 25 26 27 28 29 30      28 29                     27 28 29 30 31
    31

           April                      May                       June
    Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                    1  2       1  2  3  4  5  6  7                1  2  3  4
     3  4  5  6  7  8  9       8  9 10 11 12 13 14       5  6  7  8  9 10 11
    10 11 12 13 14 15 16      15 16 17 18 19 20 21      12 13 14 15 16 17 18
    17 18 19 20 21 22 23      22 23 24 25 26 27 28      19 20 21 22 23 24 25
    24 25 26 27 28 29 30      29 30 31                  26 27 28 29 30

            July                     August                  September
    Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                    1  2          1  2  3  4  5  6                   1  2  3
     3  4  5  6  7  8  9       7  8  9 10 11 12 13       4  5  6  7  8  9 10
    10 11 12 13 14 15 16      14 15 16 17 18 19 20      11 12 13 14 15 16 17
    17 18 19 20 21 22 23      21 22 23 24 25 26 27      18 19 20 21 22 23 24
    24 25 26 27 28 29 30      28 29 30 31               25 26 27 28 29 30
    31

          October                   November                  December
    Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                       1             1  2  3  4  5                   1  2  3
     2  3  4  5  6  7  8       6  7  8  9 10 11 12       4  5  6  7  8  9 10
     9 10 11 12 13 14 15      13 14 15 16 17 18 19      11 12 13 14 15 16 17
    16 17 18 19 20 21 22      20 21 22 23 24 25 26      18 19 20 21 22 23 24
    23 24 25 26 27 28 29      27 28 29 30               25 26 27 28 29 30 31
    30 31

Приймаються такі варіанти:

--help, -h

  Показати довідкове повідомлення та вийти.

--locale LOCALE, -L LOCALE

  The locale to use for month and weekday names. Defaults to English.

--encoding ENCODING, -e ENCODING

  The encoding to use for output. `--encoding` is required if `--locale` is set.

--type {text,html}, -t {text,html}

  Print the calendar to the terminal as text, or as an HTML document.

--first-weekday FIRST_WEEKDAY, -f FIRST_WEEKDAY

  The weekday to start each week. Must be a number between 0 (Monday) and 6 (Sunday). Defaults to 0.

  Added in version 3.13.

year

  The year to print the calendar for. Defaults to the current year.

month

  The month of the specified `year` to print the calendar for. Must be a number between 1 and 12, and may only be used in text mode. Defaults to printing a calendar for the full year.

Text-mode options:

--width WIDTH, -w WIDTH

  The width of the date column in terminal columns. The date is printed centred in the column. Any value lower than 2 is ignored. Defaults to 2.

--lines LINES, -l LINES

  The number of lines for each week in terminal rows. The date is printed top-aligned. Any value lower than 1 is ignored. Defaults to 1.

--spacing SPACING, -s SPACING

  The space between months in columns. Any value lower than 2 is ignored. Defaults to 6.

--months MONTHS, -m MONTHS

  The number of months printed per row. Defaults to 3.

Змінено в версії 3.14: By default, today’s date is highlighted in color and can be controlled using environment variables.

HTML-mode options:

--css CSS, -c CSS

  The path of a CSS stylesheet to use for the calendar. This must either be relative to the generated HTML, or an absolute HTTP or `file:///` URL.