# `calendar` — Fonctions calendaires générales

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` (lundi), pouvant aller jusqu'à `6` (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.

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

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

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

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

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

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

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

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

    Nouveau 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)

  Le constructeur de cette sous-classe de `TextCalendar` accepte un paramètre régional locale : une langue au format `"fr_FR.UTF-8"`, et renvoie les noms de mois et de jours de la semaine traduits dans cette langue. Si ce lieu possède un encodage, toutes les chaînes contenant des noms de mois ou de jours de la semaine seront renvoyées en Unicode.

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

  Cette sous-classe de `HTMLCalendar` peut recevoir un nom de lieu dans le constructeur et renvoie les noms de mois et de jours de la semaine selon le lieu spécifié. Si ce lieu possède un encodage, toutes les chaînes contenant des noms de mois ou de jours de la semaine seront renvoyées en Unicode.

Note

Les méthodes `formatweekday()` et `formatmonthname()` de ces deux classes changent temporairement le paramètre régional courant pour le paramètre donné via locale . Comme le paramètre régional est un réglage de l'ensemble du processus, elles ne sont pas utilisables de manière sûre avec les programmes à fils d'exécution multiples.

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)

  Renvoie le calendrier d'un mois dans une chaîne multi-lignes en utilisant la méthode `formatmonth()` de la classe `TextCalendar`.

`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)

  Renvoie un calendrier sur 3 colonnes pour une année entière dans une chaîne multi-lignes en utilisant la méthode `formatyear()` de la classe `TextCalendar`.

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

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.