Clarify "Using types...but not at runtime" docs #15029
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
The section "Using classes that are generic in stubs but not at runtime" on the runtime_troubles.html page is very helpful, but naive readers who follow its instructions will almost inevitably create a runtime `NameError`. This PR updates the example to include an `annotations` import that will avert such a `NameError`.
docs/source/runtime_troubles.rst
Outdated
Comment on lines
287
to
292
| Note that the ``from __future__ import annotations`` is required to avoid | ||
| a ``NameError`` at the use site of the excluded import. In the example above, | ||
| ``def f(x: SupportsRichComparison)`` would raise ``NameError`` if | ||
| ``from __future__ import annotations`` is not included. For more information, | ||
| and additional caveats, see the section on | ||
| :ref:`future annotations <future-annotations>`. |
There was a problem hiding this comment.
Suggested change
| Note that the ``from __future__ import annotations`` is required to avoid | |
| a ``NameError`` at the use site of the excluded import. In the example above, | |
| ``def f(x: SupportsRichComparison)`` would raise ``NameError`` if | |
| ``from __future__ import annotations`` is not included. For more information, | |
| and additional caveats, see the section on | |
| :ref:`future annotations <future-annotations>`. | |
| The ``from __future__ import annotations`` is required to avoid | |
| a ``NameError`` when using the imported symbol. | |
| For more information and caveats, see the section on | |
| :ref:`future annotations <future-annotations>`. |
hauntsaninja
approved these changes
Apr 11, 2023
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.
The section "Using classes that are generic in stubs but not at runtime" on the runtime_troubles.html page is very helpful, but naive readers who follow its instructions will almost inevitably create a runtime
NameError. This PR updates the example to include anannotationsimport that will avert such aNameError.