ds-caselaw-marklogic-api-client 32.0.0__py3-none-any.whl → 34.0.0__py3-none-any.whl

caselawclient/Client.py

@@ -572,6 +572,7 @@ class MarklogicApiClient:
         self,
         document_uri: DocumentURIString,
         document_xml: Element,
+        document_type: type[Document],
         annotation: VersionAnnotation,
     ) -> requests.Response:
         """
@@ -579,6 +580,7 @@ class MarklogicApiClient:
 
         :param document_uri: The URI to insert the document at
         :param document_xml: The XML of the document to insert
+        :param document_type: The type class of the document
         :param annotation: Annotations to record alongside this version
 
         :return: The response object from MarkLogic
@@ -592,6 +594,7 @@ class MarklogicApiClient:
 
         vars: query_dicts.InsertDocumentDict = {
             "uri": uri,
+            "type_collection": document_type.type_collection_name,
             "document": xml.decode("utf-8"),
             "annotation": annotation.as_json,
         }
@@ -1068,14 +1071,14 @@ class MarklogicApiClient:
         response = self._send_to_eval(vars, "get_properties_for_search_results.xqy")
         return get_single_string_from_marklogic_response(response)
 
-    def search_and_decode_response(self, search_parameters: SearchParameters) -> str:
+    def search_and_decode_response(self, search_parameters: SearchParameters) -> bytes:
         response = self.advanced_search(search_parameters)
-        return get_single_string_from_marklogic_response(response)
+        return get_single_bytestring_from_marklogic_response(response)
 
     def search_judgments_and_decode_response(
         self,
         search_parameters: SearchParameters,
-    ) -> str:
+    ) -> bytes:
         search_parameters.collections = [DOCUMENT_COLLECTION_URI_JUDGMENT]
         return self.search_and_decode_response(search_parameters)
 

caselawclient/client_helpers/__init__.py

@@ -2,8 +2,17 @@ import json
 from enum import Enum
 from typing import Any, Optional, TypedDict
 
+from lxml import etree
 from typing_extensions import NotRequired
 
+from ..models.documents import Document
+from ..models.judgments import Judgment
+from ..models.press_summaries import PressSummary
+
+
+class CannotDetermineDocumentType(Exception):
+    pass
+
 
 class AnnotationDataDict(TypedDict):
     type: str
@@ -112,3 +121,22 @@ class VersionAnnotation:
 
     def __str__(self) -> str:
         return self.as_json
+
+
+def get_document_type_class(xml: bytes) -> type[Document]:
+    """Attempt to get the type of the document based on the XML root node."""
+
+    node = etree.fromstring(xml)
+
+    # If the document's root element is `judgment` it's a `Judgment`, regardless of the presence of a `name`.
+    if node.tag == "judgment":
+        return Judgment
+
+    # If the document's root element has a `name` attribute with a value of `pressSummary` we can assume it's a `PressSummary`
+    if node.tag == "doc" and node.attrib.get("name") == "pressSummary":
+        return PressSummary
+
+    # Otherwise, we don't know for sure. Fail out.
+    raise CannotDetermineDocumentType(
+        "Unable to accurately determine the type of document based on the root XML node.",
+    )

caselawclient/models/documents/__init__.py

@@ -61,6 +61,8 @@ class Document:
     document_noun_plural = "documents"
     """ The noun for a plural of this document type. """
 
+    type_collection_name: str
+
     attributes_to_validate: list[tuple[str, bool, str]] = [
         (
             "is_failure",

caselawclient/models/judgments.py

@@ -23,6 +23,7 @@ class Judgment(NeutralCitationMixin, Document):
 
     document_noun = "judgment"
     document_noun_plural = "judgments"
+    type_collection_name = "judgment"
 
     def __init__(self, uri: DocumentURIString, *args: Any, **kwargs: Any) -> None:
         super().__init__(self.document_noun, uri, *args, **kwargs)

caselawclient/models/press_summaries.py

@@ -24,6 +24,7 @@ class PressSummary(NeutralCitationMixin, Document):
 
     document_noun = "press summary"
     document_noun_plural = "press summaries"
+    type_collection_name = "press-summary"
 
     def __init__(self, uri: DocumentURIString, *args: Any, **kwargs: Any) -> None:
         super().__init__(self.document_noun, uri, *args, **kwargs)

caselawclient/responses/search_result.py

@@ -3,7 +3,7 @@ import os
 from datetime import datetime
 from enum import Enum
 from functools import cached_property
-from typing import Dict, Optional
+from typing import Any, Dict, Optional
 
 from dateutil import parser as dateparser
 from dateutil.parser import ParserError
@@ -12,6 +12,8 @@ from ds_caselaw_utils.types import CourtCode, JurisdictionCode
 from lxml import etree
 
 from caselawclient.Client import MarklogicApiClient
+from caselawclient.models.identifiers import Identifiers
+from caselawclient.models.identifiers.unpacker import unpack_all_identifiers_from_etree
 from caselawclient.types import DocumentURIString
 from caselawclient.xml_helpers import get_xpath_match_string
 
@@ -169,6 +171,21 @@ class SearchResult:
             self._get_xpath_match_string("@uri").lstrip("/").split(".xml")[0],
         )
 
+    @property
+    def identifiers(self) -> Identifiers:
+        identifiers_etrees = self._get_xpath("//identifiers")
+        if count := len(identifiers_etrees) != 1:
+            logging.warning(f"{count} //identifiers nodes found in search result, expected 1.")
+        identifiers_etree = None if not identifiers_etrees else identifiers_etrees[0]
+        return unpack_all_identifiers_from_etree(identifiers_etree)
+
+    @cached_property
+    def slug(self) -> str:
+        preferred = self.identifiers.preferred()
+        if not preferred:
+            raise RuntimeError("No preferred identifier for search result")
+        return str(preferred.url_slug)
+
     @property
     def neutral_citation(self) -> str:
         """
