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

Added draft chapter to typing spec for enumerations. #1591

Closed
wants to merge 27 commits into from

Conversation

erictraut
Copy link
Collaborator

No description provided.

docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
Copy link
Member

@ethanfurman ethanfurman left a comment

Choose a reason for hiding this comment

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

Added some corrections and suggestions.

docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
consistency. That is, if the type is assigned to a variable, the name of
the variable must match the name of the enum class::

WrongName = Enum('Color', 'RED GREEN BLUE') # Type checker error
Copy link
Member

Choose a reason for hiding this comment

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

Not sure this should be an error, commented on Discuss

docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Show resolved Hide resolved
@erictraut
Copy link
Collaborator Author

@JelleZijlstra, did mypy 1.9 fix the issue in stubtest that was blocking us from making the necessary changes in typeshed for enums? If not, is that something that could be prioritized for mypy 1.10?

…'t apply to enum classes that derive from `enum.Flags` because these classes support enum members with values of zero and all combinations of the defined flags.
Copy link

@Hnasar Hnasar left a comment

Choose a reason for hiding this comment

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

Very well written, thank you!

docs/spec/enums.rst Outdated Show resolved Hide resolved
erictraut and others added 2 commits April 1, 2024 07:06
Co-authored-by: Hashem <Hnasar@users.noreply.github.com>
…ther an attribute is an enum member. Attributes with private (mangled) names are exempt.
Copy link
Contributor

@stroxler stroxler left a comment

Choose a reason for hiding this comment

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

Thanks for writing this, I've never actually known enum behavior as well as I should and learned quite a few things from reading.

docs/spec/enums.rst Outdated Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
Copy link

cpython-cla-bot bot commented May 23, 2024

The following commit authors need to sign the Contributor License Agreement:

  • 66853113+pre-commit-ci[bot]@users.noreply.github.com

Click the button to sign:
CLA not signed

reveal_type(Color["RED"]) # Revealed type is 'Literal[Color.RED]' (or 'Color')
reveal_type(Color(3)) # Revealed type is 'Literal[Color.BLUE]' (or 'Color')

Unlike most Python classes, Calling an enum class does not invoke its constructor.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Unlike most Python classes, Calling an enum class does not invoke its constructor.
Unlike most Python classes, calling an enum class does not invoke its constructor.

Copy link
Member

@carljm carljm left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks for writing this.

docs/spec/enums.rst Show resolved Hide resolved
docs/spec/enums.rst Show resolved Hide resolved
docs/spec/enums.rst Outdated Show resolved Hide resolved
@erictraut erictraut marked this pull request as ready for review June 3, 2024 05:46
erictraut added a commit to erictraut/typing that referenced this pull request Jun 3, 2024
This is the same set of changes as PR python#1591. The CI script that enforces CLA signing was confused, so it didn't permit merging the original PR.
@erictraut
Copy link
Collaborator Author

I'm not sure how to fix the CLA Signing issue with this PR, so I'm going to close it and submit a fresh PR. See #1759.

@erictraut erictraut closed this Jun 3, 2024
erictraut added a commit that referenced this pull request Jun 3, 2024
This is the same set of changes as PR #1591. The CI script that enforces CLA signing was confused, so it didn't permit merging the original PR.
@erictraut erictraut deleted the enum_spec branch June 3, 2024 05:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.