snap-python 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

snap_python/__init__.py

@@ -5,14 +5,3 @@ 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)
-
-ch = logging.StreamHandler()
-ch.setLevel(numeric_level)
-formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
-ch.setFormatter(formatter)
-logger.addHandler(ch)
-
-fh = logging.FileHandler("snap_python.log")
-fh.setLevel(numeric_level)
-fh.setFormatter(formatter)
-logger.addHandler(fh)

snap_python/client.py

@@ -18,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",
@@ -56,6 +58,18 @@ class SnapClient(AbstractSnapsClient):
 
     @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
         )
@@ -64,6 +78,18 @@ class SnapClient(AbstractSnapsClient):
 
     @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()

snap_python/components/snaps.py

@@ -6,7 +6,10 @@ import httpx
 
 from snap_python.schemas.changes import ChangesResponse
 from snap_python.schemas.common import AsyncResponse
-from snap_python.schemas.snaps import SingleSnapResponse, SnapListResponse
+from snap_python.schemas.snaps import (
+    InstalledSnapListResponse,
+    SingleInstalledSnapResponse,
+)
 from snap_python.utils import AbstractSnapsClient, going_to_reload_daemon
 
 logger = logging.getLogger("snap_python.components.snaps")
@@ -17,12 +20,12 @@ class SnapsEndpoints:
         self._client = client
         self.common_endpoint = "snaps"
 
-    async def list_installed_snaps(self) -> SnapListResponse:
+    async def list_installed_snaps(self) -> InstalledSnapListResponse:
         response: httpx.Response = await self._client.request(
             "GET", self.common_endpoint
         )
 
-        response = SnapListResponse.model_validate_json(response.content)
+        response = InstalledSnapListResponse.model_validate_json(response.content)
         if response.status_code > 299:
             raise httpx.HTTPStatusError(
                 request=response.request,
@@ -31,7 +34,7 @@ class SnapsEndpoints:
             )
         return response
 
-    async def get_snap_info(self, snap: str) -> SingleSnapResponse:
+    async def get_snap_info(self, snap: str) -> SingleInstalledSnapResponse:
         try:
             response: httpx.Response = await self._client.request(
                 "GET", f"{self.common_endpoint}/{snap}"
@@ -44,7 +47,7 @@ class SnapsEndpoints:
             )
             response = e.response
 
-        return SingleSnapResponse.model_validate_json(response.content)
+        return SingleInstalledSnapResponse.model_validate_json(response.content)
 
     async def is_snap_installed(self, snap: str) -> bool:
         snap_info = await self.get_snap_info(snap)

snap_python/schemas/common.py

@@ -62,3 +62,39 @@ class Media(BaseModel):
 
 class AsyncResponse(BaseResponse):
     change: str
+
+
+class Download(BaseModel):
+    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+
+    size: float
+
+
+class Revision(BaseModel):
+    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+
+    base: Optional[SnapBaseVersion] = None
+    channel: Optional[str] = None
+    common_ids: Optional[list[str]] = Field(
+        None, validation_alias=AliasChoices("common-ids", "common_ids")
+    )
+    confinement: Optional[SnapConfinement] = None
+    download: Optional[Download] = None
+    revision: Optional[int | str] = None
+    type: Optional[str] = None
+    version: Optional[str] = None
+
+
+class Publisher(BaseModel):
+    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+
+    display_name: str = Field(
+        ...,
+        validation_alias=AliasChoices("display-name", "display_name"),
+        description="Display name corresponding to the publisher.",
+    )
+    id: str = Field(..., description="The publisher id.")
+    username: str = Field(..., description="Username belonging to the publisher.")
+    validation: Optional[str] = Field(
+        None, description="Indicates if the account has been validated."
+    )

snap_python/schemas/snaps.py

@@ -1,27 +1,26 @@
+from typing import Optional
+
 from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
 
 from snap_python.schemas.common import (
     BaseErrorResult,
     BaseResponse,
     Media,
+    Publisher,
+    Revision,
     SnapApp,
-    SnapBaseVersion,
-    SnapConfinement,
 )
