fresco 3.3.4__py3-none-any.whl → 3.9.0__py3-none-any.whl

fresco/response.py

@@ -16,12 +16,14 @@
 The :class:`Response` class models the response from your application to a
 single request.
 """
+from collections.abc import Iterable
 from datetime import datetime
 from itertools import chain
 from typing import Callable
 from typing import List
 from typing import Tuple
 from typing import Set
+import typing as t
 import re
 import json as stdlib_json
 
@@ -275,7 +277,7 @@ def encoder(stream, charset):
 
 
 def make_header_name(name):
-    """\
+    """
     Return a formatted header name from a python idenfier.
 
     Example usage::
@@ -331,6 +333,7 @@ class Response(object):
     """
 
     default_content_type = "text/html; charset=UTF-8"
+    content_iterator: Iterable[bytes]
 
     def __init__(
         self,
@@ -386,7 +389,7 @@ class Response(object):
             self.status = "200 OK"
         else:
             try:
-                self.status = f"{status} {HTTP_STATUS_CODES[status]}"
+                self.status = f"{status} {HTTP_STATUS_CODES[status]}"  # type: ignore
             except KeyError:
                 self.status = str(status)
 
@@ -441,7 +444,7 @@ class Response(object):
             else:
                 self.content_iterator = encoder(content, self.charset)
 
-    def __call__(self, environ, start_response, exc_info=None):
+    def __call__(self, environ, start_response, exc_info=None) -> Iterable[bytes]:
         """
         WSGI callable. Calls ``start_response`` with assigned headers and
         returns an iterator over ``content``.
@@ -449,7 +452,7 @@ class Response(object):
         start_response(self.status, self.headers, exc_info)
         result = self.content_iterator
         if self.onclose:
-            result = ClosingIterator(result, *self.onclose)
+            result = ClosingIterator[bytes](result, *self.onclose)
         return result
 
     def add_onclose(self, *funcs):
@@ -610,12 +613,12 @@ class Response(object):
         value,
         max_age=None,
         expires=None,
-        path="/",
-        secure=None,
-        domain=None,
-        comment=None,
-        httponly=False,
-        samesite="Lax",
+        path: str = "/",
+        secure: bool = False,
+        domain: t.Optional[str] = None,
+        comment: t.Optional[str] = None,
+        httponly: bool = False,
+        samesite: str = "Lax",
     ):
         """
         Return a new response object with the given cookie added.
@@ -674,8 +677,10 @@ class Response(object):
                 newheaders.append((k, v))
         return self.replace(headers=newheaders + [("Vary", ", ".join(_vary_on))])
 
-    def replace(self, content=None, status=None, headers=None, **kwheaders):
-        """\
+    def replace(
+        self, content=None, status=None, headers=None, **kwheaders
+    ) -> "Response":
+        """
         Return a new response object with any of content, status or headers
         changed.
 
@@ -755,7 +760,7 @@ class Response(object):
         return default_charset
 
     @classmethod
-    def not_found(cls, request=None):
+    def not_found(cls, request=None) -> "Response":
         """
         Return an HTTP not found response (404).
 
@@ -778,7 +783,7 @@ class Response(object):
         )
 
     @classmethod
-    def error(cls, message="500 Internal Server Error"):
+    def error(cls, message="500 Internal Server Error") -> "Response":
         """
         Return an HTTP server error response (500).
 
@@ -800,7 +805,7 @@ class Response(object):
         )
 
     @classmethod
-    def unauthorized(cls, authenticate):
+    def unauthorized(cls, authenticate) -> "Response":
         """
         Return an HTTP unauthorized response (401)
         """
@@ -815,7 +820,7 @@ class Response(object):
         )
 
     @classmethod
-    def unauthorized_basic(cls, realm):
+    def unauthorized_basic(cls, realm) -> "Response":
         """
         Return an HTTP unauthorized response (401) with a WWW-Authenticate
         header set for HTTP Basic authentication..
@@ -823,7 +828,7 @@ class Response(object):
         return cls.unauthorized(authenticate=f'Basic realm="{realm}"')
 
     @classmethod
-    def forbidden(cls, message="Sorry, access is denied"):
+    def forbidden(cls, message="Sorry, access is denied") -> "Response":
         """
         Return an HTTP forbidden response (403).
 
@@ -839,7 +844,9 @@ class Response(object):
         )
 
     @classmethod
