datetime — Types de base pour la date et l'heure

Code source : Lib/datetime.py

Le module datetime fournit des classes permettant de manipuler les dates et les heures.

Bien que les calculs de date et d'heure sont gérés, l'attention lors de l'implémentation s'est essentiellement portée sur l'efficacité de l'extraction des attributs en vue de leur manipulation et formatage pour l'affichage.

Astuce

Skip to the format codes.

Voir aussi

Module calendar

Fonctions génériques associées au calendrier.

Module time

Accès aux données d'horaires et aux conversions associées.

Module zoneinfo

Fuseaux horaires concrets représentant la base de données IANA.

Paquet dateutil

Bibliothèque tierce avec prise en charge complète du fuseau horaire et de l'analyse de dates sous forme textuelle.

Package DateType

Third-party library that introduces distinct static types to e.g. allow static type checkers to differentiate between naive and aware datetimes.

Objets avisés et naïfs

Les objets date et time peuvent être classés comme « avisés » ou « naïfs » selon qu'ils contiennent ou non des informations sur le fuseau horaire.

Un objet avisé possède suffisamment de connaissance des règles à appliquer et des politiques d'ajustement de l'heure comme les informations sur les fuseaux horaires et l'heure d'été pour se situer de façon relative par rapport à d'autres objets avisés. Un objet avisé est utilisé pour représenter un instant précis qui n'est pas ouvert à l'interprétation 1.

Un objet naïf ne comporte pas assez d'informations pour se situer sans ambiguïté par rapport à d'autres objets date/time. Le fait qu'un objet naïf représente un Temps universel coordonné (UTC), une heure locale ou une heure dans un autre fuseau horaire dépend complètement du programme, tout comme un nombre peut représenter une longueur, un poids ou une distance pour le programme. Les objets naïfs sont simples à comprendre et il est aisé de travailler avec, au prix de négliger certains aspects de la réalité.

Pour les applications nécessitant des objets avisés, les objets datetime et time ont un attribut facultatif renseignant le fuseau horaire, tzinfo, qui peut être une instance d'une sous-classe de la classe abstraite tzinfo. Ces objets tzinfo regroupent des informations sur le décalage par rapport à l'heure UTC, le nom du fuseau horaire, et si l'heure d'été est en vigueur.

Notez qu'une seule classe concrète tzinfo, la classe timezone, est proposée par le module datetime. La classe timezone représente des fuseaux horaires simples avec un décalage fixe par rapport à UTC, comme UTC lui-même ou les fuseaux EST et EDT d'Amérique du Nord. Gérer des fuseaux horaires d'un niveau de détails plus avancé est à la charge de l'application. Les règles d'ajustement du temps à travers le monde sont plus politiques que rationnelles, changent fréquemment, et il n'y a pas de standard qui vaille pour toute application, en dehors d'UTC.

Constantes

Le module datetime exporte les constantes suivantes :

datetime.MINYEAR

Le numéro d'année le plus petit autorisé dans un objet date ou datetime. MINYEAR vaut 1.

datetime.MAXYEAR

Le numéro d'année le plus grand autorisé dans un objet date ou datetime. MAXYEAR vaut 9999.

datetime.UTC

Alias du singleton de fuseau horaire UTC datetime.timezone.utc.

Nouveau dans la version 3.11.

Types disponibles

class datetime.date

Une date naïve idéalisée, en supposant que le calendrier Grégorien actuel a toujours existé et qu'il existera toujours. Attributs : year, month et day.

class datetime.time

Un temps idéalisé, indépendant d'une date particulière, en supposant qu'une journée est composée d'exactement 24*60*60 secondes (il n'y a pas ici de notion de « seconde intercalaire »). Attributs : hour, minute, second, microsecond et tzinfo.

class datetime.datetime

Une combinaison d'une date et d'une heure. Attributs : year, month, day, hour, minute, second, microsecond, et tzinfo.

class datetime.timedelta

Une durée qui exprime la différence entre deux instances de date, time ou datetime en microsecondes.

class datetime.tzinfo

Une classe mère abstraite pour les objets portants des informations sur les fuseaux horaires. Ceux-ci sont utilisés par les classes datetime et time pour donner une notion personnalisable d'ajustement d'horaire (par exemple la prise en compte d'un fuseau horaire et/ou de l'heure d'été).

class datetime.timezone

Une classe qui implémente la classe mère abstraite tzinfo en tant que décalage fixe par rapport au temps UTC.

Nouveau dans la version 3.2.

Les objets issus de ces types sont immuables.

Relations entre les sous-classes :

object
    timedelta
    tzinfo
        timezone
    time
    date
        datetime

Propriétés communes

Les types date, datetime, time, et timezone partagent les caractéristiques suivantes :

  • Les objets issus de ces types sont immuables.

  • Les objets de ces types sont hachable, ce qui signifie qu'ils peuvent être utilisés comme clés de dictionnaire.

  • Les objets de ces types peuvent être sérialisés efficacement par le module pickle.

Catégorisation d'un objet en « avisé » ou « naïf »

Les objets de type date sont toujours naïfs.

Un objet du type time ou datetime peut être avisé ou naïf.

Un objet datetime d est avisé si les deux conditions suivantes vérifient :

  1. d.tzinfo ne vaut pas None

  2. d.tzinfo.utcoffset(d) ne renvoie pas None

Autrement, d est naïf.

Un objet time t est avisé si les deux conditions suivantes vérifient :

  1. t.tzinfo ne vaut pas None

  2. t.tzinfo.utcoffset(None) ne renvoie pas None.

Autrement, t est naïf.

La distinction entre avisé et naïf ne s'applique pas aux objets de type timedelta.

Objets timedelta

Un objet timedelta représente une durée, c'est-à-dire la différence entre deux dates ou heures.

class datetime.timedelta(days=0, seconds=0, microseconds=0, milliseconds=0, minutes=0, hours=0, weeks=0)

Tous les arguments sont optionnels et ont 0 comme valeur par défaut. Les arguments peuvent être des entiers ou des flottants et ils peuvent être positifs ou négatifs.

Seuls les jours, les secondes et les microsecondes sont stockés en interne. Les arguments sont convertis dans ces unités :

  • Une milliseconde est convertie en 1000 microsecondes.

  • Une minute est convertie en 60 secondes.

  • Une heure est convertie en 3600 secondes.

  • Une semaine est convertie en 7 jours.

et ensuite les jours, secondes et microsecondes sont normalisés pour que la représentation soit unique avec

  • 0 <= microseconds < 1000000

  • 0 <= secondes < 3600*24 (le nombre de secondes dans une journée)

  • -999999999 <= days <= 999999999

L'exemple suivant illustre comment tous les arguments autres que days, seconds et microseconds sont « fusionnés » et normalisés dans ces trois attributs résultants :

>>> from datetime import timedelta
>>> delta = timedelta(
...     days=50,
...     seconds=27,
...     microseconds=10,
...     milliseconds=29000,
...     minutes=5,
...     hours=8,
...     weeks=2
... )
>>> # Only days, seconds, and microseconds remain
>>> delta
datetime.timedelta(days=64, seconds=29156, microseconds=10)

Si l'un des arguments est un flottant et qu'il y a des microsecondes décimales, les microsecondes décimales laissées par les arguments sont combinées et leur somme est arrondie à la microseconde la plus proche en arrondissant les demis vers le nombre pair. Si aucun argument n'est flottant, les processus de conversion et de normalisation seront exacts (pas d'informations perdues).

Si la valeur normalisée des jours déborde de l'intervalle indiqué, une OverflowError est levée.

Notez que la normalisation de valeurs négatives peut être surprenante au premier abord. Par exemple :

>>> from datetime import timedelta
>>> d = timedelta(microseconds=-1)
>>> (d.days, d.seconds, d.microseconds)
(-1, 86399, 999999)

Attributs de la classe :

timedelta.min

L'objet timedelta le plus négatif, timedelta(-999999999).

timedelta.max

L'objet timedelta le plus positif, timedelta(days=999999999, hours=23, minutes=59, seconds=59, microseconds=999999).

timedelta.resolution

La plus petite différence entre des objets timedelta non égaux, timedelta(microseconds=1).

Il est à noter, du fait de la normalisation, que timedelta.max > -timedelta.min. -timedelta.max n'est pas représentable sous la forme d'un objet timedelta.

Attributs de l'instance (en lecture seule) :

Attribut

Valeur

days

Entre -999999999 et 999999999 inclus

seconds

Entre 0 et 86399 inclus

microseconds

Entre 0 et 999999 inclus

Opérations gérées :

Opération

Résultat

t1 = t2 + t3

Somme de t2 et t3. Ensuite t1 - t2 == t3 et t1 - t3 == t2 sont des expressions vraies. (1)

t1 = t2 - t3

Différence entre t2 et t3. Ensuite t1 == t2 - t3 et t2 == t1 + t3 sont des expressions vraies. (1)(6)

t1 = t2 * i or t1 = i * t2

Delta multiplié par un entier. Ensuite t1 // i == t2 est vrai, en admettant que i != 0.

De manière générale, t1 \ i == t1 \ (i-1) + t1 est vrai. (1)

t1 = t2 * f or t1 = f * t2

Delta multiplié par un flottant. Le résultat est arrondi au multiple le plus proche de timedelta.resolution en utilisant la règle de l'arrondi au pair le plus proche.

f = t2 / t3

Division (3) de la durée totale t2 par l'unité d'intervalle t3. Renvoie un objet float.

t1 = t2 / f or t1 = t2 / i

Delta divisé par un flottant ou un entier. Le résultat est arrondi au multiple le plus proche de timedelta.resolution en utilisant la règle de l'arrondi au pair le plus proche.

t1 = t2 // i or t1 = t2 // t3

