FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs by AlexWaygood · Pull Request #124480 · python/cpython · GitHub

/ cpython Public

gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs - #124480

Merged
AlexWaygood merged 6 commits into
python:mainfrom
AlexWaygood:class-attrs-docs
Sep 25, 2024
ConversationCommits (6)ChecksFiles changed
Merged

gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs#124480
AlexWaygood merged 6 commits into
python:mainfrom
AlexWaygood:class-attrs-docs

Conversation

AlexWaygood commented Sep 25, 2024 •
edited
Loading

Copy link
Copy Markdown
Member
  • Convert the attribute references in the "Custom classes" section to a list table
  • Refer to the attributes as type.__*__ rather than class.__*__; this reflects the reality at runtime
  • Make sure all attribute references for custom classes are referenceable from other files
  • Add references for attributes that were not previously documented (such as __qualname__), and move some references from library/stdtypes.rst to the datamodel docs so that references for all class attributes can be found in a single location
  • Update and improve references to class attributes from other files so that they properly link to the canonical entries in the table
  • Fix 21 or so Sphinx nitpicks in the process

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

bedevere-app Bot added docs Documentation in the Doc dir skip news labels Sep 25, 2024
bedevere-app Bot mentioned this pull request Sep 25, 2024
Closed
AlexWaygood requested a review from hugovk September 25, 2024 01:27
AlexWaygood added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Sep 25, 2024
AlexWaygood marked this pull request as ready for review September 25, 2024 16:55
JelleZijlstra reviewed Sep 25, 2024
View reviewed changes
Comment thread Doc/faq/programming.rst
Comment thread Doc/whatsnew/2.2.rst Outdated
willingc approved these changes Sep 25, 2024
View reviewed changes

willingc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks good @AlexWaygood. Thanks for doing this table.

As an FYI, it's much faster to review when the nitpick fixes are a separate PR. Makes it a little easier to grok what the new addition contains. No worries for this PR.

AlexWaygood commented Sep 25, 2024

Copy link
Copy Markdown
Member Author

As an FYI, it's much faster to review when the nitpick fixes are a separate PR. Makes it a little easier to grok what the new addition contains. No worries for this PR.

Thanks -- I'll separate it out into two PRs next time!

AlexWaygood enabled auto-merge (squash) September 25, 2024 18:51
AlexWaygood merged commit 0d9d56c into python:main Sep 25, 2024
AlexWaygood deleted the class-attrs-docs branch September 25, 2024 19:29

miss-islington-app Bot commented Sep 25, 2024

Copy link
Copy Markdown

Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington-app Bot commented Sep 25, 2024

Copy link
Copy Markdown

Sorry, @AlexWaygood, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 0d9d56c4e4246495f506f7fb319548fb105b535b 3.13

miss-islington-app Bot commented Sep 25, 2024

Copy link
Copy Markdown

Sorry, @AlexWaygood, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 0d9d56c4e4246495f506f7fb319548fb105b535b 3.12

AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Sep 25, 2024
[3.13] pythongh-101100: Add a table of class attributes to the "Custo…
8c7f3e4 
…m classes" section of the data model docs (python#124480)

bedevere-app Bot commented Sep 25, 2024

Copy link
Copy Markdown

GH-124556 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Sep 25, 2024
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Sep 25, 2024
[3.12] pythongh-101100: Add a table of class attributes to the "Custo…
51d1120 
…m classes" section of the data model docs (python#124480)

bedevere-app Bot commented Sep 25, 2024

Copy link
Copy Markdown