+from snap_python.schemas.store.categories import Category
 
 
-class Snap(BaseModel):
-    model_config = ConfigDict(extra="allow")
+class InstalledSnapFields(Revision):
     apps: list[SnapApp] = Field(default_factory=list)
-    base: SnapBaseVersion | None = None
-    channel: str
-    confinement: SnapConfinement
-    contact: str
-    description: str
-    developer: str
-    devmode: bool
-    icon: str | None = None
-    id: str
+    developer: Optional[str] = None
+    devmode: Optional[bool] = None
+    icon: Optional[str] = None
+    id: Optional[str] = Field(
+        None, validation_alias=AliasChoices("id", "snap-id"), serialization_alias="id"
+    )
     ignore_validation: bool = Field(
         validation_alias=AliasChoices("ignore-validation", "ignore_validation"),
         serialization_alias="ignore-validation",
@@ -35,36 +34,60 @@ class Snap(BaseModel):
         serialization_alias="installed-size",
     )
     jailmode: bool
-    license: str = "unset"
-    links: dict[str, list[str]] | None = None
-    media: list[Media] = Field(default_factory=list)
     mounted_from: str = Field(
         validation_alias=AliasChoices("mounted-from", "mounted_from"),
         serialization_alias="mounted-from",
     )
-    name: str
-    private: bool
-    publisher: dict[str, str] | None = None
-    revision: str
     status: str
