# DateTime 对象

`datetime` 模块提供了各种日期和时间对象。在使用任何这些函数之前，必须在你的源码中包含头文件 `datetime.h` (请注意此文件并未包含在 `Python.h` 中)，并且宏 `PyDateTime_IMPORT` 必须被发起调用，通常是作为模块初始化函数的一部分。这个宏会将指向特定 C 结构的指针放入一个静态变量 `PyDateTimeAPI` 中，它会由下面的宏来使用。

PyDateTime_IMPORT()

  导入 datetime C API。

  成功时，填充 `PyDateTimeAPI` 指针。失败时，将 `PyDateTimeAPI` 设为 `NULL` 并设置一个异常。调用方必须通过 `PyErr_Occurred()` 检查是否发生了错误：

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

  警告

  此特性不兼容子解释器。

type PyDateTime_CAPI

  包含用于 datetime C API 的字段的结构体。

  该结构体的字段是私有的并可能发生改变。

  不要直接使用此字段；建议改用 `PyDateTime_*` API。

PyDateTime_CAPI *PyDateTimeAPI

  包含 datetime C API 的动态分配的对象。

  此变量仅在 `PyDateTime_IMPORT` 执行成功时才可用。

type PyDateTime_Date

  `PyObject` 的这个子类型表示 Python 日期对象。

type PyDateTime_DateTime

  `PyObject` 的这个子类型表示 Python 日期时间对象。

type PyDateTime_Time

  `PyObject` 的这个子类型表示 Python 时间对象。

type PyDateTime_Delta

  `PyObject` 的这个子类型表示两个日期时间值之间的差值。

PyTypeObject PyDateTime_DateType

  这个 `PyTypeObject` 的实例代表 Python 日期类型；它与 Python 层面的 `datetime.date` 对象相同。

PyTypeObject PyDateTime_DateTimeType

  这个 `PyTypeObject` 的实例代表 Python 日期时间类型；它与 Python 层面的 `datetime.datetime` 对象相同。

PyTypeObject PyDateTime_TimeType

  这个 `PyTypeObject` 的实例代表 Python 时间类型；它与 Python 层面的 `datetime.time` 对象相同。

PyTypeObject PyDateTime_DeltaType

  这个 `PyTypeObject` 的实例代表两个日期时间值之间差值的 Python 类型；它与 Python 层面的 `datetime.timedelta` 是同一对象。

PyTypeObject PyDateTime_TZInfoType

  这个 `PyTypeObject` 的实例代表 Python 时区信息类型；它与 Python 层面的 `datetime.tzinfo` 对象相同。

用于访问 UTC 单例的宏：

PyObject *PyDateTime_TimeZone_UTC

  返回表示 UTC 的时区单例，与 `datetime.timezone.utc` 为同一对象。

  Added in version 3.7.

类型检查宏：

int PyDate_Check(PyObject *ob)

  如果 ob 为 `PyDateTime_DateType` 类型或 `PyDateTime_DateType` 的某个子类型则返回真值。 ob 不能为 `NULL`。此函数总是会成功执行。

int PyDate_CheckExact(PyObject *ob)

  如果 ob 为 `PyDateTime_DateType` 类型则返回真值。 ob 不能为 `NULL`。 此函数总是会成功执行。

int PyDateTime_Check(PyObject *ob)

  如果 ob 为 `PyDateTime_DateTimeType` 类型或 `PyDateTime_DateTimeType` 的某个子类型则返回真值。 ob 不能为 `NULL`。 此函数总是会成功执行。

int PyDateTime_CheckExact(PyObject *ob)

  如果 ob 为 `PyDateTime_DateTimeType` 类型则返回真值。 ob 不能为 `NULL`。 此函数总是会成功执行。

int PyTime_Check(PyObject *ob)

  如果 ob 为 `PyDateTime_TimeType` 类型或 `PyDateTime_TimeType` 的某个子类型则返回真值。 ob 不能为 `NULL`。此函数总是会成功执行。

int PyTime_CheckExact(PyObject *ob)

  如果 ob 为 `PyDateTime_TimeType` 类型则返回真值。 ob 不能为 `NULL`。 此函数总是会成功执行。

int PyDelta_Check(PyObject *ob)

  如果 ob 为 `PyDateTime_DeltaType` 类型或 `PyDateTime_DeltaType` 的某个子类型则返回真值。 ob 不能为 `NULL`。此函数总是会成功执行。

