Skip to content
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.

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

__self__ on built-in functions is not as documented #58211

Open
SpecLad mannequin opened this issue Feb 13, 2012 · 6 comments
Open

__self__ on built-in functions is not as documented #58211

SpecLad mannequin opened this issue Feb 13, 2012 · 6 comments
Labels
3.8 only security fixes 3.9 only security fixes 3.10 only security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@b7b6ade5-7451-4d6f-b8d7-b2161f50e41f
Copy link
Mannequin

SpecLad mannequin commented Feb 13, 2012

BPO 14003
Nosy @terryjreedy, @ezio-melotti, @merwok, @bitdancer, @voidspace, @anacrolix, @SpecLad, @eryksun, @vaultah, @DimitrisJim

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 2012-02-13.19:05:34.037>
labels = ['type-bug', '3.8', '3.9', '3.10', 'docs']
title = '__self__ on built-in functions is not as documented'
updated_at = <Date 2020-11-07.19:53:05.266>
user = 'https://github.com/SpecLad'

bugs.python.org fields:

activity = <Date 2020-11-07.19:53:05.266>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2012-02-13.19:05:34.037>
creator = 'SpecLad'
dependencies = []
files = []
hgrepos = []
issue_num = 14003
keywords = []
message_count = 6.0
messages = ['153287', '153288', '153298', '153610', '153620', '244963']
nosy_count = 12.0
nosy_names = ['terry.reedy', 'ezio.melotti', 'eric.araujo', 'Arfrever', 'r.david.murray', 'michael.foord', 'anacrolix', 'docs@python', 'SpecLad', 'eryksun', 'vaultah', 'Jim Fasarakis-Hilliard']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue14003'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

@b7b6ade5-7451-4d6f-b8d7-b2161f50e41f
Copy link
Mannequin Author

SpecLad mannequin commented Feb 13, 2012

The language reference says this in section 3.2:

~
Built-in functions

A built-in function object is a wrapper around a C function. Examples of built-in functions are len() and math.sin() <...> Special read-only attributes: <...> __self__ is set to None (but see the next item) <...>.
~

That is not the case:

ActivePython 3.2.2.3 (ActiveState Software Inc.) based on
Python 3.2.2 (default, Sep  8 2011, 10:55:13) [MSC v.1500 64 bit (AMD64)]  
on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> len.__self__
<module 'builtins' (built-in)>
>>> open.__self__
<module 'io' (built-in)>
>>> import math
>>> math.sin.__self__
<module 'math' (built-in)>

@b7b6ade5-7451-4d6f-b8d7-b2161f50e41f SpecLad mannequin assigned docspython Feb 13, 2012
@b7b6ade5-7451-4d6f-b8d7-b2161f50e41f SpecLad mannequin added docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error labels Feb 13, 2012
@bitdancer
Copy link
Member

It looks like this changed between 2.x and 3.x but the docs were not updated. None makes more sense than the module as __self__, though, so perhaps it is actually a bug. Then, again, since Python functions don't have a __self__, the __self__ of built-in functions seems like an anomaly to begin with...

@voidspace
Copy link
Contributor

It's nicer for introspection if __self__ is None on builtin functions. But fixing the docs is easier (and more backwards compatible).

@terryjreedy
Copy link
Member

Python-coded functions do not have .__self__.
>>> def f(): pass

>>> f.__self__
...
AttributeError: 'function' object has no attribute '__self__'

Unbound builtin methods, which are simply builtins functions attached to a class, do not have .__self__
>>> list.__len__.__self__
...
AttributeError: 'wrapper_descriptor' object has no attribute '__self__'

So it makes no sense to me that builtin non-method functions should have this attribute.

"Built-in methods
This is really a different disguise of a built-in function, this time containing an object passed to the C function as an implicit extra argument. An example of a built-in method is alist.append(), assuming alist is a list object. In this case, the special read-only attribute __self__ is set to the object denoted by alist."

should have 'method' replaced with 'instance method' as it is only talking about instance methods, as the term is used in the rest of the section. Or this section should be deleted as it duplicates the previous Instance Method section. Or it should be revised to actually discuss unbound builtin methods.

@merwok
Copy link
Member

merwok commented Feb 18, 2012

I think that functions in C modules are implemented as methods of module objects, which would explain why len.__self__ is builtins.

@eryksun
Copy link
Contributor

eryksun commented Jun 7, 2015

In Python 2 Py_InitModule4 optionally allows setting __self__ on module functions, but no module in the standard library actually uses this. It's always None. This is no longer optional with Python 3's PyModule_Create. Built-in module functions instantiated the normal way can be considered as methods of the module in which they're defined. However, some modules may specially instantiate functions for which __self__ is None, such as codecs.strict_errors.

    >>> codecs.strict_errors.__self__ is None
    True

@iritkatriel iritkatriel added 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes labels Nov 7, 2020
@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.8 only security fixes 3.9 only security fixes 3.10 only security fixes docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

No branches or pull requests

6 participants