mypy.test.helpers

module documentation

(source)

Undocumented

Function	`assert_equal`	Undocumented
Function	`assert_module_equivalence`	Undocumented
Function	`assert_string_arrays_equal`	Assert that two string arrays are equal.
Function	`assert_target_equivalence`	Compare actual and expected targets (order sensitive).
Function	`assert_type`	Undocumented
Function	`check_test_output_files`	Undocumented
Function	`clean_up`	Remove common directory prefix from all strings in a.
Function	`good_repr`	Undocumented
Function	`local_sys_path_set`	Temporary insert current directory into sys.path.
Function	`normalize_error_messages`	Translate an array of error messages to use / as path separator.
Function	`normalize_file_output`	Normalize file output for comparison.
Function	`num_skipped_prefix_lines`	Undocumented
Function	`num_skipped_suffix_lines`	Undocumented
Function	`parse_options`	Parse comments like '# flags: --foo' in a test case.
Function	`perform_file_operations`	Undocumented
Function	`retry_on_error`	Retry callback with exponential backoff when it raises OSError.
Function	`run_mypy`	Undocumented
Function	`show_align_message`	Align s1 and s2 so that the their first difference is highlighted.
Function	`split_lines`	Returns a single list of string lines from the byte streams in args.
Function	`testcase_pyversion`	Undocumented
Function	`testfile_pyversion`	Undocumented
Function	`typename`	Undocumented
Function	`update_testcase_output`	Undocumented
Function	`write_and_fudge_mtime`	Undocumented
Constant	`MIN_LINE_LENGTH_FOR_ALIGNMENT`	Undocumented

def assert_equal(a, b, fmt='{} != {}'): (source)

Undocumented

Parameters
a:`object`	Undocumented
b:`object`	Undocumented
fmt:`str`	Undocumented

def assert_module_equivalence(name, expected, actual): (source)

Undocumented

Parameters
name:`str`	Undocumented
expected:`Iterable[str]`	Undocumented
actual:`Iterable[str]`	Undocumented

def assert_string_arrays_equal(expected, actual, msg): (source)

Assert that two string arrays are equal.

We consider "can't" and "cannot" equivalent, by replacing the former with the latter before comparing.

Display any differences in a human-readable form.

Parameters
expected:`List[str]`	Undocumented
actual:`List[str]`	Undocumented
msg:`str`	Undocumented

def assert_target_equivalence(name, expected, actual): (source)

Compare actual and expected targets (order sensitive).

Parameters
name:`str`	Undocumented
expected:`List[str]`	Undocumented
actual:`List[str]`	Undocumented

def assert_type(typ, value): (source)

Undocumented

Parameters
typ:`type`	Undocumented
value:`object`	Undocumented

def check_test_output_files(testcase, step, strip_prefix=''): (source)

Undocumented

Parameters
testcase:`DataDrivenTestCase`	Undocumented
step:`int`	Undocumented
strip_prefix:`str`	Undocumented

def clean_up(a): (source)

Remove common directory prefix from all strings in a.

This uses a naive string replace; it seems to work well enough. Also remove trailing carriage returns.

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

def good_repr(obj): (source)

Undocumented

Parameters
obj:`object`	Undocumented
Returns
`str`	Undocumented

@contextlib.contextmanager
def local_sys_path_set(): (source)

Temporary insert current directory into sys.path.

This can be used by test cases that do runtime imports, for example by the stubgen tests.

Returns
`Iterator[None]`	Undocumented

def normalize_error_messages(messages): (source)

Translate an array of error messages to use / as path separator.

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

def normalize_file_output(content, current_abs_path): (source)

Normalize file output for comparison.

Parameters
content:`List[str]`	Undocumented
current_abs_path:`str`	Undocumented
Returns
`List[str]`	Undocumented

def num_skipped_prefix_lines(a1, a2): (source)

Undocumented

Parameters
a1:`List[str]`	Undocumented
a2:`List[str]`	Undocumented
Returns
`int`	Undocumented

def num_skipped_suffix_lines(a1, a2): (source)

Undocumented

Parameters
a1:`List[str]`	Undocumented
a2:`List[str]`	Undocumented
Returns
`int`	Undocumented

def parse_options(program_text, testcase, incremental_step): (source)

Parse comments like '# flags: --foo' in a test case.

Parameters
program_text:`str`	Undocumented
testcase:`DataDrivenTestCase`	Undocumented
incremental_step:`int`	Undocumented
Returns
`Options`	Undocumented

def perform_file_operations(operations): (source)

Undocumented

Parameters
operations:`List[Union[UpdateFile, DeleteFile]]`	Undocumented

def retry_on_error(func, max_wait=1.0): (source)

Retry callback with exponential backoff when it raises OSError.

If the function still generates an error after max_wait seconds, propagate the exception.

This can be effective against random file system operation failures on Windows.

Parameters
func:`Callable[[], Any]`	Undocumented
max_wait:`float`	Undocumented

def run_mypy(args): (source)

Undocumented

Parameters
args:`List[str]`	Undocumented

def show_align_message(s1, s2): (source)

Align s1 and s2 so that the their first difference is highlighted.

For example, if s1 is 'foobar' and s2 is 'fobar', display the following lines:

E: foobar A: fobar

^

If s1 and s2 are long, only display a fragment of the strings around the first difference. If s1 is very short, do nothing.

Parameters
s1:`str`	Undocumented
s2:`str`	Undocumented

def split_lines(*streams): (source)

Returns a single list of string lines from the byte streams in args.

Parameters
*streams:`bytes`	Undocumented
Returns
`List[str]`	Undocumented

def testcase_pyversion(path, testcase_name): (source)

Undocumented

Parameters
path:`str`	Undocumented
testcase_name:`str`	Undocumented
Returns
`Tuple[int, int]`	Undocumented

def testfile_pyversion(path): (source)

Undocumented

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

def typename(t): (source)

Undocumented

Parameters
t:`type`	Undocumented
Returns
`str`	Undocumented

def update_testcase_output(testcase, output): (source)

Undocumented

Parameters
testcase:`DataDrivenTestCase`	Undocumented
output:`List[str]`	Undocumented

def write_and_fudge_mtime(content, target_path): (source)

Undocumented

Parameters
content:`str`	Undocumented
target_path:`str`	Undocumented

MIN_LINE_LENGTH_FOR_ALIGNMENT: int = (source)

Undocumented

Value