Pyright

Pyright Configuration

Type object
File match pyrightconfig.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/pyright/latest.json
Source https://raw.githubusercontent.com/microsoft/pyright/main/packages/vscode-pyright/schemas/pyrightconfig.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Pyright Configuration Schema

Properties

extends string
pattern=^(.*)$
include string[]
exclude string[]
ignore string[]
strict string[]
defineConstant Record<string, string | boolean>
typeCheckingMode string
Default: "standard"
Values: "off" "basic" "standard" "strict"
useLibraryCodeForTypes boolean
Default: true
typeshedPath string
Default: ""
pattern=^(.*)$
stubPath string
Default: "./typings"
Examples: "src/typestubs"
pattern=^(.*)$
disableBytesTypePromotions boolean
Default: true
strictListInference boolean
Default: false
strictSetInference boolean
Default: false
strictDictionaryInference boolean
Default: false
analyzeUnannotatedFunctions boolean
Default: true
strictParameterNoneValue boolean
Default: true
enableExperimentalFeatures boolean
Default: false
enableTypeIgnoreComments boolean
Default: true
enableReachabilityAnalysis boolean
Default: true
deprecateTypingAliases boolean
Default: false
reportGeneralTypeIssues diagnostic
Default: "error"
reportPropertyTypeMismatch diagnostic
Default: "none"
reportFunctionMemberAccess diagnostic
Default: "error"
reportMissingImports diagnostic
Default: "error"
reportMissingModuleSource diagnostic
Default: "warning"
reportInvalidTypeForm diagnostic
Default: "error"
reportMissingTypeStubs diagnostic
Default: "none"
reportImportCycles diagnostic
Default: "none"
reportUnusedImport diagnostic
Default: "none"
reportUnusedClass diagnostic
Default: "none"
reportUnusedFunction diagnostic
Default: "none"
reportUnusedVariable diagnostic
Default: "none"
reportDuplicateImport diagnostic
Default: "none"
reportWildcardImportFromLibrary diagnostic
Default: "warning"
reportAbstractUsage diagnostic
Default: "error"
reportArgumentType diagnostic
Default: "error"
reportAssertTypeFailure diagnostic
Default: "error"
reportAssignmentType diagnostic
Default: "error"
reportAttributeAccessIssue diagnostic
Default: "error"
reportCallIssue diagnostic
Default: "error"
reportInconsistentOverload diagnostic
Default: "error"
reportIndexIssue diagnostic
Default: "error"
reportInvalidTypeArguments diagnostic
Default: "error"
reportNoOverloadImplementation diagnostic
Default: "error"
reportOperatorIssue diagnostic
Default: "error"
reportOptionalSubscript diagnostic
Default: "error"
reportOptionalMemberAccess diagnostic
Default: "error"
reportOptionalCall diagnostic
Default: "error"
reportOptionalIterable diagnostic
Default: "error"
reportOptionalContextManager diagnostic
Default: "error"
reportOptionalOperand diagnostic
Default: "error"
reportRedeclaration diagnostic
Default: "error"
reportReturnType diagnostic
Default: "error"
reportTypedDictNotRequiredAccess diagnostic
Default: "error"
reportUntypedFunctionDecorator diagnostic
Default: "none"
reportUntypedClassDecorator diagnostic
Default: "none"
reportUntypedBaseClass diagnostic
Default: "none"
reportUntypedNamedTuple diagnostic
Default: "none"
reportPrivateUsage diagnostic
Default: "none"
reportTypeCommentUsage diagnostic
Default: "none"
reportPrivateImportUsage diagnostic
Default: "error"
reportConstantRedefinition diagnostic
Default: "none"
reportDeprecated diagnostic
Default: "none"
reportIncompatibleMethodOverride diagnostic
Default: "error"
reportIncompatibleVariableOverride diagnostic
Default: "error"
reportInconsistentConstructor diagnostic
Default: "none"
reportOverlappingOverload diagnostic
Default: "error"
reportPossiblyUnboundVariable diagnostic
Default: "error"
reportMissingSuperCall diagnostic
Default: "none"
reportUninitializedInstanceVariable diagnostic
Default: "none"
reportInvalidStringEscapeSequence diagnostic
Default: "warning"
reportUnknownParameterType diagnostic
Default: "none"
reportUnknownArgumentType diagnostic
Default: "none"
reportUnknownLambdaType diagnostic
Default: "none"
reportUnknownVariableType diagnostic
Default: "none"
reportUnknownMemberType diagnostic
Default: "none"
reportMissingParameterType diagnostic
Default: "none"
reportMissingTypeArgument diagnostic
Default: "none"
reportInvalidTypeVarUse diagnostic
Default: "warning"
reportCallInDefaultInitializer diagnostic
Default: "none"
reportUnnecessaryIsInstance diagnostic
Default: "none"
reportUnnecessaryCast diagnostic
Default: "none"
reportUnnecessaryComparison diagnostic
Default: "none"
reportUnnecessaryContains diagnostic
Default: "none"
reportAssertAlwaysTrue diagnostic
Default: "warning"
reportSelfClsParameterName diagnostic
Default: "warning"
reportImplicitStringConcatenation diagnostic
Default: "none"
reportUnboundVariable diagnostic
Default: "error"
reportUnhashable diagnostic
Default: "error"
reportUndefinedVariable diagnostic
Default: "error"
reportInvalidStubStatement diagnostic
Default: "none"
reportIncompleteStub diagnostic
Default: "none"
reportUnsupportedDunderAll diagnostic
Default: "warning"
reportUnusedCallResult diagnostic
Default: "none"
reportUnusedCoroutine diagnostic
Default: "error"
reportUnusedExcept diagnostic
Default: "error"
reportUnusedExpression diagnostic
Default: "warning"
reportUnnecessaryTypeIgnoreComment diagnostic
Default: "none"
reportMatchNotExhaustive diagnostic
Default: "none"
reportUnreachable diagnostic
Default: "none"
reportImplicitOverride diagnostic
Default: "none"
extraPaths string[]
pythonVersion string
Default: ""
Examples: "3.7"
pattern=^3\.[0-9]+$
pythonPlatform string
Default: ""
Examples: "Linux"
pattern=^(Linux|Windows|Darwin|iOS|Android|All)$
venvPath string
Default: ""
pattern=^(.*)$
venv string
Default: ""
Examples: "python37"
pattern=^(.*)$
verboseOutput boolean
Default: false
executionEnvironments object[]

