structlint.logic

This is the documentation page for the module logic.

make_test_method(s: str) -> str

fix_dunder_filename(p: Path) -> Path

make_test_filename(p: Path, use_filename_suffix: bool = True) -> Path

make_doc_filename(p: Path) -> Path

make_test_method_path(p: Path, i: str, class_name: str, method_name: str, file_per_class: re.Pattern, file_per_directory: re.Pattern) -> str

make_doc_class_path(p: Path, i: str, class_name: str, file_per_class: re.Pattern, file_per_directory: re.Pattern) -> str

make_test_function_path(p: Path, i: str, function_name: str, file_per_directory: re.Pattern) -> str

make_doc_function_path(p: Path, i: str, function_name: str, file_per_directory: re.Pattern) -> str

map_to_test(s: str, cfg: Configuration) -> str

map_to_doc(s: str, cfg: Configuration) -> str

compute_disallowed(allowed: SetDict, disallowed: SetDict, allowed_everywhere: set[str], graph: grimp.ImportGraph) -> SetDict

get_disallowed_imports(icfg: ImportsConfig, module_name: str) -> tuple[SetDict, SetDict]

sort_methods(method_dict: dict[str, str], cfg: MethodsConfig) -> list[str]

analyze_discrepancies(expected: list[str], actual: list[str], allow_additional: re.Pattern) -> tuple[list[str], list[str], set[str]]