-    def bad_request(cls, request=None):
+    def bad_request(
+        cls, message="The server could not understand your request", request=None
+    ) -> "Response":
         """
         Return an HTTP bad request response.
 
@@ -853,16 +860,17 @@ class Response(object):
         return cls(
             status=STATUS_BAD_REQUEST,
             content=[
-                "<html>"
-                "<body>"
-                "<h1>The server could not understand your request</h1>"
-                "</body>"
-                "</html>"
+                f"<html>"
+                f"<body>"
+                f"<h1>Bad request</h1>"
+                f"<p>{message}</p>"
+                f"</body>"
+                f"</html>"
             ],
         )
 
     @classmethod
-    def length_required(cls, request=None):
+    def length_required(cls, request=None) -> "Response":
         """
         Return an HTTP Length Required response (411).
 
@@ -885,7 +893,7 @@ class Response(object):
         )
 
     @classmethod
-    def payload_too_large(cls, request=None):
+    def payload_too_large(cls, request=None) -> "Response":
         """
         Return an HTTP Payload Too Large response (413)::
 
@@ -900,7 +908,7 @@ class Response(object):
     request_entity_too_large = payload_too_large
 
     @classmethod
-    def method_not_allowed(cls, valid_methods):
+    def method_not_allowed(cls, valid_methods) -> "Response":
         """
         Return an HTTP method not allowed response (405)::
 
@@ -922,7 +930,7 @@ class Response(object):
         )
 
     @classmethod
-    def internal_server_error(cls):
+    def internal_server_error(cls) -> "Response":
         """
         Return an HTTP internal server error response (500).
 
@@ -943,7 +951,7 @@ class Response(object):
     @classmethod
     def unrestricted_redirect(
         cls, location, request=None, status=STATUS_FOUND, **kwargs
-    ):
+    ) -> "Response":
         """
         Return an HTTP redirect reponse (30x).
 
@@ -1001,7 +1009,7 @@ class Response(object):
                     request = fresco.context.request
                 location = request.resolve_url(location)
 
-        return Response(
+        return cls(
             "<html><head></head><body>\n"
             "<h1>Page has moved</h1>\n"
             "<p><a href='%s'>%s</a></p>\n"
@@ -1011,8 +1019,8 @@ class Response(object):
         )
 
     @classmethod
-    def unrestricted_redirect_permanent(cls, *args, **kwargs):
-        """\
+    def unrestricted_redirect_permanent(cls, *args, **kwargs) -> "Response":
+        """
         Return an HTTP permanent redirect reponse.
 
         :param location: the URI of the new location. If relative this will be
@@ -1024,8 +1032,8 @@ class Response(object):
         return cls.unrestricted_redirect(*args, **kwargs)
 
     @classmethod
-    def unrestricted_redirect_temporary(cls, *args, **kwargs):
-        """\
+    def unrestricted_redirect_temporary(cls, *args, **kwargs) -> "Response":
+        """
         Return an HTTP permanent redirect reponse.
 
         :param location: the URI of the new location. If relative this will be
@@ -1045,7 +1053,7 @@ class Response(object):
         _is_safe_url=is_safe_url,
         allowed_hosts=frozenset(),
         **kwargs,
-    ):
+    ) -> "Response":
         """
         Return an HTTP redirect reponse (30x). Will only redirect to the
         current host or hosts in the ``allowed_hosts`` list. A ``ValueError``
@@ -1072,19 +1080,22 @@ class Response(object):
         """
         # Create the fallback redirect response always so that
         # changes to route names don't result in latent bugs
+        fallback_response = None
         if fallback:
-            fallback = Response.unrestricted_redirect(fallback, status=status, **kwargs)
-        if callable(url) or "//" not in url:
+            fallback_response = cls.unrestricted_redirect(
+                fallback, status=status, **kwargs
+            )
+        if url and (
+            callable(url) or "//" not in url or _is_safe_url(url, allowed_hosts)
+        ):
             return cls.unrestricted_redirect(url, status=status, **kwargs)
 
-        if url and _is_safe_url(url, allowed_hosts):
-            return cls.unrestricted_redirect(url, status=status, **kwargs)
-        if fallback:
-            return fallback
+        if fallback_response:
+            return fallback_response
         raise ValueError("Unsafe URL")
 
     @classmethod
-    def redirect_permanent(cls, *args, **kwargs):
+    def redirect_permanent(cls, *args, **kwargs) -> "Response":
         """
         Return an HTTP permanent redirect reponse.
 
@@ -1097,7 +1108,7 @@ class Response(object):
         return cls.redirect(*args, **kwargs)
 
     @classmethod
-    def redirect_temporary(cls, *args, **kwargs):
+    def redirect_temporary(cls, *args, **kwargs) -> "Response":
         """
         Return an HTTP permanent redirect reponse.
 