Le quotient est calculé et le reste (s'il y en a un) est ignoré. Dans le second cas, un entier est renvoyé. (3)

t1 = t2 % t3

Le reste est calculé comme un objet de type timedelta. (3)

q, r = divmod(t1, t2)

Calcule le quotient et le reste : q = t1 // t2 (3) et r = t1 % t2. q est un entier et r est un objet timedelta.

+t1

Renvoie un objet timedelta avec la même valeur. (2)

-t1

équivalent à timedelta(-t1.days, -t1.seconds, -t1.microseconds), et à t1 * -1. (1)(4)

abs(t)

équivalent à +t quand t.days >= 0, et à -t quand t.days < 0. (2)

str(t)

Renvoie une chaîne de la forme [D day[s], ][H]H:MM:SS[.UUUUUU], où D est négatif pour t négatif. (5)

repr(t)

Renvoie une chaîne de la forme objet timedelta comme un appel construit avec des valeurs d'attributs canoniques.

Notes :

  1. Ceci est exact, mais peut provoquer un débordement.

  2. Ceci est exact, et ne peut pas provoquer un débordement.

  3. Une division par 0 lève une ZeroDivisionError.

  4. -timedelta.max n'est pas représentable avec un objet timedelta.

  5. La représentation en chaîne des objets timedelta est normalisée similairement à leur représentation interne. Cela amène à des résultats inhabituels pour des timedeltas négatifs. Par exemple :

    >>> timedelta(hours=-5)
datetime.timedelta(days=-1, seconds=68400)
>>> print(_)
-1 day, 19:00:00

  6. L'expression t2 - t3 est toujours égale à l'expression t2 + (-t3) sauf si t3 vaut timedelta.max ; dans ce cas, la première expression produit une valeur alors que la seconde produit un débordement.

En plus des opérations listées ci-dessus, les objets timedelta implémentent certaines additions et soustractions avec des objets date et datetime (voir ci-dessous).

Modifié dans la version 3.2: La division entière et la vraie division d'un objet timedelta par un autre timedelta sont maintenant gérées, comme le sont les opérations de reste euclidien et la fonction divmod(). La vraie division et la multiplication d'un objet timedelta par un float sont maintenant implémentées.

Les comparaisons des objets timedelta sont gérées, avec quelques réserves.

Les comparaisons == ou != renvoient toujours un bool, quel que soit le type de l'objet comparé :

>>> from datetime import timedelta
>>> delta1 = timedelta(seconds=57)
>>> delta2 = timedelta(hours=25, seconds=2)
>>> delta2 != delta1
True
>>> delta2 == 5
False

Pour toutes les autres comparaisons (telles que < et >), lorsqu'un objet timedelta est comparé à un objet d'un type différent, une TypeError est levée :

>>> delta2 > delta1
True
>>> delta2 > 5
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: '>' not supported between instances of 'datetime.timedelta' and 'int'

Dans les contextes booléens, un objet timedelta est considéré comme vrai si et seulement s'il n'est pas égal à timedelta(0).

Méthodes de l'instance :

timedelta.total_seconds()

Renvoie le nombre total de secondes contenues dans la durée. Équivalent à td / timedelta(seconds=1). Pour un intervalle dont l'unité n'est pas la seconde, utilisez directement la division (par exemple, td / timedelta(microseconds=1)).

Notez que pour des intervalles de temps très larges (supérieurs à 270 ans sur la plupart des plateformes), cette méthode perdra la précision des microsecondes.

Nouveau dans la version 3.2.

Exemples d'utilisation de la classe timedelta :

Un exemple supplémentaire de normalisation :

>>> # Components of another_year add up to exactly 365 days
>>> from datetime import timedelta
>>> year = timedelta(days=365)
>>> another_year = timedelta(weeks=40, days=84, hours=23,
...                          minutes=50, seconds=600)
>>> year == another_year
True
>>> year.total_seconds()
31536000.0

Exemples d'arithmétique avec la classe timedelta :

>>> from datetime import timedelta
>>> year = timedelta(days=365)
>>> ten_years = 10 * year
>>> ten_years
datetime.timedelta(days=3650)
>>> ten_years.days // 365
10
>>> nine_years = ten_years - year
>>> nine_years
datetime.timedelta(days=3285)
>>> three_years = nine_years // 3
>>> three_years, three_years.days // 365
(datetime.timedelta(days=1095), 3)

Objets date

Un objet date représente une date (année, mois et jour) dans un calendrier idéal, le calendrier grégorien actuel étant indéfiniment étendu dans les deux sens.

Le 1 er janvier de l'année 1 est appelé jour numéro 1, le 2 janvier de l'année 1 est appelé jour numéro 2, et ainsi de suite. 2

class datetime.date(year, month, day)

Tous les arguments sont requis. Les arguments peuvent être des entiers, dans les intervalles suivants :

  • MINYEAR <= year <= MAXYEAR

  • 1 <= month <= 12

  • 1 <= day <= nombre de jours dans le mois et l'année donnés

Si un argument est donné en dehors de ces intervalles, une ValueError est levée.

Autres constructeurs, méthodes de classe :

classmethod date.today()

Renvoie la date locale courante.

Cela est équivalent à date.fromtimestamp(time.time()).

classmethod date.fromtimestamp(timestamp)

Renvoie la date locale correspondant à l'horodatage POSIX, telle que renvoyée par time.time().

Elle peut lever une OverflowError, si l'horodatage est en dehors des bornes gérées par la fonction C localtime() de la plateforme, et une exception OSError en cas d'échec de localtime(). Il est commun d'être restreint aux années entre 1970 et 2038. Notez que sur les systèmes non POSIX qui incluent les secondes intercalaires dans leur notion d'horodatage, ces secondes sont ignorées par fromtimestamp().

Modifié dans la version 3.3: Lève une OverflowError plutôt qu'une ValueError si l'horodatage (timestamp en anglais) est en dehors des bornes gérées par la fonction C localtime() de la plateforme. Lève une OSError plutôt qu'une ValueError en cas d'échec de localtime().

classmethod date.fromordinal(ordinal)

Renvoie la date correspondant à l'ordinal grégorien proleptique, où le 1er janvier de l'an 1 a l'ordinal 1.

ValueError est levée à moins que 1 <= ordinal <= date.max.toordinal(). Pour toute date d, date.fromordinal(d.toordinal()) == d.

classmethod date.fromisoformat(date_string)

Renvoie une date correspondant à date_string dans un format ISO 8601 valide, à part les dates ordinales (ex: YYYY-DDD) :

>>> from datetime import date
>>> date.fromisoformat('2019-12-04')
datetime.date(2019, 12, 4)
>>> date.fromisoformat('20191204')
datetime.date(2019, 12, 4)
>>> date.fromisoformat('2021-W01-1')
datetime.date(2021, 1, 4)

Nouveau dans la version 3.7.

Modifié dans la version 3.11: Auparavant, cette méthode prenait en charge seulement le format YYYY-MM-DD.

classmethod date.fromisocalendar(year, week, day)

Renvoie une date correspondant à la date du calendrier ISO définie par l'année, la semaine et le jour. C'est la réciproque de la fonction date.isocalendar().

Nouveau dans la version 3.8.

Attributs de la classe :

date.min

La plus vieille date représentable, date(MINYEAR, 1, 1).

date.max

La dernière date représentable, date(MAXYEAR, 12, 31).

date.resolution

La plus petite différence possible entre deux objets dates non-égaux, timedelta(days=1).

Attributs de l'instance (en lecture seule) :

date.year

Entre MINYEAR et MAXYEAR inclus.

date.month

Entre 1 et 12 inclus.

date.day

Entre 1 et le nombre de jours du mois donné de l'année donnée.

Opérations gérées :

Opération

Résultat

date2 = date1 + timedelta

date2 est décalée de timedelta.days jours par rapport à date1. (1)

date2 = date1 - timedelta

Calcule date2 de façon à avoir date2 + timedelta == date1. (2)

timedelta = date1 - date2

(3)

date1 < date2

date1 est considérée comme inférieure à date2 quand date1 précède date2 dans le temps. (4)

Notes :

  1. date2 est déplacée en avant dans le temps si timedelta.days > 0, ou en arrière si timedelta.days < 0. Après quoi date2 - date1 == timedelta.days. timedelta.seconds et timedelta.microseconds sont ignorés. Une OverflowError est levée si date2.year devait être inférieure à MINYEAR ou supérieure à MAXYEAR.

  2. timedelta.seconds et timedelta.microseconds sont ignorés.

  3. Cela est exact, et ne peut pas provoquer de débordement. timedelta.seconds et timedelta.microseconds valent 0, et date2 + timedelta == date1 après cela.

  4. En d'autres termes, date1 < date2 si et seulement si date1.toordinal() < date2.toordinal(). La comparaison de dates lève une TypeError si l'autre opérande n'est pas un objet date. Cependant, NotImplemented est renvoyé à la place si l'autre opérande a un attribut timetuple(). Cela permet à d'autres types d'objets dates d'avoir une chance d'implémenter une comparaison entre types différents. Sinon, quand un objet date est comparé à un objet d'un type différent, une TypeError est levée à moins que la comparaison soit == ou !=. Ces derniers cas renvoient respectivement False et True.

Dans des contextes booléens, tous les objets date sont considérés comme vrai.

Méthodes de l'instance :

date.replace(year=self.year, month=self.month, day=self.day)

Renvoie une date avec la même valeur, à l'exception des paramètres nommés pour lesquels une nouvelle valeur est donnée en argument.

Exemple :

>>> from datetime import date
>>> d = date(2002, 12, 31)
>>> d.replace(day=26)
datetime.date(2002, 12, 26)
date.timetuple()

Renvoie une time.struct_time telle que renvoyée par time.localtime().

Les heures, minutes et secondes sont égales à 0 et le drapeau DST vaut -1.

d.timetuple() est équivalent à :

time.struct_time((d.year, d.month, d.day, 0, 0, 0, d.weekday(), yday, -1))

où yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1 est le numéro du jour dans l'année courante commençant par 1 pour le 1er janvier.

date.toordinal()

Renvoie l'ordinal grégorien proleptique de la date, où le 1er janvier de l'an 1 a l'ordinal 1. Pour tout objet date d, date.fromordinal(d.toordinal()) == d.

date.weekday()

Renvoie le jour de la semaine sous forme de nombre, où lundi vaut 0 et dimanche vaut 6. Par exemple, date(2002, 12, 4).weekday() == 2, un mercredi. Voir aussi isoweekday().

date.isoweekday()

Renvoie le jour de la semaine sous forme de nombre, où lundi vaut 1 et dimanche vaut 7. Par exemple, date(2002, 12, 4).isoweekday() == 3, un mercredi. Voir aussi weekday(), isocalendar().

date.isocalendar()

Renvoie un objet named tuple avec trois composants : year, week et weekday.

Le calendrier ISO est une variante largement utilisée du calendrier grégorien. 3

Une année ISO est composée de 52 ou 53 semaines pleines, où chaque semaine débute un lundi et se termine un dimanche. La première semaine d'une année ISO est la première semaine calendaire (grégorienne) de l'année comportant un jeudi. Elle est appelée la semaine numéro 1, et l'année ISO de ce jeudi est la même que son année Grégorienne.

Par exemple, l'année 2004 débute un jeudi, donc la première semaine de l'année ISO 2004 débute le lundi 29 décembre 2003 et se termine le dimanche 4 janvier 2004 :

>>> from datetime import date
>>> date(2003, 12, 29).isocalendar()
datetime.IsoCalendarDate(year=2004, week=1, weekday=1)
>>> date(2004, 1, 4).isocalendar()
datetime.IsoCalendarDate(year=2004, week=1, weekday=7)

Modifié dans la version 3.9: Le résultat a changé d'un n-uplet à un named tuple.

date.isoformat()

Renvoie une chaîne représentant la date au format ISO 8601, YYYY-MM-DD :

>>> from datetime import date
>>> date(2002, 12, 4).isoformat()
'2002-12-04'
date.__str__()

Pour une date d, str(d) est équivalent à d.isoformat().

date.ctime()

Renvoie une chaîne représentant la date :

>>> from datetime import date
>>> date(2002, 12, 4).ctime()
'Wed Dec  4 00:00:00 2002'

d.ctime() est équivalent à :

time.ctime(time.mktime(d.timetuple()))

sur les plateformes où la fonction C native ctime() (que time.ctime() invoque, mais pas date.ctime()) est conforme au standard C.

date.strftime(format)

Renvoie une chaîne représentant la date, contrôlée par une chaîne de formatage explicite. Les codes de formatage se référant aux heures, minutes ou secondes auront pour valeur 0. Voir Comportement de strftime() et strptime() et date.isoformat().

date.__format__(format)

Identique à date.strftime(). Cela permet de spécifier une chaîne de formatage pour un objet date dans une chaîne de formatage littérale et à l'utilisation de str.format(). Voir Comportement de strftime() et strptime() et date.isoformat().

Exemple d'utilisation de la classe date :

Exemple de décompte des jours avant un évènement :

>>> import time
>>> from datetime import date
>>> today = date.today()
>>> today
datetime.date(2007, 12, 5)
>>> today == date.fromtimestamp(time.time())
True
>>> my_birthday = date(today.year, 6, 24)
>>> if my_birthday < today:
...     my_birthday = my_birthday.replace(year=today.year + 1)
...
>>> my_birthday
datetime.date(2008, 6, 24)
>>> time_to_birthday = abs(my_birthday - today)
>>> time_to_birthday.days
202

Plus d'exemples avec la classe date :

>>> from datetime import date
>>> d = date.fromordinal(730920) # 730920th day after 1. 1. 0001
>>> d
datetime.date(2002, 3, 11)

>>> # Methods related to formatting string output
>>> d.isoformat()
'2002-03-11'
>>> d.strftime("%d/%m/%y")
'11/03/02'
>>> d.strftime("%A %d. %B %Y")
'Monday 11. March 2002'
>>> d.ctime()
'Mon Mar 11 00:00:00 2002'
>>> 'The {1} is {0:%d}, the {2} is {0:%B}.'.format(d, "day", "month")
'The day is 11, the month is March.'

>>> # Methods for to extracting 'components' under different calendars
>>> t = d.timetuple()
>>> for i in t:     
...     print(i)
2002                # year
3                   # month
11                  # day
0
0
0
0                   # weekday (0 = Monday)
70                  # 70th day in the year
-1
>>> ic = d.isocalendar()
>>> for i in ic:    
...     print(i)
2002                # ISO year
11                  # ISO week number
1                   # ISO day number ( 1 = Monday )

>>> # A date object is immutable; all operations produce a new object
>>> d.replace(year=2005)
datetime.date(2005, 3, 11)

Objets datetime

Un objet datetime est un seul et même objet contenant toute l'information d'un objet date et d'un objet time.

Comme un objet date, un objet datetime utilise le calendrier Grégorien actuel étendu vers le passé et le futur ; comme un objet time, un objet datetime suppose qu'il y a exactement 3600*24 secondes chaque jour.

Constructeur :

class datetime.datetime(year, month, day, hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

Les arguments year, month et day sont requis. tzinfo peut être None ou une instance d'une sous-classe de tzinfo. Les arguments restant doivent être des nombres, dans les intervalles suivants :

  • MINYEAR <= year <= MAXYEAR,

  • 1 <= month <= 12,

  • 1 <= day <= nombre de jours dans le mois donné de l'année donnée,

  • 0 <= hour < 24,

  • 0 <= minute < 60,

  • 0 <= second < 60,

  • 0 <= microsecond < 1000000,

  • fold in [0, 1].

Si un argument est donné en dehors de ces intervalles, une ValueError est levée.

Nouveau dans la version 3.6: Ajout de l'argument fold.

Autres constructeurs, méthodes de classe :

classmethod datetime.today()

Renvoie la date locale actuelle, avec tzinfo None.

Équivalent à :

datetime.fromtimestamp(time.time())

Voir aussi now(), fromtimestamp().

Cette méthode est fonctionnellement équivalente à now(), mais sans le paramètre tz.

classmethod datetime.now(tz=None)

Renvoie la date et l'heure locale actuelle.

Si l'argument optionnel tz est None ou n'est pas spécifié, la méthode est similaire à today(), mais, si possible, apporte plus de précisions que ce qui peut être trouvé à travers un horodatage time.time() (par exemple, cela peut être possible sur des plateformes fournissant la fonction C gettimeofday()).

Si tz n'est pas None, il doit être une instance d'une sous-classe tzinfo, et la date et l'heure courantes sont converties vers le fuseau horaire tz.

Cette fonction est préférée à today() et utcnow().

classmethod datetime.utcnow()

Renvoie la date et l'heure UTC actuelle, avec tzinfo None.

C'est semblable à now(), mais renvoie la date et l'heure UTC courantes, comme un objet datetime naïf. Un datetime UTC courant avisé peut être obtenu en appelant datetime.now(timezone.utc). Voir aussi now().

Avertissement

Parce que les objets naïfs datetime sont traités par de nombreuses méthodes datetime comme des heures locales, il est préférable d'utiliser les dates connues pour représenter les heures en UTC. En tant que tel, le moyen recommandé pour créer un objet représentant l'heure actuelle en UTC est d'appeler datetime.now(timezone.utc).

Obsolète depuis la version 3.12: Use datetime.now() with UTC instead.

classmethod datetime.fromtimestamp(timestamp, tz=None)

Renvoie la date et l'heure locales correspondant à l'horodatage (timestamp en anglais) POSIX, comme renvoyé par time.time(). Si l'argument optionnel tz est None ou n'est pas spécifié, l'horodatage est converti vers la date et l'heure locales de la plateforme, et l'objet datetime renvoyé est naïf.

Si tz n'est pas None, il doit être une instance d'une sous-classe tzinfo, et l'horodatage (timestamp en anglais) est converti vers le fuseau horaire tz.

fromtimestamp() peut lever une OverflowError, si l'horodatage est en dehors de l'intervalle de valeurs gérées par les fonctions C localtime() ou gmtime() de la plateforme, et une OSError en cas d'échec de localtime() ou gmtime(). Il est courant d'être restreint aux années de 1970 à 2038. Notez que sur les systèmes non POSIX qui incluent les secondes intercalaires dans leur notion d'horodatage, les secondes intercalaires sont ignorées par fromtimestamp(), et il est alors possible d'avoir deux horodatages différant d'une seconde produisant un objet datetime identique. Cette méthode est préférée à utcfromtimestamp().

Modifié dans la version 3.3: Lève une OverflowError plutôt qu'une ValueError si l'horodatage est en dehors de l'intervalle de valeurs gérées par les fonctions C localtime() ou gmtime() de la plateforme. Lève une OSError plutôt qu'une ValueError en cas d'échec de localtime() ou gmtime().

Modifié dans la version 3.6: fromtimestamp() peut renvoyer des instances avec l'attribut fold à 1.

classmethod datetime.utcfromtimestamp(timestamp)

Renvoie la classe UTC datetime correspondant à l'horodatage POSIX, avec tzinfo None (l'objet résultant est naïf).

Cela peut lever une OverflowError, si l'horodatage est en dehors de l'intervalle de valeurs gérées par la fonction C gmtime() de la plateforme, et une OSError en cas d'échec de gmtime(). Il est courant d'être restreint aux années de 1970 à 2038.

Pour obtenir un objet datetime avisé, appelez fromtimestamp() :

datetime.fromtimestamp(timestamp, timezone.utc)

Sur les plateformes respectant POSIX, cela est équivalent à l'expression suivante :

datetime(1970, 1, 1, tzinfo=timezone.utc) + timedelta(seconds=timestamp)

excepté que la dernière formule gère l'intervalle complet des années entre MINYEAR et MAXYEAR incluses.

Avertissement

Parce que les objets naïfs datetime sont traités par de nombreuses méthodes datetime comme des heures locales, il est préférable d'utiliser les dates connues pour représenter les heures en UTC. En tant que tel, le moyen recommandé pour créer un objet représentant un horodatage spécifique en UTC est d'appeler datetime.fromtimestamp(timestamp, tz=timezone.utc).

Modifié dans la version 3.3: Lève une OverflowError plutôt qu'une ValueError si l'horodatage est en dehors de l'intervalle de valeurs gérées par la fonction C gmtime() de la plateforme. Lève une OSError plutôt qu'une ValueError en cas d'échec de gmtime().

Obsolète depuis la version 3.12: Use datetime.fromtimestamp() with UTC instead.

classmethod datetime.fromordinal(ordinal)

Renvoie le datetime correspondant à l'ordinal du calendrier grégorien proleptique, où le 1er janvier de l'an 1 a l'ordinal 1. Une ValueError est levée à moins que 1 <= ordinal <= datetime.max.toordinal(). Les heures, minutes, secondes et microsecondes du résultat valent toutes 0, et tzinfo est None.

classmethod datetime.combine(date, time, tzinfo=time.tzinfo)

Return a new datetime object whose date components are equal to the given date object's, and whose time components are equal to the given time object's. If the tzinfo argument is provided, its value is used to set the tzinfo attribute of the result, otherwise the tzinfo attribute of the time argument is used. If the date argument is a datetime object, its time components and tzinfo attributes are ignored.

For any datetime object d, d == datetime.combine(d.date(), d.time(), d.tzinfo).

Modifié dans la version 3.6: Ajout de l'argument tzinfo.

classmethod datetime.fromisoformat(date_string)

Renvoie une classe datetime correspondant à date_string dans un format ISO 8601 valide, avec les exceptions suivantes :

  1. Les décalages de fuseaux horaires peuvent comporter des fractions de secondes.

  2. Le séparateur T peut être remplacé par n'importe quel caractère Unicode.

  3. Les dates ordinales ne sont actuellement pas gérées.

  4. Les fractions d'heures et de minutes ne sont pas gérées.

Exemples :

>>> from datetime import datetime
>>> datetime.fromisoformat('2011-11-04')
datetime.datetime(2011, 11, 4, 0, 0)
>>> datetime.fromisoformat('20111104')
datetime.datetime(2011, 11, 4, 0, 0)
>>> datetime.fromisoformat('2011-11-04T00:05:23')
datetime.datetime(2011, 11, 4, 0, 5, 23)
>>> datetime.fromisoformat('2011-11-04T00:05:23Z')
datetime.datetime(2011, 11, 4, 0, 5, 23, tzinfo=datetime.timezone.utc)
>>> datetime.fromisoformat('20111104T000523')
datetime.datetime(2011, 11, 4, 0, 5, 23)
>>> datetime.fromisoformat('2011-W01-2T00:05:23.283')
datetime.datetime(2011, 1, 4, 0, 5, 23, 283000)
>>> datetime.fromisoformat('2011-11-04 00:05:23.283')
datetime.datetime(2011, 11, 4, 0, 5, 23, 283000)
>>> datetime.fromisoformat('2011-11-04 00:05:23.283+00:00')
datetime.datetime(2011, 11, 4, 0, 5, 23, 283000, tzinfo=datetime.timezone.utc)
>>> datetime.fromisoformat('2011-11-04T00:05:23+04:00')   
datetime.datetime(2011, 11, 4, 0, 5, 23,
    tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))

