regorator 0.1__py3-none-any.whl → 0.1.1__py3-none-any.whl

regorator/__init__.py

@@ -1,2 +1,2 @@
+from . import core, version
 from .core.main import *
-from . import version 

regorator/core/__init__.py

@@ -0,0 +1 @@
+from . import main 

regorator/core/main.py

@@ -0,0 +1,87 @@
+import types
+
+
+def create_registry(desc=""):
+    """Create a new registry dictionary."""
+    return regdict({}, __doc__=desc)
+
+
+class regdict(dict):
+    """A dict that supports a custom __doc__ attribute."""
+
+    def __init__(self, *args, __name__=None, __doc__=None, **kwargs):
+        super().__init__(*args, **kwargs)
+        if __doc__:
+            self.__doc__ = __doc__
+        if __name__:
+            self.__name__ = __name__
+
+
+def register(name: str, registry, description: str = ""):
+    """Decorator to register a function in a given registry."""
+    def decorator(func):
+        func._correction_name = name
+        func._description = description or "No description provided"
+        registry[name] = func
+        return func
+    return decorator
+
+
+class Register:
+    """
+    Base class for bricks that require registration.
+    """
+
+    def __init__(self):
+        # Each instance gets its own registry
+        self.registry = create_registry()
+
+    def register(cls, name: str, description: str = ""):
+        """Class method that wraps the register decorator for the class's registry."""
+        def decorator(func):
+            return register(name, cls.registry, description)(func)
+        return decorator
+
+    @property
+    def available(self):
+        return self.registry
+
+    # @classmethod
+    def get(self, name):
+        """Retrieve a registered method by name.
+        Args:
+            name (str): The name of the method.
+        Raises:
+            KeyError: If the method is not registered.
+        """
+        meth = self.available.get(
+            name, None)
+
+        if meth is None:
+            raise KeyError(
+                f"Method '{name}' is not registered.",
+                "Check metadata or make sure the method is registered (if custom method).")
+        return meth
+
+    # @classmethod
+    def add_method(self, name, how=None):
+        """Decorator to add a method dynamically to a class."""
+        def decorator(func):
+            # Dynamically add the function to the class
+            if how == 'classmethod':
+                method = classmethod(func)
+            elif how == 'static':
+                method = func
+            else:
+                method = types.MethodType(func, self)
+            setattr(self, name, method)
+            return self
+        return decorator
+
+    def apply(self, data, **kwargs):
+        """
+        Apply the correction routine to the provided data.
+        Must be overridden by subclasses.
+        """
+        raise NotImplementedError(
+            "Each correction module must implement an apply() method.")

regorator/version.py

@@ -1,4 +1,4 @@
-version = "0.1"
+version = "0.1.1"
 __version__ = version
 full_version = version
 

{regorator-0.1.dist-info → regorator-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: regorator
-Version: 0.1
+Version: 0.1.1
 Summary: A Python Registry and Decorator System
 Author-email: Pedro Henrique Coimbra <pedro-henrique.herig-coimbra@inrae.fr>
 License: EUPL-1.2
@@ -20,4 +20,3 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Other/Nonlisted Topic
-

regorator-0.1.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+regorator/__init__.py,sha256=VA3koMquQPfcKC6a7b8LsZhDkK0pQhRHq00Ja6_xfoo,55
+regorator/version.py,sha256=DV3uSQoffoXzws0pLmLFroOQbeinwXoo-uUF7Pfa2ag,162
+regorator/core/__init__.py,sha256=dkVIvwG8MJYJmauIasz2oyrvcoodV3QY_N1kRhhwgOs,21
+regorator/core/main.py,sha256=s7oqH7V3N4dubKeIbEQtoTJmp1W9VmIzOVRXofG_Fnw,2687
+regorator-0.1.1.dist-info/METADATA,sha256=c0XuA_x0R1IXeESUX6jflFGs1nZ1UpaVveYS303dtUk,1022
+regorator-0.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+regorator-0.1.1.dist-info/top_level.txt,sha256=srZ8vy-ArghxY-MAErU3JmFVpXRf9r7hoBSxeZRsnBY,10
+regorator-0.1.1.dist-info/RECORD,,

{regorator-0.1.dist-info → regorator-0.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.3)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

regorator-0.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-regorator/__init__.py,sha256=3ynENL7joMcXhqEKFXoU17R0vvJLDvZyu5baG8mj5Sc,50
-regorator/version.py,sha256=POseRB3SzK83fWHtlQZmTDUVs82krdZiP-8m8ubhaeE,160
-regorator-0.1.dist-info/METADATA,sha256=-iRIrCq_gD6zxqbYQFOwM3cl4zHhQ5p6DR5lr4I4vV0,1022
-regorator-0.1.dist-info/WHEEL,sha256=WnJ8fYhv8N4SYVK2lLYNI6N0kVATA7b0piVUNvqIIJE,91
-regorator-0.1.dist-info/top_level.txt,sha256=srZ8vy-ArghxY-MAErU3JmFVpXRf9r7hoBSxeZRsnBY,10
-regorator-0.1.dist-info/RECORD,,