@@ -1110,7 +1121,7 @@ class Response(object):
         return cls.redirect(*args, **kwargs)
 
     @classmethod
-    def meta_refresh(cls, location, delay=1, request=None):
+    def meta_refresh(cls, location, delay=1, **kwargs) -> "Response":
         """
         Return an HTML page containing a <meta http-equiv="refresh"> tag,
         causing the browser to redirect to the given location after ``delay``
@@ -1121,21 +1132,19 @@ class Response(object):
                          request.
 
         """
-        if "://" not in location:
-            if request is None:
-                request = fresco.context.request
-            location = request.resolve_url(location)
-        return cls(
-            [
-                (
-                    "<!DOCTYPE html>"
-                    "<html>"
-                    '<head><meta http-equiv="refresh" content="0; url={0}"></head>'
-                    '<body><p><a href="{0}">Click here to continue</a></p></body>'
-                    "</html>"
-                ).format(location)
+        response = cls.redirect(location, **kwargs)
+        location = response.get_header("location")
+        return response.replace(
+            status="200 OK",
+            content=[
+                f"<!DOCTYPE html>"
+                f"<html>"
+                f'<head><meta http-equiv="refresh" content="0; url={location}"></head>'
+                f'<body><p><a href="{location}">Click here to continue</a></p></body>'
+                f"</html>"
             ],
             content_type="text/html",
+            location=None,
         )
 
     @classmethod
@@ -1149,7 +1158,7 @@ class Response(object):
         headers=None,
         dumps=stdlib_json.dumps,
         **kwargs,
-    ):
+    ) -> "Response":
         """
         Return an ``application/json`` response with the given data
         JSON serialized

fresco/routeargs.py

@@ -12,6 +12,7 @@
 #     See the License for the specific language governing permissions and
 #     limitations under the License.
 #
+from collections.abc import Sequence
 from operator import attrgetter, itemgetter, methodcaller
 from fresco.exceptions import MissingRouteArg
 from fresco.request import Request
@@ -19,6 +20,7 @@ from itertools import cycle
 from typing import Any
 from typing import Callable
 from typing import Mapping
+from typing import Union
 
 __all__ = (
     "routearg",
@@ -138,7 +140,7 @@ def map_magics(dest):
 
 
 @map_magics("raise_exception")
-class LazyException(object):
+class LazyException:
     """
     A lazy exception uses magic methods to intercept any access to the object
     and raise an exception.
@@ -151,7 +153,7 @@ class LazyException(object):
         raise self.__dict__["_exception"]
 
 
-class RouteArg(object):
+class RouteArg:
     """
     RouteArg objects can be used as keyword arguments in a route definition.
     RouteArgs can extract information from the request and make it available
@@ -194,7 +196,7 @@ class RouteArg(object):
         self.route = route
         self.name = name
 
-    def __call__(self, request):
+    def __call__(self, request: Request) -> Any:
         return None
 
 
@@ -225,7 +227,7 @@ def routearg(func, *args, **kwargs):
 
 
 class RequestArg(RouteArg):
-    """\
+    """
     Extract a view keyword argument from the request object.
     """
 
@@ -241,9 +243,19 @@ class RequestArg(RouteArg):
     #: input
     converter_exceptions = (ValueError, TypeError)
 
+    converter: Union[
+        Callable[[list[str]], Any],
+        Callable[[str], Any],
+    ]
+
     def __init__(
         self,
-        converter=None,
+        converter: Union[
+            Sequence[
+                Callable[[str], Any],
+            ],
+            Callable[[str], Any]
+        ] = str,
         key=None,
         default=_marker,
         exception=MissingRouteArg,
@@ -251,11 +263,13 @@ class RequestArg(RouteArg):
         super(RequestArg, self).__init__(default, exception)
         self.formkey = key
         self.getter: Callable[[Mapping], Any]
-        self.is_list = isinstance(converter, list)
+        self.is_list = isinstance(converter, Sequence)
         if self.is_list:
-            self.converter = lambda vs: [c(v) for c, v in zip(cycle(converter), vs)]
+            def list_converter(vs: list[str]) -> list[Any]:
+                return [c(v) for c, v in zip(cycle(converter), vs)]  # type: ignore
+            self.converter = list_converter
         else:
-            self.converter = converter
+            self.converter = converter  # type: ignore
 
     def configure(self, route, name):
         if self.formkey is None:
@@ -372,7 +386,7 @@ class CookieArg(RequestArg):
 
     source = RequestArg.cookies
 
-    def getter(self, cookies):
+    def getter(self, cookies):  # type: ignore
         if self.is_list:
             return cookies.getlist(self.formkey)
         else: