Use pubtools namespace to resolve init file conflict [RHELDST-17607]

Currently, there's an issue with packaging where most of the pubtool-<lib> projects contains __init__.py and other stuff which is supposed to belong only to pubtools. Python namespaces are a convenient way to work around this issue.
release-engineering · May 30, 2024 · ec581e7 · ec581e7
1 parent f434506
commit ec581e7
Show file tree

Hide file tree

Showing 10 changed files with 6 additions and 6 deletions.
diff --git a/pubtools/exodus/__init__.py b/pubtools/exodus/__init__.py
diff --git a/setup.py b/setup.py
@@ -1,4 +1,4 @@
-from setuptools import find_packages, setup
+from setuptools import find_namespace_packages, setup
 
 
 def get_description():
@@ -22,7 +22,8 @@ def get_requirements():
 setup(
     name="pubtools-exodus",
     version="1.5.1",
-    packages=find_packages(exclude=["tests"]),
+    packages=find_namespace_packages(where="src"),
+    package_dir={"": "src"},
     include_package_data=True,
     url="https://github.com/release-engineering/pubtools-exodus",
     license="GNU General Public License",

diff --git a/pubtools/__init__.py → src/pubtools/exodus/__init__.py b/pubtools/__init__.py → src/pubtools/exodus/__init__.py
diff --git a/pubtools/exodus/_hooks/__init__.py → src/pubtools/exodus/_hooks/__init__.py b/pubtools/exodus/_hooks/__init__.py → src/pubtools/exodus/_hooks/__init__.py
diff --git a/pubtools/exodus/_hooks/pulp.py → src/pubtools/exodus/_hooks/pulp.py b/pubtools/exodus/_hooks/pulp.py → src/pubtools/exodus/_hooks/pulp.py
diff --git a/pubtools/exodus/_tasks/__init__.py → src/pubtools/exodus/_tasks/__init__.py b/pubtools/exodus/_tasks/__init__.py → src/pubtools/exodus/_tasks/__init__.py
diff --git a/pubtools/exodus/_tasks/push.py → src/pubtools/exodus/_tasks/push.py b/pubtools/exodus/_tasks/push.py → src/pubtools/exodus/_tasks/push.py
diff --git a/pubtools/exodus/gateway.py → src/pubtools/exodus/gateway.py b/pubtools/exodus/gateway.py → src/pubtools/exodus/gateway.py
diff --git a/pubtools/exodus/task.py → src/pubtools/exodus/task.py b/pubtools/exodus/task.py → src/pubtools/exodus/task.py
diff --git a/tox.ini b/tox.ini
@@ -10,20 +10,20 @@ allowlist_externals=sh
 
 [testenv:static]
 commands=
-	sh -c 'pylint pubtools; test $(( $? & (1|2|4|32) )) = 0'
+	sh -c 'pylint src/pubtools/exodus; test $(( $? & (1|2|4|32) )) = 0'
 	black --check .
 	isort --check .
 
 [testenv:cov]
 usedevelop=true
 commands=
-	pytest --cov-report=html --cov=pubtools {posargs}
+	pytest --cov-report=html --cov=pubtools.exodus {posargs}
 
 [testenv:cov-ci]
 passenv=GITHUB_*
 usedevelop=true
 commands=
-	pytest --cov=pubtools {posargs}
+	pytest --cov=pubtools.exodus {posargs}
 	coveralls --service=github
 
 [testenv:docs]