diff options
| author |   Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-11-30 11:53:04 -0800 |
|---|---|---|
| committer |   GitHub <noreply@github.com> | 2022-11-30 11:53:04 -0800 |
| commit | 90701ebaf4b121b9a9767d5e8645b8e9de7702af (patch) | |
| tree | b28ac07c5ca912047c85773ca594518ce7f8c291 | |
| parent | gh-82836: fix private network check (GH-97733) (diff) | |
| download | cpython-90701ebaf4b121b9a9767d5e8645b8e9de7702af.tar.gz cpython-90701ebaf4b121b9a9767d5e8645b8e9de7702af.tar.bz2 cpython-90701ebaf4b121b9a9767d5e8645b8e9de7702af.zip | |
bpo-47220: Document the optional callback parameter of weakref.WeakMethod (GH-25491)
(cherry picked from commit 9628136fac997847b4662e6a17faf06d2a0507eb)
Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
| -rw-r--r-- | Doc/library/weakref.rst | 6 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Library/2022-04-04-22-54-11.bpo-47220.L9jYu4.rst | 2 |
2 files changed, 6 insertions, 2 deletions
diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst index a1e542b1e9..73e7b21ae4 100644 --- a/Doc/library/weakref.rst +++ b/Doc/library/weakref.rst @@ -143,7 +143,7 @@ See :ref:`__slots__ documentation <slots>` for details. ``ProxyType`` or ``CallableProxyType``, depending on whether *object* is callable. Proxy objects are not :term:`hashable` regardless of the referent; this avoids a number of problems related to their fundamentally mutable nature, and - prevent their use as dictionary keys. *callback* is the same as the parameter + prevents their use as dictionary keys. *callback* is the same as the parameter of the same name to the :func:`ref` function. Accessing an attribute of the proxy object after the referent is @@ -212,7 +212,7 @@ objects. discarded when no strong reference to it exists any more. -.. class:: WeakMethod(method) +.. class:: WeakMethod(method[, callback]) A custom :class:`ref` subclass which simulates a weak reference to a bound method (i.e., a method defined on a class and looked up on an instance). @@ -238,6 +238,8 @@ objects. >>> r() >>> + *callback* is the same as the parameter of the same name to the :func:`ref` function. + .. versionadded:: 3.4 .. class:: finalize(obj, func, /, *args, **kwargs) diff --git a/Misc/NEWS.d/next/Library/2022-04-04-22-54-11.bpo-47220.L9jYu4.rst b/Misc/NEWS.d/next/Library/2022-04-04-22-54-11.bpo-47220.L9jYu4.rst new file mode 100644 index 0000000000..6e2af08864 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2022-04-04-22-54-11.bpo-47220.L9jYu4.rst @@ -0,0 +1,2 @@ +Document the optional *callback* parameter of :class:`WeakMethod`. Patch by +Géry Ogam. |