snap-python 0.1.4__tar.gz → 0.1.6__tar.gz

{snap_python-0.1.4 → snap_python-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: snap-python
-Version: 0.1.4
+Version: 0.1.6
 Summary: Interact with snapd and snapstore(s) from Python
 License: MIT
 Author: Alexander Lukens

{snap_python-0.1.4 → snap_python-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snap-python"
-version = "0.1.4"
+version = "0.1.6"
 description = "Interact with snapd and snapstore(s) from Python"
 authors = ["Alexander Lukens <alexdlukens@gmail.com>"]
 license = "MIT"

{snap_python-0.1.4 → snap_python-0.1.6}/src/snap_python/client.py

@@ -61,7 +61,6 @@ 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:

{snap_python-0.1.4 → snap_python-0.1.6}/src/snap_python/components/snaps.py

@@ -1,12 +1,14 @@
 import asyncio
 import logging
 from pathlib import Path
+from typing import Any
 
 import httpx
 
 from snap_python.schemas.changes import ChangesResponse
-from snap_python.schemas.common import AsyncResponse
+from snap_python.schemas.common import AsyncResponse, BaseErrorResult
 from snap_python.schemas.snaps import (
+    AppsResponse,
     InstalledSnapListResponse,
     SingleInstalledSnapResponse,
 )
@@ -34,14 +36,13 @@ class SnapsEndpoints:
             "GET", self.common_endpoint
         )
 
-        response = InstalledSnapListResponse.model_validate_json(response.content)
         if response.status_code > 299:
             raise httpx.HTTPStatusError(
                 request=response.request,
                 response=response,
                 message=f"Invalid status code in response: {response.status_code}",
             )
-        return response
+        return InstalledSnapListResponse.model_validate_json(response.content)
 
     async def get_snap_info(self, snap: str) -> SingleInstalledSnapResponse:
         """
@@ -331,3 +332,137 @@ class SnapsEndpoints:
                 previous_changes = changes
             return changes
         return response
+
+    async def disable_snap(
+        self,
+        snap: str,
+        wait: bool = False,
+    ) -> AsyncResponse | ChangesResponse:
+        """
+        Disables a snap package.
+
+        :param snap: The name of the snap package to disable.
+        :type snap: str
+        :param wait: Whether to wait for the disable operation to complete. Defaults to False.
+        :type wait: bool, optional
+
+        :returns: The response from the disable operation.
+        :rtype: AsyncResponse | ChangesResponse
+
+        :raises SnapdAPIError: If there is an error during the snap disable operation.
+        """
+        request_data = {
+            "action": "disable",
+        }
+
+        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)
+                except httpx.HTTPError:
+                    if going_to_reload_daemon(previous_changes):
+                        logger.debug("Waiting for daemon to reload")
+                        await asyncio.sleep(0.1)
+                        continue
+                    raise
+                if changes.ready:
+                    break
+                if isinstance(changes.result, BaseErrorResult):
+                    raise SnapdAPIError(
+                        f"Error in snap disable: {changes.result.message}"
+                    )
+                if changes.result.err:
+                    raise SnapdAPIError(f"Error in snap disable: {changes.result.err}")
+                await asyncio.sleep(0.1)
+                previous_changes = changes
+            return changes
+
+        return response
+
+    async def enable_snap(
+        self,
+        snap: str,
+        wait: bool = False,
+    ) -> AsyncResponse | ChangesResponse:
+        """
+        enables a snap package.
+
+        :param snap: The name of the snap package to enable.
+        :type snap: str
+        :param wait: Whether to wait for the enable operation to complete. Defaults to False.
+        :type wait: bool, optional
+
+        :returns: The response from the enable operation.
+        :rtype: AsyncResponse | ChangesResponse
+
+        :raises SnapdAPIError: If there is an error during the snap enable operation.
+        """
+        request_data = {
+            "action": "enable",
+        }
+
+        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)
+                except httpx.HTTPError:
+                    if going_to_reload_daemon(previous_changes):
+                        logger.debug("Waiting for daemon to reload")
+                        await asyncio.sleep(0.1)
+                        continue
+                    raise
+                if changes.ready:
+                    break
+                if isinstance(changes.result, BaseErrorResult):
+                    raise SnapdAPIError(
+                        f"Error in snap enable: {changes.result.message}"
+                    )
+                if changes.result.err:
+                    raise SnapdAPIError(f"Error in snap enable: {changes.result.err}")
+                await asyncio.sleep(0.1)
+                previous_changes = changes
+            return changes
+
+        return response
+
+    async def get_snap_apps(
+        self,
+        snap: str,
+        services_only: bool = False,
+    ) -> AppsResponse:
+        """
+        Retrieves the applications associated with a specific snap.
+
+        :param snap: The name of the snap to retrieve applications for.
+        :type snap: str
+        :param services_only: Whether to retrieve only service applications.
+        :type services_only: bool
+
+        :returns: The response containing the list of applications for the specified snap.
+        :rtype: AppsResponse
+        """
+
+        payload: dict[str, Any] = {"names": [snap]}
+        if services_only:
+            payload["select"] = "service"
+
+        response: httpx.Response = await self._client.request(
+            "GET", "apps", params=payload
+        )
+        if response.status_code != 200:
+            raise SnapdAPIError(f"Failed to retrieve apps for snap: {snap}")
+        return AppsResponse.model_validate_json(response.content)

{snap_python-0.1.4 → snap_python-0.1.6}/src/snap_python/components/store.py

@@ -23,6 +23,10 @@ from snap_python.schemas.store.search import (
     PaginatedSnapSearchResponse,
     SearchResponse,
 )
+from snap_python.schemas.store.track import (
+    TrackRiskMap,
+    channel_map_to_current_track_map,
+)
 
 
 class StoreEndpoints:
@@ -165,7 +169,7 @@ class StoreEndpoints:
     async def find(
         self,
         query: str | None = None,
-        fields: str | None = None,
+        fields: list[str] | None = None,
         name_startswith: str | None = None,
         architecture: str | None = None,
         common_id: str | None = None,
@@ -183,7 +187,7 @@ class StoreEndpoints:
         :param query: The search query.
         :type query: str, optional
         :param fields: The fields to include in the response.
-        :type fields: str, optional
+        :type fields: list[str], optional
         :param name_startswith: Filter snaps by name prefix.
         :type name_startswith: str, optional
         :param architecture: Filter snaps by architecture.
@@ -494,3 +498,28 @@ class StoreEndpoints:
         response_json["limit"] = limit
 
         return PaginatedSnapSearchResponse.model_validate(response_json)
+
+    async def get_track_risk_map(
+        self, snap_name: str
+    ) -> dict[str, dict[str, TrackRiskMap]]:
+        """Get the track risk map for a snap.
+
+        :param snap_name: The name of the snap.
+        :type snap_name: str
+
+        :returns: A dictionary mapping tracks to their risk maps.
+        :rtype: dict[str, TrackRiskMap]
+        """
+        snap_info = await self.get_snap_info(
+            snap_name=snap_name,
+            fields=[
+                "channel-map",
+                "architectures",
+                "base",
+                "revision",
+                "confinement",
+                "version",
+                "created-at",
+            ],
+        )
+        return channel_map_to_current_track_map(snap_info.channel_map)

{snap_python-0.1.4 → snap_python-0.1.6}/src/snap_python/schemas/snaps.py

@@ -32,7 +32,8 @@ class InstalledSnapFields(Revision):
         validation_alias=AliasChoices("ignore-validation", "ignore_validation"),
         serialization_alias="ignore-validation",
     )
-    install_date: AwareDatetime = Field(
+    install_date: Optional[AwareDatetime] = Field(
+        default=None,
         validation_alias=AliasChoices("install-date", "install_date"),
         serialization_alias="install-date",
     )
@@ -98,3 +99,26 @@ class InstalledSnapListResponse(BaseResponse):
 
     def __len__(self):
         return len(self.result)
+
+
+class SnapAppInfo(BaseModel):
+    snap: Optional[str] = None
+    name: str
+    desktop_file: Optional[str] = Field(
+        default=None,
+        validation_alias=AliasChoices("desktop-file", "desktop_file"),
+        serialization_alias="desktop-file",
+    )
+    daemon: Optional[str] = None
+    enabled: Optional[bool] = None
+    active: Optional[bool] = None
+    common_id: Optional[str] = Field(
+        default=None,
+        validation_alias=AliasChoices("common-id", "common_id"),
+        serialization_alias="common-id",
+    )
+    activators: Optional[list[dict]] = None
+
+
+class AppsResponse(BaseResponse):
+    result: list[SnapAppInfo]

{snap_python-0.1.4 → snap_python-0.1.6}/src/snap_python/schemas/store/info.py

@@ -1,10 +1,12 @@
-# generated by datamodel-codegen:
-#   filename:  snaps_info_schema.json
-#   timestamp: 2024-10-17T01:47:02+00:00
-
 from typing import List, Optional
 
-from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
+from pydantic import (
+    AliasChoices,
+    AwareDatetime,
+    BaseModel,
+    ConfigDict,
+    Field,
+)
 
 from snap_python.schemas.snaps import StoreSnap
 

snap_python-0.1.6/src/snap_python/schemas/store/track.py

@@ -0,0 +1,132 @@
+import logging
+from typing import Optional
+
+from pydantic import (
+    AwareDatetime,
+    BaseModel,
+    field_validator,
+)
+
+from snap_python.schemas.store.info import Channel, ChannelMapItem
+
+logger = logging.getLogger("snap_python.schemas.store.track")
+
+
+class TrackRevisionDetails(BaseModel):
+    arch: str
+    base: str
+    channel: Channel
+    confinement: str
+    created_at: AwareDatetime
+    released_at: AwareDatetime
+    revision: int
+    risk: str
+    track: str
+    version: str
+
+    @field_validator("arch")
+    @classmethod
+    def validate_arch(cls, value):
+        valid_architectures = {
+            "amd64",
+            "arm64",
+            "armhf",
+            "i386",
+            "ppc64el",
+            "s390x",
+            "riscv64",
+        }
+        if value not in valid_architectures:
+            raise ValueError(
+                f"Invalid architecture: {value}. Must be one of {', '.join(valid_architectures)}."
+            )
+        return value
+
+
+class TrackRiskMap(BaseModel):
+    amd64: Optional[TrackRevisionDetails] = None
+    arm64: Optional[TrackRevisionDetails] = None
+    armhf: Optional[TrackRevisionDetails] = None
+    i386: Optional[TrackRevisionDetails] = None
+    ppc64el: Optional[TrackRevisionDetails] = None
+    s390x: Optional[TrackRevisionDetails] = None
+    riscv64: Optional[TrackRevisionDetails] = None
+
+    @property
+    def architectures(self) -> list[str]:
+        """Return a list of architectures that have revisions."""
+        return [
+            arch for arch, details in self.model_dump().items() if details is not None
+        ]
+
+
+def channel_map_to_current_track_map(
+    channel_map: list[ChannelMapItem],
+) -> dict[str, dict[str, TrackRiskMap]]:
+    """Convert a list of ChannelMapItem to a map of TrackRiskMap.
+
+    track -> risk -> arch
+    """
+    # track -> risk -> arch
+    current_track_map: dict[str, dict[str, TrackRiskMap]] = {}
+
+    all_tracks = set(item.channel.track for item in channel_map)
+    logger.debug(f"Found tracks: {', '.join(all_tracks)}")
+
+    for track in all_tracks:
+        current_track_map[track] = {}
+
+    for item in channel_map:
+        track = item.channel.track
+        risk = item.channel.risk
+
+        if not item.architectures:
+            logger.error(
+                f"Warning: Channel {item} has no architectures defined. Skipping."
+            )
+            continue
+        assert (
+            len(item.architectures) == 1
+        ), "Channel must have exactly one architecture."
+
+        assert (
+            item.revision is not None
+        ), f"Channel {item} must have a revision defined."
+        assert item.channel is not None, f"Channel {item} must have a channel defined."
+        assert item.base is not None, f"Channel {item} must have a base defined."
+        assert (
+            item.confinement is not None
+        ), f"Channel {item} must have a confinement defined."
+        assert item.version is not None, f"Channel {item} must have a version defined."
+        assert (
+            item.created_at is not None
+        ), f"Channel {item} must have a created_at defined."
+        assert (
+            item.channel.released_at is not None
+        ), f"Channel {item} must have a released_at defined."
+
+        arch = item.architectures[0]
+
+        revision_details = TrackRevisionDetails(
+            arch=arch,
+            base=item.base,
+            channel=item.channel,
+            confinement=item.confinement,
+            created_at=item.created_at,
+            released_at=item.channel.released_at,
+            revision=item.revision,
+            risk=risk,
+            track=track,
+            version=item.version,
+        )
+
+        if risk not in current_track_map[track]:
+            current_track_map[track][risk] = TrackRiskMap()
+        setattr(current_track_map[track][risk], arch, revision_details)
+
+    # re validate the track map to ensure it has all required fields
+    for track, risk_map in current_track_map.items():
+        for risk in risk_map:
+            risk_map[risk] = TrackRiskMap.model_validate(risk_map[risk])
+
+    return current_track_map