snap-python 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

snap_python/__init__.py

@@ -0,0 +1,7 @@
+import logging
+import os
+
+log_level = os.getenv("SNAP_PYTHON_LOG_LEVEL", "DEBUG").upper()
+numeric_level = getattr(logging, log_level, logging.DEBUG)
+logger = logging.getLogger("snap_python")
+logger.setLevel(numeric_level)

snap_python/client.py

@@ -1,7 +1,11 @@
+import asyncio
 import logging
+from typing import AsyncGenerator
 
 import httpx
+from retry import retry
 
+from snap_python.components.config import ConfigEndpoints
 from snap_python.components.snaps import SnapsEndpoints
 from snap_python.components.store import StoreEndpoints
 from snap_python.schemas.changes import ChangesResponse
@@ -14,6 +18,8 @@ logger.setLevel(logging.DEBUG)
 
 
 class SnapClient(AbstractSnapsClient):
+    """Core class for interacting with the Snap Store and Snapd."""
+
     def __init__(
         self,
         version: str = "v2",
@@ -48,16 +54,42 @@ class SnapClient(AbstractSnapsClient):
             version=self.version,
             headers=self.store_headers,
         )
+        self.config = ConfigEndpoints(self)
 
+    @retry(httpx.HTTPError, tries=3, delay=1, backoff=1)
     async def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
+        """
+        Sends an HTTP request to the specified endpoint using the given method and parameters.
+        Args:
+            method (str): The HTTP method to use for the request (e.g., 'GET', 'POST').
+            endpoint (str): The API endpoint to send the request to.
+            **kwargs: Additional keyword arguments to pass to the request.
+        Returns:
+            httpx.Response: The response object from the HTTP request.
+        Raises:
+            httpx.HTTPStatusError: If the response contains an HTTP status code indicating an error.
+        """
+
         response = await self.snapd_client.request(
             method, f"{self._base_url}/{self.version}/{endpoint}", **kwargs
         )
-        logger.debug(f"response: {response.content}")
         response.raise_for_status()
         return response
 
+    @retry(httpx.HTTPError, tries=3, delay=1, backoff=1)
     async def request_raw(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
+        """
+        Sends an HTTP request using the specified method and endpoint.
+        Args:
+            method (str): The HTTP method to use for the request (e.g., 'GET', 'POST').
+            endpoint (str): The endpoint URL to send the request to.
+            **kwargs: Additional keyword arguments to pass to the request.
+        Returns:
+            httpx.Response: The response object resulting from the HTTP request.
+        Raises:
+            httpx.HTTPStatusError: If the response contains an HTTP status code indicating an error.
+        """
+
         response = await self.snapd_client.request(method, endpoint, **kwargs)
 
         response.raise_for_status()
@@ -84,3 +116,23 @@ class SnapClient(AbstractSnapsClient):
             pass
 
         return ChangesResponse.model_validate_json(response.content)
+
+    async def get_changes_by_id_generator(
+        self, change_id: str
+    ) -> AsyncGenerator[ChangesResponse, None]:
+        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}"
+                )
+                response = e.response
+                pass
+
+            change_response = ChangesResponse.model_validate_json(response.content)
+            yield change_response
+
+            await asyncio.sleep(
+                0.01
+            )  # Add a delay to avoid spamming the server with requests

snap_python/components/config.py

@@ -0,0 +1,54 @@
+import asyncio
+import logging
+
+import httpx
+
+from snap_python.schemas.changes import ChangesResponse
+from snap_python.schemas.common import AsyncResponse
+from snap_python.schemas.config import ConfigResponse
+from snap_python.utils import AbstractSnapsClient
+
+logger = logging.getLogger("snap_python.components.snaps")
+
+
+class ConfigEndpoints:
+    def __init__(self, client: AbstractSnapsClient) -> None:
+        self._client = client
+        self.common_endpoint = "snaps"
+
+    async def get_configuration(
+        self, snap: str, keys: list[str] | None = None
+    ) -> ConfigResponse:
+        if keys:
+            response: httpx.Response = await self._client.request(
+                "GET",
+                f"{self.common_endpoint}/{snap}/conf",
+                params={"keys": ",".join(keys)},
+            )
+        else:
+            response: httpx.Response = await self._client.request(
+                "GET", f"{self.common_endpoint}/{snap}/conf"
+            )
+
+        return ConfigResponse.model_validate_json(response.content)
+
+    async def set_configuration(
+        self, snap: str, configuration: dict, wait: bool = True
+    ) -> AsyncResponse | ChangesResponse:
+        # TODO: should check that snap supports configure hook before trying to set configuration
+        response: httpx.Response = await self._client.request(
+            "PUT", f"{self.common_endpoint}/{snap}/conf", json=configuration
+        )
+
+        async_response = AsyncResponse.model_validate_json(response.content)
+        if not wait:
+            return async_response
+        while True:
+            changes = await self._client.get_changes_by_id(async_response.change)
+
+            if changes.ready:
+                break
+
+            await asyncio.sleep(0.1)
+
+        return changes

