destiny_sdk 0.2.2__tar.gz → 0.2.3__tar.gz

{destiny_sdk-0.2.2 → destiny_sdk-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: destiny_sdk
-Version: 0.2.2
+Version: 0.2.3
 Summary: A software development kit (sdk) to support interaction with the DESTINY repository
 Author-email: Adam Hamilton <adam@futureevidence.org>, Andrew Harvey <andrew@futureevidence.org>, Daniel Breves <daniel@futureevidence.org>, Jack Walmisley <jack@futureevidence.org>
 License-Expression: Apache-2.0

{destiny_sdk-0.2.2 → destiny_sdk-0.2.3}/pyproject.toml

@@ -33,7 +33,7 @@ license = "Apache-2.0"
 name = "destiny_sdk"
 readme = "README.md"
 requires-python = "~=3.12"
-version = "0.2.2"
+version = "0.2.3"
 
 [tool.pytest.ini_options]
 addopts = ["--color=yes", "--import-mode=importlib", "--verbose"]

{destiny_sdk-0.2.2 → destiny_sdk-0.2.3}/src/destiny_sdk/core.py

@@ -4,6 +4,18 @@ from typing import Self
 
 from pydantic import BaseModel
 
+# These are non-standard newline characters that are not escaped by model_dump_json().
+# We want jsonl files to have empirical new lines so they can be streamed line by line.
+# Hence we replace each occurrence with standard new lines.
+_ESCAPED_NEW_LINE = "\\n"
+_UNSUPPORTED_NEWLINE_TRANSLATION = str.maketrans(
+    {
+        "\u0085": _ESCAPED_NEW_LINE,
+        "\u2028": _ESCAPED_NEW_LINE,
+        "\u2029": _ESCAPED_NEW_LINE,
+    }
+)
+
 
 class _JsonlFileInputMixIn(BaseModel):
     """
@@ -20,7 +32,9 @@ class _JsonlFileInputMixIn(BaseModel):
         :return: The JSONL string representation of the model.
         :rtype: str
         """
-        return self.model_dump_json(exclude_none=True)
+        return self.model_dump_json(exclude_none=True).translate(
+            _UNSUPPORTED_NEWLINE_TRANSLATION
+        )
 
     @classmethod
     def from_jsonl(cls, jsonl: str) -> Self:

{destiny_sdk-0.2.2 → destiny_sdk-0.2.3}/tests/unit/test_references.py

@@ -83,3 +83,32 @@ def test_es_parsing():
     assert reference.enhancements[0].id == uuid.UUID(
         "52f3fc92-db0b-4e65-a18c-31d091242c3a"
     )
+
+
+def test_jsonl_serialization():
+    reference = destiny_sdk.references.Reference(
+        id=(_id := uuid.uuid4()),
+        enhancements=[
+            destiny_sdk.enhancements.Enhancement(
+                reference_id=_id,
+                source="testing",
+                visibility=destiny_sdk.visibility.Visibility.PUBLIC,
+                content=destiny_sdk.enhancements.AbstractContentEnhancement(
+                    process=destiny_sdk.enhancements.AbstractProcessType.UNINVERTED,
+                    abstract="This is a funky paragraph separator: \u2029.",
+                ),
+            )
+        ],
+        identifiers=[
+            destiny_sdk.identifiers.OpenAlexIdentifier(identifier="W12345678")
+        ],
+    )
+
+    reference_jsonl = reference.to_jsonl()
+    assert "This is a funky paragraph separator: \\n." in reference_jsonl
+
+    round_trip_reference = destiny_sdk.references.Reference.from_jsonl(reference_jsonl)
+    assert (
+        reference.enhancements[0].content.abstract.replace("\u2029", "\n")
+        == round_trip_reference.enhancements[0].content.abstract
+    )

{destiny_sdk-0.2.2 → destiny_sdk-0.2.3}/uv.lock

@@ -63,7 +63,7 @@ wheels = [
 
 [[package]]
 name = "destiny-sdk"
-version = "0.2.2"
+version = "0.2.3"
 source = { editable = "." }
 dependencies = [
     { name = "cachetools" },