oceanprotocol-job-details 0.3.3__py3-none-any.whl → 0.3.13__py3-none-any.whl

oceanprotocol_job_details/__init__.py

@@ -1,4 +1,5 @@
 from .helpers import create_container, load_job_details
 from .ocean import JobDetails
+from .executors import run_in_executor
 
-__all__ = [JobDetails, load_job_details, create_container]  # type: ignore
+__all__ = [JobDetails, load_job_details, create_container, run_in_executor]  # type: ignore

oceanprotocol_job_details/di.py

@@ -8,7 +8,7 @@ from oceanprotocol_job_details.loaders.impl.job_details import JobDetailsLoader
 from oceanprotocol_job_details.domain import Paths
 
 
-InputParametersT = TypeVar("InputParametersT", bound=BaseModel)
+InputParametersT = TypeVar("InputParametersT", BaseModel, None)
 
 
 class Container(containers.DeclarativeContainer, Generic[InputParametersT]):

oceanprotocol_job_details/domain.py

@@ -1,7 +1,7 @@
 # mypy: disable-error-code=explicit-any
 from dataclasses import InitVar, dataclass, field
 from pathlib import Path
-from typing import Generator, List, Optional, Sequence, TypeAlias, TypeVar
+from typing import Generator, List, Optional, Sequence, TypeAlias
 
 from pydantic import BaseModel, ConfigDict, Field, JsonValue
 

oceanprotocol_job_details/executors.py

@@ -0,0 +1,25 @@
+import asyncio
+import inspect
+from typing import Any, Callable, Coroutine, TypeVar
+
+T = TypeVar("T")
+
+
+async def run_in_executor(
+    obj: Callable[..., T]
+    | Callable[..., Coroutine[Any, Any, T]]
+    | Coroutine[Any, Any, T],
+    *args,
+    **kwargs,
+) -> T:
+    if inspect.iscoroutinefunction(obj):
+        return await obj(*args, **kwargs)
+
+    if inspect.iscoroutine(obj):
+        return await obj
+
+    if callable(obj):
+        loop = asyncio.get_running_loop()
+        return await loop.run_in_executor(None, obj, *args, **kwargs)
+
+    return obj

oceanprotocol_job_details/helpers.py

@@ -6,7 +6,7 @@ from oceanprotocol_job_details.di import Container
 from oceanprotocol_job_details.ocean import JobDetails
 from oceanprotocol_job_details.settings import JobSettings
 
-InputParametersT = TypeVar("InputParametersT", bound=BaseModel)
+InputParametersT = TypeVar("InputParametersT", BaseModel, None)
 
 
 def create_container(config: Dict[str, Any]) -> Container[InputParametersT]:  # type: ignore[explicit-any]
