"calendar" --- General calendar-related functions
*************************************************

**Code source :** Lib/calendar.py

======================================================================

Ce module permet d'afficher un calendrier comme le fait le programme
Unix **cal**, et il fournit des fonctions utiles relatives au
calendrier. Par défaut, ces calendriers ont le lundi comme premier
jour de la semaine et le dimanche comme dernier jour. Utilisez
"setfirstweekday()" pour définir le premier jour de la semaine à
dimanche (6) ou à tout autre jour de la semaine. Les paramètres pour
spécifier les dates sont donnés sous forme de nombres entiers. Voir
aussi les modules "datetime" et "time".

Les fonctions et les classes définies dans ce module utilisent un
calendrier idéalisé, le calendrier grégorien actuel s'étendant
indéfiniment dans les deux sens. Cela correspond à la définition du
calendrier grégorien proleptique dans le livre de Dershowitz et
Reingold « *Calendrical Calculations* », œuvre dans lequel il est le
calendrier de référence de tous les calculs. Les années zéros et les
années négatives sont interprétées comme prescrit par la norme ISO
8601. L'année 0 est 1 avant JC, l'année "-1" est 2 avant JC et ainsi
de suite.

class calendar.Calendar(firstweekday=0)

   Crée un objet "Calendar". *firstweekday* est un entier spécifiant
   le premier jour de la semaine, valant par défaut "0" (soit "MONDAY"
   pour lundi), pouvant aller jusqu'à "6" (soit "SUNDAY" pour
   dimanche).

   L'objet "Calendar" fournit plusieurs méthodes pouvant être
   utilisées pour préparer les données du calendrier pour le
   formatage. Cette classe ne fait pas de formatage elle-même. Il
   s'agit du travail des sous-classes.

   Les instances de "Calendar" ont les méthodes suivantes :

   iterweekdays()

      Renvoie un itérateur sur les numéros des jours d'une semaine. La
      première valeur est donc la même que la valeur de la propriété
      "firstweekday".

   itermonthdates(year, month)

      Renvoie un itérateur sur les jours du mois *month* (1 à 12) de
      l'année *year*. Cet itérateur renvoie tous les jours du mois
      (sous forme d'instances de "datetime.date") ainsi que tous les
      jours avant le début du mois et après la fin du mois nécessaires
      pour obtenir des semaines complètes.

   itermonthdays(year, month)

      Renvoie un itérateur sur les jours du mois *month* de l'année
      *year*, comme "itermonthdates()", sans être limité par
      l'intervalle de "datetime.date". Les jours renvoyés sont
      simplement les numéros des jours du mois. Pour les jours en
      dehors du mois spécifié, le numéro du jour est "0".

   itermonthdays2(year, month)

      Renvoie un itérateur sur les jours du mois *month* de l'année
      *year* comme "itermonthdates()", sans être limité par la plage
      "datetime.date". Les jours renvoyés sont des paires composées du
      numéro du jour dans le mois et du numéro du jour dans la
      semaine.

   itermonthdays3(year, month)

      Renvoie un itérateur sur les jours du *month* de l'année *year*,
      comme "itermonthdates()", sans être limité par l'intervalle de
      "datetime.date". Les jours sont renvoyés sous forme de triplets
      composés du numéro de l'année, du mois et du jour dans le mois.

      Ajouté dans la version 3.7.

   itermonthdays4(year, month)

      Renvoie un itérateur sur les jours du mois *month* de l'année
      *year*, comme "itermonthdates()", sans être limité par
      l'intervalle de "datetime.date". Le jours sont renvoyés sous
      forme de quadruplets contenant le numéro de l'année, du mois, du
      jour du mois et du jour de la semaine.

      Ajouté dans la version 3.7.

   monthdatescalendar(year, month)

      Renvoie la liste des semaines complètes du mois *month* de
      l'année *year*. Les semaines sont des listes de sept objets
      "datetime.date".

   monthdays2calendar(year, month)

      Renvoie la liste des semaines complètes du mois *month* de
      l'année *year*. Les semaines sont des listes de sept paires
      contenant le numéro du jour dans le mois et du numéro du jour
      dans la semaine.

   monthdayscalendar(year, month)

      Renvoie la liste des semaines complètes du mois *month* de
      l'année *year*. Les semaines sont une liste de sept numéros de
      jours.

   yeardatescalendar(year, width=3)

      Renvoie ce qu'il faut pour afficher correctement une année. La
      valeur renvoyée est une liste de lignes de mois. Chaque ligne
      mensuelle contient jusqu'à *width* mois (avec une valeur par
      défaut à 3). Chaque mois contient de 4 à 6 semaines et chaque
      semaine 1 à 7 jours. Les jours sont des objets "datetime.date".

   yeardays2calendar(year, width=3)

      Renvoie ce qu'il faut pour afficher correctement une année,
      (similaire à "yeardatescalendar()"). Les listes des semaines
      contiennent des paires contenant le numéro du jour du mois et le
      numéro du jour de la semaine. Les numéro des jours en dehors de
      ce mois sont à zéro.

   yeardayscalendar(year, width=3)

      Renvoie ce qu'il faut pour afficher correctement une année,
      (similaire à "yeardatescalendar()"). Les listes de semaines
      contiennent des numéros de jours. Les numéros de jours en dehors
      de ce mois sont de zéro.

