Class Documentation Issue

[Fosters4him]

Documentation

In the tutorial "MyClass" class discussion, MyClass is defined as follows.

class MyClass:
    """A simple example class"""
    i = 12345

    def f(self):
        return 'hello world'

In the method object section, x.f() is said to be normally called after it is bound, however this statement ends in error, "Missing 1 required positional argument 'self'

Then it states the following script will repeat forever, however it gets the same error Missing 1 required positional argument 'self'

xf = x.f
while True:
    print(xf())

To fix the issue remove the "self" from method f() as below and everything works as intended.

    def f():
        return 'hello world'

Linked PRs

• gh-138011: Clarify tutorial method object example code #138014
• gh-138011: add note about instantiating MyClass with ( ) #138016
• [3.14] gh-138011: Clarify tutorial method object example code (GH-138014) #138025
• [3.13] gh-138011: Clarify tutorial method object example code (GH-138014) #138026

[StanFromIreland]

@terryjreedy I assume this is also in the tutorial, but I am away and can not easily find it.

[pochmann3]

@StanFromIreland Isn't it the OP who should provide the link anyway?

[terryjreedy]

Yes, doc issues should link to the doc section(s) they discuss. I edited the issue text to add them and make the issue clearer.

In order for x.f() to execute, x must be defined. The proper definition x = MyClass(), making x an instance is given in the previous section. The OP used x = MyClass, omitting the (), making x the class itself. This bug generates the error message given. The point of the discussion is that bound method objects include the first argument, so it need not be given. Omitting self in the function definition would be wrong.

Not closing because I think the example assignment for x.f() should be repeated. Will prepare PR.
Edit: Done.