ds-caselaw-marklogic-api-client 37.3.0__py3-none-any.whl → 37.4.0__py3-none-any.whl

caselawclient/factories.py

@@ -1,10 +1,8 @@
 import datetime
 import json
-from typing import Any, Optional
+from typing import Any, Generic, Optional, Type, TypeAlias, TypeVar, cast
 from unittest.mock import Mock
 
-from typing_extensions import TypeAlias
-
 from caselawclient.Client import MarklogicApiClient
 from caselawclient.identifier_resolution import IdentifierResolution, IdentifierResolutions
 from caselawclient.models.documents import Document
@@ -17,6 +15,8 @@ from caselawclient.models.press_summaries import PressSummary
 from caselawclient.responses.search_result import SearchResult, SearchResultMetadata
 from caselawclient.types import DocumentURIString
 
+T = TypeVar("T")
+
 DEFAULT_DOCUMENT_BODY_XML = """<akomaNtoso xmlns="http://docs.oasis-open.org/legaldocml/ns/akn/3.0" xmlns:uk="https://caselaw.nationalarchives.gov.uk/akn">
             <judgment name="decision">
                 <meta/><header/>
@@ -114,13 +114,13 @@ class PressSummaryFactory(DocumentFactory):
     }
 
 
-class SimpleFactory:
-    target_class: TypeAlias = object
+class SimpleFactory(Generic[T]):
+    target_class: Type[T]
     # "name_of_attribute": "default value"
     PARAMS_MAP: dict[str, Any]
 
     @classmethod
-    def build(cls, **kwargs: Any) -> target_class:
+    def build(cls, **kwargs: Any) -> T:
         mock_object = Mock(spec=cls.target_class, autospec=True)
 
         for param, default in cls.PARAMS_MAP.items():
@@ -129,10 +129,10 @@ class SimpleFactory:
             else:
                 setattr(mock_object.return_value, param, default)
 
-        return mock_object()
+        return cast(T, mock_object())
 
 
-class SearchResultMetadataFactory(SimpleFactory):
+class SearchResultMetadataFactory(SimpleFactory[SearchResultMetadata]):
     target_class = SearchResultMetadata
     # "name_of_attribute": "default value"
     PARAMS_MAP = {
@@ -174,9 +174,8 @@ class IdentifierResolutionsFactory:
         return IdentifierResolutions(resolutions)
 
 
-class SearchResultFactory(SimpleFactory):
+class SearchResultFactory(SimpleFactory[SearchResult]):
     target_class = SearchResult
-
     PARAMS_MAP = {
         "uri": "d-a1b2c3",
         "name": "Judgment v Judgement",

caselawclient/models/documents/__init__.py

@@ -229,7 +229,7 @@ class Document:
             return []
 
     @cached_property
-    def versions_as_documents(self) -> list[Any]:
+    def versions_as_documents(self) -> list["Document"]:
         """
         Returns a list of `Document` subclasses corresponding to the versions of the document. The first entry is:
            * the most recent

caselawclient/models/documents/body.py

@@ -51,6 +51,14 @@ class DocumentBody:
     def jurisdiction(self) -> str:
         return self.get_xpath_match_string("/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:jurisdiction/text()")
 
+    @cached_property
+    def category(self) -> Optional[str]:
+        return self.get_xpath_match_string("/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:category/text()")
+
+    @cached_property
+    def case_number(self) -> Optional[str]:
+        return self.get_xpath_match_string("/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:caseNumber/text()")
+
     @property
     def court_and_jurisdiction_identifier_string(self) -> CourtCode:
         if self.jurisdiction != "":

caselawclient/models/identifiers/__init__.py

@@ -11,13 +11,17 @@ from .exceptions import IdentifierValidationException, UUIDMismatchError
 IDENTIFIER_PACKABLE_ATTRIBUTES: list[str] = [
     "uuid",
     "value",
+    "deprecated",
     "url_slug",
 ]
+"""A list of attributes of an Identifier to pack into an XML representation."""
 
 IDENTIFIER_UNPACKABLE_ATTRIBUTES: list[str] = [
     "uuid",
     "value",
+    "deprecated",
 ]
+"""A list of attributes to unpack from an XML representation."""
 
 
 class IdentifierSchema(ABC):
@@ -69,6 +73,9 @@ class Identifier(ABC):
     uuid: str
     value: DocumentIdentifierValue
 
+    deprecated: bool
+    """Should this identifier be considered deprecated, ie although we know it refers to a particular document its usage should be discouraged?"""
+
     def __init_subclass__(cls: type["Identifier"], **kwargs: Any) -> None:
         """Ensure that subclasses have the required attributes set."""
         for required in ("schema",):