int PyDelta_CheckExact(PyObject *ob)

  如果 ob 为 `PyDateTime_DeltaType` 类型则返回真值。 ob 不能为 `NULL`。 此函数总是会成功执行。

int PyTZInfo_Check(PyObject *ob)

  如果 ob 为 `PyDateTime_TZInfoType` 类型或 `PyDateTime_TZInfoType` 的某个子类型则返回真值。 ob 不能为 `NULL`。 此函数总是会成功执行。

int PyTZInfo_CheckExact(PyObject *ob)

  如果 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)
  返回值：新的引用。

  返回具有指定 year, month, day, hour, minute, second 和 microsecond 属性的 `datetime.datetime` 对象。

PyObject *PyDateTime_FromDateAndTimeAndFold(int year, int month, int day, int hour, int minute, int second, int usecond, int fold)
  返回值：新的引用。

  返回具有指定 year, month, day, hour, minute, second, microsecond 和 fold 属性的 `datetime.datetime` 对象。

  Added in version 3.6.

PyObject *PyTime_FromTime(int hour, int minute, int second, int usecond)
  返回值：新的引用。

  返回具有指定 hour, minute, second 和 microsecond 属性的 `datetime.time` 对象。

PyObject *PyTime_FromTimeAndFold(int hour, int minute, int second, int usecond, int fold)
  返回值：新的引用。

  返回具有指定 hour, minute, second, microsecond 和 fold 属性的 `datetime.time` 对象。

  Added in version 3.6.

PyObject *PyDelta_FromDSU(int days, int seconds, int useconds)
  返回值：新的引用。

  返回代表给定天、秒和微秒数的 `datetime.timedelta` 对象。将执行正规化操作以使最终的微秒和秒数处在 `datetime.timedelta` 对象的文档指明的区间之内。

PyObject *PyTimeZone_FromOffset(PyObject *offset)
  返回值：新的引用。

  返回一个 `datetime.timezone` 对象，该对象具有以 offset 参数表示的未命名固定时差。

  Added in version 3.7.

PyObject *PyTimeZone_FromOffsetAndName(PyObject *offset, PyObject *name)
  返回值：新的引用。

  返回一个 `datetime.timezone` 对象，该对象具有以 offset 参数表示的固定时差和时区名称 name。

  Added in version 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 的整数。

一些用来从日期时间对象中提取字段的宏。参数必须是 `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)

  返回折叠值，为整数 0 或 1。

  Added in version 3.6.

PyObject *PyDateTime_DATE_GET_TZINFO(PyDateTime_DateTime *o)

  返回 tzinfo (可以为 `None`)。

  Added in version 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)

  返回折叠值，为整数 0 或 1。

  Added in version 3.6.

PyObject *PyDateTime_TIME_GET_TZINFO(PyDateTime_Time *o)

  返回 tzinfo (可以为 `None`)。

  Added in version 3.10.

一些用来从时间差对象中提取字段的宏。参数必须是 `PyDateTime_Delta` 包括其子类的实例。参数不能为 `NULL`，并且不会检查类型：

int PyDateTime_DELTA_GET_DAYS(PyDateTime_Delta *o)

  返回天数，从 -999999999 到 999999999 的整数。

  Added in version 3.3.

int PyDateTime_DELTA_GET_SECONDS(PyDateTime_Delta *o)

  返回秒数，从 0 到 86399 的整数。

  Added in version 3.3.

int PyDateTime_DELTA_GET_MICROSECONDS(PyDateTime_Delta *o)

  返回微秒数，从 0 到 999999 的整数。

  Added in version 3.3.

一些便于模块实现 DB API 的宏：

PyObject *PyDateTime_FromTimestamp(PyObject *args)
  返回值：新的引用。

  创建并返回一个新的 `datetime.datetime` 对象，给定一个适合传递给 `datetime.datetime.fromtimestamp()` 的参数元组。

PyObject *PyDate_FromTimestamp(PyObject *args)
  返回值：新的引用。

  创建并返回一个新的 `datetime.date` 对象，给定一个适合传递给 `datetime.date.fromtimestamp()` 的参数元组。

# 内部数据

下列符号由 C API 对外暴露但是应当被视为仅限内部使用。

PyDateTime_CAPSULE_NAME

  要传给 `PyCapsule_Import()` 的 datetime capsule 的名称。

  仅限内部使用。请改用 `PyDateTime_IMPORT`。