Merge pull request #712 from nationalarchives/fix-types

Fix typing issues

.pre-commit-config.yaml

@@ -34,7 +34,7 @@ repos:
           - boto3-stubs[s3,sns]
           - types-python-dateutil
           - types-pytz
-          - ds-caselaw-utils
+          - ds-caselaw-utils~=2.0.0
         args:
           - --strict
         files: ^src/
@@ -48,7 +48,7 @@ repos:
           - boto3-stubs[s3,sns]
           - types-python-dateutil
           - types-pytz
-          - ds-caselaw-utils
+          - ds-caselaw-utils~=2.0.0
         files: ^tests/
         id: mypy
         name: mypy-tests

pyproject.toml

@@ -20,7 +20,7 @@ requests = "^2.28.2"
 requests-toolbelt = ">=0.10.1,<1.1.0"
 memoization = "^0.4.0"
 lxml = "^5.0.0"
-ds-caselaw-utils = "^1.4.1"
+ds-caselaw-utils = "^2.0.0"
 boto3 = "^1.26.112"
 typing-extensions = "^4.7.1"
 mypy-boto3-s3 = "^1.26.104"

src/caselawclient/Client.py

@@ -12,6 +12,7 @@
 
 import environ
 import requests
+from ds_caselaw_utils.types import NeutralCitationString
 from requests.auth import HTTPBasicAuth
 from requests.structures import CaseInsensitiveDict
 from requests_toolbelt.multipart import decoder