@@ -77,12 +84,16 @@ class Identifier(ABC):
         super().__init_subclass__(**kwargs)
 
     def __repr__(self) -> str:
-        return f"<{self.schema.name} {self.value}: {self.uuid}>"
+        representation = f"{self.schema.name} {self.value}: {self.uuid}"
+
+        if self.deprecated:
+            return f"<{representation} (deprecated)> "
+        return f"<{representation}>"
 
     def __str__(self) -> str:
         return self.value
 
-    def __init__(self, value: str, uuid: Optional[str] = None) -> None:
+    def __init__(self, value: str, uuid: Optional[str] = None, deprecated: bool = False) -> None:
         if not self.schema.validate_identifier(value=value):
             raise IdentifierValidationException(
                 f'Identifier value "{value}" is not valid according to the {self.schema.name} schema.'
@@ -94,6 +105,8 @@ class Identifier(ABC):
         else:
             self.uuid = "id-" + str(uuid4())
 
+        self.deprecated = deprecated
+
     @property
     def as_xml_tree(self) -> etree._Element:
         """Convert this Identifier into a packed XML representation for storage."""
@@ -102,9 +115,13 @@ class Identifier(ABC):
         namespace_attribute = etree.SubElement(identifier_root, "namespace")
         namespace_attribute.text = self.schema.namespace
 
-        for attribute in IDENTIFIER_PACKABLE_ATTRIBUTES:
-            packed_attribute = etree.SubElement(identifier_root, attribute)
-            packed_attribute.text = getattr(self, attribute)
+        for attribute_name in IDENTIFIER_PACKABLE_ATTRIBUTES:
+            packed_attribute = etree.SubElement(identifier_root, attribute_name)
+            attribute_value = getattr(self, attribute_name)
+            if type(attribute_value) is bool:
+                packed_attribute.text = str(attribute_value).lower()
+            else:
+                packed_attribute.text = getattr(self, attribute_name)
 
         return identifier_root
 

caselawclient/models/identifiers/unpacker.py

@@ -43,14 +43,23 @@ def unpack_an_identifier_from_etree(identifier_xml: etree._Element) -> Optional[
         warn(f"Identifier type {namespace_element.text} is not known.")
         return None
 
-    kwargs: dict[str, str] = {}
+    str_kwargs: dict[str, str] = {}
+    deprecated = False
 
     for attribute in IDENTIFIER_UNPACKABLE_ATTRIBUTES:
         element = identifier_xml.find(attribute)
-        if element is None or not element.text:
-            raise InvalidIdentifierXMLRepresentationException(
-                f"Identifer XML representation is not valid: {element} not present or empty"
-            )
-        kwargs[attribute] = element.text
 
-    return IDENTIFIER_NAMESPACE_MAP[namespace_element.text](**kwargs)
+        # Special case for unpacking deprecation state into a boolean
+        if attribute == "deprecated":
+            if element is not None and element.text is not None and element.text.lower() == "true":
+                deprecated = True
+
+        else:
+            # Case for unpacking all other element types
+            if element is None or not element.text:
+                raise InvalidIdentifierXMLRepresentationException(
+                    f"Identifer XML representation is not valid: {element} not present or empty"
+                )
+            str_kwargs[attribute] = element.text
+
+    return IDENTIFIER_NAMESPACE_MAP[namespace_element.text](deprecated=deprecated, **str_kwargs)

caselawclient/models/utilities/__init__.py

@@ -3,23 +3,22 @@ from typing import TypedDict
 
 from requests_toolbelt.multipart.decoder import BodyPart
 
-VERSION_REGEX = r"xml_versions/(\d{1,10})-(\d{1,10}|TDR)"
-# Here we limit the number of digits in the version and document reference to 10 on purpose, see
-# https://owasp.org/www-community/attacks/Regular_expression_Denial_of_Service_-_ReDoS for an explanation of why.
+from caselawclient.types import DocumentURIString, MarkLogicDocumentURIString
 
-akn_namespace = {"akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0"}
-uk_namespace = {"uk": "https://caselaw.nationalarchives.gov.uk/akn"}
+VERSION_REGEX = r"xml_versions/(\d{1,10})-"
+# Here we limit the number of digits in the version to 10 on purpose, see
+# https://owasp.org/www-community/attacks/Regular_expression_Denial_of_Service_-_ReDoS for an explanation of why.
 
 
 class VersionsDict(TypedDict):
-    uri: str  ## TODO: This should be either a MarkLogicDocumentURIString (raw from ML) or a DocumentURIString (and we parse it out). Just a str is too vague.
+    uri: DocumentURIString
     version: int
 
 
 def render_versions(decoded_versions: list[BodyPart]) -> list[VersionsDict]:
     versions: list[VersionsDict] = [
         {
-            "uri": part.text.strip("/").rstrip(".xml"),
+            "uri": MarkLogicDocumentURIString(part.text).as_document_uri(),
             "version": extract_version(part.text),
         }
         for part in decoded_versions

{ds_caselaw_marklogic_api_client-37.3.0.dist-info → ds_caselaw_marklogic_api_client-37.4.0.dist-info}/METADATA

@@ -1,14 +1,15 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: ds-caselaw-marklogic-api-client
-Version: 37.3.0
+Version: 37.4.0
 Summary: An API client for interacting with the underlying data in Find Caselaw.
-Home-page: https://github.com/nationalarchives/ds-caselaw-custom-api-client
 Keywords: national archives,caselaw
 Author: The National Archives
 Requires-Python: >=3.10.0,<4.0.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: boto3 (>=1.26.112,<2.0.0)
 Requires-Dist: certifi (>=2025.4.26,<2025.5.0)
 Requires-Dist: charset-normalizer (>=3.0.0,<4.0.0)
@@ -26,6 +27,7 @@ Requires-Dist: requests-toolbelt (>=0.10.1,<1.1.0)
 Requires-Dist: saxonche (>=12.5.0,<13.0.0)
 Requires-Dist: sqids (>=0.5.0,<0.6.0)
 Requires-Dist: typing-extensions (>=4.7.1,<5.0.0)
+Project-URL: Homepage, https://github.com/nationalarchives/ds-caselaw-custom-api-client
 Description-Content-Type: text/markdown
 
 # The National Archives: Find Case Law

{ds_caselaw_marklogic_api_client-37.3.0.dist-info → ds_caselaw_marklogic_api_client-37.4.0.dist-info}/RECORD

@@ -4,26 +4,26 @@ caselawclient/client_helpers/__init__.py,sha256=eucyUXwUqI72TPw-C5zLcHlMu4GtFY50
 caselawclient/client_helpers/search_helpers.py,sha256=R99HyRLeYHgsw2L3DOidEqlKLLvs6Tga5rKTuWQViig,1525
 caselawclient/content_hash.py,sha256=0cPC4OoABq0SC2wYFX9-24DodNigeOqksDxgxQH_hUA,2221
 caselawclient/errors.py,sha256=JC16fEGq_MRJX-_KFzfINCV2Cqx8o6OWOt3C16rQd84,3142
-caselawclient/factories.py,sha256=XgrnG61hAJ-ty61DLv2qNEAo9ITuDZowZ4MRmPrf2Bg,7109
+caselawclient/factories.py,sha256=6tjIJBg0vQivYVwdKBVES8lhavLK4exqi7-CGk7w2HE,7161
 caselawclient/identifier_resolution.py,sha256=B5I1sD7o7YjzsXMECjbKjgiGLDda5bGhejsJ-lYpTIg,2429
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
-caselawclient/models/documents/__init__.py,sha256=4o6-8Iy5ZA8KEaqOt8xkpbqc7vwOzm8IoHvI8897mPk,19460
-caselawclient/models/documents/body.py,sha256=IVcuSbgA7SvCvii_VE8MZy_54enDZY8VPoESkUDgfKU,6114
+caselawclient/models/documents/__init__.py,sha256=zDrR6XniqB6S2BkNJH8KfvPz-RCBjPVG_N6eJkJiIlA,19467
+caselawclient/models/documents/body.py,sha256=Hy76P8XM0K7EQVy1rz9PQe8TSgepvjLRtbYQmXX9J1g,6469
 caselawclient/models/documents/exceptions.py,sha256=Mz1P8uNqf5w6uLnRwJt6xK7efsVqtd5VA-WXUUH7QLk,285
 caselawclient/models/documents/statuses.py,sha256=Cp4dTQmJOtsU41EJcxy5dV1841pGD2PNWH0VrkDEv4Q,579
 caselawclient/models/documents/transforms/html.xsl,sha256=XyUQLFcJ7_GwthWQ6ShU0bmzrgpl7xDFU-U8VLgOvEs,38258
 caselawclient/models/documents/xml.py,sha256=HlmPb63lLMnySSOLP4iexcAyQiLByKBZtTd25f8sY8M,1268
-caselawclient/models/identifiers/__init__.py,sha256=_iAsx_e-Rxq3ED3TQQ5Vg1ZNnQn6AZQK8QCvHSFhdGg,6848
+caselawclient/models/identifiers/__init__.py,sha256=nIlf3q-8yW6S00JU7GbxZqIMqNACwlEafRIuleS-5bM,7603
 caselawclient/models/identifiers/exceptions.py,sha256=ckVsjPzLuTXkbd7KZRJXoxcltQCXPGL2rMyYwE5orgg,177
 caselawclient/models/identifiers/fclid.py,sha256=Gq0G0eLdUH3j7VybluqJGVcHV3Y-hpjty1OdR91dI5Q,1453
 caselawclient/models/identifiers/neutral_citation.py,sha256=mFc-nYDIkLf5fM2eTSBnBigVgxuDcUF2HuMwQYEYeXY,2871
 caselawclient/models/identifiers/press_summary_ncn.py,sha256=CKhNTnO6pfriS4Sg-gt0Pf0fRhH53Uf0flULPncJWM4,762
-caselawclient/models/identifiers/unpacker.py,sha256=fKfiuTKaN-71e40PV8BC9PueKjwgfX9Xw3IVdy8mkqg,2299
+caselawclient/models/identifiers/unpacker.py,sha256=y9WnDdy5qSXolsjLO_D0rjqJEAcVtKpfDz3-t2_keG0,2692
 caselawclient/models/judgments.py,sha256=r40irgdEID-NeSNLm3OUdUBznMpRSwjD2SJrGlBgP8o,2208
 caselawclient/models/neutral_citation_mixin.py,sha256=jAac3PPuWyPdj9N-n-U_JfwkbgbSIXaqFVQahfu95do,2086
 caselawclient/models/parser_logs.py,sha256=30kF4w0GcowiMIFtymUkl7ZARanNh_PjDpJZezn-cA8,315
 caselawclient/models/press_summaries.py,sha256=PIq9RceZ7n7Z079tESfxhQbfxCmtTc2V2OeFtcn594s,2144
-caselawclient/models/utilities/__init__.py,sha256=u3yIhbTjFQ1JJyAm5wsMEBswWl4t6Z7UMORF5FqC2xQ,1257
+caselawclient/models/utilities/__init__.py,sha256=LPhyrQwLKc5tIJUO8Bysn9wCiR6Z6jMMTksjOV4JH9U,1041
 caselawclient/models/utilities/aws.py,sha256=NTF2W2aNgbO72e5WklXZC2U2_GPbVeynjTS1Nqu6DcE,8561
 caselawclient/models/utilities/dates.py,sha256=WwORxVjUHM1ZFcBF6Qtwo3Cj0sATsnSECkUZ6ls1N1Q,492
 caselawclient/models/utilities/move.py,sha256=MXdUqkSiyqRb8YKs_66B6ICWn8EWM6DiJV95fuJO1Us,3610
@@ -83,7 +83,7 @@ caselawclient/xquery/validate_document.xqy,sha256=PgaDcnqCRJPIVqfmWsNlXmCLNKd21q
 caselawclient/xquery/xslt.xqy,sha256=w57wNijH3dkwHkpKeAxqjlghVflQwo8cq6jS_sm-erM,199
 caselawclient/xquery/xslt_transform.xqy,sha256=cccaFiGkCcvSfDv007UriZ3I4ak2nTLP1trRZdbOoS8,2462
 caselawclient/xquery_type_dicts.py,sha256=zuyDGTkcN6voOXCm3APXItZ-Ey6tZ2hdZummZWzjl50,6489
-ds_caselaw_marklogic_api_client-37.3.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-37.3.0.dist-info/METADATA,sha256=SBFGKzyXMVM2TbhCofHTIMGJ5O9MLDHjfh-3V4aupk4,4206
-ds_caselaw_marklogic_api_client-37.3.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-37.3.0.dist-info/RECORD,,
+ds_caselaw_marklogic_api_client-37.4.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-37.4.0.dist-info/METADATA,sha256=LLPRbVfKttq9sIz2z7AA8mXzLtDtc8Agd99y_w7Gt7M,4320
+ds_caselaw_marklogic_api_client-37.4.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+ds_caselaw_marklogic_api_client-37.4.0.dist-info/RECORD,,

{ds_caselaw_marklogic_api_client-37.3.0.dist-info → ds_caselaw_marklogic_api_client-37.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.5.2
+Generator: poetry-core 2.1.1
 Root-Is-Purelib: true
 Tag: py3-none-any