plain 0.37.0__py3-none-any.whl → 0.39.0__py3-none-any.whl

plain/assets/README.md

@@ -44,6 +44,22 @@ By default, this [generates "fingerprinted" and compressed versions of the asset
 
 The purpose of fingerprinting the assets is to allow the browser to cache them indefinitely. When the content of the file changes, the fingerprint will change, and the browser will use the newer file. This cuts down on the number of requests that your app has to handle related to assets.
 
+## Using `AssetView` directly
+
+In some situations you may want to use the `AssetView` at a custom URL, for example to serve a `favicon.ico`. You can do this quickly by using the `AssetView.as_view()` class method.
+
+```python
+from plain.assets.views import AssetView
+from plain.urls import path, Router
+
+
+class AppRouter(Router):
+    namespace = ""
+    urls = [
+        path("favicon.ico", AssetView.as_view(asset_path="favicon.ico")),
+    ]
+```
+
 ## FAQs
 
 ### How do you reference assets in Python code?

plain/chores/__init__.py

@@ -0,0 +1,3 @@
+from .registry import register_chore
+
+__all__ = ["register_chore"]

plain/chores/registry.py

@@ -0,0 +1,79 @@
+from importlib import import_module
+from importlib.util import find_spec
+
+from plain.packages import packages_registry
+
+
+class Chore:
+    def __init__(self, *, group, func):
+        self.group = group
+        self.func = func
+        self.name = f"{group}.{func.__name__}"
+        self.description = func.__doc__.strip() if func.__doc__ else ""
+
+    def __str__(self):
+        return self.name
+
+    def run(self):
+        """
+        Run the chore.
+        """
+        return self.func()
+
+
+class ChoresRegistry:
+    def __init__(self):
+        self._chores = {}
+
+    def register_chore(self, chore):
+        """
+        Register a chore with the specified name.
+        """
+        self._chores[chore.func] = chore
+
+    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}.chores"
+            try:
+                import_module(import_name)
+            except ModuleNotFoundError:
+                pass
+
+        # Import from app
+        import_name = "app.chores"
+        if find_spec(import_name):
+            try:
+                import_module(import_name)
+            except ModuleNotFoundError:
+                pass
+
+    def get_chores(self):
+        """
+        Get all registered chores.
+        """
+        return list(self._chores.values())
+
+
+chores_registry = ChoresRegistry()
+
+
+def register_chore(group):
+    """
+    Register a chore with a given group.
+
+    Usage:
+        @register_chore("clear_expired")
+        def clear_expired():
+            pass
+    """
+
+    def wrapper(func):
+        chore = Chore(group=group, func=func)
+        chores_registry.register_chore(chore)
+        return func
+
+    return wrapper

plain/cli/chores.py

@@ -0,0 +1,91 @@
+import logging
+import sys
+
+import click
+
+logger = logging.getLogger("plain.chores")
+
+
+@click.group()
+def chores():
+    """Routine maintenance tasks"""
+    pass
+
+
+@chores.command("list")
+@click.option("--group", default=None, type=str, help="Group to run", multiple=True)
+@click.option(
+    "--name", default=None, type=str, help="Name of the chore to run", multiple=True
+)
+def list_chores(group, name):
+    """
+    List all registered chores.
+    """
+    from plain.chores.registry import chores_registry
+
+    chores_registry.import_modules()
+
+    if group or name:
+        chores = [
+            chore
+            for chore in chores_registry.get_chores()
+            if (chore.group in group or not group) and (chore.name in name or not name)
+        ]
+    else:
+        chores = chores_registry.get_chores()
+
+    for chore in chores:
+        click.secho(f"{chore}", bold=True, nl=False)
+        if chore.description:
+            click.echo(f": {chore.description}")
+        else:
+            click.echo("")
+
+
+@chores.command("run")
+@click.option("--group", default=None, type=str, help="Group to run", multiple=True)
+@click.option(
+    "--name", default=None, type=str, help="Name of the chore to run", multiple=True
+)
+@click.option(
+    "--dry-run", is_flag=True, help="Show what would be done without executing"
+)
+def run_chores(group, name, dry_run):
+    """
+    Run the specified chores.
+    """
+    from plain.chores.registry import chores_registry
+
+    chores_registry.import_modules()
+
+    if group or name:
+        chores = [
+            chore
+            for chore in chores_registry.get_chores()
+            if (chore.group in group or not group) and (chore.name in name or not name)
+        ]
+    else:
+        chores = chores_registry.get_chores()
+
+    chores_failed = []
+
+    for chore in chores:
+        click.echo(f"{chore.name}:", nl=False)
+        if dry_run:
+            click.echo(" (dry run)", fg="yellow")
+        else:
+            try:
+                result = chore.run()
+            except Exception:
+                click.secho(" Failed", fg="red")
+                chores_failed.append(chore)
+                logger.exception(f"Error running chore {chore.name}")
+                continue
+
+            if result is None:
+                click.secho(" Done", fg="green")
+            else:
+                click.secho(f" {result}", fg="green")
+
+    if chores_failed:
+        sys.exit(1)

plain/cli/core.py

@@ -7,6 +7,7 @@ import plain.runtime
 from plain.exceptions import ImproperlyConfigured
 
 from .build import build
+from .chores import chores
 from .docs import docs
 from .formatting import PlainContext
 from .preflight import preflight_checks
@@ -26,6 +27,7 @@ def plain_cli():
 plain_cli.add_command(docs)
 plain_cli.add_command(preflight_checks)
 plain_cli.add_command(create)
+plain_cli.add_command(chores)
 plain_cli.add_command(build)
 plain_cli.add_command(utils)
 plain_cli.add_command(urls)

plain/cli/docs.py

@@ -8,80 +8,6 @@ import click
 from plain.packages import packages_registry
 
 
-def symbolicate(file_path: Path):
-    if "internal" in str(file_path).split("/"):
-        return ""
-
-    source = file_path.read_text()
-
-    parsed = ast.parse(source)
-
-    def should_skip(node):
-        if isinstance(node, ast.ClassDef | ast.FunctionDef):
-            if any(
-                isinstance(d, ast.Name) and d.id == "internalcode"
-                for d in node.decorator_list
-            ):
-                return True
-            if node.name.startswith("_"):  # and not node.name.endswith("__"):
-                return True
-        elif isinstance(node, ast.Assign):
-            for target in node.targets:
-                if (
-                    isinstance(target, ast.Name) and target.id.startswith("_")
-                    # and not target.id.endswith("__")
-                ):
-                    return True
-        return False
-
-    def process_node(node, indent=0):
-        lines = []
-        prefix = "    " * indent
-
-        if should_skip(node):
-            return []
-
-        if isinstance(node, ast.ClassDef):
-            decorators = [
-                f"{prefix}@{ast.unparse(d)}"
-                for d in node.decorator_list
-                if not (isinstance(d, ast.Name) and d.id == "internal")
-            ]
-            lines.extend(decorators)
-            bases = [ast.unparse(base) for base in node.bases]
-            lines.append(f"{prefix}class {node.name}({', '.join(bases)})")
-            # if ast.get_docstring(node):
-            #     lines.append(f'{prefix}    """{ast.get_docstring(node)}"""')
-            for child in node.body:
-                child_lines = process_node(child, indent + 1)
-                if child_lines:
-                    lines.extend(child_lines)
-            # if not has_body:
-            #     lines.append(f"{prefix}    pass")
-
-        elif isinstance(node, ast.FunctionDef):
-            decorators = [f"{prefix}@{ast.unparse(d)}" for d in node.decorator_list]
-            lines.extend(decorators)
-            args = ast.unparse(node.args)
-            lines.append(f"{prefix}def {node.name}({args})")
-            # if ast.get_docstring(node):
-            #     lines.append(f'{prefix}    """{ast.get_docstring(node)}"""')
-            # lines.append(f"{prefix}    pass")
-
-        elif isinstance(node, ast.Assign):
-            for target in node.targets:
-                if isinstance(target, ast.Name):
-                    lines.append(f"{prefix}{target.id} = {ast.unparse(node.value)}")
-
-        return lines
-
-    symbolicated_lines = []
-    for node in parsed.body:
-        symbolicated_lines.extend(process_node(node))
-
-    return "\n".join(symbolicated_lines)
-
-
 @click.command()
 @click.option("--llm", "llm", is_flag=True)
 @click.option("--open")
@@ -92,57 +18,18 @@ def docs(module, llm, open):
         sys.exit(1)
 
     if llm:
-        click.echo(
-            "Below is all of the documentation and abbreviated source code for the Plain web framework. "
-            "Your job is to read and understand it, and then act as the Plain Framework Assistant and "
-            "help the developer accomplish whatever they want to do next."
-            "\n\n---\n\n"
-        )
+        paths = [Path(__file__).parent.parent]
 
-        docs = set()
-        sources = set()
-
-        # Get everything for Plain core
-        for path in Path(__file__).parent.parent.glob("**/*.md"):
-            docs.add(path)
-        for source in Path(__file__).parent.parent.glob("**/*.py"):
-            sources.add(source)
-
-        # Find every *.md file in the other plain packages and installed apps
         for package_config in packages_registry.get_package_configs():
             if package_config.name.startswith("app."):
                 # Ignore app packages for now
                 continue
 
-            for path in Path(package_config.path).glob("**/*.md"):
-                docs.add(path)
-
-            for source in Path(package_config.path).glob("**/*.py"):
-                sources.add(source)
-
-        docs = sorted(docs)
-        sources = sorted(sources)
-
-        for doc in docs:
-            try:
-                display_path = doc.relative_to(Path.cwd())
-            except ValueError:
-                display_path = doc.absolute()
-            click.secho(f"<Docs: {display_path}>", fg="yellow")
-            click.echo(doc.read_text())
-            click.secho(f"</Docs: {display_path}>", fg="yellow")
-            click.echo()
+            paths.append(Path(package_config.path))
 