Nouveau dans la version 3.7.

Modifié dans la version 3.11: Auparavant, cette méthode prenait en charge seulement les formats émis par date.isoformat() et datetime.isoformat().

classmethod datetime.fromisocalendar(year, week, day)

Renvoie une classe datetime correspondant à la date du calendrier ISO spécifiée par année, semaine et jour. Les composantes ne relevant pas de la date de datetime sont renseignées avec leurs valeurs par défaut normales. C'est la réciproque de la fonction datetime.isocalendar().

Nouveau dans la version 3.8.

classmethod datetime.strptime(date_string, format)

Renvoie une classe datetime correspondant à date_string, analysée selon format.

Si format ne contient pas de microsecondes ou d'informations sur le fuseau horaire, cela équivaut à :

datetime(*(time.strptime(date_string, format)[0:6]))

Une ValueError est levée si date_string et format ne peuvent être analysés par time.strptime() ou si elle renvoie une valeur qui n'est pas un n-uplet de temps. Voir Comportement de strftime() et strptime() et datetime.fromisoformat().

Attributs de la classe :

datetime.min

Le plus ancien datetime représentable, datetime(MINYEAR, 1, 1, tzinfo=None).

datetime.max

Le dernier datetime représentable, datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, tzinfo=None).

datetime.resolution

La plus petite différence possible entre deux objets datetime non-égaux, timedelta(microseconds=1).

Attributs de l'instance (en lecture seule) :

datetime.year

Entre MINYEAR et MAXYEAR inclus.

datetime.month

Entre 1 et 12 inclus.

datetime.day

Entre 1 et le nombre de jours du mois donné de l'année donnée.

datetime.hour

Dans range(24).

datetime.minute

Dans range(60).

datetime.second

Dans range(60).

datetime.microsecond

Dans range(1000000).

datetime.tzinfo

L'objet passé en tant que paramètre tzinfo du constructeur de la classe datetime ou None si aucun n'a été donné.

datetime.fold