Definitions

diagnostic boolean | string
extraPaths string[]
pythonVersion string
Examples:
  • "3.7"
pythonPlatform string
Examples:
  • "Linux"
disableBytesTypePromotions boolean
strictListInference boolean
strictSetInference boolean
strictDictionaryInference boolean
analyzeUnannotatedFunctions boolean
strictParameterNoneValue boolean
enableExperimentalFeatures boolean
enableTypeIgnoreComments boolean
enableReachabilityAnalysis boolean
deprecateTypingAliases boolean
reportGeneralTypeIssues boolean | string
reportPropertyTypeMismatch boolean | string
reportFunctionMemberAccess boolean | string
reportMissingImports boolean | string
reportMissingModuleSource boolean | string
reportInvalidTypeForm boolean | string
reportMissingTypeStubs boolean | string
reportImportCycles boolean | string
reportUnusedImport boolean | string
reportUnusedClass boolean | string
reportUnusedFunction boolean | string
reportUnusedVariable boolean | string
reportDuplicateImport boolean | string
reportWildcardImportFromLibrary boolean | string
reportAbstractUsage boolean | string
reportArgumentType boolean | string
reportAssertTypeFailure boolean | string
reportAssignmentType boolean | string
reportAttributeAccessIssue boolean | string
reportCallIssue boolean | string
reportInconsistentOverload boolean | string
reportIndexIssue boolean | string
reportInvalidTypeArguments boolean | string
reportNoOverloadImplementation boolean | string
reportOperatorIssue boolean | string
reportOptionalSubscript boolean | string
reportOptionalMemberAccess boolean | string
reportOptionalCall boolean | string
reportOptionalIterable boolean | string
reportOptionalContextManager boolean | string
reportOptionalOperand boolean | string
reportRedeclaration boolean | string
reportReturnType boolean | string
reportTypedDictNotRequiredAccess boolean | string
reportUntypedFunctionDecorator boolean | string
reportUntypedClassDecorator boolean | string
reportUntypedBaseClass boolean | string
reportUntypedNamedTuple boolean | string
reportPrivateUsage boolean | string
reportTypeCommentUsage boolean | string
reportPrivateImportUsage boolean | string
reportConstantRedefinition boolean | string
reportDeprecated boolean | string
reportIncompatibleMethodOverride boolean | string
reportIncompatibleVariableOverride boolean | string
reportInconsistentConstructor boolean | string
reportOverlappingOverload boolean | string
reportPossiblyUnboundVariable boolean | string
reportMissingSuperCall boolean | string
reportUninitializedInstanceVariable boolean | string
reportInvalidStringEscapeSequence boolean | string
reportUnknownParameterType boolean | string
reportUnknownArgumentType boolean | string
reportUnknownLambdaType boolean | string
reportUnknownVariableType boolean | string
reportUnknownMemberType boolean | string
reportMissingParameterType boolean | string
reportMissingTypeArgument boolean | string
reportInvalidTypeVarUse boolean | string
reportCallInDefaultInitializer boolean | string
reportUnnecessaryIsInstance boolean | string
reportUnnecessaryCast boolean | string
reportUnnecessaryComparison boolean | string
reportUnnecessaryContains boolean | string
reportAssertAlwaysTrue boolean | string
reportSelfClsParameterName boolean | string
reportImplicitStringConcatenation boolean | string
reportUnboundVariable boolean | string
reportUnhashable boolean | string
reportUndefinedVariable boolean | string
reportInvalidStubStatement boolean | string
reportIncompleteStub boolean | string
reportUnsupportedDunderAll boolean | string
reportUnusedCallResult boolean | string
reportUnusedCoroutine boolean | string
reportUnusedExcept boolean | string
reportUnusedExpression boolean | string
reportUnnecessaryTypeIgnoreComment boolean | string
reportMatchNotExhaustive boolean | string
reportUnreachable boolean | string
reportImplicitOverride boolean | string