@@ -278,3 +295,6 @@ class SearchResult:
 
     def _get_xpath_match_string(self, path: str) -> str:
         return get_xpath_match_string(self.node, path, namespaces=self.NAMESPACES)
+
+    def _get_xpath(self, path: str) -> Any:
+        return self.node.xpath(path, namespaces=self.NAMESPACES)

caselawclient/xquery/insert_document.xqy

@@ -4,20 +4,16 @@ import module namespace dls = "http://marklogic.com/xdmp/dls" at "/MarkLogic/dls
 
 declare variable $uri as xs:string external;
 declare variable $document as xs:string external;
+declare variable $type_collection as xs:string external;
 declare variable $annotation as xs:string external;
 
 let $document_xml := xdmp:unquote($document)
 
-let $collections :=
-  if (fn:contains($uri, 'press-summary'))
-  then ("press-summary")
-  else ("judgment")
-
 return dls:document-insert-and-manage(
   $uri,
   fn:true(),
   $document_xml,
   $annotation,
   (),
-  $collections
+  ($type_collection)
 )

caselawclient/xquery/update_locked_judgment.xqy

@@ -8,8 +8,7 @@ declare variable $judgment as xs:string external;
 declare variable $annotation as xs:string external;
 
 let $judgment_xml := xdmp:unquote($judgment)
-(: alternative: check output of let $output := xdmp:validate($judgment_xml) :)
-let $crash_if_invalid := validate strict {$judgment_xml}
+
 return dls:document-update(
    $uri,
    $judgment_xml,

caselawclient/xquery_type_dicts.py

@@ -133,6 +133,7 @@ class GetVersionCreatedDict(MarkLogicAPIDict):
 class InsertDocumentDict(MarkLogicAPIDict):
     annotation: str
     document: str
+    type_collection: str
     uri: MarkLogicDocumentURIString
 
 

{ds_caselaw_marklogic_api_client-32.0.0.dist-info → ds_caselaw_marklogic_api_client-34.0.0.dist-info}/METADATA

@@ -1,13 +1,12 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 32.0.0
+Version: 34.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
 Author: The National Archives
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.10.0,<4.0.0
 Classifier: Programming Language :: Python :: 3
-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)

