mypy.config

module documentation

(source)

Undocumented

Class	`ConfigTOMLValueError`	Undocumented
Function	`check_follow_imports`	Undocumented
Function	`convert_to_boolean`	Return a boolean value translating from other types if necessary.
Function	`destructure_overrides`	Take the new [[tool.mypy.overrides]] section array in the pyproject.toml file, and convert it back to a flatter structure that the existing config_parser can handle.
Function	`expand_path`	Expand the user home directory and any environment variables contained within the provided path.
Function	`get_config_module_names`	Undocumented
Function	`get_prefix`	Undocumented
Function	`is_toml`	Undocumented
Function	`mypy_comments_to_config_map`	Rewrite the mypy comment syntax into ini file syntax.
Function	`parse_config_file`	Parse a config file into an Options object.
Function	`parse_mypy_comments`	Parse a collection of inline mypy: configuration comments.
Function	`parse_section`	Parse one section of a config file.
Function	`parse_version`	Undocumented
Function	`split_and_match_files`	Take a string representing a list of files/directories (with support for globbing through the glob library).
Function	`split_and_match_files_list`	Take a list of files/directories (with support for globbing through the glob library).
Function	`split_directive`	Split s on commas, except during quoted sections.
Function	`try_split`	Split and trim a str or list of str into a list of str
Constant	`ini_config_types`	Undocumented
Constant	`toml_config_types`	Undocumented
Constant	`_CONFIG_VALUE_TYPES`	Undocumented
Constant	`_INI_PARSER_CALLABLE`	Undocumented

def check_follow_imports(choice): (source)

Undocumented

Parameters
choice:`str`	Undocumented
Returns
`str`	Undocumented

def convert_to_boolean(value): (source)

Return a boolean value translating from other types if necessary.

Parameters
value:`Optional[Any]`	Undocumented
Returns
`bool`	Undocumented

def destructure_overrides(toml_data): (source)

Take the new [[tool.mypy.overrides]] section array in the pyproject.toml file, and convert it back to a flatter structure that the existing config_parser can handle.

E.g. the following pyproject.toml file:

[[tool.mypy.overrides]] module = [

"a.b", "b.*"

] disallow_untyped_defs = true

[[tool.mypy.overrides]] module = 'c' disallow_untyped_defs = false

Would map to the following config dict that it would have gotten from parsing an equivalent ini file:

{

"mypy-a.b": {

disallow_untyped_defs = true,

}, "mypy-b.*": {

disallow_untyped_defs = true,

}, "mypy-c": {

disallow_untyped_defs: false,

},

}

Parameters
toml_data:`Dict[str, Any]`	Undocumented
Returns
`Dict[str, Any]`	Undocumented

def expand_path(path): (source)

Expand the user home directory and any environment variables contained within the provided path.

Parameters
path:`str`	Undocumented
Returns
`str`	Undocumented

def get_config_module_names(filename, modules): (source)

Undocumented

Parameters
filename:`Optional[str]`	Undocumented
modules:`List[str]`	Undocumented
Returns
`str`	Undocumented

def get_prefix(file_read, name): (source)

Undocumented

Parameters
file_read:`str`	Undocumented
name:`str`	Undocumented
Returns
`str`	Undocumented

def is_toml(filename): (source)

Undocumented

Parameters
filename:`str`	Undocumented
Returns
`bool`	Undocumented

def mypy_comments_to_config_map(line, template): (source)

Rewrite the mypy comment syntax into ini file syntax.

Returns

Parameters
line:`str`	Undocumented
template:`Options`	Undocumented
Returns
`Tuple[Dict[str, str], List[str]]`	Undocumented

def parse_config_file(options, set_strict_flags, filename, stdout=None, stderr=None): (source)

Parse a config file into an Options object.

Errors are written to stderr but are not fatal.

If filename is None, fall back to default config files.

Parameters
options:`Options`	Undocumented
set_strict_flags:`Callable[[], None]`	Undocumented
filename:`Optional[str]`	Undocumented
stdout:`Optional[TextIO]`	Undocumented
stderr:`Optional[TextIO]`	Undocumented

def parse_mypy_comments(args, template): (source)

Parse a collection of inline mypy: configuration comments.

Returns a dictionary of options to be applied and a list of error messages generated.

Parameters
args:`List[Tuple[int, str]]`	Undocumented
template:`Options`	Undocumented
Returns
`Tuple[Dict[str, object], List[Tuple[int, str]]]`	Undocumented

def parse_section(prefix, template, set_strict_flags, section, config_types, stderr=sys.stderr): (source)

Parse one section of a config file.

Returns a dict of option values encountered, and a dict of report directories.

Parameters
prefix:`str`	Undocumented
template:`Options`	Undocumented
set_strict_flags:`Callable[[], None]`	Undocumented
section:`Mapping[str, Any]`	Undocumented
config_types:`Dict[str, Any]`	Undocumented
stderr:`TextIO`	Undocumented
Returns
`Tuple[Dict[str, object], Dict[str, str]]`	Undocumented

def parse_version(v): (source)

Undocumented

Parameters
v:`str`	Undocumented
Returns
`Tuple[int, int]`	Undocumented

def split_and_match_files(paths): (source)

Take a string representing a list of files/directories (with support for globbing through the glob library).

Where a path/glob matches no file, we still include the raw path in the resulting list.

Returns a list of file paths

Parameters
paths:`str`	Undocumented
Returns
`List[str]`	Undocumented

def split_and_match_files_list(paths): (source)

Take a list of files/directories (with support for globbing through the glob library).

Where a path/glob matches no file, we still include the raw path in the resulting list.

Returns a list of file paths

Parameters
paths:`Sequence[str]`	Undocumented
Returns
`List[str]`	Undocumented

def split_directive(s): (source)

Split s on commas, except during quoted sections.

Returns the parts and a list of error messages.

Parameters
s:`str`	Undocumented
Returns
`Tuple[List[str], List[str]]`	Undocumented

def try_split(v, split_regex='[,]'): (source)

Split and trim a str or list of str into a list of str

Parameters
v:`Union[str, Sequence[str]]`	Undocumented
split_regex:`str`	Undocumented
Returns
`List[str]`	Undocumented

ini_config_types: Dict[str, _INI_PARSER_CALLABLE] = (source)

Undocumented

Value

{'python_version': parse_version,
 'strict_optional_whitelist': (lambda s: s.split()),
 'custom_typing_module': str,
 'custom_typeshed_dir': expand_path,
 'mypy_path': (lambda s: [expand_path(p.strip()) for p in re.split('[,:]', s)]),
 'files': split_and_match_files,
 'quickstart_file': expand_path,
...

toml_config_types: Dict[str, _INI_PARSER_CALLABLE] = (source)

Undocumented

Value

ini_config_types.copy()

_CONFIG_VALUE_TYPES: _TypeAlias = (source)

Undocumented

Value

Union[str, bool, int, float, Dict[str, str], List[str], Tuple[int, int]]

_INI_PARSER_CALLABLE: _TypeAlias = (source)

Undocumented

Value

Callable[[Any], _CONFIG_VALUE_TYPES]

mypy.config_parser

`mypy.config_parser`