rats-apps 0.8.0.dev20250415093554__py3-none-any.whl → 0.9.0.dev20250415195703__py3-none-any.whl

rats/apps/__init__.py

@@ -16,6 +16,7 @@ from ._annotations import (
     service,
 )
 from ._app_containers import (
+    EMPTY_PLUGIN,
     AppBundle,
     AppContainer,
     AppPlugin,
@@ -43,6 +44,7 @@ from ._static_container import StaticContainer, StaticProvider, static_group, st
 
 __all__ = [
     "EMPTY_CONTAINER",
+    "EMPTY_PLUGIN",
     "App",
     "AppBundle",
     "AppContainer",

rats/cli/__init__.py

@@ -8,16 +8,21 @@ from ._annotations import (
     get_class_groups,
     group,
 )
-from ._app import ClickApp
+from ._click_app import ClickApp
+from ._command import Command
 from ._container import CompositeContainer, Container
-from ._plugin import attach, create_group
+from ._functions import attach, create_group
+from ._plugin import PluginConfigs, PluginContainer
 
 __all__ = [
     "AUTO_COMMAND",
     "ClickApp",
+    "Command",
     "CommandId",
     "CompositeContainer",
     "Container",
+    "PluginConfigs",
+    "PluginContainer",
     "attach",
     "command",
     "create_group",

rats/cli/_command.py

@@ -0,0 +1,24 @@
+from collections.abc import Mapping
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class Command:
+    """Wraps the information of a cli command."""
+
+    cwd: str
+    """
+    The directory the command is run from.
+
+    Often taken from [pathlib.Path.cwd][] and turned into a plain string.
+    """
+    argv: tuple[str, ...]
+    """
+    The list of cli arguments passed to the command.
+
+    This has the same meaning as [sys.argv][] and is often populated by it.
+    """
+    env: Mapping[str, str]
+    """
+    The process environment variables often populated by [os.environ][].
+    """

rats/cli/_functions.py

@@ -0,0 +1,61 @@
+import click
+
+from ._container import Container
+
+
+def create_group(group: click.Group, container: Container) -> click.Group:
+    """
+    A simple shortcut to create a [click.Group][] with commands provided by `rats.cli.Container`'s.
+
+    ```python
+    import click
+    from rats import cli
+
+
+    class Example(cli.Container):
+        @cli.command()
+        def my_command(self) -> None:
+            print("hello, world. run me with `my-cli my-command`.")
+
+
+    if __name__ == "__main__":
+        cli.create_group(click.Group("my-cli"), Example()).main()
+    ```
+
+    Args:
+        group: The [click.Group][] commands will be added to.
+        container: The [rats.cli.Container][] instance to attach commands from
+    """
+    container.attach(group)
+    return group
+
+
+def attach(
+    group: click.Group,
+    command: click.Command | click.Group,
+    *commands: click.Command | click.Group,
+) -> None:
+    """
+    Convenience function to attach multiple [click.Command]'s to a [click.Group].
+
+    ```python
+    import click
+    from rats import cli
+
+    cli.attach(
+        click.Group("my-cli"),
+        click.Command("command-1"),
+        click.Command("command-2"),
+    )
+    ```
+
+    Args:
+        group: The [click.Group] we want to build.
+        command: A [click.Command] to attach to the provided group.
+        *commands: Any number of additional [click.Command]'s to attach.
+
+    Returns: The input [click.Group][] with all of the commands attached.
+    """
+    group.add_command(command)
+    for c in commands:
+        group.add_command(c)

rats/cli/_plugin.py

@@ -1,61 +1,42 @@
-import click
+import os
+import sys
+from collections.abc import Mapping
+from pathlib import Path
+from typing import final
 
-from ._container import Container
+from rats import apps
 
+from ._command import Command
 
-def create_group(group: click.Group, container: Container) -> click.Group:
-    """
-    A simple shortcut to create a [click.Group][] with commands provided by `rats.cli.Container`'s.
 
-    ```python
-    import click
-    from rats import cli
+@apps.autoscope
+class PluginConfigs:
+    """Service IDs provided and used by [rats.cli.PluginContainer][]."""
 
+    COMMAND = apps.ServiceId[Command]("command")
+    CWD = apps.ServiceId[str]("cwd")
+    ARGV = apps.ServiceId[tuple[str, ...]]("argv")
+    ENV = apps.ServiceId[Mapping[str, str]]("env")
 
-    class Example(cli.Container):
-        @cli.command()
-        def my_command(self) -> None:
-            print("hello, world. run me with `my-cli my-command`.")
 
+@final
+class PluginContainer(apps.Container, apps.PluginMixin):
+    @apps.service(PluginConfigs.COMMAND)
+    def _command(self) -> Command:
+        return Command(
+            cwd=self._app.get(PluginConfigs.CWD),
+            argv=self._app.get(PluginConfigs.ARGV),
+            env=self._app.get(PluginConfigs.ENV),
+        )
 
-    if __name__ == "__main__":
-        cli.create_group(click.Group("my-cli"), Example()).main()
-    ```
+    @apps.fallback_service(PluginConfigs.CWD)
+    def _cwd(self) -> str:
+        return str(Path.cwd().resolve())
 
-    Args:
-        group: The [click.Group][] commands will be added to.
-        container: The [rats.cli.Container][] instance to attach commands from
-    """
-    container.attach(group)
-    return group
+    @apps.fallback_service(PluginConfigs.ARGV)
+    def _argv(self) -> tuple[str, ...]:
+        return tuple(sys.argv)
 
-
-def attach(
-    group: click.Group,
-    command: click.Command | click.Group,
-    *commands: click.Command | click.Group,
-) -> None:
-    """
-    Convenience function to attach multiple [click.Command]'s to a [click.Group].
-
-    ```python
-    import click
-    from rats import cli
-
-    cli.attach(
-        click.Group("my-cli"),
-        click.Command("command-1"),
-        click.Command("command-2"),
-    )
-    ```
-
-    Args:
-        group: The [click.Group] we want to build.
-        command: A [click.Command] to attach to the provided group.
-        *commands: Any number of additional [click.Command]'s to attach.
-
-    Returns: The input [click.Group][] with all of the commands attached.
-    """
-    group.add_command(command)
-    for c in commands:
-        group.add_command(c)
+    @apps.fallback_service(PluginConfigs.ENV)
+    def _env(self) -> Mapping[str, str]:
+        return dict(os.environ)

{rats_apps-0.8.0.dev20250415093554.dist-info → rats_apps-0.9.0.dev20250415195703.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rats-apps
-Version: 0.8.0.dev20250415093554
+Version: 0.9.0.dev20250415195703
 Summary: research analysis tools for building applications
 License: MIT
 Keywords: pipelines,machine learning,research

{rats_apps-0.8.0.dev20250415093554.dist-info → rats_apps-0.9.0.dev20250415195703.dist-info}/RECORD

@@ -7,7 +7,7 @@ rats/app_context/_collection.py,sha256=5-Nog2Du2v0tAZbhsbpg3vMjMcZ--hSZ4acWM2HTl
 rats/app_context/_container.py,sha256=YkNG25jngfN_064jv8fZmKW1FSuL6RRJAp9F_hm2NZg,2954
 rats/app_context/_context.py,sha256=VUm-cg2WKtFU2VvIJI8OmTdRRoDLXeWPBYu_ynpUjlY,1599
 rats/app_context/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rats/apps/__init__.py,sha256=4dzcE7MZTtZD5NA-pnzQbElABUxUsepf3GknBbXjfwc,1974
+rats/apps/__init__.py,sha256=BlI19Ko9nKjkHd7962P8IHgnqZxL5XAtI4aiXjq5sHc,2012
 rats/apps/_annotations.py,sha256=6M_M7K8haNVda0Tx02EpFf3s9EjnWYacNMjTIkNEdRU,4617
 rats/apps/_app_containers.py,sha256=ygZL0NM-fSRSemFddBsVMwcmSQw07sbb7bIqWTr-_yU,6147
 rats/apps/_composite_container.py,sha256=FdpmH_xIly6LxNZrA_nZCznukptjVLXttXTMtf_tnv8,695
@@ -21,12 +21,14 @@ rats/apps/_runtimes.py,sha256=yzWPVbY0I-orRRN23on-iEX8Bo0BqoRiYeR3dwcBlGg,2592
 rats/apps/_scoping.py,sha256=6C2-ID22cCPR9Cbexf3CvCF3o9F_7ieURbwqkf6DI68,1360
 rats/apps/_static_container.py,sha256=KH4AwRMX5QPIwYrD9W_HayIpQIrbVn7clEMx44LFAGc,2113
 rats/apps/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rats/cli/__init__.py,sha256=0VDmmNP4JOW-hNjufYwO-e38kLpquWb_fo95geuNv5w,564
+rats/cli/__init__.py,sha256=zMywV-4vqbtlobIoMItwbxxdvYGC20wiGU2TKm3II2A,714
 rats/cli/__main__.py,sha256=WeldAKjA3Kmz9ZRnZVd3G8Ud66Y_gSRDLIPNE1JyhV0,1418
 rats/cli/_annotations.py,sha256=-B2Y1bYjPbeTNTBMZzMdAU92qu9AyutKHN_NdFy-xhA,2964
-rats/cli/_app.py,sha256=4z2jiRHafCAN7S-cbMhfQJhLGwl6ljFS3r6P1COgR00,1454
+rats/cli/_click_app.py,sha256=4z2jiRHafCAN7S-cbMhfQJhLGwl6ljFS3r6P1COgR00,1454
+rats/cli/_command.py,sha256=kyU3UqqF9aiTTaFvlQFBKDLXvArQS1QgjoQqlMbKzok,597
 rats/cli/_container.py,sha256=FIQBqi9PTNpE2P52qkfGET51BczdD-JvcWXLTjCNPDI,3512
-rats/cli/_plugin.py,sha256=BNmgWVquQUEqJAYsed_l8vLnlLP7u3XC1TDyEFI1AiU,1552
+rats/cli/_functions.py,sha256=BNmgWVquQUEqJAYsed_l8vLnlLP7u3XC1TDyEFI1AiU,1552
+rats/cli/_plugin.py,sha256=o-pmEqU6mVH3QoRfRBrbG-XRTWCzt6pLKtSV3-5VSx0,1144
 rats/cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rats/logs/__init__.py,sha256=sizLa6JbqekhJGKDyRZUUQvTuqiJx6yxwA5jT-tDQck,152
 rats/logs/_app.py,sha256=TF6rfQXQfaHd3AFW2anAoAGaxzU31kqJMoKkjuBtbF0,1617
@@ -40,6 +42,6 @@ rats_e2e/apps/inputs/_app.py,sha256=FiaLgOZc-d1ryKSwKnL5XBNGcOP1bHbxxeMJqoU_RJg,
 rats_e2e/apps/minimal/__init__.py,sha256=bUR6Oexx6Jsouxor0cL9emXoVha4cm3WqyhU1pgchsI,521
 rats_e2e/apps/minimal/__main__.py,sha256=Mf-a2iQKTTgh9hMd6AeuzmU9araMIyf1AtdWkh_L07E,117
 rats_e2e/apps/minimal/_app.py,sha256=CQ09LVTNRarz7Pb1wiSuNHrZ_2KGcgH8nUqy4BjxMUY,849
-rats_apps-0.8.0.dev20250415093554.dist-info/METADATA,sha256=OiNdQ0fuywHWMjkvsPzyjkmANLdbfbiA25kaAdVYpqU,866
-rats_apps-0.8.0.dev20250415093554.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-rats_apps-0.8.0.dev20250415093554.dist-info/RECORD,,
+rats_apps-0.9.0.dev20250415195703.dist-info/METADATA,sha256=3flAxhmKtt4SzQvB7bBwIjgURpVwjieE2m2N-w6Oh0U,866
+rats_apps-0.9.0.dev20250415195703.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+rats_apps-0.9.0.dev20250415195703.dist-info/RECORD,,