FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.11] bpo-47220: Document the optional callback parameter of weakref.WeakMethod (GH-25491) by miss-islington · Pull Request #99909 · python/cpython · GitHub

/ cpython Public

[3.11] bpo-47220: Document the optional callback parameter of weakref.WeakMethod (GH-25491) #99909

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.

Sign up for GitHub

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

Merged
miss-islington merged 1 commit into from
Nov 30, 2022
Conversation 2 Commits 1 Checks 0 Files changed
Merged

[3.11] bpo-47220: Document the optional callback parameter of weakref.WeakMethod (GH-25491) #99909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
6 changes: 4 additions & 2 deletions Doc/library/weakref.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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).
Expand All @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2022-04-04-22-54-11.bpo-47220.L9jYu4.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Document the optional *callback* parameter of :class:`WeakMethod`. Patch by
Géry Ogam.
Back | FazBrowse Home | New Git URL