bugdantic 0.5.0__tar.gz → 0.5.2__tar.gz

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

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

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

@@ -97,6 +97,7 @@ class BugComment(BaseModel):
     is_private: Optional[bool] = None
     is_markdown: Optional[bool] = None
     tags: Optional[list[str]] = None
+    reactions: Optional[dict[str, int]] = None
 
     model_config = ConfigDict(extra="allow")
 
@@ -422,6 +423,33 @@ class AttachmentsCreateResponse(BaseModel):
     attachments: Mapping[str, AttachmentCreateResponse]
 
 
+class CommentCreate(BaseModel):
+    comment: str
+    is_private: Optional[bool] = None
+    is_markdown: Optional[bool] = None
+    work_time: Optional[float] = None
+
+
+class CommentCreateResponse(BaseModel):
+    id: int
+
+
+CommentType = TypeVar("CommentType", bound=BaseModel)
+
+
+class CommentsResponseGeneric(BaseModel, Generic[CommentType]):
+    comments: Mapping[str, CommentType]
+
+
+def comments_response_model(
+    comment_type: type[CommentType],
+) -> type[CommentsResponseGeneric[CommentType]]:
+    return cast(
+        type[CommentsResponseGeneric[CommentType]],
+        CommentsResponseGeneric.__class_getitem__(comment_type),
+    )
+
+
 class ErrorResponse(BaseModel):
     code: int
     message: str
@@ -644,6 +672,63 @@ class Bugzilla:
             )
         return results
 
+    def _comments(
+        self,
+        comment_ids: Sequence[int],
+        comment_type: type[CommentType],
+        include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
+        page_size: int = 100,
+    ) -> list[CommentType]:
+        """Get comments specified by their ids.
+
+        The API accepts a list of comment ids with a single id in the path,
+        and the remainder are passed as repeated comment_ids parameters."""
+        results: list[CommentType] = []
+        for comment_ids_chunk in [
+            comment_ids[n : n + page_size]
+            for n in range(0, len(comment_ids), page_size)
+        ]:
+            response = self.check_error(
+                self.request(
+                    "GET",
+                    f"bug/comment/{comment_ids_chunk[0]}",
+                    include_fields=include_fields,
+                    exclude_fields=exclude_fields,
+                    params={
+                        "comment_ids": [str(item) for item in comment_ids_chunk[1:]]
+                    },
+                )
+            )
+            result = comments_response_model(comment_type).model_validate(response)
+            results.extend(result.comments.values())
+        return results
+
+    def comments(
+        self,
+        comment_ids: Sequence[int],
+        include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
+        page_size: int = 100,
+    ) -> list[BugComment]:
+        """Get comments specified by their ids"""
+        return self._comments(
+            comment_ids, BugComment, include_fields, exclude_fields, page_size
+        )
+
+    def comments_as(
+        self,
+        comment_ids: Sequence[int],
+        comment_type: type[CommentType],
+        exclude_fields: Optional[list[str]] = None,
+        page_size: int = 100,
+    ) -> list[CommentType]:
+        """Get comments specified by their ids"""
+        include_fields = model_field_names(comment_type)
+        return self._comments(
+            comment_ids, comment_type, include_fields, exclude_fields, page_size
+        )
+
     def bug_history(
         self, bug_id: int, new_since: Optional[datetime] = None
     ) -> BugHistory:
@@ -787,3 +872,16 @@ class Bugzilla:
             return list(create_result.attachments.values())
 
         return []
+
+    def add_comment(self, bug_id: int, comment: CommentCreate) -> Optional[int]:
+        """Add a comment to a bug, returning the id of the new comment"""
+        path = f"bug/{bug_id}/comment"
+
+        json_body = comment.model_dump(exclude_none=True)
+
+        response = self.check_error(self.request("POST", path, json_body=json_body))
+
+        if self.config.allow_writes:
+            return CommentCreateResponse.model_validate(response).id
+
+        return None

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

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

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

@@ -2,8 +2,8 @@ httpx[http2]>=0.28.1
 pydantic>=2.11.3
 
 [test]
-mypy==2.3.0
-ruff==0.16.2
+mypy==2.3.1
+ruff==0.16.6
 pytest==9.1.1
 pytest-ruff==0.5
-ty==0.0.71
+ty==0.0.78

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

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

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

@@ -124,3 +124,21 @@ def test_bug_as_exclude(bugzilla):
     assert result.id == 975444
     assert result.attachments
     assert all("data" not in item for item in result.attachments)
+
+
+def test_comment(bugzilla):
+    result = bugzilla.comments([18109498, 18109500])
+    assert all(isinstance(item, BugComment) for item in result)
+    assert len(result) == 2
+    assert {item.id for item in result} == {18109498, 18109500}
+
+
+def test_comment_as(bugzilla):
+    class CommentReactions(BaseModel):
+        id: int
+        reactions: dict[str, int]
+
+    result = bugzilla.comments_as([18109498, 18109500], CommentReactions)
+    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)