Skip to content

Only exclude _version from top-level Import Linter contracts #1536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathanjmcdougall merged 2 commits into from
Mar 25, 2026
Merged

Only exclude _version from top-level Import Linter contracts #1536

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac8d8a5
Initial plan
Copilot Mar 25, 2026
78eff52
fix: only exclude _version from top-level Import Linter contracts, no…
Copilot Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/usethis/_integrations/project/imports.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,16 @@ def _get_module_layered_architecture(
# _version is typically auto-generated by VCS plugins (e.g. setuptools-scm,
# hatch-vcs) and should not participate in the layered architecture.
# Instead, it is excluded so it appears in exhaustive_ignores.
# Only exclude _version at the root package level, not in subpackages.
# Ref: https://github.com/usethis-python/usethis-python/issues/1423
_VERSION_MODULE = "_version"
for layer in layers:
if _VERSION_MODULE in layer:
layer.discard(_VERSION_MODULE)
excluded.add(_VERSION_MODULE)
layers = [layer for layer in layers if layer]
# Ref: https://github.com/usethis-python/usethis-python/issues/1432
if "." not in module:
_VERSION_MODULE = "_version"
for layer in layers:
if _VERSION_MODULE in layer:
layer.discard(_VERSION_MODULE)
excluded.add(_VERSION_MODULE)
layers = [layer for layer in layers if layer]

return LayeredArchitecture(
layers=list(reversed(layers)),
Expand Down
30 changes: 30 additions & 0 deletions tests/usethis/_integrations/project/test_imports.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,36 @@ def test_version_excluded_with_deps(
assert arch.layers == [{"a"}, {"b"}]
assert arch.excluded == {"_version"}

def test_version_not_excluded_in_submodule(
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
):
"""_version is not excluded from submodule layer contracts.

Only top-level packages should exclude _version, since VCS plugins
(e.g. setuptools-scm, hatch-vcs) only auto-generate it at the root.

Ref: https://github.com/usethis-python/usethis-python/issues/1432
"""
# Arrange
(tmp_path / "salut").mkdir()
(tmp_path / "salut" / "__init__.py").touch()
(tmp_path / "salut" / "b").mkdir()
(tmp_path / "salut" / "b" / "__init__.py").touch()
(tmp_path / "salut" / "b" / "c.py").touch()
(tmp_path / "salut" / "b" / "d.py").touch()
(tmp_path / "salut" / "b" / "_version.py").touch()

monkeypatch.syspath_prepend(str(tmp_path))

# Act
with change_cwd(tmp_path):
graph = _get_graph("salut")
arch = _get_module_layered_architecture("salut.b", graph=graph)

# Assert
assert arch.layers == [{"_version", "c", "d"}]
assert arch.excluded == set()


class TestGetChildDependencies:
def test_three(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
Expand Down
Loading