-        for source in sources:
-            if symbolicated := symbolicate(source):
-                try:
-                    display_path = source.relative_to(Path.cwd())
-                except ValueError:
-                    display_path = source.absolute()
-                click.secho(f"<Source: {display_path}>", fg="yellow")
-                click.echo(symbolicated)
-                click.secho(f"</Source: {display_path}>", fg="yellow")
-                click.echo()
+        source_docs = LLMDocs(paths)
+        source_docs.load()
+        source_docs.print()
 
         click.secho(
             "That's everything! Copy this into your AI tool of choice.",
@@ -209,3 +96,158 @@ def docs(module, llm, open):
                     yield "\n"
 
             click.echo_via_pager(_iterate_markdown(readme_path.read_text()))
+
+
+class LLMDocs:
+    preamble = (
+        "Below is all of the documentation and abbreviated source code for the Plain web framework. "
+        "Your job is to read and understand it, and then act as the Plain Framework Assistant and "
+        "help the developer accomplish whatever they want to do next."
+        "\n\n---\n\n"
+    )
+
+    def __init__(self, paths):
+        self.paths = paths
+
+    def load(self):
+        self.docs = set()
+        self.sources = set()
+
+        for path in self.paths:
+            if path.is_dir():
+                self.docs.update(path.glob("**/*.md"))
+                self.sources.update(path.glob("**/*.py"))
+            elif path.suffix == ".py":
+                self.sources.add(path)
+            elif path.suffix == ".md":
+                self.docs.add(path)
+
+        # Exclude "migrations" code from plain apps, except for plain/models/migrations
+        self.docs = {
+            doc
+            for doc in self.docs
+            if not (
+                "/migrations/" in str(doc)
+                and "/plain/models/migrations/" not in str(doc)
+            )
+        }
+        self.sources = {
+            source
+            for source in self.sources
+            if not (
+                "/migrations/" in str(source)
+                and "/plain/models/migrations/" not in str(source)
+            )
+        }
+
+        self.docs = sorted(self.docs)
+        self.sources = sorted(self.sources)
+
+    def display_path(self, path):
+        if "plain" in path.parts:
+            root_index = path.parts.index("plain")
+        elif "plainx" in path.parts:
+            root_index = path.parts.index("plainx")
+        else:
+            raise ValueError("Path does not contain 'plain' or 'plainx'")
+
+        plain_root = Path(*path.parts[: root_index + 1])
+        return path.relative_to(plain_root.parent)
+
+    def print(self, relative_to=None):
+        click.secho(self.preamble, fg="yellow")
+
+        for doc in self.docs:
+            if relative_to:
+                display_path = doc.relative_to(relative_to)
+            else:
+                display_path = self.display_path(doc)
+            click.secho(f"<Docs: {display_path}>", fg="yellow")
+            click.echo(doc.read_text())
+            click.secho(f"</Docs: {display_path}>", fg="yellow")
+            click.echo()
+
+        for source in self.sources:
+            if symbolicated := self.symbolicate(source):
+                if relative_to:
+                    display_path = source.relative_to(relative_to)
+                else:
+                    display_path = self.display_path(source)
+                click.secho(f"<Source: {display_path}>", fg="yellow")
+                click.echo(symbolicated)
+                click.secho(f"</Source: {display_path}>", fg="yellow")
+                click.echo()
+
+    @staticmethod
+    def symbolicate(file_path: Path):
+        if "internal" in str(file_path).split("/"):
+            return ""
+
+        source = file_path.read_text()
+
+        parsed = ast.parse(source)
+
+        def should_skip(node):
+            if isinstance(node, ast.ClassDef | ast.FunctionDef):
+                if any(
+                    isinstance(d, ast.Name) and d.id == "internalcode"
+                    for d in node.decorator_list
+                ):
+                    return True
+                if node.name.startswith("_"):  # and not node.name.endswith("__"):
+                    return True
+            elif isinstance(node, ast.Assign):
+                for target in node.targets:
+                    if (
+                        isinstance(target, ast.Name) and target.id.startswith("_")
+                        # and not target.id.endswith("__")
+                    ):
+                        return True
+            return False
+
+        def process_node(node, indent=0):
+            lines = []
+            prefix = "    " * indent
+
+            if should_skip(node):
+                return []
+
+            if isinstance(node, ast.ClassDef):
+                decorators = [
+                    f"{prefix}@{ast.unparse(d)}"
+                    for d in node.decorator_list
+                    if not (isinstance(d, ast.Name) and d.id == "internalcode")
+                ]
+                lines.extend(decorators)
+                bases = [ast.unparse(base) for base in node.bases]
+                lines.append(f"{prefix}class {node.name}({', '.join(bases)})")
+                # if ast.get_docstring(node):
+                #     lines.append(f'{prefix}    """{ast.get_docstring(node)}"""')
+                for child in node.body:
+                    child_lines = process_node(child, indent + 1)
+                    if child_lines:
+                        lines.extend(child_lines)
+                # if not has_body:
+                #     lines.append(f"{prefix}    pass")
+
+            elif isinstance(node, ast.FunctionDef):
+                decorators = [f"{prefix}@{ast.unparse(d)}" for d in node.decorator_list]
+                lines.extend(decorators)
+                args = ast.unparse(node.args)
+                lines.append(f"{prefix}def {node.name}({args})")
+                # if ast.get_docstring(node):
+                #     lines.append(f'{prefix}    """{ast.get_docstring(node)}"""')
+                # lines.append(f"{prefix}    pass")
+
+            elif isinstance(node, ast.Assign):
+                for target in node.targets:
+                    if isinstance(target, ast.Name):
+                        lines.append(f"{prefix}{target.id} = {ast.unparse(node.value)}")
+
+            return lines
+
+        symbolicated_lines = []
+        for node in parsed.body:
+            symbolicated_lines.extend(process_node(node))
+
+        return "\n".join(symbolicated_lines)

plain/csrf/README.md

@@ -2,13 +2,13 @@
 
 **Cross-Site Request Forgery (CSRF) protection.**
 
-Plain protects against [CSRF attacks](https://en.wikipedia.org/wiki/Cross-site_request_forgery) through a [middleware](middleware.py) that compares the generated `csrftoken` cookie with the CSRF token from the request (either `_csrftoken` in form data or the `X-CSRFToken` header).
+Plain protects against [CSRF attacks](https://en.wikipedia.org/wiki/Cross-site_request_forgery) through a [middleware](middleware.py) that compares the generated `csrftoken` cookie with the CSRF token from the request (either `_csrftoken` in form data or the `CSRF-Token` header).
 
 ## Usage
 
 The `CsrfViewMiddleware` is [automatically installed](../internal/handlers/base.py#BUILTIN_BEFORE_MIDDLEWARE), so you don't need to add it to your `settings.MIDDLEWARE`.
 
-When you use HTML forms, you should include the CSRF token in the form data:
+When you use HTML forms, you should include the CSRF token in the form data via a hidden input:
 
 ```html
 <form method="post">

plain/forms/exceptions.py

@@ -2,7 +2,9 @@ from plain.exceptions import ValidationError
 
 
 class FormFieldMissingError(Exception):
-    pass
+    def __init__(self, field_name):
+        self.field_name = field_name
+        self.message = f'The "{self.field_name}" field is missing from the form data.'
 
 
 __all__ = [

plain/forms/fields.py

@@ -67,23 +67,16 @@ class Field:
         initial=None,
         error_messages=None,
         validators=(),
-        disabled=False,
     ):
         # required -- Boolean that specifies whether the field is required.
         #             True by default.
-        # widget -- A Widget class, or instance of a Widget class, that should
-        #           be used for this Field when displaying it. Each Field has a
-        #           default Widget that it'll use if you don't specify this. In
-        #           most cases, the default widget is TextInput.
         # initial -- A value to use in this Field's initial display. This value
         #            is *not* used as a fallback if data isn't given.
         # error_messages -- An optional dictionary to override the default
         #                   messages that the field will raise.
         # validators -- List of additional validators to use
-        # disabled -- Boolean that specifies whether the field is disabled, that
-        #             is its widget is shown in the form but not editable.
-        self.required, self.initial = required, initial
-        self.disabled = disabled
+        self.required = required
+        self.initial = initial
 
         messages = {}
         for c in reversed(self.__class__.__mro__):
@@ -136,16 +129,10 @@ class Field:
         For most fields, this will simply be data; FileFields need to handle it
         a bit differently.
         """
-        if self.disabled:
-            return initial
         return data
 
     def has_changed(self, initial, data):
         """Return True if data differs from initial."""
-        # Always return False if the field is disabled since self.bound_data
-        # always uses the initial value in this case.
-        if self.disabled:
-            return False
         try:
             data = self.to_python(data)
             if hasattr(self, "_coerce"):
@@ -174,12 +161,17 @@ class Field:
         return result
 
     def value_from_form_data(self, data, files, html_name):
+        # By default, all fields are expected to be present in HTML form data.
         try:
             return data[html_name]
         except KeyError as e:
-            raise FormFieldMissingError(
-                f'The "{html_name}" field is missing from the form data.'
-            ) from e
+            raise FormFieldMissingError(html_name) from e
+
+    def value_from_json_data(self, data, files, html_name):
+        if self.required and html_name not in data:
+            raise FormFieldMissingError(html_name)
+
+        return data.get(html_name, None)
 
 
 class CharField(Field):
@@ -592,11 +584,14 @@ class FileField(Field):
         return initial
 
     def has_changed(self, initial, data):
-        return not self.disabled and data is not None
+        return data is not None
 
     def value_from_form_data(self, data, files, html_name):
         return files.get(html_name)
 
+    def value_from_json_data(self, data, files, html_name):
+        return files.get(html_name)
+
 
 class ImageField(FileField):
     default_validators = [validators.validate_image_file_extension]
@@ -706,8 +701,6 @@ class BooleanField(Field):
             raise ValidationError(self.error_messages["required"], code="required")
 
     def has_changed(self, initial, data):
-        if self.disabled:
-            return False
         # Sometimes data or initial may be a string equivalent of a boolean
         # so we should run it through to_python first to get a boolean value
         return self.to_python(initial) != self.to_python(data)
@@ -729,6 +722,13 @@ class BooleanField(Field):
             "on": True,
         }.get(value)
 
+    def value_from_json_data(self, data, files, html_name):
+        # Boolean fields must be present in the JSON data
+        try:
+            return data[html_name]
+        except KeyError as e:
+            raise FormFieldMissingError(html_name) from e
+
 
 class NullBooleanField(BooleanField):
     """
@@ -883,8 +883,6 @@ class MultipleChoiceField(ChoiceField):
                 )
 
     def has_changed(self, initial, data):
-        if self.disabled:
-            return False
         if initial is None:
             initial = []
         if data is None:
@@ -944,8 +942,6 @@ class JSONField(CharField):
         super().__init__(**kwargs)
 
     def to_python(self, value):
-        if self.disabled:
-            return value
         if value in self.empty_values:
             return None
         elif isinstance(value, list | dict | int | float | JSONString):
@@ -964,8 +960,6 @@ class JSONField(CharField):
             return converted
 
     def bound_data(self, data, initial):
-        if self.disabled:
-            return initial
         if data is None:
             return None
         try:

plain/forms/forms.py

@@ -3,6 +3,7 @@ Form classes
 """
 
 import copy
+import json
 
 from plain.exceptions import NON_FIELD_ERRORS
 from plain.utils.datastructures import MultiValueDict
@@ -57,15 +58,36 @@ class BaseForm:
 
     def __init__(
         self,
-        data=None,
-        files=None,
+        *,
+        request,
         auto_id="id_%s",
         prefix=None,
         initial=None,
     ):
-        self.is_bound = data is not None or files is not None
-        self.data = MultiValueDict() if data is None else data
-        self.files = MultiValueDict() if files is None else files
+        if request.method in ("POST", "PUT", "PATCH"):
+            if request.headers.get("Content-Type") == "application/json":
+                self.data = json.loads(request.body)
+                self.is_json_request = True
+            elif request.headers.get("Content-Type") in [
+                "application/x-www-form-urlencoded",
+                "multipart/form-data",
+            ]:
+                self.data = request.POST
+                self.is_json_request = False
+            else:
+                raise ValueError(
+                    "Unsupported Content-Type. Supported types are "
+                    "'application/json', 'application/x-www-form-urlencoded', "
+                    "and 'multipart/form-data'."
+                )
+        else:
+            self.data = MultiValueDict()
+            self.is_json_request = False
+
+        self.files = request.FILES
+
+        self.is_bound = bool(self.data or self.files)
+
         self._auto_id = auto_id
         if prefix is not None:
             self.prefix = prefix
@@ -224,16 +246,16 @@ class BaseForm:
             # Allow custom parsing from form data/files at the form level
             return getattr(self, f"parse_{html_name}")()
 
-        return field.value_from_form_data(self.data, self.files, html_name)
+        if self.is_json_request:
+            return field.value_from_json_data(self.data, self.files, html_name)
+        else:
+            return field.value_from_form_data(self.data, self.files, html_name)
 
     def _clean_fields(self):
         for name, bf in self._bound_items():
             field = bf.field
 
-            if field.disabled:
-                value = bf.initial
-            else:
-                value = self._field_data_value(bf.field, bf.html_name)
+            value = self._field_data_value(bf.field, bf.html_name)
 
             try:
                 if isinstance(field, FileField):

plain/logs/README.md

@@ -2,7 +2,7 @@
 
 **Logging configuration and utilities.**
 
-In Python, configuring logging can be surprisingly complex. For most use cases, Plain provides a [default configuration](configure.py) that "just works".
+In Python, configuring logging can be surprisingly complex. For most use cases, Plain provides a [default configuration](./configure.py) that "just works".
 
 By default, both the `plain` and `app` loggers are set to the `INFO` level. You can quickly change this by using the `PLAIN_LOG_LEVEL` and `APP_LOG_LEVEL` environment variables.
 

plain/views/README.md

@@ -12,7 +12,7 @@ from plain.views import View
 
 class ExampleView(View):
     def get(self):
-        return "Hello, world!"
+        return "<html><body>Hello, world!</body></html>"
 ```
 
 ## HTTP methods -> class methods
@@ -51,18 +51,23 @@ but you can override these too.
 
 ## Return types
 
-For simple plain text and JSON responses,
+For simple JSON responses, HTML, or status code responses,
 you don't need to instantiate a `Response` object.
 
 ```python
-class TextView(View):
+class JsonView(View):
     def get(self):
-        return "Hello, world!"
+        return {"message": "Hello, world!"}
 
 
-class JsonView(View):
+class HtmlView(View):
     def get(self):
-        return {"message": "Hello, world!"}
+        return "<html><body>Hello, world!</body></html>"
+
+
+class StatusCodeView(View):
+    def get(self):
+        return 204  # No content
 ```
 
 ## Template views
@@ -84,6 +89,19 @@ class ExampleView(TemplateView):
 
 The `TemplateView` is also the base class for _most_ of the other built-in view classes.
 
+Template views that don't need any custom context can use `TemplateView.as_view()` direcly in the URL route.
+
+```python
+from plain.views import TemplateView
+from plain.urls import path, Router
+
+
+class AppRouter(Router):
+    routes = [
+        path("/example/", TemplateView.as_view(template_name="example.html")),
+    ]
+```
+
 ## Form views
 
 Standard [forms](../forms) can be rendered and processed by a `FormView`.
@@ -255,7 +273,20 @@ class ExampleRedirectView(RedirectView):
     permanent = True
 ```
 
-## CSRF exemption
+Redirect views can also be used in the URL router.
+
+```python
+from plain.views import RedirectView
+from plain.urls import path, Router
+
+
+class AppRouter(Router):
+    routes = [
+        path("/old-location/", RedirectView.as_view(url="/new-location/", permanent=True)),
+    ]
+```
+
+## CSRF exempt views
 
 ```python
 from plain.views import View

plain/views/base.py

@@ -1,4 +1,5 @@
 import logging
+from http import HTTPMethod
 
 from plain.http import (
     HttpRequest,
@@ -6,6 +7,7 @@ from plain.http import (
     Response,
     ResponseBase,
     ResponseNotAllowed,
+    ResponseNotFound,
 )
 from plain.utils.decorators import classonlymethod
 
@@ -19,19 +21,6 @@ class View:
     url_args: tuple
     url_kwargs: dict
 
-    # By default, any of these are allowed if a method is defined for it.
-    # To disallow a defined method, remove it from this list.
-    allowed_http_methods = [
-        "get",
-        "post",
-        "put",
-        "patch",
-        "delete",
-        "head",
-        "options",
-        "trace",
-    ]
-
     # View.as_view(example="foo") usage can be customized by defining your own __init__ method.
     # def __init__(self, *args, **kwargs):
 
@@ -48,10 +37,7 @@ class View:
         def view(request, *url_args, **url_kwargs):
             v = cls(*init_args, **init_kwargs)
             v.setup(request, *url_args, **url_kwargs)
-            try:
-                return v.get_response()
-            except ResponseException as e:
-                return e.response
+            return v.get_response()
 
         view.view_class = cls
 
@@ -63,43 +49,49 @@ class View:
         if not self.request.method:
             raise AttributeError("HTTP method is not set")
 
-        handler = getattr(self, self.request.method.lower(), None)
+        return getattr(self, self.request.method.lower(), None)
+
+    def get_response(self) -> ResponseBase:
+        handler = self.get_request_handler()
 
-        if not handler or self.request.method.lower() not in self.allowed_http_methods:
+        if not handler:
             logger.warning(
                 "Method Not Allowed (%s): %s",
                 self.request.method,
                 self.request.path,
                 extra={"status_code": 405, "request": self.request},
             )
-            raise ResponseException(ResponseNotAllowed(self._allowed_methods()))
+            return ResponseNotAllowed(self._allowed_methods())
 
-        return handler
-
-    def get_response(self) -> ResponseBase:
-        handler = self.get_request_handler()
+        try:
+            result = handler()
+        except ResponseException as e:
+            return e.response
 
-        result = handler()
+        return self.convert_value_to_response(result)
 
-        if isinstance(result, ResponseBase):
-            return result
+    def convert_value_to_response(self, value) -> ResponseBase:
+        """Convert a value to a Response."""
+        if isinstance(value, ResponseBase):
+            return value
 
-        if isinstance(result, str):
-            # Assume the str is rendered HTML
-            return Response(result)
+        if isinstance(value, str):
+            # Assume a str is rendered HTML
+            return Response(value)
 
-        if isinstance(result, list):
-            return JsonResponse(result, safe=False)
+        if isinstance(value, list):
+            return JsonResponse(value, safe=False)
 
-        if isinstance(result, dict):
-            return JsonResponse(result)
+        if isinstance(value, dict):
+            return JsonResponse(value)
 
-        if isinstance(result, int):
-            return Response(status_code=result)
+        if isinstance(value, int):
+            return Response(status_code=value)
 
-        # Allow tuple for (status_code, content)?
+        if value is None:
+            return ResponseNotFound()
 
-        raise ValueError(f"Unexpected view return type: {type(result)}")
+        raise ValueError(f"Unexpected view return type: {type(value)}")
 
     def options(self) -> Response:
         """Handle responding to requests for the OPTIONS HTTP verb."""
@@ -109,4 +101,4 @@ class View:
         return response
 
     def _allowed_methods(self) -> list[str]:
-        return [m.upper() for m in self.allowed_http_methods if hasattr(self, m)]
+        return [m.upper() for m in HTTPMethod if hasattr(self, m.lower())]

plain/views/forms.py

@@ -27,19 +27,11 @@ class FormView(TemplateView):
 
     def get_form_kwargs(self) -> dict:
         """Return the keyword arguments for instantiating the form."""
-        kwargs: dict = {
-            "initial": {},  # Makes it easier to set keys in subclasses
+        return {
+            "initial": {},
+            "request": self.request,
         }
 
-        if hasattr(self, "request") and self.request.method in ("POST", "PUT"):
-            kwargs.update(
-                {
-                    "data": self.request.POST,
-                    "files": self.request.FILES,
-                }
-            )
-        return kwargs
-
     def get_success_url(self, form: "BaseForm") -> str:
         """Return the URL to redirect to after processing a valid form."""
         if not self.success_url:

{plain-0.37.0.dist-info → plain-0.39.0.dist-info}/METADATA

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

{plain-0.37.0.dist-info → plain-0.39.0.dist-info}/RECORD

@@ -7,18 +7,21 @@ plain/paginator.py,sha256=-fpLJd6c-V8bLCaNCHfTqPtm-Lm2Y1TuKqFDfy7n3ZE,5857
 plain/signing.py,sha256=sf7g1Mp-FzdjFAEoLxHyu2YvbUl5w4FOtTVDAfq6TO0,8733
 plain/validators.py,sha256=TePzFHzwR4JXUAZ_Y2vC6mkKgVxHX3QBXI6Oex0rV8c,19236
 plain/wsgi.py,sha256=R6k5FiAElvGDApEbMPTT0MPqSD7n2e2Az5chQqJZU0I,236
-plain/assets/README.md,sha256=8JDbusQPWu4HneNPMJ-vQ30r2FdVBD72mSL-Fn82CAM,3328
+plain/assets/README.md,sha256=wgsmBK5vAHgFMZ010q7LTrgLq5BTfuPuuug5HLZ9GNw,3774
 plain/assets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 plain/assets/compile.py,sha256=rABDHj7k_YAIPVvS7JJLCukEgUhb7h5oz9ajt5fGirI,3298
 plain/assets/finders.py,sha256=2k8QZAbfUbc1LykxbzdazTSB6xNxJZnsZaGhWbSFZZs,1452
 plain/assets/fingerprints.py,sha256=2LPHLUkoITMseLDmemTpBtMRDWCR2H5GAHjC6AN4gz0,1367
 plain/assets/urls.py,sha256=zQUA8bAlh9qVqskPJJrqWd9DjvetOi5jPSqy4vUX0J4,1161
 plain/assets/views.py,sha256=T_0Qh6v9qBerEBYbhToigwOzsij-x1z_R-1zETQcIh0,9447
+plain/chores/__init__.py,sha256=r9TXtQCH-VbvfnIJ5F8FxgQC35GRWFOfmMZN3q9niLg,67
+plain/chores/registry.py,sha256=V3WjuekRI22LFvJbqSkUXQtiOtuE2ZK8gKV1TRvxRUI,1866
 plain/cli/README.md,sha256=ompPcgzY2Fdpm579ITmCpFIaZIsiXYbfD61mqkq312M,1860
 plain/cli/__init__.py,sha256=6w9T7K2WrPwh6DcaMb2oNt_CWU6Bc57nUTO2Bt1p38Y,63
 plain/cli/build.py,sha256=dKUYBNegvb6QNckR7XZ7CJJtINwZcmDvbUdv2dWwjf8,3226
-plain/cli/core.py,sha256=N7xUO8Ox2xz8wJyWZ0fSyCfqVFmKz9czH9gulRyQuM4,2809
-plain/cli/docs.py,sha256=dHInHcweVLOew3hCNspVvUQ8epEfovDh3yI6O_FEsnI,7546
+plain/cli/chores.py,sha256=xXSSFvr8T5jWfLWqe6E8YVMw1BkQxyOHHVuY0x9RH0A,2412
+plain/cli/core.py,sha256=sy5otyN5jNOHkcy1EXISB7iMr1itp0rzmBSnEXYGe2k,2866
+plain/cli/docs.py,sha256=2CpTv5k-TNWf593tPiglvUVXWBGdfPmbGf8vl5AfJwU,8995
 plain/cli/formatting.py,sha256=1hZH13y1qwHcU2K2_Na388nw9uvoeQH8LrWL-O9h8Yc,2207
 plain/cli/preflight.py,sha256=NKyYjcoDjigzfJIDhf7A7degYadaUI05Bw7U9OQ73vs,4170
 plain/cli/print.py,sha256=XraUYrgODOJquIiEv78wSCYGRBplHXtXSS9QtFG5hqY,217
@@ -29,15 +32,15 @@ plain/cli/shell.py,sha256=iIwvlTdTBjLBBUdXMAmIRWSoynszOZI79-mrBg4RegU,1373
 plain/cli/startup.py,sha256=wLaFuyUb4ewWhtehBCGicrRCXIIGCRbeCT3ce9hUv-A,1022
 plain/cli/urls.py,sha256=CS9NFpwZBWveAR8F3YsoUNySDEK_PwF73oSgLDfkOdI,3776
 plain/cli/utils.py,sha256=VwlIh0z7XxzVV8I3qM2kZo07fkJFPoeeVZa1ODG616k,258
-plain/csrf/README.md,sha256=Xqb3pRZcIF6TJlOzEksQN0zue4mY7OTebNta9cq0T8g,699
+plain/csrf/README.md,sha256=nxCpPk1HF5eAM-7paxg9D-9RVCU9jXsSPAVHkJvA_DU,717
 plain/csrf/middleware.py,sha256=bn8KOE45aucSam0m3F9g8FVfnmjjt-6jxS6iSNwHamU,17413
 plain/csrf/views.py,sha256=HwQqfI6KPelHP9gSXhjfZaTLQic71PKsoZ6DPhr1rKI,572
 plain/forms/README.md,sha256=TawBdy1jP0-8HUsfUzd7vvgkwl3EJGejDxFhWR8F-80,2242
 plain/forms/__init__.py,sha256=UxqPwB8CiYPCQdHmUc59jadqaXqDmXBH8y4bt9vTPms,226
 plain/forms/boundfield.py,sha256=LhydhCVR0okrli0-QBMjGjAJ8-06gTCXVEaBZhBouQk,1741
-plain/forms/exceptions.py,sha256=XCLDRl5snIEDu5-8mLB0NnU_tegcBfyIHMiJxqvbxnc,164
-plain/forms/fields.py,sha256=Fw77LP06aO5h6ZdJmS2S_2On4YSrsl4gu142Y6nGF50,34987
-plain/forms/forms.py,sha256=fEKBee1b8I_DJ-FufzWJGtSQoUoyieYfqUaGEre9B4Q,10418
+plain/forms/exceptions.py,sha256=NYk1wjYDkk-lA_XMJQDItOebQcL_m_r2eNRc2mkLQkg,315
+plain/forms/fields.py,sha256=C71ed7m8VBnsgS-eIC6Xsmz7ruNSkdGa1BuSo7V3QKc,34574
+plain/forms/forms.py,sha256=Zcl5euWWxuE-CTcOHsOVYixWESdVk7no2Sz40AxmudY,11204
 plain/http/README.md,sha256=G662f56feQWiEHw9tTncZqK8kNB_nbR1HTGeOR1ygNM,713
 plain/http/__init__.py,sha256=DIsDRbBsCGa4qZgq-fUuQS0kkxfbTU_3KpIM9VvH04w,1067
 plain/http/cookie.py,sha256=11FnSG3Plo6T3jZDbPoCw7SKh9ExdBio3pTmIO03URg,597
@@ -61,7 +64,7 @@ plain/internal/middleware/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 plain/internal/middleware/headers.py,sha256=ENIW1Gwat54hv-ejgp2R8QTZm-PlaI7k44WU01YQrNk,964
 plain/internal/middleware/https.py,sha256=XpuQK8HicYX1jNanQHqNgyQ9rqe4NLUOZO3ZzKdsP8k,1203
 plain/internal/middleware/slash.py,sha256=FMU8b9w0NSx4eJs9Y7Ew6RAoSTbUqe2oOM68kg3wOng,2817
-plain/logs/README.md,sha256=C1eeqIolTUyaQPLFy8PpewOnLWwOaaqXH9nC9S6n9lk,1274
+plain/logs/README.md,sha256=wXqqAQym4g6hUiJOothj-t0RacZLf2-o9JskoZhsehA,1276
 plain/logs/__init__.py,sha256=rASvo4qFBDIHfkACmGLNGa6lRGbG9PbNjW6FmBt95ys,168
 plain/logs/configure.py,sha256=6mV7d1IxkDYT3VBz61qhIj0Esuy5l5QdQfsHaGCfI6w,1063
 plain/logs/loggers.py,sha256=iz9SYcwP9w5QAuwpULl48SFkVyJuuMoQ_fdLgdCHpNg,2121
@@ -132,18 +135,18 @@ plain/utils/text.py,sha256=42hJv06sadbWfsaAHNhqCQaP1W9qZ69trWDTS-Xva7k,9496
 plain/utils/timesince.py,sha256=a_-ZoPK_s3Pt998CW4rWp0clZ1XyK2x04hCqak2giII,5928
 plain/utils/timezone.py,sha256=6u0sE-9RVp0_OCe0Y1KiYYQoq5THWLokZFQYY8jf78g,6221
 plain/utils/tree.py,sha256=wdWzmfsgc26YDF2wxhAY3yVxXTixQYqYDKE9mL3L3ZY,4383
-plain/views/README.md,sha256=mveTtHrd2z3knSAchW2jTwfg59_bowwhAacx-3QBBHw,6003
+plain/views/README.md,sha256=_jR_8_eccE1Qwc9sbUhD_hpZGGf0r-HY4W-al6kqtGs,6762
 plain/views/__init__.py,sha256=a-N1nkklVohJTtz0yD1MMaS0g66HviEjsKydNVVjvVc,392
-plain/views/base.py,sha256=LomceHi01okLk41YfUr6cBE0VB5FNsSVODTOQ-Rmv0I,3280
+plain/views/base.py,sha256=bF_yBHrBfOdq3OcA_CTGCs7hNI1O6LpDVLM2Pkzyfjs,3062
 plain/views/csrf.py,sha256=7q6l5xzLWhRnMY64aNj0hR6G-3pxI2yhRwG6k_5j00E,144
 plain/views/errors.py,sha256=jbNCJIzowwCsEvqyJ3opMeZpPDqTyhtrbqb0VnAm2HE,1263
 plain/views/exceptions.py,sha256=b4euI49ZUKS9O8AGAcFfiDpstzkRAuuj_uYQXzWNHME,138
-plain/views/forms.py,sha256=5L6dYkwcZFMD3-w_QC2QDElo9hhSPrhVVFq9CB5yL9k,2692
+plain/views/forms.py,sha256=ESZOXuo6IeYixp1RZvPb94KplkowRiwO2eGJCM6zJI0,2400
 plain/views/objects.py,sha256=GGbcfg_9fPZ-PiaBwIHG2e__8GfWDR7JQtQ15wTyiHg,5970
 plain/views/redirect.py,sha256=vMXx8430FtyKcT0V0gyY92SkLtyULBX52KhX4eu4gEA,1985
 plain/views/templates.py,sha256=kMcHKkKNvucF91SFGkaq-ugjrCwn4zJBpFV1JkwA544,2027
-plain-0.37.0.dist-info/METADATA,sha256=Oj1bF-2a2hpbWTokTcq-TFKjKyfaZhvpBFSqTxapSNU,4297
-plain-0.37.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain-0.37.0.dist-info/entry_points.txt,sha256=1Ys2lsSeMepD1vz8RSrJopna0RQfUd951vYvCRsvl6A,45
-plain-0.37.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
-plain-0.37.0.dist-info/RECORD,,
+plain-0.39.0.dist-info/METADATA,sha256=DlIAs31jS4S87R0UhAlZlYdgxZGKOebjo3IcgK5yas4,4297
+plain-0.39.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain-0.39.0.dist-info/entry_points.txt,sha256=1Ys2lsSeMepD1vz8RSrJopna0RQfUd951vYvCRsvl6A,45
+plain-0.39.0.dist-info/licenses/LICENSE,sha256=m0D5O7QoH9l5Vz_rrX_9r-C8d9UNr_ciK6Qwac7o6yo,3175
+plain-0.39.0.dist-info/RECORD,,