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 · cdbd62a · cdbd62a
1 parent 2e108a1
commit cdbd62a
Show file tree

Hide file tree

Showing 9 changed files with 4 additions and 3 deletions.
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():
@@ -24,7 +24,8 @@ def get_requirements():
 setup(
     name="pubtools",
     version="1.4.0",
-    packages=find_packages(exclude=["tests"]),
+    packages=find_namespace_packages(where="src"),
+    package_dir={"": "src"},
     url="https://github.com/release-engineering/pubtools",
     license="GNU General Public License",
     description=get_description(),

diff --git a/pubtools/__init__.py → src/pubtools/__init__.py b/pubtools/__init__.py → src/pubtools/__init__.py
diff --git a/pubtools/_impl/__init__.py → src/pubtools/_impl/__init__.py b/pubtools/_impl/__init__.py → src/pubtools/_impl/__init__.py
diff --git a/pubtools/_impl/mallopt.py → src/pubtools/_impl/mallopt.py b/pubtools/_impl/mallopt.py → src/pubtools/_impl/mallopt.py
diff --git a/pubtools/_impl/pluggy.py → src/pubtools/_impl/pluggy.py b/pubtools/_impl/pluggy.py → src/pubtools/_impl/pluggy.py
diff --git a/pubtools/_impl/tracing.py → src/pubtools/_impl/tracing.py b/pubtools/_impl/tracing.py → src/pubtools/_impl/tracing.py
diff --git a/pubtools/pluggy.py → src/pubtools/pluggy.py b/pubtools/pluggy.py → src/pubtools/pluggy.py
diff --git a/pubtools/tracing.py → src/pubtools/tracing.py b/pubtools/tracing.py → src/pubtools/tracing.py
diff --git a/tox.ini b/tox.ini
@@ -9,7 +9,7 @@ whitelist_externals=sh
 [testenv:cov]
 usedevelop=true
 commands=
-	pytest --cov-report=xml --cov=pubtools {posargs}
+	pytest --cov-report=xml --cov=src/pubtools {posargs}
 
 [testenv:docs]
 deps=