Dans [0, 1]. Utilisé pour désambiguïser les heures dans un intervalle répété. (Un intervalle répété apparaît quand l'horloge est retardée à la fin de l'heure d'été ou quand le décalage horaire UTC du fuseau courant est décrémenté pour des raisons politiques.) La valeur 0 (1) représente le plus ancien (récent) des deux moments représentés par la même heure.

Nouveau dans la version 3.6.

Opérations gérées :

Opération

Résultat

datetime2 = datetime1 + timedelta

(1)

datetime2 = datetime1 - timedelta

(2)

timedelta = datetime1 - datetime2

(3)

datetime1 < datetime2

Compare datetime à datetime. (4)

  1. datetime2 est décalé d'une durée timedelta par rapport à datetime1, en avant dans le temps si timedelta.days > 0, ou en arrière si timedelta.days < 0. Le résultat a le même attribut tzinfo que le datetime d'entrée, et datetime2 - datetime1 == timedelta après l'opération. Une OverflowError est levée si datetime2.year devait être inférieure à MINYEAR ou supérieure à MAXYEAR. Notez qu'aucun ajustement de fuseau horaire n'est réalisé même si l'entrée est avisée.

  2. Calcule datetime2 tel que datetime2 + timedelta == datetime1. Comme pour l'addition, le résultat a le même attribut tzinfo que le datetime d'entrée, et aucun ajustement de fuseau horaire n'est réalisé même si l'entrée est avisée.

  3. La soustraction d'un datetime à un autre datetime n'est définie que si les deux opérandes sont naïfs, ou s'ils sont les deux avisés. Si l'un est avisé et que l'autre est naïf, une TypeError est levée.

    Si les deux sont naïfs, ou que les deux sont avisés et ont le même attribut tzinfo, les attributs tzinfo sont ignorés, et le résultat est un objet timedelta t tel que datetime2 + t == datetime1. Aucun ajustement de fuseau horaire n'a lieu dans ce cas.

    Si les deux sont avisés mais ont des attributs tzinfo différents, a-b agit comme si a et b étaient premièrement convertis vers des datetimes UTC naïfs. Le résultat est (a.replace(tzinfo=None) - a.utcoffset()) - (b.replace(tzinfo=None) - b.utcoffset()) à l'exception que l'implémentation ne produit jamais de débordement.

  4. datetime1 est considéré inférieur à datetime2 quand il le précède dans le temps.

    Si un opérande est naïf et l'autre avisé, une TypeError est levée si une comparaison d'ordre est attendue. Pour les comparaisons d'égalité, les instances naïves ne sont jamais égales aux instances avisées.

    Si les deux opérandes sont avisés, et ont le même attribut tzinfo, l'attribut commun tzinfo est ignoré et les datetimes de base sont comparés. Si les deux opérandes sont avisés et ont des attributs tzinfo différents, les opérandes sont premièrement ajustés en soustrayant leurs décalages UTC (obtenus depuis self.utcoffset()).

    Modifié dans la version 3.3: Les comparaisons d'égalité entre des instances datetime naïves et avisées ne lèvent pas d'exception TypeError.

    Note

    Afin d'empêcher la comparaison de retomber sur le schéma par défaut de comparaison des adresses des objets, la comparaison datetime lève normalement une exception TypeError si l'autre opérande n'est pas aussi un objet datetime. Cependant, NotImplemented est renvoyé à la place si l'autre opérande a un attribut timetuple(). Cela permet à d'autres types d'objets dates d'implémenter la comparaison entre types mixtes. Sinon, quand un objet datetime est comparé à un objet d'un type différent, une exception TypeError est levée à moins que la comparaison soit == ou !=. Ces derniers cas renvoient respectivement False et True.

Méthodes de l'instance :

datetime.date()

Renvoie un objet date avec les mêmes année, mois et jour.

datetime.time()

Renvoie un objet time avec les mêmes heures, minutes, secondes, microsecondes et fold. tzinfo est None. Voir aussi la méthode timetz().

Modifié dans la version 3.6: La valeur fold est copiée vers l'objet time renvoyé.

datetime.timetz()

Renvoie un objet time avec les mêmes attributs heure, minute, seconde, microseconde, fold et tzinfo. Voir aussi la méthode time().

Modifié dans la version 3.6: La valeur fold est copiée vers l'objet time renvoyé.

datetime.replace(year=self.year, month=self.month, day=self.day, hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, *, fold=0)

Renvoie un datetime avec les mêmes attributs, exceptés ceux dont de nouvelles valeurs sont données par les arguments nommés correspondant. Notez que tzinfo=None peut être spécifié pour créer un datetime naïf depuis un datetime avisé sans conversion de la date ou de l'heure.

Nouveau dans la version 3.6: Ajout de l'argument fold.

datetime.astimezone(tz=None)

Renvoie un objet datetime avec un nouvel attribut tzinfo valant tz, ajustant la date et l'heure pour que le résultat soit le même temps UTC que self, mais dans le temps local au fuseau tz.

S'il est fourni, tz doit être une instance d'une sous-classe de tzinfo, et ses méthodes utcoffset() et dst() ne doivent pas renvoyer None. Si self est naïf, Python considère que le temps est exprimé dans le fuseau horaire du système.

Si appelé sans arguments (ou si tz=None) le fuseau horaire local du système est utilisé comme fuseau horaire cible. L'attribut .tzinfo de l'instance datetime convertie aura pour valeur une instance de timezone avec le nom de fuseau et le décalage obtenus depuis l'OS.

Si self.tzinfo est tz, self.astimezone(tz) est égal à self : aucun ajustement de date ou d'heure n'est réalisé. Sinon le résultat est le temps local dans le fuseau tz représentant le même temps UTC que self : après astz = dt.astimezone(tz), astz - astz.utcoffset() aura les mêmes données de date et d'heure que dt - dt.utcoffset().

Si vous voulez seulement associer un fuseau horaire tz à un datetime dt sans ajustement des données de date et d'heure, utilisez dt.replace(tzinfo=tz). Si vous voulez seulement supprimer le fuseau horaire d'un datetime dt avisé sans conversion des données de date et d'heure, utilisez dt.replace(tzinfo=None).

Notez que la méthode par défaut tzinfo.fromutc() peut être redéfinie dans une sous-classe tzinfo pour affecter le résultat renvoyé par astimezone(). En ignorant les cas d'erreurs, astimezone() se comporte comme :

def astimezone(self, tz):
    if self.tzinfo is tz:
        return self
    # Convert self to UTC, and attach the new time zone object.
    utc = (self - self.utcoffset()).replace(tzinfo=tz)
    # Convert from UTC to tz's local time.
    return tz.fromutc(utc)

Modifié dans la version 3.3: tz peut maintenant être omis.

Modifié dans la version 3.6: La méthode astimezone() peut maintenant être appelée sur des instances naïves qui sont supposées représenter un temps local au système.

datetime.utcoffset()

Si tzinfo est None, renvoie None, sinon renvoie self.tzinfo.utcoffset(self), et lève une exception si l'expression précédente ne renvoie pas None ou un objet timedelta d'une magnitude inférieure à un jour.

Modifié dans la version 3.7: Le décalage UTC peut aussi être autre chose qu'un ensemble de minutes.

datetime.dst()

Si tzinfo est None, renvoie None, sinon renvoie self.tzinfo.dst(self), et lève une exception si l'expression précédente ne renvoie pas None ou un objet timedelta d'une magnitude inférieure à un jour.

Modifié dans la version 3.7: Le décalage DST n'est pas restreint à des minutes entières.

datetime.tzname()

Si tzinfo est None, renvoie None, sinon renvoie self.tzinfo.tzname(self), lève une exception si l'expression précédente ne renvoie pas None ou une chaîne de caractères,

datetime.timetuple()

Renvoie une time.struct_time telle que renvoyée par time.localtime().

d.timetuple() est équivalent à :

time.struct_time((d.year, d.month, d.day,
                  d.hour, d.minute, d.second,
                  d.weekday(), yday, dst))

où yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1 est le numéro de jour dans l'année courante commençant avec 1 pour le 1er janvier. L'option tm_isdist du résultat est attribuée selon la méthode dst() : si tzinfo est None ou dst() renvoie None, tm_isdst est mise à -1 ; sinon, si dst() renvoie une valeur non nulle, tm_isdst est mise à 1 ; sinon tm_isdst est mise à 0.

datetime.utctimetuple()

Si l'instance de datetime d est naïve, cela est équivalent à d.timetuple(), excepté que tm_isdst est forcé à 0 sans tenir compte de ce que renvoie d.dst(). L'heure d'été n'est jamais effective pour un temps UTC.

Si d est avisé, il est normalisé vers un temps UTC, en lui soustrayant d.utcoffset(), et un time.struct_time est renvoyé pour le temps normalisé. tm_isdst est forcé à 0. Notez qu'une OverflowError peut être levée si d.year vaut MINYEAR ou MAXYEAR et que l'ajustement UTC fait déborder la limite de l'année.

Avertissement

Comme les objets datetime naïfs sont traités par de nombreuses méthodes datetime comme des heures locales, il est préférable d'utiliser les datetime avisés pour représenter les heures en UTC ; par conséquent, l'utilisation de datetime.utcfromtimetuple() peut donner des résultats trompeurs. Si vous disposez d'une datetime naïve représentant l'heure UTC, utilisez datetime.replace(tzinfo=timezone.utc) pour la rendre avisée, puis vous pouvez utiliser datetime.timetuple().

datetime.toordinal()

Renvoie l'ordinal du calendrier grégorien proleptique de cette date. Identique à self.date().toordinal().

datetime.timestamp()

Renvoie l'horodatage POSIX correspondant à l'instance datetime. La valeur renvoyée est un float similaire à ceux renvoyés par time.time().

Naive datetime instances are assumed to represent local time and this method relies on the platform C mktime() function to perform the conversion. Since datetime supports wider range of values than mktime() on many platforms, this method may raise OverflowError or OSError for times far in the past or far in the future.

Pour les instances datetime avisées, la valeur renvoyée est calculée comme suit :

(dt - datetime(1970, 1, 1, tzinfo=timezone.utc)).total_seconds()

Nouveau dans la version 3.3.

Modifié dans la version 3.6: La méthode timestamp() utilise l'attribut fold pour désambiguïser le temps dans un intervalle répété.

Note

Il n'y a pas de méthode pour obtenir l'horodatage (timestamp en anglais) POSIX directement depuis une instance datetime naïve représentant un temps UTC. Si votre application utilise cette convention et que le fuseau horaire de votre système n'est pas réglé sur UTC, vous pouvez obtenir l'horodatage POSIX en fournissant tzinfo=timezone.utc :

timestamp = dt.replace(tzinfo=timezone.utc).timestamp()

ou en calculant l'horodatage (timestamp en anglais) directement :

timestamp = (dt - datetime(1970, 1, 1)) / timedelta(seconds=1)
datetime.weekday()

Renvoie le jour de la semaine sous forme de nombre, où lundi vaut 0 et dimanche vaut 6. Identique à self.date().weekday(). Voir aussi isoweekday().

datetime.isoweekday()

Renvoie le jour de la semaine sous forme de nombre, où lundi vaut 1 et dimanche vaut 7. Identique à self.date().isoweekday(). Voir aussi weekday(), isocalendar().

datetime.isocalendar()

Renvoie un n-uplet nommé de 3 éléments : year, week et weekday. Identique à self.date().isocalendar().

datetime.isoformat(sep='T', timespec='auto')

Renvoie une chaîne représentant la date et l'heure au format ISO 8601 :

Si utcoffset() ne renvoie pas None, une chaîne est ajoutée, donnant le décalage UTC :

  • YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]], si microsecond ne vaut pas 0

  • YYYY-MM-DDTHH:MM:SS+HH:MM[:SS[.ffffff]], si microsecond vaut 0

Exemples :

>>> from datetime import datetime, timezone
>>> datetime(2019, 5, 18, 15, 17, 8, 132263).isoformat()
'2019-05-18T15:17:08.132263'
>>> datetime(2019, 5, 18, 15, 17, tzinfo=timezone.utc).isoformat()
'2019-05-18T15:17:00+00:00'

L'argument optionnel sep (par défaut 'T') est un séparateur d'un caractère, placé entre les portions du résultat correspondant à la date et à l'heure. Par exemple :

>>> from datetime import tzinfo, timedelta, datetime
>>> class TZ(tzinfo):
...     """A time zone with an arbitrary, constant -06:39 offset."""
...     def utcoffset(self, dt):
...         return timedelta(hours=-6, minutes=-39)
...
>>> datetime(2002, 12, 25, tzinfo=TZ()).isoformat(' ')
'2002-12-25 00:00:00-06:39'
>>> datetime(2009, 11, 27, microsecond=100, tzinfo=TZ()).isoformat()
'2009-11-27T00:00:00.000100-06:39'

L'argument optionnel timespec spécifie le nombre de composants additionnels de temps à inclure (par défaut 'auto'). Il peut valoir l'une des valeurs suivantes :

  • 'auto' : Identique à 'seconds' si microsecond vaut 0, à 'microseconds' sinon.

  • 'hours' : Inclut hour au format à deux chiffres HH.

  • 'minutes' : Inclut hour et minute au format HH:MM.

  • 'seconds' : Inclut hour, minute et second au format HH:MM:SS.

  • 'milliseconds' : Inclut le temps complet, mais tronque la partie fractionnaire des millisecondes, au format HH:MM:SS.sss.

  • 'microseconds' : Inclut le temps complet, au format HH:MM:SS.ffffff.

Note

