mypy.find_sources

module documentation
(source)

Routines for finding the sources that mypy will check
Class ​Invalid​Source​List Exception indicating a problem in the list of sources given to mypy.
Class ​Source​Finder No class docstring; 0/5 instance variable, 3/7 methods documented
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, options, fscache=None, allow_empty_dir=False): (source)

From a list of source files/directories, makes a list of BuildSources.

Raises InvalidSourceList on errors.

Parameters
paths:Sequence[str]Undocumented
options:OptionsUndocumented
fscache:Optional[FileSystemCache]Undocumented
allow​_empty​_dir:boolUndocumented
Returns
List[BuildSource]Undocumented
def get_explicit_package_bases(options): (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

Parameters
options:OptionsUndocumented
Returns
Optional[List[str]]Undocumented
def keyfunc(name): (source)

Determines sort order for directory listing.

The desirable properties are: 1) foo < foo.pyi < foo.py 2) __init__.py[i] < foo

Parameters
name:strUndocumented
Returns
Tuple[bool, int, str]Undocumented
def module_join(parent, child): (source)
Join module ids, accounting for a possibly empty parent.
Parameters
parent:strUndocumented
child:strUndocumented
Returns
strUndocumented
def normalise_package_base(root): (source)

Undocumented

Parameters
root:strUndocumented
Returns
strUndocumented
def strip_py(arg): (source)

Strip a trailing .py or .pyi suffix.

Return None if no such suffix is found.

Parameters
arg:strUndocumented
Returns
Optional[str]Undocumented
PY_EXTENSIONS = (source)

Undocumented

Value
tuple(PYTHON_EXTENSIONS)