Builtin __bool__ docstrings are wrong

[JelleZijlstra]

BPO	46732
Nosy	@terryjreedy, @JelleZijlstra, @miss-islington
PRs	bpo-46732: fix __bool__ docstring #31301 [3.10] bpo-46732: fix __bool__ docstring (GH-31301) #31473 [3.9] bpo-46732: fix __bool__ docstring (GH-31301) #31474

^{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 = 'https://github.com/JelleZijlstra'
closed_at = <Date 2022-02-21.17:19:35.177>
created_at = <Date 2022-02-12.19:10:01.907>
labels = ['interpreter-core', 'type-bug', '3.11']
title = 'Builtin __bool__ docstrings are wrong'
updated_at = <Date 2022-02-21.17:19:35.177>
user = 'https://github.com/JelleZijlstra'

bugs.python.org fields:

activity = <Date 2022-02-21.17:19:35.177>
actor = 'JelleZijlstra'
assignee = 'JelleZijlstra'
closed = True
closed_date = <Date 2022-02-21.17:19:35.177>
closer = 'JelleZijlstra'
components = ['Interpreter Core']
creation = <Date 2022-02-12.19:10:01.907>
creator = 'JelleZijlstra'
dependencies = []
files = []
hgrepos = []
issue_num = 46732
keywords = ['patch']
message_count = 5.0
messages = ['413141', '413505', '413628', '413660', '413661']
nosy_count = 3.0
nosy_names = ['terry.reedy', 'JelleZijlstra', 'miss-islington']
pr_nums = ['31301', '31473', '31474']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue46732'
versions = ['Python 3.11']

[JelleZijlstra]

>>> None.__bool__.__doc__
'self != 0'

This isn't true, since None does not equal 0. I suggest rewording it to "True if self else False".

[terryjreedy]

There is no object.__bool__. None.__bool__.__doc__ appears to be an accidental copy of bool/int/float/complex.__bool__.__doc__. It should just be 'False'.

[terryjreedy]

For whatever reason, all builtins with a __bool__ method appear to share the same docstring. For example,

>>> range.__bool__.__doc__
'self != 0'
>>> bool(range(0))
False
>>> bool(range(1))
True

The concrete collection classes have their lengths stored internally so bool use that via len(self). But len(range) != 0 iff stop != start.

[miss-islington]

New changeset c596ecb by Miss Islington (bot) in branch '3.10':
[3.10] bpo-46732: fix __bool__ docstring (GH-31301) (GH-31473)
c596ecb

[miss-islington]

New changeset 8eb18d8 by Miss Islington (bot) in branch '3.9':
[3.9] bpo-46732: fix __bool__ docstring (GH-31301) (GH-31474)
8eb18d8