snap_python/components/snaps.py

@@ -1,11 +1,15 @@
 import asyncio
+import logging
+from pathlib import Path
 
 import httpx
 
 from snap_python.schemas.changes import ChangesResponse
 from snap_python.schemas.common import AsyncResponse
-from snap_python.schemas.snaps import SnapListResponse
-from snap_python.utils import AbstractSnapsClient
+from snap_python.schemas.snaps import SingleSnapResponse, SnapListResponse
+from snap_python.utils import AbstractSnapsClient, going_to_reload_daemon
+
+logger = logging.getLogger("snap_python.components.snaps")
 
 
 class SnapsEndpoints:
@@ -27,6 +31,27 @@ class SnapsEndpoints:
             )
         return response
 
+    async def get_snap_info(self, snap: str) -> SingleSnapResponse:
+        try:
+            response: httpx.Response = await self._client.request(
+                "GET", f"{self.common_endpoint}/{snap}"
+            )
+        except httpx.HTTPStatusError as e:
+            logger.debug(
+                "Bad status code from get_snap_info on snap %s: %s",
+                snap,
+                e.response.status_code,
+            )
+            response = e.response
+
+        return SingleSnapResponse.model_validate_json(response.content)
+
+    async def is_snap_installed(self, snap: str) -> bool:
+        snap_info = await self.get_snap_info(snap)
+        if snap_info.status == "OK":
+            return True
+        return False
+
     async def install_snap(
         self,
         snap: str,
@@ -36,8 +61,31 @@ class SnapsEndpoints:
         ignore_validation: bool = False,
         jailmode: bool = False,
         revision: int = None,
+        filename: str = None,
         wait: bool = False,
     ) -> AsyncResponse | ChangesResponse:
+        """Install or sideload a snap
+
+        To sideload a snap, provide the filename parameter with the path to the snap file
+
+
+        Args:
+            snap (str): name of the snap to install
+            channel (str, optional): Channel to install. Defaults to "stable".
+            classic (bool, optional): Install with classic confinement. 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
+
+        Returns:
+            AsyncResponse | ChangesResponse: If wait is True, will return ChangesResponse. Otherwise, will return AsyncResponse
+        """
         request_data = {
             "action": "install",
             "channel": channel,
@@ -48,24 +96,51 @@ class SnapsEndpoints:
         }
         if revision:
             request_data["revision"] = revision