class calendar.TextCalendar(firstweekday=0)

   Cette classe peut être utilisée pour générer des calendriers en
   texte brut.

   Les instances "TextCalendar" exposent les méthodes suivantes :

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

      Donne le calendrier d'un mois dans une chaîne multi-ligne. Si
      *w* est fourni, il spécifie la largeur des colonnes de date, qui
      sont centrées. Si *l* est donné, il spécifie le nombre de lignes
      que chaque semaine utilisera. Le résultat varie en fonction du
      premier jour de la semaine spécifié dans le constructeur ou
      défini par la méthode "setfirstweekday()".

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

      Affiche le calendrier d'un mois tel que renvoyé par
      "formatmonth()".

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

      Renvoie un calendrier de *m* colonnes pour une année entière
      sous forme de chaîne multi-ligne. Les paramètres facultatifs
      *w*, *l* et *c* correspondent respectivement à la largeur de la
      colonne date, les lignes par semaines, le nombre d'espace entre
      les colonnes de mois. Le résultat varie en fonction du premier
      jour de la semaine spécifié dans le constructeur ou défini par
      la méthode "setfirstweekday()". La première année pour laquelle
      un calendrier peut être généré, dépend de la plateforme.

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

      Affiche le calendrier pour une année entière comme renvoyé par
      "formatyear()".

class calendar.HTMLCalendar(firstweekday=0)

   Cette classe peut être utilisée pour générer des calendriers HTML.

   Les instances de "HTMLCalendar" utilisent les méthodes suivantes :

   formatmonth(theyear, themonth, withyear=True)

      Renvoie le calendrier d'un mois sous la forme d'une table HTML.
      Si *withyear* est vrai l'année sera inclue dans l'en-tête, sinon
      seul le nom du mois sera utilisé.

   formatyear(theyear, width=3)

      Renvoie le calendrier d'une année sous la forme d'une table
      HTML. *width* (par défaut à 3) spécifie le nombre de mois par
      ligne.

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

      Renvoie le calendrier d'une année sous la forme d'une page HTML
      complète. *width* (par défaut à 3) spécifie le nombre de mois
      par ligne. *css* est le nom de la feuille de style en cascade à
      utiliser. "None" peut être passé si aucune feuille de style ne
      doit être utilisée. *encoding* spécifie l'encodage à utiliser
      pour les données de sortie (par défaut l'encodage par défaut du
      système).

   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" possède les attributs suivants que vous pouvez
   surcharger pour personnaliser les classes CSS utilisées par le
   calendrier :

   cssclasses

      Une liste de classes CSS utilisées pour chaque jour de la
      semaine. La liste par défaut de la classe est :

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

      davantage de styles peuvent être ajoutés pour chaque jour :

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

      Notez que la longueur de cette liste doit être de sept éléments.

   cssclass_noday

      La classe CSS pour le jour de la semaine apparaissant dans le
      mois précédent ou à venir.

      Ajouté dans la version 3.7.

   cssclasses_weekday_head

      Une liste de classes CSS utilisées pour les noms des jours de la
      semaine dans la ligne d'en-tête. Par défaut les mêmes que
      "cssclasses".

      Ajouté dans la version 3.7.

   cssclass_month_head

      La classe CSS du mois en en-tête (utilisé par
      "formatmonthname()"). La valeur par défaut est ""month"".

      Ajouté dans la version 3.7.

   cssclass_month

      La classe CSS pour la table du mois entière (utilisé par
      "formatmonth()"). La valeur par défaut est ""month"".

      Ajouté dans la version 3.7.

   cssclass_year

      La classe CSS pour la table entière des tables de l'année
      (utilisé par "formatyear()"). La valeur par défaut est ""year"".

      Ajouté dans la version 3.7.

   cssclass_year_head

      La classe CSS pour l'en-tête de la table pour l'année entière
      (utilisé par "formatyear()"). La valeur par défaut est ""year"".

      Ajouté dans la version 3.7.

   Notez que même si le nommage ci-dessus des attributs de classe est
   au singulier (p. ex. "cssclass_month" "cssclass_noday"), on peut
   remplacer la seule classe CSS par une liste de classes CSS séparées
   par une espace, par exemple :

      "text-bold text-red"

   Voici un exemple de comment peut être personnalisée "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)

   Il est possible de passer un nom de locale au constructeur de la
   sous-classe de "TextCalendar". Elle renvoie les noms des mois et
   des jours de la semaine dans la locale précisée.

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

   Il est possible de passer un nom de locale au constructeur de la
   sous-classe de "HTMLCalendar". Elle renvoie les noms des mois et
   des jours de la semaine dans la locale précisée.

