From 7513c6b6fe50dd651abe4d9b0c2f207b032cabfe Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sat, 25 Mar 2023 09:44:05 +0200 Subject: [3.10] gh-101100: Document PyObject_ClearWeakRefs and gzip's name (#103002) --- Doc/c-api/weakref.rst | 10 ++++++++++ Doc/library/gzip.rst | 6 ++++++ 2 files changed, 16 insertions(+) diff --git a/Doc/c-api/weakref.rst b/Doc/c-api/weakref.rst index cb6aba3..b471260 100644 --- a/Doc/c-api/weakref.rst +++ b/Doc/c-api/weakref.rst @@ -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. diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index 33c4067..ec92fa2 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -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. -- cgit v0.12