destiny_sdk 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

destiny_sdk/identifiers.py

@@ -1,9 +1,10 @@
 """Identifier classes for the Destiny SDK."""
 
+import uuid
 from enum import StrEnum, auto
-from typing import Annotated, Literal
+from typing import Annotated, Literal, Self
 
-from pydantic import UUID4, BaseModel, Field, field_validator
+from pydantic import UUID4, BaseModel, Field, TypeAdapter, field_validator
 
 
 class ExternalIdentifierType(StrEnum):
@@ -94,6 +95,10 @@ ExternalIdentifier = Annotated[
     Field(discriminator="identifier_type"),
 ]
 
+ExternalIdentifierAdapter: TypeAdapter[ExternalIdentifier] = TypeAdapter(
+    ExternalIdentifier
+)
+
 
 class LinkedExternalIdentifier(BaseModel):
     """An external identifier which identifies a reference."""
@@ -105,3 +110,83 @@ class LinkedExternalIdentifier(BaseModel):
     reference_id: UUID4 = Field(
         description="The ID of the reference this identifier identifies."
     )
+
+
+class IdentifierLookup(BaseModel):
+    """An external identifier lookup."""
+
+    identifier: str = Field(description="The identifier value.")
+    identifier_type: ExternalIdentifierType | None = Field(
+        description="The type of identifier used. If not provided, it is assumed to"
+        " be a DESTINY identifier.",
+    )
+    other_identifier_name: str | None = Field(
+        default=None,
+        description="The name of the undocumented identifier type.",
+    )
+
+    def serialize(self) -> str:
+        """Serialize the identifier lookup to a string."""
+        if self.identifier_type is None:
+            return self.identifier
+        if self.identifier_type == ExternalIdentifierType.OTHER:
+            return f"other:{self.other_identifier_name}:{self.identifier}"
+        return f"{self.identifier_type.value.lower()}:{self.identifier}"
+
+    @classmethod
+    def parse(cls, identifier_lookup_string: str, delimiter: str = ":") -> Self:
+        """Parse an identifier string into an IdentifierLookup."""
+        if delimiter not in identifier_lookup_string:
+            try:
+                UUID4(identifier_lookup_string)
+            except ValueError as exc:
+                msg = (
+                    f"Invalid identifier lookup string: {identifier_lookup_string}. "
+                    "Must be UUIDv4 if no identifier type is specified."
+                )
+                raise ValueError(msg) from exc
+            return cls(
+                identifier=identifier_lookup_string,
+                identifier_type=None,
+            )
+        identifier_type, identifier = identifier_lookup_string.split(delimiter, 1)
+        if identifier_type == ExternalIdentifierType.OTHER:
+            if delimiter not in identifier:
+                msg = (
+                    f"Invalid identifier lookup string: {identifier_lookup_string}. "
+                    "Other identifier type must include other identifier name."
+                )
+                raise ValueError(msg)
+            other_identifier_type, identifier = identifier.split(delimiter, 1)
+            return cls(
+                identifier=identifier,
+                identifier_type=ExternalIdentifierType.OTHER,
+                other_identifier_name=other_identifier_type,
+            )
+        if identifier_type not in ExternalIdentifierType:
+            msg = (
+                f"Invalid identifier lookup string: {identifier_lookup_string}. "
+                f"Unknown identifier type: {identifier_type}."
+            )
+            raise ValueError(msg)
+        return cls(
+            identifier=identifier,
+            identifier_type=ExternalIdentifierType(identifier_type),
+        )
+
+    @classmethod
+    def from_identifier(cls, identifier: ExternalIdentifier | UUID4) -> Self:
+        """Create an IdentifierLookup from an ExternalIdentifier or UUID4."""
+        if isinstance(identifier, uuid.UUID):
+            return cls(identifier=str(identifier), identifier_type=None)
+        return cls(
+            identifier=str(identifier.identifier),
+            identifier_type=identifier.identifier_type,
+            other_identifier_name=getattr(identifier, "other_identifier_name", None),
+        )
+
+    def to_identifier(self) -> ExternalIdentifier | UUID4:
+        """Convert into an ExternalIdentifier or UUID4 if it has no identifier_type."""
+        if self.identifier_type is None:
+            return UUID4(self.identifier)
+        return ExternalIdentifierAdapter.validate_python(self.model_dump())

