mirror of
https://github.com/python/cpython.git
synced 2026-01-06 15:32:22 +00:00
gh-133033: Add docs for TypeIgnore (#133034)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
This commit is contained in:
parent
af3f6fcb7e
commit
4e04511cb9
1 changed files with 37 additions and 0 deletions
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue