datashare-python 0.12.9__py3-none-any.whl → 0.12.11__py3-none-any.whl

datashare_python/conftest.py

@@ -48,6 +48,7 @@ _DEFAULT_BROKER_URL = (
 _DEFAULT_AUTH = aiohttp.BasicAuth(login="guest", password="guest", encoding="utf-8")
 
 TEST_PROJECT = "test-project"
+DS_URL = "https://datashare.org"
 
 _INDEX_BODY = {
     "mappings": {

datashare_python/exceptions.py

@@ -1,5 +1,7 @@
 from abc import ABC
 
+from .objects import DocArtifact
+
 
 class DatashareError(Exception, ABC): ...
 
@@ -16,3 +18,9 @@ class DependencyInjectionError(DatashareError, RuntimeError):
     def __init__(self, name: str):
         msg = f"{name} was not injected"
         super().__init__(msg)
+
+
+class ArtifactNotFound(DatashareError):
+    def __init__(self, doc_id: str, artifact_type: type[DocArtifact]):
+        msg = f"could not find {artifact_type.__name__} for {doc_id}"
+        super().__init__(msg)

datashare_python/objects.py

@@ -858,10 +858,12 @@ class WorkerFile(
         )
 
 
-def _file_discriminator(v: Any) -> str:
+def _file_discriminator(v: Any) -> str | None:
     parent = v.get("parent") if isinstance(v, dict) else getattr(v, "parent", None)
     if parent is None:
-        raise ValueError(f"{v} has no parent")
+        # No match the parent is neither a DatashareFile of WorkerFile it could be a
+        # Document or we're just deserializing something else
+        return None
     if isinstance(parent, dict):
         is_document = parent.get("type") == "Document"
     else:

datashare_python/utils.py

@@ -54,6 +54,7 @@ from datashare_python.types_ import (
 )
 
 from .constants import MANIFEST_JSON, METADATA_JSON
+from .exceptions import ArtifactNotFound
 from .mimetypes_ import types_map
 from .objects import (
     BaseModel,
@@ -401,6 +402,37 @@ def artifacts_dir(doc_id: str, *, project: str) -> Path:
     return Path(project, safe_dir(doc_id), doc_id)
 
 
+async def async_read_artifact(
+    paths: WorkerPaths, doc_id: str, artifact_type: type[DocArtifact], *, project: str
+) -> bytes:
+    # Reading the manifest can be long, we load it only if the artifact exists then
+    # we check that the entry is in the manifest
+    artifact_path = (
+        paths.artifacts
+        / artifacts_dir(doc_id, project=project)
+        / artifact_type.filename
+    )
+    if not artifact_path.exists():
+        raise ArtifactNotFound(doc_id, artifact_type)
+    m_path = paths.artifacts / _manifest_path(doc_id, project=project)
+
+    try:
+        async with async_open(m_path, "r") as f:
+            manifest_json = await f.read()
+    except OSError as e:
+        raise ArtifactNotFound(doc_id, artifact_type) from e
+
+    manifest = json.loads(manifest_json)
+    if artifact_type.type.value not in manifest:
+        raise ArtifactNotFound(doc_id, artifact_type)
+
+    try:
+        async with async_open(artifact_path, "rb") as f:
+            return await f.read()
+    except OSError as e:
+        raise ArtifactNotFound(doc_id, artifact_type) from e
+
+
 def _metadata_path(doc_id: str, *, project: str) -> Path:
     metadata_path = artifacts_dir(doc_id, project=project) / METADATA_JSON
     return metadata_path

{datashare_python-0.12.9.dist-info → datashare_python-0.12.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: datashare-python
-Version: 0.12.9
+Version: 0.12.11
 Summary: Manage Python tasks and local resources in Datashare
 Project-URL: Homepage, https://icij.github.io/datashare-python/
 Project-URL: Documentation, https://icij.github.io/datashare-python/

{datashare_python-0.12.9.dist-info → datashare_python-0.12.11.dist-info}/RECORD

@@ -2,27 +2,27 @@ datashare_python/.gitignore,sha256=e-SRgnvGGdsjRrqgKsTzALz6Obx8IYiOjr0yaAxT6v8,2
 datashare_python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 datashare_python/__main__.py,sha256=g-fvS46zl9umKmGrSpl-OG-8PSuZgjqvTCqjpsZtSps,101
 datashare_python/config.py,sha256=sQ-M4_T4iojWXFsR_auQn5GMrGHj9E5Nwt6DgJe1kC0,5203
-datashare_python/conftest.py,sha256=fpjgOBBKzwtIArcyC4qbcyTpMtr2nf0N2p-8WKkRvgs,13827
+datashare_python/conftest.py,sha256=EuRICBdocWVc30yNzEJq-71uHYnHW-BpoYjAnN-ko78,13860
 datashare_python/constants.py,sha256=ELS71jupoHAYTPrCvjWizCJUdzNbOiwza58CG2WP4lU,6136
 datashare_python/dependencies.py,sha256=Q-BIhCwWu-GGp9omYNhENZ88cF0QJ8spfaMZX40mmNU,4386
 datashare_python/discovery.py,sha256=3mUck2GUSKu2DSP9-MM1OdVM4FqFKqfBeSQDQZxgh2g,7177
-datashare_python/exceptions.py,sha256=bVHEAXxDPKfxeeMC0hJXEsrJkgsKO2ESAhxWU96GA4M,496
+datashare_python/exceptions.py,sha256=lYtbana4ubreOBeSMa70exQA1YIYPQCx9Ar_d-JBb8M,743
 datashare_python/interceptors.py,sha256=-XC-y_MvGyHlZQ6jItfMRPAmKwQkQzzncpAGxceKlwM,16485
 datashare_python/logging_.py,sha256=96KNXhP-JR5ybu9dld4VLtF7v7PfiphOCR1Nio-mmUs,4483
 datashare_python/mimetypes_.py,sha256=omd2g8JyN-tfZL-lmxbWsjgc987iUe5w87ZpEtbyUK0,49930
-datashare_python/objects.py,sha256=mRkqeK_nRJIvfbT5VjsynOl01TNO5JtvxE-ISlJ5T80,26747
+datashare_python/objects.py,sha256=2v83v4A0KcEJxiqQjv1PDDN6XRbEyTKJuGPuMpG4-jU,26874
 datashare_python/task_client.py,sha256=oTmP8bvZW0UyhLNMi1AV3XIAx7hrdbxNRss2Mw2azEc,8435
 datashare_python/template.py,sha256=N1uM8TRXh5tQPV7BC1oJj-Pdm2Gs_SkjaXv50RnNYso,4682
 datashare_python/types_.py,sha256=cPcCkIk6ecILrKetPnAsrb0njHYuWJU3eZicUXy2lF8,1278
-datashare_python/utils.py,sha256=2Tp0rAgGl3N-_hvZmk09gF22wiVRuciDJKVh0QvruDo,34738
-datashare_python/worker-template.tar.gz,sha256=irvU8_NFLiZ10bOPkDuBJ2ZT32IDv4_-wX_mPqF6azQ,281025
+datashare_python/utils.py,sha256=0B2Cl-G4FbudTKTm2CWYRg2pNTIvHHu1i9ZS02zr0Lk,35858
+datashare_python/worker-template.tar.gz,sha256=cpDoYRLOY8Lylr4YCtwcN4EjoC3jS2bnBoUuCilbQX0,280825
 datashare_python/worker.py,sha256=ad36_yJOgwtj8KBheWndGkqaP_2aXTPSrYaHrbCXTvg,8389
 datashare_python/cli/__init__.py,sha256=9BPWtssDgsVfWMsZ1TtZCla0EC_kai4RHttr8oNLYOE,1401
 datashare_python/cli/project.py,sha256=w32Gy9AOL5B00uDT4in7YUCt2g68FnNbvwg2M3a8G6o,946
 datashare_python/cli/task.py,sha256=GsyR5o0fN4Pd8tJKAUgivAvCBKT3L4Ay5j_BCW1XBHk,5828
 datashare_python/cli/utils.py,sha256=p69CQb0zfixuyBkiZprhdMCc_NuYwXyAn6vC9H1UzAw,911
 datashare_python/cli/worker.py,sha256=x0p3a1_NsZPbmV7-WSVMRyW3_iadYcgyZKbDvWgymQc,5790
-datashare_python-0.12.9.dist-info/METADATA,sha256=Yc1M1G9jvcB6UbrI9svzh7kV4JYGsIYvpIoE9hzISbg,1012
-datashare_python-0.12.9.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-datashare_python-0.12.9.dist-info/entry_points.txt,sha256=ILE7auxabHWiu3GC-AunWnzjhOI_SbZp7D4GqZHlLw4,68
-datashare_python-0.12.9.dist-info/RECORD,,
+datashare_python-0.12.11.dist-info/METADATA,sha256=Cv6L1Y5UXU8dE884paYaxsgvlHzCQUpkMvU5QJFnk2M,1013
+datashare_python-0.12.11.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+datashare_python-0.12.11.dist-info/entry_points.txt,sha256=ILE7auxabHWiu3GC-AunWnzjhOI_SbZp7D4GqZHlLw4,68
+datashare_python-0.12.11.dist-info/RECORD,,