snap-python 0.0.5__tar.gz → 0.1.0__tar.gz

{snap_python-0.0.5 → snap_python-0.1.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: snap-python
-Version: 0.0.5
+Version: 0.1.0
 Summary: An api to interact with snapd and snap stores
-Home-page: https://github.com/alexlukens/snap-python
 License: MIT
 Author: Alexander Lukens
 Author-email: alexdlukens@gmail.com

{snap_python-0.0.5 → snap_python-0.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snap-python"
-version = "0.0.5"
+version = "0.1.0"
 description = "An api to interact with snapd and snap stores"
 authors = ["Alexander Lukens <alexdlukens@gmail.com>"]
 license = "MIT"
@@ -27,3 +27,9 @@ sphinx-rtd-theme = "^3.0.2"
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+addopts = "--cov=snap_python --cov-report=html"
+testpaths = "tests"

{snap_python-0.0.5 → snap_python-0.1.0}/src/snap_python/client.py

@@ -44,15 +44,15 @@ class SnapClient(AbstractSnapsClient):
         if store_headers is None:
             store_headers = {"Snap-Device-Series": "16", "X-Ubuntu-Series": "16"}
 
-        snapd_headers = {}
+        self.snapd_headers = {}
         if prompt_for_authentication:
-            snapd_headers = {"X-Allow-Interaction": "true"}
+            self.snapd_headers = {"X-Allow-Interaction": "true"}
 
         self.version = version
         self.store_base_url = store_base_url
         self.store_headers = store_headers
         self.snapd_client = httpx.AsyncClient(
-            transport=self._transport, headers=snapd_headers
+            transport=self._transport, headers=self.snapd_headers
         )
         self.snaps = SnapsEndpoints(self)
         self.store = StoreEndpoints(
@@ -61,6 +61,7 @@ class SnapClient(AbstractSnapsClient):
             headers=self.store_headers,
         )
         self.config = ConfigEndpoints(self)
+        self.snapd_client = httpx.AsyncClient(transport=self._transport)
 
     @retry(httpx.HTTPError, tries=3, delay=1, backoff=1)
     async def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
@@ -111,30 +112,54 @@ class SnapClient(AbstractSnapsClient):
 
         return response
 
+    @retry(httpx.HTTPError, tries=3, delay=0.5)
     async def get_changes_by_id(self, change_id: str) -> ChangesResponse:
+        """
+        Asynchronously retrieves changes by their ID.
+        Args:
+            change_id (str): The ID of the change to retrieve.
+        Returns:
+            ChangesResponse: The response object containing the changes.
+        Raises:
+            httpx.HTTPStatusError: If the request results in an HTTP error.
+        """
+
         try:
             response = await self.request("GET", f"changes/{change_id}")
         except httpx.HTTPStatusError as e:
             logger.warning(
-                f"Bad response status code for get_changes_by_id: {e.response.status_code}"
+                "Bad response status code for get_changes_by_id: %s",
+                e.response.status_code,
             )
             response = e.response
-            pass
 
         return ChangesResponse.model_validate_json(response.content)
 
     async def get_changes_by_id_generator(
         self, change_id: str
     ) -> AsyncGenerator[ChangesResponse, None]:
+        """
+        Asynchronous generator to fetch changes by change ID.
+        This generator continuously requests changes from the server using the provided
+        change ID and yields the response as a ChangesResponse object. It includes error
+        handling for HTTP status errors and adds a small delay between requests to avoid
+        overwhelming the server.
+        Args:
+            change_id (str): The ID of the change to fetch.
+        Yields:
+            ChangesResponse: The response object containing the changes.
+        Raises:
+            httpx.HTTPStatusError: If the request fails with an HTTP status error.
+        """
         while True:
             try:
                 response = await self.request("GET", f"changes/{change_id}")
             except httpx.HTTPStatusError as e:
                 logger.warning(
-                    f"Bad response status code for get_changes_by_id: {e.response.status_code}"
+                    "Bad response status code for get_changes_by_id: %s",
+                    e.response.status_code,
                 )
                 response = e.response
-                pass
 
             change_response = ChangesResponse.model_validate_json(response.content)
             yield change_response

{snap_python-0.0.5 → snap_python-0.1.0}/src/snap_python/components/snaps.py

@@ -10,7 +10,7 @@ from snap_python.schemas.snaps import (
     InstalledSnapListResponse,
     SingleInstalledSnapResponse,
 )
-from snap_python.utils import AbstractSnapsClient, going_to_reload_daemon
+from snap_python.utils import AbstractSnapsClient, SnapdAPIError, going_to_reload_daemon
 
 logger = logging.getLogger("snap_python.components.snaps")
 
@@ -62,7 +62,6 @@ class SnapsEndpoints:
         classic: bool = False,
         dangerous: bool = False,
         devmode: bool = False,
-        ignore_validation: bool = False,
         jailmode: bool = False,
         revision: int = None,
         filename: str = None,
@@ -79,14 +78,13 @@ class SnapsEndpoints:
             classic (bool, optional): Install with classic confinement. Defaults to False.
             dangerous (bool, optional): install the given snap files even if there are no pre-acknowledged signatures for them, meaning they are not verified and could be dangerous if true (optional, implied by devmode). Defaults to False.
             devmode (bool, optional): Install with devmode. Defaults to False.
-            ignore_validation (bool, optional): _description_. Defaults to False.
             jailmode (bool, optional): Install snap with jailmode. Defaults to False.
             revision (int, optional): install a specific revision of the snap. Defaults to None.
             filename (str, optional): Path to snap to sideload. Defaults to None.
             wait (bool, optional): Whether to wait for snap to install. If not waiting, will return async response with change id. Defaults to False.
 
         Raises:
-            Exception: If error occurs during snap install
+            SnapdAPIError: If error occurs during snap install
 
         Returns:
             AsyncResponse | ChangesResponse: If wait is True, will return ChangesResponse. Otherwise, will return AsyncResponse
@@ -97,7 +95,6 @@ class SnapsEndpoints:
             "classic": classic,
             "dangerous": dangerous,
             "devmode": devmode,
-            "ignore_validation": ignore_validation,
             "jailmode": jailmode,
         }
         if revision:
@@ -128,17 +125,16 @@ class SnapsEndpoints:
             while True:
                 try:
                     changes = await self._client.get_changes_by_id(changes_id)
-                    logger.debug(f"Progress: {changes.result.overall_progress}")
-                except httpx.HTTPError as e:
+                    logger.debug("Progress: %s", changes.result.overall_progress)
+                except httpx.HTTPError:
                     if going_to_reload_daemon(previous_changes):
                         logger.debug("Waiting for daemon to reload")
-                        await asyncio.sleep(0.1)
-                        continue
+                        changes = previous_changes
 
                 if changes.ready:
                     break
                 if changes.result.err:
-                    raise Exception(f"Error in snap install: {changes.result.err}")
+                    raise SnapdAPIError(f"Error in snap install: {changes.result.err}")
                 await asyncio.sleep(0.1)
                 previous_changes = changes
             return changes
@@ -151,6 +147,18 @@ class SnapsEndpoints:
         terminate: bool = False,
         wait: bool = False,
     ) -> AsyncResponse | ChangesResponse:
+        """
+        Asynchronously removes a snap package.
+        Args:
+            snap (str): The name of the snap package to remove.
+            purge (bool, optional): If True, purges the snap package. Defaults to False.
+            terminate (bool, optional): If True, terminates the snap package. Defaults to False.
+            wait (bool, optional): If True, waits for the removal process to complete. Defaults to False.
+        Returns:
+            AsyncResponse | ChangesResponse: The response from the snapd API, either an asynchronous response or a changes response if waiting for completion.
+        Raises:
+            SnapdAPIError: If there is an error in the snap removal process.
+        """
         request_data = {
             "action": "remove",
             "purge": purge,
@@ -168,7 +176,7 @@ class SnapsEndpoints:
             while True:
                 try:
                     changes = await self._client.get_changes_by_id(changes_id)
-                except httpx.HTTPError as e:
+                except httpx.HTTPError:
                     if going_to_reload_daemon(previous_changes):
                         logger.debug("Waiting for daemon to reload")
                         await asyncio.sleep(0.1)
@@ -176,9 +184,95 @@ class SnapsEndpoints:
                 if changes.ready:
                     break
                 if changes.result.err:
-                    raise Exception(f"Error in snap remove: {changes.result.err}")
+                    raise SnapdAPIError(f"Error in snap remove: {changes.result.err}")
                 await asyncio.sleep(0.1)
                 previous_changes = changes
             return changes
 
         return response
+
+    async def refresh_snap(
+        self,
+        snap: str,
+        channel: str = "stable",
+        classic: bool = False,
+        dangerous: bool = False,
+        devmode: bool = False,
+        ignore_validation: bool = False,
+        jailmode: bool = False,
+        revision: int = None,
+        filename: str = None,
+        wait: bool = False,
+    ) -> AsyncResponse | ChangesResponse:
+        """
+        Refreshes a snap package.
+        Args:
+            snap (str): The name of the snap package to refresh.
+            channel (str, optional): The channel to refresh the snap from. Defaults to "stable".
+            classic (bool, optional): Whether to use classic confinement. Defaults to False.
+            dangerous (bool, optional): Whether to allow installation of unasserted snaps. Defaults to False.
+            devmode (bool, optional): Whether to use development mode. Defaults to False.
+            ignore_validation (bool, optional): Whether to ignore validation. Defaults to False.
+            jailmode (bool, optional): Whether to use jail mode. Defaults to False.
+            revision (int, optional): The specific revision to refresh to. Defaults to None.
+            filename (str, optional): The path to the snap file for sideloading. Defaults to None.
+            wait (bool, optional): Whether to wait for the refresh operation to complete. Defaults to False.
+        Returns:
+            AsyncResponse | ChangesResponse: The response from the refresh operation.
+        Raises:
+            FileNotFoundError: If the specified snap file does not exist.
+            ValueError: If attempting to sideload without the dangerous flag set to True.
+            SnapdAPIError: If there is an error during the snap refresh.
+        """
+        request_data = {
+            "action": "refresh",
+            "channel": channel,
+            "classic": classic,
+            "dangerous": dangerous,
+            "devmode": devmode,
+            "ignore_validation": ignore_validation,
+            "jailmode": jailmode,
+        }
+        if revision:
+            request_data["revision"] = revision
+        if filename:
+            # sideload
+            if not Path(filename).exists():
+                raise FileNotFoundError(f"File {filename} does not exist")
+            if request_data.get("dangerous") is not True:
+                raise ValueError(
+                    "Cannot sideload snap without dangerous flag set to True"
+                )
+            raw_response: httpx.Response = await self._client.request(
+                "POST",
+                f"{self.common_endpoint}",
+                data=request_data,
+                files={"snap": open(filename, "rb")},
+            )
+        else:
+            # install from default snap store
+            raw_response: httpx.Response = await self._client.request(
+                "POST", f"{self.common_endpoint}/{snap}", json=request_data
+            )
+        response = AsyncResponse.model_validate_json(raw_response.content)
+        if wait:
+            changes_id = response.change
+            previous_changes = None
+            while True:
+                try:
+                    changes = await self._client.get_changes_by_id(changes_id)
+                    logger.debug("Progress: %s", changes.result.overall_progress)
+                except httpx.HTTPError:
+                    if going_to_reload_daemon(previous_changes):
+                        logger.debug("Waiting for daemon to reload")
+                        await asyncio.sleep(0.1)
+                        continue
+
+                if changes.ready:
+                    break
+                if changes.result.err:
+                    raise SnapdAPIError(f"Error in snap remove: {changes.result.err}")
+                await asyncio.sleep(0.1)
+                previous_changes = changes
+            return changes
+        return response

{snap_python-0.0.5 → snap_python-0.1.0}/src/snap_python/components/store.py

@@ -11,6 +11,7 @@ from snap_python.schemas.store.categories import (
 from snap_python.schemas.store.info import VALID_SNAP_INFO_FIELDS, InfoResponse
 from snap_python.schemas.store.search import (
     VALID_SEARCH_CATEGORY_FIELDS,
+    ArchSearchResponse,
     SearchResponse,
 )
 
@@ -165,3 +166,30 @@ class StoreEndpoints:
         return await self.find(
             category=category, fields=["title", "store-url", "summary"]
         )
+
+    async def get_all_snaps_for_arch(self, arch: str) -> ArchSearchResponse:
+        # use the old "/api/v1/snaps/names" to get all snaps for a given architecture
+
+        # ensure valid arch
+        if arch not in [
+            "amd64",
+            "arm64",
+            "armhf",
+            "i386",
+            "ppc64el",
+            "s390x",
+            "riscv64",
+        ]:
+            raise ValueError(f"Invalid architecture: {arch}")
+
+        route = "/api/v1/snaps/names"
+        extra_headers = {"X-Ubuntu-Architecture": arch}
+
+        response = await self.store_client.get(
+            f"{self._raw_base_url}{route}", headers=extra_headers, timeout=60
+        )
+        response.raise_for_status()
+
+        response_json = response.json()
+        response_json["arch"] = arch
+        return ArchSearchResponse.model_validate(response_json)

{snap_python-0.0.5 → snap_python-0.1.0}/src/snap_python/schemas/store/search.py

@@ -1,6 +1,13 @@
 from typing import Any, Dict, List, Optional
 
-from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
+from pydantic import (
+    AliasChoices,
+    AliasPath,
+    AwareDatetime,
+    BaseModel,
+    ConfigDict,
+    Field,
+)
 
 from snap_python.schemas.common import Revision
 from snap_python.schemas.snaps import InstalledSnap, Snap, StoreSnap, StoreSnapFields
@@ -120,3 +127,21 @@ class SearchResponse(BaseModel):
 
     error_list: Optional[List[ErrorListItem]] = Field(None, alias="error-list")
     results: List[SearchResult]
+
+
+class ArchSearchItem(BaseModel):
+    model_config = ConfigDict(extra="ignore")
+
+    aliases: Optional[list[dict[str, str]]]
+    apps: list[str]
+    package_name: str
+    summary: str
+    title: str
+    version: str
+
+
+class ArchSearchResponse(BaseModel):
+    results: list[ArchSearchItem] = Field(
+        alias=AliasPath("_embedded", "clickindex:package")
+    )
+    arch: str

{snap_python-0.0.5 → snap_python-0.1.0}/src/snap_python/utils.py

@@ -5,13 +5,17 @@ import httpx
 from snap_python.schemas.changes import ChangesResponse
 
 
+class SnapdAPIError(Exception):
+    pass
+
+
 class AbstractSnapsClient(ABC):  # pragma: no cover
     @abstractmethod
-    async def request(self) -> httpx.Response:
+    async def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
         pass
 
     @abstractmethod
-    async def request_raw(self) -> httpx.Response:
+    async def request_raw(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
         pass
 
     @abstractmethod