bugdantic 0.6.1__tar.gz → 0.6.2__tar.gz

{bugdantic-0.6.1 → bugdantic-0.6.2}/PKG-INFO

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

{bugdantic-0.6.1 → bugdantic-0.6.2}/bugdantic/bugzilla.py

@@ -9,6 +9,7 @@ from datetime import datetime
 from typing import (
     Any,
     Generic,
+    Literal,
     Optional,
     Self,
     TypeVar,
@@ -487,6 +488,100 @@ def comments_response_model(
     )
 
 
+# Data models for getting products
+
+
+class FlagType(BaseModel):
+    id: Optional[int] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+    cc_list: Optional[str] = None
+    sort_key: Optional[int] = None
+    is_active: Optional[bool] = None
+    is_requestable: Optional[bool] = None
+    is_requesteeble: Optional[bool] = None
+    is_multiplicable: Optional[bool] = None
+    grant_group: Optional[int] = None
+    request_group: Optional[int] = None
+
+
+class ComponentFlagTypes(BaseModel):
+    bug: Optional[list[FlagType]] = None
+    attachment: Optional[list[FlagType]] = None
+
+
+class ProductComponent(BaseModel):
+    id: Optional[int] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+    default_assigned_to: Optional[str] = None
+    default_qa_contact: Optional[str] = None
+    triage_owner: Optional[str] = None
+    team_name: Optional[str] = None
+    sort_key: Optional[int] = None
+    is_active: Optional[bool] = None
+    default_bug_type: Optional[str] = None
+    flag_types: Optional[ComponentFlagTypes] = None
+
+
+class ProductVersion(BaseModel):
+    id: Optional[int] = None
+    name: Optional[str] = None
+    sort_key: Optional[int] = None
+    is_active: Optional[bool] = None
+
+
+class ProductMilestone(BaseModel):
+    id: Optional[int] = None
+    name: Optional[str] = None
+    sort_key: Optional[int] = None
+    is_active: Optional[bool] = None
+
+
+class Product(BaseModel):
+    id: Optional[int] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+    is_active: Optional[bool] = None
+    default_bug_type: Optional[str] = None
+    default_milestone: Optional[str] = None
+    default_version: Optional[str] = None
+    has_unconfirmed: Optional[bool] = None
+    classification: Optional[str] = None
+    components: Optional[list[ProductComponent]] = None
+    versions: Optional[list[ProductVersion]] = None
+    milestones: Optional[list[ProductMilestone]] = None
+
+    # BMO specific fields
+    default_platform: Optional[str] = None
+    default_op_sys: Optional[str] = None
+    default_security_group: Optional[str] = None
+
+    model_config = ConfigDict(extra="allow")
+
+    def to_dict(self) -> dict[str, Any]:
+        return self.model_dump(exclude_unset=True)
+
+
+ProductAccess = Literal["accessible", "selectable", "enterable"]
+
+
+ProductType = TypeVar("ProductType", bound=BaseModel)
+
+
+class ProductsResponseGeneric(BaseModel, Generic[ProductType]):
+    products: list[ProductType] = []
+
+
+def products_response_model(
+    product_type: type[ProductType],
+) -> type[ProductsResponseGeneric[ProductType]]:
+    return cast(
+        type[ProductsResponseGeneric[ProductType]],
+        ProductsResponseGeneric.__class_getitem__(product_type),
+    )
+
+
 class ErrorResponse(BaseModel):
     code: int
     message: str
@@ -770,6 +865,60 @@ class Bugzilla:
             comment_ids, comment_type, include_fields, exclude_fields, page_size
         )
 
