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

caselawclient/client_helpers/__init__.py

@@ -5,6 +5,8 @@ from typing import Any, Optional, TypedDict
 from lxml import etree
 from typing_extensions import NotRequired
 
+from caselawclient.xml_helpers import DEFAULT_NAMESPACES
+
 from ..models.documents import Document
 from ..models.judgments import Judgment
 from ..models.press_summaries import PressSummary
@@ -124,19 +126,23 @@ class VersionAnnotation:
 
 
 def get_document_type_class(xml: bytes) -> type[Document]:
-    """Attempt to get the type of the document based on the XML root node."""
+    """Attempt to get the type of the document based on the top-level structure of the XML document."""
 
     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":
+    # If the main node is `<judgment>`, it's a judgment
+    if node.xpath("/akn:akomaNtoso/akn:judgment", namespaces=DEFAULT_NAMESPACES):
         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":
+    # If the main node is `<doc name='pressSummary'>`, it's a press summary
+    if node.xpath("/akn:akomaNtoso/akn:doc[@name='pressSummary']", namespaces=DEFAULT_NAMESPACES):
         return PressSummary
 
+    # If the document is a parser error with a root element of `error`, it's not of a special type.
+    if node.xpath("/error", namespaces=DEFAULT_NAMESPACES):
+        return Document
+
     # 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.",
+        "Unable to determine the Document type by its XML",
     )

caselawclient/xml_helpers.py

@@ -2,6 +2,11 @@ from typing import Dict, Optional
 
 from lxml import etree
 
+DEFAULT_NAMESPACES = {
+    "uk": "https://caselaw.nationalarchives.gov.uk/akn",
+    "akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0",
+}
+
 
 def get_xpath_match_string(
     node: etree._Element,

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 34.0.0
+Version: 34.0.1
 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

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

@@ -1,6 +1,6 @@
 caselawclient/Client.py,sha256=v8Zb7vZmoF3COJWtIzoJxTy8d3DLo-mlNH3MhfDL4hs,44931
 caselawclient/__init__.py,sha256=DY-caubLDQWWingSdsBWgovDNXh8KcnkI6kwz08eIFk,612
-caselawclient/client_helpers/__init__.py,sha256=mmPVwIxnR-KeelNIIMGjsTMzruK6j0X1YR_0H_RHnew,4798
+caselawclient/client_helpers/__init__.py,sha256=Qo1bvNz6wq4-d9szsALYWTGrlg5mRyNccUJHOK_dsIM,5009
 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
@@ -32,7 +32,7 @@ caselawclient/responses/search_result.py,sha256=l6wSruVJDLCT1JquDrUVk9TZ0Ic6w4Wl
 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
-caselawclient/xml_helpers.py,sha256=FEtE8gxaEZmcgua-Xu8awPmiOm9K58OSabEYVGpiVEY,493
+caselawclient/xml_helpers.py,sha256=xCboRhhzezqh-VyoKBQwal5lwxv96vTMJyVFWJNN-ok,639
 caselawclient/xquery/break_judgment_checkout.xqy,sha256=rISzoBKxQKrP5ZRdCSoRqOXW8T_NDBSZRFjOXo_H3ns,220
 caselawclient/xquery/checkin_judgment.xqy,sha256=QeGqO3kL-q0UrjopCVU0lCbkwbyoc5SuNLYFAIbbyMg,197
 caselawclient/xquery/checkout_judgment.xqy,sha256=aRwVo4KXoEKXfXRZ6IrVfvh0pXK-7pFxVIgEyzE5DRY,385
@@ -80,7 +80,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=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,,
+ds_caselaw_marklogic_api_client-34.0.1.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-34.0.1.dist-info/METADATA,sha256=HA36beJz4OQedMNQ_c58IGx1RZX9GjM_h5JkOQm66Is,4206
+ds_caselaw_marklogic_api_client-34.0.1.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-34.0.1.dist-info/RECORD,,