Les composants de temps exclus sont tronqués et non arrondis.

Une ValueError est levée en cas d'argument timespec invalide :

>>> from datetime import datetime
>>> datetime.now().isoformat(timespec='minutes')   
'2002-12-25T00:00'
>>> dt = datetime(2015, 1, 1, 12, 30, 59, 0)
>>> dt.isoformat(timespec='microseconds')
'2015-01-01T12:30:59.000000'

Nouveau dans la version 3.6: Ajout de l'argument timespec.

datetime.__str__()

Pour une instance d de datetime, str(d) est équivalent à d.isoformat(' ').

datetime.ctime()

Renvoie une chaîne représentant la date et l'heure :

>>> from datetime import datetime
>>> datetime(2002, 12, 4, 20, 30, 40).ctime()
'Wed Dec  4 20:30:40 2002'

La chaîne de caractères en sortie n'inclura pas d'informations sur le fuseau horaire, que l'entrée soit avisée ou naïve.

d.ctime() est équivalent à :

time.ctime(time.mktime(d.timetuple()))

sur les plateformes où la fonction C native ctime() (que time.ctime() invoque, mais pas datetime.ctime()) est conforme au standard C.

datetime.strftime(format)

Renvoie une chaîne représentant la date et l'heure, contrôlée par une chaîne de format explicite. Voir Comportement de strftime() et strptime() et datetime.isoformat().

datetime.__format__(format)

Identique à datetime.strftime(). Cela permet de spécifier une chaîne de format pour un objet datetime dans une chaîne de formatage littérale et en utilisant str.format(). Voir Comportement de strftime() et strptime() et datetime.isoformat().

Exemple d'utilisation de la classe datetime :

Exemples d'utilisation des objets datetime :

>>> from datetime import datetime, date, time, timezone

>>> # Using datetime.combine()
>>> d = date(2005, 7, 14)
>>> t = time(12, 30)
>>> datetime.combine(d, t)
datetime.datetime(2005, 7, 14, 12, 30)

>>> # Using datetime.now()
>>> datetime.now()   
datetime.datetime(2007, 12, 6, 16, 29, 43, 79043)   # GMT +1
>>> datetime.now(timezone.utc)   
datetime.datetime(2007, 12, 6, 15, 29, 43, 79060, tzinfo=datetime.timezone.utc)

>>> # Using datetime.strptime()
>>> dt = datetime.strptime("21/11/06 16:30", "%d/%m/%y %H:%M")
>>> dt
datetime.datetime(2006, 11, 21, 16, 30)

>>> # Using datetime.timetuple() to get tuple of all attributes
>>> tt = dt.timetuple()
>>> for it in tt:   
...     print(it)
...
2006    # year
11      # month
21      # day
16      # hour
30      # minute
0       # second
1       # weekday (0 = Monday)
325     # number of days since 1st January
-1      # dst - method tzinfo.dst() returned None

>>> # Date in ISO format
>>> ic = dt.isocalendar()
>>> for it in ic:   
...     print(it)
...
2006    # ISO year
47      # ISO week
2       # ISO weekday

>>> # Formatting a datetime
>>> dt.strftime("%A, %d. %B %Y %I:%M%p")
'Tuesday, 21. November 2006 04:30PM'
>>> 'The {1} is {0:%d}, the {2} is {0:%B}, the {3} is {0:%I:%M%p}.'.format(dt, "day", "month", "time")
'The day is 21, the month is November, the time is 04:30PM.'

L'exemple ci-dessous définit une sous-classe tzinfo qui regroupe des informations sur les fuseaux horaires pour Kaboul, en Afghanistan, qui a utilisé +4 UTC jusqu'en 1945, puis +4:30 UTC par la suite :

from datetime import timedelta, datetime, tzinfo, timezone

class KabulTz(tzinfo):
    # Kabul used +4 until 1945, when they moved to +4:30
    UTC_MOVE_DATE = datetime(1944, 12, 31, 20, tzinfo=timezone.utc)

    def utcoffset(self, dt):
        if dt.year < 1945:
            return timedelta(hours=4)
        elif (1945, 1, 1, 0, 0) <= dt.timetuple()[:5] < (1945, 1, 1, 0, 30):
            # An ambiguous ("imaginary") half-hour range representing
            # a 'fold' in time due to the shift from +4 to +4:30.
            # If dt falls in the imaginary range, use fold to decide how
            # to resolve. See PEP495.
            return timedelta(hours=4, minutes=(30 if dt.fold else 0))
        else:
            return timedelta(hours=4, minutes=30)

    def fromutc(self, dt):
        # Follow same validations as in datetime.tzinfo
        if not isinstance(dt, datetime):
            raise TypeError("fromutc() requires a datetime argument")
        if dt.tzinfo is not self:
            raise ValueError("dt.tzinfo is not self")

        # A custom implementation is required for fromutc as
        # the input to this function is a datetime with utc values
        # but with a tzinfo set to self.
        # See datetime.astimezone or fromtimestamp.
        if dt.replace(tzinfo=timezone.utc) >= self.UTC_MOVE_DATE:
            return dt + timedelta(hours=4, minutes=30)
        else:
            return dt + timedelta(hours=4)

    def dst(self, dt):
        # Kabul does not observe daylight saving time.
        return timedelta(0)

    def tzname(self, dt):
        if dt >= self.UTC_MOVE_DATE:
            return "+04:30"
        return "+04"

Utilisation de KabulTz cité plus haut :

>>> tz1 = KabulTz()

>>> # Datetime before the change
>>> dt1 = datetime(1900, 11, 21, 16, 30, tzinfo=tz1)
>>> print(dt1.utcoffset())
4:00:00

>>> # Datetime after the change
>>> dt2 = datetime(2006, 6, 14, 13, 0, tzinfo=tz1)
>>> print(dt2.utcoffset())
4:30:00

>>> # Convert datetime to another time zone
>>> dt3 = dt2.astimezone(timezone.utc)
>>> dt3
datetime.datetime(2006, 6, 14, 8, 30, tzinfo=datetime.timezone.utc)
>>> dt2
datetime.datetime(2006, 6, 14, 13, 0, tzinfo=KabulTz())
>>> dt2 == dt3
True

Objets time

Un objet time représente une heure (locale) du jour, indépendante de tout jour particulier, et sujette à des ajustements par un objet tzinfo.

