[3.10] gh-101100: Document PyObject_ClearWeakRefs and gzip's name (#103002)

This commit is contained in:
Hugo van Kemenade 2023-03-25 09:44:05 +02:00 committed by GitHub
parent d3b4d3ace9
commit 7513c6b6fe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 0 deletions

View file

@ -68,3 +68,13 @@ as much as it can.
Similar to :c:func:`PyWeakref_GetObject`, but implemented as a macro that does no
error checking.
.. c:function:: void PyObject_ClearWeakRefs(PyObject *object)
This function is called by the :c:member:`~PyTypeObject.tp_dealloc` handler
to clear weak references.
This iterates through the weak references for *object* and calls callbacks
for those references which have one. It returns when all callbacks have
been attempted.

View file

@ -143,6 +143,12 @@ The module defines the following items:
:func:`time.time` and the :attr:`~os.stat_result.st_mtime` attribute of
the object returned by :func:`os.stat`.
.. attribute:: name
The path to the gzip file on disk, as a :class:`str` or :class:`bytes`.
Equivalent to the output of :func:`os.fspath` on the original input path,
with no other normalization, resolution or expansion.
.. versionchanged:: 3.1
Support for the :keyword:`with` statement was added, along with the
*mtime* constructor argument and :attr:`mtime` attribute.