bugdantic 0.4.3__tar.gz → 0.5.0__tar.gz

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

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

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

@@ -455,10 +455,19 @@ def bug_search_model(bug_type: type[BugType]) -> type[BugSearchGeneric[BugType]]
 
 
 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()
-    ]
+    field_names = []
+    for name, field_obj in model.model_fields.items():
+        if field_obj.validation_alias is not None:
+            if not isinstance(field_obj.validation_alias, str):
+                raise ValueError(
+                    "Only string values for validation_alias are supported"
+                )
+            field_names.append(field_obj.validation_alias)
+        elif field_obj.alias is not None:
+            field_names.append(field_obj.alias)
+        else:
+            field_names.append(name)
+    return field_names
 
 
 class Bugzilla:
@@ -555,11 +564,17 @@ class Bugzilla:
         bug_id: int,
         bug_type: type[BugType],
         include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
     ) -> Optional[BugType]:
         """Get a single bug specified by id"""
 
         data = self.check_error(
-            self.request("GET", f"bug/{bug_id}", include_fields=include_fields)
+            self.request(
+                "GET",
+                f"bug/{bug_id}",
+                include_fields=include_fields,
+                exclude_fields=exclude_fields,
+            )
         )
         search_result = bug_search_model(bug_type).model_validate(data)
         if search_result.faults:
@@ -571,18 +586,27 @@ class Bugzilla:
         return bugs[0]
 
     def bug(
-        self, bug_id: int, include_fields: Optional[list[str]] = None
+        self,
+        bug_id: int,
+        include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
     ) -> Optional[Bug]:
-        return self._bug(bug_id, Bug, include_fields)
+        return self._bug(bug_id, Bug, include_fields, exclude_fields)
 
-    def bug_as(self, bug_id: int, bug_type: type[BugType]) -> Optional[BugType]:
+    def bug_as(
+        self,
+        bug_id: int,
+        bug_type: type[BugType],
+        exclude_fields: Optional[list[str]] = None,
+    ) -> Optional[BugType]:
         include_fields = model_field_names(bug_type)
-        return self._bug(bug_id, bug_type, include_fields)
+        return self._bug(bug_id, bug_type, include_fields, exclude_fields)
 
     def bugs(
         self,
         bug_ids: Sequence[int],
         include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
         page_size: int = 100,
     ) -> list[Bug]:
         """Get multiple bugs specified by id"""
@@ -594,6 +618,7 @@ class Bugzilla:
                 self.search(
                     {"id": ",".join(str(id) for id in bug_ids_chunk)},
                     include_fields=include_fields,
+                    exclude_fields=exclude_fields,
                 )
             )
         return results
@@ -602,6 +627,7 @@ class Bugzilla:
         self,
         bug_ids: Sequence[int],
         bug_type: type[BugType],
+        exclude_fields: Optional[list[str]] = None,
         page_size: int = 100,
     ) -> list[BugType]:
         """Get multiple bugs specified by id"""
@@ -613,6 +639,7 @@ class Bugzilla:
                 self.search_as(
                     {"id": ",".join(str(id) for id in bug_ids_chunk)},
                     bug_type,
+                    exclude_fields,
                 )
             )
         return results
@@ -641,6 +668,7 @@ class Bugzilla:
         bug_type: type[BugType],
         query: QueryParams,
         include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
         page_size: int = 100,
     ) -> list[BugType]:
         """Search for bugs using the bugzilla query API"""
@@ -656,7 +684,13 @@ class Bugzilla:
         results: list[BugType] = []
         while True:
             response = self.check_error(
-                self.request("GET", "bug", params=query, include_fields=include_fields)
+                self.request(
+                    "GET",
+                    "bug",
+                    params=query,
+                    include_fields=include_fields,
+                    exclude_fields=exclude_fields,
+                )
             )
             search_result = bug_search_model(bug_type).model_validate(response)
             if search_result.faults:
@@ -680,15 +714,20 @@ class Bugzilla:
         self,
         query: QueryParams,
         include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
         page_size: int = 100,
     ) -> list[Bug]:
-        return self._search(Bug, query, include_fields, page_size)
+        return self._search(Bug, query, include_fields, exclude_fields, page_size)
 
     def search_as(
-        self, query: QueryParams, bug_type: type[BugType], page_size: int = 100
+        self,
+        query: QueryParams,
+        bug_type: type[BugType],
+        exclude_fields: Optional[list[str]] = None,
+        page_size: int = 100,
     ) -> list[BugType]:
         include_fields = model_field_names(bug_type)
-        return self._search(bug_type, query, include_fields, page_size)
+        return self._search(bug_type, query, include_fields, exclude_fields, page_size)
 
     def update_bugs(
         self, update_params: BugUpdate, bug_id: Optional[int] = None

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

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

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

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

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

@@ -1,3 +1,5 @@
+from typing import Any
+
 import pytest
 from pydantic import BaseModel, Field
 
@@ -45,6 +47,23 @@ def test_search_include_comments_and_attachments(bugzilla):
         assert bug.id == expected_id
         assert isinstance(bug.comments, list)
         assert isinstance(bug.attachments, list)
+        for item in bug.attachments:
+            assert "data" not in item
+
+
+def test_search_include_attachments_exclude_data(bugzilla):
+    bugs = [423488, 1749533]
+    result = bugzilla.search(
+        {"id": bugs},
+        include_fields=["id", "comments", "attachments"],
+        exclude_fields=["attachments.data"],
+    )
+    for expected_id, bug in zip(bugs, sorted(result, key=lambda x: x.id)):
+        assert bug.id == expected_id
+        assert isinstance(bug.comments, list)
+        assert isinstance(bug.attachments, list)
+        for item in bug.attachments:
+            assert "data" not in item
 
 
 def test_bug_as(bugzilla):
@@ -80,3 +99,28 @@ def test_bug_as_alias(bugzilla):
     assert isinstance(result, BugData)
     assert result.id == 975444
     assert result.user_story is not None
+
+
+def test_bug_as_validation_alias(bugzilla):
+    class BugData(BaseModel):
+        id: int
+        user_story: str = Field(
+            validation_alias="cf_user_story", alias="raw_user_story"
+        )
+
+    result = bugzilla.bug_as(975444, BugData)
+    assert isinstance(result, BugData)
+    assert result.id == 975444
+    assert result.user_story is not None
+
+
+def test_bug_as_exclude(bugzilla):
+    class BugData(BaseModel):
+        id: int
+        attachments: list[dict[str, Any]]
+
+    result = bugzilla.bug_as(975444, BugData, exclude_fields=["attachments.data"])
+    assert isinstance(result, BugData)
+    assert result.id == 975444
+    assert result.attachments
+    assert all("data" not in item for item in result.attachments)