{destiny_sdk-0.5.0.dist-info → destiny_sdk-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: destiny_sdk
-Version: 0.5.0
+Version: 0.5.1
 Summary: A software development kit (sdk) to support interaction with the DESTINY repository
 Author-email: Adam Hamilton <adam@futureevidence.org>, Andrew Harvey <andrew@futureevidence.org>, Daniel Breves <daniel@futureevidence.org>, Jack Walmisley <jack@futureevidence.org>
 License-Expression: Apache-2.0

{destiny_sdk-0.5.0.dist-info → destiny_sdk-0.5.1.dist-info}/RECORD

@@ -3,7 +3,7 @@ destiny_sdk/auth.py,sha256=bY72ywZEcG_67YBd9PrwgWTXkCf58rhLvVEXrtXbWtA,6247
 destiny_sdk/client.py,sha256=fTBtuq5emT8ieNtCuCY8Y6xAKZJDLq8sG1WOvmjLz-I,4971
 destiny_sdk/core.py,sha256=_FwDaczKTSaUSV_qfcnLhkBbZagh4ayFpN0qUwJ03-o,1448
 destiny_sdk/enhancements.py,sha256=SkIlIlWKBN7Z-aXpQiy22SXrU7zVnKxaRb4F5yaFsO8,11503
-destiny_sdk/identifiers.py,sha256=HjY3EVrbM2NP06TNo-VkXxH97zqTzoPFn974_iSXoKw,3554
+destiny_sdk/identifiers.py,sha256=1N2cszBmnQoUeKm54-7MUTO-zTDuvW8U9OjTeAmhWvo,7182
 destiny_sdk/imports.py,sha256=b-rh-dt3NsyLGxqmVzIzKaHiXhbw-3wtAaBN-ZW-i1E,5940
 destiny_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 destiny_sdk/references.py,sha256=Dx-WKcv9gNJkKU9n52AYoEey7siTHR5_wBVBKSHND6Q,2321
@@ -11,7 +11,7 @@ destiny_sdk/robots.py,sha256=I_ZvMxwST52e8ovhv0-gPbOB3P9tptbRG0LrkNNOqKo,13463
 destiny_sdk/visibility.py,sha256=8D44Q868YdScAt6eAFgXXrhonozXnv_Qa5w5yEGMPX8,577
 destiny_sdk/parsers/__init__.py,sha256=d5gS--bXla_0I7e_9wTBnGWMXt2U8b-_ndeprTPe1hk,149
 destiny_sdk/parsers/eppi_parser.py,sha256=rEOtt_5Kp3oktFlzRTLZ2x4_7aQ9-ba3FYpkaEnpnvs,5521
-destiny_sdk-0.5.0.dist-info/METADATA,sha256=por5YQKyr40k3V95DJN_g8295pxlXbqG2nWdVf3h15w,2440
-destiny_sdk-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-destiny_sdk-0.5.0.dist-info/licenses/LICENSE,sha256=6QURU4gvvTjVZ5rfp5amZ6FtFvcpPhAGUjxF5WSZAHI,9138
-destiny_sdk-0.5.0.dist-info/RECORD,,
+destiny_sdk-0.5.1.dist-info/METADATA,sha256=eKznxYvVJhW-IVlA16LHzJ2QtpzfG3RyBKk9e-x_o8w,2440
+destiny_sdk-0.5.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+destiny_sdk-0.5.1.dist-info/licenses/LICENSE,sha256=6QURU4gvvTjVZ5rfp5amZ6FtFvcpPhAGUjxF5WSZAHI,9138
+destiny_sdk-0.5.1.dist-info/RECORD,,