GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-104874: Document NewType.__supertype__ by JelleZijlstra · Pull Request #104875 · python/cpython

Conversation

@JelleZijlstra

@JelleZijlstra JelleZijlstra commented May 24, 2023 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Fixes #104874

  • Issue: Document NewType.__supertype__ #104874

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@JelleZijlstra
Document NewType.__supertype__
6dc254f
@JelleZijlstra JelleZijlstra added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels May 24, 2023
@bedevere-bot bedevere-bot mentioned this pull request May 24, 2023
Document NewType.__supertype__ #104874
Closed
@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label May 24, 2023
@JelleZijlstra
JelleZijlstra marked this pull request as ready for review May 24, 2023 16:56
@JelleZijlstra
JelleZijlstra requested review from AlexWaygood, Fidget-Spinner and gvanrossum as code owners May 24, 2023 16:56
@bedevere-bot bedevere-bot added the awaiting core review label May 24, 2023
AlexWaygood
AlexWaygood reviewed May 24, 2023
View reviewed changes

@AlexWaygood AlexWaygood left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Looks good. We also test for __qualname__ and __module__; should we document those as well?

cpython/Lib/test/test_typing.py

Lines 6658 to 6669 in c90a862

def test_special_attrs(self):
self.assertEqual(UserId.__name__, 'UserId')
self.assertEqual(UserId.__qualname__, 'UserId')
self.assertEqual(UserId.__module__, __name__)
self.assertEqual(UserId.__supertype__, int)
UserName = self.UserName
self.assertEqual(UserName.__name__, 'UserName')
self.assertEqual(UserName.__qualname__,
self.__class__.__qualname__ + '.UserName')
self.assertEqual(UserName.__module__, __name__)
self.assertEqual(UserName.__supertype__, str)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@JelleZijlstra

JelleZijlstra commented May 24, 2023

Copy link
Copy Markdown
Member Author

__qualname__ is actually wrong as implemented (it's always the same as __name__) and __module__ is mostly an implementation detail for pickling, so I'd prefer to leave those undocumented.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@AlexWaygood

AlexWaygood commented May 24, 2023

Copy link
Copy Markdown
Member

__module__ is mostly an implementation detail for pickling

I feel like it could be useful to be able to know the module the newtype was defined in, and it seems useful to mention the ways in which instances of NewType are similar to classes, even though they're not classes.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@JelleZijlstra
Add __module__
6744bff
JelleZijlstra
JelleZijlstra commented May 24, 2023
View reviewed changes
Comment thread Doc/library/typing.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@JelleZijlstra
Update Doc/library/typing.rst
2535374
JelleZijlstra
JelleZijlstra commented May 24, 2023
View reviewed changes
Comment thread Doc/library/typing.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@JelleZijlstra
Update Doc/library/typing.rst
0308cdc
@JelleZijlstra
JelleZijlstra requested a review from AlexWaygood May 24, 2023 20:21
@AlexWaygood
AlexWaygood merged commit 41768a2 into python:main May 24, 2023
@bedevere-bot bedevere-bot removed the awaiting core review label May 24, 2023
@miss-islington

miss-islington commented May 24, 2023

Copy link
Copy Markdown
Contributor

Thanks @JelleZijlstra for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 24, 2023
@JelleZijlstra @miss-islington
pythongh-104874: Document NewType.__supertype__ (pythonGH-104875)
b29fc4b 
(cherry picked from commit 41768a2)

Co-authored-by: Jelle Zijlstra <[email protected]>
@bedevere-bot

bedevere-bot commented May 24, 2023

Copy link
Copy Markdown

GH-104906 is a backport of this pull request to the 3.12 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label May 24, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 24, 2023
@JelleZijlstra @miss-islington
pythongh-104874: Document NewType.__supertype__ (pythonGH-104875)
fa00882 
(cherry picked from commit 41768a2)

Co-authored-by: Jelle Zijlstra <[email protected]>
@bedevere-bot

bedevere-bot commented May 24, 2023

Copy link
Copy Markdown

GH-104907 is a backport of this pull request to the 3.11 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label May 24, 2023
AlexWaygood pushed a commit that referenced this pull request May 24, 2023
@miss-islington @JelleZijlstra
[3.12] gh-104874: Document NewType.__supertype__ (GH-104875) (#104906)
a064233 
gh-104874: Document NewType.__supertype__ (GH-104875)
(cherry picked from commit 41768a2)

Co-authored-by: Jelle Zijlstra <[email protected]>
AlexWaygood pushed a commit that referenced this pull request May 24, 2023
@miss-islington @JelleZijlstra
[3.11] gh-104874: Document NewType.__supertype__ (GH-104875) (#104907)
3b3f2e1 
gh-104874: Document NewType.__supertype__ (GH-104875)
(cherry picked from commit 41768a2)

Co-authored-by: Jelle Zijlstra <[email protected]>
@erlend-aasland erlend-aasland mentioned this pull request Jun 6, 2023
3.12 backport gh 105236 #105358
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gvanrossum gvanrossum Awaiting requested review from gvanrossum
@Fidget-Spinner Fidget-Spinner Awaiting requested review from Fidget-Spinner
@AlexWaygood AlexWaygood Awaiting requested review from AlexWaygood AlexWaygood is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document NewType.__supertype__

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@JelleZijlstra @AlexWaygood @miss-islington @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.