bugdantic 0.3.0__tar.gz → 0.4.1__tar.gz

{bugdantic-0.3.0 → bugdantic-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bugdantic
-Version: 0.3.0
+Version: 0.4.1
 Summary: Bugzilla client based on pydantic
 Author-email: James Graham <james@hoppipolla.co.uk>
 License-Expression: MPL-2.0

{bugdantic-0.3.0 → bugdantic-0.4.1}/bugdantic/bugzilla.py

@@ -4,10 +4,21 @@ import json
 import logging
 from dataclasses import dataclass
 from datetime import datetime
-from typing import Any, Mapping, MutableMapping, Optional, Sequence, Self
+from typing import (
+    Any,
+    Generic,
+    Mapping,
+    MutableMapping,
+    Optional,
+    Sequence,
+    Self,
+    TypeVar,
+    cast,
+)
 from urllib.parse import urljoin
 
 import httpx
+import pydantic
 from pydantic import BaseModel, ConfigDict
 
 Json = dict[str, "Json"] | list["Json"] | str | int | float | bool | None
@@ -412,6 +423,13 @@ class AttachmentsCreateResponse(BaseModel):
     attachments: Mapping[str, AttachmentCreateResponse]
 
 
+class ErrorResponse(BaseModel):
+    code: int
+    message: str
+    error: bool
+    documentation: str
+
+
 @dataclass
 class BugzillaConfig:
     base_url: str
@@ -422,6 +440,27 @@ class BugzillaConfig:
     max_retries: int = 1
 
 
+BugType = TypeVar("BugType", bound=BaseModel)
+
+
+class BugSearchGeneric(BaseModel, Generic[BugType]):
+    bugs: Optional[list[BugType]] = None
+    faults: Optional[list[Any]] = None
+
+
+def bug_search_model(bug_type: type[BugType]) -> type[BugSearchGeneric[BugType]]:
+    return cast(
+        type[BugSearchGeneric[BugType]], BugSearchGeneric.__class_getitem__(bug_type)
+    )
+
+
+def model_field_names(model: type[BaseModel]) -> list[str]:
+    return [
+        field.alias if field.alias else name
+        for name, field in model.model_fields.items()
+    ]
+
+
 class Bugzilla:
     def __init__(self, config: BugzillaConfig):
         self.config = config
@@ -491,13 +530,27 @@ class Bugzilla:
 """)
             return {}
 
-    def bug(
-        self, bug_id: int, include_fields: Optional[list[str]] = None
-    ) -> Optional[Bug]:
+    def check_error(self, data: Mapping[str, Json]) -> Mapping[str, Json]:
+        try:
+            err = ErrorResponse.model_validate(data)
+            if err.error:
+                raise BugzillaError(err.message)
+        except pydantic.ValidationError:
+            pass
+        return data
+
+    def _bug(
+        self,
+        bug_id: int,
+        bug_type: type[BugType],
+        include_fields: Optional[list[str]] = None,
+    ) -> Optional[BugType]:
         """Get a single bug specified by id"""
-        search_result = BugSearch.model_validate(
+
+        data = self.check_error(
             self.request("GET", f"bug/{bug_id}", include_fields=include_fields)
         )
+        search_result = bug_search_model(bug_type).model_validate(data)
         if search_result.faults:
             raise BugzillaError(search_result.faults)
         bugs = search_result.bugs
@@ -506,6 +559,15 @@ class Bugzilla:
         assert len(bugs) == 1
         return bugs[0]
 
+    def bug(
+        self, bug_id: int, include_fields: Optional[list[str]] = None
+    ) -> Optional[Bug]:
+        return self._bug(bug_id, Bug, include_fields)
+
+    def bug_as(self, bug_id: int, bug_type: type[BugType]) -> Optional[BugType]:
+        include_fields = model_field_names(bug_type)
+        return self._bug(bug_id, bug_type, include_fields)
+
     def bugs(
         self,
         bug_ids: Sequence[int],
@@ -525,6 +587,25 @@ class Bugzilla:
             )
         return results
 
+    def bugs_as(
+        self,
+        bug_ids: Sequence[int],
+        bug_type: type[BugType],
+        page_size: int = 100,
+    ) -> list[Bug]:
+        """Get multiple bugs specified by id"""
+        results: list[Bug] = []
+        for bug_ids_chunk in [
+            bug_ids[n : n + page_size] for n in range(0, len(bug_ids), page_size)
+        ]:
+            results.extend(
+                self.search_as(
+                    {"id": ",".join(str(id) for id in bug_ids_chunk)},
+                    bug_type,
+                )
+            )
+        return results
+
     def bug_history(
         self, bug_id: int, new_since: Optional[datetime] = None
     ) -> BugHistory:
@@ -532,9 +613,10 @@ class Bugzilla:
         params = {}
         if new_since is not None:
             params["new_since"] = new_since.strftime("%Y-%m-%dT%H:%M:%SZ")
-        query_result = BugsHistory.model_validate(
+        data = self.check_error(
             self.request("GET", f"bug/{bug_id}/history", params=params)
         )
+        query_result = BugsHistory.model_validate(data)
         if query_result.faults:
             raise BugzillaError(query_result.faults)
         bugs = query_result.bugs
@@ -543,13 +625,15 @@ class Bugzilla:
         assert len(bugs) == 1
         return bugs[0]
 
-    def search(
+    def _search(
         self,
+        bug_type: type[BugType],
         query: QueryParams,
         include_fields: Optional[list[str]] = None,
         page_size: int = 100,
-    ) -> list[Bug]:
+    ) -> list[BugType]:
         """Search for bugs using the bugzilla query API"""
+
         query = {**query}
         paginate = False
         offset = 0
@@ -558,12 +642,12 @@ class Bugzilla:
             query["offset"] = "0"
             paginate = True
 
-        results: list[Bug] = []
+        results: list[BugType] = []
         while True:
-            response = self.request(
-                "GET", "bug", params=query, include_fields=include_fields
+            response = self.check_error(
+                self.request("GET", "bug", params=query, include_fields=include_fields)
             )
-            search_result = BugSearch.model_validate(response)
+            search_result = bug_search_model(bug_type).model_validate(response)
             if search_result.faults:
                 raise BugzillaError(search_result.faults)
             if search_result.bugs is not None:
@@ -581,6 +665,20 @@ class Bugzilla:
 
         return results
 
+    def search(
+        self,
+        query: QueryParams,
+        include_fields: Optional[list[str]] = None,
+        page_size: int = 100,
+    ) -> list[Bug]:
+        return self._search(Bug, query, include_fields, page_size)
+
+    def search_as(
+        self, query: QueryParams, bug_type: type[BugType], page_size: int = 100
+    ):
+        include_fields = model_field_names(bug_type)
+        return self._search(bug_type, query, include_fields, page_size)
+
     def update_bugs(
         self, update_params: BugUpdate, bug_id: Optional[int] = None
     ) -> list[BugUpdateResponse]:
@@ -600,7 +698,7 @@ class Bugzilla:
 
         json_body = update_params.model_dump(exclude_none=True)
 
-        response = self.request("PUT", path, json_body=json_body)
+        response = self.check_error(self.request("PUT", path, json_body=json_body))
 
         if self.config.allow_writes:
             update_result = BugsUpdateResponse.model_validate(response)
@@ -632,7 +730,7 @@ class Bugzilla:
         if not json_body.get("ids"):
             json_body["ids"] = [bug_id]
 
-        response = self.request("POST", path, json_body=json_body)
+        response = self.check_error(self.request("POST", path, json_body=json_body))
 
         if self.config.allow_writes:
             create_result = AttachmentsCreateResponse.model_validate(response)

{bugdantic-0.3.0 → bugdantic-0.4.1}/bugdantic.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bugdantic
-Version: 0.3.0
+Version: 0.4.1
 Summary: Bugzilla client based on pydantic
 Author-email: James Graham <james@hoppipolla.co.uk>
 License-Expression: MPL-2.0

{bugdantic-0.3.0 → bugdantic-0.4.1}/pyproject.toml

@@ -5,7 +5,7 @@ authors = [
   {name = "James Graham", email = "james@hoppipolla.co.uk"}
 ]
 
-version = "0.3.0"
+version = "0.4.1"
 requires-python = ">=3.11"
 license = "MPL-2.0"
 classifiers = [

{bugdantic-0.3.0 → bugdantic-0.4.1}/test/test_bugzilla.py

@@ -1,6 +1,8 @@
 import pytest
+from pydantic import BaseModel, Field
 
 from bugdantic import Bugzilla, BugzillaConfig
+from bugdantic.bugzilla import BugComment
 
 
 @pytest.fixture
@@ -26,7 +28,7 @@ def test_bug_history_full(bugzilla):
     assert result.id == 1886129
 
 
-def test_serach_include_history(bugzilla):
+def test_search_include_history(bugzilla):
     bugs = [423488, 1749533]
     result = bugzilla.search({"id": bugs}, include_fields=["id", "history"])
     for expected_id, bug in zip(bugs, sorted(result, key=lambda x: x.id)):
@@ -43,3 +45,38 @@ def test_search_include_comments_and_attachments(bugzilla):
         assert bug.id == expected_id
         assert isinstance(bug.comments, list)
         assert isinstance(bug.attachments, list)
+
+
+def test_bug_as(bugzilla):
+    class BugData(BaseModel):
+        id: int
+        cf_user_story: str
+
+    result = bugzilla.bug_as(975444, BugData)
+    assert isinstance(result, BugData)
+    assert result.id == 975444
+    assert result.cf_user_story is not None
+
+
+def test_search_as(bugzilla):
+    class BugData(BaseModel):
+        id: int
+        comments: list[BugComment]
+
+    bugs = [423488, 1749533]
+    result = bugzilla.search_as({"id": bugs}, BugData)
+    for expected_id, bug in zip(bugs, sorted(result, key=lambda x: x.id)):
+        assert isinstance(bug, BugData)
+        assert bug.id == expected_id
+        assert isinstance(bug.comments, list)
+
+
+def test_bug_as_alias(bugzilla):
+    class BugData(BaseModel):
+        id: int
+        user_story: str = Field(alias="cf_user_story")
+
+    result = bugzilla.bug_as(975444, BugData)
+    assert isinstance(result, BugData)
+    assert result.id == 975444
+    assert result.user_story is not None