pipeline-component-system 0.0.1__tar.gz

pipeline_component_system-0.0.1/LICENSE

@@ -0,0 +1,5 @@
+Copyright 2024 Daniel Cauchi
+
+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:
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pipeline_component_system-0.0.1/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: pipeline-component-system
+Version: 0.0.1
+Summary: A strange programming framework
+Author-email: Daniel Cauchi <cowkeyman@gmail.com>
+Project-URL: Homepage, https://github.com/CowKeyMan/PCS
+Project-URL: Issues, https://github.com/CowKeyMan/PCS/issues
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT No Attribution License (MIT-0)
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Pipeline Component System (PCS)
+
+

pipeline_component_system-0.0.1/README.md

@@ -0,0 +1,3 @@
+# Pipeline Component System (PCS)
+
+

pipeline_component_system-0.0.1/pcs/argument_parser.py

@@ -0,0 +1,82 @@
+import yaml
+import argparse
+
+
+class Args(argparse.Namespace):
+    def __init__(self):
+        super().__init__()
+        self.args_files: str = ""
+        self.rest: list[str] = []
+
+
+def parse_arguments(obj: object):
+    args = do_parse_arguments()
+    update_dict = get_update_dict_from_comma_separated_file_list(args.args_files)
+    update_dict_with_rest_arguments(update_dict, args.rest)
+    update_object(obj, update_dict)
+
+
+def do_parse_arguments() -> Args:
+    parser = argparse.ArgumentParser()
+    _ = parser.add_argument(
+        "--args-files",
+        "-f",
+        required=False,
+        help=(
+            "A list of comma separated yaml files, where the keys in the "
+            "latest files will overwrite those in previous files"
+        ),
+    )
+    _ = parser.add_argument(
+        "--rest",
+        "-r",
+        nargs="+",
+        help=(
+            "Set a number of key-value pairs like <key>=<value>. "
+            "Values may have spaces if the whole value is wrapped"
+            'in quotes such as <key>="this is a value". These arguments'
+            "take precedence over those that come from files"
+        ),
+    )
+    args = Args()
+    args = parser.parse_args(namespace=args)
+    return args
+
+
+def get_update_dict_from_comma_separated_file_list(files: str) -> dict[str, object]:
+    return get_update_dict_from_files(files.split(","))
+
+
+def get_update_dict_from_files(files: list[str]) -> dict[str, object]:
+    if len(files) == 1 and files[0] == "":
+        return {}
+    args: dict[str, object] = {}
+    for file in files:
+        with open(file, "r", encoding="utf-8") as f:
+            args |= yaml.safe_load(f)
+    return args
+
+
+def update_dict_with_rest_arguments(update_dict: dict[str, object], rest: list[str]):
+    for r in rest:
+        key, value = r.split("=")
+        if value.isdigit():
+            value = int(value)
+        else:
+            try:
+                value = float(value)
+            except ValueError:
+                print("Not a float")
+        update_dict[key] = value
+
+
+def update_object(obj: object, update_dict: dict[str, object]):
+    for key, value in update_dict.items():
+        assert hasattr(obj, key), f"obj has no attribute {key}"
+        target_type: type = obj.__annotations__[key]
+        assert isinstance(value, target_type), (
+            f"Key: {key} with value: {value} of type {type(value)} "
+            f"does not have the target type of {target_type}"
+        )
+        setattr(obj, key, value)
+

pipeline_component_system-0.0.1/pcs/init.py

@@ -0,0 +1,6 @@
+from typing import TypeVar
+
+T = TypeVar('T')
+
+def initialize_object_nones(Cls: type[T]) -> T:
+    return Cls(*([None] * len(Cls.__annotations__)))

pipeline_component_system-0.0.1/pcs/pipeline.py

@@ -0,0 +1,89 @@
+import inspect
+from collections.abc import Mapping
+from typing import Callable, TypeAlias
+
+System: TypeAlias = Callable[..., None | Mapping[str, object]]
+
+
+class Pipeline:
+    def __init__(
+        self,
+        component: object,
+        systems: list[System],
+        do_null_checks: bool = True,
+        do_type_checks: bool = True,
+    ):
+        assert len(systems) > 0, "Systems in an empty list"
+        self.component: object = component
+        self.systems: list[System] = systems
+        self.do_null_checks: bool = do_null_checks
+        self.do_type_checks: bool = do_type_checks
+        self.current_system: System = systems[0]
+
+    def execute(self):
+        for system in self.systems:
+            self.current_system = system
+            self.check_for_nulls(system)
+            self.check_for_types(system)
+            result = system(
+                *[
+                    getattr(self.component, param_name)
+                    for param_name in inspect.signature(system).parameters
+                ]
+            )
+            self.set_component(result)
+
+    def check_for_nulls(self, system: System):
+        if not self.do_null_checks:
+            return
+        for parameter in inspect.signature(system).parameters:
+            assert (
+                getattr(self.component, parameter) is not None
+            ), f"System: {system.__name__} - Parameter {parameter} was None"
+
+    def check_for_types(self, system: System):
+        if not self.do_type_checks:
+            return
+        parameters = inspect.signature(system).parameters
+        for param in parameters:
+            self.assert_type_annotation(
+                self.component.__annotations__[param],  # pyright: ignore[reportAny]
+                parameters[param].annotation,    # pyright: ignore[reportAny]
+                f"System {system.__name__} - Input {param} has wrong type",
+            )
+
+    def set_component(self, result: None | Mapping[str, object]):
+        if result is None:
+            return
+        assert isinstance(result, dict), (
+            f"System {self.current_system.__name__} - "
+            f"Result is not None or a dictionary"
+        )
+        for name, obj in result.items():
+            self.assert_type_obj(
+                self.component.__annotations__[name],  # pyright: ignore[reportAny]
+                obj,
+                (
+                    f"System {self.current_system.__name__} "
+                    f"- Output {name} has wrong type"
+                ),
+            )
+            setattr(self.component, name, obj)
+
+    @staticmethod
+    def assert_type_obj(parent_annotation: type, obj: object, message: str):
+        parent_origin = getattr(parent_annotation, "__origin__", parent_annotation)
+        assert (type(obj) is parent_annotation) or isinstance(
+            obj, parent_origin
+        ), message
+
+    @staticmethod
+    def assert_type_annotation(
+        parent_annotation: TypeAlias, child_annotation: TypeAlias, message: str
+    ):
+        child_origin = getattr(child_annotation, "__origin__", child_annotation)
+        parent_origin = getattr(parent_annotation, "__origin__", parent_annotation)
+        assert isinstance(parent_origin, type) or parent_origin is TypeAlias
+        assert (child_annotation == parent_annotation) or isinstance(
+            child_origin, parent_origin
+        ), message

pipeline_component_system-0.0.1/pipeline_component_system.egg-info/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: pipeline-component-system
+Version: 0.0.1
+Summary: A strange programming framework
+Author-email: Daniel Cauchi <cowkeyman@gmail.com>
+Project-URL: Homepage, https://github.com/CowKeyMan/PCS
+Project-URL: Issues, https://github.com/CowKeyMan/PCS/issues
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT No Attribution License (MIT-0)
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Pipeline Component System (PCS)
+
+

pipeline_component_system-0.0.1/pipeline_component_system.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+pcs/__init__.py
+pcs/argument_parser.py
+pcs/init.py
+pcs/pipeline.py
+pipeline_component_system.egg-info/PKG-INFO
+pipeline_component_system.egg-info/SOURCES.txt
+pipeline_component_system.egg-info/dependency_links.txt
+pipeline_component_system.egg-info/top_level.txt

pipeline_component_system-0.0.1/pipeline_component_system.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pipeline_component_system-0.0.1/pipeline_component_system.egg-info/top_level.txt

@@ -0,0 +1 @@
+pcs

pipeline_component_system-0.0.1/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "pipeline-component-system"
+version = "0.0.1"
+authors = [
+  { name="Daniel Cauchi", email="cowkeyman@gmail.com" },
+]
+description = "A strange programming framework"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+  "Development Status :: 2 - Pre-Alpha",
+  "License :: OSI Approved :: MIT No Attribution License (MIT-0)",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3 :: Only",
+  "Natural Language :: English",
+  "Intended Audience :: Developers"
+]
+
+[project.urls]
+Homepage = "https://github.com/CowKeyMan/PCS"
+Issues = "https://github.com/CowKeyMan/PCS/issues"

pipeline_component_system-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+