bugdantic 0.2__tar.gz

bugdantic-0.2/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

bugdantic-0.2/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: bugdantic
+Version: 0.2
+Summary: Bugzilla client based on pydantic
+Author-email: James Graham <james@hoppipolla.co.uk>
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Dist: httpx[http2]==0.28.1
+Requires-Dist: pydantic==2.10.5
+Provides-Extra: test
+Requires-Dist: mypy==1.10.0; extra == "test"
+Requires-Dist: ruff==0.4.8; extra == "test"
+Requires-Dist: pytest==8.3.4; extra == "test"
+Dynamic: license-file

bugdantic-0.2/README.md

@@ -0,0 +1 @@
+Bugzilla client based on [pydantic](https://docs.pydantic.dev/latest/).

bugdantic-0.2/bugdantic/__init__.py

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

bugdantic-0.2/bugdantic/bugzilla.py

@@ -0,0 +1,451 @@
+import enum
+import json
+import logging
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Mapping, MutableMapping, Optional
+from urllib.parse import urljoin
+
+import httpx
+from pydantic import BaseModel, ConfigDict
+
+Json = dict[str, "Json"] | list["Json"] | str | int | float | bool | None
+
+
+class BugzillaError(Exception):
+    pass
+
+
+class UserGroup(BaseModel):
+    id: int
+    name: str
+    description: str
+
+
+class UserSearch(BaseModel):
+    id: int
+    name: str
+    query: str
+
+
+class User(BaseModel):
+    id: int
+    real_name: str
+    email: str
+    name: str
+    can_login: Optional[bool] = None
+    email_enabled: Optional[bool] = None
+    login_denied_text: Optional[str] = None
+    groups: Optional[list[UserGroup]] = None
+    saved_searches: Optional[list[UserSearch]] = None
+    saved_reports: Optional[list[UserSearch]] = None
+
+
+# Data models for getting bugs
+
+
+class Flag(BaseModel):
+    id: int
+    name: str
+    type_id: int
+    creation_date: datetime
+    modification_date: datetime
+    status: str
+    setter: str
+    requestee: str
+
+
+class Change(BaseModel):
+    field_name: str
+    removed: str
+    added: str
+    attachment_id: Optional[int] = None
+
+
+class History(BaseModel):
+    when: datetime
+    who: str
+    changes: list[Change]
+
+
+class Bug(BaseModel):
+    actual_time: Optional[float] = None
+    alias: Optional[list[str]] = None
+    assigned_to: Optional[str] = None
+    assigned_to_detail: Optional[User] = None
+    blocks: Optional[list[int]] = None
+    cc: Optional[list[str]] = None
+    cc_detail: Optional[list[User]] = None
+    classification: Optional[str] = None
+    component: Optional[str] = None
+    creation_time: Optional[datetime] = None
+    creator: Optional[str] = None
+    creator_detail: Optional[User] = None
+    deadline: Optional[str] = None
+    depends_on: Optional[list[int]] = None
+    dupe_of: Optional[int] = None
+    estimated_time: Optional[float] = None
+    flags: Optional[list[Flag]] = None
+    groups: Optional[list[str]] = None
+    id: Optional[int] = None
+    is_cc_accessible: Optional[bool] = None
+    is_confirmed: Optional[bool] = None
+    is_open: Optional[bool] = None
+    is_creator_accessible: Optional[bool] = None
+    history: Optional[list[History]] = None
+    keywords: Optional[list[str]] = None
+    last_change_time: Optional[datetime] = None
+    op_sys: Optional[str] = None
+    platform: Optional[str] = None
+    priority: Optional[str] = None
+    product: Optional[str] = None
+    qa_contact: Optional[str] = None
+    qa_contact_detail: Optional[User] = None
+    remaining_time: Optional[float] = None
+    resolution: Optional[str] = None
+    see_also: Optional[list[str]] = None
+    severity: Optional[str] = None
+    status: Optional[str] = None
+    summary: Optional[str] = None
+    target_milestone: Optional[str] = None
+    update_token: Optional[str] = None
+    url: Optional[str] = None
+    version: Optional[str] = None
+    whiteboard: Optional[str] = None
+
+    # BMO specific custom fields
+    cf_last_resolved: Optional[datetime] = None
+    cf_user_story: Optional[str] = None
+    cf_webcompat_priority: Optional[str] = None
+    cf_webcompat_score: Optional[str] = None
+
+    model_config = ConfigDict(extra="allow")
+
+    def to_dict(self) -> dict[str, Any]:
+        return self.model_dump(exclude_unset=True)
+
+
+class BugSearch(BaseModel):
+    faults: Optional[list[Any]] = None
+    bugs: Optional[list[Bug]] = None
+
+
+# Data model for bug history
+
+
+
+class BugHistory(BaseModel):
+    id: int
+    history: list[History]
+    alias: Optional[str] = None
+
+    def to_dict(self) -> dict[str, Any]:
+        return self.model_dump(exclude_unset=True)
+
+
+class BugsHistory(BaseModel):
+    faults: Optional[list[Any]] = None
+    bugs: Optional[list[BugHistory]] = None
+
+
+# Data models for update requests
+
+
+class BugRelationUpdate(BaseModel):
+    add: Optional[list[int]] = None
+    remove: Optional[list[int]] = None
+    set: Optional[list[int]] = None
+
+
+class BugKeywordsUpdate(BaseModel):
+    add: Optional[list[str]] = None
+    remove: Optional[list[str]] = None
+    set: Optional[list[str]] = None
+
+
+class BugCcUpdate(BaseModel):
+    add: Optional[list[str]] = None
+    remove: Optional[list[str]] = None
+
+
+class BugGroupsUpdate(BaseModel):
+    add: Optional[list[str]] = None
+    remove: Optional[list[str]] = None
+
+
+class BugSeeAlsoUpdate(BaseModel):
+    add: Optional[list[str]] = None
+    remove: Optional[list[str]] = None
+
+
+class Comment(BaseModel):
+    body: str
+    is_private: Optional[bool] = False
+
+
+class FlagChange(BaseModel):
+    name: Optional[str] = None
+    type_id: Optional[int] = None
+    status: str
+    requestee: Optional[str] = None
+    id: Optional[int] = None
+    new: Optional[bool] = None
+
+
+class Priority(enum.StrEnum):
+    unset = "--"
+    P1 = "P1"
+    P2 = "P2"
+    P3 = "P3"
+    P4 = "P4"
+    P5 = "P5"
+
+
+class Severity(enum.StrEnum):
+    unset = "--"
+    S1 = "S1"
+    S2 = "S2"
+    S3 = "S3"
+    S4 = "S4"
+    not_applicable = "N/A"
+
+
+class WebcompatPriority(enum.StrEnum):
+    unset = "---"
+    P1 = "P1"
+    P2 = "P2"
+    P3 = "P3"
+    requested = "?"
+
+
+class BugUpdate(BaseModel):
+    ids: Optional[list[int]] = None
+    id_or_alias: Optional[int | str] = None
+
+    alias: Optional[list[Any]] = None
+    assigned_to: Optional[str] = None
+    blocks: Optional[BugRelationUpdate] = None
+    depends_on: Optional[BugRelationUpdate] = None
+    cc: Optional[BugCcUpdate] = None
+    is_cc_accessible: Optional[bool] = None
+    comment: Optional[Comment] = None
+    comment_is_private: Optional[dict[int, bool]] = None
+    component: Optional[str] = None
+    deadline: Optional[datetime] = None
+    dupe_of: Optional[int] = None
+    estimated_time: Optional[float] = None
+    flags: Optional[FlagChange] = None
+    groups: Optional[BugGroupsUpdate] = None
+    keywords: Optional[BugKeywordsUpdate] = None
+    op_sys: Optional[str] = None
+    platform: Optional[str] = None
+    priority: Optional[Priority] = None
+    product: Optional[str] = None
+    qa_contact: Optional[str] = None
+    is_creator_accessible: Optional[bool] = None
+    remaining_time: Optional[float] = None
+    reset_assigned_to: Optional[bool] = None
+    reset_qa_contact: Optional[bool] = None
+    resolution: Optional[str] = None
+    see_also: Optional[BugSeeAlsoUpdate] = None
+    severity: Optional[Severity] = None
+    summary: Optional[str] = None
+    target_milestone: Optional[str] = None
+    url: Optional[str] = None
+    version: Optional[str] = None
+    whiteboard: Optional[str] = None
+    work_time: Optional[str] = None
+
+    # BMO specific custom fields
+    cf_user_story: Optional[str] = None
+    cf_webcompat_priority: Optional[WebcompatPriority] = None
+    cf_webcompat_score: Optional[str] = None
+
+
+class BugChange(BaseModel):
+    added: Any
+    removed: Any
+
+
+class BugUpdateResponse(BaseModel):
+    id: int
+    last_change_time: datetime
+    changes: dict[str, BugChange]
+    alias: Optional[str] = None
+
+
+class BugsUpdateResponse(BaseModel):
+    bugs: Optional[list[BugUpdateResponse]] = None
+    faults: Optional[list[Any]] = None
+
+
+@dataclass
+class BugzillaConfig:
+    base_url: str
+    api_key: Optional[str] = None
+    request_timeout: Optional[int] = 60
+    allow_writes: bool = False
+    # Number of times to retry a request if there's a 503 error
+    max_retries: int = 1
+
+
+class Bugzilla:
+    def __init__(self, config: BugzillaConfig):
+        self.config = config
+        headers = (
+            {"X-Bugzilla-API-Key": self.config.api_key}
+            if self.config.api_key is not None
+            else None
+        )
+
+        self.client = httpx.Client(
+            http2=True, timeout=config.request_timeout, headers=headers
+        )
+
+    def request(
+        self,
+        method: str,
+        path: str,
+        include_fields: Optional[list[str]] = None,
+        exclude_fields: Optional[list[str]] = None,
+        params: Optional[dict[str, str]] = None,
+        headers: Optional[dict[str, str]] = None,
+        json_body: Optional[MutableMapping[str, Json]] = None,
+    ) -> Mapping[str, Json]:
+        if params is None:
+            params = {}
+
+        if include_fields is not None:
+            params["include_fields"] = ",".join(include_fields)
+
+        if exclude_fields is not None:
+            params["exclude_fields"] = ",".join(exclude_fields)
+
+        if path.startswith("/"):
+            path = path[1:]
+
+        url = urljoin(self.config.base_url, f"/rest/{path}")
+
+        if self.config.allow_writes or method in {"GET", "OPTIONS", "HEAD"}:
+            retry = 0
+            while retry <= self.config.max_retries:
+                retry += 1
+                response = self.client.request(
+                    method, url, params=params, headers=headers, json=json_body
+                )
+                if response.status_code != 503:
+                    break
+            try:
+                response.raise_for_status()
+            except Exception as e:
+                msg = "Request failed"
+                json_resp = response.json()
+                if json_resp:
+                    msg += f"\n{json_resp.get('message')}"
+                logging.error(msg)
+                raise e
+            return response.json()
+        else:
+            logging.info(f"""Not updating, would send {method} request to {path} with body:
+{json.dumps(json_body)}
+===
+""")
+            return {}
+
+    def bug(
+        self, bug_id: int, include_fields: Optional[list[str]] = None
+    ) -> Optional[Bug]:
+        search_result = BugSearch.model_validate(
+            self.request("GET", f"bug/{bug_id}", include_fields=include_fields)
+        )
+        if search_result.faults:
+            raise BugzillaError(search_result.faults)
+        bugs = search_result.bugs
+        if not bugs:
+            return None
+        assert len(bugs) == 1
+        return bugs[0]
+
+    def bug_history(
+        self, bug_id: int, new_since: Optional[datetime] = None
+    ) -> BugHistory:
+        params = {}
+        if new_since is not None:
+            params["new_since"] = new_since.strftime("%Y-%m-%dT%H:%M:%SZ")
+        query_result = BugsHistory.model_validate(
+            self.request("GET", f"bug/{bug_id}/history", params=params)
+        )
+        if query_result.faults:
+            raise BugzillaError(query_result.faults)
+        bugs = query_result.bugs
+        if bugs is None:
+            raise BugzillaError("Empty bugs list but no faults")
+        assert len(bugs) == 1
+        return bugs[0]
+
+    def search(
+        self,
+        query: dict[str, str],
+        include_fields: Optional[list[str]] = None,
+        page_size: int = 100,
+    ) -> list[Bug]:
+        paginate = False
+        if "limit" not in query and "offset" not in query and page_size > 0:
+            query["limit"] = str(page_size)
+            query["offset"] = "0"
+            paginate = True
+
+        results: list[Bug] = []
+        while True:
+            response = self.request(
+                "GET", "bug", params=query, include_fields=include_fields
+            )
+            search_result = BugSearch.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)}"
+                )
+                raise BugzillaError("Response contained neither bugs nor faults fields")
+
+            query["offset"] = str(int(query["offset"]) + page_size)
+
+        return results
+
+    def update_bugs(
+        self, update_params: BugUpdate, bug_id: Optional[int] = None
+    ) -> list[BugUpdateResponse]:
+        if bug_id is None:
+            if update_params.ids:
+                id_str = str(update_params.ids[0])
+            elif update_params.id_or_alias:
+                id_str = str(update_params.id_or_alias)
+            else:
+                raise ValueError("Missing bug ids to update")
+        else:
+            id_str = str(bug_id)
+
+        # Apparently there has to be a bug id in the URL
+        path = f"bug/{id_str}"
+
+        json_body = update_params.model_dump(exclude_none=True)
+
+        response = self.request("PUT", path, json_body=json_body)
+
+        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.2/bugdantic.egg-info/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: bugdantic
+Version: 0.2
+Summary: Bugzilla client based on pydantic
+Author-email: James Graham <james@hoppipolla.co.uk>
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Dist: httpx[http2]==0.28.1
+Requires-Dist: pydantic==2.10.5
+Provides-Extra: test
+Requires-Dist: mypy==1.10.0; extra == "test"
+Requires-Dist: ruff==0.4.8; extra == "test"
+Requires-Dist: pytest==8.3.4; extra == "test"
+Dynamic: license-file

