python-base-command 0.1.2__tar.gz → 0.1.3__tar.gz

{python_base_command-0.1.2 → python_base_command-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-base-command
-Version: 0.1.2
+Version: 0.1.3
 Summary: Django-style BaseCommand framework for standalone Python CLI tools
 Project-URL: Homepage, https://github.com/aviz92/python-base-command
 Project-URL: Repository, https://github.com/aviz92/python-base-command

{python_base_command-0.1.2 → python_base_command-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-base-command"
-version = "0.1.2"
+version = "0.1.3"
 description = "Django-style BaseCommand framework for standalone Python CLI tools"
 readme = "README.md"
 license = { text = "MIT" }

{python_base_command-0.1.2 → python_base_command-0.1.3}/python_base_command/runner.py

@@ -48,6 +48,7 @@ from typing import Optional
 
 from custom_python_logger import get_logger
 
+from . import CommandRegistry
 from .base import BaseCommand, CommandError
 
 logger = get_logger("python-base-command")
@@ -78,8 +79,15 @@ class Runner:
 
     def _discover(self) -> dict[str, type[BaseCommand]]:
         """
-        Walk ``self._commands_dir`` and import every non-private module that
-        exposes a ``Command`` class inheriting from ``BaseCommand``.
+        Walk ``self._commands_dir`` and import every non-private module.
+
+        Two conventions are supported per module:
+
+        1. **Classic** — a class literally named ``Command`` that subclasses
+           ``BaseCommand``.  The command name is the module's file stem.
+        2. **Registry** — one or more ``CommandRegistry`` instances defined at
+           module level.  Every command registered on those instances is merged
+           in; the names come from the registry (not the file stem).
         """
         commands: dict[str, type[BaseCommand]] = {}
 
@@ -94,15 +102,19 @@ class Runner:
             if module is None:
                 continue
 
+            # --- 1. Classic: a top-level class named "Command" ---
             command_class = getattr(module, "Command", None)
-            if command_class is None:
-                continue
-            if not (
-                isinstance(command_class, type) and issubclass(command_class, BaseCommand)
-            ):
-                continue
-
-            commands[path.stem] = command_class
+            if command_class is not None and isinstance(command_class, type) and issubclass(command_class, BaseCommand):
+                commands[path.stem] = command_class
+
+            # --- 2. Registry: any CommandRegistry instances in the module ---
+            for attr_name in dir(module):
+                obj = getattr(module, attr_name)
+                if isinstance(obj, CommandRegistry):
+                    for name in obj.list_commands():
+                        cls = obj.get(name)
+                        if cls is not None:
+                            commands[name] = cls
 
         return commands
 

python_base_command-0.1.3/usage_example/commands/registry_cmd.py

@@ -0,0 +1,33 @@
+from python_base_command import BaseCommand, CommandError, CommandRegistry
+
+registry = CommandRegistry()
+
+
+@registry.register("greet2")
+class Greet2Command(BaseCommand):
+    help = "Greet a user"
+
+    def add_arguments(self, parser):
+        parser.add_argument("name", type=str)
+
+    def handle(self, **kwargs):
+        self.logger.info(f"Hello, {kwargs['name']}!")
+
+
+@registry.register("export")
+class ExportCommand(BaseCommand):
+    help = "Export data"
+
+    def add_arguments(self, parser):
+        parser.add_argument("--format", choices=["csv", "json"], default="csv")
+        parser.add_argument("--dry-run", action="store_true")
+
+    def handle(self, **kwargs):
+        if kwargs["dry_run"]:
+            self.logger.warning("Dry run — no files written.")
+            return
+        self.logger.info(f"Exported as {kwargs['format']}.")
+
+
+if __name__ == "__main__":
+    registry.run()