ocean-runner 0.1.0__py3-none-any.whl → 0.1.3__py3-none-any.whl

ocean_runner/__init__.py

@@ -0,0 +1,4 @@
+from ocean_runner.config import Config, Environment
+from ocean_runner.runner import Algorithm
+
+__all__ = [Config, Algorithm, Environment]

ocean_runner/config.py

@@ -0,0 +1,48 @@
+from dataclasses import asdict, dataclass, field
+from logging import Logger
+import os
+from pathlib import Path
+from typing import Callable, Iterable, TypeVar
+
+T = TypeVar("T")
+
+
+@dataclass(frozen=True)
+class Environment:
+    """Environment variables mock"""
+
+    base_dir: str | None = field(default=os.environ.get("BASE_DIR", None))
+    """Base data directory, defaults to '/data'"""
+
+    dids: str = field(default=os.environ.get("DIDS"))
+    """Datasets DID's, format: '["XXXX"]'"""
+
+    transformation_did: str = field(default=os.environ.get("TRANSFORMATION_DID"))
+    """Transformation (algorithm) DID"""
+
+    secret: str = field(default=os.environ.get("SECRET"))
+    """Super secret secret"""
+
+    dict = asdict
+
+
+@dataclass
+class Config:
+    """Algorithm overall configuration"""
+
+    custom_input: T | None = None
+    """Algorithm's custom input types, must be a dataclass_json"""
+
+    error_callback: Callable[[Exception], None] = None
+    """Callback to execute upon exceptions"""
+
+    logger: Logger | None = None
+    """Logger to use in the algorithm"""
+
+    source_paths: Iterable[Path] = field(
+        default_factory=lambda: [Path("/algorithm/src")]
+    )
+    """Paths that should be included so the code executes correctly"""
+
+    environment: Environment = Environment()
+    """Mock of environment data"""

ocean_runner/runner.py

@@ -0,0 +1,126 @@
+from dataclasses import InitVar, asdict, dataclass, field
+from logging import Logger
+from pathlib import Path
+from typing import Callable, Generic, Self, TypeVar
+
+from oceanprotocol_job_details import JobDetails
+
+from ocean_runner.config import Config
+
+JobDetailsT = TypeVar(
+    "JobDetailsT",
+)
+ResultT = TypeVar("ResultT")
+
+
+def default_error_callback(e: Exception) -> None:
+    raise e
+
+
+def default_validation(algorithm: "Algorithm") -> None:
+    algorithm.logger.info("Validating input using default validation")
+
+    assert algorithm.job_details.ddos, "DDOs missing"
+    assert algorithm.job_details.files, "Files missing"
+
+
+def default_save(*, result: ResultT, base: Path, algorithm: "Algorithm") -> None:
+    algorithm.logger.info("Saving results using default save")
+
+    with open(base / "result.txt", "w+") as f:
+        f.write(str(result))
+
+
+@dataclass
+class Algorithm(Generic[JobDetailsT, ResultT]):
+
+    config: InitVar[Config | None] = None
+
+    # Load from config
+    logger: Logger = field(init=False)
+    error_callback: Callable[[Exception], None] = field(init=False)
+
+    _job_details: JobDetails[JobDetailsT] = field(init=False)
+    _result: ResultT | None = field(default=None, init=False)
+
+    def __post_init__(self, config: Config | None) -> None:
+        config = config or Config()
+
+        # Use config or use a default implementation
+        self.error_callback = config.error_callback or default_error_callback
+
+        if config.logger:
+            self.logger = config.logger
+        else:
+            import logging
+
+            logging.basicConfig(
+                level=logging.DEBUG,
+                format="%(asctime)s | %(levelname)-8s | %(name)s | %(message)s",
+                datefmt="%Y-%m-%d %H:%M:%S",
+            )
+
+            self.logger = logging.getLogger("ocean_runner")
+
+        if isinstance(config.environment.base_dir, str):
+            config.environment.base_dir = Path(config.environment.base_dir)
+
+        if config.source_paths:
+            import sys
+
+            sys.path.extend([str(path.absolute()) for path in config.source_paths])
+            self.logger.debug(f"Added [{len(config.source_paths)}] entries to PATH")
+
+        self._job_details = JobDetails.load(
+            config.custom_input,
+            **config.environment.dict(),
+        )
+
+        self.logger.info("Loaded JobDetails")
+        self.logger.debug(asdict(self.job_details))
+
+    class Error(RuntimeError): ...
+
+    @property
+    def job_details(self) -> JobDetails:
+        if not self._job_details:
+            raise Algorithm.Error("JobDetails not initialized or missing")
+        return self._job_details
+
+    @property
+    def result(self) -> ResultT:
+        if not self._result:
+            raise Algorithm.Error("Result missing, run the algorithm first")
+        return self._result
+
+    def validate(self, callback: Callable[[Self], None] = default_validation) -> Self:
+        self.logger.info("Validating instance...")
+        try:
+            callback(self)
+        except Exception as e:
+            self.error_callback(e)
+
+        return self
+
+    def run(self, callable: Callable[[Self], ResultT]) -> Self:
+        self.logger.info("Running algorithm ...")
+        try:
+            self._result = callable(self)
+        except Exception as e:
+            self.error_callback(e)
+
+        return self
+
+    def save_results(
+        self,
+        callable: Callable[[ResultT, Path, "Algorithm"], None] = default_save,
+    ) -> None:
+        self.logger.info("Saving results...")
+        try:
+            callable(
+                results=self.result,
+                base_path=self.job_details.paths.outputs,
+                algorithm=self,
+            )
+        except Exception as e:
+            self.error_callback(e)

