mirror of
https://github.com/microsoft/pyright.git
synced 2024-07-07 04:26:31 +03:00
More tweaks to documentation and README files. Added a navbar to docs site.
This commit is contained in:
Eric Traut
parent
65874c5254
commit
2c4a9da2ae
|
|
@ -2,7 +2,9 @@
|
|||
|
||||
# Static Type Checker for Python
|
||||
|
||||
Pyright is a full-featured, standards-based static type checker for Python. It is designed for high performance and can be used with large Python source bases. Pyright includes both a [command-line tool](/docs/command-line.md) and an [extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright).
|
||||
Pyright is a full-featured, standards-based static type checker for Python. It is designed for high performance and can be used with large Python source bases.
|
||||
|
||||
Pyright includes both a [command-line tool](/docs/command-line.md) and an [extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright).
|
||||
|
||||
|
||||
## Documentation
|
||||
|
|
|
|||
|
|
@ -2,6 +2,8 @@
|
|||
|
||||
# Static type checker for Python
|
||||
|
||||
Pyright is a full-featured, standards-based static type checker for Python. It is designed for high performance and can be used with large Python source bases. Pyright includes both a [command-line tool](command-line.md) and an [extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright).
|
||||
Pyright is a full-featured, standards-based static type checker for Python. It is designed for high performance and can be used with large Python source bases.
|
||||
|
||||
Pyright includes both a [command-line tool](command-line.md) and an [extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright).
|
||||
|
||||
|
||||
|
|
|
|||
1
docs/_navbar.md
Normal file
1
docs/_navbar.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
[Github Site](https://github.com/Microsoft/pyright)
|
||||
|
|
@ -19,9 +19,10 @@
|
|||
<script>
|
||||
window.$docsify = {
|
||||
name: 'Pyright',
|
||||
nameLink: 'https://github.com/Microsoft/pyright',
|
||||
nameLink: '/',
|
||||
search: 'auto',
|
||||
loadSidebar: true,
|
||||
loadNavbar: true,
|
||||
auto2top: true,
|
||||
|
||||
search: {
|
||||
|
|
|
|||
|
|
@ -1,63 +1,10 @@
|
|||
# Static type checker for Python
|
||||
|
||||
### Speed
|
||||
# Static Type Checker for Python
|
||||
|
||||
Pyright is a full-featured, standards-based static type checker for Python. It is designed for high performance and can be used with large Python source bases.
|
||||
|
||||
### Configurability
|
||||
Pyright includes both a [command-line tool](/docs/command-line.md) and an [extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-pyright.pyright).
|
||||
|
||||
Pyright supports [configuration files](/docs/configuration.md) that provide granular control over settings. Different "execution environments" can be associated with subdirectories within a source base. Each environment can specify different module search paths, python language versions, and platform targets.
|
||||
|
||||
### Type Checking Features
|
||||
## Documentation
|
||||
|
||||
* [PEP 484](https://www.python.org/dev/peps/pep-0484/) type hints including generics
|
||||
* [PEP 487](https://www.python.org/dev/peps/pep-0487/) simpler customization of class creation
|
||||
* [PEP 526](https://www.python.org/dev/peps/pep-0526/) syntax for variable annotations
|
||||
* [PEP 544](https://www.python.org/dev/peps/pep-0544/) structural subtyping
|
||||
* [PEP 561](https://www.python.org/dev/peps/pep-0561/) distributing and packaging type information
|
||||
* [PEP 563](https://www.python.org/dev/peps/pep-0563/) postponed evaluation of annotations
|
||||
* [PEP 570](https://www.python.org/dev/peps/pep-0570/) position-only parameters
|
||||
* [PEP 585](https://www.python.org/dev/peps/pep-0585/) type hinting generics in standard collections
|
||||
* [PEP 586](https://www.python.org/dev/peps/pep-0586/) literal types
|
||||
* [PEP 589](https://www.python.org/dev/peps/pep-0589/) typed dictionaries
|
||||
* [PEP 591](https://www.python.org/dev/peps/pep-0591/) final qualifier
|
||||
* [PEP 593](https://www.python.org/dev/peps/pep-0593/) flexible variable annotations
|
||||
* [PEP 604](https://www.python.org/dev/peps/pep-0604/) complementary syntax for unions
|
||||
* [PEP 612](https://www.python.org/dev/peps/pep-0612/) parameter specification variables
|
||||
* [PEP 613](https://www.python.org/dev/peps/pep-0613/) explicit type aliases
|
||||
* [PEP 635](https://www.python.org/dev/peps/pep-0635/) structural pattern matching
|
||||
* [PEP 646](https://www.python.org/dev/peps/pep-0646/) variadic generics
|
||||
* [PEP 647](https://www.python.org/dev/peps/pep-0647/) user-defined type guards
|
||||
* [PEP 655](https://www.python.org/dev/peps/pep-0655/) required typed dictionary items
|
||||
* [PEP 673](https://www.python.org/dev/peps/pep-0673/) Self type
|
||||
* [PEP 675](https://www.python.org/dev/peps/pep-0675/) arbitrary literal strings
|
||||
* [PEP 681](https://www.python.org/dev/peps/pep-0681/) dataclass transform
|
||||
* [PEP 692](https://www.python.org/dev/peps/pep-0692/) TypedDict for kwargs typing
|
||||
* [PEP 695](https://www.python.org/dev/peps/pep-0695/) (draft) Type parameter syntax
|
||||
* [PEP 696](https://www.python.org/dev/peps/pep-0696/) (draft) Type defaults for TypeVarLikes
|
||||
* [PEP 698](https://www.python.org/dev/peps/pep-0698/) Override decorator for static typing
|
||||
* [PEP 702](https://www.python.org/dev/peps/pep-0702/) (draft) Marking deprecations
|
||||
* Type inference for function return values, instance variables, class variables, and globals
|
||||
* Type guards that understand conditional code flow constructs like if/else statements
|
||||
|
||||
### VS Code Language Features
|
||||
|
||||
The VS Code extension supports many time-saving language features including:
|
||||
|
||||
* Intelligent type completion of keywords, symbols, and import names appears when editing
|
||||
* Import statements are automatically inserted when necessary for type completions
|
||||
* Signature completion tips help when filling in arguments for a call
|
||||
* Hover over symbols to provide type information and doc strings
|
||||
* Find Definitions to quickly go to the location of a symbol’s definition
|
||||
* Find References to find all references to a symbol within a code base
|
||||
* Rename Symbol to rename all references to a symbol within a code base
|
||||
* Find Symbols within the current document or within the entire workspace
|
||||
* View call hierarchy information — calls made within a function and places where a function is called
|
||||
* Organize Imports command for automatically ordering imports according to PEP8 rules
|
||||
* Type stub generation for third-party libraries
|
||||
|
||||
### Built-in Type Stubs
|
||||
|
||||
Pyright includes a recent copy of the stdlib type stubs from [Typeshed](https://github.com/python/typeshed). It can be configured to use another (perhaps more recent or modified) copy of the Typeshed type stubs. Of course, it also works with custom type stub files that are part of your project.
|
||||
|
||||
For more details, refer to the [README](https://github.com/microsoft/pyright/blob/main/README.md) on the Pyright GitHub site.
|
||||
Refer to [the documentation](https://microsoft.github.io/pyright) for installation, configuration, and usage details.
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user