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.
amcmahon-rh · May 30, 2024 · 3db5922 · 3db5922
1 parent 4e0e306
commit 3db5922
Show file tree

Hide file tree

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

diff --git a/pubtools/_ami/__init__.py → src/pubtools/_ami/__init__.py b/pubtools/_ami/__init__.py → src/pubtools/_ami/__init__.py
diff --git a/pubtools/_ami/arguments.py → src/pubtools/_ami/arguments.py b/pubtools/_ami/arguments.py → src/pubtools/_ami/arguments.py
diff --git a/pubtools/_ami/rhsm.py → src/pubtools/_ami/rhsm.py b/pubtools/_ami/rhsm.py → src/pubtools/_ami/rhsm.py
diff --git a/pubtools/_ami/services/__init__.py → src/pubtools/_ami/services/__init__.py b/pubtools/_ami/services/__init__.py → src/pubtools/_ami/services/__init__.py
diff --git a/pubtools/_ami/services/aws.py → src/pubtools/_ami/services/aws.py b/pubtools/_ami/services/aws.py → src/pubtools/_ami/services/aws.py
diff --git a/pubtools/_ami/services/base.py → src/pubtools/_ami/services/base.py b/pubtools/_ami/services/base.py → src/pubtools/_ami/services/base.py
diff --git a/pubtools/_ami/services/collector.py → src/pubtools/_ami/services/collector.py b/pubtools/_ami/services/collector.py → src/pubtools/_ami/services/collector.py
diff --git a/pubtools/_ami/services/rhsm_.py → src/pubtools/_ami/services/rhsm_.py b/pubtools/_ami/services/rhsm_.py → src/pubtools/_ami/services/rhsm_.py
diff --git a/pubtools/_ami/step.py → src/pubtools/_ami/step.py b/pubtools/_ami/step.py → src/pubtools/_ami/step.py
diff --git a/pubtools/_ami/task.py → src/pubtools/_ami/task.py b/pubtools/_ami/task.py → src/pubtools/_ami/task.py
diff --git a/pubtools/_ami/tasks/__init__.py → src/pubtools/_ami/tasks/__init__.py b/pubtools/_ami/tasks/__init__.py → src/pubtools/_ami/tasks/__init__.py
diff --git a/pubtools/_ami/tasks/base.py → src/pubtools/_ami/tasks/base.py b/pubtools/_ami/tasks/base.py → src/pubtools/_ami/tasks/base.py
diff --git a/pubtools/_ami/tasks/delete.py → src/pubtools/_ami/tasks/delete.py b/pubtools/_ami/tasks/delete.py → src/pubtools/_ami/tasks/delete.py
diff --git a/pubtools/_ami/tasks/exceptions.py → src/pubtools/_ami/tasks/exceptions.py b/pubtools/_ami/tasks/exceptions.py → src/pubtools/_ami/tasks/exceptions.py
diff --git a/pubtools/_ami/tasks/push.py → src/pubtools/_ami/tasks/push.py b/pubtools/_ami/tasks/push.py → src/pubtools/_ami/tasks/push.py
diff --git a/tox.ini b/tox.ini
@@ -8,7 +8,7 @@ allowlist_externals=sh
 
 [testenv:static]
 commands=
-	sh -c 'pylint pubtools; test $(( $? & (1|2|4|32) )) = 0'
+	sh -c 'pylint src/pubtools; test $(( $? & (1|2|4|32) )) = 0'
 
 [testenv:pidiff]
 skip_install=true
@@ -17,7 +17,7 @@ commands=pidiff pubtools-ami .
 [testenv:cov]
 usedevelop=true
 commands=
-	pytest --cov-report=html --cov-report=xml --cov=pubtools {posargs}
+	pytest --cov-report=html --cov-report=xml --cov=src/pubtools {posargs}
 
 [testenv:docs]
 use_develop=true