junban 1.0.1__tar.gz → 1.0.3__tar.gz

junban-1.0.3/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: junban
+Version: 1.0.3
+Summary: Junban – Simple Sequential Python Workflows
+Author-email: Sebastian Franz <sebastian.franz@tum.de>
+Project-URL: Issues, https://github.com/biocentral/junban/issues
+Project-URL: Repository, https://github.com/biocentral/junban
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Junban (順番) – Simple Sequential Python Workflows
+
+Junban (english: order) is a lightweight library for defining and executing sequential (scientific) workflows in Python.
+
+## Installation
+
+Junban is available via [pypi](https://pypi.org/project/junban/):
+
+```shell
+pip install junban
+```
+
+## Quick Example
+
+Here is a simple example showing how to define a context and two steps. It showcases how context is passed between steps
+and how entry/exit assumptions (verification) are handled.
+
+```python
+from dataclasses import dataclass
+from junban.pipeline import Pipeline
+from junban.pipeline_step import PipelineStep
+from junban.pipeline_context import PipelineContext
+
+
+# 1. Define your context by inheriting from PipelineContext
+@dataclass
+class MyContext(PipelineContext):
+    value: int = 0
+    is_processed: bool = False
+
+
+# 2. Create pipeline steps by inheriting from PipelineStep
+class IncrementStep(PipelineStep[MyContext]):
+    def _check_entry_assumptions(self, context: MyContext) -> bool:
+        # Verification before step execution
+        return context.value == 0
+
+    def _execute(self, context: MyContext) -> MyContext:
+        # Core logic of the step
+        context.value += 1
+        return context
+
+    def _check_exit_assumptions(self, context: MyContext) -> bool:
+        # Verification after step execution
+        return context.value == 1
+
+    def get_start_message(self) -> str:
+        return "Incrementing value..."
+
+    def get_end_message(self) -> str:
+        return "Value incremented."
+
+
+class ProcessStep(PipelineStep[MyContext]):
+    def _check_entry_assumptions(self, context: MyContext) -> bool:
+        return context.value > 0
+
+    def _execute(self, context: MyContext) -> MyContext:
+        context.is_processed = True
+        return context
+
+    def _check_exit_assumptions(self, context: MyContext) -> bool:
+        return context.is_processed is True
+
+    def get_start_message(self) -> str:
+        return "Processing..."
+
+    def get_end_message(self) -> str:
+        return "Processed."
+
+
+# 3. Initialize and execute the pipeline
+if __name__ == "__main__":
+    context = MyContext()
+    pipeline = Pipeline(
+        steps=[IncrementStep(), ProcessStep()],
+        name="ExamplePipeline"
+    )
+
+    final_context = pipeline.execute(context)
+    print(f"Final value: {final_context.value}, Processed: {final_context.is_processed}")
+```

{junban-1.0.1 → junban-1.0.3}/junban/pipeline.py

@@ -41,9 +41,13 @@ class Pipeline(Generic[C]):
         current_context = context
         for step in self.steps:
             try:
-                self._log_info(f"[{self.name}] {step.get_start_message()}")
-                current_context = step.run(current_context)
-                self._log_info(f"[{self.name}] {step.get_end_message()}")
+                skip = step.maybe_skip(context)
+                if skip:
+                    self._log_info(f"[{self.name}] Skipping..")
+                else:
+                    self._log_info(f"[{self.name}] {step.get_start_message()}")
+                    current_context = step.run(current_context)
+                    self._log_info(f"[{self.name}] {step.get_end_message()}")
             except AssertionError as e:
                 self._log_error(f"[{self.name}] Assertion error in step {step.__class__.__name__}: {str(e)}")
                 raise

{junban-1.0.1 → junban-1.0.3}/junban/pipeline_step.py

@@ -20,6 +20,11 @@ class PipelineStep(ABC, Generic[C]):
         """
         return True
 
+    def _skip(self, context: C) -> bool:
+        """ If this method returns True, the pipeline step will be skipped entirely.
+        Should not modify the context in any way."""
+        return False
+
     @abstractmethod
     def get_start_message(self) -> str:
         raise NotImplementedError
@@ -32,6 +37,9 @@ class PipelineStep(ABC, Generic[C]):
     def _execute(self, context: C) -> C:
         raise NotImplementedError
 
+    def maybe_skip(self, context: C) -> bool:
+        return self._skip(context)
+
     def run(self, context: C) -> C:
         if not self._check_entry_assumptions(context):
             assert False, "Entry assumptions not met"

junban-1.0.3/junban.egg-info/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: junban
+Version: 1.0.3
+Summary: Junban – Simple Sequential Python Workflows
+Author-email: Sebastian Franz <sebastian.franz@tum.de>
+Project-URL: Issues, https://github.com/biocentral/junban/issues
+Project-URL: Repository, https://github.com/biocentral/junban
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Junban (順番) – Simple Sequential Python Workflows
+
+Junban (english: order) is a lightweight library for defining and executing sequential (scientific) workflows in Python.
+
+## Installation
+
+Junban is available via [pypi](https://pypi.org/project/junban/):
+
+```shell
+pip install junban
+```
+
+## Quick Example
+
+Here is a simple example showing how to define a context and two steps. It showcases how context is passed between steps
+and how entry/exit assumptions (verification) are handled.
+
+```python
+from dataclasses import dataclass
+from junban.pipeline import Pipeline
+from junban.pipeline_step import PipelineStep
+from junban.pipeline_context import PipelineContext
+
+
+# 1. Define your context by inheriting from PipelineContext
+@dataclass
+class MyContext(PipelineContext):
+    value: int = 0
+    is_processed: bool = False
+
+
+# 2. Create pipeline steps by inheriting from PipelineStep
+class IncrementStep(PipelineStep[MyContext]):
+    def _check_entry_assumptions(self, context: MyContext) -> bool:
+        # Verification before step execution
+        return context.value == 0
+
+    def _execute(self, context: MyContext) -> MyContext:
+        # Core logic of the step
+        context.value += 1
+        return context
+
+    def _check_exit_assumptions(self, context: MyContext) -> bool:
+        # Verification after step execution
+        return context.value == 1
+
+    def get_start_message(self) -> str:
+        return "Incrementing value..."
+
+    def get_end_message(self) -> str:
+        return "Value incremented."
+
+
+class ProcessStep(PipelineStep[MyContext]):
+    def _check_entry_assumptions(self, context: MyContext) -> bool:
+        return context.value > 0
+
+    def _execute(self, context: MyContext) -> MyContext:
+        context.is_processed = True
+        return context
+
+    def _check_exit_assumptions(self, context: MyContext) -> bool:
+        return context.is_processed is True
+
+    def get_start_message(self) -> str:
+        return "Processing..."
+
+    def get_end_message(self) -> str:
+        return "Processed."
+
+
+# 3. Initialize and execute the pipeline
+if __name__ == "__main__":
+    context = MyContext()
+    pipeline = Pipeline(
+        steps=[IncrementStep(), ProcessStep()],
+        name="ExamplePipeline"
+    )
+
+    final_context = pipeline.execute(context)
+    print(f"Final value: {final_context.value}, Processed: {final_context.is_processed}")
+```

{junban-1.0.1 → junban-1.0.3}/pyproject.toml

@@ -1,10 +1,11 @@
 [project]
 name = "junban"
-version = "1.0.1"
+version = "1.0.3"
 description = "Junban – Simple Sequential Python Workflows"
 authors = [
     {name = "Sebastian Franz", email = "sebastian.franz@tum.de"},
 ]
+readme = "README.md"
 requires-python = ">=3.11"
 dependencies = []
 

junban-1.0.1/PKG-INFO

@@ -1,10 +0,0 @@
-Metadata-Version: 2.4
-Name: junban
-Version: 1.0.1
-Summary: Junban – Simple Sequential Python Workflows
-Author-email: Sebastian Franz <sebastian.franz@tum.de>
-Project-URL: Issues, https://github.com/biocentral/junban/issues
-Project-URL: Repository, https://github.com/biocentral/junban
-Requires-Python: >=3.11
-License-File: LICENSE
-Dynamic: license-file

junban-1.0.1/junban.egg-info/PKG-INFO

@@ -1,10 +0,0 @@
-Metadata-Version: 2.4
-Name: junban
-Version: 1.0.1
-Summary: Junban – Simple Sequential Python Workflows
-Author-email: Sebastian Franz <sebastian.franz@tum.de>
-Project-URL: Issues, https://github.com/biocentral/junban/issues
-Project-URL: Repository, https://github.com/biocentral/junban
-Requires-Python: >=3.11
-License-File: LICENSE
-Dynamic: license-file