{ds_caselaw_marklogic_api_client-32.0.0.dist-info → ds_caselaw_marklogic_api_client-34.0.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-caselawclient/Client.py,sha256=Vy8DRniIxWQxc0hMlnhD-e6_O3WM9eVLX7PBaP1fPLg,44756
+caselawclient/Client.py,sha256=v8Zb7vZmoF3COJWtIzoJxTy8d3DLo-mlNH3MhfDL4hs,44931
 caselawclient/__init__.py,sha256=DY-caubLDQWWingSdsBWgovDNXh8KcnkI6kwz08eIFk,612
-caselawclient/client_helpers/__init__.py,sha256=fyDNKCdrTb2N0Ks23YDhmvlXKfLTHnYQCXhnZb-QQbg,3832
+caselawclient/client_helpers/__init__.py,sha256=mmPVwIxnR-KeelNIIMGjsTMzruK6j0X1YR_0H_RHnew,4798
 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=BzxG7rBprmszxS1U1jsyBKaMSSm22RFmFK1nQSOZJlw,6812
 caselawclient/identifier_resolution.py,sha256=BKj7k8ca6b8ZpeoOk2uHYqprOOp9aN5qEB7PWvfJmSw,2439
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
-caselawclient/models/documents/__init__.py,sha256=J5lUpL7XiBYA3mRiDsjc8McUzkhxcdSVS3nlrIUWpAI,19012
+caselawclient/models/documents/__init__.py,sha256=7U5oN2b8JZV9sFSYglBg2K7fKKQgDjTVU5FT22URx7U,19043
 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
@@ -18,9 +18,9 @@ caselawclient/models/identifiers/fclid.py,sha256=FBqarEcnr-1AYmFvjTu1WoPNSBY785h
 caselawclient/models/identifiers/neutral_citation.py,sha256=O3zLw8lnhh5Mb0COjwhhDfTyvcSt48Td5pfT6yaCCJk,1947
 caselawclient/models/identifiers/press_summary_ncn.py,sha256=0SU6WQqj337VOio8pzSHn2AgFTF1_B3bKDnrpTMPTZY,751
 caselawclient/models/identifiers/unpacker.py,sha256=xvp480QESbN36NEc6qeo-orqOBq6WchnLI7thY7A1qs,2156
-caselawclient/models/judgments.py,sha256=H_-t4mCa3LdYu1cLOhQB5n045RdJghWpqS5hgPPDE4U,2170
+caselawclient/models/judgments.py,sha256=r40irgdEID-NeSNLm3OUdUBznMpRSwjD2SJrGlBgP8o,2208
 caselawclient/models/neutral_citation_mixin.py,sha256=jAac3PPuWyPdj9N-n-U_JfwkbgbSIXaqFVQahfu95do,2086
-caselawclient/models/press_summaries.py,sha256=a50KdX_v41G_eI5h6_HuA2hvrhOA2EDvoTYBi5va1e8,2101
+caselawclient/models/press_summaries.py,sha256=PIq9RceZ7n7Z079tESfxhQbfxCmtTc2V2OeFtcn594s,2144
 caselawclient/models/utilities/__init__.py,sha256=u3yIhbTjFQ1JJyAm5wsMEBswWl4t6Z7UMORF5FqC2xQ,1257
 caselawclient/models/utilities/aws.py,sha256=E4nFcNC2xxPUv0Xkfi2XTO3FyIH6jaAy9pgsvR48Eg8,8759
 caselawclient/models/utilities/dates.py,sha256=WwORxVjUHM1ZFcBF6Qtwo3Cj0sATsnSECkUZ6ls1N1Q,492
@@ -28,7 +28,7 @@ caselawclient/models/utilities/move.py,sha256=MXdUqkSiyqRb8YKs_66B6ICWn8EWM6DiJV
 caselawclient/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 caselawclient/responses/__init__.py,sha256=2-5NJn_PXPTje_W4dHeHYaNRN6vXK4UcB9eLLNUAKa4,67
 caselawclient/responses/search_response.py,sha256=Z76Zj4VvM-EV_vdiehv2-Jfkr9HZD3SvCTlRrUB_cyE,1951
-caselawclient/responses/search_result.py,sha256=hotJHJ9wQusjb4PjZm1DDZv2HEsXWTtZU5TOTj2T0rw,8205
+caselawclient/responses/search_result.py,sha256=l6wSruVJDLCT1JquDrUVk9TZ0Ic6w4Wlayhu8vL_0sg,9123
 caselawclient/responses/xsl/search_match.xsl,sha256=4Sv--MrwBd7J48E9aI7jlFSXGlNi4dBqgzJ3bdMJ_ZU,1018
 caselawclient/search_parameters.py,sha256=nR-UC1aWZbdXzXBrVDaHECU4Ro8Zi4JZATtgrpAVsKY,3342
 caselawclient/types.py,sha256=0PsEsQzJOInpuwZ-Ydw0UpGns6jbHzlJhc-Ms28sqCU,2064
@@ -58,7 +58,7 @@ caselawclient/xquery/get_recently_enriched.xqy,sha256=qSA9EYlKaAyYwewBRj494aC_Jn
 caselawclient/xquery/get_recently_parsed.xqy,sha256=k8NP72O11FyDZ3MeKAJWlcrzPsynhPTddYIeS0pRaII,594
 caselawclient/xquery/get_version_annotation.xqy,sha256=pFDMGA9SxI59iUPaoAeUsq23kUp4Op7cUg-PFNFqxcI,262
 caselawclient/xquery/get_version_created.xqy,sha256=bRweaXFtwMBNzL16SlOdiOxHkbqNUwpwDHLxpZYVCh0,250
-caselawclient/xquery/insert_document.xqy,sha256=iP2xTaLGa-u6X9KfS1yJ6yPCKQUWQFYdEW1S4YcMY7w,531
+caselawclient/xquery/insert_document.xqy,sha256=aRauDny7OwqWr19L4BGLky48OBqiHtsV4Qf6xd2zBUc,486
 caselawclient/xquery/list_judgment_versions.xqy,sha256=WShga8igeD21hSLfVSvCOiDMPDhNH6KGf1OW6G0SAkY,190
 caselawclient/xquery/resolve_from_identifier_slug.xqy,sha256=jMaOugdG1XVQIk9AR5NOth8D2RS8VEUJuBwjO9j4MFM,485
 caselawclient/xquery/resolve_from_identifier_value.xqy,sha256=7uP3DnRi67qSp0aUhW6Cv_GA8BQGw6GuvtAghjrT7Z4,493
@@ -72,15 +72,15 @@ caselawclient/xquery/set_metadata_work_expression_date.xqy,sha256=eN4VvRA5FqP3aK
 caselawclient/xquery/set_property.xqy,sha256=wUDCMLrUUgTMqn_-_T48DXsdDLtFncrVjidVuCwtpS4,343
 caselawclient/xquery/set_property_as_node.xqy,sha256=85ywMo5VPGXBnHepIajDOPYEy_ZmeU_9glgDcJ_CwEI,362
 caselawclient/xquery/update_document.xqy,sha256=-kbv3Ig2nuBviCyn0R_H6GPE1kpDP4UOhWsYk5oBgtU,420
-caselawclient/xquery/update_locked_judgment.xqy,sha256=wFDEtKh7MxvPmEHrzOHTJIRlY01ATneESl-n_lIQ7cU,556
+caselawclient/xquery/update_locked_judgment.xqy,sha256=1njfQ4dPLhnIM_j4VupXBEHJ47ZBX85VS8Py46rYh8E,421
 caselawclient/xquery/user_has_privilege.xqy,sha256=TfqPjhdpXt-4Fo7E2kEYRhfqQm6uES-IuLbAlCxylbg,371
 caselawclient/xquery/user_has_role.xqy,sha256=52YuFZnXqaDDJs-j_UanpqcLNEiw_m9xb07HvZVUoXY,246
 caselawclient/xquery/validate_all_documents.xqy,sha256=z_0YEXmRcZ-FaJM0ouKiTjdI4tLKQ4FTssRihR07qFk,156
 caselawclient/xquery/validate_document.xqy,sha256=PgaDcnqCRJPIVqfmWsNlXmCLNKd21qkJrvY1RtNP7eA,140
 caselawclient/xquery/xslt.xqy,sha256=w57wNijH3dkwHkpKeAxqjlghVflQwo8cq6jS_sm-erM,199
 caselawclient/xquery/xslt_transform.xqy,sha256=cccaFiGkCcvSfDv007UriZ3I4ak2nTLP1trRZdbOoS8,2462
-caselawclient/xquery_type_dicts.py,sha256=mkpvJcqgKhDi7xkW9RLGIoXIzrpcmLSkg_B1zP8CWWk,6358
-ds_caselaw_marklogic_api_client-32.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-32.0.0.dist-info/METADATA,sha256=HeIQpEv7f-NciSntkOJER1_Br9gpaaevWbHDnr9fG7k,4251
-ds_caselaw_marklogic_api_client-32.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-32.0.0.dist-info/RECORD,,
+caselawclient/xquery_type_dicts.py,sha256=21V6PJ0a8lPZuwzQCWeHNo914hdCbCJtOvnqdHcTpKk,6383
+ds_caselaw_marklogic_api_client-34.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-34.0.0.dist-info/METADATA,sha256=1Y9daSrmdkheziHwxatUrnUuGlx4whYIcdURLgxibKU,4206
+ds_caselaw_marklogic_api_client-34.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-34.0.0.dist-info/RECORD,,