Объекты даты и времени

Различные объекты даты и времени предоставляются модулем datetime. Перед использованием любой из этих функций необходимо включить в исходный код заголовочный файл datetime.h (обратите внимание, что он не включается модулем Python.h), а также вызвать макрос PyDateTime_IMPORT, обычно в составе функции инициализации модуля. Макрос помещает указатель на структуру C в статическую переменную PyDateTimeAPI, которая используется следующими макросами.

PyDateTime_IMPORT()

Импортирует C API datetime.

При успешном выполнении заполняет указатель PyDateTimeAPI. При ошибке устанавливает PyDateTimeAPI в значение NULL и возбуждает исключение. Вызывающий код должен проверить, произошла ли ошибка, с помощью PyErr_Occurred():

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

Предупреждение

Это несовместимо с субинтерпретаторами.

type PyDateTime_CAPI

Структура, содержащая поля C API datetime.

Поля этой структуры являются закрытыми и могут измениться.

Не используйте эту структуру напрямую; вместо этого предпочтительно использовать API PyDateTime_*.

PyDateTime_CAPI *PyDateTimeAPI

Динамически выделяемый объект, содержащий C API datetime.

Эта переменная доступна только после успешного выполнения PyDateTime_IMPORT.

type PyDateTime_Date

Этот подтип PyObject представляет объект date в Python.

type PyDateTime_DateTime

Этот подтип PyObject представляет объект datetime в Python.

type PyDateTime_Time

Этот подтип PyObject представляет объект time в Python.

type PyDateTime_Delta

Этот подтип PyObject представляет разность двух значений datetime.

PyTypeObject PyDateTime_DateType

Этот экземпляр PyTypeObject представляет тип date в Python; это тот же объект, что и datetime.date на уровне Python.

PyTypeObject PyDateTime_DateTimeType

Этот экземпляр PyTypeObject представляет тип datetime в Python; это тот же объект, что и datetime.datetime на уровне Python.

PyTypeObject PyDateTime_TimeType

Этот экземпляр PyTypeObject представляет тип time в Python; это тот же объект, что и datetime.time на уровне Python.

PyTypeObject PyDateTime_DeltaType

Этот экземпляр PyTypeObject представляет тип Python для разности двух значений datetime; это тот же объект, что и datetime.timedelta на уровне Python.

PyTypeObject PyDateTime_TZInfoType

Этот экземпляр PyTypeObject представляет тип информации о часовом поясе в Python; это тот же объект, что и datetime.tzinfo на уровне Python.

Макрос для доступа к singleton UTC:

PyObject *PyDateTime_TimeZone_UTC

Возвращает singleton часового пояса, представляющий UTC, — тот же объект, что и datetime.timezone.utc.

Добавлено в версии 3.7.

Макросы проверки типа:

