oceanprotocol-job-details 0.3.2__tar.gz → 0.3.9__tar.gz

{oceanprotocol_job_details-0.3.2 → oceanprotocol_job_details-0.3.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oceanprotocol-job-details
-Version: 0.3.2
+Version: 0.3.9
 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
@@ -42,17 +42,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,7 +71,7 @@ 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
@@ -88,7 +86,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.2 → oceanprotocol_job_details-0.3.9}/README.md

@@ -16,17 +16,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
@@ -47,7 +45,7 @@ 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
@@ -62,7 +60,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.2 → oceanprotocol_job_details-0.3.9}/oceanprotocol_job_details/di.py

@@ -1,3 +1,4 @@
+from types import NoneType
 from typing import Generic, TypeVar
 from dependency_injector import containers, providers
 from pydantic import BaseModel
@@ -8,7 +9,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-0.3.2 → oceanprotocol_job_details-0.3.9}/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-0.3.2 → oceanprotocol_job_details-0.3.9}/oceanprotocol_job_details/loaders/impl/files.py

@@ -20,14 +20,10 @@ class FilesLoader:
     dids: list[str]
     """Input DIDs"""
 
-    transformation_did: InitVar[str | None] = None
+    transformation_did: str
     """DID for the transformation algorithm"""
 
-    _transformation_did: str = field(init=False)
-
-    def __post_init__(self, transformation_did: str | None) -> None:
-        object.__setattr__(self, "_transformation_did", transformation_did)
-
+    def __post_init__(self) -> None:
         assert self.dids, "Missing input DIDs"
 
     def calculate_path(self, did: str, path_type: Literal["input", "ddo"]) -> Path:

{oceanprotocol_job_details-0.3.2 → oceanprotocol_job_details-0.3.9}/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-0.3.2 → oceanprotocol_job_details-0.3.9}/oceanprotocol_job_details/ocean.py

@@ -3,33 +3,27 @@ from __future__ import annotations
 import asyncio
 from functools import cached_property
 from pathlib import Path
+from types import NoneType
 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
 
-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
-
     def inputs(self) -> Generator[Tuple[int, Path], None, None]:
         yield from (
             (idx, file)
@@ -38,14 +32,17 @@ class JobDetails(BaseModel, Generic[InputParemetersT]):  # type: ignore[explicit
         )
 
     @cached_property
-    def input_parameters(self) -> InputParemetersT:
+    def input_parameters(self) -> InputParametersT | None:
         return asyncio.run(self.ainput_parameters())
 
-    async def ainput_parameters(self) -> InputParemetersT:
+    async def ainput_parameters(self) -> InputParametersT | None:
+        if self.input_type is None:
+            return None
+
         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-0.3.2 → oceanprotocol_job_details-0.3.9}/oceanprotocol_job_details/settings.py

@@ -1,31 +1,42 @@
 # mypy: disable-error-code=call-overload
 from logging import Logger, getLogger
 from pathlib import Path
+from typing import Self
 
 import orjson
-from pydantic import Field, field_validator
+from pydantic import Field, field_validator, model_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 
 class JobSettings(BaseSettings):  # type: ignore[explicit-any]
     base_dir: Path = Field(alias="BASE_DIR")
-    dids: list[str] = Field(alias="DIDS")
+    dids: list[str] = Field(default_factory=list, alias="DIDS")
     transformation_did: str = Field(alias="TRANSFORMATION_DID")
     secret: str | None = Field(default=None, alias="SECRET")
     logger: Logger = Field(default_factory=lambda: getLogger(__name__))
 
     model_config = SettingsConfigDict(
         extra="forbid",
-        validate_default=True,
         populate_by_name=True,
         arbitrary_types_allowed=True,
     )
 
     @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)
             return data
         return v
+
+    @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("*") if f.is_file()]
+            )
+        return self

{oceanprotocol_job_details-0.3.2 → oceanprotocol_job_details-0.3.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oceanprotocol-job-details"
-version = "0.3.2"
+version = "0.3.9"
 description = "A Python package to get details from OceanProtocol jobs"
 authors = [
     { name = "Agrospai", email = "agrospai@udl.cat" },
@@ -39,7 +39,10 @@ build-backend = "hatchling.build"
 include = ["oceanprotocol_job_details"]
 
 [tool.hatch.build.targets.wheel]
-include = ["oceanprotocol_job_details"]
+packages = ["oceanprotocol_job_details"]
+
+[tool.hatch.build.targets.wheel.package-data]
+oceanprotocol_job_details = ["py.typed"]
 
 [tool.mypy]
 plugins = ["pydantic.mypy"]