Repository navigation
Document magic methods called by built-in functions #54498
Description
| BPO | 10289 |
|---|---|
| Nosy | @rhettinger, @mdickinson, @abalkin, @merwok, @berkerpeksag, @vadmium, @serhiy-storchaka, @andy-maier |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2010-11-01.23:54:55.121>
labels = ['type-feature', 'docs']
title = 'Document magic methods called by built-in functions'
updated_at = <Date 2016-04-10.00:55:02.725>
user = 'https://github.com/merwok'bugs.python.org fields:
activity = <Date 2016-04-10.00:55:02.725>
actor = 'rhettinger'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2010-11-01.23:54:55.121>
creator = 'eric.araujo'
dependencies = []
files = ['35879', '35881']
hgrepos = []
issue_num = 10289
keywords = ['patch']
message_count = 11.0
messages = ['120189', '120191', '222290', '222443', '222446', '222477', '222480', '222486', '222487', '240517', '263119']
nosy_count = 10.0
nosy_names = ['rhettinger', 'mark.dickinson', 'belopolsky', 'eric.araujo', 'cvrebert', 'docs@python', 'berker.peksag', 'martin.panter', 'serhiy.storchaka', 'andymaier']
pr_nums = []
priority = 'low'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue10289'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6']
Activity
merwok commentedon Nov 1, 2010
At the top of Doc/library/functions.rst, which documents built-in functions like abs, getattr or hash, a comment reads “document all delegations to __special__ methods”.
Some functions are already good: enumerate for instance does link to the definition of iterator and hints about the __next__ method, format points to __format__, etc. They can serve as example for how to add links (in plain text and in the global index).
abalkin commentedon Nov 2, 2010
Éric,
I just wanted to link to a related discussion we had under bpo-8983. See msg107689.
andy-maier commentedon Jul 4, 2014
I have reviewed the descriptions of the built-in functions in Python 3.4, and found only the following issues w.r.t. missing __special__functions:
getattr(), setattr(), delattr(): They only refer to object attributes and miss to mention the fallback to object.__getattr__(), etc. Because hasattr() calls getattr() to test for the presence, the __getattr__() is relevant for hasattr() as well.
len() misses to describe that it uses s.__len__().
sorted() misses to describe how rich comparison methods can be used. I think we can integrate the changes to list.sort() proposed in bpo-14050.
str() delegates the description to stdtypes.html#str, which in turn does describe obj.__str__(). Not sure we need to do something for str().
I did not check 2.7 yet.
Andy
andy-maier commentedon Jul 7, 2014
Uploaded a patch for Python 3.4, and for merging into "default".
The patch addresses items 1) to 3) from my previous post; item 4) does not need to be addressed IMHO.
Andy
andy-maier commentedon Jul 7, 2014
Uploaded v2 of the 3.4/default patch, which removes the comment line at the top of Doc/library/functions.rst (mentioned by Éric in the original message of this issue).
-> Please review the patch.
-> Please also double check whether there are any additional built-in functions in 3.x that have a need to document their underlying __special__ functions.
Andy
andy-maier commentedon Jul 7, 2014
Comments on the patch py34_v2:
On complex(): It delegates to object.__complex__(); that should also be described.
On hex(): The use of "__index__()" is text and should be changed to a hyperlink.
Andy
andy-maier commentedon Jul 7, 2014
I reviewed the description of the built-in functions in Python 2.7, and found these issues:
Andy
mdickinson commentedon Jul 7, 2014
Should the Python 2.7 delegation of
roundto__float__for its input also be described as part of this issue?BreamoreBoy commentedon Jul 7, 2014
Could bpo-15436 "__sizeof__ is not documented" also be covered by this?
vadmium commentedon Apr 12, 2015
Sizeof is not relevant to the built-in functions as far as I know. It is already described at <https://docs.python.org/dev/library/sys.html#sys.getsizeof\>.
Some more delegations that I think should be documented here (at least for Python 3):
I added some comments about the sorted() specification on Reitveld, but maybe they should be handled in a separate issue, because the delegation is less direct compared to the other functions being considered here. And any update to sorted() should probably also consider list.sort(), min(), max(), and maybe the bisect and heapq modules.
rhettinger commentedon Apr 10, 2016
Most of the proposed update look reasonable updates and would improve the documentation.
That said, please take care to not accidentally document and unintentionally guarantee implementation details rather than language requirements (leaving freedom for future changes to implementation and freedom for IronPython, PyPy, and Jython to use their best possible implementations).
Sizeof is a CPython specific implementation detail.
I also have reservations about class.__instancecheck__() and class.__subclasscheck__() which are more appropriately described in a section on abstract base classes than for the otherwise simple and clear docs for isinstance() and issubclass().
The sort() method does guarantee use of __lt__ but other tools that make comparisons make or may not follow that lead (i.e. heapq used to use __le__ and collections.abc.Set uses both __le__ and __ge__). Accordingly, there is a PEP-8 recommendation to use @functools.total_ordering rather than supplying just a single rich comparison method).
One other thought is to keep the additions as brief as possible to not distract from the main message of each section; keeping the docs primarily focused on what a function does rather than how it does it, and remembering that making the docs more lengthly impairs their utility for everyday use. Our docs are already much more chatty than equivalents in Java and Go (it used to take five minutes to read the docs for the builtin functions and now it takes an hour).
There is also a matter of keeping the docs approachable for normal people. For most folks, saying that hex(num) returns a string with the number in hexadecimal would suffice. Adding notes about the exact case of the letters, handling of negatives, use of __int__ and __index__, and comparisons with string formatting, and multiple examples beats a dead horse and makes a simple tool seem more complex.
Though I think this so go forward, I'm marking it with "low" priority because we don't have any evidence that users have found the current docs to be inadequate -- they have served well over Python's long history. Cases we've gone into details like __format__ or __next__ were there because they we essential to the tool; in contrast, it is unlikely that a user would ever need to know the sys.getsizeof() delegated its work to __sizeof__.
skirpichev commentedon Oct 1, 2025
I think this issue is completed.
Either builtins have references to related magic methods (as abs() or sorted()) or language syntax has relevant links for customization of expressions (as for the power operator, mentioned in the pow()).
In case I miss something, probably it will be better to open more targeted issues instead.