Commitda2a52b

committed

Deploy preview for PR 1172 🛫

1 parent52270bf commitda2a52bCopy full SHA for da2a52b

File tree

576 files changed

+1012

-726

lines changed

pr-preview/pr-1172

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

576 files changed

+1012

-726

lines changed

`‎pr-preview/pr-1172/_sources/c-api/datetime.rst.txt‎`

Lines changed: 46 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,42 @@ DateTime Objects`
`8`	`8`	Various date and time objects are supplied by the:mod:`datetime` module.
`9`	`9`	Before using any of these functions, the header file:file:`datetime.h` must be
`10`	`10`	included in your source (note that this is not included by:file:`Python.h`),
`11`		-and the macro:c:macro:`!PyDateTime_IMPORT` must be invoked, usually as part of
	`11`	+and the macro:c:macro:`PyDateTime_IMPORT` must be invoked, usually as part of
`12`	`12`	`the module initialisation function. The macro puts a pointer to a C structure`
`13`		-into a static variable,:c:data:`!PyDateTimeAPI`, that is used by the following
	`13`	+into a static variable,:c:data:`PyDateTimeAPI`, that is used by the following
`14`	`14`	`macros.`
`15`	`15`
	`16`	`+..c:macro:: PyDateTime_IMPORT()`
	`17`	`+`
	`18`	`+ Import the datetime C API.`
	`19`	`+`
	`20`	+ On success, populate the:c:var:`PyDateTimeAPI` pointer.
	`21`	+ On failure, set:c:var:`PyDateTimeAPI` to ``NULL`` and set an exception.
	`22`	+ The caller must check if an error occurred via:c:func:`PyErr_Occurred`:
	`23`	`+`
	`24`	`+ ..code-block::`
	`25`	`+`
	`26`	`+ PyDateTime_IMPORT;`
	`27`	`+ if (PyErr_Occurred()) { /* cleanup */ }`
	`28`	`+`
	`29`	`+ ..warning::`
	`30`	`+`
	`31`	`+ This is not compatible with subinterpreters.`
	`32`	`+`
	`33`	`+..c:type:: PyDateTime_CAPI`
	`34`	`+`
	`35`	`+ Structure containing the fields for the datetime C API.`
	`36`	`+`
	`37`	`+ The fields of this structure are private and subject to change.`
	`38`	`+`
	`39`	+ Do not use this directly; prefer ``PyDateTime_*`` APIs instead.
	`40`	`+`
	`41`	`+..c:var:: PyDateTime_CAPI *PyDateTimeAPI`
	`42`	`+`
	`43`	`+ Dynamically allocated object containing the datetime C API.`
	`44`	`+`
	`45`	+ This variable is only available once:c:macro:`PyDateTime_IMPORT` succeeds.
	`46`	`+`
`16`	`47`	`..c:type:: PyDateTime_Date`
`17`	`48`
`18`	`49`	This subtype of:c:type:`PyObject` represents a Python date object.
`@@ -325,3 +356,16 @@ Macros for the convenience of modules implementing the DB API:`
`325`	`356`
`326`	`357`	Create and return a new:class:`datetime.date` object given an argument
`327`	`358`	tuple suitable for passing to:meth:`datetime.date.fromtimestamp`.
	`359`	`+`
	`360`	`+`
	`361`	`+Internal data`
	`362`	`+-------------`
	`363`	`+`
	`364`	`+The following symbols are exposed by the C API but should be considered`
	`365`	`+internal-only.`
	`366`	`+`
	`367`	`+..c:macro:: PyDateTime_CAPSULE_NAME`
	`368`	`+`
	`369`	+ Name of the datetime capsule to pass to:c:func:`PyCapsule_Import`.
	`370`	`+`
	`371`	+ Internal usage only. Use:c:macro:`PyDateTime_IMPORT` instead.

`‎pr-preview/pr-1172/_sources/c-api/gen.rst.txt‎`

Lines changed: 38 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -44,3 +44,41 @@ than explicitly calling :c:func:`PyGen_New` or :c:func:`PyGen_NewWithQualName`.
`44`	`44`	with ``__name__`` and ``__qualname__`` set to name and qualname.
`45`	`45`	`A reference to frame is stolen by this function. The frame argument`
`46`	`46`	must not be ``NULL``.
	`47`	`+`
	`48`	`+..c:function:: PyCodeObjectPyGen_GetCode(PyGenObject gen)`
	`49`	`+`
	`50`	+ Return a new:term:`strong reference` to the code object wrapped by gen.
	`51`	`+ This function always succeeds.`
	`52`	`+`
	`53`	`+`
	`54`	`+Asynchronous Generator Objects`
	`55`	`+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
	`56`	`+`
	`57`	`+..seealso::`
	`58`	+:pep:`525`
	`59`	`+`
	`60`	`+..c:var:: PyTypeObject PyAsyncGen_Type`
	`61`	`+`
	`62`	`+ The type object corresponding to asynchronous generator objects. This is`
	`63`	+ available as:class:`types.AsyncGeneratorType` in the Python layer.
	`64`	`+`
	`65`	`+ ..versionadded::3.6`
	`66`	`+`
	`67`	`+..c:function:: PyObject PyAsyncGen_New(PyFrameObject frame, PyObject name, PyObject qualname)`
	`68`	`+`
	`69`	+ Create a new asynchronous generator wrapping frame, with ``__name__`` and
	`70`	+ ``__qualname__`` set to name and qualname. frame is stolen by this
	`71`	+ function and must not be ``NULL``.
	`72`	`+`
	`73`	+ On success, this function returns a:term:`strong reference` to the
	`74`	+ new asynchronous generator. On failure, this function returns ``NULL``
	`75`	`+ with an exception set.`
	`76`	`+`
	`77`	`+ ..versionadded::3.6`
	`78`	`+`
	`79`	`+..c:function::intPyAsyncGen_CheckExact(PyObject *op)`
	`80`	`+`
	`81`	`+ Return true if op is an asynchronous generator object, false otherwise.`
	`82`	`+ This function always succeeds.`
	`83`	`+`
	`84`	`+ ..versionadded::3.6`