int PyDate_Check(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_DateType или является подтипом PyDateTime_DateType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

int PyDate_CheckExact(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_DateType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

int PyDateTime_Check(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_DateTimeType или является подтипом PyDateTime_DateTimeType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

int PyDateTime_CheckExact(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_DateTimeType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

int PyTime_Check(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_TimeType или является подтипом PyDateTime_TimeType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

int PyTime_CheckExact(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_TimeType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

int PyDelta_Check(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_DeltaType или является подтипом PyDateTime_DeltaType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

int PyDelta_CheckExact(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_DeltaType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

int PyTZInfo_Check(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_TZInfoType или является подтипом PyDateTime_TZInfoType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

int PyTZInfo_CheckExact(PyObject *ob)

Возвращает true, если ob имеет тип PyDateTime_TZInfoType. Значение ob не должно быть NULL. Эта функция всегда завершается успешно.

Макросы для создания объектов:

PyObject *PyDate_FromDate(int year, int month, int day)

Возвращаемое значение: новая ссылка.

Возвращает объект datetime.date с указанными годом, месяцем и днём.

PyObject *PyDateTime_FromDateAndTime(int year, int month, int day, int hour, int minute, int second, int usecond)

Возвращаемое значение: новая ссылка.

Возвращает объект datetime.datetime с указанными годом, месяцем, днём, часом, минутой, секундой и микросекундой.

PyObject *PyDateTime_FromDateAndTimeAndFold(int year, int month, int day, int hour, int minute, int second, int usecond, int fold)

Возвращаемое значение: новая ссылка.

Возвращает объект datetime.datetime с указанными годом, месяцем, днём, часом, минутой, секундой, микросекундой и fold.

Добавлено в версии 3.6.

PyObject *PyTime_FromTime(int hour, int minute, int second, int usecond)

Возвращаемое значение: новая ссылка.

Возвращает объект datetime.time с указанными часом, минутой, секундой и микросекундой.

PyObject *PyTime_FromTimeAndFold(int hour, int minute, int second, int usecond, int fold)

Возвращаемое значение: новая ссылка.

Возвращает объект datetime.time с указанными часом, минутой, секундой, микросекундой и fold.

Добавлено в версии 3.6.

PyObject *PyDelta_FromDSU(int days, int seconds, int useconds)

Возвращаемое значение: новая ссылка.

Возвращает объект datetime.timedelta, представляющий заданное количество дней, секунд и микросекунд. Выполняется нормализация, чтобы полученное количество микросекунд и секунд находилось в диапазонах, описанных для объектов datetime.timedelta.

PyObject *PyTimeZone_FromOffset(PyObject *offset)

Возвращаемое значение: новая ссылка.

Возвращает объект datetime.timezone с фиксированным смещением без имени, заданным аргументом offset.

Добавлено в версии 3.7.

PyObject *PyTimeZone_FromOffsetAndName(PyObject *offset, PyObject *name)

Возвращаемое значение: новая ссылка.

Возвращает объект datetime.timezone с фиксированным смещением, заданным аргументом offset, и именем часового пояса name.

Добавлено в версии 3.7.

Макросы для извлечения полей из объектов даты. Аргумент должен быть экземпляром PyDateTime_Date, включая подклассы (например, PyDateTime_DateTime). Аргумент не должен быть NULL, проверка типа не выполняется:

int PyDateTime_GET_YEAR(PyDateTime_Date *o)

Возвращает год в виде положительного целого числа.

int PyDateTime_GET_MONTH(PyDateTime_Date *o)

Возвращает месяц в виде целого числа от 1 до 12.

int PyDateTime_GET_DAY(PyDateTime_Date *o)

Возвращает день в виде целого числа от 1 до 31.

Макросы для извлечения полей из объектов datetime. Аргумент должен быть экземпляром PyDateTime_DateTime, включая подклассы. Аргумент не должен быть NULL, проверка типа не выполняется:

int PyDateTime_DATE_GET_HOUR(PyDateTime_DateTime *o)

Возвращает час в виде целого числа от 0 до 23.

int PyDateTime_DATE_GET_MINUTE(PyDateTime_DateTime *o)

Возвращает минуту в виде целого числа от 0 до 59.

int PyDateTime_DATE_GET_SECOND(PyDateTime_DateTime *o)

Возвращает секунду в виде целого числа от 0 до 59.

int PyDateTime_DATE_GET_MICROSECOND(PyDateTime_DateTime *o)

Возвращает микросекунду в виде целого числа от 0 до 999999.

int PyDateTime_DATE_GET_FOLD(PyDateTime_DateTime *o)

Возвращает fold в виде целого числа от 0 до 1.

Добавлено в версии 3.6.

PyObject *PyDateTime_DATE_GET_TZINFO(PyDateTime_DateTime *o)

Возвращает tzinfo (который может быть None).

Добавлено в версии 3.10.

Макросы для извлечения полей из объектов времени. Аргумент должен быть экземпляром PyDateTime_Time, включая подклассы. Аргумент не должен быть NULL, проверка типа не выполняется:

int PyDateTime_TIME_GET_HOUR(PyDateTime_Time *o)

Возвращает час в виде целого числа от 0 до 23.

int PyDateTime_TIME_GET_MINUTE(PyDateTime_Time *o)

Возвращает минуту в виде целого числа от 0 до 59.

int PyDateTime_TIME_GET_SECOND(PyDateTime_Time *o)

Возвращает секунду в виде целого числа от 0 до 59.

int PyDateTime_TIME_GET_MICROSECOND(PyDateTime_Time *o)

Возвращает микросекунду в виде целого числа от 0 до 999999.

int PyDateTime_TIME_GET_FOLD(PyDateTime_Time *o)

Возвращает fold в виде целого числа от 0 до 1.

Добавлено в версии 3.6.

PyObject *PyDateTime_TIME_GET_TZINFO(PyDateTime_Time *o)

Возвращает tzinfo (который может быть None).

Добавлено в версии 3.10.

Макросы для извлечения полей из объектов интервала времени. Аргумент должен быть экземпляром PyDateTime_Delta, включая подклассы. Аргумент не должен быть NULL, проверка типа не выполняется:

int PyDateTime_DELTA_GET_DAYS(PyDateTime_Delta *o)

Возвращает количество дней в виде целого числа от -999999999 до 999999999.

Добавлено в версии 3.3.

int PyDateTime_DELTA_GET_SECONDS(PyDateTime_Delta *o)

Возвращает количество секунд в виде целого числа от 0 до 86399.

Добавлено в версии 3.3.

int PyDateTime_DELTA_GET_MICROSECONDS(PyDateTime_Delta *o)

Возвращает количество микросекунд в виде целого числа от 0 до 999999.

Добавлено в версии 3.3.

Макросы для удобства модулей, реализующих DB API:

PyObject *PyDateTime_FromTimestamp(PyObject *args)

Возвращаемое значение: новая ссылка.

Создаёт и возвращает новый объект datetime.datetime, принимая кортеж аргументов, подходящий для передачи в datetime.datetime.fromtimestamp().

PyObject *PyDate_FromTimestamp(PyObject *args)

Возвращаемое значение: новая ссылка.

Создаёт и возвращает новый объект datetime.date, принимая кортеж аргументов, подходящий для передачи в datetime.date.fromtimestamp().