class datetime.time(hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

Tous les arguments sont optionnels. tzinfo peut être None ou une instance d'une sous-classe tzinfo. Les autres arguments doivent être des nombres entiers, dans les intervalles suivants :

  • 0 <= hour < 24,

  • 0 <= minute < 60,

  • 0 <= second < 60,

  • 0 <= microsecond < 1000000,

  • fold in [0, 1].

Si un argument est fourni en dehors de ces bornes, une ValueError est levée. Ils valent tous 0 par défaut, à l'exception de tzinfo qui vaut None.

Attributs de la classe :

time.min

Le plus petit objet time représentable, time(0, 0, 0, 0).

time.max

Le plus grand objet time représentable, time(23, 59, 59, 999999).

time.resolution

La plus petite différence possible entre deux objets time non-égaux, timedelta(microseconds=1), notez cependant que les objets time n'implémentent pas d'opérations arithmétiques.

Attributs de l'instance (en lecture seule) :

time.hour

Dans range(24).

time.minute

Dans range(60).

time.second

Dans range(60).

time.microsecond

Dans range(1000000).

time.tzinfo

L'objet passé comme argument tzinfo au constructeur de time, ou None si aucune valeur n'a été passée.

time.fold

Dans [0, 1]. Utilisé pour désambiguïser les heures dans un intervalle répété. (Un intervalle répété apparaît quand l'horloge est retardée à la fin de l'heure d'été ou quand le décalage horaire UTC du fuseau courant est décrémenté pour des raisons politiques.) La valeur 0 (1) représente le plus ancien (récent) des deux moments représentés par la même heure.

Nouveau dans la version 3.6.

Les objets time gèrent la comparaison d'un time avec un autre time, où a est considéré inférieur à b s'il le précède dans le temps. Si un opérande est naïf et l'autre avisé, et qu'une relation d'ordre est attendue, une TypeError est levée. Pour les égalités, les instances naïves ne sont jamais égales aux instances avisées.

Si les deux opérandes sont avisés, et ont le même attribut tzinfo, l'attribut commun tzinfo est ignoré et les temps de base sont comparés. Si les deux opérandes sont avisés et ont des attributs tzinfo différents, ils sont d'abord ajustés en leur soustrayant leurs décalages UTC (obtenus à l'aide de self.utcoffset()). Afin d'empêcher les comparaisons de types mixtes de retomber sur la comparaison par défaut par l'adresse de l'objet, quand un objet time est comparé à un objet de type différent, une TypeError est levée à moins que la comparaison soit == ou !=. Ces derniers cas renvoient respectivement False et True.

Modifié dans la version 3.3: Les comparaisons d'égalité entre instances de time naïves et avisées ne lèvent pas de TypeError.

Dans un contexte booléen, un objet time est toujours considéré comme vrai.

Modifié dans la version 3.5: Avant Python 3.5, un objet time était considéré comme faux s'il représentait minuit en UTC. Ce comportement était considéré comme obscur et propice aux erreurs, il a été supprimé en Python 3.5. Voir bpo-13936 pour les détails complets.

Autre constructeur :

classmethod time.fromisoformat(time_string)

Renvoie une time correspondant à time_string dans un format ISO 8601 valide, avec les exceptions suivantes :

  1. Les décalages de fuseaux horaires peuvent comporter des fractions de secondes.

  2. Le T initial, normalement requis dans les cas où il peut y avoir une ambiguïté entre une date et une heure, n'est pas nécessaire.

  3. Les fractions de secondes peuvent avoir un nombre quelconque de décimales (tout ce qui dépasse 6 décimales sera tronqué).

  4. Les fractions d'heures et de minutes ne sont pas gérées.

Exemples :

>>> from datetime import time
>>> time.fromisoformat('04:23:01')
datetime.time(4, 23, 1)
>>> time.fromisoformat('T04:23:01')
datetime.time(4, 23, 1)
>>> time.fromisoformat('T042301')
datetime.time(4, 23, 1)
>>> time.fromisoformat('04:23:01.000384')
datetime.time(4, 23, 1, 384)
>>> time.fromisoformat('04:23:01,000')
datetime.time(4, 23, 1, 384)
>>> time.fromisoformat('04:23:01+04:00')
datetime.time(4, 23, 1, tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))
>>> time.fromisoformat('04:23:01Z')
datetime.time(4, 23, 1, tzinfo=datetime.timezone.utc)
>>> time.fromisoformat('04:23:01+00:00')
datetime.time(4, 23, 1, tzinfo=datetime.timezone.utc)

Nouveau dans la version 3.7.

Modifié dans la version 3.11: Auparavant, cette méthode ne prenait en charge que les formats émis par time.isoformat().

Méthodes de l'instance :

time.replace(hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, *, fold=0)

Renvoie un objet time avec la même valeur, à l'exception des attributs dont les nouvelles valeurs sont spécifiées par les arguments nommés. Notez que tzinfo=None peut être spécifié pour créer une instance time naïve à partir d'une instance time avisée, sans conversion des données de temps.

Nouveau dans la version 3.6: Ajout de l'argument fold.

time.isoformat(timespec='auto')

Renvoie une chaîne représentant la date au format ISO 8601 :

L'argument optionnel timespec spécifie le nombre de composants additionnels de temps à inclure (par défaut 'auto'). Il peut valoir l'une des valeurs suivantes :

  • 'auto' : Identique à 'seconds' si microsecond vaut 0, à 'microseconds' sinon.

  • 'hours' : Inclut hour au format à deux chiffres HH.

  • 'minutes' : Inclut hour et minute au format HH:MM.

  • 'seconds' : Inclut hour, minute et second au format HH:MM:SS.

  • 'milliseconds' : Inclut le temps complet, mais tronque la partie fractionnaire des millisecondes, au format HH:MM:SS.sss.

  • 'microseconds' : Inclut le temps complet, au format HH:MM:SS.ffffff.

Note

Les composants de temps exclus sont tronqués et non arrondis.

Une ValueError sera levée en cas d'argument timespec invalide.

Exemple :

>>> from datetime import time
>>> time(hour=12, minute=34, second=56, microsecond=123456).isoformat(timespec='minutes')
'12:34'
>>> dt = time(hour=12, minute=34, second=56, microsecond=0)
>>> dt.isoformat(timespec='microseconds')
'12:34:56.000000'
>>> dt.isoformat(timespec='auto')
'12:34:56'

Nouveau dans la version 3.6: Ajout de l'argument timespec.

time.__str__()

Pour un temps t, str(t) est équivalent à t.isoformat().

time.strftime(format)

Renvoie une chaîne représentant l'heure, contrôlée par une chaîne de formatage explicite. Voir Comportement de strftime() et strptime() et time.isoformat().

time.__format__(format)

Identique à time.strftime(). Cela permet de spécifier une chaîne de formatage pour un objet time dans une chaîne de formatage littérale et à l'utilisation de str.format(). Voir Comportement de strftime() et strptime() et time.isoformat().

time.utcoffset()

Si tzinfo est None, renvoie None, sinon renvoie self.tzinfo.utcoffset(None), et lève une exception si l'expression précédente ne renvoie pas None ou un objet timedelta d'une magnitude inférieure à un jour.

Modifié dans la version 3.7: Le décalage UTC peut aussi être autre chose qu'un ensemble de minutes.

time.dst()

Si tzinfo est None, renvoie None, sinon renvoie self.tzinfo.dst(None), et lève une exception si l'expression précédente ne renvoie pas None ou un objet timedelta d'une magnitude inférieure à un jour.

Modifié dans la version 3.7: Le décalage DST n'est pas restreint à des minutes entières.

time.tzname()

Si tzinfo est None, renvoie None, sinon renvoie self.tzinfo.tzname(None), et lève une exception si l'expression précédente ne renvoie pas None ou une chaîne de caractères.

Exemples d'utilisation de time

Exemples d'utilisation de l'objet time :

>>> from datetime import time, tzinfo, timedelta
>>> class TZ1(tzinfo):
...     def utcoffset(self, dt):
...         return timedelta(hours=1)
...     def dst(self, dt):
...         return timedelta(0)
...     def tzname(self,dt):
...         return "+01:00"
...     def  __repr__(self):
...         return f"{self.__class__.__name__}()"
...
>>> t = time(12, 10, 30, tzinfo=TZ1())
>>> t
datetime.time(12, 10, 30, tzinfo=TZ1())
>>> t.isoformat()
'12:10:30+01:00'
>>> t.dst()
datetime.timedelta(0)
>>> t.tzname()
'+01:00'
>>> t.strftime("%H:%M:%S %Z")
'12:10:30 +01:00'
>>> 'The {} is {:%H:%M}.'.format("time", t)
'The time is 12:10.'

Objets tzinfo

class datetime.tzinfo

Il s'agit d'une classe mère abstraite, ce qui signifie que cette classe ne doit pas être instanciée directement. Définissez une sous-classe de tzinfo pour capturer des informations sur un fuseau horaire particulier.

Une instance (d'une sous-classe concrète) de tzinfo peut être passée aux constructeurs des objets datetime et time. Les objets en question voient leurs attributs comme étant en temps local, et l'objet tzinfo contient des méthodes pour obtenir le décalage du temps local par rapport à UTC, le nom du fuseau horaire, le décalage d'heure d'été, tous relatifs à un objet de date ou d'heure qui leur est passé.

Vous devez en dériver une sous-classe concrète et (au minimum) fournir des implémentations aux méthodes standard tzinfo requises par les méthodes de datetime que vous utilisez. Le module datetime fournit une simple sous-classe concrète de tzinfo, timezone, qui peut représenter des fuseaux horaires avec des décalages fixes par rapport à UTC, tels qu'UTC lui-même ou les fuseaux nord-américains EST et EDT.

Prérequis spécifique à la sérialisation : Une sous-classe tzinfo doit avoir une méthode __init__() qui peut être appelée sans arguments, sans quoi un objet sérialisé ne pourrait pas toujours être désérialisé. C'est un prérequis technique qui pourrait être assoupli dans le futur.

Une sous-classe concrète de tzinfo peut devoir implémenter les méthodes suivantes. Les méthodes réellement nécessaires dépendent de l'utilisation qui est faite des objets datetime avisés. Dans le doute, implémentez-les toutes.

tzinfo.utcoffset(dt)

Renvoie le décalage de l'heure locale par rapport à UTC, sous la forme d'un objet timedelta qui est positif à l'est de UTC. Si l'heure locale est à l'ouest de UTC, il doit être négatif.

Cela représente le décalage total par rapport à UTC ; par exemple, si un objet tzinfo représente à la fois un fuseau horaire et son ajustement à l'heure d'été, utcoffset() devrait renvoyer leur somme. Si le décalage UTC n'est pas connu, elle renvoie None. Sinon, la valeur renvoyée doit être un objet timedelta compris strictement entre -timedelta(hours=24) et timedelta(hours=24) (l'amplitude du décalage doit être inférieure à un jour). La plupart des implémentations de utcoffset() ressembleront probablement à l'une des deux suivantes :

return CONSTANT                 # fixed-offset class
return CONSTANT + self.dst(dt)  # daylight-aware class

Si utcoffset() ne renvoie pas None, dst() ne doit pas non plus renvoyer None.

L'implémentation par défaut de utcoffset() lève une NotImplementedError.

Modifié dans la version 3.7: Le décalage UTC peut aussi être autre chose qu'un ensemble de minutes.

tzinfo.dst(dt)

Renvoie le réglage de l'heure d'été (DST), sous la forme d'un objet timedelta ou None si l'information DST n'est pas connue.

Renvoie timedelta(0) si l'heure d'été n'est pas effective. Si elle est effective, renvoie un décalage sous forme d'un objet timedelta (voir utcoffset() pour les détails). Notez que ce décalage, si applicable, est déjà compris dans le décalage UTC renvoyé par utcoffset(), il n'est donc pas nécessaire de faire appel à dst() à moins que vous ne souhaitiez obtenir les informations séparément. Par exemple, datetime.timetuple() appelle la méthode dst() de son attribut tzinfo pour déterminer si l'option tm_isdst doit être activée, et tzinfo.fromutc() fait appel à dst() pour tenir compte des heures d'été quand elle traverse des fuseaux horaires.

Une instance tz d'une sous-classe tzinfo convenant à la fois pour une heure standard et une heure d'été doit être cohérente :

tz.utcoffset(dt) - tz.dst(dt)

doit renvoyer le même résultat pour tout objet datetime dt avec dt.tzinfo == tz Pour les sous-classes saines de tzinfo, cette expression calcule le « décalage standard » du fuseau horaire, qui ne doit pas dépendre de la date ou de l'heure, mais seulement de la position géographique. L'implémentation de datetime.astimezone() se base là-dessus, mais ne peut pas détecter les violations ; il est de la responsabilité du programmeur de l'assurer. Si une sous-classe tzinfo ne le garantit pas, il doit être possible de redéfinir l'implémentation par défaut de tzinfo.fromutc() pour tout de même fonctionner correctement avec astimezone().

La plupart des implémentations de dst() ressembleront probablement à l'une des deux suivantes :

def dst(self, dt):
    # a fixed-offset class:  doesn't account for DST
    return timedelta(0)

ou :

def dst(self, dt):
    # Code to set dston and dstoff to the time zone's DST
    # transition times based on the input dt.year, and expressed
    # in standard local time.

    if dston <= dt.replace(tzinfo=None) < dstoff:
        return timedelta(hours=1)
    else:
        return timedelta(0)

L'implémentation par défaut de dst() lève une NotImplementedError.

Modifié dans la version 3.7: Le décalage DST n'est pas restreint à des minutes entières.

tzinfo.tzname(dt)

Renvoie le nom du fuseau horaire correspondant à l'objet datetime dt, sous forme d'une chaîne. Rien n'est défini sur les noms par le module datetime, et il n'est pas nécessaire que ces noms signifient quelque chose en particulier. Par exemple, « GMT », « UTC », « -500 », « -5:00 », « EDT », « US/Eastern » et « America/New York » sont toutes des valeurs de retour valides. Renvoie None si un nom est inconnu. Notez qu'il s'agit d'une méthode et non d'une chaîne fixée en amont, parce que les sous-classes de tzinfo peuvent souhaiter renvoyer des noms différents en fonction de valeurs de dt spécifiques, en particulier si la classe tzinfo tient compte de l'heure d'été.

L'implémentation par défaut de tzname() lève une NotImplementedError.

Ces méthodes sont appelées par les objets datetime et time, en réponse à leurs méthodes de mêmes noms. Un objet datetime se passe lui-même en tant qu'argument, et un objet time passe None. Les méthodes des sous-classes tzinfo doivent alors être prêtes à recevoir un argument None pour dt, ou une instance de datetime.

Quand None est passé, il est de la responsabilité du designer de la classe de choisir la meilleure réponse. Par exemple, renvoyer None est approprié si la classe souhaite signaler que les objets de temps ne participent pas au protocole tzinfo. Il peut être plus utile pour utcoffset(None) de renvoyer le décalage UTC standard, comme il n'existe aucune autre convention pour obtenir ce décalage.

Quand un objet datetime est passé en réponse à une méthode de datetime, dt.tzinfo est le même objet que self. Les méthodes de tzinfo peuvent se baser là-dessus, à moins que le code utilisateur appelle directement des méthodes de tzinfo. L'intention est que les méthodes de tzinfo interprètent dt comme étant le temps local, et n'aient pas à se soucier des objets dans d'autres fuseaux horaires.

Il y a une dernière méthode de tzinfo que les sous-classes peuvent vouloir redéfinir :

tzinfo.fromutc(dt)

Elle est appelée par l'implémentation par défaut de datetime.astimezone(). Lors d'un appel depuis cette méthode, dt.tzinfo vaut self et les données de date et d'heure de dt sont vues comme exprimant un horodatage UTC. Le rôle de fromutc() est d'ajuster les données de date et d'heure, renvoyant un objet datetime équivalent à self, dans le temps local.

La plupart des sous-classes tzinfo doivent être en mesure d'hériter sans problème de l'implémentation par défaut de fromutc(). Elle est suffisamment robuste pour gérer les fuseaux horaires à décalage fixe, et les fuseaux représentant à la fois des heures standards et d'été, et ce même si le décalage de l'heure d'été est différent suivant les années. Un exemple de fuseau horaire qui ne serait pas géré correctement dans tous les cas par l'implémentation par défaut de fromutc() en est un où le décalage standard (par rapport à UTC) dépend de valeurs spécifiques de date et d'heure passées, ce qui peut arriver pour des raisons politiques. Les implémentations par défaut de astimezone() et fromutc() peuvent ne pas produire les résultats attendus si le résultat est l'une des heures affectées par le changement d'heure.

En omettant le code des cas d'erreurs, l'implémentation par défaut de fromutc() se comporte comme suit :

def fromutc(self, dt):
    # raise ValueError error if dt.tzinfo is not self
    dtoff = dt.utcoffset()
    dtdst = dt.dst()
    # raise ValueError if dtoff is None or dtdst is None
    delta = dtoff - dtdst  # this is self's standard offset
    if delta:
        dt += delta   # convert to standard local time
        dtdst = dt.dst()
        # raise ValueError if dtdst is None
    if dtdst:
        return dt + dtdst
    else:
        return dt

Dans le fichier tzinfo_examples.py il y a des exemples de tzinfo classes :

from datetime import tzinfo, timedelta, datetime

ZERO = timedelta(0)
HOUR = timedelta(hours=1)
SECOND = timedelta(seconds=1)

# A class capturing the platform's idea of local time.
# (May result in wrong values on historical times in
#  timezones where UTC offset and/or the DST rules had
#  changed in the past.)
import time as _time

STDOFFSET = timedelta(seconds = -_time.timezone)
if _time.daylight:
    DSTOFFSET = timedelta(seconds = -_time.altzone)
else:
    DSTOFFSET = STDOFFSET

DSTDIFF = DSTOFFSET - STDOFFSET

class LocalTimezone(tzinfo):

    def fromutc(self, dt):
        assert dt.tzinfo is self
        stamp = (dt - datetime(1970, 1, 1, tzinfo=self)) // SECOND
        args = _time.localtime(stamp)[:6]
        dst_diff = DSTDIFF // SECOND
        # Detect fold
        fold = (args == _time.localtime(stamp - dst_diff))
        return datetime(*args, microsecond=dt.microsecond,
                        tzinfo=self, fold=fold)

    def utcoffset(self, dt):
        if self._isdst(dt):
            return DSTOFFSET
        else:
            return STDOFFSET

    def dst(self, dt):
        if self._isdst(dt):
            return DSTDIFF
        else:
            return ZERO

    def tzname(self, dt):
        return _time.tzname[self._isdst(dt)]

    def _isdst(self, dt):
        tt = (dt.year, dt.month, dt.day,
              dt.hour, dt.minute, dt.second,
              dt.weekday(), 0, 0)
        stamp = _time.mktime(tt)
        tt = _time.localtime(stamp)
        return tt.tm_isdst > 0

Local = LocalTimezone()


# A complete implementation of current DST rules for major US time zones.

def first_sunday_on_or_after(dt):
    days_to_go = 6 - dt.weekday()
    if days_to_go:
        dt += timedelta(days_to_go)
    return dt


# US DST Rules
#
# This is a simplified (i.e., wrong for a few cases) set of rules for US
# DST start and end times. For a complete and up-to-date set of DST rules
# and timezone definitions, visit the Olson Database (or try pytz):
# http://www.twinsun.com/tz/tz-link.htm
# https://sourceforge.net/projects/pytz/ (might not be up-to-date)
#
# In the US, since 2007, DST starts at 2am (standard time) on the second
# Sunday in March, which is the first Sunday on or after Mar 8.
DSTSTART_2007 = datetime(1, 3, 8, 2)
# and ends at 2am (DST time) on the first Sunday of Nov.
DSTEND_2007 = datetime(1, 11, 1, 2)
# From 1987 to 2006, DST used to start at 2am (standard time) on the first
# Sunday in April and to end at 2am (DST time) on the last
# Sunday of October, which is the first Sunday on or after Oct 25.
DSTSTART_1987_2006 = datetime(1, 4, 1, 2)
DSTEND_1987_2006 = datetime(1, 10, 25, 2)
# From 1967 to 1986, DST used to start at 2am (standard time) on the last
# Sunday in April (the one on or after April 24) and to end at 2am (DST time)
# on the last Sunday of October, which is the first Sunday
# on or after Oct 25.
DSTSTART_1967_1986 = datetime(1, 4, 24, 2)
DSTEND_1967_1986 = DSTEND_1987_2006

def us_dst_range(year):
    # Find start and end times for US DST. For years before 1967, return
    # start = end for no DST.
    if 2006 < year:
        dststart, dstend = DSTSTART_2007, DSTEND_2007
    elif 1986 < year < 2007:
        dststart, dstend = DSTSTART_1987_2006, DSTEND_1987_2006
    elif 1966 < year < 1987:
        dststart, dstend = DSTSTART_1967_1986, DSTEND_1967_1986
    else:
        return (datetime(year, 1, 1), ) * 2

    start = first_sunday_on_or_after(dststart.replace(year=year))
    end = first_sunday_on_or_after(dstend.replace(year=year))
    return start, end


class USTimeZone(tzinfo):

    def __init__(self, hours, reprname, stdname, dstname):
        self.stdoffset = timedelta(hours=hours)
        self.reprname = reprname
        self.stdname = stdname
        self.dstname = dstname

    def __repr__(self):
        return self.reprname

    def tzname(self, dt):
        if self.dst(dt):
            return self.dstname
        else:
            return self.stdname

    def utcoffset(self, dt):
        return self.stdoffset + self.dst(dt)

    def dst(self, dt):
        if dt is None or dt.tzinfo is None:
            # An exception may be sensible here, in one or both cases.
            # It depends on how you want to treat them.  The default
            # fromutc() implementation (called by the default astimezone()
            # implementation) passes a datetime with dt.tzinfo is self.
            return ZERO
        assert dt.tzinfo is self
        start, end = us_dst_range(dt.year)
        # Can't compare naive to aware objects, so strip the timezone from
        # dt first.
        dt = dt.replace(tzinfo=None)
        if start + HOUR <= dt < end - HOUR:
            # DST is in effect.
            return HOUR
        if end - HOUR <= dt < end:
            # Fold (an ambiguous hour): use dt.fold to disambiguate.
            return ZERO if dt.fold else HOUR
        if start <= dt < start + HOUR:
            # Gap (a non-existent hour): reverse the fold rule.
            return HOUR if dt.fold else ZERO
        # DST is off.
        return ZERO

    def fromutc(self, dt):
        assert dt.tzinfo is self
        start, end = us_dst_range(dt.year)
        start = start.replace(tzinfo=self)
        end = end.replace(tzinfo=self)
        std_time = dt + self.stdoffset
        dst_time = std_time + HOUR
        if end <= dst_time < end + HOUR:
            # Repeated hour
            return std_time.replace(fold=1)
        if std_time < start or dst_time >= end:
            # Standard time
            return std_time
        if start <= std_time < end - HOUR:
            # Daylight saving time
            return dst_time


Eastern  = USTimeZone(-5, "Eastern",  "EST", "EDT")
Central  = USTimeZone(-6, "Central",  "CST", "CDT")
Mountain = USTimeZone(-7, "Mountain", "MST", "MDT")
Pacific  = USTimeZone(-8, "Pacific",  "PST", "PDT")

Notez que, deux fois par an, on rencontre des subtilités inévitables dans les sous-classes de tzinfo représentant à la fois des heures standard et d'été, au passage de l'une à l'autre. Concrètement, considérez le fuseau de l'est des États-Unis (UTC -0500), où EDT (heure d'été) débute à la minute qui suit 1:59 (EST) le second dimanche de mars, et se termine à la minute qui suit 1:59 (EDT) le premier dimanche de novembre :

  UTC   3:MM  4:MM  5:MM  6:MM  7:MM  8:MM
  EST  22:MM 23:MM  0:MM  1:MM  2:MM  3:MM
  EDT  23:MM  0:MM  1:MM  2:MM  3:MM  4:MM

start  22:MM 23:MM  0:MM  1:MM  3:MM  4:MM

  end  23:MM  0:MM  1:MM  1:MM  2:MM  3:MM

Quand l'heure d'été débute (la ligne « start »), l'horloge locale passe de 1:59 à 3:00. Une heure de la forme 2:MM n'a pas vraiment de sens ce jour là, donc astimezone(Eastern) ne fournira pas de résultat avec hour == 2 pour le jour où débute l'heure d'été. Par exemple, lors du changement d'heure du printemps 2016, nous obtenons :

>>> from datetime import datetime, timezone
>>> from tzinfo_examples import HOUR, Eastern
>>> u0 = datetime(2016, 3, 13, 5, tzinfo=timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname())
...
05:00:00 UTC = 00:00:00 EST
06:00:00 UTC = 01:00:00 EST
07:00:00 UTC = 03:00:00 EDT
08:00:00 UTC = 04:00:00 EDT

Quand l'heure d'été se termine (la ligne « end »), il y a potentiellement un problème pire que cela : il y a une heure qui ne peut pas être exprimée sans ambiguïté en temps local : la dernière heure de l'heure d'été. Dans l'est des États-Unis, l'heure d'été se termine sur les heures de la forme 5:MM UTC. L'horloge locale passe de 1:59 (heure d'été) à 1:00 (heure d'hiver) à nouveau. Les heures locales de la forme 1:MM sont ambiguës. astimezone() imite le comportement des horloges locales en associant deux heures UTC adjacentes à la même heure locale. Dans notre exemple, les horodatages UTC de la forme 5:MM et 6:MM sont tous deux associés à 1:MM quand ils sont convertis vers ce fuseau, mais les horodatages les plus anciens ont l'attribut fold à 0 et les plus récents l'ont à 1. Par exemple, lors du changement d'heure de l'automne 2016, nous obtenons :

>>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
...
04:00:00 UTC = 00:00:00 EDT 0
05:00:00 UTC = 01:00:00 EDT 0
06:00:00 UTC = 01:00:00 EST 1
07:00:00 UTC = 02:00:00 EST 0

Notez que deux instances datetime qui ne diffèrent que par la valeur de leur attribut fold sont considérées égales dans les comparaisons.

Les applications qui ne peuvent pas gérer ces ambiguïtés doivent vérifier explicitement la valeur de l'attribut fold ou éviter d'utiliser des sous-classes tzinfo hybrides ; il n'y a aucune ambiguïté lors de l'utilisation de la classe timezone, ou toute autre sous-classe de tzinfo à décalage fixe (comme une classe représentant uniquement le fuseau EST (de décalage fixe -5h) ou uniquement EDT (-4h)).

Voir aussi

zoneinfo

Le module datetime contient une classe élémentaire timezone pour gérer des décalages fixes par rapport à UTC et timezone.utc comme instance du fuseau horaire UTC.

zoneinfo apporte à Python la base de données de fuseaux horaires IANA (aussi appelée base de données Olson), et son utilisation est recommandée.

Base de données des fuseaux horaires de l'IANA

La Time Zone Database (souvent appelée tz, tzdata ou zoneinfo) contient les codes et les données représentant l'historique du temps local pour un grand nombre d'emplacements représentatifs autour du globe. Elle est mise à jour périodiquement, pour refléter les changements opérés par des politiques sur les bornes du fuseau, les décalages UTC, et les règles de passage à l'heure d'été.

Objets timezone

La classe timezone est une sous-classe de tzinfo, dont chaque instance représente un fuseau horaire défini par un décalage fixe par rapport à UTC.

Les objets de cette classe ne peuvent pas être utilisés pour représenter les informations de fuseaux horaires dans des emplacements où plusieurs décalages sont utilisés au cours de l'année ni où le déroulement du temps civil a fait l'objet d'ajustements.

class datetime.timezone(offset, name=None)

L'argument offset doit être spécifié comme un objet timedelta représentant la différence entre le temps local et UTC. Il doit être strictement compris entre -timedelta(hours=24) et timedelta(hours=24), autrement une ValueError est levée.

L'argument name est optionnel. S'il est spécifié, il doit être une chaîne qui sera utilisée comme valeur de retour de la méthode datetime.tzname().

Nouveau dans la version 3.2.

Modifié dans la version 3.7: Le décalage UTC peut aussi être autre chose qu'un ensemble de minutes.

timezone.utcoffset(dt)

Renvoie la valeur fixe spécifiée lorsque l'instance timezone est construite.

L'argument dt est ignoré. La valeur de retour est une instance timedelta égale à la différence entre le temps local et UTC.

Modifié dans la version 3.7: Le décalage UTC peut aussi être autre chose qu'un ensemble de minutes.

timezone.tzname(dt)

Renvoie la valeur fixe spécifiée lorsque l'instance timezone est construite.

Si name n'est pas fourni au constructeur, le nom renvoyé par tzname(dt) est généré comme suit à partir de la valeur de offset. Si offset vaut timedelta(0), le nom sera « UTC », autrement le nom sera une chaîne de la forme UTC±HH:MM, où ± est le signe d'offset, et HH et MM sont respectivement les représentations à deux chiffres de offset.hours et offset.minutes.

Modifié dans la version 3.6: Le nom généré à partir de offset=timedelta(0) est maintenant 'UTC' plutôt que 'UTC+00:00'.

timezone.dst(dt)

Renvoie toujours None.

timezone.fromutc(dt)

Renvoie dt + offset. L'argument dt doit être une instance avisée de datetime, avec tzinfo valant self.

Attributs de la classe :

timezone.utc

Le fuseau horaire UTC, timezone(timedelta(0)).

Comportement de strftime() et strptime()

Les objets date, datetime et time comportent tous une méthode strftime(format), pour créer une représentation du temps sous forme d'une chaîne, contrôlée par une chaîne de formatage explicite.

Inversement, la méthode de classe datetime.strptime() crée un objet datetime à partir d'une chaîne représentant une date et une heure, et une chaîne de format correspondante.

Le tableau ci-dessous fournit une comparaison de haut niveau entre strftime() et strptime() :

strftime

strptime

Utilisation

Convertit un objet en une chaîne selon un format donné

Analyse une chaîne dans un objet datetime en fonction du format de correspondance donné

Type de méthode

Méthode d'instance

Méthode de classe

Méthode de

date ; datetime ; time

datetime

Signature

strftime(format)

strptime(date_string, format)

Codes de formatage de strftime() et strptime()

Ces méthodes acceptent des codes de formatage qui peuvent être utilisés pour analyser et formater les dates :

>>> datetime.strptime('31/01/22 23:59:59.999999',
...                   '%d/%m/%y %H:%M:%S.%f')
datetime.datetime(2022, 1, 31, 23, 59, 59, 999999)
>>> _.strftime('%a %d %b %Y, %I:%M%p')
'Mon 31 Jan 2022, 11:59PM'

Voici la liste de tous les codes de formatage requis par le C standard 1989, et ils fonctionnent sur toutes les plateformes possédant une implémentation de C standard.

Directive

Signification

Exemple

Notes

%a

Jour de la semaine abrégé dans la langue locale.
Sun, Mon, ..., Sat (en_US);
Lu, Ma, ..., Di (fr_FR)

(1)

%A

Jour de la semaine complet dans la langue locale.
Sunday, Monday, ..., Saturday (en_US);
Lundi, Mardi, ..., Dimanche (fr_FR)

(1)

%w

Jour de la semaine en chiffre, avec 0 pour le dimanche et 6 pour le samedi.

0, 1, ..., 6

%d

Jour du mois sur deux chiffres.

01, 02, ..., 31

(9)

%b

Nom du mois abrégé dans la langue locale.
Jan, Feb, ..., Dec (en_US);
janv., févr., ..., déc. (fr_FR)

(1)

%B

Nom complet du mois dans la langue locale.
January, February, ..., December (en_US);
janvier, février, ..., décembre (fr_FR)

(1)

%m

Numéro du mois sur deux chiffres.

01, 02, ..., 12

(9)

%y

Année sur deux chiffres (sans le siècle).

00, 01, ..., 99

(9)

%Y

Année complète sur quatre chiffres.

0001, 0002, ..., 2013, 2014, ..., 9998, 9999

(2)

%H

Heure à deux chiffres de 00 à 23.

00, 01, ..., 23

(9)

%I

Heure à deux chiffres pour les horloges 12h (01 à 12).

01, 02, ..., 12

(9)

%p

Équivalent local à AM/PM.
AM, PM (en_US);
am, pm (de_DE)

(1), (3)

%M

Minutes sur deux chiffres.

00, 01, ..., 59

(9)

%S

Secondes sur deux chiffres.

00, 01, ..., 59

(4), (9)

%f

Microsecondes sur 6 chiffres.

000000, 000001, ..., 999999

(5)

%z

Décalage horaire UTC sous la forme ±HHMM[SS[.ffffff]] (chaîne vide si l'instance est naïve).

(vide), +0000, -0400, +1030, +063415, -030712.345216

(6)

%Z

Nom du fuseau horaire (chaîne vide si l'instance est naïve).

(vide), UTC, GMT

(6)

%j

Numéro du jour dans l'année sur trois chiffres.

001, 002, ..., 366

(9)

%U

Numéro de la semaine à deux chiffres (où dimanche est considéré comme le premier jour de la semaine). Tous les jours de l'année précédent le premier dimanche sont considérés comme appartenant à la semaine 0.

00, 01, ..., 53

(7), (9)

%W

Numéro de la semaine à deux chiffres (où lundi est considéré comme le premier jour de la semaine). Tous les jours de l'année précédent le premier lundi sont considérés comme appartenant à la semaine 0.

00, 01, ..., 53

(7), (9)

%c

Représentation locale de la date et de l'heure.
Tue Aug 16 21:30:00 1988 (en_US);
mar. 16 août 1988 21:30:00 (fr_FR)

(1)

%x

Représentation locale de la date.
08/16/88 (None);
08/16/1988 (en_US);
16/08/1988 (fr_FR)

(1)

%X

Représentation locale de l'heure.
21:30:00 (en_US) ;
21:30:00 (fr_FR)

(1)

%%

Un caractère '%' littéral.

%

Plusieurs directives supplémentaires non requises par la norme C89 sont incluses pour des raisons de commodité. Ces paramètres correspondent tous aux valeurs de date de la norme ISO 8601.

Directive

Signification

Exemple

Notes

%G

Année complète ISO 8601 représentant l'année contenant la plus grande partie de la semaine ISO (%V).

0001, 0002, ..., 2013, 2014, ..., 9998, 9999

(8)

%u

Jour de la semaine ISO 8601 où 1 correspond au lundi.

1, 2, ..., 7

%V

Numéro de la semaine ISO 8601, avec lundi étant le premier jour de la semaine. La semaine 01 est la semaine contenant le 4 janvier.

01, 02, ..., 53

(8), (9)

%:z

UTC offset in the form ±HH:MM[:SS[.ffffff]] (empty string if the object is naive).

(empty), +00:00, -04:00, +10:30, +06:34:15, -03:07:12.345216

(6)

Elles peuvent ne pas être disponibles sur toutes les plateformes quand elles sont utilisées avec la méthode strftime(). Les directives ISO 8601 d'année et de semaine ne sont pas interchangeables avec les directives d'année et de semaine précédentes. Appeler strptime() avec des directives ISO 8601 incomplètes ou ambiguës lèvera une ValueError.

L'ensemble complet des codes de formatage implémentés varie selon les plateformes, parce que Python appelle la fonction strftime() de la bibliothèque C de la plateforme, et les variations sont courantes. Pour voir un ensemble complet des codes de formatage implémentés par votre plateforme, consultez la documentation de strftime(3). Il existe également des différences entre les plateformes dans la gestion de format non pris en charge.

Nouveau dans la version 3.6: %G, %u et %V ont été ajoutés.

Nouveau dans la version 3.12: %:z was added.

Détail technique

Grossièrement, d.strftime(fmt) se comporte comme la fonction time.strftime(fmt, d.timetuple()) du module time, bien que tous les objets ne comportent pas de méthode timetuple().

Pour la méthode datetime.strptime(), la valeur par défaut est 1900-01-01T00:00:00.000 : tous les composants non spécifiés dans la chaîne de formatage seront retirés de la valeur par défaut. 4

L'utilisation de datetime.strptime(date_string, format) équivaut à :

datetime(*(time.strptime(date_string, format)[0:6]))

sauf lorsque le format inclut des composantes de sous-secondes ou des informations de décalage de fuseau horaire, qui sont prises en charge dans datetime.strptime mais pas par time.strptime.

Pour les objets time, les codes de formatage pour l'année, le mois et le jour ne devraient pas être utilisés, puisque les objets time ne possèdent pas de telles valeurs. S'ils sont tout de même utilisés, 1900 est utilisé pour l'année, et 1 pour le mois et le jour.

Pour les objets date, les codes de formatage pour les heures, minutes, secondes et microsecondes ne devraient pas être utilisés, puisque les objets date ne possèdent pas de telles valeurs. S'ils sont tout de même utilisés, la valeur 0 est utilisée.

Pour la même raison, la gestion des chaînes contenant des caractères (ou points) Unicode qui ne peuvent pas être représentés dans la locale actuelle dépend aussi de la plateforme. Sur certaines plateformes, ces caractères sont conservés tels quels dans la sortie, alors que sur d'autres plateformes strftime lève une UnicodeError ou renvoie une chaîne vide.

Notes :

  1. Comme le format dépend de la locale courante, les assomptions sur la valeur de retour doivent être prises soigneusement. L'ordre des champs variera (par exemple, « mois/jour/année » au lieu de « année/mois/jour »), et le résultat peut contenir des caractères non-ASCII.

  2. La méthode strptime() peut analyser toutes les années de l'intervalle [1, 9999], mais toutes les années < 1000 doivent être représentées sur quatre chiffres.

    Modifié dans la version 3.2: Dans les versions précédentes, la méthode strftime() était limitée aux années >= 1900.

    Modifié dans la version 3.3: En version 3.2, la méthode strftime() était limitée aux années >= 1000.

  3. Quand utilisée avec la méthode strptime(), la directive %p n'affecte l'heure extraite que si la directive %I est utilisée pour analyser l'heure.

  4. À l'inverse du module time, le module datetime ne gère pas les secondes intercalaires.

  5. Quand elle est utilisée avec la méthode strptime(), la directive %f accepte un nombre de 1 à 6 chiffres, où des zéros seront ajoutés à droite. %f est une extension de l'ensemble des caractères de formatage du standard C (mais implémentée séparément dans les objets datetime, la rendant ainsi toujours disponible).

  6. For a naive object, the %z, %:z and %Z format codes are replaced by empty strings.

    Pour un objet avisé :

    %z

    Le résultat de utcoffset() est transformé en une chaîne sous la forme ±HHMM[SS[.ffffff]], où HH est une chaîne de deux chiffres donnant le nombre d'heures du décalage UTC, MM une chaîne de deux chiffres donnant le nombre de minutes du décalage UTC, SS une chaîne de deux chiffres donnant le nombre de secondes du décalage UTC et ffffff une chaîne de six chiffres donnant le nombre en microsecondes du décalage UTC. La partie ffffff est omise lorsque le décalage est un nombre entier de secondes et les parties ffffff et SS sont omises lorsque le décalage est un nombre entier de minutes. Par exemple, si utcoffset() renvoie timedelta(hours=-3, minutes=-30), %z est remplacé par la chaîne '-0330'.

    Modifié dans la version 3.7: Le décalage UTC peut aussi être autre chose qu'un ensemble de minutes.

    Modifié dans la version 3.7: Quand la directive %z est soumise à la méthode strptime(), le décalage UTC peut avoir une colonne comme séparateur entre les heures, minutes et secondes. Par exemple, '+01:00:00', est analysé comme un décalage d'une heure. Par ailleurs, 'Z' est identique à '+00:00'.

    %:z

    Behaves exactly as %z, but has a colon separator added between hours, minutes and seconds.

    %Z

    Si tzname() renvoie None, %Z est remplacé par une chaîne vide dans strftime(). Autrement %Z est remplacé par la valeur renvoyée, qui doit être une chaîne.

    strptime() accepte seulement certaines valeurs pour %Z :

    1. toute valeur dans time.tzname pour votre machine locale

    2. les valeurs UTC et GMT codés en dur

    Ainsi, quelqu'un qui vit au Japon peut avoir comme valeurs valides JST, UTC et GMT, mais probablement pas EST. Les valeurs invalides lèvent ValueError.

    Modifié dans la version 3.2: Quand la directive %z est fournie à la méthode strptime(), un objet datetime avisé est construit. L'attribut tzinfo du résultat aura pour valeur une instance de timezone.

  7. Quand ces directives sont utilisées avec la méthode strptime(), %U et %W ne sont utilisées dans les calculs que si le jour de la semaine et l'année calendaire (%Y) sont spécifiés.

  8. De façon similaire à %U et %W, %v n'est utilisé dans les calculs que lorsque le jour de la semaine et l'année ISO (%G) sont spécifiés dans la chaîne de formatage strptime(). Notez aussi que %G et %Y ne sont pas interchangeables.

  9. Quand cette directive est utilisée avec la méthode strptime(), le zéro d'entête est optionnel pour les formats %d, %m, %H, %I, %M, %S, %j, %U, %W et %V. Le format %y requiert un zéro en entête.

Notes

1

Si on ignore les effets de la Relativité

2

Cela correspond à la définition du calendrier « grégorien proleptique » dans le livre Calendrical Calculations de Dershowitz et Reingold, où il est la base de tous les calculs. Référez-vous au livre pour les algorithmes de conversion entre calendriers grégorien proleptique et les autres systèmes.

3

Voir R. H. van Gent guide des mathématiques du calendrier ISO 8601 pour une bonne explication.

4

Passer datetime.strptime(‘Feb 29’, ‘%b %d’) ne marchera pas car 1900 n’est pas une année bissextile.