-    summary: str
-    title: str | None = None
-    tracking_channel: str | None = Field(
+    tracking_channel: Optional[str] = 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 StoreSnapFields(BaseModel):
+    gated_snap_ids: Optional[list[str]] = Field(
+        None, alias=AliasChoices("gated-snap-ids", "gated_snap_ids")
+    )
+    categories: Optional[list[Category]] = None
+    prices: Optional[dict[str, str]] = None
+    snap_id: Optional[str] = Field(None, alias=AliasChoices("snap-id", "snap_id"))
+    store_url: Optional[str] = Field(None, alias=AliasChoices("store-url", "store_url"))
+    trending: Optional[bool] = None
+
+
+class Snap(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+
+    contact: Optional[str] = None
+    description: Optional[str] = None
+    license: str = "unset"
+    links: Optional[dict[str, list[str]]] = None
+    media: Optional[list[Media]] = None
+    name: Optional[str] = None
+    private: Optional[bool] = None
+    publisher: Optional[Publisher] = Field(None, description="The publisher.")
+    summary: Optional[str] = None
+    title: Optional[str] = None
+    unlisted: Optional[bool] = None
+    website: Optional[str] = None
+
+
+class StoreSnap(Snap, StoreSnapFields):
+    pass
+
+
+class InstalledSnap(Snap, InstalledSnapFields):
+    pass
+
+
+class SingleInstalledSnapResponse(BaseResponse):
+    result: InstalledSnap | BaseErrorResult
 
 
-class SnapListResponse(BaseResponse):
-    result: list[Snap]
+class InstalledSnapListResponse(BaseResponse):
+    result: list[InstalledSnap]
 
     def __len__(self):
         return len(self.result)

snap_python/schemas/store/info.py

@@ -6,7 +6,7 @@ from typing import List, Optional
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
-from snap_python.schemas.store.search import Snap
+from snap_python.schemas.snaps import StoreSnap
 
 VALID_SNAP_INFO_FIELDS = [
     "architectures",
@@ -130,5 +130,5 @@ class InfoResponse(BaseModel):
     default_track: Optional[str] = Field(None, alias="default-track")
     error_list: Optional[List[ErrorListItem]] = Field(None, alias="error-list")
     name: str
-    snap: Snap
+    snap: StoreSnap
     snap_id: str = Field(..., alias="snap-id")

snap_python/schemas/store/search.py

@@ -1,13 +1,9 @@
-# generated by datamodel-codegen:
-#   filename:  snaps_find_schema.json
-#   timestamp: 2024-09-17T01:18:24+00:00
-
-
 from typing import Any, Dict, List, Optional
 
 from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
 
-from snap_python.schemas.store.categories import Category, Media
+from snap_python.schemas.common import Revision
+from snap_python.schemas.snaps import InstalledSnap, StoreSnap, StoreSnapFields
 
 VALID_SEARCH_CATEGORY_FIELDS = [
     "base",
@@ -40,65 +36,6 @@ class ErrorListItem(BaseModel):
     message: str
 
 
-class Download(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
-
-    size: float
-
-
-class Revision(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
-
-    base: Optional[str] = None
-    channel: Optional[str] = None
-    common_ids: Optional[List[str]] = Field(None, alias="common-ids")
-    confinement: Optional[str] = None
-    download: Optional[Download] = None
-    revision: Optional[float] = None
-    type: Optional[str] = None
-    version: Optional[str] = None
-
-
-class Publisher(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
-
-    display_name: str = Field(
-        ...,
-        alias="display-name",
-        description="Display name corresponding to the publisher.",
-    )
-    id: str = Field(..., description="The publisher id.")
-    username: str = Field(..., description="Username belonging to the publisher.")
-    validation: Optional[str] = Field(
-        None, description="Indicates if the account has been validated."
-    )
-
-
-class Snap(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
-
-    categories: Optional[List[Category]] = None
-    contact: Optional[str] = None
-    description: Optional[str] = ""
-    gated_snap_ids: Optional[List[str]] = Field(
-        None, alias=AliasChoices("gated-snap-ids", "gated_snap_ids")
-    )
-    license: Optional[str] = None
-    links: Optional[Dict[str, Any]] = None
-    media: Optional[List[Media]] = None
-    name: Optional[str] = None
-    prices: Optional[Dict[str, Any]] = None
-    private: Optional[bool] = None
-    publisher: Optional[Publisher] = Field(None, description="The publisher.")
-    snap_id: Optional[str] = Field(None, alias=AliasChoices("snap-id", "snap_id"))
-    store_url: Optional[str] = Field(None, alias=AliasChoices("store-url", "store_url"))
-    summary: Optional[str] = None
-    title: Optional[str] = None
-    trending: Optional[bool] = None
-    unlisted: Optional[bool] = None
-    website: Optional[str] = None
-
-
 class SnapDetails(BaseModel):
     aliases: Optional[List[Dict]] = None
     anon_download_url: str
@@ -145,16 +82,39 @@ class SnapDetails(BaseModel):
 
 
 class SearchResult(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True, exclude_none=True)
+    model_config = ConfigDict(extra="forbid")
 
     name: str
     revision: Optional[Revision] = None
-    snap: Snap
+    snap: StoreSnap
     snap_id: str = Field(alias=AliasChoices("snap-id", "snap_id"))
 
+    @classmethod
+    def from_installed_snap(cls, installed_snap: InstalledSnap):
+        snap_info: dict = installed_snap.model_dump(mode="json")
+        revision_snap_fields = Revision.model_fields.keys()
+        revision_info = {}
+        for field in revision_snap_fields:
+            if field in snap_info:
+                revision_info[field] = snap_info.pop(field)
+
+        snap_id = snap_info.pop("id")
+        snap_name = snap_info.pop("name")
+
+        # get set of acceptable fields for StoreSnap
+        store_snap_fields = StoreSnapFields.model_fields.keys()
+        snap_info = {
+            key: value for key, value in snap_info.items() if key in store_snap_fields
+        }
+
+        snap_info = {"snap": snap_info, "snap-id": snap_id, "name": snap_name}
+        snap_info["revision"] = revision_info
+
+        return cls.model_validate(snap_info)
+
 
 class SearchResponse(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True, exclude_none=True)
+    model_config = ConfigDict(extra="forbid")
 
     error_list: Optional[List[ErrorListItem]] = Field(None, alias="error-list")
     results: List[SearchResult]

{snap_python-0.0.2.dist-info → snap_python-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snap-python
-Version: 0.0.2
+Version: 0.0.4
 Summary: An api to interact with snapd and snap stores
 Home-page: https://github.com/alexlukens/snap-python
 License: MIT

{snap_python-0.0.2.dist-info → snap_python-0.0.4.dist-info}/RECORD

@@ -1,23 +1,23 @@
-snap_python/__init__.py,sha256=wsEFXtK9EflFT0l7EuICfsX31OgUq--7cpQ-YXiWCbc,535
-snap_python/client.py,sha256=a5xyEC3RzFEiMr-p_1KBFhDfCFROuErSMkmqTh8p2fQ,3953
+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/config.py,sha256=IO_gCrumphEZioINFmXxb8I5OVsKC9cgSa28sQbZ700,1775
-snap_python/components/snaps.py,sha256=Hw1dPlgmkAo9q3YQUOnCa3Dz6b7lnA5JkkdZF71HSrs,6631
+snap_python/components/snaps.py,sha256=RkCxxHfArWATx7bsNst4v0yvJPqVQtaKJkLm_bO70qE,6698
 snap_python/components/store.py,sha256=_o_2OYMvGbq_bLEQXw9zHjBrCipQ92qZaSkwdAfngAc,6451
 snap_python/schemas/changes.py,sha256=7SYUFXAQq9arl7hAA3YQ0YubMurPJtknTOVxP8ryqew,1919
-snap_python/schemas/common.py,sha256=n0npzv0CAaSK6GPY1Y9PxywWRR0KE7Wf2JML8G5e9Dk,1459
+snap_python/schemas/common.py,sha256=GLtC9aBo3O8vLKX9PNvzE-_DKN02OGpwsS7Ik2WK9-8,2608
 snap_python/schemas/config.py,sha256=xXTGhk6TpwI8RlR6_qnfWlBHrBnTwr3hRCO5qCnN-6U,107
-snap_python/schemas/snaps.py,sha256=L6iXB4j9MiSR57siIkxP5MbB7I0wmDBC1dHmGs0QkY8,1960
+snap_python/schemas/snaps.py,sha256=y1v-FjZ4ZpcqmLxXbULP6Wa85RMPjXQpbKGf0CEHVIg,2846
 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
+snap_python/schemas/store/info.py,sha256=TuqG5wZc89e_Epai1xkcpA1nXNMKBOKng0B40xm_PfU,3333
 snap_python/schemas/store/json/category_by_name_schema.json,sha256=3-95m6V2WXaPCu_DZw-STa9YHPEbr7CI8fbhjaq881s,1674
 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/search.py,sha256=ewsc00BV4S1AIZMCj-HCvB7lOznGpWImHv7YZbkRBhc,4496
+snap_python/schemas/store/search.py,sha256=GFfK8qfYnCD1UziU5kWmmjac03qNYWWkmIGcKZoSb90,3223
 snap_python/utils.py,sha256=pE-mVtoq5KMZH_Xg1O9lJlAmktLyuIdAVBEomuLZjWI,752
-snap_python-0.0.2.dist-info/LICENSE,sha256=lYXNZszxC_l2rlBvrHYs-esDegxWh8MKtjrdxA24uOk,1072
-snap_python-0.0.2.dist-info/METADATA,sha256=azhCpe9YohlK3uhjIdY_wgDUdAid7tPNQtcakwpoZ7Q,1096
-snap_python-0.0.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snap_python-0.0.2.dist-info/RECORD,,
+snap_python-0.0.4.dist-info/LICENSE,sha256=lYXNZszxC_l2rlBvrHYs-esDegxWh8MKtjrdxA24uOk,1072
+snap_python-0.0.4.dist-info/METADATA,sha256=CsfubdQSuEypyBzgGd42EHi1EyNmjwO78b88DEsh1RI,1096
+snap_python-0.0.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snap_python-0.0.4.dist-info/RECORD,,