ds-caselaw-marklogic-api-client 30.0.0__py3-none-any.whl → 31.0.0__py3-none-any.whl

caselawclient/factories.py

@@ -1,10 +1,12 @@
 import datetime
+import json
 from typing import Any, Optional
 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
 from caselawclient.models.documents.body import DocumentBody
 from caselawclient.models.judgments import Judgment
@@ -12,7 +14,16 @@ from caselawclient.models.press_summaries import PressSummary
 from caselawclient.responses.search_result import SearchResult, SearchResultMetadata
 from caselawclient.types import DocumentURIString
 
-DEFAULT_DOCUMENT_BODY_XML = "<akomantoso>This is some XML of a judgment.</akomantoso>"
+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/>
+                <judgmentBody>
+                <decision>
+                <p>This is a document.</p>
+                </decision>
+                </judgmentBody>
+            </judgment>
+            </akomaNtoso>"""
 
 
 class DocumentBodyFactory:
@@ -56,7 +67,6 @@ class DocumentFactory:
     def build(
         cls,
         uri: DocumentURIString = DocumentURIString("test/2023/123"),
-        html: str = "<p>This is a judgment.</p>",
         api_client: Optional[MarklogicApiClient] = None,
         **kwargs: Any,
     ) -> target_class:
@@ -66,7 +76,6 @@ class DocumentFactory:
             api_client.get_property_as_node.return_value = None
 
         document = cls.target_class(uri, api_client=api_client)
-        document.content_as_html = Mock(return_value=html)  # type: ignore[method-assign]
         document.body = kwargs.pop("body") if "body" in kwargs else DocumentBodyFactory.build()
 
         for param_name, default_value in cls.PARAMS_MAP.items():
@@ -133,3 +142,33 @@ class SearchResultFactory(SimpleFactory):
         "metadata": SearchResultMetadataFactory.build(),
         "is_failure": False,
     }
+
+
+class IdentifierResolutionFactory:
+    @classmethod
+    def build(
+        self,
+        resolution_uuid: Optional[str] = None,
+        document_uri: Optional[str] = None,
+        identifier_slug: Optional[str] = None,
+        published: Optional[bool] = True,
+        namespace: Optional[str] = None,
+        value: Optional[str] = None,
+    ) -> IdentifierResolution:
+        raw_resolution = {
+            "documents.compiled_url_slugs.identifier_uuid": resolution_uuid or "24b9a384-8bcf-4f20-996a-5c318f8dc657",
+            "documents.compiled_url_slugs.document_uri": document_uri or "/ewca/civ/2003/547.xml",
+            "documents.compiled_url_slugs.identifier_slug": identifier_slug or "ewca/civ/2003/54721",
+            "documents.compiled_url_slugs.document_published": "true" if published else "false",
+            "documents.compiled_url_slugs.identifier_namespace": namespace or "ukncn",
+            "documents.compiled_url_slugs.identifier_value": value or "[2003] EWCA 54721 (Civ)",
+        }
+        return IdentifierResolution.from_marklogic_output(json.dumps(raw_resolution))
+
+
+class IdentifierResolutionsFactory:
+    @classmethod
+    def build(self, resolutions: Optional[list[IdentifierResolution]] = None) -> IdentifierResolutions:
+        if resolutions is None:
+            resolutions = [IdentifierResolutionFactory.build()]
+        return IdentifierResolutions(resolutions)

caselawclient/models/documents/__init__.py

@@ -6,15 +6,14 @@ from typing import TYPE_CHECKING, Any, Optional
 from ds_caselaw_utils import courts
 from ds_caselaw_utils.courts import CourtNotFoundException
 from ds_caselaw_utils.types import NeutralCitationString
-from lxml import html as html_parser
 from requests_toolbelt.multipart import decoder
 
 from caselawclient.errors import (
     DocumentNotFoundError,
-    GatewayTimeoutError,
     NotSupportedOnVersion,
     OnlySupportedOnVersion,
 )
+from caselawclient.identifier_resolution import IdentifierResolutions
 from caselawclient.models.identifiers import Identifier
 from caselawclient.models.identifiers.fclid import FindCaseLawIdentifier, FindCaseLawIdentifierSchema
 from caselawclient.models.identifiers.unpacker import unpack_all_identifiers_from_etree
@@ -252,39 +251,6 @@ class Document:
         "Is this document a potentially historic version of a document, or is it the main document itself?"
         return extract_version(self.uri) != 0
 
-    def content_as_html(
-        self,
-        version_uri: Optional[DocumentURIString] = None,
-        query: Optional[str] = None,
-    ) -> str:
-        try:
-            results = self.api_client.eval_xslt(
-                self.uri,
-                version_uri,
-                show_unpublished=True,
-                query=query,
-            )
-            multipart_data = decoder.MultipartDecoder.from_response(results)
-            return str(multipart_data.parts[0].text)
-        except GatewayTimeoutError as e:
-            if query is not None:
-                warnings.warn(
-                    (
-                        "Gateway timeout when getting content with query"
-                        "highlighting for document %s, version %s, and query"
-                        '"%s", falling back to unhighlighted content...'
-                    )
-                    % (self.uri, version_uri, query),
-                    GatewayTimeoutGettingHTMLWithQuery,
-                )
-                return self.content_as_html(version_uri)
-            raise e
-
-    def number_of_mentions(self, query: str) -> int:
-        html = self.content_as_html(query=query)
-        tree = html_parser.fromstring(html.encode("utf-8"))
-        return len(tree.findall(".//mark"))
-
     @cached_property
     def is_failure(self) -> bool:
         """
