Mention use of cast in enum type stub example #1877
Merged
Conversation
This file contains 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
carljm
reviewed
Oct 29, 2024
docs/spec/enums.rst
Outdated
| CAT = ... # Member attribute | ||
| DOG = ... # Member attribute | ||
| CAT = 1 # Member attribute with known value and type | ||
| DOG = cast(str, ...) # Member attribute with unknown value and known type |
There was a problem hiding this comment.
As a reader, I think I would be confused by the use of str here, given that this appears to be a reimplementation of the above Pet enum. Why not just use int and keep things consistent?
There was a problem hiding this comment.
Changed it! I was anchored to some of the conversations we had around using _value_ as a way to spell this (which would work for homogenous types, but not heterogeneous types, as well as being harder to come up with)
hauntsaninja
commented
Oct 29, 2024
carljm
approved these changes
Oct 29, 2024
|
Looks good to me too. |
|
I think this is fine to merge without the full approval procedure because it doesn't change any normative part of the spec, it just clarifies an example. |
carljm
added a commit
to erictraut/typing
that referenced
this pull request
Jan 9, 2025
* main: (29 commits) Updated conformance test results for the latest versions of type chec… (python#1904) Add content from typeshed/CONTRIBUTING.md (python#1882) Fix markup in generics specification (python#1900) Specs clarification: Forbid `ClassVar` and `Final` within `TypedDict` body (python#1890) Remove paragraph mentioning minor edits through the mailing list (python#1891) Writing Stubs: Add "Overloads and Flags" section (python#1894) Fix a typo (python#1893) Update conformance tests for recent generics spec change (python#1892) Clarify some behavior around user-defined generic classes (python#1879) Modernizing guide: Mention TypeGuard/TypeIs (python#1887) Tools can perform "some" refactorings (python#1886) Mention use of cast in enum type stub example (python#1877) Update conformance results after new pyre release (python#1878) Add a label for typed dictionaries class-based syntax (python#1873) Add missing return type to generic_syntax_infer_variance.py (python#1871) Updated conformance results for mypy 1.13 and pyright 1.1.386 (python#1870) Modernizing guide: also mention `com2ann` (python#1869) Suggest `pyupgrade` or `ruff` for modernizing superseded typing features (python#1868) Updated conformance results for pyright 1.1.385. (python#1867) Updated conformance results for mypy 1.12. (python#1866) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In case people gloss over the text, it's good for the example to recommend the thing with the most static information