plain 0.27.0__py3-none-any.whl → 0.29.0__py3-none-any.whl

plain/__main__.py

@@ -1,4 +1,4 @@
-from .cli import cli
+from .cli.core import cli
 
 # Make the CLI available as `python -m plain`
 if __name__ == "__main__":

plain/cli/README.md

@@ -99,19 +99,3 @@ then any commands you defined.
 $ plain <pkg> hello
 Hello, world!
 ```
-
-### Add CLI commands to published packages
-
-Some packages, like [plain-dev](https://plainframework.com/docs/plain-dev/),
-never show up in `INSTALLED_PACKAGES` but still have CLI commands.
-These are detected via Python entry points.
-
-An example with `pyproject.toml` and UV:
-
-```toml
-# pyproject.toml
-[project.entry-points."plain.cli"]
-"dev" = "plain.dev:cli"
-"pre-commit" = "plain.dev.precommit:cli"
-"contrib" = "plain.dev.contribute:cli"
-```

plain/cli/__init__.py

@@ -1,3 +1,3 @@
-from .cli import cli
+from .registry import register_cli
 
-__all__ = ["cli"]
+__all__ = ["register_cli"]

plain/cli/{cli.py → core.py}

@@ -1,4 +1,3 @@
-import importlib
 import os
 import shutil
 import subprocess
@@ -6,7 +5,6 @@ import sys
 import tomllib
 import traceback
 from importlib.metadata import entry_points
-from importlib.util import find_spec
 from pathlib import Path
 
 import click
@@ -20,7 +18,7 @@ from plain.packages import packages_registry
 from plain.utils.crypto import get_random_string
 
 from .formatting import PlainContext
-from .packages import EntryPointGroup, InstalledPackagesGroup
+from .registry import cli_registry
 
 
 @click.group()
@@ -500,25 +498,21 @@ def urls(flat):
         print_tree(resolver.url_patterns)
 
 
-class AppCLIGroup(click.Group):
+class CLIRegistryGroup(click.Group):
     """
-    Loads app.cli if it exists as `plain app`
+    Click Group that exposes commands from the CLI registry.
     """
 
-    MODULE_NAME = "app.cli"
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        cli_registry.import_modules()
 
     def list_commands(self, ctx):
-        if find_spec(self.MODULE_NAME):
-            return ["app"]
-        else:
-            return []
+        return sorted(cli_registry.get_commands().keys())
 
     def get_command(self, ctx, name):
-        if name != "app":
-            return
-
-        cli = importlib.import_module(self.MODULE_NAME)
-        return cli.cli
+        commands = cli_registry.get_commands()
+        return commands.get(name)
 
 
 class PlainCommandCollection(click.CommandCollection):
@@ -531,9 +525,7 @@ class PlainCommandCollection(click.CommandCollection):
             plain.runtime.setup()
 
             sources = [
-                InstalledPackagesGroup(),
-                EntryPointGroup(),
-                AppCLIGroup(),
+                CLIRegistryGroup(),
                 plain_cli,
             ]
         except plain.runtime.AppPathNotFound:
@@ -545,7 +537,6 @@ class PlainCommandCollection(click.CommandCollection):
             )
 
             sources = [
-                EntryPointGroup(),
                 plain_cli,
             ]
         except ImproperlyConfigured as e:

plain/cli/registry.py

@@ -0,0 +1,62 @@
+from importlib import import_module
+from importlib.util import find_spec
+
+from plain.packages import packages_registry
+
+
+class CLIRegistry:
+    def __init__(self):
+        self._commands = {}
+
+    def register_command(self, cmd, name):
+        """
+        Register a CLI command or group with the specified name.
+        """
+        self._commands[name] = cmd
+
+    def import_modules(self):
+        """
+        Import modules from installed packages and app to trigger registration.
+        """
+        # Import from installed packages
+        for package_config in packages_registry.get_package_configs():
+            import_name = f"{package_config.name}.cli"
+            try:
+                import_module(import_name)
+            except ModuleNotFoundError:
+                pass
+
+        # Import from app
+        import_name = "app.cli"
+        if find_spec(import_name):
+            try:
+                import_module(import_name)
+            except ModuleNotFoundError:
+                pass
+
+    def get_commands(self):
+        """
+        Get all registered commands.
+        """
+        return self._commands
+
+
+cli_registry = CLIRegistry()
+
+
+def register_cli(name):
+    """
+    Register a CLI command or group with the given name.
+
+    Usage:
+        @register_cli("users")
+        @click.group()
+        def users_cli():
+            pass
+    """
+
+    def wrapper(cmd):
+        cli_registry.register_command(cmd, name)
+        return cmd
+
+    return wrapper

plain/packages/config.py

@@ -10,8 +10,6 @@ CONFIG_MODULE_NAME = "config"
 class PackageConfig:
     """Class representing a Plain application and its configuration."""
 
-    migrations_module = "migrations"
-
     def __init__(self, name, *, label=""):
         # Full Python path to the application e.g. 'plain.admin.admin'.
         self.name = name

plain/runtime/__init__.py

@@ -51,9 +51,24 @@ def setup():
     packages_registry.populate(settings.INSTALLED_PACKAGES)
 
 
+class SettingsReference(str):
+    """
+    String subclass which references a current settings value. It's treated as
+    the value in memory but serializes to a settings.NAME attribute reference.
+    """
+
+    def __new__(self, setting_name):
+        value = getattr(settings, setting_name)
+        return str.__new__(self, value)
+
+    def __init__(self, setting_name):
+        self.setting_name = setting_name
+
+
 __all__ = [
     "setup",
     "settings",
+    "SettingsReference",
     "APP_PATH",
     "__version__",
 ]

plain/runtime/user_settings.py

@@ -298,16 +298,3 @@ class SettingDefinition:
 
     def __str__(self):
         return f"SettingDefinition(name={self.name}, value={self.value}, source={self.source})"
-
-
-class SettingsReference(str):
-    """
-    String subclass which references a current settings value. It's treated as
-    the value in memory but serializes to a settings.NAME attribute reference.
-    """
-
-    def __new__(self, value, setting_name):
-        return str.__new__(self, value)
-
-    def __init__(self, value, setting_name):
-        self.setting_name = setting_name

{plain-0.27.0.dist-info → plain-0.29.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain
-Version: 0.27.0
+Version: 0.29.0
 Summary: A web framework for building products with Python.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE

{plain-0.27.0.dist-info → plain-0.29.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 plain/README.md,sha256=nW3Ioj3IxPb6aoCGaFMN2n7Cd7LMx0s8Lph6pMkKnh4,8
-plain/__main__.py,sha256=BiYbF-txGNbeRqp_CHQ9EZ_bCbbKq2iw51Z8RRUgIBY,105
+plain/__main__.py,sha256=GK39854Lc_LO_JP8DzY9Y2MIQ4cQEl7SXFJy244-lC8,110
 plain/debug.py,sha256=abPkJY4aSbBYGEYSZST_ZY3ohXPGDdz9uWQBYRqfd3M,730
 plain/exceptions.py,sha256=Z9cbPE5im_Y-bjVq8cqC85gBoqOr80rLFG5wTKixrwE,5894
 plain/json.py,sha256=McJdsbMT1sYwkGRG--f2NSZz0hVXPMix9x3nKaaak2o,1262
@@ -14,12 +14,12 @@ plain/assets/finders.py,sha256=rhkHG5QW3H3IlBGHB5WJf9J6VTdDWgUC0qEs6u2Z4RQ,1233
 plain/assets/fingerprints.py,sha256=1NKAnnXVlncY5iimXztr0NL3RIjBKsNlZRIe6nmItJc,931
 plain/assets/urls.py,sha256=lW7VzKNzTKY11JqbszhJQ1Yy0HtljZlsHDnnkTPdLOM,992
 plain/assets/views.py,sha256=z7noLzoelGw_8-MXcvGKjXs9KZ43Tivmy2TIfnZIpgw,9253
-plain/cli/README.md,sha256=CwrqK-NV5ZK1JDYfR4480uHXmJEyxWF6jA_K40_llE8,2366
-plain/cli/__init__.py,sha256=9ByBOIdM8DebChjNz-RH2atdz4vWe8somlwNEsbhwh4,40
-plain/cli/cli.py,sha256=NbkgCiJk-QaAGUBU7Dne37B_Xv3sZPcGyA5IBG4nFIo,18420
+plain/cli/README.md,sha256=t3k4jmSK0QFALO3bVWTUsJC09KhY4CvauStTvVLLUdI,1922
+plain/cli/__init__.py,sha256=6w9T7K2WrPwh6DcaMb2oNt_CWU6Bc57nUTO2Bt1p38Y,63
+plain/cli/core.py,sha256=5_4hsXxzk2ocIez5BBY2YoYtFUdyfKks-2twpqy-zoU,18256
 plain/cli/formatting.py,sha256=1hZH13y1qwHcU2K2_Na388nw9uvoeQH8LrWL-O9h8Yc,2207
-plain/cli/packages.py,sha256=GLvDgQ1o93tSHae_B2i0YNimpt3LGu4QMQpFYrO48d8,2758
 plain/cli/print.py,sha256=XraUYrgODOJquIiEv78wSCYGRBplHXtXSS9QtFG5hqY,217
+plain/cli/registry.py,sha256=yKVMSDjW8g10nlV9sPXFGJQmhC_U-k4J4kM7N2OQVLA,1467
 plain/cli/startup.py,sha256=3LIz9JrIZoF52Sa0j0SCypQwEaBDkhvuGaBdtiQLr5Q,680
 plain/csrf/README.md,sha256=RXMWMtHmzf30gVVNOfj0kD4xlSqFIPgJh-n7dIciaEM,163
 plain/csrf/middleware.py,sha256=FYhT7KPJ664Sm0nKjeej1OIXalvVTYiotQX3ytI0dfY,17417
@@ -61,7 +61,7 @@ plain/logs/loggers.py,sha256=iz9SYcwP9w5QAuwpULl48SFkVyJuuMoQ_fdLgdCHpNg,2121
 plain/logs/utils.py,sha256=9UzdCCQXJinGDs71Ngw297mlWkhgZStSd67ya4NOW98,1257
 plain/packages/README.md,sha256=Vq1Nw3mmEmZ2IriQavuVi4BjcQC2nb8k7YIbnm8QjIg,799
 plain/packages/__init__.py,sha256=OpQny0xLplPdPpozVUUkrW2gB-IIYyDT1b4zMzOcCC4,160
-plain/packages/config.py,sha256=Gmu7QW4Z3Cx9_d7N2D5o7t292t7vAOE8aL-3yO7sGqc,3327
+plain/packages/config.py,sha256=uOO7uE9jajqDhqFBafJQ3ZnfLmQiHikTzOSJ1AlP7ZM,3289
 plain/packages/registry.py,sha256=Aklno7y7UrBZlidtUR_YO3B5xqF46UbUtalReNcYHm8,7937
 plain/preflight/README.md,sha256=-PKVd0RBMh4ROiMkegPS2PgvT1Kq9qqN1KfNkmUSdFc,177
 plain/preflight/__init__.py,sha256=H-TNRvaddPtOGmv4RXoc1fxDV1AOb7_K3u7ECF8mV58,607
@@ -71,9 +71,9 @@ plain/preflight/registry.py,sha256=7s7f_iEwURzv-Ye515P5lJWcHltd5Ca2fsX1Wpbf1wQ,2
 plain/preflight/security.py,sha256=sNpv5AHobPcaO48cOUGRNe2EjusTducjY8vyShR8EhI,2645
 plain/preflight/urls.py,sha256=OSTLvCpftAD_8VbQ0V3p1CTPlRRwtlnXVBZeWgr7l2k,2881
 plain/runtime/README.md,sha256=Q8VVO7JRGuYrDxzuYL6ptoilhclbecxKzpRXKgbWGkU,2061
-plain/runtime/__init__.py,sha256=FyGTIx-633bNPrPv8IBarBKvu_XspbCiqj8W8eOd_mA,1528
+plain/runtime/__init__.py,sha256=o2RVETiL8U0lMFBpbtfnxflhw_4MFllMV6CEpX3RqZs,1965
 plain/runtime/global_settings.py,sha256=SfOhwzpZe2zpNqSpdx3hHgCN89xdbW9KJVR4KJfS_Gk,5498
-plain/runtime/user_settings.py,sha256=r6uQ-h0QxX3gSB_toJJekEbSikXXdNSb8ykUtwGTpdY,11280
+plain/runtime/user_settings.py,sha256=uRHHVfzUvHon91_fOKj7K2WaBYwJ1gCPLfeXqKj5CTs,10902
 plain/signals/README.md,sha256=cd3tKEgH-xc88CUWyDxl4-qv-HBXx8VT32BXVwA5azA,230
 plain/signals/__init__.py,sha256=eAs0kLqptuP6I31dWXeAqRNji3svplpAV4Ez6ktjwXM,131
 plain/signals/dispatch/__init__.py,sha256=FzEygqV9HsM6gopio7O2Oh_X230nA4d5Q9s0sUjMq0E,292
@@ -134,8 +134,8 @@ plain/views/forms.py,sha256=RhlaUcZCkeqokY_fvv-NOS-kgZAG4XhDLOPbf9K_Zlc,2691
 plain/views/objects.py,sha256=g5Lzno0Zsv0K449UpcCtxwCoO7WMRAWqKlxxV2V0_qg,8263
 plain/views/redirect.py,sha256=9zHZgKvtSkdrMX9KmsRM8hJTPmBktxhc4d8OitbuniI,1724
 plain/views/templates.py,sha256=cBkFNCSXgVi8cMqQbhsqJ4M_rIQYVl8cUvq9qu4YIes,1951
-plain-0.27.0.dist-info/METADATA,sha256=5bkOqMEQNCnkyEx011gMDQNmLjzncCOXJ2zPGti0HHo,319
-plain-0.27.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain-0.27.0.dist-info/entry_points.txt,sha256=DHHprvufgd7xypiBiqMANYRnpJ9xPPYhYbnPGwOkWqE,40
-plain-0.27.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
-plain-0.27.0.dist-info/RECORD,,
+plain-0.29.0.dist-info/METADATA,sha256=ONh32xHnWT3cqrGSkuvVsTvkci_KvLkY95bBGf3GW2Y,319
+plain-0.29.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain-0.29.0.dist-info/entry_points.txt,sha256=1Ys2lsSeMepD1vz8RSrJopna0RQfUd951vYvCRsvl6A,45
+plain-0.29.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
+plain-0.29.0.dist-info/RECORD,,

plain-0.29.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+plain = plain.cli.core:cli

plain/cli/packages.py

@@ -1,94 +0,0 @@
-import importlib
-from importlib.metadata import entry_points
-from importlib.util import find_spec
-
-import click
-
-from plain.packages import packages_registry
-
-
-class InstalledPackagesGroup(click.Group):
-    """
-    Packages in INSTALLED_PACKAGES with a cli.py module
-    will be discovered automatically.
-    """
-
-    PLAIN_APPS_PREFIX = "plain."
-    APP_PREFIX = "app."
-    MODULE_NAME = "cli"
-
-    def list_commands(self, ctx):
-        command_names = []
-
-        # Get installed packages with a cli.py module
-        for app in packages_registry.get_package_configs():
-            if not find_spec(f"{app.name}.{self.MODULE_NAME}"):
-                continue
-
-            cli_name = app.name
-
-            # Change plain.{pkg} to just {pkg}
-            if cli_name.startswith(self.PLAIN_APPS_PREFIX):
-                cli_name = cli_name[len(self.PLAIN_APPS_PREFIX) :]
-
-            # Change app.{pkg} to just {pkg}
-            if cli_name.startswith(self.APP_PREFIX):
-                cli_name = cli_name[len(self.APP_PREFIX) :]
-
-            if cli_name in command_names:
-                raise ValueError(
-                    f"Duplicate command name {cli_name} found in installed packages."
-                )
-
-            command_names.append(cli_name)
-
-        return command_names
-
-    def get_command(self, ctx, name):
-        # Try it as plain.x, app.x, and just x (we don't know ahead of time which it is)
-        for n in [self.PLAIN_APPS_PREFIX + name, self.APP_PREFIX + name, name]:
-            try:
-                if not find_spec(n):
-                    # plain.<name> doesn't exist at all
-                    continue
-            except ModuleNotFoundError:
-                continue
-
-            try:
-                if not find_spec(f"{n}.{self.MODULE_NAME}"):
-                    continue
-            except ModuleNotFoundError:
-                continue
-
-            cli = importlib.import_module(f"{n}.{self.MODULE_NAME}")
-
-            # Get the app's cli.py group
-            try:
-                return cli.cli
-            except AttributeError:
-                continue
-
-
-class EntryPointGroup(click.Group):
-    """
-    Python packages can be added to the Plain CLI
-    via the plain_cli entrypoint in their setup.py.
-
-    This is intended for packages that don't go in INSTALLED_PACKAGES.
-    """
-
-    ENTRYPOINT_NAME = "plain.cli"
-
-    def list_commands(self, ctx):
-        rv = []
-
-        for entry_point in entry_points().select(group=self.ENTRYPOINT_NAME):
-            rv.append(entry_point.name)
-
-        rv.sort()
-        return rv
-
-    def get_command(self, ctx, name):
-        for entry_point in entry_points().select(group=self.ENTRYPOINT_NAME):
-            if entry_point.name == name:
-                return entry_point.load()

plain-0.27.0.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-plain = plain.cli:cli