ocean-runner 0.2.12__py3-none-any.whl → 0.2.13__py3-none-any.whl

ocean_runner/runner.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import inspect
 from dataclasses import InitVar, asdict, dataclass, field
 from logging import Logger
 from pathlib import Path
@@ -9,9 +10,7 @@ from oceanprotocol_job_details import JobDetails
 
 from ocean_runner.config import Config
 
-JobDetailsT = TypeVar(
-    "JobDetailsT",
-)
+JobDetailsT = TypeVar("JobDetailsT")
 ResultT = TypeVar("ResultT")
 
 
@@ -21,14 +20,12 @@ def default_error_callback(_: Algorithm, e: Exception) -> None:
 
 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))
 
@@ -37,21 +34,26 @@ def default_save(*, result: ResultT, base: Path, algorithm: Algorithm) -> None:
 class Algorithm(Generic[JobDetailsT, ResultT]):
 
     config: InitVar[Config | None] = None
-
-    # Load from config
     logger: Logger = field(init=False)
-
     _job_details: JobDetails[JobDetailsT] = field(init=False)
     _result: ResultT | None = field(default=None, init=False)
-
     error_callback = default_error_callback
 
     def __post_init__(self, config: Config | None) -> None:
         config: Config = config or Config()
-
         if config.error_callback:
             self.error_callback = config.error_callback
 
+        self._setup_logger(config)
+        self._load_job_details(config)
+        self._load_user_defined_functions()
+        self._maybe_autorun(config)
+
+    # ---------------------
+    # Setup helpers
+    # ---------------------
+
+    def _setup_logger(self, config: Config) -> None:
         if config.logger:
             self.logger = config.logger
         else:
@@ -62,12 +64,11 @@ class Algorithm(Generic[JobDetailsT, ResultT]):
                 format="%(asctime)s | %(levelname)-8s | %(name)s | %(message)s",
                 datefmt="%Y-%m-%d %H:%M:%S",
             )
-
             self.logger = logging.getLogger("ocean_runner")
 
+    def _load_job_details(self, config: Config) -> None:
         if isinstance(config.environment.base_dir, str):
             config.environment.base_dir = Path(config.environment.base_dir)
-
         if config.source_paths:
             import sys
 
@@ -81,11 +82,49 @@ class Algorithm(Generic[JobDetailsT, ResultT]):
             transformation_did=config.environment.transformation_did,
             secret=config.environment.secret,
         )
-
         self.logger.info("Loaded JobDetails")
         self.logger.debug(asdict(self.job_details))
 
-    class Error(RuntimeError): ...
+    # ---------------------
+    # Auto-detect functions
+    # ---------------------
+
+    def _load_user_defined_functions(self) -> None:
+        caller = inspect.getmodule(inspect.stack()[2][0])
+        if not caller:
+            return
+
+        for name, default in {
+            "validation": default_validation,
+            "run": None,
+            "save": default_save,
+        }.items():
+            fn = getattr(caller, name, None)
+            if callable(fn):
+                self.logger.debug(f"Found user-defined '{name}' function")
+                setattr(self, f"_user_{name}", fn)
+            elif default:
+                setattr(self, f"_user_{name}", default)
+
+        self._caller_module = caller
+
+    # ---------------------
+    # Auto-run logic
+    # ---------------------
+
+    def _maybe_autorun(self, config) -> None:
+        """Automatically runs if caller has __ocean_runner_autorun__ = True"""
+        if (
+            getattr(self, "_caller_module", None)
+            and getattr(self._caller_module, "__ocean_runner_autorun__", False)
+            and not getattr(config, "_from_test", False)
+        ):
+            self.logger.info("Auto-running algorithm...")
+            self.validate().run().save_results()
+
+    # ---------------------
+    # Main API
+    # ---------------------
 
     @property
     def job_details(self) -> JobDetails:
@@ -99,45 +138,41 @@ class Algorithm(Generic[JobDetailsT, ResultT]):
             raise Algorithm.Error("Result missing, run the algorithm first")
         return self._result
 
-    def validate(
-        self,
-        callback: Callable[[Self], None] = default_validation,
-    ) -> Self:
+    def validate(self, callback: Callable[[Self], None] | None = None) -> Self:
+        callback = callback or getattr(self, "_user_validation", default_validation)
         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:
+    def run(self, callback: Callable[[Self], ResultT] | None = None) -> Self:
+        callback = callback or getattr(self, "_user_run", None)
+        if callback is None:
+            raise Algorithm.Error("No 'run' function found")
         self.logger.info("Running algorithm...")
         try:
-            self._result = callable(self)
+            self._result = callback(self)
         except Exception as e:
             self.error_callback(e)
-
         return self
 
     def save_results(
         self,
-        callable: Callable[[ResultT, Path, Algorithm], None] = default_save,
+        callback: Callable[[ResultT, Path, Algorithm], None] | None = None,
         *,
         override_path: Path | None = None,
     ) -> None:
+        callback = callback or getattr(self, "_user_save", default_save)
         self.logger.info("Saving results...")
         try:
-            callable(
-                results=self.result,
-                base_path=override_path or self.job_details.paths.outputs,
+            callback(
+                result=self.result,
+                base=override_path or self.job_details.paths.outputs,
                 algorithm=self,
             )
         except Exception as e:
             self.error_callback(e)
 
-
-__all__ = [Algorithm]
+    class Error(RuntimeError): ...

{ocean_runner-0.2.12.dist-info → ocean_runner-0.2.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ocean-runner
-Version: 0.2.12
+Version: 0.2.13
 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

ocean_runner-0.2.13.dist-info/RECORD

@@ -0,0 +1,7 @@
+ocean_runner/__init__.py,sha256=awAmE6kZhuwcrD3gT7qFZArdhiuzW-EFTA6tGKhw06k,138
+ocean_runner/config.py,sha256=EgloiUTLBvca4B_pr2eNa8kHYfsyVE73ZxszLCbiDYY,1525
+ocean_runner/runner.py,sha256=-nYH6_TtAEJ9RWv_PWmeDMyfJOhQ1tlrJrNHi7ZmYKo,5941
+ocean_runner-0.2.13.dist-info/METADATA,sha256=orDe6w9hnST2HI33Ta3rU2-kUg9ulFSq9mQhLOhuVxI,5919
+ocean_runner-0.2.13.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ocean_runner-0.2.13.dist-info/licenses/LICENSE,sha256=_B25KqK4amoADWkMN150tnZFm_Fy7VvZpvIC8ZydWdI,1053
+ocean_runner-0.2.13.dist-info/RECORD,,

ocean_runner-0.2.12.dist-info/RECORD

@@ -1,7 +0,0 @@
-ocean_runner/__init__.py,sha256=awAmE6kZhuwcrD3gT7qFZArdhiuzW-EFTA6tGKhw06k,138
-ocean_runner/config.py,sha256=EgloiUTLBvca4B_pr2eNa8kHYfsyVE73ZxszLCbiDYY,1525
-ocean_runner/runner.py,sha256=LXkVNYsqELsXciI8T8RWtfbNpI-_kUAtW1aQzsnOAfU,4075
-ocean_runner-0.2.12.dist-info/METADATA,sha256=k9dRV2nI-i3_ZJPETo2DnuDzasRqx_YZhFe3pVy-20M,5919
-ocean_runner-0.2.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ocean_runner-0.2.12.dist-info/licenses/LICENSE,sha256=_B25KqK4amoADWkMN150tnZFm_Fy7VvZpvIC8ZydWdI,1053
-ocean_runner-0.2.12.dist-info/RECORD,,