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

…263) 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 · Jun 10, 2024 · be58349 · be58349
1 parent 9b72070
commit be58349
Show file tree

Hide file tree

Showing 30 changed files with 9 additions and 9 deletions.
diff --git a/pubtools/__init__.py b/pubtools/__init__.py
diff --git a/setup.py b/setup.py
@@ -8,7 +8,7 @@
 
 # import pkg_resources
 import sys
-from setuptools import setup, find_packages
+from setuptools import setup, find_namespace_packages
 from setuptools.command.test import test as TestCommand
 
 
@@ -122,7 +122,8 @@ def get_dependency_links():
     url="https://github.com/release-engineering/pubtools-quay",
     classifiers=classifiers,
     python_requires=">=3.6",
-    packages=find_packages(exclude=["tests"]),
+    packages=find_namespace_packages(where="src"),
+    package_dir={"": "src"},
     data_files=[],
     install_requires=get_requirements(),
     dependency_links=get_dependency_links(),

diff --git a/pubtools/_quay/__init__.py → src/pubtools/_quay/__init__.py b/pubtools/_quay/__init__.py → src/pubtools/_quay/__init__.py
diff --git a/pubtools/_quay/clear_repo.py → src/pubtools/_quay/clear_repo.py b/pubtools/_quay/clear_repo.py → src/pubtools/_quay/clear_repo.py
diff --git a/pubtools/_quay/command_executor.py → src/pubtools/_quay/command_executor.py b/pubtools/_quay/command_executor.py → src/pubtools/_quay/command_executor.py
diff --git a/pubtools/_quay/container_image_pusher.py → src/pubtools/_quay/container_image_pusher.py b/pubtools/_quay/container_image_pusher.py → src/pubtools/_quay/container_image_pusher.py
diff --git a/pubtools/_quay/exceptions.py → src/pubtools/_quay/exceptions.py b/pubtools/_quay/exceptions.py → src/pubtools/_quay/exceptions.py
diff --git a/pubtools/_quay/hooks.py → src/pubtools/_quay/hooks.py b/pubtools/_quay/hooks.py → src/pubtools/_quay/hooks.py
diff --git a/pubtools/_quay/iib_operations.py → src/pubtools/_quay/iib_operations.py b/pubtools/_quay/iib_operations.py → src/pubtools/_quay/iib_operations.py
diff --git a/pubtools/_quay/image_untagger.py → src/pubtools/_quay/image_untagger.py b/pubtools/_quay/image_untagger.py → src/pubtools/_quay/image_untagger.py
diff --git a/pubtools/_quay/item_processor.py → src/pubtools/_quay/item_processor.py b/pubtools/_quay/item_processor.py → src/pubtools/_quay/item_processor.py
diff --git a/pubtools/_quay/manifest_claims_handler.py → ...pubtools/_quay/manifest_claims_handler.py b/pubtools/_quay/manifest_claims_handler.py → ...pubtools/_quay/manifest_claims_handler.py
diff --git a/pubtools/_quay/manifest_list_merger.py → src/pubtools/_quay/manifest_list_merger.py b/pubtools/_quay/manifest_list_merger.py → src/pubtools/_quay/manifest_list_merger.py
diff --git a/pubtools/_quay/merge_manifest_list.py → src/pubtools/_quay/merge_manifest_list.py b/pubtools/_quay/merge_manifest_list.py → src/pubtools/_quay/merge_manifest_list.py
diff --git a/pubtools/_quay/models.py → src/pubtools/_quay/models.py b/pubtools/_quay/models.py → src/pubtools/_quay/models.py
diff --git a/pubtools/_quay/operator_pusher.py → src/pubtools/_quay/operator_pusher.py b/pubtools/_quay/operator_pusher.py → src/pubtools/_quay/operator_pusher.py
diff --git a/pubtools/_quay/push_docker.py → src/pubtools/_quay/push_docker.py b/pubtools/_quay/push_docker.py → src/pubtools/_quay/push_docker.py
diff --git a/pubtools/_quay/quay_api_client.py → src/pubtools/_quay/quay_api_client.py b/pubtools/_quay/quay_api_client.py → src/pubtools/_quay/quay_api_client.py
diff --git a/pubtools/_quay/quay_client.py → src/pubtools/_quay/quay_client.py b/pubtools/_quay/quay_client.py → src/pubtools/_quay/quay_client.py
diff --git a/pubtools/_quay/quay_session.py → src/pubtools/_quay/quay_session.py b/pubtools/_quay/quay_session.py → src/pubtools/_quay/quay_session.py
diff --git a/pubtools/_quay/remove_repo.py → src/pubtools/_quay/remove_repo.py b/pubtools/_quay/remove_repo.py → src/pubtools/_quay/remove_repo.py
diff --git a/pubtools/_quay/security_manifest_pusher.py → ...ubtools/_quay/security_manifest_pusher.py b/pubtools/_quay/security_manifest_pusher.py → ...ubtools/_quay/security_manifest_pusher.py
diff --git a/pubtools/_quay/signer_wrapper.py → src/pubtools/_quay/signer_wrapper.py b/pubtools/_quay/signer_wrapper.py → src/pubtools/_quay/signer_wrapper.py
diff --git a/pubtools/_quay/tag_docker.py → src/pubtools/_quay/tag_docker.py b/pubtools/_quay/tag_docker.py → src/pubtools/_quay/tag_docker.py
diff --git a/pubtools/_quay/tag_images.py → src/pubtools/_quay/tag_images.py b/pubtools/_quay/tag_images.py → src/pubtools/_quay/tag_images.py
diff --git a/pubtools/_quay/types.py → src/pubtools/_quay/types.py b/pubtools/_quay/types.py → src/pubtools/_quay/types.py
diff --git a/pubtools/_quay/untag_images.py → src/pubtools/_quay/untag_images.py b/pubtools/_quay/untag_images.py → src/pubtools/_quay/untag_images.py
diff --git a/pubtools/_quay/utils/__init__.py → src/pubtools/_quay/utils/__init__.py b/pubtools/_quay/utils/__init__.py → src/pubtools/_quay/utils/__init__.py
diff --git a/pubtools/_quay/utils/misc.py → src/pubtools/_quay/utils/misc.py b/pubtools/_quay/utils/misc.py → src/pubtools/_quay/utils/misc.py
diff --git a/tox.ini b/tox.ini
@@ -7,7 +7,7 @@ deps=
     -rrequirements-test.txt
 commands=
     pytest -vv \
