def test_config_cfg_merge(): sources = [Path("path1"), Path("path2")] config = Config(config_file=setup_cfg).parse() console_configuration = { "include": "tests|env", "remove": True, "diff": False, "include_star_import": True, } gitignore_exclude = utils.get_exclude_list_from_gitignore() exclude = "|".join( [config.exclude] + gitignore_exclude + [C.INIT_FILE_IGNORE_REGEX] ) config = config.merge(**console_configuration) assert config.include == "tests|env" assert config.exclude == exclude assert config.sources == sources assert config.gitignore is True assert config.requirements is True assert config.remove is True assert config.diff is False assert config.ignore_init is True
def test_toml_command_check(): config = Config(pyproject).parse() assert config.merge(check=True).check is True assert config.merge(diff=False).check is True assert config.merge(diff=False, permission=False).check is True assert config.merge().check is False assert config.merge(gitignore=True).check is False assert config.merge(diff=True).check is False assert config.merge(remove=True).check is False assert config.merge(permission=True).check is False
def test_cfg_parse(self): config = Config(config_file=setup_cfg).parse() self.assertEqual(self.include, config.include) self.assertEqual(self.exclude, config.exclude) self.assertEqual(self.sources, config.sources) self.assertTrue(config.gitignore) self.assertTrue(config.requirements) self.assertFalse(config.remove) self.assertTrue(config.diff)
def test_toml_parse(self): config = Config(config_file=no_unimport_pyproject).parse() self.assertEqual(self.default_config.include, config.include) self.assertEqual(self.default_config.exclude, config.exclude) self.assertEqual(self.default_config.sources, config.sources) self.assertFalse(config.gitignore) self.assertFalse(config.requirements) self.assertFalse(config.remove) self.assertFalse(config.diff)
def test_cfg_merge(self): config = Config(config_file=setup_cfg).parse() console_configuration = { "include": "tests|env", "remove": True, "diff": False, "include_star_import": True, } gitignore_exclude = utils.get_exclude_list_from_gitignore() gitignore_exclude.extend(config.exclude) exclude = "|".join(gitignore_exclude) config = config.merge(**console_configuration) self.assertEqual("tests|env", config.include) self.assertEqual(exclude, config.exclude) self.assertEqual(self.sources, config.sources) self.assertTrue(config.gitignore) self.assertTrue(config.requirements) self.assertTrue(config.remove) self.assertFalse(config.diff)
def test_cfg_merge(self): config = Config(config_file=no_unimport_setup_cfg).parse() console_configuration = { "include": "tests|env", "remove": True, "diff": False, "include_star_import": True, } config = config.merge(**console_configuration) self.assertEqual("tests|env", config.include) self.assertEqual(self.default_config.exclude, config.exclude) self.assertEqual(self.default_config.sources, config.sources) self.assertTrue(config.remove) self.assertTrue(config.include_star_import) self.assertFalse(config.gitignore) self.assertFalse(config.requirements) self.assertFalse(config.diff)
def __init__(self, config_file: Optional[Path] = None, *, include_star_import: bool = False, show_error: bool = False) -> None: self.show_error = show_error self.config = (Config(config_file) if config_file and config_file.name in CONFIG_FILES else Config) self.scanner = Scanner(include_star_import=include_star_import, show_error=self.show_error)
def test_no_import_section_cfg_merge(): default_config = DefaultConfig() config = Config(config_file=no_unimport_setup_cfg).parse() console_configuration = { "include": "tests|env", "remove": True, "diff": False, "include_star_import": True, } config = config.merge(**console_configuration) assert config.include == "tests|env" assert default_config.exclude == config.exclude assert default_config.sources == config.sources assert config.remove is True assert config.include_star_import is True assert config.gitignore is False assert config.requirements is False assert config.diff is False
def test_no_import_section_cfg_parse(): default_config = DefaultConfig() config = Config(config_file=no_unimport_setup_cfg).parse() assert default_config.include == config.include assert default_config.exclude == config.exclude assert default_config.sources == config.sources assert config.gitignore is False assert config.requirements is False assert config.remove is False assert config.diff is False assert config.ignore_init is False
class TestTomlCommand(TestCase): def setUp(self): self.config = Config(pyproject).parse() self.exclude = "__init__.py|tests/" def test_same_with_toml_config(self): self.assertEqual( self.config.merge(exclude=self.exclude).exclude, self.config.merge().exclude, ) def test_check(self): self.assertTrue(self.config.merge(check=True).check) self.assertTrue(self.config.merge(diff=False).check) self.assertTrue(self.config.merge(diff=False, permission=False).check) self.assertFalse(self.config.merge().check) self.assertFalse(self.config.merge(gitignore=True).check) self.assertFalse(self.config.merge(diff=True).check) self.assertFalse(self.config.merge(remove=True).check) self.assertFalse(self.config.merge(permission=True).check)
def test_config_cfg_parse(): include = "test|test2|tests.py" exclude = "__init__.py|tests/" sources = [Path("path1"), Path("path2")] config = Config(config_file=setup_cfg).parse() assert include == config.include assert exclude == config.exclude assert sources == config.sources assert config.gitignore is True assert config.requirements is True assert config.diff is True assert config.ignore_init is True assert config.remove is False
def main(argv: Optional[Sequence[str]] = None) -> int: parser = argparse.ArgumentParser( prog="unimport", description=C.DESCRIPTION, epilog="Get rid of all unused imports 🥳", ) exclusive_group = parser.add_mutually_exclusive_group(required=False) parser.add_argument( "sources", default=default_config.sources, nargs="*", help="Files and folders to find the unused imports.", action="store", type=Path, ) parser.add_argument( "--check", action="store_true", help="Prints which file the unused imports are in.", default=default_config.check, ) parser.add_argument( "-c", "--config", default=".", help="Read configuration from PATH.", metavar="PATH", action="store", type=Path, ) parser.add_argument( "--include", help="File include pattern.", metavar="include", action="store", default=default_config.include, type=str, ) parser.add_argument( "--exclude", help="File exclude pattern.", metavar="exclude", action="store", default=default_config.exclude, type=str, ) parser.add_argument( "--gitignore", action="store_true", help="Exclude .gitignore patterns. if present.", default=default_config.gitignore, ) parser.add_argument( "--ignore-init", action="store_true", help="Ignore the __init__.py file.", default=default_config.ignore_init, ) parser.add_argument( "--include-star-import", action="store_true", help="Include star imports during scanning and refactor.", default=default_config.include_star_import, ) parser.add_argument( "-d", "--diff", action="store_true", help="Prints a diff of all the changes unimport would make to a file.", default=default_config.diff, ) exclusive_group.add_argument( "-r", "--remove", action="store_true", help="Remove unused imports automatically.", default=default_config.remove, ) exclusive_group.add_argument( "-p", "--permission", action="store_true", help="Refactor permission after see diff.", default=default_config.permission, ) parser.add_argument( "--requirements", action="store_true", help= "Include requirements.txt file, You can use it with all other arguments", default=default_config.requirements, ) parser.add_argument( "-v", "--version", action="version", version=f"Unimport {C.VERSION}", help="Prints version of unimport", ) argv = argv if argv is not None else sys.argv[1:] args = parser.parse_args(argv) config = (Config(args.config).parse() if args.config and args.config.name in CONFIG_FILES else default_config) config = config.merge(**vars(args)) unused_modules = set() used_packages: Set[str] = set() for source_path in config.sources: for py_path in utils.list_paths(source_path, config.include, config.exclude): source, encoding = utils.read(py_path) analyzer = Analyzer( source=source, path=py_path, include_star_import=config.include_star_import, ) analyzer.traverse() unused_imports = list(analyzer.get_unused_imports()) unused_modules.update({imp.name for imp in unused_imports}) used_packages.update( utils.get_used_packages(analyzer.imports, unused_imports)) if config.check: for imp in unused_imports: if (isinstance(imp, ImportFrom) and imp.star and imp.suggestions): context = (color.paint( f"from {imp.name} import *", color.RED ) + " -> " + color.paint( f"from {imp.name} import {', '.join(imp.suggestions)}", color.GREEN, )) else: context = color.paint(imp.name, color.YELLOW) print(context + " at " + color.paint(py_path.as_posix(), color.GREEN) + ":" + color.paint(str(imp.lineno), color.GREEN)) if any((config.diff, config.remove)): refactor_result = refactor_string( source=source, unused_imports=unused_imports, ) if config.diff: diff = utils.diff( source=source, refactor_result=refactor_result, fromfile=py_path, ) exists_diff = bool(diff) if exists_diff: print(color.difference(diff)) if config.permission and exists_diff: action = input( f"Apply suggested changes to '{color.paint(str(py_path), color.YELLOW)}' [Y/n/q] ? >" ).lower() if action == "q": return 1 elif utils.actiontobool(action): config = config._replace(remove=True) if config.remove and source != refactor_result: py_path.write_text(refactor_result, encoding=encoding) print( f"Refactoring '{color.paint(str(py_path), color.GREEN)}'") analyzer.clear() if not unused_modules and config.check: print( color.paint( "✨ Congratulations there is no unused import in your project. ✨", color.GREEN, )) if config.requirements: for requirements in Path(".").glob("requirements*.txt"): source = requirements.read_text() copy_source = source.splitlines().copy() for index, requirement in enumerate(source.splitlines()): module_name = utils.package_name_from_metadata( requirement.split("==")[0]) if module_name is None: print(color.paint(requirement + " not found", color.RED)) continue if module_name not in used_packages: copy_source.remove(requirement) if config.check: print( f"{color.paint(requirement, color.CYAN)} at " f"{color.paint(requirements.as_posix(), color.CYAN)}:{color.paint(str(index + 1), color.CYAN)}" ) refactor_result = "\n".join(copy_source) if config.diff: diff = utils.diff( source=source, refactor_result=refactor_result, fromfile=requirements, ) exists_diff = bool(diff) if exists_diff: print(color.difference(diff)) if config.permission and exists_diff: action = input( f"Apply suggested changes to '{color.paint(requirements.as_posix(), color.CYAN)}' [Y/n/q] ? >" ).lower() if action == "q": return 1 if utils.actiontobool(action): config = config._replace(remove=True) if config.remove: requirements.write_text(refactor_result) print( f"Refactoring '{color.paint(requirements.as_posix(), color.CYAN)}'" ) if unused_modules: return 1 else: return 0
def __init__(self, config_file=None, include_star_import=False): self.config = Config(config_file) self.scanner = Scanner(include_star_import=include_star_import)
def test_toml_command_same_with_config(): config = Config(pyproject).parse() exclude = "__init__.py|tests/" assert config.merge(exclude=exclude).exclude == config.merge().exclude
def main(argv: Optional[Sequence[str]] = None) -> int: parser = argparse.ArgumentParser( prog="unimport", description=C.DESCRIPTION, epilog=f"Get rid of all unused imports {emoji.PARTYING_FACE}", ) exclusive_group = parser.add_mutually_exclusive_group(required=False) options.add_sources_option(parser) options.add_check_option(parser) options.add_config_option(parser) color.add_color_option(parser) options.add_include_option(parser) options.add_exclude_option(parser) options.add_gitignore_option(parser) options.add_ignore_init_option(parser) options.add_include_star_import_option(parser) options.add_diff_option(parser) options.add_remove_option(exclusive_group) options.add_permission_option(exclusive_group) options.add_requirements_option(parser) options.add_version_option(parser) argv = argv if argv is not None else sys.argv[1:] args = parser.parse_args(argv) config = Config.get_config(args) unused_modules = set() used_packages: Set[str] = set() for path in config.get_paths(): source, encoding, newline = utils.read(path) with Analyzer( source=source, path=path, include_star_import=config.include_star_import, ): unused_imports = list( Import.get_unused_imports(config.include_star_import) ) unused_modules.update({imp.name for imp in unused_imports}) used_packages.update( utils.get_used_packages(Import.imports, unused_imports) ) if config.check: commands.check(path, unused_imports, args.color) if any((config.diff, config.remove)): refactor_result = refactor_string( source=source, unused_imports=unused_imports, ) if config.diff: exists_diff = commands.diff(path, source, refactor_result) if config.permission and exists_diff: commands.permission( path, encoding, newline, refactor_result, args.color ) if config.remove and source != refactor_result: commands.remove( path, encoding, newline, refactor_result, args.color ) if not unused_modules and config.check: print( color.paint( f"{emoji.STAR} Congratulations there is no unused import in your project. {emoji.STAR}", color.GREEN, args.color, ) ) if config.requirements: for path in config.get_requirements(): source = path.read_text() copy_source = source.splitlines().copy() for index, requirement in enumerate(source.splitlines()): module_name = utils.package_name_from_metadata( requirement.split("==")[0] ) if module_name is None: print( color.paint( requirement + " not found", color.RED, args.color ) ) continue if module_name not in used_packages: copy_source.remove(requirement) if config.check: commands.requirements_check( path, index, requirement, args.color ) refactor_result = "\n".join(copy_source) if config.diff: exists_diff = commands.diff(path, source, refactor_result) if config.permission and exists_diff: commands.requirements_permission( path, refactor_result, args.color ) if config.remove and source != refactor_result: commands.requirements_remove( path, refactor_result, args.color ) if unused_modules: return 1 else: return 0
def setUp(self): self.config = Config(pyproject).parse() self.exclude = "__init__.py|tests/"