Eric Traut
6a25a7bf0b
Removed the requirement that a TypedDict be marked @final for it to be considered for type narrowing as part of a S in D type guard pattern. This requirement wasn't sound because TypedDict is a structural type (i.e. a protocol), so @final doesn't have any real meaning.
2023-07-17 08:01:52 -07:00
Eric Traut
0a67c65bef
Clarified in documentation that no_type_check is not supported.
2023-06-30 08:39:10 +02:00
Eric Traut
c767228a82
Improved documentation for "implied else" type narrowing.
2023-06-29 01:28:19 +02:00
Eric Traut
5568b4dc95
Enhanced command-line version of pyright to allow file or directory names to be passed via stdin if - option is used in the command line. This addresses https://github.com/microsoft/pyright/issues/5342 .
2023-06-19 18:00:31 -07:00
Eric Traut
2de35e3684
Added documentation about higher-order functions.
2023-06-18 00:00:06 -07:00
Eric Traut
8d9910eb89
Added more details about difference between mypy and pyright overload resolution in ambiguous cases.
2023-06-15 16:01:12 -07:00
Ross J. Duff, MSc
b12ca05927
Clarification of --version argument usage string ( #5308 )
...
* Update command-line.md
clarify that `--version` prints the version *and exits*
* Update --version usage string
Clarifies that `--version` prints the version *and exits*, this is fairly common language used by most CLI apps to indicate what the behavior of `--version` is. It may surprise new users that `--version` exits rather than appending the version with the previous language.
2023-06-15 08:42:26 -07:00
Serhii Tereshchenko
0d0e716f92
Update ci-integration.md ( #5259 )
...
When both scripts are executed in `scripts:` section, and `pyright` reports error, second script is not executed.
Best way to ensure report are always converted, is to use `after_script:` block.
2023-06-09 08:37:45 -06:00
Eric Traut
24b612fda2
Reverted overload change for now. It's causing breaks in the pandas-stubs library. More investigation is needed.
2023-06-06 17:53:24 -06:00
Eric Traut
5ca3d900fd
Deleted redundant documentation.
2023-06-05 15:06:24 -06:00
Eric Traut
746e03a49d
Modified overload matching algorithm to better match that of mypy. In particular, if overload matching is ambiguous due to an Any or Unknown anywhere within an argument type (even within type arguments) and the resulting filtered overloads return the same generic type but with different type arguments, the resulting type was previously the return type of the first filtered overload. It is now the common generic type with erased type arguments. This addresses https://github.com/microsoft/pyright/issues/5216 .
2023-06-03 17:36:09 -06:00
Eric Traut
6e6c3664b3
Added documentation for pyright's handling of constructor calls and how this differs from mypy.
2023-05-25 18:36:11 -07:00
Erik De Bonte
b971a0c689
Add PEP 712 to features.md ( #5143 )
2023-05-19 17:07:39 -07:00
Eric Traut
35a2ed939c
Updated features documentation to mark PEP 695 as no longer in draft form.
2023-05-15 23:16:36 -07:00
Eric Traut
98b0604eb9
Added command-line option pythonpath that allows the path to the python interpreter to be specified. This addresses https://github.com/microsoft/pyright/issues/5111 .
2023-05-13 16:19:14 -07:00
Eric Traut
ba18f421d1
Deprecated command-line options 'typeshed-path' and 'venv-path' in favor of 'typeshedpath' and 'venvpath'. The hyphenated options were inconsistent with the conventions used for other options.
2023-05-13 15:56:26 -07:00
Eric Traut
85a8b34aee
Added instructions for adding a “pyright: checked” badge.
2023-05-06 08:26:44 -07:00
Eric Traut
a9a0a60a39
Moved badge to docs/img folder.
2023-05-06 08:25:03 -07:00
Erik De Bonte
6e95b76291
Fix broken link in mypy-comparison.md ( #5046 )
2023-05-01 14:42:54 -07:00
Eric Traut
2c6e5b2938
Updated CLI documentation to clarify that files specified on the command line do not cause the config file to be ignored entirely.
2023-04-22 19:31:52 -07:00
Eric Traut
9f81564a46
Changed reportImportCycles so it is not on by default in "strict" type checking mode. It is highly opinionated and should be used only in cases where the developer opts into it.
2023-04-08 10:29:14 -07:00
Eric Traut
39cac72d99
Improved documentation for conditional types.
2023-04-05 15:50:00 -07:00
Eric Traut
5d6eacd5e1
Changed the default of the useLibraryCodeForTypes from false to true to bring pylance and pyright into alignment. Also deprecated the "--lib" command-line option, which was previously used to enable useLibraryCodeForTypes from the command line. ( #4903 )
...
Co-authored-by: Eric Traut <erictr@microsoft.com>
2023-04-05 09:47:59 -06:00
Eric Traut
ff134e6467
Added documentation to mypy comparison that talks about narrowing for captured variables.
2023-04-02 08:34:28 -07:00
Eric Traut
08085479ef
Extended type narrowing for type guards of the form x[I] is B and x[I] is not B where x is a tuple and B is an enum literal.
2023-03-30 18:26:46 -07:00
Eric Traut
f1db88481f
Added support for type guards of the form x[I] is B and x[I] is not B where x is a tuple and B is a boolean literal True or False. This addresses part of https://github.com/microsoft/pyright/issues/4875 .
2023-03-30 18:10:06 -07:00
Dmitry Volodin
14b0831697
Fix Markdown links ( #4849 )
...
* Fixed Markdown links
* Gave main doc page prettier name
2023-03-27 19:48:11 -06:00
Eric Traut
e2e3a5c9ff
Added new diagnostic check reportImplicitOverride. This addresses https://github.com/microsoft/pyright/issues/4788 .
2023-03-16 09:52:25 -06:00
Eric Traut
65ca325a14
Changed # pyright: basic file-level comment so it overrides "strict" settings specified in the config file or language server settings. This allows an individual file to be "downgraded" from strict to basic. This addresses https://github.com/microsoft/pyright/issues/4751 .
2023-03-09 10:28:44 -07:00
Eric Traut
3f987e3137
Fixed broken links in README for npmjs page. Added missing link to command line interface documentation in sidebar.
2023-03-09 09:46:17 -07:00
Eric Traut
9c6ebad347
Updated mypy comparison to reflect change in mypy's type narrowing capabilities.
2023-03-09 08:21:01 -07:00
Eric Traut
c83a95e62e
More improvements to documentation.
2023-03-07 16:38:22 -07:00
Eric Traut
414dce170e
Updated documentation for import modeling differences between mypy and pyright.
2023-03-07 10:16:14 -07:00
Eric Traut
1fdeadeca6
Improved "getting started" documentation.
2023-03-07 09:53:49 -07:00
Eric Traut
a00a026953
Fixed capitalization inconsistency in docs.
2023-03-06 18:12:20 -07:00
Eric Traut
08b2cb4698
Did a consistency pass on documentation markdown.
2023-03-06 18:10:33 -07:00
Eric Traut
f7db5822ef
Ran auto-formatter on html to avoid style issue in CI.
2023-03-06 17:59:23 -07:00
Eric Traut
8f17673300
Fixed main Pyright link in sidebar.
2023-03-06 17:55:58 -07:00
Eric Traut
400dd260cc
Another small tweak to docs sidebar.
2023-03-06 17:54:36 -07:00
Eric Traut
2c4a9da2ae
More tweaks to documentation and README files. Added a navbar to docs site.
2023-03-06 17:52:06 -07:00
Eric Traut
65874c5254
Small tweak for main docs page.
2023-03-06 17:45:37 -07:00
Eric Traut
deabba5e6a
Tweaked documentation theming and added language highlighting for json.
2023-03-06 17:44:15 -07:00
Eric Traut
2827c94d89
Small correction to settings documentation.
2023-03-06 16:10:06 -07:00
Eric Traut
dc87fa46af
Added a missing HTML tag to index.html.
2023-03-06 16:03:19 -07:00
Eric Traut
6cb2f4a058
Moved installation instructions and FAQ to their own docs pages, further simplifying the main README.
2023-03-06 15:58:44 -07:00
Eric Traut
b61f121efe
Minor tweak to README.
2023-03-06 15:51:49 -07:00
Eric Traut
4c4aec52a5
Added support for docsify-based docs site.
2023-03-06 15:46:07 -07:00
Eric Traut
b3fd962116
Fixed bugs in documentation.
2023-03-06 15:45:51 -07:00
Eric Traut
735c19a1c9
Improved documentation for ... function bodies.
2023-03-06 10:49:54 -07:00
Eric Traut
7197a8d624
Added documentation for import statements.
2023-03-06 08:49:00 -07:00
