snap-python 0.1.5__tar.gz → 0.1.7__tar.gz

{snap_python-0.1.5 → snap_python-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: snap-python
-Version: 0.1.5
+Version: 0.1.7
 Summary: Interact with snapd and snapstore(s) from Python
 License: MIT
 Author: Alexander Lukens
@@ -12,8 +12,8 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: httpx (>=0.27.2,<0.28.0)
-Requires-Dist: pydantic (>=2.9.2,<3.0.0)
+Requires-Dist: httpx (>0.27,<1)
+Requires-Dist: pydantic (>2.9,<3)
 Requires-Dist: retry (>=0.9.2,<0.10.0)
 Project-URL: Documentation, https://alexdlukens.github.io/snap-python/
 Project-URL: Repository, https://github.com/alexdlukens/snap-python

{snap_python-0.1.5 → snap_python-0.1.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snap-python"
-version = "0.1.5"
+version = "0.1.7"
 description = "Interact with snapd and snapstore(s) from Python"
 authors = ["Alexander Lukens <alexdlukens@gmail.com>"]
 license = "MIT"
@@ -10,8 +10,8 @@ documentation = "https://alexdlukens.github.io/snap-python/"
 
 [tool.poetry.dependencies]
 python = "^3.10"
-httpx = "^0.27.2"
-pydantic = "^2.9.2"
+httpx = ">0.27,<1"
+pydantic = ">2.9,<3"
 retry = "^0.9.2"
 
 [tool.poetry.group.dev.dependencies]

{snap_python-0.1.5 → snap_python-0.1.7}/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.5 → snap_python-0.1.7}/src/snap_python/components/store.py

@@ -1,5 +1,6 @@
 import functools
 import uuid
+from typing import Optional
 
 import retry
 from httpx import AsyncClient, Response
@@ -23,6 +24,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:
@@ -73,8 +78,19 @@ class StoreEndpoints:
         response.raise_for_status()
         return response.json()
 
+    async def get_snap_name_from_snap_id(self, snap_id: str) -> str | None:
+        response = await self.store_client.get(
+            f"https://api.snapcraft.io/v2/assertions/snap-declaration/16/{snap_id}"
+        )
+        response.raise_for_status()
+        response_json = response.json()
+        return response_json.get("headers", {}).get("snap-name", None)
+
     async def get_snap_info(
-        self, snap_name: str, fields: list[str] | None = None
+        self,
+        snap_name: Optional[str] = None,
+        snap_id: Optional[str] = None,
+        fields: list[str] | None = None,
     ) -> InfoResponse:
         """
         Get information about a snap.
@@ -89,6 +105,15 @@ class StoreEndpoints:
 
         :raises ValueError: If invalid fields are provided.
         """
+        if snap_name is None and snap_id is None:
+            raise ValueError("Either snap_name or snap_id must be provided.")
+        if snap_name is not None and snap_id is not None:
+            raise ValueError("Only one of snap_name or snap_id must be provided.")
+
+        # get snap name from id, then proceed as usual
+        if snap_id is not None:
+            snap_name = await self.get_snap_name_from_snap_id(snap_id)
+
         query = {}
         if fields is not None:
             if not all(field in VALID_SNAP_INFO_FIELDS for field in fields):
@@ -165,7 +190,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 +208,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 +519,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.5 → snap_python-0.1.7}/src/snap_python/schemas/common.py

