pyright/docs/comments.md
2019-04-28 12:59:19 -07:00

693 B

Comments

Some behaviors of pyright can be controlled through the use of comments within the source file.

Type Annotations

Verisons of Python prior to 3.6 did not support type annotations for variables. Pyright honors type annotations found within a comment at the end of the same line where a variable is assigned.

offsets = [] # type: List[int]

self._target = 3 # type: Union[int, str]

File-level Type Controls

Strict typing controls (where all supported type-checking switches generate errors) can be enabled for a file through the use of a special comment. Typically this comment is placed at or near the top of a code file on its own line.

# pyright: strict