@@ -1035,7 +1036,7 @@ def search_judgments_and_decode_response(
         search_parameters.collections = [DOCUMENT_COLLECTION_URI_JUDGMENT]
         return self.search_and_decode_response(search_parameters)
 
-    def update_document_uri(self, old_uri: DocumentURIString, new_citation: str) -> DocumentURIString:
+    def update_document_uri(self, old_uri: DocumentURIString, new_citation: NeutralCitationString) -> DocumentURIString:
         """
         Move the document at old_uri to the correct location based on the neutral citation
         The new neutral citation *must* not already exist (that is handled elsewhere)

src/caselawclient/models/documents/__init__.py

@@ -5,6 +5,7 @@
 
 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
 
@@ -441,7 +442,7 @@ def delete(self) -> None:
         else:
             raise DocumentNotSafeForDeletion
 
-    def move(self, new_citation: str) -> None:
+    def move(self, new_citation: NeutralCitationString) -> None:
         self.api_client.update_document_uri(self.uri, new_citation)
 
     def force_reparse(self) -> None:

src/caselawclient/models/documents/body.py

@@ -4,7 +4,7 @@
 from typing import Optional
 
 import pytz
-from ds_caselaw_utils.courts import CourtCode
+from ds_caselaw_utils.types import CourtCode
 
 from caselawclient.models.utilities.dates import parse_string_date_as_utc
 

src/caselawclient/models/judgments.py

@@ -2,6 +2,8 @@
 from functools import cached_property
 from typing import TYPE_CHECKING, Any, Optional
 
+from ds_caselaw_utils.types import NeutralCitationString
+
 from caselawclient.errors import DocumentNotFoundError
 from caselawclient.models.neutral_citation_mixin import NeutralCitationMixin
 
@@ -23,13 +25,15 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         super(Judgment, self).__init__(self.document_noun, *args, **kwargs)
 
     @cached_property
-    def neutral_citation(self) -> str:
-        return self.body.get_xpath_match_string(
-            "/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:cite/text()",
-            {
-                "uk": "https://caselaw.nationalarchives.gov.uk/akn",
-                "akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0",
-            },
+    def neutral_citation(self) -> NeutralCitationString:
+        return NeutralCitationString(
+            self.body.get_xpath_match_string(
+                "/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:cite/text()",
+                {
+                    "uk": "https://caselaw.nationalarchives.gov.uk/akn",
+                    "akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0",
+                },
+            )
         )
 
     @property

src/caselawclient/models/neutral_citation_mixin.py

@@ -1,10 +1,12 @@
+from abc import ABC, abstractmethod
 from functools import cached_property
 from typing import Any
 
 from ds_caselaw_utils import neutral_url
+from ds_caselaw_utils.types import NeutralCitationString
 
 
-class NeutralCitationMixin:
+class NeutralCitationMixin(ABC):
     """
     A mixin class that provides functionality related to neutral citation.
 
@@ -35,8 +37,8 @@ def __init__(self, document_noun: str, *args: Any, **kwargs: Any) -> None:
         super(NeutralCitationMixin, self).__init__(*args, **kwargs)
 
     @cached_property
-    def neutral_citation(self) -> str:
-        return ""
+    @abstractmethod
+    def neutral_citation(self) -> NeutralCitationString: ...
 
     @cached_property
     def has_ncn(self) -> bool:

src/caselawclient/models/press_summaries.py

@@ -4,6 +4,8 @@
 from functools import cached_property
 from typing import TYPE_CHECKING, Any, Optional
 
+from ds_caselaw_utils.types import NeutralCitationString
+
 from caselawclient.errors import DocumentNotFoundError
 from caselawclient.models.neutral_citation_mixin import NeutralCitationMixin
 
@@ -25,12 +27,14 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         super(PressSummary, self).__init__(self.document_noun, *args, **kwargs)
 
     @cached_property
-    def neutral_citation(self) -> str:
-        return self.body.get_xpath_match_string(
-            "/akn:akomaNtoso/akn:doc/akn:preface/akn:p/akn:neutralCitation/text()",
-            {
-                "akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0",
-            },
+    def neutral_citation(self) -> NeutralCitationString:
+        return NeutralCitationString(
+            self.body.get_xpath_match_string(
+                "/akn:akomaNtoso/akn:doc/akn:preface/akn:p/akn:neutralCitation/text()",
+                {
+                    "akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0",
+                },
+            )
         )
 
     @property

src/caselawclient/models/utilities/move.py

@@ -1,6 +1,7 @@
 from typing import TYPE_CHECKING, Any, Optional
 
 import ds_caselaw_utils as caselawutils
+from ds_caselaw_utils.types import NeutralCitationString
 
 from caselawclient.errors import MarklogicAPIError
 from caselawclient.models.documents import DocumentURIString
@@ -19,7 +20,7 @@ class MoveJudgmentError(Exception):
 
 
 def update_document_uri(
-    source_uri: DocumentURIString, target_citation: str, api_client: "MarklogicApiClient"
+    source_uri: DocumentURIString, target_citation: NeutralCitationString, api_client: "MarklogicApiClient"
 ) -> DocumentURIString:
     """
     Move the document at source_uri to the correct location based on the neutral citation
@@ -30,7 +31,7 @@ def update_document_uri(
     :param api_client: An instance of MarklogicApiClient used to make the search request
     :return: The URL associated with the `target_citation`
     """
-    new_ncn_based_uri = caselawutils.neutral_url(target_citation.strip())
+    new_ncn_based_uri = caselawutils.neutral_url(target_citation)
     new_uri: Optional[DocumentURIString] = DocumentURIString(new_ncn_based_uri) if new_ncn_based_uri else None
     if new_uri is None:
         raise NeutralCitationToUriError(
@@ -63,7 +64,7 @@ def update_document_uri(
     return new_uri
 
 
-def set_metadata(old_uri: str, new_uri: str, api_client: Any) -> None:
+def set_metadata(old_uri: DocumentURIString, new_uri: DocumentURIString, api_client: Any) -> None:
     source_organisation = api_client.get_property(old_uri, "source-organisation")
     source_name = api_client.get_property(old_uri, "source-name")
     source_email = api_client.get_property(old_uri, "source-email")

src/caselawclient/responses/search_result.py

@@ -7,7 +7,8 @@
 
 from dateutil import parser as dateparser
 from dateutil.parser import ParserError
-from ds_caselaw_utils.courts import Court, CourtCode, CourtNotFoundException, JurisdictionCode, courts
+from ds_caselaw_utils.courts import Court, CourtNotFoundException, courts
+from ds_caselaw_utils.types import CourtCode, JurisdictionCode
 from lxml import etree
 
 from caselawclient.Client import MarklogicApiClient