mreg-api 0.2.0__tar.gz → 0.2.2__tar.gz

{mreg_api-0.2.0 → mreg_api-0.2.2}/.github/workflows/publish.yml

@@ -80,13 +80,7 @@ jobs:
                       ### uv
 
                       ```bash
-                      uv tool install mreg-api==${{ github.ref_name }}
-                      ```
-
-                      ### pipx
-
-                      ```bash
-                      pipx install mreg-api==${{ github.ref_name }}
+                      uv add mreg-api==${{ github.ref_name }}
                       ```
 
                       ### pip

{mreg_api-0.2.0 → mreg_api-0.2.2}/CHANGELOG.md

@@ -7,6 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- ## Unreleased -->
 
+## [0.2.2](https://github.com/unioslo/mreg-api/releases/tag/0.2.2) - 2026-04-23
+
+### Changed
+
+- Removed nullability of `NAPTR` fields.
+
+### Removed
+
+- Duplicate endpoint `Endpoints.NAPTRs`. Now only `Endpoints.Naptrs` exists.
+
+## [0.2.1](https://github.com/unioslo/mreg-api/releases/tag/0.2.1) - 2026-04-20
+
+### Added
+
+- `APIMixin.endpoint_with_id` property for getting the endpoint for the object with its ID, used for operations on the object itself (PATCH, DELETE, etc.). Used by default in `APIMixin.patch()` and `APIMixin.delete()`. Subclasses can override `endpoint_with_id` to provide custom endpoint resolution for these operations.
+
+### Removed
+
+- `Community.patch()`. Now uses `APIMixin.patch()`.
+- `Community.delete()`. Now uses `APIMixin.delete()`.
+- `APIMixin.patch()` response validation.
+
+### Deprecated
+
+- `APIMixin.patch()` parameter `validate`. Will be removed in 0.3.0.
+
 ## [0.2.0](https://github.com/unioslo/mreg-api/releases/tag/0.2.0) - 2026-04-16
 
 ### Added

