bugdantic 0.5.2__tar.gz → 0.6.0__tar.gz

{bugdantic-0.5.2 → bugdantic-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bugdantic
-Version: 0.5.2
+Version: 0.6.0
 Summary: Bugzilla client based on pydantic
 Author-email: James Graham <james@hoppipolla.co.uk>
 License-Expression: MPL-2.0
@@ -12,8 +12,8 @@ Requires-Dist: httpx[http2]>=0.28.1
 Requires-Dist: pydantic>=2.11.3
 Provides-Extra: test
 Requires-Dist: mypy==2.3.1; extra == "test"
-Requires-Dist: ruff==0.16.6; extra == "test"
+Requires-Dist: ruff==0.16.7; extra == "test"
 Requires-Dist: pytest==9.1.1; extra == "test"
 Requires-Dist: pytest-ruff==0.5; extra == "test"
-Requires-Dist: ty==0.0.78; extra == "test"
+Requires-Dist: ty==0.0.80; extra == "test"
 Dynamic: license-file

bugdantic-0.6.0/bugdantic/__init__.py

@@ -0,0 +1,6 @@
+from .bugzilla import (  # noqa: F401
+    Bugzilla,
+    BugzillaConfig,
+    BugzillaError,
+    BugzillaResponseError,
+)

{bugdantic-0.5.2 → bugdantic-0.6.0}/bugdantic/bugzilla.py

@@ -26,8 +26,39 @@ QueryValue = Optional[str | int | float | bool]
 QueryParams = Mapping[str, QueryValue | Sequence[QueryValue]]
 
 
-class BugzillaError(Exception):
-    pass
+class BugzillaError(Exception): ...
+
+
+class ResponseError(BugzillaError):
+    response_data: BaseModel
+
+    def __init__(
+        self,
+        message: str,
+        response_data: BaseModel,
+        *args: Any,
+        **kwargs: Any,
+    ):
+        super().__init__(message, *args, **kwargs)
+        self.response_data = response_data
+
+
+class BugzillaResponseError(ResponseError):
+    response_data: "ErrorResponse"
+
+    def __init__(
+        self,
+        message: str,
+        response_data: "ErrorResponse",
+        *args: Any,
+        **kwargs: Any,
+    ):
+        super().__init__(message, response_data, *args, **kwargs)
+
+    @property
+    def code(self) -> int:
+        assert isinstance(self.response_data, ErrorResponse)
+        return self.response_data.code
 
 
 class UserGroup(BaseModel):
@@ -188,9 +219,17 @@ class Bug(BaseModel):
         return self.model_dump(exclude_unset=True)
 
 
-class BugSearch(BaseModel):
+class FaultsModel(BaseModel):
     faults: Optional[list[Any]] = None
-    bugs: Optional[list[Bug]] = None
+
+    def raise_for_faults(self) -> None:
+        if self.faults:
+            # In the current BMO code this should actually be impossible
+            raise ResponseError("Unexpected faults in response", response_data=self)
+
+
+class BugSearch(FaultsModel):
+    bugs: list[Bug] = []
 
 
 # Data model for bug history
@@ -205,9 +244,8 @@ class BugHistory(BaseModel):
         return self.model_dump(exclude_unset=True)
 
 
-class BugsHistory(BaseModel):
-    faults: Optional[list[Any]] = None
-    bugs: Optional[list[BugHistory]] = None
+class BugsHistory(FaultsModel):
+    bugs: list[BugHistory] = []
 
 
 # Data models for update requests
@@ -347,8 +385,7 @@ class BugUpdateResponse(BaseModel):
 
 
 class BugsUpdateResponse(BaseModel):
-    bugs: Optional[list[BugUpdateResponse]] = None
-    faults: Optional[list[Any]] = None
+    bugs: list[BugUpdateResponse] = []
 
 
 # Data models for creating attachments
@@ -456,6 +493,10 @@ class ErrorResponse(BaseModel):
     error: bool
     documentation: str
 
+    def raise_for_error(self) -> None:
+        if self.error:
+            raise BugzillaResponseError(self.message, response_data=self)
+
 
 @dataclass
 class BugzillaConfig:
@@ -471,9 +512,8 @@ class BugzillaConfig:
 BugType = TypeVar("BugType", bound=BaseModel)
 
 
-class BugSearchGeneric(BaseModel, Generic[BugType]):
-    bugs: Optional[list[BugType]] = None
-    faults: Optional[list[Any]] = None
+class BugSearchGeneric(FaultsModel, Generic[BugType]):
+    bugs: list[BugType] = []
 
 
 def bug_search_model(bug_type: type[BugType]) -> type[BugSearchGeneric[BugType]]:
@@ -563,12 +603,16 @@ class Bugzilla:
             assert response is not None
             try:
                 response.raise_for_status()
-            except Exception:
-                msg = "Request failed"
-                json_resp = response.json()
-                if json_resp:
-                    msg += f"\n{json_resp.get('message')}"
-                logging.error(msg)
+            except httpx.HTTPStatusError as e:
+                try:
+                    resp_json = response.json()
+                except ValueError:
+                    resp_json = None
+                if resp_json:
+                    try:
+                        self.check_error(resp_json)
+                    except BugzillaError as bug_error:
+                        raise bug_error from e
                 raise
             return response.json()
         else:
@@ -580,9 +624,7 @@ class Bugzilla:
 
     def check_error(self, data: Mapping[str, Json]) -> Mapping[str, Json]:
         try:
-            err = ErrorResponse.model_validate(data)
-            if err.error:
-                raise BugzillaError(err.message)
+            ErrorResponse.model_validate(data).raise_for_error()
         except pydantic.ValidationError:
             pass
         return data
@@ -605,8 +647,7 @@ class Bugzilla:
             )
         )
         search_result = bug_search_model(bug_type).model_validate(data)
