snap-python 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

snap_python/components/store.py

@@ -20,6 +20,7 @@ from snap_python.schemas.store.refresh import (
 from snap_python.schemas.store.search import (
     VALID_SEARCH_CATEGORY_FIELDS,
     ArchSearchResponse,
+    PaginatedSnapSearchResponse,
     SearchResponse,
 )
 
@@ -396,3 +397,100 @@ class StoreEndpoints:
         )
         response.raise_for_status()
         return RefreshRevisionResponse.model_validate_json(response.content)
+
+    async def get_many_snap_revision_info(
+        self,
+        snap_name: str,
+        from_revision: int,
+        to_revision: int,
+        arch: str,
+        fields=None,
+    ) -> RefreshRevisionResponse:
+        """Get information about a snap revision.
+
+        :param snap_name: The name of the snap.
+        :type snap_name: str
+        :param revision: The revision of the snap.
+        :type revision: int
+        :param arch: The architecture of the snap to retrieve details about (e.g. amd64, arm64, riscv64, etc).
+        :type arch: str
+
+        :returns: The snap revision information.
+        :rtype: RefreshRevisionResponse
+        """
+
+        # cast revision to int
+        from_revision = int(from_revision)
+        to_revision = int(to_revision)
+        extra_headers = {"Snap-Device-Architecture": arch}
+        snap_info = await self.get_snap_info(snap_name=snap_name)
+
+        # I don't think this matters for the "context" field, so using info from the first available
+        channel_map_item = snap_info.channel_map[0]
+
+        payload = {
+            "context": [
+                {
+                    "tracking-channel": "stable",
+                    "snap-id": snap_info.snap_id,
+                    "revision": channel_map_item.revision,
+                    "instance-key": str(uuid.uuid4()),
+                }
+            ],
+            "actions": [],
+        }
+        for revision in range(from_revision, to_revision + 1):
+            payload["actions"].append(
+                {
+                    "action": "download",
+                    "name": snap_name,
+                    "revision": revision,
+                    "instance-key": str(uuid.uuid4()),
+                }
+            )
+
+        if fields is not None:
+            if not all(field in VALID_SNAP_REFRESH_FIELDS for field in fields):
+                raise ValueError(
+                    f"Invalid fields. Allowed fields: {VALID_SNAP_REFRESH_FIELDS}"
+                )
+        payload["fields"] = fields
+
+        response = await self.snap_refresh(
+            snap_name=snap_name,
+            payload=payload,
+            extra_headers=extra_headers,
+        )
+        response.raise_for_status()
+        return RefreshRevisionResponse.model_validate_json(response.content)
+
+    async def get_snap_search_paginated(
+        self,
+        q: str = "",
+        scope: str = "wide",
+        arch: str = "wide",
+        page: int = 1,
+        limit: int = 100,
+        confinement: str = "strict,classic",
+    ) -> PaginatedSnapSearchResponse:
+        payload = {
+            "scope": scope,
+            "arch": arch,
+            "page": page,
+            "size": limit,
+            "confinement": confinement,
+        }
+        if q:
+            payload["q"] = q
+
+        response = await self.store_client.get(
+            f"{self._raw_base_url}/api/v1/snaps/search",
+            params=payload,
+        )
+
+        response.raise_for_status()
+        response_json = response.json()
+        response_json["page"] = page
+        response_json["limit"] = limit
+
+        return PaginatedSnapSearchResponse.model_validate(response_json)

snap_python/schemas/store/refresh.py

@@ -72,6 +72,12 @@ class StoreRefreshSnap(Snap, SnapRefreshFields):
     pass
 
 
+class RefreshResultError(BaseModel):
+    code: str
+    message: str
+    extra: Optional[dict] = None
+
+
 class RefreshResultData(BaseModel):
     model_config = ConfigDict(extra="forbid", exclude_unset=True)
 
@@ -98,6 +104,13 @@ class RefreshResultData(BaseModel):
     snap_id: str = Field(
         ..., alias=AliasChoices("snap-id", "snap_id"), serialization_alias="snap-id"
     )
+    error: RefreshResultError | None = None
+
+    @property
+    def is_error(self) -> bool:
+        if self.error:
+            return True
+        return False
 
 
 class RefreshRevisionResponse(BaseModel):

snap_python/schemas/store/search.py

@@ -7,6 +7,7 @@ from pydantic import (
     BaseModel,
     ConfigDict,
     Field,
+    computed_field,
 )
 
 from snap_python.schemas.common import Revision
@@ -144,4 +145,35 @@ class ArchSearchResponse(BaseModel):
     results: list[ArchSearchItem] = Field(
         alias=AliasChoices(AliasPath("_embedded", "clickindex:package"), "results")
     )
