plain 0.69.0__py3-none-any.whl → 0.71.0__py3-none-any.whl

plain/validators.py

@@ -1,7 +1,11 @@
+from __future__ import annotations
+
 import ipaddress
 import math
 import re
+from collections.abc import Callable
 from pathlib import Path
+from typing import Any
 from urllib.parse import urlsplit, urlunsplit
 
 from plain.exceptions import ValidationError
@@ -24,8 +28,13 @@ class RegexValidator:
     flags = 0
 
     def __init__(
-        self, regex=None, message=None, code=None, inverse_match=None, flags=None
-    ):
+        self,
+        regex: str | re.Pattern[str] | None = None,
+        message: str | None = None,
+        code: str | None = None,
+        inverse_match: bool | None = None,
+        flags: int | None = None,
+    ) -> None:
         if regex is not None:
             self.regex = regex
         if message is not None:
@@ -43,7 +52,7 @@ class RegexValidator:
 
         self.regex = _lazy_re_compile(self.regex, self.flags)
 
-    def __call__(self, value):
+    def __call__(self, value: Any) -> None:
         """
         Validate that the input contains (or does *not* contain, if
         inverse_match is True) a match for the regular expression.
@@ -53,11 +62,11 @@ class RegexValidator:
         if invalid_input:
             raise ValidationError(self.message, code=self.code, params={"value": value})
 
-    def __eq__(self, other):
+    def __eq__(self, other: object) -> bool:
         return (
             isinstance(other, RegexValidator)
-            and self.regex.pattern == other.regex.pattern
-            and self.regex.flags == other.regex.flags
+            and self.regex.pattern == other.regex.pattern  # type: ignore[attr-defined]
+            and self.regex.flags == other.regex.flags  # type: ignore[attr-defined]
             and (self.message == other.message)
             and (self.code == other.code)
             and (self.inverse_match == other.inverse_match)
@@ -104,12 +113,12 @@ class URLValidator(RegexValidator):
     schemes = ["http", "https", "ftp", "ftps"]
     unsafe_chars = frozenset("\t\r\n")
 
-    def __init__(self, schemes=None, **kwargs):
+    def __init__(self, schemes: list[str] | None = None, **kwargs: Any) -> None:
         super().__init__(**kwargs)
         if schemes is not None:
             self.schemes = schemes
 
-    def __call__(self, value):
+    def __call__(self, value: Any) -> None:
         if not isinstance(value, str):
             raise ValidationError(self.message, code=self.code, params={"value": value})
         if self.unsafe_chars.intersection(value):
@@ -182,7 +191,12 @@ class EmailValidator:
     )
     domain_allowlist = ["localhost"]
 
-    def __init__(self, message=None, code=None, allowlist=None):
+    def __init__(
+        self,
+        message: str | None = None,
+        code: str | None = None,
+        allowlist: list[str] | None = None,
+    ) -> None:
         if message is not None:
             self.message = message
         if code is not None:
@@ -190,7 +204,7 @@ class EmailValidator:
         if allowlist is not None:
             self.domain_allowlist = allowlist
 
-    def __call__(self, value):
+    def __call__(self, value: Any) -> None:
         if not value or "@" not in value:
             raise ValidationError(self.message, code=self.code, params={"value": value})
 
@@ -209,10 +223,11 @@ class EmailValidator:
                 pass
             else:
                 if self.validate_domain_part(domain_part):
-                    return
+                    return None
             raise ValidationError(self.message, code=self.code, params={"value": value})
+        return None
 
-    def validate_domain_part(self, domain_part):
+    def validate_domain_part(self, domain_part: str) -> bool:
         if self.domain_regex.match(domain_part):
             return True
 
@@ -226,7 +241,7 @@ class EmailValidator:
                 pass
         return False
 
-    def __eq__(self, other):
+    def __eq__(self, other: object) -> bool:
         return (
             isinstance(other, EmailValidator)
             and (self.domain_allowlist == other.domain_allowlist)
@@ -238,7 +253,7 @@ class EmailValidator:
 validate_email = EmailValidator()
 
 
-def validate_ipv4_address(value):
+def validate_ipv4_address(value: str) -> None:
     try:
         ipaddress.IPv4Address(value)
     except ValueError:
@@ -247,14 +262,14 @@ def validate_ipv4_address(value):
         )
 
 
-def validate_ipv6_address(value):
+def validate_ipv6_address(value: str) -> None:
     if not is_valid_ipv6_address(value):
         raise ValidationError(
             "Enter a valid IPv6 address.", code="invalid", params={"value": value}
         )
 
 
-def validate_ipv46_address(value):
+def validate_ipv46_address(value: str) -> None:
     try:
         validate_ipv4_address(value)
     except ValidationError:
@@ -275,7 +290,9 @@ ip_address_validator_map = {
 }
 
 
-def ip_address_validators(protocol, unpack_ipv4):
+def ip_address_validators(
+    protocol: str, unpack_ipv4: bool
+) -> tuple[list[Callable[[str], None]], str]:
     """
     Depending on the given parameters, return the appropriate validators for
     the GenericIPAddressField.