{mreg_api-0.2.0 → mreg_api-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mreg-api
-Version: 0.2.0
+Version: 0.2.2
 Summary: MREG API
 Author-email: Terje Kvernes <terjekv@uio.no>
 Maintainer-email: Peder Hovdan Andresen <pederhan@uio.no>

{mreg_api-0.2.0 → mreg_api-0.2.2}/mreg_api/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.2.2'
+__version_tuple__ = version_tuple = (0, 2, 2)
 
-__commit_id__ = commit_id = 'gab1432412'
+__commit_id__ = commit_id = 'ge065b8b90'

{mreg_api-0.2.0 → mreg_api-0.2.2}/mreg_api/endpoints.py

@@ -23,7 +23,6 @@ class Endpoint(str, Enum):
     PTR_overrides = "/api/v1/ptroverrides/"
     Locs = "/api/v1/locs/"
     Mxs = "/api/v1/mxs/"
-    NAPTRs = "/api/v1/naptrs/"
     Nameservers = "/api/v1/nameservers/"
 
     Hosts = "/api/v1/hosts/"

{mreg_api-0.2.0 → mreg_api-0.2.2}/mreg_api/models/abstracts.py

@@ -4,110 +4,25 @@ from __future__ import annotations
 
 from abc import ABC
 from abc import abstractmethod
-from collections.abc import Mapping
 from datetime import datetime
 from typing import Any
-from typing import Callable
 from typing import Self
-from typing import cast
+from typing import overload
 
-from pydantic import AliasChoices
 from pydantic import BaseModel
 from pydantic import ConfigDict
-from pydantic.fields import FieldInfo
+from typing_extensions import deprecated
 
 from mreg_api.endpoints import Endpoint
 from mreg_api.exceptions import EntityAlreadyExists
 from mreg_api.exceptions import EntityNotFound
 from mreg_api.exceptions import GetError
 from mreg_api.exceptions import InternalError
-from mreg_api.exceptions import PatchError
 from mreg_api.exceptions import PostError
 from mreg_api.types import JsonMapping
 from mreg_api.types import QueryParams
 
 
-def get_field_aliases(field_info: FieldInfo) -> set[str]:
-    """Get all aliases for a Pydantic field."""
-    aliases: set[str] = set()
-
-    if field_info.alias:
-        aliases.add(field_info.alias)
-
-    if field_info.validation_alias:
-        if isinstance(field_info.validation_alias, str):
-            aliases.add(field_info.validation_alias)
-        elif isinstance(field_info.validation_alias, AliasChoices):
-            for choice in field_info.validation_alias.choices:
-                if isinstance(choice, str):
-                    aliases.add(choice)
-    return aliases
-
-
-def get_model_aliases(model: BaseModel) -> dict[str, str]:
-    """Get a mapping of aliases to field names for a Pydantic model.
-
-    Includes field names, alias, and validation alias(es).
-    """
-    fields: dict[str, str] = {}
-    for field_name, field_info in model.model_fields.items():
-        aliases = get_field_aliases(field_info)
-        if model.model_config.get("populate_by_name"):
-            aliases.add(field_name)
-        # Assign aliases to field name in mapping
-        for alias in aliases:
-            fields[alias] = field_name
-    return fields
-
-
-def validate_patched_model(model: BaseModel, fields: Mapping[str, Any]) -> None:
-    """Validate that model fields were patched correctly."""
-    aliases = get_model_aliases(model)
-
-    validators: dict[type, Callable[[Any, Any], bool]] = {
-        list: _validate_lists,
-        dict: _validate_dicts,
-    }
-    for key, value in fields.items():
-        field_name = key
-        if key in aliases:
-            field_name = aliases[key]
-
-        try:
-            nval = getattr(model, field_name)
-        except AttributeError as e:
-            raise PatchError(f"Could not get value for {field_name} in patched object.") from e
-
-        # Ensure patched value is the one we tried to set
-        validator = validators.get(
-            type(nval),  # pyright:ignore[reportUnknownArgumentType, reportAny] # dict.get call with unknown type (Any) is fine
-            _validate_default,
-        )
-        if not validator(nval, value):
-            raise PatchError(
-                f"Patch failure! Tried to set {key} to {value!r}, but server returned {nval!r}."
-            )
-
-
-def _validate_lists(new: list[Any], old: list[Any]) -> bool:
-    """Validate that two lists are equal."""
-    if len(new) != len(old):
-        return False
-    return all(x in old for x in new)
-
-
-def _validate_dicts(new: dict[str, Any], old: dict[str, Any]) -> bool:
-    """Validate that two dictionaries are equal."""
-    if len(new) != len(old):
-        return False
-    return all(old.get(k) == v for k, v in new.items())
-
-
-def _validate_default(new: Any, old: Any) -> bool:
-    """Validate that two values are equal."""
-    return str(new) == str(old)
-
-
 class FrozenModel(BaseModel):
     """Model for an immutable object."""
 
@@ -153,9 +68,17 @@ class APIMixin(ABC):
     @classmethod
     @abstractmethod
     def endpoint(cls) -> Endpoint:
-        """Return the endpoint for the method."""
+        """Return the endpoint for the resource."""
         raise NotImplementedError("You must define an endpoint.")
 
+    @property
+    def endpoint_with_id(self) -> str:
+        """Return the endpoint for the object with its ID.
+
+        Used for operations on the object itself (PATCH, DELETE, etc.).
+        """
+        return self.endpoint().with_id(self.id_for_endpoint())
+
     @classmethod
     def get(cls, _id: int) -> Self | None:
         """Get an object.
@@ -526,8 +449,33 @@ class APIMixin(ABC):
             raise GetError(f"Could not refresh {self.__class__.__name__} with ID {identifier}.")
         return obj
 
+    @overload
+    @deprecated(
+        "APIMixin.patch() parameter 'validate' is deprecated and will be removed in a future version."
+    )
+    def patch(
+        self,
+        data: JsonMapping,
+        *,
+        params: QueryParams | None = None,
+        validate: bool,
+    ) -> Self: ...
+
+    @overload
+    def patch(
+        self,
+        data: JsonMapping,
+        *,
+        params: QueryParams | None = ...,
+        validate: None = ...,
+    ) -> Self: ...
+
     def patch(
-        self, data: JsonMapping, *, params: QueryParams | None = None, validate: bool = False
+        self,
+        data: JsonMapping,
+        *,
+        params: QueryParams | None = None,
+        validate: bool | None = None,  # noqa: ARG002  # pyright: ignore[reportUnusedParameter]
     ) -> Self:
         """Patch the object with the given values.
 
@@ -539,21 +487,16 @@ class APIMixin(ABC):
         Args:
             data: The values to patch.
             params: Optional query parameters.
-            validate: Whether to validate the patched object.
+            validate: Whether to validate the response. (Deprecated and ignored)
 
         Returns:
             The object refetched from the server.
         """
         from mreg_api.client import MregClient  # noqa: PLC0415
 
-        MregClient().patch(self.endpoint().with_id(self.id_for_endpoint()), json=data, params=params)
+        MregClient().patch(self.endpoint_with_id, json=data, params=params)
         new_object = self.refetch()
 
-        if validate:
-            # __init_subclass__ guarantees we inherit from BaseModel
-            # but we can't signal this to the type checker, so we cast here.
-            validate_patched_model(cast(BaseModel, new_object), data)  # pyright: ignore[reportInvalidCast] # we know what we are doing here (...?!)
-
         return new_object
 
     def delete(self) -> bool:
@@ -564,7 +507,7 @@ class APIMixin(ABC):
         """
         from mreg_api.client import MregClient  # noqa: PLC0415
 
-        response = MregClient().delete(self.endpoint().with_id(self.id_for_endpoint()))
+        response = MregClient().delete(self.endpoint_with_id)
 
         if response and response.is_success:
             return True

{mreg_api-0.2.0 → mreg_api-0.2.2}/mreg_api/models/fields.py

@@ -1,6 +1,6 @@
 """Custom field types for Pydantic models.
 
-The types validate to basic types like str, int, etc., but with additional
+The types resolve to basic types like str, int, etc., but with additional
 validation added to them. The types are used in Pydantic models for consistent
 validation of common fields such as hostnames, MAC addresses, etc.
 

{mreg_api-0.2.0 → mreg_api-0.2.2}/mreg_api/models/history.py

@@ -14,6 +14,7 @@ from pydantic import field_validator
 
 from mreg_api.endpoints import Endpoint
 from mreg_api.exceptions import EntityNotFound
+from mreg_api.types import JsonMapping
 from mreg_api.types import QueryParams
 from mreg_api.types import parse_json_mapping_string
 
@@ -62,7 +63,7 @@ class HistoryItem(BaseModel):
     mid: int = Field(alias="model_id")  # model_ is an internal pydantic namespace.
     model: str
     action: str
-    data: dict[str, Any]
+    data: JsonMapping
 
     @field_validator("data", mode="before")
     def parse_json_data(cls, v: Any) -> Any:

{mreg_api-0.2.0 → mreg_api-0.2.2}/mreg_api/models/models.py

@@ -891,7 +891,7 @@ class Zone(FrozenModelWithTimestamps, WithTTL, APIMixin):
 
         self.ensure_delegation_in_zone(name)
         cls = Delegation.type_by_zone(self)
-        resp = MregClient().get(cls.endpoint_with_id(self, name), ok404=True)
+        resp = MregClient().get(cls.endpoint_with_name(self, name), ok404=True)
         if not resp:
             return None
         return cls.model_validate_json(resp.text)
@@ -951,7 +951,7 @@ class Zone(FrozenModelWithTimestamps, WithTTL, APIMixin):
         # Check if delegation exists
         self.ensure_delegation_in_zone(name)  # check name
         delegation = self.get_delegation_or_raise(name)
-        resp = MregClient().delete(delegation.endpoint_with_id(self, name))
+        resp = MregClient().delete(delegation.endpoint_with_name(self, name))
         return resp.is_success if resp else False
 
     def set_delegation_comment(self, name: str, comment: str) -> None:
@@ -966,7 +966,7 @@ class Zone(FrozenModelWithTimestamps, WithTTL, APIMixin):
         delegation = self.get_delegation_or_raise(name)
         try:
             MregClient().patch(
-                delegation.endpoint_with_id(self, delegation.name), json={"comment": comment}
+                delegation.endpoint_with_name(self, delegation.name), json={"comment": comment}
             )
         except PatchError as e:
             # TODO: implement after mreg-cli parity
@@ -1087,7 +1087,7 @@ class Delegation(FrozenModelWithTimestamps, WithZone):
         return Endpoint.ForwardZonesDelegations
 
     @classmethod
-    def endpoint_with_id(cls, zone: Zone, name: str) -> str:
+    def endpoint_with_name(cls, zone: Zone, name: str) -> str:
         """Return the path to a delegation in a specific zone."""
         if cls.is_reverse():
             endpoint = Endpoint.ReverseZonesDelegationsZone
@@ -2000,7 +2000,7 @@ class Network(FrozenModelWithTimestamps, APIMixin):
         Returns:
             The updated Network object.
         """
-        return self.patch({"policy": policy.id}, validate=False)
+        return self.patch({"policy": policy.id})
 
     def set_max_communities(self, max_communities: int) -> Self:
         """Set the maximum number of communities for the network.
@@ -2011,7 +2011,7 @@ class Network(FrozenModelWithTimestamps, APIMixin):
         Returns:
             The updated Network object.
         """
-        return self.patch({"max_communities": max_communities}, validate=False)
+        return self.patch({"max_communities": max_communities})
 
     def unset_policy(self) -> Self:
         """Unset the network policy of the network.
@@ -2019,7 +2019,7 @@ class Network(FrozenModelWithTimestamps, APIMixin):
         Returns:
             The updated Network object.
         """
-        return self.patch({"policy": None}, validate=False)
+        return self.patch({"policy": None})
 
     def unset_max_communities(self) -> Self:
         """Unset the maximum number of communities for the network.
@@ -2027,7 +2027,7 @@ class Network(FrozenModelWithTimestamps, APIMixin):
         Returns:
             The updated Network object.
         """
-        return self.patch({"max_communities": None}, validate=False)
+        return self.patch({"max_communities": None})
 
 
 class NetworkPolicyAttribute(FrozenModelWithTimestamps, WithName):
@@ -2068,6 +2068,7 @@ class Community(FrozenModelWithTimestamps, APIMixin):
         return Endpoint.NetworkCommunity
 
     @property
+    @override
     def endpoint_with_id(self) -> str:
         """Return the endpoint with the community ID."""
         return self.endpoint().with_params(self.network_address, self.id)
@@ -2088,42 +2089,6 @@ class Community(FrozenModelWithTimestamps, APIMixin):
 
         return MregClient().get_typed(self.endpoint_with_id, self.__class__)
 
-    @override
-    def patch(
-        self,
-        data: JsonMapping,
-        *,
-        params: QueryParams | None = None,
-        validate: bool = False,  # noqa: ARG002, E501
-    ) -> Self:
-        """Patch the community.
-
-        Args:
-            data: The data to patch.
-            params: Optional query parameters.
-            validate: Whether to validate the response. (Not implemented)
-
-        Returns:
-            The updated Community object.
-        """
-        from mreg_api.client import MregClient  # noqa: PLC0415
-
-        try:
-            MregClient().patch(self.endpoint_with_id, json=data, params=params)
-        except PatchError as e:
-            # TODO: implement after mreg-cli parity
-            # raise PatchError(f"Failed to patch community {self.name!r}", e.response) from e
-            raise e
-        new_object = self.refetch()
-        return new_object
-
-    def delete(self) -> bool:
-        """Delete the community."""
-        from mreg_api.client import MregClient  # noqa: PLC0415
-
-        resp = MregClient().delete(self.endpoint_with_id)
-        return resp.is_success if resp else False
-
     def get_hosts(self) -> list[Host]:
         """Get a list of hosts in the community.
 
@@ -2286,7 +2251,6 @@ class NetworkPolicy(FrozenModelWithTimestamps, WithName):
         """
         self.patch(
             {"attributes": [{"name": a.name, "value": a.value} for a in attrs]},
-            validate=False,
         )
         # NOTE: can return self.refetch() here if we need to refresh the object
 
@@ -2468,7 +2432,7 @@ class IPAddress(FrozenModelWithTimestamps, WithHost, APIMixin):
             A new IPAddress object fetched from the API with the MAC address removed.
         """
         # Model converts empty string to None so we must validate this ourselves.
-        patched = self.patch(data={"macaddress": ""}, validate=False)
+        patched = self.patch(data={"macaddress": ""})
         if patched.macaddress:
             raise PatchError(f"Failed to disassociate MAC address from {self.ipaddress}")
         return patched
@@ -2639,9 +2603,9 @@ class NAPTR(FrozenModelWithTimestamps, WithHost, APIMixin):
     id: int  # noqa: A003
     preference: int
     order: int
-    flag: str | None = None
-    service: str | None = None
-    regex: str | None = None
+    flag: str
+    service: str
+    regex: str
     replacement: str
 
     @classmethod
@@ -2650,7 +2614,7 @@ class NAPTR(FrozenModelWithTimestamps, WithHost, APIMixin):
         return Endpoint.Naptrs
 
     @classmethod
-    def headers(cls) -> list[str]:
+    def headers(cls) -> list[str]:  # TODO: remove. Move to mreg-cli
         """Return the headers for the NAPTR record."""
         return [
             "NAPTRs:",
@@ -3282,7 +3246,7 @@ class Host(FrozenModelWithTimestamps, WithTTL, WithHistory, APIMixin):
             Host: Updated Host object.
         """
         # Uses non-atomic host update via PATCH to set the contacts list.
-        return self.patch(data={"contacts": contacts}, validate=False)
+        return self.patch(data={"contacts": contacts})
 
     def add_contacts(self, contacts: list[str]) -> HostContactModification:
         """Add contacts to the host.

{mreg_api-0.2.0 → mreg_api-0.2.2}/mreg_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mreg-api
-Version: 0.2.0
+Version: 0.2.2
 Summary: MREG API
 Author-email: Terje Kvernes <terjekv@uio.no>
 Maintainer-email: Peder Hovdan Andresen <pederhan@uio.no>