-        --cov-config .coveragerc --cov=pubtools --cov-report term \
+        --cov-config .coveragerc --cov=pubtools._quay --cov-report term \
         --cov-report xml --cov-report html {posargs}
 whitelist_externals=sh
 
@@ -17,15 +17,15 @@ basepython = python3
 deps =
     black
 commands =
-    black -l 100 --check --diff pubtools tests
+    black -l 100 --check --diff src/pubtools tests
 
 [testenv:black-format]
 description = apply black formatting
 basepython = python3
 deps =
     black
 commands =
-    black -l 100 pubtools tests
+    black -l 100 src/pubtools tests
 
 [testenv:docs]
 basepython = python3
@@ -44,7 +44,7 @@ deps =
     flake8
     flake8-docstrings
 commands =
-    flake8 pubtools tests
+    flake8 src/pubtools tests
 
 [testenv:mypy]
 description = mypy checks
@@ -53,7 +53,7 @@ deps =
     -rrequirements-test.txt
     -rrequirements.txt
 commands =
-    mypy pubtools/_quay
+    mypy src/pubtools/_quay
 
 [testenv:py3-bandit]
 deps=
@@ -67,4 +67,4 @@ max-line-length = 100
 per-file-ignores =
     tests/*:D103
     # "D401 First line should be in imperative mood" -> hooks are not like typical functions
-    pubtools/_quay/hooks.py:D401
+    src/pubtools/_quay/hooks.py:D401