Skip to content

basedpyright

basedpyright documentation

toolroom._stubs.basedpyright.Basedpyright

Bases: Tool[_R]

__call__

__call__(
    *args: str | PathLike[str],
    baselinefile: Value = ...,
    createstub: Value = ...,
    dependencies: Flag = ...,
    gitlabcodequality: Value = ...,
    ignoreexternal: Flag = ...,
    level: Value = ...,
    outputjson: Flag = ...,
    project: Value = ...,
    pythonpath: Value = ...,
    pythonplatform: Value = ...,
    pythonversion: Value = ...,
    skipunannotated: Flag = ...,
    stats: Flag = ...,
    threads: Value = ...,
    typeshedpath: Value = ...,
    venvpath: Value = ...,
    verbose: Flag = ...,
    verifytypes: Value = ...,
    warnings: Flag = ...,
    watch: Flag = ...,
    writebaseline: Flag = ...,
    **flags: Any,
) -> _R

Run this verb.

Parameters:

Name Type Description Default
baselinefile Value

Path to the baseline file to be used.

...
createstub Value

Create type stub file(s) for import.

...
dependencies Flag

Emit import dependency information.

...
gitlabcodequality Value

Output results to a gitlab code quality report.

...
ignoreexternal Flag

Ignore external imports for --verifytypes.

...
level Value

Minimum diagnostic level (error or warning).

...
outputjson Flag

Output results in JSON format.

...
project Value

Use the configuration file at this location.

...
pythonpath Value

Path to the Python interpreter.

...
pythonplatform Value

Analyze for a specific platform (Darwin, Linux, Windows, iOS, Android).

...
pythonversion Value

Analyze for a specific version (3.3, 3.4, etc.).

...
skipunannotated Flag

Skip analysis of functions with no type annotations.

...
stats Flag

Print detailed performance stats.

...
threads Value

Use separate threads to parallelize type checking.

...
typeshedpath Value

Use typeshed type stubs at this location.

...
venvpath Value

Directory that contains virtual environments.

...
verbose Flag

Emit verbose diagnostics.

...
verifytypes Value

Verify type completeness of a py.typed package.

...
warnings Flag

Use exit code of 1 if warnings are reported.

...
watch Flag

Continue to run and watch for changes.

...
writebaseline Flag

Write new errors to the baseline file.

...