@@ -18,8 +18,8 @@ def create_container(config: Dict[str, Any]) -> Container[InputParametersT]:  #
 
 
 def load_job_details(
-    config: Dict[str, JsonValue],
-    input_type: Type[InputParametersT],
+    config: Dict[str, JsonValue] = {},
+    input_type: Type[InputParametersT] | None = None,
 ) -> JobDetails[InputParametersT]:
     """
     Load JobDetails for a given input_type using the config.

oceanprotocol_job_details/loaders/impl/job_details.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass, field
+from types import NoneType
 from typing import Generic, Type, TypeVar, final
 
 from pydantic import BaseModel
@@ -6,7 +7,7 @@ from pydantic import BaseModel
 from oceanprotocol_job_details.domain import DDO, Files, Paths
 from oceanprotocol_job_details.ocean import JobDetails
 
-T = TypeVar("T", bound=BaseModel)
+T = TypeVar("T", BaseModel, None)
 
 
 @final

oceanprotocol_job_details/ocean.py

@@ -6,29 +6,25 @@ from pathlib import Path
 from typing import Generator, Generic, Tuple, Type, TypeVar, final
 
 import aiofiles
-from pydantic import BaseModel, ConfigDict, Secret, model_validator
+from pydantic import BaseModel, ConfigDict, Secret
 
 from oceanprotocol_job_details.domain import DDO, Files, Paths
+from oceanprotocol_job_details.executors import run_in_executor
 
-InputParemetersT = TypeVar("InputParemetersT", bound=BaseModel)
+InputParametersT = TypeVar("InputParametersT", BaseModel, None)
 
 
 @final
-class JobDetails(BaseModel, Generic[InputParemetersT]):  # type: ignore[explicit-any]
+class JobDetails(BaseModel, Generic[InputParametersT]):  # type: ignore[explicit-any]
     files: Files
     ddos: list[DDO]
     paths: Paths
-    input_type: Type[InputParemetersT]
+    input_type: Type[InputParametersT] | None
     secret: Secret[str] | None = None
 
     model_config = ConfigDict(arbitrary_types_allowed=True, frozen=True)
 
-    @model_validator(mode="after")
-    def validate_type(self) -> JobDetails[InputParemetersT]:
-        assert issubclass(self.input_type, BaseModel), (
-            f"{self.input_type} must be subtype of pydantic.BaseModel"
-        )
-        return self
+    _input_parameters: InputParametersT | None = None
 
     def inputs(self) -> Generator[Tuple[int, Path], None, None]:
         yield from (
@@ -37,15 +33,20 @@ class JobDetails(BaseModel, Generic[InputParemetersT]):  # type: ignore[explicit
             for file in files.input_files
         )
 
-    @cached_property
-    def input_parameters(self) -> InputParemetersT:
-        return asyncio.run(self.ainput_parameters())
+    async def input_parameters(self) -> InputParametersT:
+        if self._input_parameters is None:
+            input_parameters = await self.ainput_parameters()
+            object.__setattr__(self, "_input_parameters", input_parameters)
+        return self._input_parameters
+
+    async def ainput_parameters(self) -> InputParametersT:
+        if self.input_type is None:
+            return None
 
-    async def ainput_parameters(self) -> InputParemetersT:
         path = self.paths.algorithm_custom_parameters
         async with aiofiles.open(path) as f:
             raw = await f.read()
 
         raw = raw.strip()
         assert raw is not None, f"Empty file {path}"
-        return self.input_type.model_validate_json(raw)
+        return self.input_type.model_validate_json(raw)  # type: ignore

oceanprotocol_job_details/settings.py

@@ -23,7 +23,10 @@ class JobSettings(BaseSettings):  # type: ignore[explicit-any]
 
     @field_validator("dids", mode="before")
     @classmethod
-    def split_dids(cls, v: list[str] | str) -> list[str]:
+    def split_dids(cls, v: list[str] | str | None) -> list[str]:
+        if v is None:
+            return []
+
         if isinstance(v, str):
             data = orjson.loads(v)
             assert isinstance(data, list)
@@ -33,5 +36,7 @@ class JobSettings(BaseSettings):  # type: ignore[explicit-any]
     @model_validator(mode="after")
     def validate_dids(self) -> Self:
         if not self.dids:
-            self.dids.extend([f.name for f in (self.base_dir / "ddos").glob("*")])
+            self.dids.extend(
+                [f.name for f in (self.base_dir / "ddos").glob("*") if f.is_file()]
+            )
         return self

{oceanprotocol_job_details-0.3.3.dist-info → oceanprotocol_job_details-0.3.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oceanprotocol-job-details
-Version: 0.3.3
+Version: 0.3.13
 Summary: A Python package to get details from OceanProtocol jobs
 Project-URL: Homepage, https://github.com/AgrospAI/oceanprotocol-job-details
 Project-URL: Issues, https://github.com/AgrospAI/oceanprotocol-job-details/issues
@@ -32,9 +32,7 @@ A Python package to get details from OceanProtocol jobs
 
 ```bash
 pip install oceanprotocol-job-details
-```
-
-```bash
+#or
 uv add oceanprotocol-job-details
 ```
 
@@ -42,17 +40,15 @@ uv add oceanprotocol-job-details
 
 As a simple library, we only need to import `load_job_details` and run it. It will:
 
-1. Fetch the needed parameters to populate the `JobDetails` instance from the environment variables or use the passed values to the function.
-1. Look for the files corresponding to the passed DIDs in the filesystem according to the [Ocean Protocol Structure](#oceanprotocol-structure) and load them into the `JobDetails` instance.
+1. Read from disk the needed parameters to populate the `JobDetails` from the given `base_dir`. Looking for the files corresponding to the passed DIDs in the filesystem according to the [Ocean Protocol Structure](#oceanprotocol-structure).
+2. If given a `InputParameters` type that inherits from `pydantic.BaseModel`, it will create an instance from the environment variables.
 
 ### Minimal Example
 
 ```python
 from oceanprotocol_job_details import load_job_details
 
-class InputParameters(BaseModel): ...
-
-job_details = load_job_details({}, InputParameters)
+job_details = load_job_details({"base_dir": "...", "transformation_did": "..."})
 ```
 
 ### Custom Input Parameters
@@ -73,11 +69,12 @@ class InputParameters(BaseModel):
     foo: Foo
 
 
-job_details = load_job_details({}, InputParameters)
+job_details = load_job_details({"base_dir": "...", "transformation_did": "..."}, InputParameters)
 
 # Usage
-job_details.input_parameters.foo
-job_details.input_parameters.foo.bar
+parameters = await job_details.input_parameters()
+parameters.foo
+parameters.foo.bar
 ```
 
 The values to fill the custom `InputParameters` will be parsed from the `algoCustomData.json` located next to the input data directories.
@@ -88,7 +85,7 @@ The values to fill the custom `InputParameters` will be parsed from the `algoCus
 from oceanprotocol_job_details import load_job_details
 
 
-job_details = load_job_details
+job_details = load_job_details(...)
 
 for idx, file_path in job_details.inputs():
     ...

oceanprotocol_job_details-0.3.13.dist-info/RECORD

@@ -0,0 +1,18 @@
+oceanprotocol_job_details/__init__.py,sha256=sq_C8Ey4_4oHiX9cO1wne7ZsWqs86WWgHfKQ5PMwwak,218
+oceanprotocol_job_details/di.py,sha256=H4_n9NrNuRB2s9uarSkwDYzjD1i7sV8dySRfHt21QWM,1316
+oceanprotocol_job_details/domain.py,sha256=ifw-hKFAJj0Gl_wJuH-51LQx4KPsCyEVDsT10xg9uBw,3842
+oceanprotocol_job_details/executors.py,sha256=Csc1MaUf0-Ve4Wp80qIanL7reRTT2qA3W3QrSE2jQO4,556
+oceanprotocol_job_details/helpers.py,sha256=ABm3oIRwPd-4XeCOIszCbfL2wkUJqVJJ2bqy3hR4jyw,1064
+oceanprotocol_job_details/ocean.py,sha256=kq7tAHJ36s7piJ_WpXVaTmSAMe87tuwHDeMQB-xS0T4,1702
+oceanprotocol_job_details/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oceanprotocol_job_details/settings.py,sha256=o_1Hn2vl5hMk7bAkdS7GjE4nKOAyHm7dScO2_o2sPuY,1345
+oceanprotocol_job_details/loaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oceanprotocol_job_details/loaders/loader.py,sha256=36X2s_0lN89kCUpItxEXfIzuBBNJySebP2B_tdWK2E0,186
+oceanprotocol_job_details/loaders/impl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+oceanprotocol_job_details/loaders/impl/ddo.py,sha256=XthrQFhmP85XSVzVjBlLePtTowGR3BAsmVp3jngiQ08,668
+oceanprotocol_job_details/loaders/impl/files.py,sha256=Y2vFBT2T9w9zrdpmf550-LQJxwtNPUGa0UU6bBzk9AU,1145
+oceanprotocol_job_details/loaders/impl/job_details.py,sha256=QwlUaG9KozkI1wX66oDTPg4TjGkvSsi8O-TctF6eWvo,724
+oceanprotocol_job_details-0.3.13.dist-info/METADATA,sha256=9jFrlbS9oWNQXrHj_jY3ia16bA3HvdBeMt6nMdUguHk,4509
+oceanprotocol_job_details-0.3.13.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+oceanprotocol_job_details-0.3.13.dist-info/licenses/LICENSE,sha256=ni3ix7P_GxK1W3VGC4fJ3o6QoCngCEpSuTJwO4nkpbw,1055
+oceanprotocol_job_details-0.3.13.dist-info/RECORD,,

oceanprotocol_job_details-0.3.3.dist-info/RECORD

@@ -1,16 +0,0 @@
-oceanprotocol_job_details/__init__.py,sha256=nJMrZsEC5F1n9WF-v5QV095Yyc8UkhFw0AzD9o7X0IE,162
-oceanprotocol_job_details/di.py,sha256=lsogbmjvmPfkd0mjLvn9vYLIZebwJm5RNraWt7WE5LA,1316
-oceanprotocol_job_details/domain.py,sha256=2_USbeA_7VIEYS8DVb2MW6dCZasjiqIxQaGUnNUKspY,3851
-oceanprotocol_job_details/helpers.py,sha256=ubH_KjAROqYvn0mkbA0-89vpdKIhVNGZ0h9pQLfPNow,1045
-oceanprotocol_job_details/ocean.py,sha256=q8rgT5ycA2ifey3XNhUW0bcJwfMp7hpKU-6EVDeKV1o,1620
-oceanprotocol_job_details/settings.py,sha256=zgIYPzaXjsgcmuhT7L2ipSP-2eNaodugHZr0rn2Z420,1248
-oceanprotocol_job_details/loaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oceanprotocol_job_details/loaders/loader.py,sha256=36X2s_0lN89kCUpItxEXfIzuBBNJySebP2B_tdWK2E0,186
-oceanprotocol_job_details/loaders/impl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oceanprotocol_job_details/loaders/impl/ddo.py,sha256=XthrQFhmP85XSVzVjBlLePtTowGR3BAsmVp3jngiQ08,668
-oceanprotocol_job_details/loaders/impl/files.py,sha256=Y2vFBT2T9w9zrdpmf550-LQJxwtNPUGa0UU6bBzk9AU,1145
-oceanprotocol_job_details/loaders/impl/job_details.py,sha256=7mEdeTo-cmsWuqWPdN7btjLjo6p5Oa1_acjSLWL5tb8,697
-oceanprotocol_job_details-0.3.3.dist-info/METADATA,sha256=pDXdsInFTf36wYjsqWSd_ygeCDggozjueHlhF6OyvlQ,4416
-oceanprotocol_job_details-0.3.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-oceanprotocol_job_details-0.3.3.dist-info/licenses/LICENSE,sha256=ni3ix7P_GxK1W3VGC4fJ3o6QoCngCEpSuTJwO4nkpbw,1055
-oceanprotocol_job_details-0.3.3.dist-info/RECORD,,