Skip to content

basedpyright

basedpyright documentation

footman._stubs.basedpyright.Basedpyright

Bases: Tool

__call__

__call__(
    *args: 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,
) -> Result

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.

...