mypy.reachability

module documentation

(source)

Utilities related to determining the reachability of code (in semantic analysis).

Class	`MarkImportsMypyOnlyVisitor`	Visitor that sets is_mypy_only (which affects priority).
Class	`MarkImportsUnreachableVisitor`	Visitor that flags all imports nested within a node as unreachable.
Function	`assert_will_always_fail`	Undocumented
Function	`consider_sys_platform`	Consider whether expr is a comparison involving sys.platform.
Function	`consider_sys_version_info`	Consider whether expr is a comparison involving sys.version_info.
Function	`contains_int_or_tuple_of_ints`	Undocumented
Function	`contains_sys_version_info`	Undocumented
Function	`fixed_comparison`	Undocumented
Function	`infer_condition_value`	Infer whether the given condition is always true/false.
Function	`infer_reachability_of_if_statement`	Undocumented
Function	`is_sys_attr`	Undocumented
Function	`mark_block_mypy_only`	Undocumented
Function	`mark_block_unreachable`	Undocumented
Constant	`ALWAYS_FALSE`	Undocumented
Constant	`ALWAYS_TRUE`	Undocumented
Constant	`inverted_truth_mapping`	Undocumented
Constant	`MYPY_FALSE`	Undocumented
Constant	`MYPY_TRUE`	Undocumented
Constant	`reverse_op`	Undocumented
Constant	`TRUTH_VALUE_UNKNOWN`	Undocumented
Variable	`Targ`	Undocumented

def assert_will_always_fail(s, options): (source)

Undocumented

Parameters
s:`AssertStmt`	Undocumented
options:`Options`	Undocumented
Returns
`bool`	Undocumented

def consider_sys_platform(expr, platform): (source)

Consider whether expr is a comparison involving sys.platform.

Return ALWAYS_TRUE, ALWAYS_FALSE, or TRUTH_VALUE_UNKNOWN.

Parameters
expr:`Expression`	Undocumented
platform:`str`	Undocumented
Returns
`int`	Undocumented

def consider_sys_version_info(expr, pyversion): (source)

Consider whether expr is a comparison involving sys.version_info.

Return ALWAYS_TRUE, ALWAYS_FALSE, or TRUTH_VALUE_UNKNOWN.

Parameters
expr:`Expression`	Undocumented
pyversion:`Tuple[int, ...]`	Undocumented
Returns
`int`	Undocumented

def contains_int_or_tuple_of_ints(expr): (source)

Undocumented

Parameters
expr:`Expression`	Undocumented
Returns
`Union[None, int, Tuple[int], Tuple[int, ...]]`	Undocumented

def contains_sys_version_info(expr): (source)

Undocumented

Parameters
expr:`Expression`	Undocumented
Returns
`Union[None, int, Tuple[Optional[int], Optional[int]]]`	Undocumented

def fixed_comparison(left, op, right): (source)

Undocumented

Parameters
left:`Targ`	Undocumented
op:`str`	Undocumented
right:`Targ`	Undocumented
Returns
`int`	Undocumented

def infer_condition_value(expr, options): (source)

Infer whether the given condition is always true/false.

Return ALWAYS_TRUE if always true, ALWAYS_FALSE if always false, MYPY_TRUE if true under mypy and false at runtime, MYPY_FALSE if false under mypy and true at runtime, else TRUTH_VALUE_UNKNOWN.

Parameters
expr:`Expression`	Undocumented
options:`Options`	Undocumented
Returns
`int`	Undocumented

def infer_reachability_of_if_statement(s, options): (source)

Undocumented

Parameters
s:`IfStmt`	Undocumented
options:`Options`	Undocumented

def is_sys_attr(expr, name): (source)

Undocumented

Parameters
expr:`Expression`	Undocumented
name:`str`	Undocumented
Returns
`bool`	Undocumented

def mark_block_mypy_only(block): (source)

Undocumented

Parameters
block:`Block`	Undocumented

def mark_block_unreachable(block): (source)

Undocumented

Parameters
block:`Block`	Undocumented

ALWAYS_FALSE: int = (source)

Undocumented

Value

ALWAYS_TRUE: int = (source)

Undocumented

Value

inverted_truth_mapping = (source)

Undocumented

Value

{ALWAYS_TRUE: ALWAYS_FALSE,
 ALWAYS_FALSE: ALWAYS_TRUE,
 TRUTH_VALUE_UNKNOWN: TRUTH_VALUE_UNKNOWN,
 MYPY_TRUE: MYPY_FALSE,
 MYPY_FALSE: MYPY_TRUE}

MYPY_FALSE: int = (source)

Undocumented

Value

MYPY_TRUE: int = (source)

Undocumented

Value

reverse_op: dict[str, str] = (source)

Undocumented

Value

{'==': '==', '!=': '!=', '<': '>', '>': '<', '<=': '>=', '>=': '<='}

TRUTH_VALUE_UNKNOWN: int = (source)

Undocumented

Value

Targ = (source)

Undocumented