@@ -529,3 +495,21 @@ class Document:
             return getattr(self.body, name)
         except Exception:
             raise AttributeError(f"Neither 'Document' nor 'DocumentBody' objects have an attribute '{name}'")
+
+    def linked_document_resolutions(self, namespaces: list[str], only_published: bool = True) -> IdentifierResolutions:
+        """Get documents which share the same neutral citation as this document."""
+        if not hasattr(self, "neutral_citation") or not self.neutral_citation:
+            return IdentifierResolutions([])
+
+        resolutions = self.api_client.resolve_from_identifier_value(self.neutral_citation)
+        if only_published:
+            resolutions = resolutions.published()
+
+        # only documents which aren't this one and have a right namespace
+        return IdentifierResolutions(
+            [
+                resolution
+                for resolution in resolutions
+                if resolution.document_uri != self.uri.as_marklogic() and resolution.identifier_namespace in namespaces
+            ]
+        )

caselawclient/models/documents/body.py

@@ -3,7 +3,6 @@ import os
 import warnings
 from functools import cache, cached_property
 from typing import Optional
-from xml.etree.ElementTree import Element
 
 import pytz
 from ds_caselaw_utils.types import CourtCode
@@ -128,13 +127,14 @@ class DocumentBody:
     def has_content(self) -> bool:
         """If we do not have a word document, the XML will not contain
         the contents of the judgment, but will contain a preamble."""
-
-        def stripped_tag_text(tag: Element) -> str:
-            return "".join(tag.itertext()).strip()
-
-        header = self._xml.xml_as_tree.xpath("//akn:header", namespaces=DEFAULT_NAMESPACES)[0]
-        content = self._xml.xml_as_tree.xpath("//akn:judgmentBody", namespaces=DEFAULT_NAMESPACES)[0]
-        return not (stripped_tag_text(header) == "" and stripped_tag_text(content) == "")
+        trailing_tags = self._xml.xml_as_tree.xpath("//*[preceding::akn:meta]", namespaces=DEFAULT_NAMESPACES)
+        for tag in trailing_tags:
+            if tag.tail and tag.tail.strip():
+                return True
+            if tag.text and tag.text.strip():
+                return True
+
+        return False
 
     @cache
     def content_as_html(self, image_base_url: Optional[str] = None) -> Optional[str]:

caselawclient/models/judgments.py

@@ -5,6 +5,7 @@ from typing import TYPE_CHECKING, Any, Optional
 from ds_caselaw_utils.types import NeutralCitationString
 
 from caselawclient.errors import DocumentNotFoundError
+from caselawclient.identifier_resolution import IdentifierResolutions
 from caselawclient.models.neutral_citation_mixin import NeutralCitationMixin
 
 if TYPE_CHECKING:
@@ -51,3 +52,7 @@ class Judgment(NeutralCitationMixin, Document):
             return PressSummary(uri, self.api_client)
         except DocumentNotFoundError:
             return None
+
+    @cached_property
+    def linked_press_summaries(self, only_published: bool = True) -> "IdentifierResolutions":
+        return self.linked_document_resolutions(["uksummaryofncn"], only_published)

caselawclient/models/press_summaries.py

@@ -7,6 +7,7 @@ from typing import TYPE_CHECKING, Any, Optional
 from ds_caselaw_utils.types import NeutralCitationString
 
 from caselawclient.errors import DocumentNotFoundError
+from caselawclient.identifier_resolution import IdentifierResolutions
 from caselawclient.models.neutral_citation_mixin import NeutralCitationMixin
 from caselawclient.types import DocumentURIString
 
@@ -51,3 +52,6 @@ class PressSummary(NeutralCitationMixin, Document):
             return Judgment(uri, self.api_client)
         except DocumentNotFoundError:
             return None
