Skip to content

gh-133033: Add document for TypeIgnore #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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Apr 28, 2025
Merged

gh-133033: Add document for TypeIgnore #133034

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d208c58
gh-133033: Add document for `TypeIgnore`
Apr 27, 2025
7a835bc
fixup
Apr 27, 2025
fc06a53
Update Doc/library/ast.rst
Apr 28, 2025
bce8ace
Update Doc/library/ast.rst
Apr 28, 2025
3731757
Update Doc/library/ast.rst
Apr 28, 2025
4902adc
Update `Doc/library/ast.rst`
Apr 28, 2025
4755dc2
Updated `Doc/library/ast.rst`
Apr 28, 2025
c897b51
Update Doc/library/ast.rst
Apr 28, 2025
6cd63c9
Updated `Doc/library/ast.rst`
Apr 28, 2025
83cf038
Updated `Doc/library/ast.rst`
Apr 28, 2025
c67ea98
Add an example with non-empty tag
Apr 28, 2025
98e601c
Add note about `type_comments` parameter
Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions Doc/library/ast.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Module(
body=[
Assign(
targets=[
Name(id='x', ctx=Store())],
value=Constant(value=1))],
type_ignores=[
TypeIgnore(lineno=1, tag='')])
>>> 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
Expand Down
Loading