Note:

  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.

Pour les calendriers texte simples ce module fournit les fonctions
suivantes.

calendar.setfirstweekday(weekday)

   Fixe le jour de la semaine ("0" pour lundi, "6" pour dimanche) qui
   débute chaque semaine. Les valeurs "MONDAY", "TUESDAY",
   "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", et "SUNDAY" sont
   fournies par commodité. Par exemple, pour fixer le premier jour de
   la semaine à dimanche :

      import calendar
      calendar.setfirstweekday(calendar.SUNDAY)

calendar.firstweekday()

   Renvoie le réglage courant pour le jour de la semaine débutant
   chaque semaine.

calendar.isleap(year)

   Renvoie "True" si *year* est une année bissextile, sinon "False".

calendar.leapdays(y1, y2)

   Renvoie le nombre d'années bissextiles dans la période de *y1* à
   *y2* (non inclus), où *y1* et *y2* sont des années.

   Cette fonction marche pour les périodes couvrant un changement de
   siècle.

calendar.weekday(year, month, day)

   Renvoie le jour de la semaine ("0" pour lundi) pour *year*
   ("1970"-- …), *month* ("1"--"12"), *day* ("1"--"31").

calendar.weekheader(n)

   Renvoie un en-tête contenant les jours de la semaine en abrégé. *n*
   spécifie la largeur en caractères pour un jour de la semaine.

calendar.monthrange(year, month)

   Renvoie le jour de la semaine correspondant au premier jour du mois
   et le nombre de jours dans le mois, pour l'année *year* et le mois
   *month* spécifiés.

calendar.monthcalendar(year, month)

   Renvoie une matrice représentant le calendrier d'un mois. Chaque
   ligne représente une semaine ; les jours en dehors du mois sont
   représentés par des zéros. Chaque semaine débute avec le lundi à
   moins de l'avoir modifié avec "setfirstweekday()".

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

   Affiche le calendrier d'un mois tel que renvoyé par "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)

   Affiche le calendrier pour une année entière tel que renvoyé par
   "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)

   Une fonction sans rapport mais pratique, qui prend un *n*-uplet
   temporel tel que celui renvoyé par la fonction "gmtime()" dans le
   module "time", et renvoie la valeur d'horodatage Unix (*timestamp*
   en anglais) correspondante, en supposant une époque de 1970, et
   l'encodage POSIX. En fait, "time.gmtime()" et "timegm()" sont
   l'inverse l'un de l'autre.

Le module "calendar" exporte les attributs suivants :

calendar.day_name

   Un tableau qui représente les jours de la semaine pour les
   paramètres régionaux actifs.

calendar.day_abbr

   Un tableau qui représente les jours de la semaine en abrégé pour
   les paramètres régionaux actifs.

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".

   Ajouté dans la 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".

   Ajouté dans la version 3.12.

calendar.month_name

   Un tableau qui représente les mois de l'année pour les paramètres
   régionaux actifs. Ceux-ci respectent la convention usuelle où
   janvier est le mois numéro 1, donc il a une longueur de 13 et
   "month_name[0]" est la chaîne vide.

calendar.month_abbr

   Un tableau qui représente les mois de l'année en abrégé pour les
   paramètres régionaux actifs. Celui-ci respectent la convention
   usuelle où janvier est le mois numéro 1, donc il a une longueur de
   13 et "month_name[0]" est la chaîne vide.

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".

   Ajouté dans la 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".

   Ajouté dans la 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.

Voir aussi:

  Module "datetime"
     Interface orientée objet pour les dates et les heures avec des
     fonctionnalités similaires au module "time".

  Module "time"
     Fonctions bas niveau relatives au temps.


Command-Line Usage
==================

Ajouté dans la 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]
                      [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

The following options are accepted:

--help, -h

   Show the help message and exit.

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

year

   The year to print the calendar for. Must be a number between 1 and
   9999. 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.

*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.
