DateTime Objects

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.

Import the datetime C API.

On success, populate the PyDateTimeAPI pointer. On failure, set PyDateTimeAPI to NULL and set an exception. The caller must check if an error occurred via PyErr_Occurred:

PyDateTime_IMPORT;
if (PyErr_Occurred()) { /* cleanup */ }

[!WARNING] This is not compatible with subinterpreters.

3.15

This macro is now thread safe.

Structure containing the fields for the datetime C API.

The fields of this structure are private and subject to change.

Do not use this directly; prefer PyDateTime_* APIs instead.

Dynamically allocated object containing the datetime C API.

This variable is only available once PyDateTime_IMPORT succeeds.

3.15

This variable should not be accessed directly as direct access is not thread-safe. Use PyDateTime_IMPORT instead.

This subtype of PyObject represents a Python date object.

This subtype of PyObject represents a Python datetime object.

This subtype of PyObject represents a Python time object.

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

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

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

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

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

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

Macro for access to the UTC singleton:

Returns the time zone singleton representing UTC, the same object as datetime.timezone.utc.

3.7

Type-check macros:

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

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

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

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

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

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

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

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

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

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

Macros to create objects:

Return a datetime.date object with the specified year, month and day.

Return a datetime.datetime object with the specified year, month, day, hour, minute, second and microsecond.

Return a datetime.datetime object with the specified year, month, day, hour, minute, second, microsecond and fold.

3.6

Return a datetime.time object with the specified hour, minute, second and microsecond.

Return a datetime.time object with the specified hour, minute, second, microsecond and fold.

3.6

Return a datetime.timedelta object representing the given number of days, seconds and microseconds. Normalization is performed so that the resulting number of microseconds and seconds lie in the ranges documented for datetime.timedelta objects.

Return a datetime.timezone object with an unnamed fixed offset represented by the offset argument.

3.7

Return a datetime.timezone object with a fixed offset represented by the offset argument and with tzname name.

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:

Return the year, as a positive int.

Return the month, as an int from 1 through 12.

Return the day, as an int from 1 through 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:

Return the hour, as an int from 0 through 23.

Return the minute, as an int from 0 through 59.

Return the second, as an int from 0 through 59.

Return the microsecond, as an int from 0 through 999999.

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

3.6

Return the tzinfo (which may be None).

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:

Return the hour, as an int from 0 through 23.

Return the minute, as an int from 0 through 59.

Return the second, as an int from 0 through 59.

Return the microsecond, as an int from 0 through 999999.

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

3.6

Return the tzinfo (which may be None).

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:

Return the number of days, as an int from -999999999 to 999999999.

3.3

Return the number of seconds, as an int from 0 through 86399.

3.3

Return the number of microseconds, as an int from 0 through 999999.

3.3

Macros for the convenience of modules implementing the DB API:

Create and return a new datetime.datetime object given an argument tuple suitable for passing to datetime.datetime.fromtimestamp.

Create and return a new datetime.date object given an argument tuple suitable for passing to datetime.date.fromtimestamp.

Internal data

The following symbols are exposed by the C API but should be considered internal-only.

Name of the datetime capsule to pass to PyCapsule_Import.

Internal usage only. Use PyDateTime_IMPORT instead.