microsoft/pyright
1
1
Fork 0
mirror of https://github.com/microsoft/pyright.git synced 2024-11-10 00:26:21 +03:00
Code Issues Projects Releases Wiki Activity
576d327452
pyright/client
History
Eric Traut e367ed0ac0 Published 1.1.7
2019-11-30 00:15:10 -08:00
..
images Updated logo and added icon for VS Code extension. 2019-03-21 20:00:47 -07:00
schemas Added config feature "reportAssertAlwaysTrue". It flags errant assert statements. 2019-11-17 18:02:46 -08:00
src Fixed regression in extension. 2019-10-20 09:39:36 -07:00
typeshed-fallback Sync'ed typeshed stdlib stubs with latest typeshed repo. 2019-11-22 20:10:39 -08:00
.vscodeignore Optimized production build of server, reducing the startup time and overall size of the VS Code extension significantly. 2019-10-05 22:42:25 -07:00
CHANGELOG.md Added README and CHANGELOG to client folder so they appear in VS Code extensions panel. 2019-04-19 23:53:50 -07:00
package-lock.json Published 1.1.7 2019-11-30 00:15:10 -08:00
package.json Published 1.1.7 2019-11-30 00:15:10 -08:00
README.md Updated embedded README. 2019-10-05 03:28:00 -07:00
tsconfig.json Initial checkin. 2019-03-11 20:45:56 -07:00

README.md

Static type checker for Python

Speed

Pyright is a fast type checker meant for large Python source bases. It can run in a “watch” mode and performs fast incremental updates when files are modified.

No Dependency on Python Environment

Pyright does not require a Python environment or imported third-party packages to be installed.

Configurability

Pyright supports configuration files 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

Pyright supports:

  • PEP 484 type hints including generics
  • PEP 526 syntax for variable annotations
  • PEP 544 structural subtyping
  • PEP 589 typed dictionaries
  • Type inference for function return values, instance variables, class variables, and globals
  • Smart type constraints 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
  • 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. 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 on the Pyright GitHub site.