Configurations

It’s possible to configure unimport from pyproject.toml or setup.cfg files if you have.

Automatically pick up config options from setup.cfg if it is present in the project root else check and if it exists use pyproject.toml.

If you want you can disable this feature by passing --disable-auto-discovery-config or you can pass the path to the configuration file by passing --config path/to/pyproject.toml.

For example:

pyproject.toml

[tool.unimport]
sources = ["path1", "path2"]
exclude = '__init__.py|tests/'
include = 'test|test2|tests.py'
gitignore = true
remove = false
check = true
diff = true
include_star_import = true
ignore_init = true
jobs = 4

setup.cfg

[unimport]
sources = ["path1", "path2"]
exclude = __init__.py|tests/
include = test|test2|tests.py
gitignore = true
remove = false
check = true
diff = true
include_star_import = true
ignore_init = true
jobs = 4

Per-file ignores¶

Keep specific imports in specific files, while the rest of each file is still checked. Keys are file patterns: a pattern without / matches the file name in any directory (__init__.py), otherwise the path relative to the directory unimport runs in (src/*/conftest.py), also when the file is passed as an absolute path. Values are import-name patterns (fnmatch); matching imports are never reported or removed.

pyproject.toml

[tool.unimport]
per-file-ignores = { "__init__.py" = ["*"], "tests/conftest.py" = ["pytest_plugins", "fixtures.*"] }

setup.cfg

[unimport]
per-file-ignores =
    __init__.py: *
    tests/conftest.py: pytest_plugins, fixtures.*

Manage like CLI in configuration¶

[tool.unimport]
include-star-import = true
ignore-init = true

setup.cfg

[unimport]
include-star-import = true
ignore-init = true