plain 0.33.0__tar.gz → 0.34.0__tar.gz

{plain-0.33.0 → plain-0.34.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain
-Version: 0.33.0
+Version: 0.34.0
 Summary: A web framework for building products with Python.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-File: LICENSE
@@ -40,7 +40,7 @@ The `plain` package includes everything you need to start handling web requests
 
 - [plain.models](/plain-models/README.md) - Define and interact with your database models.
 - [plain.cache](/plain-cache/README.md) - A database-driven general purpose cache.
-- [plain.mail](/plain-mail/README.md) - Send emails with SMTP or custom backends.
+- [plain.email](/plain-email/README.md) - Send emails with SMTP or custom backends.
 - [plain.sessions](/plain-sessions/README.md) - User sessions and cookies.
 - [plain.worker](/plain-worker/README.md) - Backgrounb jobs stored in the database.
 - [plain.api](/plain-api/README.md) - Build APIs with Plain views.

{plain-0.33.0 → plain-0.34.0}/plain/README.md

@@ -29,7 +29,7 @@ The `plain` package includes everything you need to start handling web requests
 
 - [plain.models](/plain-models/README.md) - Define and interact with your database models.
 - [plain.cache](/plain-cache/README.md) - A database-driven general purpose cache.
-- [plain.mail](/plain-mail/README.md) - Send emails with SMTP or custom backends.
+- [plain.email](/plain-email/README.md) - Send emails with SMTP or custom backends.
 - [plain.sessions](/plain-sessions/README.md) - User sessions and cookies.
 - [plain.worker](/plain-worker/README.md) - Backgrounb jobs stored in the database.
 - [plain.api](/plain-api/README.md) - Build APIs with Plain views.

{plain-0.33.0 → plain-0.34.0}/plain/internal/handlers/exception.py

@@ -45,10 +45,14 @@ def convert_exception_to_response(get_response):
 
 def response_for_exception(request, exc):
     if isinstance(exc, Http404):
-        response = get_exception_response(request, 404)
+        response = get_exception_response(
+            request=request, status_code=404, exception=None
+        )
 
     elif isinstance(exc, PermissionDenied):
-        response = get_exception_response(request, 403)
+        response = get_exception_response(
+            request=request, status_code=403, exception=exc
+        )
         log_response(
             "Forbidden (Permission denied): %s",
             request.path,
@@ -58,7 +62,9 @@ def response_for_exception(request, exc):
         )
 
     elif isinstance(exc, MultiPartParserError):
-        response = get_exception_response(request, 400)
+        response = get_exception_response(
+            request=request, status_code=400, exception=None
+        )
         log_response(
             "Bad request (Unable to parse request body): %s",
             request.path,
@@ -68,7 +74,9 @@ def response_for_exception(request, exc):
         )
 
     elif isinstance(exc, BadRequest):
-        response = get_exception_response(request, 400)
+        response = get_exception_response(
+            request=request, status_code=400, exception=exc
+        )
         log_response(
             "%s: %s",
             str(exc),
@@ -91,11 +99,15 @@ def response_for_exception(request, exc):
             exc_info=exc,
             extra={"status_code": 400, "request": request},
         )
-        response = get_exception_response(request, 400)
+        response = get_exception_response(
+            request=request, status_code=400, exception=None
+        )
 
     else:
         signals.got_request_exception.send(sender=None, request=request)
-        response = get_exception_response(request, 500)
+        response = get_exception_response(
+            request=request, status_code=500, exception=None
+        )
         log_response(
             "%s: %s",
             response.reason_phrase,
@@ -105,34 +117,25 @@ def response_for_exception(request, exc):
             exception=exc,
         )
 
-    # Force a TemplateResponse to be rendered.
-    if not getattr(response, "is_rendered", True) and callable(
-        getattr(response, "render", None)
-    ):
-        response = response.render()
-
     return response
 
 
-def get_exception_response(request, status_code):
+def get_exception_response(*, request, status_code, exception):
     try:
-        return get_error_view(status_code)(request)
+        view_class = get_error_view(status_code=status_code, exception=exception)
+        return view_class(request)
     except Exception:
         signals.got_request_exception.send(sender=None, request=request)
-        return handle_uncaught_exception()
 
+        # In development mode, re-raise the exception to get a full stack trace
+        if settings.DEBUG:
+            raise
 
-def handle_uncaught_exception():
-    """
-    Processing for any otherwise uncaught exceptions (those that will
-    generate HTTP 500 responses).
-    """
-    if settings.DEBUG:
-        raise
-    return ResponseServerError()
+        # If we can't load the view, return a 500 response
+        return ResponseServerError()
 
 
-def get_error_view(status_code):
+def get_error_view(*, status_code, exception):
     views_by_status = settings.HTTP_ERROR_VIEWS
     if status_code in views_by_status:
         view = views_by_status[status_code]
@@ -142,4 +145,4 @@ def get_error_view(status_code):
         return view.as_view()
 
     # Create a standard view for any other status code
-    return ErrorView.as_view(status_code=status_code)
+    return ErrorView.as_view(status_code=status_code, exception=exception)

{plain-0.33.0 → plain-0.34.0}/plain/packages/config.py

@@ -10,7 +10,9 @@ CONFIG_MODULE_NAME = "config"
 class PackageConfig:
     """Class representing a Plain application and its configuration."""
 
-    def __init__(self, name, *, label=""):
+    package_label: str
+
+    def __init__(self, name):
         # Full Python path to the application e.g. 'plain.admin.admin'.
         self.name = name
 
@@ -18,28 +20,18 @@ class PackageConfig:
         # registry when it registers the PackageConfig instance.
         self.packages_registry = None
 
-        # The following attributes could be defined at the class level in a
-        # subclass, hence the test-and-set pattern.
-        if label and hasattr(self, "label"):
-            raise ImproperlyConfigured(
-                "PackageConfig class should not define a class label attribute and an init label"
-            )
-
-        if label:
-            # Set the label explicitly from the init
-            self.label = label
-        elif not hasattr(self, "label"):
+        if not hasattr(self, "package_label"):
             # Last component of the Python path to the application e.g. 'admin'.
             # This value must be unique across a Plain project.
-            self.label = self.name.rpartition(".")[2]
+            self.package_label = self.name.rpartition(".")[2]
 
-        if not self.label.isidentifier():
+        if not self.package_label.isidentifier():
             raise ImproperlyConfigured(
-                f"The app label '{self.label}' is not a valid Python identifier."
+                f"The app label '{self.package_label}' is not a valid Python identifier."
             )
 
     def __repr__(self):
-        return f"<{self.__class__.__name__}: {self.label}>"
+        return f"<{self.__class__.__name__}: {self.package_label}>"
 
     @cached_property
     def path(self):

{plain-0.33.0 → plain-0.34.0}/plain/packages/registry.py

@@ -146,7 +146,7 @@ class PackagesRegistry:
             message = f"No installed app with label '{package_label}'."
             for package_config in self.get_package_configs():
                 if package_config.name == package_label:
-                    message += f" Did you mean '{package_config.label}'?"
+                    message += f" Did you mean '{package_config.package_label}'?"
                     break
             raise LookupError(message)
 
@@ -179,11 +179,11 @@ class PackagesRegistry:
         class Config(PackageConfig):
             pass
         """
-        if package_config.label in self.package_configs:
+        if package_config.package_label in self.package_configs:
             raise ImproperlyConfigured(
-                f"Package labels aren't unique, duplicates: {package_config.label}"
+                f"Package labels aren't unique, duplicates: {package_config.package_label}"
             )
-        self.package_configs[package_config.label] = package_config
+        self.package_configs[package_config.package_label] = package_config
         package_config.packages = self
 
         return package_config

{plain-0.33.0 → plain-0.34.0}/plain/utils/cache.py

@@ -15,13 +15,39 @@ An example: i18n middleware would need to distinguish caches by the
 "Accept-language" header.
 """
 
+import time
 from collections import defaultdict
 
-from plain.utils.regex_helper import _lazy_re_compile
+from .http import http_date
+from .regex_helper import _lazy_re_compile
 
 cc_delim_re = _lazy_re_compile(r"\s*,\s*")
 
 
+def patch_response_headers(response, cache_timeout):
+    """
+    Add HTTP caching headers to the given HttpResponse: Expires and
+    Cache-Control.
+
+    Each header is only added if it isn't already set.
+    """
+    if cache_timeout < 0:
+        cache_timeout = 0  # Can't have max-age negative
+    if "Expires" not in response.headers:
+        response.headers["Expires"] = http_date(time.time() + cache_timeout)
+    patch_cache_control(response, max_age=cache_timeout)
+
+
+def add_never_cache_headers(response):
+    """
+    Add headers to a response to indicate that a page should never be cached.
+    """
+    patch_response_headers(response, cache_timeout=-1)
+    patch_cache_control(
+        response, no_cache=True, no_store=True, must_revalidate=True, private=True
+    )
+
+
 def patch_cache_control(response, **kwargs):
     """
     Patch the Cache-Control header by adding all keyword arguments to it.

{plain-0.33.0 → plain-0.34.0}/plain/views/base.py

@@ -20,6 +20,7 @@ class View:
     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",

{plain-0.33.0 → plain-0.34.0}/plain/views/errors.py

@@ -7,11 +7,19 @@ from .templates import TemplateView
 class ErrorView(TemplateView):
     status_code: int
 
-    def __init__(self, status_code=None) -> None:
+    def __init__(self, *, status_code=None, exception=None) -> None:
         # Allow creating an ErrorView with a status code
         # e.g. ErrorView.as_view(status_code=404)
-        if status_code is not None:
-            self.status_code = status_code
+        self.status_code = status_code or self.status_code
+
+        # Allow creating an ErrorView with an exception
+        self.exception = exception
+
+    def get_template_context(self):
+        context = super().get_template_context()
+        context["status_code"] = self.status_code
+        context["exception"] = self.exception
+        return context
 
     def get_template_names(self) -> list[str]:
         return [f"{self.status_code}.html", "error.html"]

{plain-0.33.0 → plain-0.34.0}/plain/views/templates.py

@@ -27,6 +27,10 @@ class TemplateView(View):
 
     template_name: str | None = None
 
+    def __init__(self, template_name=None):
+        # Allow template_name to be passed in as_view()
+        self.template_name = template_name or self.template_name
+
     def get_template_context(self) -> dict:
         return {
             "request": self.request,

{plain-0.33.0 → plain-0.34.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plain"
-version = "0.33.0"
+version = "0.34.0"
 description = "A web framework for building products with Python."
 authors = [{name = "Dave Gaeddert", email = "dave.gaeddert@dropseed.dev"}]
 readme = "README.md"