@@ -52,7 +52,7 @@ class SnapApp(BaseModel):
 
 
 class Media(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     height: Optional[float] = None
     type: str
@@ -65,13 +65,13 @@ class AsyncResponse(BaseResponse):
 
 
 class Download(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     size: float
 
 
 class Revision(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     base: Optional[SnapBaseVersion] = None
     channel: Optional[str] = None
@@ -86,7 +86,7 @@ class Revision(BaseModel):
 
 
 class Publisher(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     display_name: str = Field(
         ...,

{snap_python-0.1.5 → snap_python-0.1.7}/src/snap_python/schemas/snaps.py

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
+from pydantic import AliasChoices, AwareDatetime, BaseModel, Field
 
 from snap_python.schemas.common import (
     BaseErrorResult,
@@ -66,8 +66,6 @@ class StoreSnapFields(BaseModel):
 
 
 class Snap(BaseModel):
-    model_config = ConfigDict(extra="forbid")
-
     contact: Optional[str] = None
     description: Optional[str] = None
     license: str = "unset"

{snap_python-0.1.5 → snap_python-0.1.7}/src/snap_python/schemas/store/categories.py

@@ -10,7 +10,7 @@ VALID_CATEGORY_FIELDS = ["name", "type", "title", "summary", "description", "med
 
 
 class Media(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     height: Optional[float] = None
     type: str
@@ -19,7 +19,7 @@ class Media(BaseModel):
 
 
 class Category(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     description: Optional[str] = None
     media: Optional[Media] = None
@@ -31,12 +31,12 @@ class Category(BaseModel):
 
 
 class CategoryResponse(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     categories: Optional[List[Category]] = None
 
 
 class SingleCategoryResponse(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     category: Category

{snap_python-0.1.5 → snap_python-0.1.7}/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
 
@@ -43,7 +45,7 @@ VALID_SNAP_INFO_FIELDS = [
 
 
 class Channel(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     architecture: str
     name: str
@@ -57,7 +59,7 @@ class Channel(BaseModel):
 
 
 class Delta(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     format: str
     sha3_384: Optional[str] = Field(
@@ -70,7 +72,7 @@ class Delta(BaseModel):
 
 
 class Download(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     deltas: List[Delta]
     sha3_384: Optional[str] = Field(
@@ -81,7 +83,7 @@ class Download(BaseModel):
 
 
 class Epoch(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     read: List[float]
     write: List[float]
@@ -96,7 +98,7 @@ class Download1(BaseModel):
 
 
 class Resource(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     architectures: Optional[List[str]] = None
     created_at: Optional[str] = Field(
@@ -113,7 +115,7 @@ class Resource(BaseModel):
 
 
 class ChannelMapItem(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     architectures: Optional[List[str]] = None
     base: Optional[str] = None
@@ -143,14 +145,14 @@ class ChannelMapItem(BaseModel):
 
 
 class ErrorListItem(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     code: str
     message: str
 
 
 class InfoResponse(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     channel_map: List[ChannelMapItem] = Field(
         ...,

{snap_python-0.1.5 → snap_python-0.1.7}/src/snap_python/schemas/store/refresh.py

@@ -79,7 +79,7 @@ class RefreshResultError(BaseModel):
 
 
 class RefreshResultData(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     default_track: Optional[str] = Field(
         None,

{snap_python-0.1.5 → snap_python-0.1.7}/src/snap_python/schemas/store/search.py

@@ -38,7 +38,7 @@ VALID_SEARCH_CATEGORY_FIELDS = [
 
 
 class ErrorListItem(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+    model_config = ConfigDict(exclude_unset=True)
 
     code: str
     message: str
@@ -90,8 +90,6 @@ class SnapDetails(BaseModel):
 
 
 class SearchResult(BaseModel):
-    model_config = ConfigDict(extra="forbid")
-
     name: str
     revision: Optional[Revision] = None
     snap: StoreSnap
@@ -124,15 +122,11 @@ class SearchResult(BaseModel):
 
 
 class SearchResponse(BaseModel):
-    model_config = ConfigDict(extra="forbid")
-
     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

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

@@ -0,0 +1,138 @@
+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):
+    """Contains details for a specific track/risk/architecture
+
+
+    Raises:
+        ValueError: If the architecture is invalid.
+    """
+
+    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):
+    """Map of architectures to their revision details for a specific risk level."""
+
+    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 track -> risk -> TrackRiskMap."""
+    # 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