+
+    def linked_judgments(self, only_published: bool = True) -> "IdentifierResolutions":
+        return self.linked_document_resolutions(["ukncn"], only_published)

caselawclient/types.py

@@ -2,6 +2,10 @@ class InvalidDocumentURIException(Exception):
     """The document URI is not valid."""
 
 
+class MarkLogicDocumentURIString(str):
+    pass
+
+
 class DocumentURIString(str):
     """
     This class checks that the string is actually a valid Document URI on creation. It does _not_ manipulate the string.
@@ -22,3 +26,6 @@ class DocumentURIString(str):
 
         # If everything is good, return as usual
         return str.__new__(cls, content)
+
+    def as_marklogic(self) -> MarkLogicDocumentURIString:
+        return MarkLogicDocumentURIString(f"/{self}.xml")

caselawclient/xquery_type_dicts.py

@@ -8,8 +8,8 @@ checks. They are used to enforce appropriately typed variables being passed in t
 
 from typing import Any, NewType, Optional, TypedDict
 from caselawclient.types import DocumentURIString
+from caselawclient.types import MarkLogicDocumentURIString as MarkLogicDocumentURIString
 
-MarkLogicDocumentURIString = NewType("MarkLogicDocumentURIString", str)
 MarkLogicDocumentVersionURIString = NewType("MarkLogicDocumentVersionURIString", MarkLogicDocumentURIString)
 
 MarkLogicPrivilegeURIString = NewType("MarkLogicPrivilegeURIString", str)

{ds_caselaw_marklogic_api_client-30.0.0.dist-info → ds_caselaw_marklogic_api_client-31.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 30.0.0
+Version: 31.0.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
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: boto3 (>=1.26.112,<2.0.0)
-Requires-Dist: certifi (>=2024.12.14,<2024.13.0)
+Requires-Dist: certifi (>=2025.1.31,<2025.2.0)
 Requires-Dist: charset-normalizer (>=3.0.0,<4.0.0)
 Requires-Dist: django-environ (>=0.12.0)
 Requires-Dist: ds-caselaw-utils (>=2.0.0,<3.0.0)

{ds_caselaw_marklogic_api_client-30.0.0.dist-info → ds_caselaw_marklogic_api_client-31.0.0.dist-info}/RECORD

@@ -4,11 +4,11 @@ caselawclient/client_helpers/__init__.py,sha256=fyDNKCdrTb2N0Ks23YDhmvlXKfLTHnYQ
 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=yJmecrJNmzvI0_gJZFrpiONI6qt2jTFId7cXCA68-iY,4503
+caselawclient/factories.py,sha256=_ey9KTu393H9q1hWAjr5LIp4oYzDre55QpVMkmxNSb0,6223
 caselawclient/identifier_resolution.py,sha256=pqapUH8oiZF3ie-s_CI0hvZwH__JVcjJ4VxkpBxswmA,2354
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
-caselawclient/models/documents/__init__.py,sha256=SKYgOOpO4i-lhTWSB16eI6052GEh5ZlqvK3Dggd3sOg,18644
-caselawclient/models/documents/body.py,sha256=2rhNzCsXU13n4nw8m_GU2f_FyYGE8wUYOecBqFmZFHo,5999
+caselawclient/models/documents/__init__.py,sha256=LNo9FVKkF9rGzmJ4swEKrKXvimpvenE3OU_Z3Rt6Jic,18230
+caselawclient/models/documents/body.py,sha256=mhPOV1cOF3RJr69UzNPlo1KrzePaj7KDPYi1exP06L0,5880
 caselawclient/models/documents/exceptions.py,sha256=Mz1P8uNqf5w6uLnRwJt6xK7efsVqtd5VA-WXUUH7QLk,285
 caselawclient/models/documents/statuses.py,sha256=Cp4dTQmJOtsU41EJcxy5dV1841pGD2PNWH0VrkDEv4Q,579
 caselawclient/models/documents/transforms/html.xsl,sha256=oSSO-IBX4qLiSWexQYmWJfGNevF09aCBx4D1NYqXxpo,38322
@@ -18,9 +18,9 @@ caselawclient/models/identifiers/fclid.py,sha256=pTO586ra0sr4DbjHSxuI8UlxfNXLm9n
 caselawclient/models/identifiers/neutral_citation.py,sha256=3Jw1_-NmGfGmrWGFSzLdTHBYHIHq4tPkF8U7Jba-jGo,1848
 caselawclient/models/identifiers/press_summary_ncn.py,sha256=r55-qgi9LDnGxY8vTKijzotGknA6mNLpu55QQTV8Lxo,652
 caselawclient/models/identifiers/unpacker.py,sha256=xvp480QESbN36NEc6qeo-orqOBq6WchnLI7thY7A1qs,2156
-caselawclient/models/judgments.py,sha256=hYPmzWcxS_Pi87vWEezLI5geQqm1tRh_HtGqHpm49Zg,1900
+caselawclient/models/judgments.py,sha256=H_-t4mCa3LdYu1cLOhQB5n045RdJghWpqS5hgPPDE4U,2170
 caselawclient/models/neutral_citation_mixin.py,sha256=jAac3PPuWyPdj9N-n-U_JfwkbgbSIXaqFVQahfu95do,2086
-caselawclient/models/press_summaries.py,sha256=f0Qyv5_7K8tWv-HVGv2QHlS4WMh5Dh4ZhbYJOJYD9lw,1867
+caselawclient/models/press_summaries.py,sha256=a50KdX_v41G_eI5h6_HuA2hvrhOA2EDvoTYBi5va1e8,2101
 caselawclient/models/utilities/__init__.py,sha256=u3yIhbTjFQ1JJyAm5wsMEBswWl4t6Z7UMORF5FqC2xQ,1257
 caselawclient/models/utilities/aws.py,sha256=E4nFcNC2xxPUv0Xkfi2XTO3FyIH6jaAy9pgsvR48Eg8,8759
 caselawclient/models/utilities/dates.py,sha256=WwORxVjUHM1ZFcBF6Qtwo3Cj0sATsnSECkUZ6ls1N1Q,492
@@ -31,7 +31,7 @@ caselawclient/responses/search_response.py,sha256=Z76Zj4VvM-EV_vdiehv2-Jfkr9HZD3
 caselawclient/responses/search_result.py,sha256=hotJHJ9wQusjb4PjZm1DDZv2HEsXWTtZU5TOTj2T0rw,8205
 caselawclient/responses/xsl/search_match.xsl,sha256=4Sv--MrwBd7J48E9aI7jlFSXGlNi4dBqgzJ3bdMJ_ZU,1018
 caselawclient/search_parameters.py,sha256=nR-UC1aWZbdXzXBrVDaHECU4Ro8Zi4JZATtgrpAVsKY,3342
-caselawclient/types.py,sha256=vVOK78bFsnHXdOGx1899biR2QiCSVNBKoDbziJPCb68,920
+caselawclient/types.py,sha256=gedGlrO1ZA_wYdCuquwi6seFr5OqTPxi1O0D_lKdEps,1087
 caselawclient/xml_helpers.py,sha256=FEtE8gxaEZmcgua-Xu8awPmiOm9K58OSabEYVGpiVEY,493
 caselawclient/xquery/break_judgment_checkout.xqy,sha256=rISzoBKxQKrP5ZRdCSoRqOXW8T_NDBSZRFjOXo_H3ns,220
 caselawclient/xquery/checkin_judgment.xqy,sha256=QeGqO3kL-q0UrjopCVU0lCbkwbyoc5SuNLYFAIbbyMg,197
@@ -79,8 +79,8 @@ caselawclient/xquery/validate_all_documents.xqy,sha256=z_0YEXmRcZ-FaJM0ouKiTjdI4
 caselawclient/xquery/validate_document.xqy,sha256=PgaDcnqCRJPIVqfmWsNlXmCLNKd21qkJrvY1RtNP7eA,140
 caselawclient/xquery/xslt.xqy,sha256=w57wNijH3dkwHkpKeAxqjlghVflQwo8cq6jS_sm-erM,199
 caselawclient/xquery/xslt_transform.xqy,sha256=smyFFxqmtkuOzBd2l7uw6K2oAsYctudrP8omdv_XNAM,2463
-caselawclient/xquery_type_dicts.py,sha256=qZ_bUiceoHw8c02FAFWe75zdpmK8GYUJzi2q-bc1NXA,6266
-ds_caselaw_marklogic_api_client-30.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-30.0.0.dist-info/METADATA,sha256=6DnjxKcXIc01ysu22YKZBC5mek5oQtmxiRnTEljxzN0,4264
-ds_caselaw_marklogic_api_client-30.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-30.0.0.dist-info/RECORD,,
+caselawclient/xquery_type_dicts.py,sha256=IElFK9aFZboNgKytRjK2EQPIJJcXXw9NVfRTWKx2zJo,6283
+ds_caselaw_marklogic_api_client-31.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-31.0.0.dist-info/METADATA,sha256=QR0bbqSK9ZROZon7RZII--oK8fBuKoMRk94JTOE57Zc,4262
+ds_caselaw_marklogic_api_client-31.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-31.0.0.dist-info/RECORD,,