-
Notifications
You must be signed in to change notification settings - Fork 768
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add to TROUBLESHOOTING and README (#21)
* Add to troubleshooting and readme * use prettier formatting * Fix json block; * fix json * prettier everything
- Loading branch information
1 parent
40efa9b
commit de6bb89
Showing
8 changed files
with
140 additions
and
120 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "singleQuote": true, | ||
| "tabWidth": 4, | ||
| "useTabs": false, | ||
| "printWidth": 120, | ||
| "endOfLine": "auto", | ||
| "overrides": [ | ||
| { | ||
| "files": ["*.yml", "*.yaml"], | ||
| "options": { | ||
| "tabWidth": 2 | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope | |
|
|
||
| Resources: | ||
|
|
||
| - [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) | ||
| - [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
| - Contact [[email protected]](mailto:[email protected]) with questions or concerns | ||
| - [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) | ||
| - [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
| - Contact [[email protected]](mailto:[email protected]) with questions or concerns | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,103 +1,109 @@ | ||
| Pylance | ||
| ===================== | ||
| # Pylance | ||
|
|
||
| ### Fast, feature-rich language support for Python | ||
|
|
||
| This repository is for providing feedback and documentation on the Pylance language server extension in Visual Studio Code. You can use the repository to report issues or submit feature requests. The Pylance codebase is not open-source but you can contribute to Pyright to make improvements to the core typing engine that powers the Pylance experience. | ||
|
|
||
| Quick Start | ||
| ============ | ||
| # Quick Start | ||
|
|
||
| 1. Install the [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) from the marketplace. | ||
| 1. Open a Python (.py) file and the Pylance extension will activate. | ||
|
|
||
| Features | ||
| ========= | ||
| # Features | ||
|
|
||
|  | ||
|
|
||
| * Docstrings | ||
| * Signature help, with type information | ||
| * Parameter suggestions | ||
| * Code completion | ||
| * Auto-imports (as well as add and remove import code actions) | ||
| * As-you-type reporting of code errors and warnings (diagnostics) | ||
| * Code outline | ||
| * Code navigation | ||
| * Code lens (references/implementations) | ||
| * Type checking mode | ||
| * Native multi-root workspace support | ||
| * IntelliCode compatibility | ||
| * Jupyter Notebooks compatibility | ||
| Pylance provides some awesome features for Python 3, including: | ||
|
|
||
| - Docstrings | ||
| - Signature help, with type information | ||
| - Parameter suggestions | ||
| - Code completion | ||
| - Auto-imports (as well as add and remove import code actions) | ||
| - As-you-type reporting of code errors and warnings (diagnostics) | ||
| - Code outline | ||
| - Code navigation | ||
| - Code lens (references/implementations) | ||
| - Type checking mode | ||
| - Native multi-root workspace support | ||
| - IntelliCode compatibility | ||
| - Jupyter Notebooks compatibility | ||
|
|
||
| See the [changelog](CHANGELOG.md) for the latest release. | ||
|
|
||
| Settings and Customization | ||
| =============== | ||
| Pylance provides users with the ability to customize their Python language support via a host of settings which can either be placed in the settings.json file in your workspace, or edited through the Settings Editor UI. | ||
|
|
||
| - `python.analysis.typeCheckingMode` | ||
| - Used to specify the level of type checking analysis performed; | ||
| - Default: `off` | ||
| - Available values: | ||
| - `off`: No type checking analysis is conducted; unresolved imports/variables diagnostics are produced | ||
| - `basic`: Non-type checking-related rules (all rules in `off`) + basic type checking rules | ||
| - `strict`: All type checking rules at the highest severity of error (includes all rules in `off` and `basic` categories) | ||
|
|
||
| - `python.analysis.diagnosticMode` | ||
| - Used to allow a user to specify what files they want the language server to analyze to get problems flagged in their code. | ||
| - Available values: | ||
| - `workspace` | ||
| - `openFilesOnly` (default) | ||
|
|
||
| - `python.analysis.stubPaths` | ||
| - Used to allow a user to specify a path to a directory that contains custom type stubs. Each package's type stub file(s) are expected to be in its own subdirectory. | ||
| - Default value: `./typings` | ||
|
|
||
| - `python.analysis.autoSearchPaths` | ||
| - Used to automatically add search paths based on some predefined names (like `src`). | ||
| - Available values: | ||
| - `true` (default) | ||
| - `false` | ||
|
|
||
| - `python.analysis.diagnosticSeverityOverrides` | ||
| - Used to allow a user to override the severity levels for individual diagnostics should they desire | ||
| - Accepted severity values: | ||
| - `error` (red squiggle) | ||
| - `warning` (yellow squiggle) | ||
| - `information` (blue squiggle) | ||
| - `none` (disables the rule) | ||
|
|
||
| - Available rule to use as keys can be found [here](DIAGNOSTIC_SEVERITY_RULES.md) | ||
| - Example: | ||
| ``` | ||
| { | ||
| "python.analysis.diagnosticSeverityOverrides:" { | ||
| "reportUnboundVariable" : "information", | ||
| "reportImplicitStringConcatenation" : "warning" | ||
| } | ||
| } | ||
| # Settings and Customization | ||
|
|
||
| Pylance provides users with the ability to customize their Python language support via a host of settings which can either be placed in the settings.json file in your workspace, or edited through the Settings Editor UI. | ||
|
|
||
| - `python.analysis.typeCheckingMode` | ||
|
|
||
| - Used to specify the level of type checking analysis performed; | ||
| - Default: `off` | ||
| - Available values: | ||
| - `off`: No type checking analysis is conducted; unresolved imports/variables diagnostics are produced | ||
| - `basic`: Non-type checking-related rules (all rules in `off`) + basic type checking rules | ||
| - `strict`: All type checking rules at the highest severity of error (includes all rules in `off` and `basic` categories) | ||
|
|
||
| - `python.analysis.diagnosticMode` | ||
|
|
||
| - Used to allow a user to specify what files they want the language server to analyze to get problems flagged in their code. | ||
| - Available values: | ||
| - `workspace` | ||
| - `openFilesOnly` (default) | ||
|
|
||
| - `python.analysis.stubPaths` | ||
|
|
||
| - Used to allow a user to specify a path to a directory that contains custom type stubs. Each package's type stub file(s) are expected to be in its own subdirectory. | ||
| - Default value: `./typings` | ||
|
|
||
| - `python.analysis.autoSearchPaths` | ||
|
|
||
| - Used to automatically add search paths based on some predefined names (like `src`). | ||
| - Available values: | ||
| - `true` (default) | ||
| - `false` | ||
|
|
||
| - `python.analysis.diagnosticSeverityOverrides` | ||
|
|
||
| - Used to allow a user to override the severity levels for individual diagnostics should they desire | ||
| - Accepted severity values: | ||
|
|
||
| - `error` (red squiggle) | ||
| - `warning` (yellow squiggle) | ||
| - `information` (blue squiggle) | ||
| - `none` (disables the rule) | ||
|
|
||
| - Available rule to use as keys can be found [here](DIAGNOSTIC_SEVERITY_RULES.md) | ||
| - Example: | ||
|
|
||
| ```json | ||
| { | ||
| "python.analysis.diagnosticSeverityOverrides": { | ||
| "reportUnboundVariable": "information", | ||
| "reportImplicitStringConcatenation": "warning" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| - `python.analysis.useLibraryCodeForTypes` | ||
| - Used to parse the source code for a package when a typestub is not found | ||
| - Accepted values: | ||
| - `true` (default) | ||
| - `false` | ||
| - `python.analysis.useLibraryCodeForTypes` | ||
| - Used to parse the source code for a package when a typestub is not found | ||
| - Accepted values: | ||
| - `true` (default) | ||
| - `false` | ||
|
|
||
| # Contributing | ||
|
|
||
| Contributing | ||
| =============== | ||
| Pylance leverages Microsoft's open-source static type checking tool, Pyright, to provide performant language support for Python. | ||
| Pylance leverages Microsoft's open-source static type checking tool, Pyright, to provide performant language support for Python. | ||
|
|
||
| Code contributions are welcomed via the [Pyright](https://github.com/microsoft/pyright) repo. | ||
|
|
||
| For information on getting started, refer to the [CONTRIBUTING instructions](https://github.com/microsoft/pyright/blob/master/CONTRIBUTING.md). | ||
|
|
||
| # Feedback | ||
|
|
||
| Feedback | ||
| =============== | ||
| * File a bug in [GitHub Issues](https://github.com/microsoft/pylance-release/issues/new/choose) | ||
| * [Tweet us](https://twitter.com/pythonvscode/) with other feedback | ||
| - File a bug in [GitHub Issues](https://github.com/microsoft/pylance-release/issues/new/choose) | ||
| - [Tweet us](https://twitter.com/pythonvscode/) with other feedback | ||
|
|
||
| # License | ||
|
|
||
| License | ||
| =============== | ||
| See [LICENSE](LICENSE) for more information. | ||
| See [LICENSE](LICENSE) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,27 +4,27 @@ | |
|
|
||
| Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). | ||
|
|
||
| If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. | ||
| If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](<https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)>), please report it to us as described below. | ||
|
|
||
| ## Reporting Security Issues | ||
|
|
||
| **Please do not report security vulnerabilities through public GitHub issues.** | ||
|
|
||
| Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). | ||
|
|
||
| If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). | ||
| If you prefer to submit without logging in, send email to [[email protected]](mailto:[email protected]). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). | ||
|
|
||
| You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). | ||
| You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). | ||
|
|
||
| Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: | ||
|
|
||
| * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) | ||
| * Full paths of source file(s) related to the manifestation of the issue | ||
| * The location of the affected source code (tag/branch/commit or direct URL) | ||
| * Any special configuration required to reproduce the issue | ||
| * Step-by-step instructions to reproduce the issue | ||
| * Proof-of-concept or exploit code (if possible) | ||
| * Impact of the issue, including how an attacker might exploit the issue | ||
| - Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) | ||
| - Full paths of source file(s) related to the manifestation of the issue | ||
| - The location of the affected source code (tag/branch/commit or direct URL) | ||
| - Any special configuration required to reproduce the issue | ||
| - Step-by-step instructions to reproduce the issue | ||
| - Proof-of-concept or exploit code (if possible) | ||
| - Impact of the issue, including how an attacker might exploit the issue | ||
|
|
||
| This information will help us triage your report more quickly. | ||
|
|
||
|
|
@@ -38,4 +38,4 @@ We prefer all communications to be in English. | |
|
|
||
| Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). | ||
|
|
||
| <!-- END MICROSOFT SECURITY.MD BLOCK --> | ||
| <!-- END MICROSOFT SECURITY.MD BLOCK --> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters