mirror of
https://github.com/microsoft/pyright.git
synced 2024-09-11 07:55:56 +03:00
1597 lines
72 KiB
JSON
1597 lines
72 KiB
JSON
{
|
|
"name": "vscode-pyright",
|
|
"displayName": "Pyright",
|
|
"description": "VS Code static type checking for Python",
|
|
"version": "1.1.369",
|
|
"private": true,
|
|
"license": "MIT",
|
|
"author": {
|
|
"name": "Microsoft Corporation"
|
|
},
|
|
"publisher": "ms-pyright",
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "https://github.com/Microsoft/pyright"
|
|
},
|
|
"engines": {
|
|
"vscode": "^1.86.0"
|
|
},
|
|
"keywords": [
|
|
"python"
|
|
],
|
|
"categories": [
|
|
"Programming Languages"
|
|
],
|
|
"activationEvents": [
|
|
"onLanguage:python",
|
|
"workspaceContains:pyrightconfig.json"
|
|
],
|
|
"icon": "images/pyright-icon.png",
|
|
"main": "./dist/extension.js",
|
|
"contributes": {
|
|
"languages": [
|
|
{
|
|
"id": "python",
|
|
"aliases": [
|
|
"Python"
|
|
],
|
|
"extensions": [
|
|
".py",
|
|
".pyi"
|
|
]
|
|
}
|
|
],
|
|
"commands": [
|
|
{
|
|
"command": "pyright.organizeimports",
|
|
"title": "Organize Imports",
|
|
"category": "Pyright"
|
|
},
|
|
{
|
|
"command": "pyright.restartserver",
|
|
"title": "Restart Server",
|
|
"category": "Pyright"
|
|
},
|
|
{
|
|
"command": "pyright.dumpTokens",
|
|
"title": "Dump token streams ...",
|
|
"category": "Pyright",
|
|
"enablement": "editorLangId == python && pyright.development"
|
|
},
|
|
{
|
|
"command": "pyright.dumpNodes",
|
|
"title": "Dump parse tree ...",
|
|
"category": "Pyright",
|
|
"enablement": "editorLangId == python && pyright.development"
|
|
},
|
|
{
|
|
"command": "pyright.dumpTypes",
|
|
"title": "Dump type info ...",
|
|
"category": "Pyright",
|
|
"enablement": "editorLangId == python && pyright.development"
|
|
},
|
|
{
|
|
"command": "pyright.dumpCachedTypes",
|
|
"title": "Dump cached type info ...",
|
|
"category": "Pyright",
|
|
"enablement": "editorLangId == python && pyright.development"
|
|
},
|
|
{
|
|
"command": "pyright.dumpCodeFlowGraph",
|
|
"title": "Dump code flow graph for node ...",
|
|
"category": "Pyright",
|
|
"enablement": "editorLangId == python && pyright.development"
|
|
}
|
|
],
|
|
"menus": {
|
|
"editor/context": [
|
|
{
|
|
"command": "pyright.organizeimports",
|
|
"title": "Pyright: Organize Imports",
|
|
"group": "Pyright",
|
|
"when": "editorLangId == python"
|
|
}
|
|
],
|
|
"commandPalette": [
|
|
{
|
|
"command": "pyright.dumpTokens",
|
|
"when": "editorLangId == python && pyright.development"
|
|
},
|
|
{
|
|
"command": "pyright.dumpNodes",
|
|
"when": "editorLangId == python && pyright.development"
|
|
},
|
|
{
|
|
"command": "pyright.dumpTypes",
|
|
"when": "editorLangId == python && pyright.development"
|
|
},
|
|
{
|
|
"command": "pyright.dumpCachedTypes",
|
|
"when": "editorLangId == python && pyright.development"
|
|
},
|
|
{
|
|
"command": "pyright.dumpCodeFlowGraph",
|
|
"when": "editorLangId == python && pyright.development"
|
|
}
|
|
]
|
|
},
|
|
"configuration": {
|
|
"type": "object",
|
|
"title": "Pyright",
|
|
"properties": {
|
|
"python.analysis.autoImportCompletions": {
|
|
"type": "boolean",
|
|
"default": true,
|
|
"description": "Offer auto-import completions.",
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.autoSearchPaths": {
|
|
"type": "boolean",
|
|
"default": true,
|
|
"description": "Automatically add common search paths like 'src'?",
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.extraPaths": {
|
|
"type": "array",
|
|
"default": [],
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Additional import search resolution paths",
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.stubPath": {
|
|
"type": "string",
|
|
"default": "typings",
|
|
"description": "Path to directory containing custom type stub files.",
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.diagnosticMode": {
|
|
"type": "string",
|
|
"default": "openFilesOnly",
|
|
"enum": [
|
|
"openFilesOnly",
|
|
"workspace"
|
|
],
|
|
"enumDescriptions": [
|
|
"Analyzes and reports errors on only open files.",
|
|
"Analyzes and reports errors on all files in the workspace."
|
|
],
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.include": {
|
|
"type": "array",
|
|
"default": [],
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Paths of directories or files that should be included. If no paths are specified, pyright defaults to the workspace root directory. Paths may contain wildcard characters ** (a directory or multiple levels of directories), * (a sequence of zero or more characters), or ? (a single character).",
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.exclude": {
|
|
"type": "array",
|
|
"default": [],
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Paths of directories or files that should not be included. These override the include directories, allowing specific subdirectories to be excluded. Note that files in the exclude paths may still be included in the analysis if they are referenced (imported) by source files that are not excluded. Paths may contain wildcard characters ** (a directory or multiple levels of directories), * (a sequence of zero or more characters), or ? (a single character). If no exclude paths are specified, pyright automatically excludes the following: `**/node_modules`, `**/__pycache__`, `.git` and any virtual environment directories.",
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.ignore": {
|
|
"type": "array",
|
|
"default": [],
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Paths of directories or files whose diagnostic output (errors and warnings) should be suppressed even if they are an included file or within the transitive closure of an included file. Paths may contain wildcard characters ** (a directory or multiple levels of directories), * (a sequence of zero or more characters), or ? (a single character). If no value is provided, the value of python.linting.ignorePatterns (if set) will be used.",
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.diagnosticSeverityOverrides": {
|
|
"type": "object",
|
|
"description": "Allows a user to override the severity levels for individual diagnostics. Use the rule name as a key and one of \"error\", \"warning\", \"information\", \"none\", `true` (alias for \"error\") or `false` (alias for \"none\") as value. The default value shown for each diagnostic is the default when \"python.analysis.typeCheckingMode\" is set to \"standard\". See [here](https://github.com/microsoft/pyright/blob/main/docs/configuration.md#diagnostic-rule-defaults) for defaults for each type checking mode (\"off\", \"basic\", \"standard\", and \"strict\").",
|
|
"scope": "resource",
|
|
"properties": {
|
|
"reportGeneralTypeIssues": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for general type inconsistencies, unsupported operations, argument/parameter mismatches, etc. Covers all of the basic type-checking rules not covered by other rules. Does not include syntax errors.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportPropertyTypeMismatch": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for property whose setter and getter have mismatched types.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportFunctionMemberAccess": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for member accesses on functions.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportMissingImports": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for imports that have no corresponding imported python file or type stub file.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportMissingModuleSource": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for imports that have no corresponding source file. This happens when a type stub is found, but the module source file was not found, indicating that the code may fail at runtime when using this execution environment. Type checking will be done using the type stub.",
|
|
"default": "warning",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportInvalidTypeForm": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for type expression that uses an invalid form.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportMissingTypeStubs": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for imports that have no corresponding type stub file (either a typeshed file or a custom type stub). The type checker requires type stubs to do its best job at analysis.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportImportCycles": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for cyclical import chains. These are not errors in Python, but they do slow down type analysis and often hint at architectural layering issues. Generally, they should be avoided.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnusedImport": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an imported symbol that is not referenced within that file.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnusedClass": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for a class with a private name (starting with an underscore) that is not accessed.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnusedFunction": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for a function or method with a private name (starting with an underscore) that is not accessed.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnusedVariable": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for a variable that is not accessed.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportDuplicateImport": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an imported symbol or module that is imported more than once.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportWildcardImportFromLibrary": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an wildcard import from an external library.",
|
|
"default": "warning",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportAbstractUsage": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an attempt to instantiate an abstract or protocol class or use an abstract method.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportArgumentType": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for a type incompatibility for an argument to a call.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportAssertTypeFailure": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for a type incompatibility detected by a typing.assert_type call.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportAssignmentType": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for type incompatibilities for assignments.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportAttributeAccessIssue": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for issues involving attribute accesses.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportCallIssue": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for issues involving call expressions and arguments.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportInconsistentOverload": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for inconsistencies between function overload signatures and implementation.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportIndexIssue": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics related to index operations and expressions.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportInvalidTypeArguments": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for invalid type argument usage.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportNoOverloadImplementation": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an overloaded function or method with a missing implementation.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportOperatorIssue": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for related to unary or binary operators.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportOptionalSubscript": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an attempt to subscript (index) a variable with an Optional type.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportOptionalMemberAccess": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an attempt to access a member of a variable with an Optional type.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportOptionalCall": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an attempt to call a variable with an Optional type.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportOptionalIterable": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an attempt to use an Optional type as an iterable value (e.g. within a for statement).",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportOptionalContextManager": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an attempt to use an Optional type as a context manager (as a parameter to a with statement).",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportOptionalOperand": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an attempt to use an Optional type as an operand to a binary or unary operator (like '+', '==', 'or', 'not').",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportRedeclaration": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an attempt to declare the type of a symbol multiple times.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportReturnType": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics related to function return type compatibility.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportTypedDictNotRequiredAccess": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for an attempt to access a non-required key within a TypedDict without a check for its presence.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUntypedFunctionDecorator": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for function decorators that have no type annotations. These obscure the function type, defeating many type analysis features.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUntypedClassDecorator": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for class decorators that have no type annotations. These obscure the class type, defeating many type analysis features.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUntypedBaseClass": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for base classes whose type cannot be determined statically. These obscure the class type, defeating many type analysis features.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUntypedNamedTuple": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics when “namedtuple” is used rather than “NamedTuple”. The former contains no type information, whereas the latter does.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportPrivateUsage": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for incorrect usage of private or protected variables or functions. Protected class members begin with a single underscore _ and can be accessed only by subclasses. Private class members begin with a double underscore but do not end in a double underscore and can be accessed only within the declaring class. Variables and functions declared outside of a class are considered private if their names start with either a single or double underscore, and they cannot be accessed outside of the declaring module.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportTypeCommentUsage": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for usage of deprecated type comments.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportPrivateImportUsage": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for incorrect usage of symbol imported from a \"py.typed\" module that is not re-exported from that module.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportConstantRedefinition": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for attempts to redefine variables whose names are all-caps with underscores and numerals.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportDeprecated": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for use of deprecated classes or functions.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportIncompatibleMethodOverride": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for methods that override a method of the same name in a base class in an incompatible manner (wrong number of parameters, incompatible parameter types, or incompatible return type).",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportIncompatibleVariableOverride": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for overrides in subclasses that redefine a variable in an incompatible way.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportInconsistentConstructor": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for __init__ and __new__ methods whose signatures are inconsistent.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportOverlappingOverload": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for function overloads that overlap in signature and obscure each other or have incompatible return types.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportPossiblyUnboundVariable": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for the use of variables that may be unbound on some code paths.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportMissingSuperCall": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for missing call to parent class for inherited `__init__` methods.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUninitializedInstanceVariable": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for instance variables that are not declared or initialized within class body or `__init__` method.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportInvalidStringEscapeSequence": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for invalid escape sequences used within string literals. The Python specification indicates that such sequences will generate a syntax error in future versions.",
|
|
"default": "warning",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnknownParameterType": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for input or return parameters for functions or methods that have an unknown type.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnknownArgumentType": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for call arguments for functions or methods that have an unknown type.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnknownLambdaType": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for input or return parameters for lambdas that have an unknown type.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnknownVariableType": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for variables that have an unknown type..",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnknownMemberType": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for class or instance variables that have an unknown type.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportMissingParameterType": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for parameters that are missing a type annotation.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportMissingTypeArgument": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for generic class reference with missing type arguments.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportInvalidTypeVarUse": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for improper use of type variables in a function signature.",
|
|
"default": "warning",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportCallInDefaultInitializer": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for function calls within a default value initialization expression. Such calls can mask expensive operations that are performed at module initialization time.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnnecessaryIsInstance": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for 'isinstance' or 'issubclass' calls where the result is statically determined to be always true. Such calls are often indicative of a programming error.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnnecessaryCast": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for 'cast' calls that are statically determined to be unnecessary. Such calls are sometimes indicative of a programming error.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnnecessaryComparison": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for '==' and '!=' comparisons that are statically determined to be unnecessary. Such calls are sometimes indicative of a programming error.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnnecessaryContains": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for 'in' operation that is statically determined to be unnecessary. Such operations are sometimes indicative of a programming error.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportAssertAlwaysTrue": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for 'assert' statement that will provably always assert. This can be indicative of a programming error.",
|
|
"default": "warning",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportSelfClsParameterName": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for a missing or misnamed “self” parameter in instance methods and “cls” parameter in class methods. Instance methods in metaclasses (classes that derive from “type”) are allowed to use “cls” for instance methods.",
|
|
"default": "warning",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportImplicitStringConcatenation": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for two or more string literals that follow each other, indicating an implicit concatenation. This is considered a bad practice and often masks bugs such as missing commas.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportInvalidStubStatement": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for type stub statements that do not conform to PEP 484.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportIncompleteStub": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for the use of a module-level “__getattr__” function, indicating that the stub is incomplete.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUndefinedVariable": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for undefined variables.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnboundVariable": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for the use of unbound variables.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnhashable": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for the use of an unhashable object in a container that requires hashability.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnsupportedDunderAll": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for unsupported operations performed on __all__.",
|
|
"default": "warning",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnusedCallResult": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for call expressions whose results are not consumed and are not None.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnusedCoroutine": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for call expressions that return a Coroutine and whose results are not consumed.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnusedExcept": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for unreachable except clause.",
|
|
"default": "error",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnusedExpression": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for simple expressions whose value is not used in any way.",
|
|
"default": "warning",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportUnnecessaryTypeIgnoreComment": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for '# type: ignore' comments that have no effect.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportMatchNotExhaustive": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for 'match' statements that do not exhaustively match all possible values.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportShadowedImports": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for files that are overriding a module in the stdlib.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
},
|
|
"reportImplicitOverride": {
|
|
"type": [
|
|
"string",
|
|
"boolean"
|
|
],
|
|
"description": "Diagnostics for overridden methods that do not include an `@override` decorator.",
|
|
"default": "none",
|
|
"enum": [
|
|
"none",
|
|
"information",
|
|
"warning",
|
|
"error",
|
|
true,
|
|
false
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"python.analysis.logLevel": {
|
|
"type": "string",
|
|
"default": "Information",
|
|
"description": "Specifies the level of logging for the Output panel",
|
|
"enum": [
|
|
"Error",
|
|
"Warning",
|
|
"Information",
|
|
"Trace"
|
|
]
|
|
},
|
|
"python.analysis.typeCheckingMode": {
|
|
"type": "string",
|
|
"default": "standard",
|
|
"enum": [
|
|
"off",
|
|
"basic",
|
|
"standard",
|
|
"strict"
|
|
],
|
|
"description": "Defines the default rule set for type checking.",
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.typeshedPaths": {
|
|
"type": "array",
|
|
"default": [],
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Paths to look for typeshed modules.",
|
|
"scope": "resource"
|
|
},
|
|
"python.analysis.useLibraryCodeForTypes": {
|
|
"type": "boolean",
|
|
"default": true,
|
|
"description": "Use library implementations to extract type information when type stub is not present.",
|
|
"scope": "resource"
|
|
},
|
|
"pyright.disableLanguageServices": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Disables type completion, definitions, and references.",
|
|
"scope": "resource"
|
|
},
|
|
"pyright.disableTaggedHints": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Disable hint diagnostics with special hints for grayed-out or strike-through text.",
|
|
"scope": "resource"
|
|
},
|
|
"pyright.disableOrganizeImports": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Disables the “Organize Imports” command.",
|
|
"scope": "resource"
|
|
},
|
|
"python.pythonPath": {
|
|
"type": "string",
|
|
"default": "python",
|
|
"description": "Path to Python, you can use a custom version of Python.",
|
|
"scope": "resource"
|
|
},
|
|
"python.venvPath": {
|
|
"type": "string",
|
|
"default": "",
|
|
"description": "Path to folder with a list of Virtual Environments.",
|
|
"scope": "resource"
|
|
}
|
|
}
|
|
},
|
|
"jsonValidation": [
|
|
{
|
|
"fileMatch": "pyrightconfig.json",
|
|
"url": "./schemas/pyrightconfig.schema.json"
|
|
}
|
|
]
|
|
},
|
|
"scripts": {
|
|
"clean": "shx rm -rf ./dist ./out",
|
|
"prepackage": "node ./build/renamePackage.js pyright",
|
|
"package": "vsce package",
|
|
"postpackage": "node ./build/renamePackage.js vscode-pyright",
|
|
"vscode:prepublish": "node ./build/checkPackage.js && npm run clean && webpack --mode production --progress",
|
|
"webpack": "webpack --mode development --progress",
|
|
"webpack-dev": "npm run clean && webpack --mode development --watch --progress"
|
|
},
|
|
"dependencies": {
|
|
"vscode-jsonrpc": "^9.0.0-next.4",
|
|
"vscode-languageclient": "^10.0.0-next.8",
|
|
"vscode-languageserver": "^10.0.0-next.6",
|
|
"vscode-languageserver-protocol": "^3.17.6-next.6"
|
|
},
|
|
"devDependencies": {
|
|
"@types/node": "^17.0.45",
|
|
"@types/vscode": "^1.82.0",
|
|
"copy-webpack-plugin": "^11.0.0",
|
|
"esbuild-loader": "^3.2.0",
|
|
"shx": "^0.3.4",
|
|
"ts-loader": "^9.5.1",
|
|
"typescript": "~5.2",
|
|
"vsce": "^2.7.0",
|
|
"webpack": "^5.90.1",
|
|
"webpack-cli": "^5.1.4"
|
|
}
|
|
}
|