microsoft/pyright
1
1
Fork 0
mirror of https://github.com/microsoft/pyright.git synced 2024-08-16 19:30:26 +03:00
Code Issues Projects Releases Wiki Activity

Updated typed library documentation to explicitly mention import statements of the form “from . import A” and “from .A import X”.

Browse Source
This commit is contained in:
Eric Traut 2021-02-23 01:02:15 -07:00
parent bf259f3385
commit b5017de462
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/typed-libraries.md
View File

@ -32,7 +32,7 @@ If a “py.typed” module is present, a type checker will treat all modules wit
Each module exposes a set of symbols. Some of these symbols are considered “private” — implementation details that are not part of the library’s interface. Type checkers like pyright use the following rules to determine which symbols are visible outside of the package.
* Symbols whose names begin with an underscore (but are not dunder names) are considered private.
* Imported symbols are considered private by default. If they use the “import A as A” (a redundant module alias), “from A import X as X” (a redundant symbol alias) or “from A import *” forms, they are not private (unless their names begin with an underscore).
* Imported symbols are considered private by default. If they use the “import A as A” (a redundant module alias), “from X import A as A” (a redundant symbol alias), “from . import A”, or “from .A import X” forms, symbol “A” is not private unless the name begins with an underscore. Likewise, if a wildcard import (of the form “from X import *”) is used, all symbols referenced by the wildcard are not private.
* A module can expose an `__all__` symbol at the module level that provides a list of names that are considered part of the interface. This overrides all other rules above, allowing imported symbols or symbols whose names begin with an underscore to be included in the interface.
* Local variables within a function (including nested functions) are always considered private.