-        raw_response: httpx.Response = await self._client.request(
-            "POST", f"{self.common_endpoint}/{snap}", json=request_data
-        )
+        if filename:
+            # sideload
+            if not Path(filename).exists():
+                raise FileNotFoundError(f"File {filename} does not exist")
+            request_data["dangerous"] = 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:
-                changes = await self._client.get_changes_by_id(changes_id)
+                try:
+                    changes = await self._client.get_changes_by_id(changes_id)
+                    logger.debug(f"Progress: {changes.result.overall_progress}")
+                except httpx.HTTPError as e:
+                    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 Exception(f"Error in snap install: {changes.result.err}")
-                await asyncio.sleep(2.0)
+                await asyncio.sleep(0.1)
+                previous_changes = changes
             return changes
         return response
 
     async def remove_snap(
-        self, snap: str, purge: bool, terminate: bool, wait: bool = False
+        self,
+        snap: str,
+        purge: bool = False,
+        terminate: bool = False,
+        wait: bool = False,
     ) -> AsyncResponse | ChangesResponse:
         request_data = {
             "action": "remove",
@@ -80,13 +155,21 @@ class SnapsEndpoints:
 
         if wait:
             changes_id = response.change
+            previous_changes = None
             while True:
-                changes = await self._client.get_changes_by_id(changes_id)
+                try:
+                    changes = await self._client.get_changes_by_id(changes_id)
+                except httpx.HTTPError as e:
+                    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 Exception(f"Error in snap remove: {changes.result.err}")
-                await asyncio.sleep(2.0)
+                await asyncio.sleep(0.1)
+                previous_changes = changes
             return changes
 
         return response

snap_python/schemas/changes.py

@@ -3,12 +3,23 @@ from pydantic import AliasChoices, AwareDatetime, BaseModel, Field
 from snap_python.schemas.common import BaseErrorResult, BaseResponse
 
 
+class MaintenanceInfo(BaseModel):
+    kind: str
+    message: str
+
+
+class ProgressInfo(BaseModel):
+    label: str
+    done: int
+    total: int
+
+
 class Task(BaseModel):
     id: str
     kind: str
     summary: str
     status: str
-    progress: dict
+    progress: ProgressInfo
     spawn_time: AwareDatetime = Field(
         validation_alias=AliasChoices("spawn-time", "spawn_time"),
         serialization_alias="spawn-time",
@@ -40,12 +51,22 @@ class ChangesResult(BaseModel):
     err: str | None = None
     data: dict | None = None
 
+    @property
+    def overall_progress(self) -> ProgressInfo:
+        if not self.tasks:
+            return ProgressInfo(label="Overall", done=0, total=-1)
+        total = sum(task.progress.total for task in self.tasks)
+        done = sum(task.progress.done for task in self.tasks)
+
+        return ProgressInfo(label="Overall", done=done, total=total)
+
 
 class ChangesResponse(BaseResponse):
     result: ChangesResult | BaseErrorResult
+    maintenance: MaintenanceInfo | None = None
 
     @property
     def ready(self) -> bool:
         if isinstance(self.result, BaseErrorResult):
-            return False
+            return True
         return self.result.ready

snap_python/schemas/config.py

@@ -0,0 +1,5 @@
+from snap_python.schemas.common import BaseResponse
+
+
+class ConfigResponse(BaseResponse):
+    result: dict

snap_python/schemas/snaps.py

@@ -1,6 +1,7 @@
 from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
 
 from snap_python.schemas.common import (
+    BaseErrorResult,
     BaseResponse,
     Media,
     SnapApp,
@@ -43,20 +44,25 @@ class Snap(BaseModel):
     )
     name: str
     private: bool
-    publisher: dict[str, str]
+    publisher: dict[str, str] | None = None
     revision: str
     status: str
     summary: str
     title: str | None = None
-    tracking_channel: str = Field(
+    tracking_channel: str | None = Field(
         validation_alias=AliasChoices("tracking-channel", "tracking_channel"),
         serialization_alias="tracking-channel",
+        default=None,
     )
     type: str
     version: str
     website: str | None = None
 
 
+class SingleSnapResponse(BaseResponse):
+    result: Snap | BaseErrorResult
+
+
 class SnapListResponse(BaseResponse):
     result: list[Snap]
 

snap_python/utils.py

@@ -17,3 +17,16 @@ class AbstractSnapsClient(ABC):  # pragma: no cover
     @abstractmethod
     async def get_changes_by_id(self, change_id: str) -> ChangesResponse:
         pass
+
+
+def going_to_reload_daemon(changes: ChangesResponse | None) -> bool:
+    if changes is None or not isinstance(changes, ChangesResponse):
+        return False
+
+    if changes.maintenance and changes.maintenance.kind in [
+        "daemon-reload",
+        "daemon-restart",
+    ]:
+        return True
+
+    return False

{snap_python-0.0.1.dist-info → snap_python-0.0.3.dist-info}/METADATA

@@ -1,17 +1,21 @@
 Metadata-Version: 2.1
 Name: snap-python
-Version: 0.0.1
-Summary: 
+Version: 0.0.3
+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
-Requires-Python: >=3.12,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: httpx (>=0.27.2,<0.28.0)
 Requires-Dist: pydantic (>=2.9.2,<3.0.0)
 Requires-Dist: retry (>=0.9.2,<0.10.0)
+Project-URL: Repository, https://github.com/alexlukens/snap-python
 Description-Content-Type: text/markdown
 
 # snap_python

{snap_python-0.0.1.dist-info → snap_python-0.0.3.dist-info}/RECORD

@@ -1,11 +1,13 @@
-snap_python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snap_python/client.py,sha256=5AOo71wxmiEQUv4Y5Y0Fwj-3ZFLZoJ6XPXN1El_lgt4,2985
+snap_python/__init__.py,sha256=gV43Nempk7HFKD1UCvxUhmP9x6dBmPjotcITREr81Vg,222
+snap_python/client.py,sha256=PsmO9EIszUsYc6zYOOijFjFr1jdHQR2dxl3by2bWUMo,5150
 snap_python/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snap_python/components/snaps.py,sha256=zR--BC9OvWtTI3eww9o7Zs1QRajzo4aDg-6_fEwmzVQ,3166
+snap_python/components/config.py,sha256=IO_gCrumphEZioINFmXxb8I5OVsKC9cgSa28sQbZ700,1775
+snap_python/components/snaps.py,sha256=Hw1dPlgmkAo9q3YQUOnCa3Dz6b7lnA5JkkdZF71HSrs,6631
 snap_python/components/store.py,sha256=_o_2OYMvGbq_bLEQXw9zHjBrCipQ92qZaSkwdAfngAc,6451
-snap_python/schemas/changes.py,sha256=bAXYvOwEJ6sYjRh_rU3bpZ1BTT_zL0Mw_zS-fZZomTs,1368
+snap_python/schemas/changes.py,sha256=7SYUFXAQq9arl7hAA3YQ0YubMurPJtknTOVxP8ryqew,1919
 snap_python/schemas/common.py,sha256=n0npzv0CAaSK6GPY1Y9PxywWRR0KE7Wf2JML8G5e9Dk,1459
-snap_python/schemas/snaps.py,sha256=IufXEGBmMZKFlThzqKI-frEgXf4c6WpSGzDoIhtGAoo,1819
+snap_python/schemas/config.py,sha256=xXTGhk6TpwI8RlR6_qnfWlBHrBnTwr3hRCO5qCnN-6U,107
+snap_python/schemas/snaps.py,sha256=L6iXB4j9MiSR57siIkxP5MbB7I0wmDBC1dHmGs0QkY8,1960
 snap_python/schemas/store/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snap_python/schemas/store/categories.py,sha256=PewotRqoPs7cMKtlZKsHVNfnJoItmNKMekS1Be-46l0,1082
 snap_python/schemas/store/info.py,sha256=AKe93ichq8gOIQQxSaEEWHmFHeeONOqe5hfOADJP1gU,3330
@@ -14,8 +16,8 @@ snap_python/schemas/store/json/category_schema.json,sha256=c4h_eyyBbChOiNby3hYfj
 snap_python/schemas/store/json/snaps_find_schema.json,sha256=TfKpnievs5QOc7ah97ATMCQTOEfKspONTZnwSwq_0fI,8866
 snap_python/schemas/store/json/snaps_info_schema.json,sha256=udoOovb6Ea7EnE_R9RuZ1CpY1wOJ3-K8xP4-8zKHgrQ,15888
 snap_python/schemas/store/search.py,sha256=ewsc00BV4S1AIZMCj-HCvB7lOznGpWImHv7YZbkRBhc,4496
-snap_python/utils.py,sha256=cQOh5hE9gdLwFA1dAN3CCeC1MYJh9J8yQZstcg0JMUE,434
-snap_python-0.0.1.dist-info/LICENSE,sha256=lYXNZszxC_l2rlBvrHYs-esDegxWh8MKtjrdxA24uOk,1072
-snap_python-0.0.1.dist-info/METADATA,sha256=StMCrHoDOGdhrDA4hl6ylXs13gvVRDlpE5gLhjCCbxU,829
-snap_python-0.0.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snap_python-0.0.1.dist-info/RECORD,,
+snap_python/utils.py,sha256=pE-mVtoq5KMZH_Xg1O9lJlAmktLyuIdAVBEomuLZjWI,752
+snap_python-0.0.3.dist-info/LICENSE,sha256=lYXNZszxC_l2rlBvrHYs-esDegxWh8MKtjrdxA24uOk,1072
+snap_python-0.0.3.dist-info/METADATA,sha256=N-hc-RSJiouLpnb7QGXB2OAHUBdrU_YctJalRJqfxY8,1096
+snap_python-0.0.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snap_python-0.0.3.dist-info/RECORD,,