+    def _products(
+        self,
+        product_type: type[ProductType],
+        ids: Optional[Sequence[int]] = None,
+        names: Optional[Sequence[str]] = None,
+        access: Sequence[ProductAccess] = ("accessible",),
+        include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
+    ) -> list[ProductType]:
+        """Get products specified by id, name, or access type.
+
+        Products that don't exist or aren't accessible to the user are
+        silently omitted."""
+        params: dict[str, Sequence[QueryValue]] = {"type": list(access)}
+        if ids is not None:
+            params["ids"] = [str(item) for item in ids]
+        if names is not None:
+            params["names"] = list(names)
+        response = self.check_error(
+            self.request(
+                "GET",
+                "product",
+                params=params,
+                include_fields=include_fields,
+                exclude_fields=exclude_fields,
+            )
+        )
+        return products_response_model(product_type).model_validate(response).products
+
+    def products(
+        self,
+        ids: Optional[Sequence[int]] = None,
+        names: Optional[Sequence[str]] = None,
+        access: Sequence[ProductAccess] = ("accessible",),
+        include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
+    ) -> list[Product]:
+        return self._products(
+            Product, ids, names, access, include_fields, exclude_fields
+        )
+
+    def products_as(
+        self,
+        product_type: type[ProductType],
+        ids: Optional[Sequence[int]] = None,
+        names: Optional[Sequence[str]] = None,
+        access: Sequence[ProductAccess] = ("accessible",),
+        exclude_fields: Optional[list[str]] = None,
+    ) -> list[ProductType]:
+        include_fields = model_field_names(product_type)
+        return self._products(
+            product_type, ids, names, access, include_fields, exclude_fields
+        )
+
     def bug_history(
         self, bug_id: int, new_since: Optional[datetime] = None
     ) -> BugHistory:

{bugdantic-0.6.1 → bugdantic-0.6.2}/bugdantic.egg-info/PKG-INFO

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

{bugdantic-0.6.1 → bugdantic-0.6.2}/pyproject.toml

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

{bugdantic-0.6.1 → bugdantic-0.6.2}/test/test_bugzilla.py

@@ -4,7 +4,7 @@ import pytest
 from pydantic import BaseModel, Field
 
 from bugdantic import Bugzilla, BugzillaConfig, BugzillaResponseError
-from bugdantic.bugzilla import BugComment
+from bugdantic.bugzilla import BugComment, Product
 
 
 @pytest.fixture
@@ -156,3 +156,49 @@ def test_error_fails_whole_request(bugzilla):
     with pytest.raises(BugzillaResponseError) as exc_info:
         bugzilla.comments([18109498, 0, 18109500])
     assert exc_info.value.response_data.code == 111
+
+
+def test_products_by_name(bugzilla):
+    result = bugzilla.products(names=["Web Compatibility"])
+    assert len(result) == 1
+    product = result[0]
+    assert isinstance(product, Product)
+    assert product.name == "Web Compatibility"
+    assert product.components
+    assert any(component.name == "Site Reports" for component in product.components)
+
+
+def test_products_by_id(bugzilla):
+    [by_name] = bugzilla.products(names=["Web Compatibility"], include_fields=["id"])
+    result = bugzilla.products(ids=[by_name.id], include_fields=["id", "name"])
+    assert [(item.id, item.name) for item in result] == [
+        (by_name.id, "Web Compatibility")
+    ]
+
+
+def test_products_missing(bugzilla):
+    assert bugzilla.products(names=["This product does not exist"]) == []
+
+
+def test_products_as(bugzilla):
+    class ComponentName(BaseModel):
+        name: str
+
+    class ProductComponents(BaseModel):
+        name: str
+        components: list[ComponentName]
+
+    result = bugzilla.products_as(
+        ProductComponents, names=["Web Compatibility", "Core"]
+    )
+    assert all(isinstance(item, ProductComponents) for item in result)
+    assert {item.name for item in result} == {"Web Compatibility", "Core"}
+    assert all(item.components for item in result)
+
+
+def test_products_access(bugzilla):
+    class ProductName(BaseModel):
+        name: str
+
+    result = bugzilla.products_as(ProductName, access=["enterable"])
+    assert "Web Compatibility" in {item.name for item in result}