Navigation
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.
Type-check macros:
-
int
PyDate_Check(PyObject *ob) Return true if ob is of type
PyDateTime_DateTypeor a subtype ofPyDateTime_DateType. ob must not be NULL.New in version 2.4.
-
int
PyDate_CheckExact(PyObject *ob) Return true if ob is of type
PyDateTime_DateType. ob must not be NULL.New in version 2.4.
-
int
PyDateTime_Check(PyObject *ob) Return true if ob is of type
PyDateTime_DateTimeTypeor a subtype ofPyDateTime_DateTimeType. ob must not be NULL.New in version 2.4.
-
int
PyDateTime_CheckExact(PyObject *ob) Return true if ob is of type
PyDateTime_DateTimeType. ob must not be NULL.New in version 2.4.
-
int
PyTime_Check(PyObject *ob) Return true if ob is of type
PyDateTime_TimeTypeor a subtype ofPyDateTime_TimeType. ob must not be NULL.New in version 2.4.
-
int
PyTime_CheckExact(PyObject *ob) Return true if ob is of type
PyDateTime_TimeType. ob must not be NULL.New in version 2.4.
-
int
PyDelta_Check(PyObject *ob) Return true if ob is of type
PyDateTime_DeltaTypeor a subtype ofPyDateTime_DeltaType. ob must not be NULL.New in version 2.4.
-
int
PyDelta_CheckExact(PyObject *ob) Return true if ob is of type
PyDateTime_DeltaType. ob must not be NULL.New in version 2.4.
-
int
PyTZInfo_Check(PyObject *ob) Return true if ob is of type
PyDateTime_TZInfoTypeor a subtype ofPyDateTime_TZInfoType. ob must not be NULL.New in version 2.4.
-
int
PyTZInfo_CheckExact(PyObject *ob) Return true if ob is of type
PyDateTime_TZInfoType. ob must not be NULL.New in version 2.4.
Macros to create objects:
-
PyObject*
PyDate_FromDate(int year, int month, int day) - Return value: New reference.
Return a
datetime.dateobject with the specified year, month and day.New in version 2.4.
-
PyObject*
PyDateTime_FromDateAndTime(int year, int month, int day, int hour, int minute, int second, int usecond) - Return value: New reference.
Return a
datetime.datetimeobject with the specified year, month, day, hour, minute, second and microsecond.New in version 2.4.
-
PyObject*
PyTime_FromTime(int hour, int minute, int second, int usecond) - Return value: New reference.
Return a
datetime.timeobject with the specified hour, minute, second and microsecond.New in version 2.4.
-
PyObject*
PyDelta_FromDSU(int days, int seconds, int useconds) - Return value: New reference.
Return a
datetime.timedeltaobject 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 fordatetime.timedeltaobjects.New in version 2.4.
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) Return the year, as a positive int.
New in version 2.4.
-
int
PyDateTime_GET_MONTH(PyDateTime_Date *o) Return the month, as an int from 1 through 12.
New in version 2.4.
-
int
PyDateTime_GET_DAY(PyDateTime_Date *o) Return the day, as an int from 1 through 31.
New in version 2.4.
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) Return the hour, as an int from 0 through 23.
New in version 2.4.
-
int
PyDateTime_DATE_GET_MINUTE(PyDateTime_DateTime *o) Return the minute, as an int from 0 through 59.
New in version 2.4.
-
int
PyDateTime_DATE_GET_SECOND(PyDateTime_DateTime *o) Return the second, as an int from 0 through 59.
New in version 2.4.
-
int
PyDateTime_DATE_GET_MICROSECOND(PyDateTime_DateTime *o) Return the microsecond, as an int from 0 through 999999.
New in version 2.4.
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) Return the hour, as an int from 0 through 23.
New in version 2.4.
-
int
PyDateTime_TIME_GET_MINUTE(PyDateTime_Time *o) Return the minute, as an int from 0 through 59.
New in version 2.4.
-
int
PyDateTime_TIME_GET_SECOND(PyDateTime_Time *o) Return the second, as an int from 0 through 59.
New in version 2.4.
-
int
PyDateTime_TIME_GET_MICROSECOND(PyDateTime_Time *o) Return the microsecond, as an int from 0 through 999999.
New in version 2.4.
Macros for the convenience of modules implementing the DB API: