pubtools-pyxis 1.3.4__tar.gz → 1.3.6__tar.gz

{pubtools-pyxis-1.3.4/pubtools_pyxis.egg-info → pubtools_pyxis-1.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pubtools-pyxis
-Version: 1.3.4
+Version: 1.3.6
 Summary: Pubtools-pyxis
 Home-page: https://github.com/release-engineering/pubtools-pyxis
 Author: Lubomir Gallovic
@@ -15,8 +15,25 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.6
 Description-Content-Type: text/x-rst
-Provides-Extra: reST
 License-File: LICENSE
+Requires-Dist: setuptools
+Requires-Dist: more-executors>=2.3.0
+Requires-Dist: requests
+Requires-Dist: requests-kerberos
+Requires-Dist: urllib3<2
+Provides-Extra: rest
+Requires-Dist: Sphinx; extra == "rest"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ===============
  pubtools-pyxis
@@ -128,6 +145,17 @@ Get signatures:
 ChangeLog
 =========
 
+1.3.6 (2025-03-06)
+------------------
+
+* Splitted entrypoitnts to `console_scripts` and `mod`.
+
+
+1.3.5 (2023-03-14)
+------------------
+
+* Delete signatures in parallel
+
 1.3.4 (2023-03-01)
 ------------------
 

{pubtools-pyxis-1.3.4 → pubtools_pyxis-1.3.6}/docs/source/CHANGELOG.rst

@@ -1,6 +1,17 @@
 ChangeLog
 =========
 
+1.3.6 (2025-03-06)
+------------------
+
+* Splitted entrypoitnts to `console_scripts` and `mod`.
+
+
+1.3.5 (2023-03-14)
+------------------
+
+* Delete signatures in parallel
+
 1.3.4 (2023-03-01)
 ------------------
 

pubtools_pyxis-1.3.6/requirements-test.txt

@@ -0,0 +1,8 @@
+mock
+requests-mock
+pytest
+pytest-pylint
+pytest-cov
+bandit==1.7.5
+mypy
+types-requests

{pubtools-pyxis-1.3.4 → pubtools_pyxis-1.3.6}/requirements.txt

@@ -2,3 +2,4 @@ setuptools
 more-executors>=2.3.0
 requests
 requests-kerberos
+urllib3<2

{pubtools-pyxis-1.3.4 → pubtools_pyxis-1.3.6}/setup.py

@@ -7,7 +7,7 @@ import sys
 
 # 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
 
 
@@ -71,7 +71,7 @@ if os.environ.get("READTHEDOCS", None):
 
 setup(
     name="pubtools-pyxis",
-    version="1.3.4",
+    version="1.3.6",
     description="Pubtools-pyxis",
     long_description=long_description,
     long_description_content_type='text/x-rst',
@@ -80,7 +80,8 @@ setup(
     url="https://github.com/release-engineering/pubtools-pyxis",
     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=DEPENDENCY_LINKS,
@@ -91,6 +92,13 @@ setup(
             "pubtools-pyxis-upload-signatures = pubtools._pyxis.pyxis_ops:upload_signatures_main",
             "pubtools-pyxis-get-signatures = pubtools._pyxis.pyxis_ops:get_signatures_main",
             "pubtools-pyxis-delete-signatures = pubtools._pyxis.pyxis_ops:delete_signatures_main"
+        ],
+        "mod": [
+            "pubtools-pyxis-get-operator-indices = pubtools._pyxis.pyxis_ops:get_operator_indices_mod",
+            "pubtools-pyxis-get-repo-metadata = pubtools._pyxis.pyxis_ops:get_repo_metadata_mod",
+            "pubtools-pyxis-upload-signatures = pubtools._pyxis.pyxis_ops:upload_signatures_mod",
+            "pubtools-pyxis-get-signatures = pubtools._pyxis.pyxis_ops:get_signatures_mod",
+            "pubtools-pyxis-delete-signatures = pubtools._pyxis.pyxis_ops:delete_signatures_mod"
         ]
     },
     include_package_data=True,

{pubtools-pyxis-1.3.4 → pubtools_pyxis-1.3.6/src}/pubtools/_pyxis/pyxis_authentication.py

@@ -3,15 +3,17 @@ import subprocess
 
 from requests_kerberos import HTTPKerberosAuth, OPTIONAL
 
+from .pyxis_session import PyxisSession
 
-class PyxisAuth(object):
+
+class PyxisAuth:
     """Base Auth class."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize."""
         raise NotImplementedError  # pragma: no cover"
 
-    def apply_to_session(self, pyxis_session):
+    def apply_to_session(self, pyxis_session: PyxisSession) -> None:
         """Set up initialization in the Pyxis session."""
         raise NotImplementedError  # pragma: no cover"
 
@@ -20,7 +22,7 @@ class PyxisSSLAuth(PyxisAuth):
     """SSL Auth provider to PyxisClient."""
 
     # pylint: disable=super-init-not-called
-    def __init__(self, crt_path, key_path):
+    def __init__(self, crt_path: str, key_path: str) -> None:
         """
         Initialize.
 
@@ -33,7 +35,7 @@ class PyxisSSLAuth(PyxisAuth):
         self.crt_path = crt_path
         self.key_path = key_path
 
-    def apply_to_session(self, pyxis_session):
+    def apply_to_session(self, pyxis_session: PyxisSession) -> None:
         """
         Set up PyxisSession with SSL auth.
 
@@ -47,7 +49,9 @@ class PyxisSSLAuth(PyxisAuth):
 class PyxisKrbAuth(PyxisAuth):
     """Kerberos authentication support for PyxisClient."""
 
-    def __init__(self, krb_princ, service, ktfile=None, ccache_file=None):
+    def __init__(
+        self, krb_princ: str, service: str, ccache_file: str, ktfile: str | None = None
+    ) -> None:
         """
         Initialize.
 
@@ -56,17 +60,17 @@ class PyxisKrbAuth(PyxisAuth):
                 Kerberos principal for obtaining ticket.
             service (str)
                 URL of the service to apply the authentication to.
-            ktfile (str)
-                Kerberos client keytab file.
             ccache_file (str)
                 Path to a file used for ccache. Only necessary if kinit will be used.
+            ktfile (str)
+                Kerberos client keytab file.
         """
         self.krb_princ = krb_princ
         self.service = service
         self.ktfile = ktfile
         self.ccache_file = ccache_file
 
-    def _krb_auth(self):
+    def _krb_auth(self) -> HTTPKerberosAuth:
         retcode = subprocess.Popen(
             ["klist", "-s"], stdout=subprocess.PIPE, stderr=subprocess.PIPE
         ).wait()
@@ -102,7 +106,7 @@ class PyxisKrbAuth(PyxisAuth):
             force_preemptive=True,
         )
 
-    def apply_to_session(self, pyxis_session):
+    def apply_to_session(self, pyxis_session: PyxisSession) -> None:
         """Set up PyxisSession with Kerberos auth.
 
         Args:

{pubtools-pyxis-1.3.4 → pubtools_pyxis-1.3.6/src}/pubtools/_pyxis/pyxis_client.py

@@ -3,27 +3,29 @@ from concurrent.futures import as_completed
 from functools import partial
 import math
 import threading
+from typing import Callable, Any
 
 from more_executors import Executors
 from requests.exceptions import HTTPError
+from requests import Response
 
 from .constants import DEFAULT_REQUEST_THREADS_LIMIT
 from .pyxis_session import PyxisSession
+from .pyxis_authentication import PyxisAuth
 
 
-# pylint: disable=bad-option-value,useless-object-inheritance
-class PyxisClient(object):
+class PyxisClient:
     """Pyxis requests wrapper."""
 
     def __init__(
         self,
-        hostname,
-        retries=5,
-        auth=None,
-        backoff_factor=5,
-        verify=True,
-        threads=DEFAULT_REQUEST_THREADS_LIMIT,
-    ):
+        hostname: str,
+        retries: int = 5,
+        auth: PyxisAuth | None = None,
+        backoff_factor: int = 5,
+        verify: bool = True,
+        threads: int = DEFAULT_REQUEST_THREADS_LIMIT,
+    ) -> None:
         """
         Initialize.
 
@@ -53,7 +55,7 @@ class PyxisClient(object):
         self.threads_limit = threads
 
     @property
-    def pyxis_session(self):
+    def pyxis_session(self) -> PyxisSession | Any:
         """
         Return a thread-local session for Pyxis requests.
 
@@ -64,13 +66,15 @@ class PyxisClient(object):
             self.thread_local.pyxis_session = self._make_session()
         return self.thread_local.pyxis_session
 
-    def _make_session(self):
+    def _make_session(self) -> PyxisSession:
         session = self._session_factory()
         if self._auth:
             self._auth.apply_to_session(session)
         return session
 
-    def get_operator_indices(self, ocp_versions_range, organization=None):
+    def get_operator_indices(
+        self, ocp_versions_range: str, organization: str | None = None
+    ) -> list[str] | Any:
         """Get a list of index images satisfying versioning and organization conditions.
 
         Args:
@@ -91,8 +95,12 @@ class PyxisClient(object):
         return resp.json()["data"]
 
     def get_repository_metadata(
-        self, repo_name, custom_registry=None, only_internal=False, only_partner=False
-    ):
+        self,
+        repo_name: str,
+        custom_registry: str | None = None,
+        only_internal: bool = False,
+        only_partner: bool = False,
+    ) -> dict[Any, Any] | Any:
         """Get metadata of a Comet repository.
 
         If checking only one registry hasn't been specified, check both with precedence on
@@ -130,19 +138,19 @@ class PyxisClient(object):
         resp.raise_for_status()
         return resp.json()
 
-    def upload_signatures(self, signatures):
+    def upload_signatures(self, signatures: list[str]) -> list[Any]:
         """
         Upload signatures from given JSON string.
 
         Args:
-            signatures (str)
+            signatures [str]
                 JSON with signatures to upload.  See Pyxis API for details.
 
         Returns:
             list: List of uploaded signatures including auto-populated fields.
         """
 
-        def _send_post_request(data):
+        def _send_post_request(data: dict[Any, Any]) -> Response:
             response = self.pyxis_session.post("signatures", json=data)
             # SEE CLOUDDST-9698
             # Pyxis returns 500 error due to a potential sidecar config issue
@@ -156,11 +164,13 @@ class PyxisClient(object):
 
         return self._do_parallel_requests(_send_post_request, signatures)
 
-    def _clear_session(self):
+    def _clear_session(self) -> None:
         self.thread_local.pyxis_session.close()
         delattr(self.thread_local, "pyxis_session")
 
-    def _do_parallel_requests(self, make_request, data_items):
+    def _do_parallel_requests(
+        self, make_request: Callable[[Any], Any], data_items: list[Any]
+    ) -> list[Any] | Any:
         """
         Call given function with given data items in parallel, collect responses.
 
@@ -189,7 +199,7 @@ class PyxisClient(object):
 
             return [f.result() for f in as_completed(futures)]
 
-    def _handle_json_response(self, response):
+    def _handle_json_response(self, response: Response) -> dict[Any, Any] | Any:
         """
         Get JSON from given response or raise an informative exception.
 
@@ -202,8 +212,14 @@ class PyxisClient(object):
         except ValueError:  # Python 2.x compat
             data = {}
 
+        tolerate_codes = []
         # Uploaded data already exists in Pyxis
-        if response.status_code == 409:
+        if response.request.method == "POST":
+            tolerate_codes = [409]
+        # Data already removed from Pyxis
+        elif response.request.method == "DELETE":
+            tolerate_codes = [404]
+        if response.status_code in tolerate_codes:
             return data
 
         try:
@@ -216,11 +232,13 @@ class PyxisClient(object):
             extra_msg = data["detail"] if "detail" in data else response.text
 
             # re-raise the exception with an extra message
-            raise HTTPError("{0}\n{1}".format(e, extra_msg))
+            raise HTTPError("{0}\n{1}".format(e, extra_msg), response=response)
 
         return data
 
-    def get_container_signatures(self, manifest_digests=None, references=None):
+    def get_container_signatures(
+        self, manifest_digests: str | None = None, references: str | None = None
+    ) -> list[str]:
         """Get a list of signature metadata matching given fields.
 
         Args:
@@ -248,7 +266,7 @@ class PyxisClient(object):
 
         return resp
 
-    def _get_items_from_all_pages(self, endpoint, **kwargs):
+    def _get_items_from_all_pages(self, endpoint: str, **kwargs: Any) -> list[Any]:
         """
         Get response from all pages of pyxis.
 
@@ -277,16 +295,17 @@ class PyxisClient(object):
                 all_resp.extend(resp.json()["data"])
         return all_resp
 
-    def delete_container_signatures(self, signature_ids):
+    def delete_container_signatures(self, signature_ids: list[str]) -> list[Any]:
         """Delete signatures matching given fields.
 
         Args:
             signature_ids ([str])
                 Internal Pyxis signature IDs of signatures which should be removed.
         """
-        delete_endpoint = "signatures/id/{id}"
 
-        for signature_id in signature_ids:
+        def _send_delete_request(signature_id: str) -> Response:
+            delete_endpoint = "signatures/id/{id}"
             resp = self.pyxis_session.delete(delete_endpoint.format(id=signature_id))
-            if resp.status_code != 404:
-                resp.raise_for_status()
+            return resp
+
+        return self._do_parallel_requests(_send_delete_request, signature_ids)

{pubtools-pyxis-1.3.4 → pubtools_pyxis-1.3.6/src}/pubtools/_pyxis/pyxis_ops.py

@@ -1,9 +1,11 @@
 import json
 import sys
 import tempfile
+from argparse import ArgumentParser, Namespace
+from typing import Any
 
 from .constants import DEFAULT_REQUEST_THREADS_LIMIT
-from .pyxis_authentication import PyxisKrbAuth, PyxisSSLAuth
+from .pyxis_authentication import PyxisKrbAuth, PyxisSSLAuth, PyxisAuth
 from .pyxis_client import PyxisClient
 from .utils import setup_arg_parser
 
@@ -108,9 +110,15 @@ DELETE_SIGNATURES_ARGS[("--ids",)] = {
     "required": True,
     "type": str,
 }
+DELETE_SIGNATURES_ARGS[("--request-threads",)] = {
+    "help": "Maximum number of threads to use for parallel requests",
+    "required": False,
+    "default": DEFAULT_REQUEST_THREADS_LIMIT,
+    "type": int,
+}
 
 
-def setup_pyxis_client(args, ccache_file):
+def setup_pyxis_client(args: Namespace, ccache_file: str) -> PyxisClient:
     """
     Set up a PyxisClient instance according to specified parameters.
 
@@ -125,11 +133,11 @@ def setup_pyxis_client(args, ccache_file):
     """
     # If both auths are specified, Kerberos is preferred
     if args.pyxis_krb_principal:
-        auth = PyxisKrbAuth(
+        auth: PyxisAuth = PyxisKrbAuth(
             args.pyxis_krb_principal,
             args.pyxis_server,
-            args.pyxis_krb_ktfile,
             ccache_file,
+            args.pyxis_krb_ktfile,
         )
     elif args.pyxis_ssl_crtfile and args.pyxis_ssl_keyfile:
         auth = PyxisSSLAuth(args.pyxis_ssl_crtfile, args.pyxis_ssl_keyfile)
@@ -150,12 +158,12 @@ def setup_pyxis_client(args, ccache_file):
         return PyxisClient(args.pyxis_server, auth=auth, verify=not args.pyxis_insecure)
 
 
-def set_get_operator_indices_args():
+def set_get_operator_indices_args() -> ArgumentParser:
     """Set up argparser without extra parameters, this method is used for auto doc generation."""
     return setup_arg_parser(GET_OPERATORS_INDICES_ARGS)
 
 
-def get_operator_indices_main(sysargs=None):
+def _get_operator_indices(sysargs: list[str] | None = None) -> list[str] | Any:
     """
     Entrypoint for getting operator indices.
 
@@ -173,17 +181,41 @@ def get_operator_indices_main(sysargs=None):
         resp = pyxis_client.get_operator_indices(
             args.ocp_versions_range, args.organization
         )
+        return resp
+
 
+def get_operator_indices_main(sysargs: list[str] | None = None) -> int:
+    """
+    Entrypoint for getting operator indices.
+
+    Returns:
+        int: Exit code (0 for success).
+    """
+    try:
+        resp = _get_operator_indices(sysargs)
         json.dump(resp, sys.stdout, sort_keys=True, indent=4, separators=(",", ": "))
-        return resp
+        return 0
+    except Exception as e:
+        print(f"Error getting operator indices: {e}", file=sys.stderr)
+        return 1
+
 
+def get_operator_indices_mod(sysargs: list[str] | None = None) -> list[str] | Any:
+    """
+    Entrypoint for getting operator indices in module mode.
 
-def set_get_repo_metadata_args():
+    This function is used when running the script as a module.
+    It does not return an exit code, but rather prints the result directly.
+    """
+    return _get_operator_indices(sysargs)
+
+
+def set_get_repo_metadata_args() -> ArgumentParser:
     """Set up argparser without extra parameters, this method is used for auto doc generation."""
     return setup_arg_parser(GET_REPO_METADATA_ARGS)
 
 
-def get_repo_metadata_main(sysargs=None):
+def _get_repo_metadata(sysargs: list[str] | None = None) -> dict[Any, Any] | Any:
     """
     Entrypoint for getting repository metadata.
 
@@ -210,17 +242,42 @@ def get_repo_metadata_main(sysargs=None):
             args.only_internal_registry,
             args.only_partner_registry,
         )
+        return res
 
+
+def get_repo_metadata_main(sysargs: list[str] | None = None) -> dict[Any, Any] | Any:
+    """
+    Entrypoint for getting repository metadata.
+
+    Returns:
+        int: Exit code (0 for success).
+    """
+    try:
+        res = _get_repo_metadata(sysargs)
         json.dump(res, sys.stdout, sort_keys=True, indent=4, separators=(",", ": "))
-        return res
+        return 0
+    except Exception as e:
+        print(f"Error getting repository metadata: {e}", file=sys.stderr)
+        return 1
+
+
+def get_repo_metadata_mod(sysargs: list[str] | None = None) -> dict[Any, Any] | Any:
+    """
+    Entrypoint for getting repository metadata in module mode.
+
+    This function is used when running the script as a module.
+    It does not return an exit code, but rather prints the result directly.
+    """
+    return _get_repo_metadata(sysargs)
+    # No return value, output is printed directly
 
 
-def set_upload_signatures_args():
+def set_upload_signatures_args() -> ArgumentParser:
     """Set up argparser without extra parameters, this method is used for auto doc generation."""
     return setup_arg_parser(UPLOAD_SIGNATURES_ARGS)
 
 
-def upload_signatures_main(sysargs=None):
+def _upload_signatures(sysargs: list[str] | None = None) -> list[Any]:
     """
     Entrypoint for uploading signatures from JSON or a file.
 
@@ -238,13 +295,37 @@ def upload_signatures_main(sysargs=None):
     with tempfile.NamedTemporaryFile() as tmpfile:
         pyxis_client = setup_pyxis_client(args, tmpfile.name)
         resp = pyxis_client.upload_signatures(signatures_json)
+        return resp
+
 
+def upload_signatures_main(sysargs: list[str] | None = None) -> int:
+    """
+    Entrypoint for uploading signatures from JSON or a file.
+
+    Returns:
+        int: Exit code (0 for success).
+    """
+    try:
+        resp = _upload_signatures(sysargs)
         json.dump(resp, sys.stdout, sort_keys=True, indent=4, separators=(",", ": "))
+        return 0
+    except Exception as e:
+        print(f"Error uploading signatures: {e}", file=sys.stderr)
+        return 1
 
-        return resp
+
+def upload_signatures_mod(sysargs: list[str] | None = None) -> list[Any]:
+    """
+    Entrypoint for uploading signatures from JSON or a file in module mode.
+
+    This function is used when running the script as a module.
+    It does not return an exit code, but rather prints the result directly.
+    """
+    return _upload_signatures(sysargs)
+    # No return value, output is printed directly
 
 
-def deserialize_list_from_arg(value, csv_input=False):
+def deserialize_list_from_arg(value: str, csv_input: bool = False) -> list[Any] | Any:
     """
     Conditionally load contents of a file if specified in argument value.
 
@@ -269,17 +350,17 @@ def deserialize_list_from_arg(value, csv_input=False):
         return json.load(f)
 
 
-def serialize_to_csv_from_list(list_value):
+def serialize_to_csv_from_list(list_value: list[Any]) -> str:
     """Convert a list to comma separated string."""
     return ",".join(list_value)
 
 
-def set_get_signatures_args():
+def set_get_signatures_args() -> ArgumentParser:
     """Set up argparser without extra parameters, this method is used for auto doc generation."""
     return setup_arg_parser(GET_SIGNATURES_ARGS)
 
 
-def get_signatures_main(sysargs=None):
+def _get_signatures(sysargs: list[str] | None = None) -> list[str]:
     """
     Entrypoint for getting container signature metadata.
 
@@ -309,17 +390,42 @@ def get_signatures_main(sysargs=None):
         res = pyxis_client.get_container_signatures(
             csv_manifest_digests, csv_references
         )
+        return res
+
 
+def get_signatures_main(sysargs: list[str] | None = None) -> int:
+    """
+    Entrypoint for getting container signature metadata.
+
+    Returns:
+        int: Exit code (0 for success).
+    """
+    try:
+        res = _get_signatures(sysargs)
         json.dump(res, sys.stdout, sort_keys=True, indent=4, separators=(",", ": "))
-        return res
+        return 0
+    except Exception as e:
+        print(f"Error getting signatures: {e}", file=sys.stderr)
+        return 1
 
 
-def set_delete_signatures_args():
+def get_signatures_mod(sysargs: list[str] | None = None) -> list[str]:
+    """
+    Entrypoint for getting container signature metadata in module mode.
+
+    This function is used when running the script as a module.
+    It does not return an exit code, but rather prints the result directly.
+    """
+    return _get_signatures(sysargs)
+    # No return value, output is printed directly
+
+
+def set_delete_signatures_args() -> ArgumentParser:
     """Set up argparser without extra parameters, this method is used for auto doc generation."""
     return setup_arg_parser(DELETE_SIGNATURES_ARGS)
 
 
-def delete_signatures_main(sysargs=None):
+def _delete_signatures(sysargs: list[str] | None = None) -> None:
     """
     Entrypoint for removing existing signatures.
 
@@ -338,3 +444,29 @@ def delete_signatures_main(sysargs=None):
     with tempfile.NamedTemporaryFile() as tmpfile:
         pyxis_client = setup_pyxis_client(args, tmpfile.name)
         pyxis_client.delete_container_signatures(signature_ids)
+
+
+def delete_signatures_main(sysargs: list[str] | None = None) -> int:
+    """
+    Entrypoint for removing existing signatures.
+
+    Returns:
+        int: Exit code (0 for success).
+    """
+    try:
+        _delete_signatures(sysargs)
+        return 0
+    except Exception as e:
+        print(f"Error deleting signatures: {e}", file=sys.stderr)
+        return 1
+
+
+def delete_signatures_mod(sysargs: list[str] | None = None) -> None:
+    """
+    Entrypoint for removing existing signatures in module mode.
+
+    This function is used when running the script as a module.
+    It does not return an exit code, but rather prints the result directly.
+    """
+    return _delete_signatures(sysargs)
+    # No return value, output is printed directly