Skip to content

gh-143535: Document dispatch behavior of singledispatchmethod #143592

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

Closed
priyanshu2282-cyber wants to merge 8 commits into from
Closed

gh-143535: Document dispatch behavior of singledispatchmethod #143592

Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
666a2a8
gh-143535: Document dispatch behavior of singledispatchmethod
priyanshu2282-cyber Jan 9, 2026
ea2fda1
gh-143535: Move singledispatchmethod note outside example block
priyanshu2282-cyber Jan 9, 2026
119a4b1
Merge branch 'main' into doc-singledispatchmethod-dispatch
priyanshu2282-cyber Jan 9, 2026
2834c45
gh-143535: Clarify dispatch semantics of singledispatchmethod
priyanshu2282-cyber Jan 9, 2026
57e6d20
Update Doc/library/functools.rst
priyanshu2282-cyber Jan 12, 2026
44f3295
Indentation fixes
priyanshu2282-cyber Jan 12, 2026
e033b66
gh-143535: Fix indentation in singledispatchmethod docs
priyanshu2282-cyber Jan 13, 2026
48d6546
Used decorators
priyanshu2282-cyber Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Doc/library/functools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,6 +718,11 @@ The :mod:`functools` module defines the following functions:
The same pattern can be used for other similar decorators:
:deco:`staticmethod`, :deco:`~abc.abstractmethod`, and others.

For every ``singledispatchmethod`` method defined in a class, the value
Copy link
Copy Markdown
Member

@picnixz picnixz Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't define a singledispatchmethod, you decorate one with this decorator. See the other paragraphs.

Copy link
Copy Markdown
Member

@johnslavik johnslavik Jan 13, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't define a singledispatchmethod

It doesn't say singledispatchmethod defined in a class, but singledispatchmethod method defined in a class.

However, I agree that the current wording can be better. If it was good, you wouldn't have raised the thread.

Copy link
Copy Markdown
Contributor Author

@priyanshu2282-cyber priyanshu2282-cyber Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your clarification, I have used the decorators as suggested, and updated the PR.

dispatched on by that method is *always* the first argument passed for the call.
Therefore, dispatching to regular methods can only be sensibly performed by
calling such a method from instances of the class, and not from the class object.
Copy link
Copy Markdown
Member

@picnixz picnixz Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Align your paragraph with the other paragraphs, that is, use the correct indentation. You're 1 space off.

Copy link
Copy Markdown
Contributor Author

@priyanshu2282-cyber priyanshu2282-cyber Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, Aligned!


.. versionadded:: 3.8

.. versionchanged:: 3.15
Expand Down
Loading