-        if search_result.faults:
-            raise BugzillaError(search_result.faults)
+        search_result.raise_for_faults()
         bugs = search_result.bugs
         if not bugs:
             return None
@@ -740,11 +781,12 @@ class Bugzilla:
             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)
+        query_result.raise_for_faults()
         bugs = query_result.bugs
-        if bugs is None:
-            raise BugzillaError("Empty bugs list but no faults")
+        if not bugs:
+            raise ResponseError(
+                "Empty bugs list but no error", response_data=query_result
+            )
         assert len(bugs) == 1
         return bugs[0]
 
@@ -778,17 +820,15 @@ class Bugzilla:
                 )
             )
             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:
-                results.extend(search_result.bugs)
-                if not paginate or len(search_result.bugs) < page_size:
-                    break
-            else:
-                logging.error(
-                    f"Invalid bugzilla response object: {json.dumps(response)}"
+            search_result.raise_for_faults()
+            if not search_result.bugs:
+                raise ResponseError(
+                    "Empty bugs list but no error", response_data=search_result
                 )
-                raise BugzillaError("Response contained neither bugs nor faults fields")
+
+            results.extend(search_result.bugs)
+            if not paginate or len(search_result.bugs) < page_size:
+                break
 
             offset += page_size
             query["offset"] = str(offset)
@@ -837,13 +877,6 @@ class Bugzilla:
 
         if self.config.allow_writes:
             update_result = BugsUpdateResponse.model_validate(response)
-            if update_result.faults:
-                raise BugzillaError(update_result.faults)
-            if update_result.bugs is None:
-                logging.error(
-                    f"Invalid bugzilla response object: {json.dumps(response)}"
-                )
-                raise BugzillaError("Response contained neither bugs nor faults fields")
             return update_result.bugs
 
         return []

{bugdantic-0.5.2 → bugdantic-0.6.0}/bugdantic.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bugdantic
-Version: 0.5.2
+Version: 0.6.0
 Summary: Bugzilla client based on pydantic
 Author-email: James Graham <james@hoppipolla.co.uk>
 License-Expression: MPL-2.0
@@ -12,8 +12,8 @@ Requires-Dist: httpx[http2]>=0.28.1
 Requires-Dist: pydantic>=2.11.3
 Provides-Extra: test
 Requires-Dist: mypy==2.3.1; extra == "test"
-Requires-Dist: ruff==0.16.6; extra == "test"
+Requires-Dist: ruff==0.16.7; extra == "test"
 Requires-Dist: pytest==9.1.1; extra == "test"
 Requires-Dist: pytest-ruff==0.5; extra == "test"
-Requires-Dist: ty==0.0.78; extra == "test"
+Requires-Dist: ty==0.0.80; extra == "test"
 Dynamic: license-file

{bugdantic-0.5.2 → bugdantic-0.6.0}/bugdantic.egg-info/requires.txt

@@ -3,7 +3,7 @@ pydantic>=2.11.3
 
 [test]
 mypy==2.3.1
-ruff==0.16.6
+ruff==0.16.7
 pytest==9.1.1
 pytest-ruff==0.5
-ty==0.0.78
+ty==0.0.80

{bugdantic-0.5.2 → bugdantic-0.6.0}/pyproject.toml

@@ -5,7 +5,7 @@ authors = [
   {name = "James Graham", email = "james@hoppipolla.co.uk"}
 ]
 
-version = "0.5.2"
+version = "0.6.0"
 requires-python = ">=3.11"
 license = "MPL-2.0"
 classifiers = [
@@ -21,10 +21,10 @@ dependencies = [
 [project.optional-dependencies]
 test = [
   "mypy==2.3.1",
-  "ruff==0.16.6",
+  "ruff==0.16.7",
   "pytest==9.1.1",
   "pytest-ruff==0.5",
-  "ty==0.0.78",
+  "ty==0.0.80",
 ]
 
 [tool.mypy]

{bugdantic-0.5.2 → bugdantic-0.6.0}/test/test_bugzilla.py

@@ -3,7 +3,7 @@ from typing import Any
 import pytest
 from pydantic import BaseModel, Field
 
-from bugdantic import Bugzilla, BugzillaConfig
+from bugdantic import Bugzilla, BugzillaConfig, BugzillaResponseError
 from bugdantic.bugzilla import BugComment
 
 
@@ -142,3 +142,17 @@ def test_comment_as(bugzilla):
     assert all(isinstance(item, CommentReactions) for item in result)
     assert {item.id for item in result} == {18109498, 18109500}
     assert all(isinstance(item.reactions, dict) for item in result)
+
+
+def test_error_code(bugzilla):
+    with pytest.raises(BugzillaResponseError) as exc_info:
+        bugzilla.comments([0])
+    assert exc_info.value.response_data.code == 111
+    assert str(exc_info.value) == "0 is not a valid comment id."
+
+
+def test_error_fails_whole_request(bugzilla):
+    """One bad comment id loses the readable comments in the same request"""
+    with pytest.raises(BugzillaResponseError) as exc_info:
+        bugzilla.comments([18109498, 0, 18109500])
+    assert exc_info.value.response_data.code == 111

bugdantic-0.5.2/bugdantic/__init__.py

@@ -1 +0,0 @@
-from .bugzilla import Bugzilla, BugzillaConfig  # noqa: F401