GH-124558 is a backport of this pull request to the 3.12 branch.

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Sep 25, 2024
AlexWaygood added a commit that referenced this pull request Sep 25, 2024
[3.12] gh-101100: Add a table of class attributes to the "Custom clas…
d2068c6 
…ses" section of the data model docs (#124480) (#124558)
emilyemorehouse added a commit to lysnikolaou/cpython that referenced this pull request Sep 26, 2024
Merge branch 'main' into fix-help-double-prompt
4cdb3ae 
* main: (69 commits)
  Add "annotate" SET_FUNCTION_ATTRIBUTE bit to dis. (python#124566)
  pythongh-124412: Add helpers for converting annotations to source format (python#124551)
  pythongh-119180: Disallow instantiation of ConstEvaluator objects (python#124561)
  For-else deserves its own section in the tutorial (python#123946)
  Add 3.13 as a version option to the crash issue template (python#124560)
  pythongh-123242: Note that type.__annotations__ may not exist (python#124557)
  pythongh-119180: Make FORWARDREF format look at __annotations__ first (python#124479)
  pythonGH-58058: Add quick reference for `ArgumentParser` to argparse docs (pythongh-124227)
  pythongh-41431: Add `datetime.time.strptime()` and `datetime.date.strptime()` (python#120752)
  pythongh-102450: Add ISO-8601 alternative for midnight to `fromisoformat()` calls. (python#105856)
  pythongh-124370: Add "howto" for free-threaded Python (python#124371)
  pythongh-121277: Allow `.. versionadded:: next` in docs (pythonGH-121278)
  pythongh-119400:  make_ssl_certs: update reference test data automatically, pass in expiration dates as parameters python#119400  (pythonGH-119401)
  pythongh-119180: Avoid going through AST and eval() when possible in annotationlib (python#124337)
  pythongh-124448: Update Windows builds to use Tcl/Tk 8.6.15 (pythonGH-124449)
  pythongh-123884 Tee of tee was not producing n independent iterators (pythongh-124490)
  pythongh-124378: Update test_ttk for Tcl/Tk 8.6.15 (pythonGH-124542)
  pythongh-124513: Check args in framelocalsproxy_new() (python#124515)
  pythongh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (python#124480)
  Doc: Use ``major.minor`` for documentation distribution archive filenames (python#124489)
  ...
Yhg1s pushed a commit that referenced this pull request Sep 26, 2024
[3.13] gh-101100: Add a table of class attributes to the "Custom clas…
9f2e6ca 
…ses" section of the data model docs (#124480) (#124556)
JelleZijlstra reviewed Sep 26, 2024
View reviewed changes
Comment thread Doc/reference/datamodel.rst
.. doctest::

>>> int.__subclasses__()
[<class 'bool'>, <enum 'IntEnum'>, <flag 'IntFlag'>, <class 're._constants._NamedIntConstant'>, <class 're._ZeroSentinel'>]

JelleZijlstra Sep 26, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

This failed spuriously on https://github.com/python/cpython/actions/runs/11043320393/job/30677452220?pr=124569. I suspect it depends on whether GC has run and collected the MyIntEnum class. Example:

>>> print(int.__subclasses__())
[<class 'bool'>, <enum 'IntEnum'>, <flag 'IntFlag'>, <class 're._constants._NamedIntConstant'>, <class 're._ZeroSentinel'>]
>>> import enum
>>> def f():
...     class MyIntEnum(int, enum.Enum): pass
...     
>>> f()
>>> print(int.__subclasses__())
[<class 'bool'>, <enum 'IntEnum'>, <flag 'IntFlag'>, <class 're._constants._NamedIntConstant'>, <class 're._ZeroSentinel'>, <enum 'MyIntEnum'>]
>>> import gc
>>> gc.collect()
31
>>> print(int.__subclasses__())
[<class 'bool'>, <enum 'IntEnum'>, <flag 'IntFlag'>, <class 're._constants._NamedIntConstant'>, <class 're._ZeroSentinel'>]
>>>

I'll send a PR to change this.

AlexWaygood Sep 26, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Oh, interesting! Thanks!

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

JelleZijlstra JelleZijlstra approved these changes
willingc willingc approved these changes
hugovk Awaiting requested review from hugovk
ethanfurman Awaiting requested review from ethanfurman ethanfurman is a code owner
rhettinger Awaiting requested review from rhettinger rhettinger is a code owner
vsajip Awaiting requested review from vsajip vsajip is a code owner

Assignees

AlexWaygood

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL