Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
gh-133033: Add document forTypeIgnore
#133034
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
12 commits Select commitHold shift + click to select a range
d208c58
gh-133033: Add document for `TypeIgnore`
koyuki7w7a835bc
fixup
koyuki7wfc06a53
Update Doc/library/ast.rst
koyuki7wbce8ace
Update Doc/library/ast.rst
koyuki7w3731757
Update Doc/library/ast.rst
koyuki7w4902adc
Update `Doc/library/ast.rst`
koyuki7w4755dc2
Updated `Doc/library/ast.rst`
koyuki7wc897b51
Update Doc/library/ast.rst
koyuki7w6cd63c9
Updated `Doc/library/ast.rst`
koyuki7w83cf038
Updated `Doc/library/ast.rst`
koyuki7wc67ea98
Add an example with non-empty tag
koyuki7w98e601c
Add note about `type_comments` parameter
koyuki7wFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
37 changes: 37 additions & 0 deletionsDoc/library/ast.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1761,6 +1761,43 @@ Pattern matching | ||
.. versionadded:: 3.10 | ||
Type annotations | ||
^^^^^^^^^^^^^^^^ | ||
.. class:: TypeIgnore(lineno, tag) | ||
A ``# type: ignore`` comment located at *lineno*. | ||
*tag* is the optional tag specified by the form ``# type: ignore <tag>``. | ||
.. doctest:: | ||
>>> print(ast.dump(ast.parse('x = 1 # type: ignore', type_comments=True), indent=4)) | ||
koyuki7w marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
Module( | ||
body=[ | ||
Assign( | ||
targets=[ | ||
Name(id='x', ctx=Store())], | ||
value=Constant(value=1))], | ||
type_ignores=[ | ||
TypeIgnore(lineno=1, tag='')]) | ||
koyuki7w marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
>>> print(ast.dump(ast.parse('x: bool = 1 # type: ignore[assignment]', type_comments=True), indent=4)) | ||
Module( | ||
body=[ | ||
AnnAssign( | ||
target=Name(id='x', ctx=Store()), | ||
annotation=Name(id='bool', ctx=Load()), | ||
value=Constant(value=1), | ||
simple=1)], | ||
type_ignores=[ | ||
TypeIgnore(lineno=1, tag='[assignment]')]) | ||
.. note:: | ||
:class:`!TypeIgnore` nodes are not generated when the *type_comments* parameter | ||
is set to ``False`` (default). See :func:`ast.parse` for more details. | ||
.. versionadded:: 3.8 | ||
.. _ast-type-params: | ||
Type parameters | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.