Objets DateTime
***************

Various date and time objects are supplied by the "datetime" module.
Before using any of these functions, the header file "datetime.h" must
be included in your source (note that this is not included by
"Python.h"), and the macro "PyDateTime_IMPORT" must be invoked,
usually as part of the module initialisation function.  The macro puts
a pointer to a C structure into a static variable, "PyDateTimeAPI",
that is used by the following macros.

type PyDateTime_Date

   This subtype of "PyObject" represents a Python date object.

type PyDateTime_DateTime

   This subtype of "PyObject" represents a Python datetime object.

type PyDateTime_Time

   This subtype of "PyObject" represents a Python time object.

type PyDateTime_Delta

   This subtype of "PyObject" represents the difference between two
   datetime values.

PyTypeObject PyDateTime_DateType

   This instance of "PyTypeObject" represents the Python date type; it
   is the same object as "datetime.date" in the Python layer.

PyTypeObject PyDateTime_DateTimeType

   This instance of "PyTypeObject" represents the Python datetime
   type; it is the same object as "datetime.datetime" in the Python
   layer.

PyTypeObject PyDateTime_TimeType

   This instance of "PyTypeObject" represents the Python time type; it
   is the same object as "datetime.time" in the Python layer.

PyTypeObject PyDateTime_DeltaType

   This instance of "PyTypeObject" represents Python type for the
   difference between two datetime values; it is the same object as
   "datetime.timedelta" in the Python layer.

PyTypeObject PyDateTime_TZInfoType

   This instance of "PyTypeObject" represents the Python time zone
   info type; it is the same object as "datetime.tzinfo" in the Python
   layer.

Macro pour accéder au singleton UTC :

PyObject *PyDateTime_TimeZone_UTC

   Renvoie le singleton du fuseau horaire UTC, qui est le même objet
   que "datetime.timezone.utc".

   Ajouté dans la version 3.7.

Macros pour vérifier les types :

int PyDate_Check(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_DateType" or a subtype
   of "PyDateTime_DateType".  *ob* must not be "NULL".  This function
   always succeeds.

int PyDate_CheckExact(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_DateType". *ob* must not
   be "NULL".  This function always succeeds.

int PyDateTime_Check(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_DateTimeType" or a
   subtype of "PyDateTime_DateTimeType".  *ob* must not be "NULL".
   This function always succeeds.

int PyDateTime_CheckExact(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_DateTimeType". *ob* must
   not be "NULL".  This function always succeeds.

int PyTime_Check(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_TimeType" or a subtype
   of "PyDateTime_TimeType".  *ob* must not be "NULL".  This function
   always succeeds.

int PyTime_CheckExact(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_TimeType". *ob* must not
   be "NULL".  This function always succeeds.

int PyDelta_Check(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_DeltaType" or a subtype
   of "PyDateTime_DeltaType".  *ob* must not be "NULL".  This function
   always succeeds.

int PyDelta_CheckExact(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_DeltaType". *ob* must
   not be "NULL".  This function always succeeds.

int PyTZInfo_Check(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_TZInfoType" or a subtype
   of "PyDateTime_TZInfoType".  *ob* must not be "NULL".  This
   function always succeeds.

int PyTZInfo_CheckExact(PyObject *ob)

   Return true if *ob* is of type "PyDateTime_TZInfoType". *ob* must
   not be "NULL".  This function always succeeds.

Macros pour créer des objets :

PyObject *PyDate_FromDate(int year, int month, int day)
    *Valeur de retour : nouvelle référence.*

   Renvoie un objet "datetime.date" avec l'année, le mois et le jour
   spécifiés.

PyObject *PyDateTime_FromDateAndTime(int year, int month, int day, int hour, int minute, int second, int usecond)
    *Valeur de retour : nouvelle référence.*

   Renvoie un objet "datetime.datetime" avec l'année, le mois, le
   jour, l'heure, la minute, la seconde et la microseconde spécifiés.

PyObject *PyDateTime_FromDateAndTimeAndFold(int year, int month, int day, int hour, int minute, int second, int usecond, int fold)
    *Valeur de retour : nouvelle référence.*

   Renvoie un objet "datetime.datetime" avec l'année, le mois, le
   jour, l'heure, la minute, la seconde, la microseconde et le pli
   (*fold* en anglais) spécifiés.

   Ajouté dans la version 3.6.

PyObject *PyTime_FromTime(int hour, int minute, int second, int usecond)
    *Valeur de retour : nouvelle référence.*

   Renvoie un objet "datetime.time" avec l'heure, la minute, la
   seconde et la microseconde spécifiées.

PyObject *PyTime_FromTimeAndFold(int hour, int minute, int second, int usecond, int fold)
    *Valeur de retour : nouvelle référence.*

   Renvoie un objet "datetime.time" avec l'heure, la minute, la
   seconde, la microseconde et le pli (*fold* en anglais) spécifiés.

   Ajouté dans la version 3.6.

PyObject *PyDelta_FromDSU(int days, int seconds, int useconds)
    *Valeur de retour : nouvelle référence.*

   Renvoie un objet "datetime.timedelta" représentant le nombre passé
   en paramètre de jours, de secondes et de microsecondes. Le résultat
   est normalisé pour que le nombre de microsecondes et de secondes
   tombe dans la plage documentée pour les objets
   "datetime.timedelta".

PyObject *PyTimeZone_FromOffset(PyObject *offset)
    *Valeur de retour : nouvelle référence.*

   Renvoie un objet "datetime.timezone" avec un décalage anonyme fixe
   représenté par l'argument *offset*.

   Ajouté dans la version 3.7.

PyObject *PyTimeZone_FromOffsetAndName(PyObject *offset, PyObject *name)
    *Valeur de retour : nouvelle référence.*

   Renvoie un objet "datetime.timezone" avec un décalage fixe
   représenté par l'argument *offset* et avec le nom de fuseau horaire
   *name*.

   Ajouté dans la version 3.7.

Macros to extract fields from date objects.  The argument must be an
instance of "PyDateTime_Date", including subclasses (such as
"PyDateTime_DateTime").  The argument must not be "NULL", and the type
is not checked:

int PyDateTime_GET_YEAR(PyDateTime_Date *o)

   Renvoie l'année, sous forme d'entier positif.

int PyDateTime_GET_MONTH(PyDateTime_Date *o)

   Renvoie le mois, sous forme d'entier allant de 1 à 12.

int PyDateTime_GET_DAY(PyDateTime_Date *o)

   Renvoie le jour, sous forme d'entier allant de 1 à 31.

Macros to extract fields from datetime objects.  The argument must be
an instance of "PyDateTime_DateTime", including subclasses. The
argument must not be "NULL", and the type is not checked:

int PyDateTime_DATE_GET_HOUR(PyDateTime_DateTime *o)

   Renvoie l'heure, sous forme d'entier allant de 0 à 23.

int PyDateTime_DATE_GET_MINUTE(PyDateTime_DateTime *o)

   Renvoie la minute, sous forme d'entier allant de 0 à 59.

int PyDateTime_DATE_GET_SECOND(PyDateTime_DateTime *o)

   Renvoie la seconde, sous forme d'entier allant de 0 à 59.

int PyDateTime_DATE_GET_MICROSECOND(PyDateTime_DateTime *o)

   Renvoie la microseconde, sous forme d'entier allant de 0 à 999999.

int PyDateTime_DATE_GET_FOLD(PyDateTime_DateTime *o)

   Return the fold, as an int from 0 through 1.

   Ajouté dans la version 3.6.

PyObject *PyDateTime_DATE_GET_TZINFO(PyDateTime_DateTime *o)

   Return the tzinfo (which may be "None").

   Ajouté dans la version 3.10.

Macros to extract fields from time objects.  The argument must be an
instance of "PyDateTime_Time", including subclasses. The argument must
not be "NULL", and the type is not checked:

int PyDateTime_TIME_GET_HOUR(PyDateTime_Time *o)

   Renvoie l'heure, sous forme d'entier allant de 0 à 23.

int PyDateTime_TIME_GET_MINUTE(PyDateTime_Time *o)

   Renvoie la minute, sous forme d'entier allant de 0 à 59.

int PyDateTime_TIME_GET_SECOND(PyDateTime_Time *o)

   Renvoie la seconde, sous forme d'entier allant de 0 à 59.

int PyDateTime_TIME_GET_MICROSECOND(PyDateTime_Time *o)

   Renvoie la microseconde, sous forme d'entier allant de 0 à 999999.

int PyDateTime_TIME_GET_FOLD(PyDateTime_Time *o)

   Return the fold, as an int from 0 through 1.

   Ajouté dans la version 3.6.

PyObject *PyDateTime_TIME_GET_TZINFO(PyDateTime_Time *o)

   Return the tzinfo (which may be "None").

   Ajouté dans la version 3.10.

Macros to extract fields from time delta objects.  The argument must
be an instance of "PyDateTime_Delta", including subclasses. The
argument must not be "NULL", and the type is not checked:

int PyDateTime_DELTA_GET_DAYS(PyDateTime_Delta *o)

   Renvoie le nombre de jours, sous forme d'entier allant de
   "-999999999" à "999999999".

   Ajouté dans la version 3.3.

int PyDateTime_DELTA_GET_SECONDS(PyDateTime_Delta *o)

   Renvoie le nombre de secondes sous forme d'entier allant de 0 à
   86399.

   Ajouté dans la version 3.3.

int PyDateTime_DELTA_GET_MICROSECONDS(PyDateTime_Delta *o)

   Renvoie le nombre de microsecondes, sous forme d'entier allant de 0
   à 999999.

   Ajouté dans la version 3.3.

Macros de confort pour les modules implémentant l'API DB :

PyObject *PyDateTime_FromTimestamp(PyObject *args)
    *Valeur de retour : nouvelle référence.*

   Crée et renvoie un nouvel objet "datetime.datetime" à partir d'un
   n-uplet qui peut être passé à "datetime.datetime.fromtimestamp()".

PyObject *PyDate_FromTimestamp(PyObject *args)
    *Valeur de retour : nouvelle référence.*

   Crée et renvoie un nouvel objet "datetime.date" à partir d'un
   *n*-uplet qui peut être passé à "datetime.date.fromtimestamp()".
