From: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Date: Mon, 28 Apr 2025 10:49:07 +0000 (+0900)
Subject: gh-133033: Add docs for `TypeIgnore` (#133034)
X-Git-Tag: v3.14.0b1~243
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4e04511cb9c176c32d6f3694f426750d710121cd;p=thirdparty%2FPython%2Fcpython.git

gh-133033: Add docs for `TypeIgnore` (#133034)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
---

diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst
index 1a04d42e5f5d..776c63d1f0fd 100644
--- a/Doc/library/ast.rst
+++ b/Doc/library/ast.rst
@@ -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