-    arch: str
+    arch: str = "wide"
+
+
+class PaginatedResponse(BaseModel):
+    total: int
+    page: int = Field(ge=0)
+    limit: int = Field(ge=1, le=100)
+
+    @computed_field
+    @property
+    def next_page(self) -> Optional[int]:
+        if self.page * self.limit + self.limit < self.total:
+            return self.page + 1
+        return None
+
+    @computed_field
+    @property
+    def previous_page(self) -> Optional[int]:
+        if self.page > 0:
+            return self.page - 1
+        return None
+
+    @computed_field
+    @property
+    def has_more(self) -> bool:
+        return self.page * self.limit + self.limit < self.total
+
+
+class PaginatedSnapSearchResponse(PaginatedResponse):
+    results: list[ArchSearchItem] = Field(
+        alias=AliasChoices(AliasPath("_embedded", "clickindex:package"), "results")
+    )

snap_python/scrape.py

@@ -25,7 +25,6 @@ def get_highest_revision(channel_map: list[ChannelMapItem]) -> ChannelMapItem:
 
     """
 
-    print(channel_map)
     return max(channel_map, key=lambda x: x.revision)
 
 

{snap_python-0.1.2.dist-info → snap_python-0.1.4.dist-info}/METADATA

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

{snap_python-0.1.2.dist-info → snap_python-0.1.4.dist-info}/RECORD

@@ -3,7 +3,7 @@ snap_python/client.py,sha256=rZAfzcQNhdtTyjQml1N-9-nAianFyEwOaI4H_0FMaFE,6612
 snap_python/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snap_python/components/config.py,sha256=IO_gCrumphEZioINFmXxb8I5OVsKC9cgSa28sQbZ700,1775
 snap_python/components/snaps.py,sha256=FQ362L83jmhu3MLKszOU1w5jGP8l5-WNBlUTLnR6IW8,13176
-snap_python/components/store.py,sha256=8r1WUOBu2vPpDXGSSgK9f1HKU3Rfl6wAPu6siTnEcPU,13803
+snap_python/components/store.py,sha256=lxN-6cVslAeen-yfZqMPQ2iNvDUNBCClWIvLn5PZi2Q,16971
 snap_python/schemas/changes.py,sha256=7SYUFXAQq9arl7hAA3YQ0YubMurPJtknTOVxP8ryqew,1919
 snap_python/schemas/common.py,sha256=GLtC9aBo3O8vLKX9PNvzE-_DKN02OGpwsS7Ik2WK9-8,2608
 snap_python/schemas/config.py,sha256=xXTGhk6TpwI8RlR6_qnfWlBHrBnTwr3hRCO5qCnN-6U,107
@@ -15,11 +15,11 @@ snap_python/schemas/store/json/category_by_name_schema.json,sha256=3-95m6V2WXaPC
 snap_python/schemas/store/json/category_schema.json,sha256=c4h_eyyBbChOiNby3hYfjAh9i_1MDbPJnHHU4rGOGss,1898
 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/refresh.py,sha256=EjzQurejMggHJUqALoJUpXt26nh_OClkd1qZYaibews,2928
-snap_python/schemas/store/search.py,sha256=-Fd1G821-V6JVxvbcgfnzXy8VQoWnS9MR1oLdRurqu0,3743
-snap_python/scrape.py,sha256=ZL-kaKdhkz2SfM0iDoJdRLH-lovRyONRNyOm-xivyII,4599
+snap_python/schemas/store/refresh.py,sha256=HAlt-rKfy7vmZSCujMXtW9HHXlVYbHGFwy_BKfD1uCU,3190
+snap_python/schemas/store/search.py,sha256=4ghZb8xY6IESxZuAvzSjM9RaEwZAH3zjiC06zLc0zvU,4561
+snap_python/scrape.py,sha256=ZDJAROp8jwossaAA78gBFTKQzrfnO11RgyyOZqevNd0,4576
 snap_python/utils.py,sha256=cmUooPg5DzNL197Xxvu7LGD4Gwk3xxsT68wbVytRtV0,1240
-snap_python-0.1.2.dist-info/LICENSE,sha256=lYXNZszxC_l2rlBvrHYs-esDegxWh8MKtjrdxA24uOk,1072
-snap_python-0.1.2.dist-info/METADATA,sha256=mdz8xXB3SRa_3cnXmmJjYSlY7f4BuzYOIkw7Rw8chqw,1883
-snap_python-0.1.2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-snap_python-0.1.2.dist-info/RECORD,,
+snap_python-0.1.4.dist-info/LICENSE,sha256=lYXNZszxC_l2rlBvrHYs-esDegxWh8MKtjrdxA24uOk,1072
+snap_python-0.1.4.dist-info/METADATA,sha256=jT6zFn5qHbXNkM8oS4fZQbdGqgFytApIIL85IydP_6M,1883
+snap_python-0.1.4.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+snap_python-0.1.4.dist-info/RECORD,,

{snap_python-0.1.2.dist-info → snap_python-0.1.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.1
+Generator: poetry-core 2.1.2
 Root-Is-Purelib: true
 Tag: py3-none-any