{ocean_runner-0.1.0.dist-info → ocean_runner-0.1.3.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: ocean-runner
-Version: 0.1.0
-Summary: A Python PyPI package template
+Version: 0.1.3
+Summary: A fluent API for OceanProtocol algorithms
 Project-URL: Homepage, https://github.com/AgrospAI/ocean-runner
 Project-URL: Issues, https://github.com/AgrospAI/ocean-runner/issues
-Author-email: John Doe <john.doe@foo.bar>
+Author-email: AgrospAI <agrospai@udl.cat>, Christian López <christian.lopez@udl.cat>
 License: Copyright 2025 spin3l
         
         Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
@@ -61,6 +61,9 @@ Algorithm(
         
         logger: ... # type: logging.Logger
         # Custom logger to use.
+
+        source_paths: ... # type: Iterable[Path]
+        # Source paths to include in the PATH
         
         environment: ... 
         # type: ocean_runner.Environment. Mock of environment variables.
@@ -93,6 +96,11 @@ Algorithm(
         NOTE: it's not recommended to catch exceptions this way. Should re-raise and halt the execution.
         """
 
+        source_paths: [Path("/algorithm/src")],
+        """
+        Source paths to include in the PATH. '/algorithm/src' is the default since our templates place the algorithm source files there.
+        """
+
         logger: logger,
         """
         Custom logger to use in the Algorithm.

ocean_runner-0.1.3.dist-info/RECORD

@@ -0,0 +1,7 @@
+ocean_runner/__init__.py,sha256=awAmE6kZhuwcrD3gT7qFZArdhiuzW-EFTA6tGKhw06k,138
+ocean_runner/config.py,sha256=9XSDHuNY5IspDi5ZZKmt2HX6yrI9gzeogCw-ATMCATs,1323
+ocean_runner/runner.py,sha256=r02O2QHSc_eij1zI8soYzvjPXA8R-Khvg2XyCj58C-M,3770
+ocean_runner-0.1.3.dist-info/METADATA,sha256=fJNuD7DqYooVxdhYpFJXTlJvZxLISJITxgooum2emlc,5781
+ocean_runner-0.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ocean_runner-0.1.3.dist-info/licenses/LICENSE,sha256=_B25KqK4amoADWkMN150tnZFm_Fy7VvZpvIC8ZydWdI,1053
+ocean_runner-0.1.3.dist-info/RECORD,,

ocean_runner-0.1.0.dist-info/RECORD

@@ -1,4 +0,0 @@
-ocean_runner-0.1.0.dist-info/METADATA,sha256=RNcTJa7JJDpda1CbBiRFUQgBANV0h8PR_b-TNuYgS2U,5420
-ocean_runner-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ocean_runner-0.1.0.dist-info/licenses/LICENSE,sha256=_B25KqK4amoADWkMN150tnZFm_Fy7VvZpvIC8ZydWdI,1053
-ocean_runner-0.1.0.dist-info/RECORD,,