X Tutup
Skip to content

gh-118465: Add __firstlineno__ attribute to class#118475

Merged
serhiy-storchaka merged 7 commits intopython:mainfrom
serhiy-storchaka:class-firstlineno
May 6, 2024
Merged

gh-118465: Add __firstlineno__ attribute to class#118475
serhiy-storchaka merged 7 commits intopython:mainfrom
serhiy-storchaka:class-firstlineno

Conversation

@serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented May 1, 2024 •
edited by github-actions bot
Loading

It is set by compiler with the line number of the first line of the class definition.

📚 Documentation preview 📚: https://cpython-previews--118475.org.readthedocs.build/

@serhiy-storchaka
pythongh-118465: Add __firstlineno__ attribute to class
2d78936 
It is set by compiler with the line number of the first line of
the class definition.
@bedevere-app bedevere-app bot mentioned this pull request May 1, 2024
Closed
markshannon
markshannon reviewed May 1, 2024
View reviewed changes
iritkatriel
iritkatriel reviewed May 1, 2024
View reviewed changes
Doc/whatsnew/3.13.rst

* Classes have a new :attr:`!__firstlineno__` attribute,
populated by the compiler, with the line number of the first line
of the class definition.
Copy link
Member

@iritkatriel iritkatriel May 1, 2024

Choose a reason for hiding this comment

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

If the class has decorators then I think this is the first line of the first decorator. Need a test for this case, and probably to mention in the doc.

Copy link
Member Author

@serhiy-storchaka serhiy-storchaka May 2, 2024

Choose a reason for hiding this comment

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

There are existing tests, and they are passed.

I'll add explicit mentioning of this fact, but AFAIK it was not specified for co_firstlineno etc.

@serhiy-storchaka @markshannon
Update Doc/reference/datamodel.rst
2ac81ad 
Co-authored-by: Mark Shannon <mark@hotpy.org>
serhiy-storchaka
serhiy-storchaka commented May 2, 2024
View reviewed changes
Doc/whatsnew/3.13.rst

* Classes have a new :attr:`!__firstlineno__` attribute,
populated by the compiler, with the line number of the first line
of the class definition.
Copy link
Member Author

@serhiy-storchaka serhiy-storchaka May 2, 2024

Choose a reason for hiding this comment

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

There are existing tests, and they are passed.

I'll add explicit mentioning of this fact, but AFAIK it was not specified for co_firstlineno etc.

@JelleZijlstra
Copy link
Member

JelleZijlstra commented May 4, 2024

It is possible to construct classes without __firstlineno__:

def f():
    __firstlineno__ = 1
    class X:
        nonlocal __firstlineno__
    return X
print(f().__firstlineno__)  # AttributeError

Or:

class Y:
    global __firstlineno__
print(Y.__firstlineno__)  # AttributeError

This is obviously an extreme edge case though. You could also do this by manipulating locals() in the class body or the metaclass.

Is it worth it to make inspect smarter in the presence of classes without __firstlineno__?

  File "/Users/jelle/py/cpython/insp.py", line 18, in <module>
    print(inspect.findsource(X))
          ~~~~~~~~~~~~~~~~~~^^^
  File "/Users/jelle/py/cpython/Lib/inspect.py", line 1070, in findsource
    return lines, object.__firstlineno__ - 1
                  ^^^^^^^^^^^^^^^^^^^^^^
AttributeError: type object 'X' has no attribute '__firstlineno__'

@serhiy-storchaka
Copy link
Member Author

serhiy-storchaka commented May 5, 2024

Good point. I thought that it is the same as for __module__ and __qualname__, but it turned out that they are set implicitly in the type constructor even when not specified in the class dict. They are set even for type('A', (), {}).

We can try to set __firstlineno__ to the current line number in the top Python frame, but it is safer to not set it at all. Setting __firstlineno__ for classes created by the type() call rather than in the class statement does not help in the only use case for this attribute.

I think that for backward compatibility getsource() should convert an AttributeError into OSError which was raised before for classes created by the type() call.

@serhiy-storchaka serhiy-storchaka merged commit 153b3f7 into python:main May 6, 2024
@serhiy-storchaka serhiy-storchaka deleted the class-firstlineno branch May 6, 2024 09:02
SonicField pushed a commit to SonicField/cpython that referenced this pull request May 8, 2024
@serhiy-storchaka @SonicField
pythongh-118465: Add __firstlineno__ attribute to class (pythonGH-118475
7670241 
)

It is set by compiler with the line number of the first line of
the class definition.
@frenzymadness frenzymadness mentioned this pull request May 13, 2024
Closed
@devdanzin devdanzin mentioned this pull request Aug 14, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iritkatriel iritkatriel iritkatriel left review comments

@markshannon markshannon markshannon left review comments

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

@ethanfurman ethanfurman Awaiting requested review from ethanfurman ethanfurman is a code owner

@AlexWaygood AlexWaygood Awaiting requested review from AlexWaygood AlexWaygood is a code owner

@brettcannon brettcannon Awaiting requested review from brettcannon brettcannon is a code owner

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

@ncoghlan ncoghlan Awaiting requested review from ncoghlan ncoghlan is a code owner

@warsaw warsaw Awaiting requested review from warsaw warsaw is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@serhiy-storchaka @JelleZijlstra @iritkatriel @markshannon
X Tutup