Skip to content

bpo-29086: Add stableabi option to Documentation #23185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions Doc/c-api/datetime.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ macros.
Macro for access to the UTC singleton:

.. c:var:: PyObject* PyDateTime_TimeZone_UTC
:stableabi:

Returns the time zone singleton representing UTC, the same object as
:attr:`datetime.timezone.utc`.
Expand All @@ -26,60 +27,70 @@ Macro for access to the UTC singleton:
Type-check macros:

.. c:function:: int PyDate_Check(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_DateType` or a subtype of
:c:data:`PyDateTime_DateType`. *ob* must not be ``NULL``.


.. c:function:: int PyDate_CheckExact(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_DateType`. *ob* must not be
``NULL``.


.. c:function:: int PyDateTime_Check(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_DateTimeType` or a subtype of
:c:data:`PyDateTime_DateTimeType`. *ob* must not be ``NULL``.


.. c:function:: int PyDateTime_CheckExact(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_DateTimeType`. *ob* must not
be ``NULL``.


.. c:function:: int PyTime_Check(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_TimeType` or a subtype of
:c:data:`PyDateTime_TimeType`. *ob* must not be ``NULL``.


.. c:function:: int PyTime_CheckExact(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_TimeType`. *ob* must not be
``NULL``.


.. c:function:: int PyDelta_Check(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_DeltaType` or a subtype of
:c:data:`PyDateTime_DeltaType`. *ob* must not be ``NULL``.


.. c:function:: int PyDelta_CheckExact(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_DeltaType`. *ob* must not be
``NULL``.


.. c:function:: int PyTZInfo_Check(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_TZInfoType` or a subtype of
:c:data:`PyDateTime_TZInfoType`. *ob* must not be ``NULL``.


.. c:function:: int PyTZInfo_CheckExact(PyObject *ob)
:stableabi:

Return true if *ob* is of type :c:data:`PyDateTime_TZInfoType`. *ob* must not be
``NULL``.
Expand All @@ -88,17 +99,20 @@ Type-check macros:
Macros to create objects:

.. c:function:: PyObject* PyDate_FromDate(int year, int month, int day)
:stableabi:

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


.. c:function:: PyObject* PyDateTime_FromDateAndTime(int year, int month, int day, int hour, int minute, int second, int usecond)
:stableabi:

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


.. c:function:: PyObject* PyDateTime_FromDateAndTimeAndFold(int year, int month, int day, int hour, int minute, int second, int usecond, int fold)
:stableabi:

Return a :class:`datetime.datetime` object with the specified year, month, day, hour,
minute, second, microsecond and fold.
Expand All @@ -107,12 +121,14 @@ Macros to create objects:


.. c:function:: PyObject* PyTime_FromTime(int hour, int minute, int second, int usecond)
:stableabi:

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


.. c:function:: PyObject* PyTime_FromTimeAndFold(int hour, int minute, int second, int usecond, int fold)
:stableabi:

Return a :class:`datetime.time` object with the specified hour, minute, second,
microsecond and fold.
Expand All @@ -121,20 +137,23 @@ Macros to create objects:


.. c:function:: PyObject* PyDelta_FromDSU(int days, int seconds, int useconds)
:stableabi:

Return a :class:`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
:class:`datetime.timedelta` objects.

.. c:function:: PyObject* PyTimeZone_FromOffset(PyDateTime_DeltaType* offset)
:stableabi:

Return a :class:`datetime.timezone` object with an unnamed fixed offset
represented by the *offset* argument.

.. versionadded:: 3.7

.. c:function:: PyObject* PyTimeZone_FromOffsetAndName(PyDateTime_DeltaType* offset, PyUnicode* name)
:stableabi:

Return a :class:`datetime.timezone` object with a fixed offset represented
by the *offset* argument and with tzname *name*.
Expand All @@ -148,16 +167,19 @@ Macros to extract fields from date objects. The argument must be an instance of
not checked:

.. c:function:: int PyDateTime_GET_YEAR(PyDateTime_Date *o)
:stableabi:

Return the year, as a positive int.


.. c:function:: int PyDateTime_GET_MONTH(PyDateTime_Date *o)
:stableabi:

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


.. c:function:: int PyDateTime_GET_DAY(PyDateTime_Date *o)
:stableabi:

Return the day, as an int from 1 through 31.

Expand All @@ -167,25 +189,30 @@ instance of :c:data:`PyDateTime_DateTime`, including subclasses. The argument
must not be ``NULL``, and the type is not checked:

.. c:function:: int PyDateTime_DATE_GET_HOUR(PyDateTime_DateTime *o)
:stableabi:

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


.. c:function:: int PyDateTime_DATE_GET_MINUTE(PyDateTime_DateTime *o)
:stableabi:

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


.. c:function:: int PyDateTime_DATE_GET_SECOND(PyDateTime_DateTime *o)
:stableabi:

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


.. c:function:: int PyDateTime_DATE_GET_MICROSECOND(PyDateTime_DateTime *o)
:stableabi:

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

.. c:function:: PyObject* PyDateTime_DATE_GET_TZINFO(PyDateTime_DateTime *o)
:stableabi:

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

Expand All @@ -196,25 +223,30 @@ Macros to extract fields from time objects. The argument must be an instance of
and the type is not checked:

.. c:function:: int PyDateTime_TIME_GET_HOUR(PyDateTime_Time *o)
:stableabi:

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


.. c:function:: int PyDateTime_TIME_GET_MINUTE(PyDateTime_Time *o)
:stableabi:

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


.. c:function:: int PyDateTime_TIME_GET_SECOND(PyDateTime_Time *o)
:stableabi:

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


.. c:function:: int PyDateTime_TIME_GET_MICROSECOND(PyDateTime_Time *o)
:stableabi:

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

.. c:function:: PyObject* PyDateTime_TIME_GET_TZINFO(PyDateTime_Time *o)
:stableabi:

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

Expand All @@ -226,20 +258,23 @@ instance of :c:data:`PyDateTime_Delta`, including subclasses. The argument must
not be ``NULL``, and the type is not checked:

.. c:function:: int PyDateTime_DELTA_GET_DAYS(PyDateTime_Delta *o)
:stableabi:

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

.. versionadded:: 3.3


.. c:function:: int PyDateTime_DELTA_GET_SECONDS(PyDateTime_Delta *o)
:stableabi:

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

.. versionadded:: 3.3


.. c:function:: int PyDateTime_DELTA_GET_MICROSECONDS(PyDateTime_Delta *o)
:stableabi:

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

Expand All @@ -249,12 +284,14 @@ not be ``NULL``, and the type is not checked:
Macros for the convenience of modules implementing the DB API:

.. c:function:: PyObject* PyDateTime_FromTimestamp(PyObject *args)
:stableabi:

Create and return a new :class:`datetime.datetime` object given an argument
tuple suitable for passing to :meth:`datetime.datetime.fromtimestamp()`.


.. c:function:: PyObject* PyDate_FromTimestamp(PyObject *args)
:stableabi:

Create and return a new :class:`datetime.date` object given an argument
tuple suitable for passing to :meth:`datetime.date.fromtimestamp()`.