bugdantic-0.2/bugdantic.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+bugdantic/__init__.py
+bugdantic/bugzilla.py
+bugdantic/py.typed
+bugdantic.egg-info/PKG-INFO
+bugdantic.egg-info/SOURCES.txt
+bugdantic.egg-info/dependency_links.txt
+bugdantic.egg-info/requires.txt
+bugdantic.egg-info/top_level.txt
+test/test_bugzilla.py

bugdantic-0.2/bugdantic.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

bugdantic-0.2/bugdantic.egg-info/requires.txt

@@ -0,0 +1,7 @@
+httpx[http2]==0.28.1
+pydantic==2.10.5
+
+[test]
+mypy==1.10.0
+ruff==0.4.8
+pytest==8.3.4

bugdantic-0.2/bugdantic.egg-info/top_level.txt

@@ -0,0 +1 @@
+bugdantic

bugdantic-0.2/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "bugdantic"
+description = "Bugzilla client based on pydantic"
+authors = [
+  {name = "James Graham", email = "james@hoppipolla.co.uk"}
+]
+
+version = "0.2"
+requires-python = ">=3.11"
+classifiers = [
+    "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+]
+
+dependencies = [
+  "httpx[http2]==0.28.1",
+  "pydantic==2.10.5",
+]
+
+[project.optional-dependencies]
+test = [
+  "mypy==1.10.0",
+  "ruff==0.4.8",
+  "pytest==8.3.4",
+]

bugdantic-0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bugdantic-0.2/test/test_bugzilla.py

@@ -0,0 +1,34 @@
+import pytest
+
+from bugdantic import Bugzilla, BugzillaConfig
+
+
+@pytest.fixture
+def bugzilla():
+    config = BugzillaConfig("https://bugzilla.mozilla.org")
+    return Bugzilla(config)
+
+
+def test_bug_include_default(bugzilla):
+    result = bugzilla.bug(975444)
+    assert result.id == 975444
+    result = bugzilla.bug(975444, include_fields=["_default"])
+    assert result.id == 975444
+
+
+def test_bug_include_all(bugzilla):
+    result = bugzilla.bug(975444, include_fields=["_all"])
+    assert result.id == 975444
+
+
+def test_bug_history_full(bugzilla):
+    result = bugzilla.bug_history(1886129)
+    assert result.id == 1886129
+
+
+def test_serach_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)):
+        assert bug.id == expected_id
+        assert isinstance(bug.history, list)