mypy.find_sources

module documentation
(source)

Routines for finding the sources that mypy will check

Class SourceFinder No class docstring; 0/5 instance variable, 3/7 methods documented
Exception InvalidSourceList Exception indicating a problem in the list of sources given to mypy.
Function create_source_list From a list of source files/directories, makes a list of BuildSources.
Function get_explicit_package_bases Returns explicit package bases to use if the option is enabled, or None if disabled.
Function keyfunc Determines sort order for directory listing.
Function module_join Join module ids, accounting for a possibly empty parent.
Function normalise_package_base Undocumented
Function strip_py Strip a trailing .py or .pyi suffix.
Constant PY_EXTENSIONS Undocumented
def create_source_list(paths: Sequence[str], options: Options, fscache: FileSystemCache|None = None, allow_empty_dir: bool = False) -> list[BuildSource]: (source)

From a list of source files/directories, makes a list of BuildSources. Raises InvalidSourceList on errors.

def get_explicit_package_bases(options: Options) -> list[str]|None: (source)

Returns explicit package bases to use if the option is enabled, or None if disabled. We currently use MYPYPATH and the current directory as the package bases. In the future, when --namespace-packages is the default could also use the values passed with the --package-root flag, see #9632. Values returned are normalised so we can use simple string comparisons in SourceFinder.is_explicit_package_base

def keyfunc(name: str) -> tuple[bool, int, str]: (source)

Determines sort order for directory listing. The desirable properties are: 1) foo < foo.pyi < foo.py 2) __init__.py[i] < foo

def module_join(parent: str, child: str) -> str: (source)

Join module ids, accounting for a possibly empty parent.

def normalise_package_base(root: str) -> str: (source)

Undocumented

def strip_py(arg: str) -> str|None: (source)

Strip a trailing .py or .pyi suffix. Return None if no such suffix is found.

PY_EXTENSIONS = (source)

Undocumented

Value
tuple(PYTHON_EXTENSIONS)