@@ -292,14 +309,19 @@ def ip_address_validators(protocol, unpack_ipv4):
         )
 
 
-def int_list_validator(sep=",", message=None, code="invalid", allow_negative=False):
+def int_list_validator(
+    sep: str = ",",
+    message: str | None = None,
+    code: str = "invalid",
+    allow_negative: bool = False,
+) -> RegexValidator:
     regexp = _lazy_re_compile(
         r"^{neg}\d+(?:{sep}{neg}\d+)*\Z".format(
             neg="(-)?" if allow_negative else "",
             sep=re.escape(sep),
         )
     )
-    return RegexValidator(regexp, message=message, code=code)
+    return RegexValidator(regexp, message=message, code=code)  # type: ignore[arg-type]
 
 
 validate_comma_separated_integer_list = int_list_validator(
@@ -312,12 +334,12 @@ class BaseValidator:
     message = "Ensure this value is %(limit_value)s (it is %(show_value)s)."
     code = "limit_value"
 
-    def __init__(self, limit_value, message=None):
+    def __init__(self, limit_value: Any, message: str | None = None) -> None:
         self.limit_value = limit_value
         if message:
             self.message = message
 
-    def __call__(self, value):
+    def __call__(self, value: Any) -> None:
         cleaned = self.clean(value)
         limit_value = (
             self.limit_value() if callable(self.limit_value) else self.limit_value
@@ -326,7 +348,7 @@ class BaseValidator:
         if self.compare(cleaned, limit_value):
             raise ValidationError(self.message, code=self.code, params=params)
 
-    def __eq__(self, other):
+    def __eq__(self, other: object) -> bool:
         if not isinstance(other, self.__class__):
             return NotImplemented
         return (
@@ -335,10 +357,10 @@ class BaseValidator:
             and self.code == other.code
         )
 
-    def compare(self, a, b):
+    def compare(self, a: Any, b: Any) -> bool:
         return a is not b
 
-    def clean(self, x):
+    def clean(self, x: Any) -> Any:
         return x
 
 
@@ -347,7 +369,7 @@ class MaxValueValidator(BaseValidator):
     message = "Ensure this value is less than or equal to %(limit_value)s."
     code = "max_value"
 
-    def compare(self, a, b):
+    def compare(self, a: Any, b: Any) -> bool:
         return a > b
 
 
@@ -356,7 +378,7 @@ class MinValueValidator(BaseValidator):
     message = "Ensure this value is greater than or equal to %(limit_value)s."
     code = "min_value"
 
-    def compare(self, a, b):
+    def compare(self, a: Any, b: Any) -> bool:
         return a < b
 
 
@@ -365,7 +387,7 @@ class StepValueValidator(BaseValidator):
     message = "Ensure this value is a multiple of step size %(limit_value)s."
     code = "step_size"
 
-    def compare(self, a, b):
+    def compare(self, a: Any, b: Any) -> bool:
         return not math.isclose(math.remainder(a, b), 0, abs_tol=1e-9)
 
 
@@ -380,10 +402,10 @@ class MinLengthValidator(BaseValidator):
     )
     code = "min_length"
 
-    def compare(self, a, b):
+    def compare(self, a: Any, b: Any) -> bool:
         return a < b
 
-    def clean(self, x):
+    def clean(self, x: Any) -> int:
         return len(x)
 
 
@@ -398,10 +420,10 @@ class MaxLengthValidator(BaseValidator):
     )
     code = "max_length"
 
-    def compare(self, a, b):
+    def compare(self, a: Any, b: Any) -> bool:
         return a > b
 
-    def clean(self, x):
+    def clean(self, x: Any) -> int:
         return len(x)
 
 
@@ -433,11 +455,11 @@ class DecimalValidator:
         ),
     }
 
-    def __init__(self, max_digits, decimal_places):
+    def __init__(self, max_digits: int | None, decimal_places: int | None) -> None:
         self.max_digits = max_digits
         self.decimal_places = decimal_places
 
-    def __call__(self, value):
+    def __call__(self, value: Any) -> None:
         digit_tuple, exponent = value.as_tuple()[1:]
         if exponent in {"F", "n", "N"}:
             raise ValidationError(
@@ -485,7 +507,7 @@ class DecimalValidator:
                 params={"max": (self.max_digits - self.decimal_places), "value": value},
             )
 
-    def __eq__(self, other):
+    def __eq__(self, other: object) -> bool:
         return (
             isinstance(other, self.__class__)
             and self.max_digits == other.max_digits
@@ -495,10 +517,15 @@ class DecimalValidator:
 
 @deconstructible
 class FileExtensionValidator:
-    message = "File extension “%(extension)s” is not allowed. Allowed extensions are: %(allowed_extensions)s."
+    message = 'File extension "%(extension)s" is not allowed. Allowed extensions are: %(allowed_extensions)s.'
     code = "invalid_extension"
 
-    def __init__(self, allowed_extensions=None, message=None, code=None):
+    def __init__(
+        self,
+        allowed_extensions: list[str] | None = None,
+        message: str | None = None,
+        code: str | None = None,
+    ) -> None:
         if allowed_extensions is not None:
             allowed_extensions = [
                 allowed_extension.lower() for allowed_extension in allowed_extensions
@@ -509,7 +536,7 @@ class FileExtensionValidator:
         if code is not None:
             self.code = code
 
-    def __call__(self, value):
+    def __call__(self, value: Any) -> None:
         extension = Path(value.name).suffix[1:].lower()
         if (
             self.allowed_extensions is not None
@@ -525,7 +552,7 @@ class FileExtensionValidator:
                 },
             )
 
-    def __eq__(self, other):
+    def __eq__(self, other: object) -> bool:
         return (
             isinstance(other, self.__class__)
             and self.allowed_extensions == other.allowed_extensions
@@ -534,9 +561,9 @@ class FileExtensionValidator:
         )
 
 
-def get_available_image_extensions():
+def get_available_image_extensions() -> list[str]:
     try:
-        from PIL import Image
+        from PIL import Image  # type: ignore[import-untyped]
     except ImportError:
         return []
     else:
@@ -544,7 +571,7 @@ def get_available_image_extensions():
         return [ext.lower()[1:] for ext in Image.EXTENSION]
 
 
-def validate_image_file_extension(value):
+def validate_image_file_extension(value: Any) -> None:
     return FileExtensionValidator(allowed_extensions=get_available_image_extensions())(
         value
     )
@@ -557,17 +584,17 @@ class ProhibitNullCharactersValidator:
     message = "Null characters are not allowed."
     code = "null_characters_not_allowed"
 
-    def __init__(self, message=None, code=None):
+    def __init__(self, message: str | None = None, code: str | None = None) -> None:
         if message is not None:
             self.message = message
         if code is not None:
             self.code = code
 
-    def __call__(self, value):
+    def __call__(self, value: Any) -> None:
         if "\x00" in str(value):
             raise ValidationError(self.message, code=self.code, params={"value": value})
 
-    def __eq__(self, other):
+    def __eq__(self, other: object) -> bool:
         return (
             isinstance(other, self.__class__)
             and self.message == other.message

plain/views/base.py

@@ -1,5 +1,9 @@
+from __future__ import annotations
+
 import logging
+from collections.abc import Callable
 from http import HTTPMethod
+from typing import Any
 
 from opentelemetry import trace
 from opentelemetry.semconv._incubating.attributes.code_attributes import (
@@ -8,8 +12,8 @@ from opentelemetry.semconv._incubating.attributes.code_attributes import (
 )
 
 from plain.http import (
-    HttpRequest,
     JsonResponse,
+    Request,
     Response,
     ResponseBase,
     ResponseNotAllowed,
@@ -26,14 +30,14 @@ tracer = trace.get_tracer("plain")
 
 
 class View:
-    request: HttpRequest
+    request: Request
     url_args: tuple
     url_kwargs: dict
 
     # View.as_view(example="foo") usage can be customized by defining your own __init__ method.
     # def __init__(self, *args, **kwargs):
 
-    def setup(self, request: HttpRequest, *url_args, **url_kwargs) -> None:
+    def setup(self, request: Request, *url_args: object, **url_kwargs: object) -> None:
         if hasattr(self, "get") and not hasattr(self, "head"):
             self.head = self.get
 
@@ -42,8 +46,12 @@ class View:
         self.url_kwargs = url_kwargs
 
     @classonlymethod
-    def as_view(cls, *init_args, **init_kwargs):
-        def view(request, *url_args, **url_kwargs):
+    def as_view(
+        cls, *init_args: object, **init_kwargs: object
+    ) -> Callable[[Request, Any, Any], ResponseBase]:
+        def view(
+            request: Request, *url_args: object, **url_kwargs: object
+        ) -> ResponseBase:
             with tracer.start_as_current_span(
                 f"{cls.__name__}",
                 kind=trace.SpanKind.INTERNAL,
@@ -62,11 +70,11 @@ class View:
                 )
                 return response
 
-        view.view_class = cls
+        view.view_class = cls  # type: ignore[attr-defined]
 
         return view
 
-    def get_request_handler(self) -> callable:
+    def get_request_handler(self) -> Callable[[], Any] | None:
         """Return the handler for the current request method."""
 
         if not self.request.method:
@@ -93,7 +101,7 @@ class View:
 
         return self.convert_value_to_response(result)
 
-    def convert_value_to_response(self, value) -> ResponseBase:
+    def convert_value_to_response(self, value: object) -> ResponseBase:
         """Convert a return value to a Response."""
         if isinstance(value, ResponseBase):
             return value

plain/views/errors.py

@@ -1,3 +1,8 @@
+from __future__ import annotations
+
+from collections.abc import Callable
+from typing import Any
+
 from plain.http import ResponseBase
 from plain.templates import TemplateFileMissing
 
@@ -7,7 +12,9 @@ from .templates import TemplateView
 class ErrorView(TemplateView):
     status_code: int
 
-    def __init__(self, *, status_code=None, exception=None) -> None:
+    def __init__(
+        self, *, status_code: int | None = None, exception: Any | None = None
+    ) -> None:
         # Allow creating an ErrorView with a status code
         # e.g. ErrorView.as_view(status_code=404)
         self.status_code = status_code or self.status_code
@@ -15,7 +22,7 @@ class ErrorView(TemplateView):
         # Allow creating an ErrorView with an exception
         self.exception = exception
 
-    def get_template_context(self):
+    def get_template_context(self) -> dict:
         context = super().get_template_context()
         context["status_code"] = self.status_code
         context["exception"] = self.exception
@@ -24,7 +31,7 @@ class ErrorView(TemplateView):
     def get_template_names(self) -> list[str]:
         return [f"{self.status_code}.html", "error.html"]
 
-    def get_request_handler(self):
+    def get_request_handler(self) -> Callable[[], Any]:
         return self.get  # All methods (post, patch, etc.) will use the get()
 
     def get_response(self) -> ResponseBase:
@@ -33,7 +40,7 @@ class ErrorView(TemplateView):
         response.status_code = self.status_code
         return response
 
-    def get(self):
+    def get(self) -> ResponseBase:
         try:
             return super().get()
         except TemplateFileMissing:

plain/views/exceptions.py

@@ -1,4 +1,7 @@
+from plain.http import ResponseBase
+
+
 class ResponseException(Exception):
-    def __init__(self, response):
+    def __init__(self, response: ResponseBase) -> None:
         self.response = response
         super().__init__(response)

plain/views/objects.py

@@ -6,7 +6,7 @@ from plain.exceptions import ImproperlyConfigured
 try:
     from plain.models.exceptions import ObjectDoesNotExist
 except ImportError:
-    ObjectDoesNotExist = None
+    ObjectDoesNotExist = None  # type: ignore[assignment]
 
 from plain.forms import Form
 from plain.http import Http404
@@ -21,7 +21,7 @@ class CreateView(FormView):
     """
 
     # TODO? would rather you have to specify this...
-    def get_success_url(self, form):
+    def get_success_url(self, form: Form) -> str:
         """Return the URL to redirect to after processing a valid form."""
         if self.success_url:
             url = self.success_url.format(**self.object.__dict__)
@@ -35,9 +35,9 @@ class CreateView(FormView):
                 )
         return url
 
-    def form_valid(self, form):
+    def form_valid(self, form: Form) -> Any:
         """If the form is valid, save the associated model."""
-        self.object = form.save()
+        self.object = form.save()  # type: ignore[attr-defined]
         return super().form_valid(form)
 
 
@@ -91,7 +91,7 @@ class DetailView(ObjectTemplateViewMixin, TemplateView):
 class UpdateView(ObjectTemplateViewMixin, FormView):
     """View for updating an object, with a response rendered by a template."""
 
-    def get_success_url(self, form):
+    def get_success_url(self, form: Form) -> str:
         """Return the URL to redirect to after processing a valid form."""
         if self.success_url:
             url = self.success_url.format(**self.object.__dict__)
@@ -105,12 +105,12 @@ class UpdateView(ObjectTemplateViewMixin, FormView):
                 )
         return url
 
-    def form_valid(self, form):
+    def form_valid(self, form: Form) -> Any:
         """If the form is valid, save the associated model."""
-        form.save()
+        form.save()  # type: ignore[attr-defined]
         return super().form_valid(form)
 
-    def get_form_kwargs(self):
+    def get_form_kwargs(self) -> dict:
         """Return the keyword arguments for instantiating the form."""
         kwargs = super().get_form_kwargs()
         kwargs.update({"instance": self.object})
@@ -124,24 +124,24 @@ class DeleteView(ObjectTemplateViewMixin, FormView):
     """
 
     class EmptyDeleteForm(Form):
-        def __init__(self, instance, *args, **kwargs):
+        def __init__(self, instance: Any, *args: object, **kwargs: object) -> None:
             self.instance = instance
             super().__init__(*args, **kwargs)
 
-        def save(self):
+        def save(self) -> None:
             self.instance.delete()
 
     form_class = EmptyDeleteForm
 
-    def get_form_kwargs(self):
+    def get_form_kwargs(self) -> dict:
         """Return the keyword arguments for instantiating the form."""
         kwargs = super().get_form_kwargs()
         kwargs.update({"instance": self.object})
         return kwargs
 
-    def form_valid(self, form):
+    def form_valid(self, form: Form) -> Any:
         """If the form is valid, save the associated model."""
-        form.save()
+        form.save()  # type: ignore[attr-defined]
         return super().form_valid(form)
 
 
@@ -154,10 +154,10 @@ class ListView(TemplateView):
     context_object_name = ""
 
     @cached_property
-    def objects(self):
+    def objects(self) -> Any:
         return self.get_objects()
 
-    def get_objects(self):
+    def get_objects(self) -> Any:
         raise NotImplementedError(
             f"get_objects() is not implemented on {self.__class__.__name__}"
         )

plain/views/redirect.py

@@ -13,8 +13,12 @@ class RedirectView(View):
     preserve_query_params = False
 
     def __init__(
-        self, url=None, status_code=None, url_name=None, preserve_query_params=None
-    ):
+        self,
+        url: str | None = None,
+        status_code: int | None = None,
+        url_name: str | None = None,
+        preserve_query_params: bool | None = None,
+    ) -> None:
         # Allow attributes to be set in RedirectView.as_view(url="...", status_code=301, etc.)
         self.url = url or self.url
         self.status_code = status_code if status_code is not None else self.status_code
@@ -25,7 +29,7 @@ class RedirectView(View):
             else self.preserve_query_params
         )
 
-    def get_redirect_url(self):
+    def get_redirect_url(self) -> str:
         """
         Return the URL redirect to. Keyword arguments from the URL pattern
         match generating the redirect request are provided as kwargs to this
@@ -43,24 +47,24 @@ class RedirectView(View):
             url = f"{url}?{args}"
         return url
 
-    def get(self):
+    def get(self) -> ResponseRedirect:
         url = self.get_redirect_url()
         return ResponseRedirect(url, status_code=self.status_code)
 
-    def head(self):
+    def head(self) -> ResponseRedirect:
         return self.get()
 
-    def post(self):
+    def post(self) -> ResponseRedirect:
         return self.get()
 
-    def options(self):
+    def options(self) -> ResponseRedirect:
         return self.get()
 
-    def delete(self):
+    def delete(self) -> ResponseRedirect:
         return self.get()
 
-    def put(self):
+    def put(self) -> ResponseRedirect:
         return self.get()
 
-    def patch(self):
+    def patch(self) -> ResponseRedirect:
         return self.get()

plain/views/templates.py

@@ -13,7 +13,7 @@ class TemplateView(View):
 
     template_name: str | None = None
 
-    def __init__(self, template_name=None):
+    def __init__(self, template_name: str | None = None) -> None:
         # Allow template_name to be passed in as_view()
         self.template_name = template_name or self.template_name
 

plain/wsgi.py

@@ -1,8 +1,10 @@
+from __future__ import annotations
+
 import plain.runtime
 from plain.internal.handlers.wsgi import WSGIHandler
 
 
-def _get_wsgi_application():
+def _get_wsgi_application() -> WSGIHandler:
     plain.runtime.setup()
     return WSGIHandler()
 

{plain-0.69.0.dist-info → plain-0.71.0.dist-info}/METADATA

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