microdot 2.6.2__tar.gz → 2.8.0__tar.gz

{microdot-2.6.2/src/microdot.egg-info → microdot-2.8.0}/PKG-INFO

@@ -1,15 +1,19 @@
 Metadata-Version: 2.4
 Name: microdot
-Version: 2.6.2
+Version: 2.8.0
 Summary: The impossibly small web framework for MicroPython
 Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
-Project-URL: Homepage, https://github.com/miguelgrinberg/microdot
-Project-URL: Bug Tracker, https://github.com/miguelgrinberg/microdot/issues
+License-Expression: MIT
+Project-URL: Homepage, https://code.miguelgrinberg.com/miguelgrinberg/microdot
+Project-URL: Documentation, https://microdot.readthedocs.io/
+Project-URL: Source Code, https://code.miguelgrinberg.com/miguelgrinberg/microdot
+Project-URL: Issue Tracker, https://code.miguelgrinberg.com/miguelgrinberg/microdot/issues
+Project-URL: Changelog, https://code.miguelgrinberg.com/miguelgrinberg/microdot/src/branch/main/CHANGES.md
+Project-URL: Funding, https://code.miguelgrinberg.com/miguelgrinberg/microdot#sponsor-this-project
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: Implementation :: MicroPython
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
@@ -22,8 +26,9 @@ Requires-Dist: furo; extra == "docs"
 Requires-Dist: pyjwt; extra == "docs"
 Dynamic: license-file
 
-# microdot
-[![Build status](https://github.com/miguelgrinberg/microdot/workflows/build/badge.svg)](https://github.com/miguelgrinberg/microdot/actions) [![codecov](https://codecov.io/gh/miguelgrinberg/microdot/branch/main/graph/badge.svg)](https://codecov.io/gh/miguelgrinberg/microdot)
+# Microdot
+
+[![tests](https://code.miguelgrinberg.com/miguelgrinberg/microdot/badges/workflows/tests.yml/badge.svg)](https://code.miguelgrinberg.com/miguelgrinberg/microdot/actions)
 
 *“The impossibly small web framework for Python and MicroPython”*
 
@@ -45,14 +50,16 @@ app.run()
 
 ## Resources
 
-- [Change Log](https://github.com/miguelgrinberg/microdot/blob/main/CHANGES.md)
-- Documentation
-    - [Latest](https://microdot.readthedocs.io/en/latest/)
-    - [Stable (v2)](https://microdot.readthedocs.io/en/stable/)
+- [git](https://code.miguelgrinberg.com/miguelgrinberg/microdot)
+- [Change Log](https://code.miguelgrinberg.com/miguelgrinberg/microdot/src/branch/main/CHANGES.md)
+- [Documentation](https://microdot.readthedocs.io/)
+- [PyPI](https://pypi.python.org/pypi/microdot)
+- [Contributor's guide](CONTRIBUTING.md)
+- [Security policy](SECURITY.md)
 
-The following links are for version 1 of Microdot:
+The following links are for legacy version 1 of Microdot:
 
-- [Code](https://github.com/miguelgrinberg/microdot/tree/v1)
+- [git](https://github.com/miguelgrinberg/microdot/tree/v1)
 - [Documentation](https://microdot.readthedocs.io/en/v1/)
 
 Note that version 1 is no longer maintained, so you should consider migrating
@@ -73,3 +80,16 @@ MicroPython and CPython:
 - OpenAPI integration, similar to [APIFairy](https://github.com/miguelgrinberg/apifairy) for Flask
 
 Do you have other ideas to propose? Let's [discuss them](https://github.com/:miguelgrinberg/microdot/discussions/new?category=ideas)!
+
+Sponsor this project
+--------------------
+
+This project relies on contributions from its users. If you benefit from it please consider making a single or ongoing monetary contribution in one of the following platforms:
+
+- [Github Sponsors](https://github.com/sponsors/miguelgrinberg)
+- [Patreon](https://patreon.com/miguelgrinberg)
+- [Buy me a Coffee](https://buymeacoffee.com/miguelgrinberg)
+- [thanks.dev](https://thanks.dev/u/gh/miguelgrinberg)
+- [PayPal](https://paypal.me/miguelgrinberg)
+
+Thank you!

{microdot-2.6.2 → microdot-2.8.0}/README.md

@@ -1,5 +1,6 @@
-# microdot
-[![Build status](https://github.com/miguelgrinberg/microdot/workflows/build/badge.svg)](https://github.com/miguelgrinberg/microdot/actions) [![codecov](https://codecov.io/gh/miguelgrinberg/microdot/branch/main/graph/badge.svg)](https://codecov.io/gh/miguelgrinberg/microdot)
+# Microdot
+
+[![tests](https://code.miguelgrinberg.com/miguelgrinberg/microdot/badges/workflows/tests.yml/badge.svg)](https://code.miguelgrinberg.com/miguelgrinberg/microdot/actions)
 
 *“The impossibly small web framework for Python and MicroPython”*
 
@@ -21,14 +22,16 @@ app.run()
 
 ## Resources
 
-- [Change Log](https://github.com/miguelgrinberg/microdot/blob/main/CHANGES.md)
-- Documentation
-    - [Latest](https://microdot.readthedocs.io/en/latest/)
-    - [Stable (v2)](https://microdot.readthedocs.io/en/stable/)
+- [git](https://code.miguelgrinberg.com/miguelgrinberg/microdot)
+- [Change Log](https://code.miguelgrinberg.com/miguelgrinberg/microdot/src/branch/main/CHANGES.md)
+- [Documentation](https://microdot.readthedocs.io/)
+- [PyPI](https://pypi.python.org/pypi/microdot)
+- [Contributor's guide](CONTRIBUTING.md)
+- [Security policy](SECURITY.md)
 
-The following links are for version 1 of Microdot:
+The following links are for legacy version 1 of Microdot:
 
-- [Code](https://github.com/miguelgrinberg/microdot/tree/v1)
+- [git](https://github.com/miguelgrinberg/microdot/tree/v1)
 - [Documentation](https://microdot.readthedocs.io/en/v1/)
 
 Note that version 1 is no longer maintained, so you should consider migrating
@@ -49,3 +52,16 @@ MicroPython and CPython:
 - OpenAPI integration, similar to [APIFairy](https://github.com/miguelgrinberg/apifairy) for Flask
 
 Do you have other ideas to propose? Let's [discuss them](https://github.com/:miguelgrinberg/microdot/discussions/new?category=ideas)!
+
+Sponsor this project
+--------------------
+
+This project relies on contributions from its users. If you benefit from it please consider making a single or ongoing monetary contribution in one of the following platforms:
+
+- [Github Sponsors](https://github.com/sponsors/miguelgrinberg)
+- [Patreon](https://patreon.com/miguelgrinberg)
+- [Buy me a Coffee](https://buymeacoffee.com/miguelgrinberg)
+- [thanks.dev](https://thanks.dev/u/gh/miguelgrinberg)
+- [PayPal](https://paypal.me/miguelgrinberg)
+
+Thank you!

{microdot-2.6.2 → microdot-2.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "microdot"
-version = "2.6.2"
+version = "2.8.0"
 authors = [
     { name = "Miguel Grinberg", email = "miguel.grinberg@gmail.com" },
 ]
@@ -10,9 +10,9 @@ classifiers = [
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: Implementation :: MicroPython",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
 ]
+license = "MIT"
 requires-python = ">=3.8"
 dependencies = [
 ]
@@ -22,8 +22,12 @@ file = "README.md"
 content-type = "text/markdown"
 
 [project.urls]
-Homepage = "https://github.com/miguelgrinberg/microdot"
-"Bug Tracker" = "https://github.com/miguelgrinberg/microdot/issues"
+Homepage = "https://code.miguelgrinberg.com/miguelgrinberg/microdot"
+Documentation = "https://microdot.readthedocs.io/"
+"Source Code" = "https://code.miguelgrinberg.com/miguelgrinberg/microdot"
+"Issue Tracker" = "https://code.miguelgrinberg.com/miguelgrinberg/microdot/issues"
+Changelog = "https://code.miguelgrinberg.com/miguelgrinberg/microdot/src/branch/main/CHANGES.md"
+Funding = "https://code.miguelgrinberg.com/miguelgrinberg/microdot#sponsor-this-project"
 
 [project.optional-dependencies]
 dev = [

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/__init__.py

@@ -1,4 +1,4 @@
 from microdot.microdot import Microdot, Request, Response, abort, redirect, \
     send_file, URLPattern, AsyncBytesIO, iscoroutine  # noqa: F401
 
-__version__ = '2.6.2'
+__version__ = '2.8.0'

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/asgi.pyi

@@ -9,38 +9,38 @@ class Microdot(BaseMicrodot):  # type: ignore[no-redef]
     embedded_server: bool
     def __init__(self, lifespan_startup: Callable[[dict[str, Any]], Awaitable[None]] = ..., lifespan_shutdown: Callable[[dict[str, Any]], Awaitable[None]] = ...) -> None:
         ...
-    
+
     async def handle_lifespan(self, scope: dict[str, Any], receive: Callable[[], Awaitable[dict[str, Any]]], send: Callable[[dict[str, Any]], Awaitable[None]]) -> None:
         ...
-    
+
     async def asgi_app(self, scope: dict[str, Any], receive: Callable[[], Awaitable[dict[str, Any]]], send: Callable[[dict[str, Any]], Awaitable[None]]):
         ...
-    
+
     async def __call__(self, scope: dict[str, Any], receive: Callable[[], Awaitable[dict[str, Any]]], send: Callable[[dict[str, Any]], Awaitable[None]]):
         ...
-    
+
     def shutdown(self) -> None:
         ...
-    
+
     def run(self, host: str = ..., port: int = ..., debug: bool = ..., **options: Any) -> None:  # type: ignore[override]
         ...
-    
+
 
 
 class WebSocket(BaseWebSocket):
     closed: bool
     async def handshake(self) -> None:
         ...
-    
+
     async def receive(self) -> bytes | str:
         ...
-    
+
     async def send(self, data: bytes | str) -> None:  # type: ignore[override]
         ...
-    
+
     async def close(self) -> None:
         ...
-    
+
 
 
 async def websocket_upgrade(request: Request) -> BaseWebSocket:

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/auth.pyi

@@ -6,13 +6,13 @@ class BaseAuth:
     error_callback: Callable[[Request], Any | Awaitable[Any]]
     def __init__(self) -> None:
         ...
-    
+
     def __call__(self, f: Callable[..., Any]):
         ...
-    
+
     def optional(self, f: Callable[..., Any]):
         ...
-    
+
 
 
 class BasicAuth(BaseAuth):
@@ -23,14 +23,14 @@ class BasicAuth(BaseAuth):
     error_callback: Callable[[Request], Any | Awaitable[Any]]
     def __init__(self, realm: str = ..., charset: str = ..., scheme: str = ..., error_status: int = ...) -> None:
         ...
-    
+
     async def authentication_error(self, request):
         ...
-    
+
     auth_callback: Callable[[Request, str, str], Any | Awaitable[Any]]
     def authenticate(self, f: Callable[[Request, str, str], Any | Awaitable[Any]]) -> None:
         ...
-    
+
 
 
 class TokenAuth(BaseAuth):
@@ -40,13 +40,13 @@ class TokenAuth(BaseAuth):
     error_callback: Callable[[Request], Any | Awaitable[Any]]
     def __init__(self, header: str = ..., scheme: str = ..., error_status: int = ...) -> None:
         ...
-    
+
     auth_callback: Callable[[Request, str], Any | Awaitable[Any]]
     def authenticate(self, f: Callable[..., Any | Awaitable[Any]]) -> None:
         ...
-    
+
     def errorhandler(self, f: Callable[[Request], Any | Awaitable[Any]]) -> None:
         ...
-    
+
     async def authentication_error(self, request) -> None:
         ...

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/cors.py

@@ -63,13 +63,18 @@ class CORS:
         """
         cors_headers = {}
         origin = request.headers.get('Origin')
+        vary_origin = False
         if self.allowed_origins == '*':
             cors_headers['Access-Control-Allow-Origin'] = origin or '*'
             if origin:
-                cors_headers['Vary'] = 'Origin'
+                vary_origin = True
         elif origin in (self.allowed_origins or []):
             cors_headers['Access-Control-Allow-Origin'] = origin
-            cors_headers['Vary'] = 'Origin'
+            vary_origin = True
+        if vary_origin:
+            if not hasattr(request.g, '_vary'):
+                request.g._vary = set()
+            request.g._vary.add('Origin')
         if self.allow_credentials and \
                 'Access-Control-Allow-Origin' in cors_headers:
             cors_headers['Access-Control-Allow-Credentials'] = 'true'
@@ -103,9 +108,5 @@ class CORS:
         return cors_headers
 
     def after_request(self, request, response):
-        saved_vary = response.headers.get('Vary')
         if request:  # pragma: no branch
             response.headers.update(self.get_cors_headers(request))
-        if saved_vary and saved_vary != response.headers.get('Vary'):
-            response.headers['Vary'] = (
-                saved_vary + ', ' + response.headers['Vary'])

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/cors.pyi

@@ -14,16 +14,16 @@ class CORS:
     max_age: int | None
     def __init__(self, app: Microdot | None = ..., allowed_origins: list[str] | Literal['*'] | None = ..., allow_credentials: bool = ..., allowed_methods: list[str] | None = ..., expose_headers: list[str] | None = ..., allowed_headers: list[str] | None = ..., max_age: int | None = ..., handle_cors: bool = ...) -> None:
         ...
-    
+
     default_options_handler: Callable[[Request], dict[str, str]]
     def initialize(self, app: Microdot, handle_cors: bool = ...) -> None:
         ...
-    
+
     def options_handler(self, request: Request) -> dict[str, str]:
         ...
-    
+
     def get_cors_headers(self, request: Request) -> dict[str, str]:
         ...
-    
+
     def after_request(self, request: Request, response: Response) -> None:
         ...

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/csrf.py

@@ -64,6 +64,11 @@ class CSRF:
                         allow = True
                     elif sfs == 'same-site' and self.allow_subdomains:
                         allow = True
+                    if allow:
+                        if not hasattr(
+                                request.g, '_vary'):  # pragma: no branch
+                            request.g._vary = set()
+                        request.g._vary.add('Sec-Fetch-Site')
                 if not allow and origin and self.cors and \
                         self.cors.allowed_origins != '*':
                     # if we have a list of allowed origins, then we can

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/csrf.pyi

@@ -11,12 +11,12 @@ class CSRF:
     protected_routes: list[Callable[..., Any | Awaitable[Any]]]
     def __init__(self, app: Microdot | None = ..., cors: CORS | None = ..., protect_all: bool = ..., allow_subdomains: bool = ...) -> None:
         ...
-    
+
     def initialize(self, app: Microdot, cors: CORS | None = ...) -> None:
         ...
-    
+
     def exempt(self, f: Callable[..., Any | Awaitable[Any]]) -> Callable[..., Any | Awaitable[Any]]:
         ...
-    
+
     def protect(self, f: Callable[..., Any | Awaitable[Any]]) -> Callable[..., Any | Awaitable[Any]]:
         ...

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/jinja.pyi

@@ -6,20 +6,20 @@ class Template:
     @classmethod
     def initialize(cls, template_dir: str = ..., enable_async: bool = ..., **kwargs) -> None:
         ...
-    
+
     name: str
     template: JinjaTemplate
     def __init__(self, template: str, **kwargs: Any) -> None:
         ...
-    
+
     def generate(self, *args: Any, **kwargs: Any) -> Iterator[str]:
         ...
-    
+
     def render(self, *args: Any, **kwargs: Any) -> str:
         ...
-    
+
     def generate_async(self, *args: Any, **kwargs: Any) -> AsyncIterator[str]:
         ...
-    
+
     async def render_async(self, *args: Any, **kwargs: Any) -> Awaitable[str]:
         ...

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/login.pyi

@@ -6,21 +6,21 @@ class Login:
     user_loader_callback: Callable[[str], Any | Awaitable[Any]]
     def __init__(self, login_url: str = ...) -> None:
         ...
-    
+
     def user_loader(self, f: Callable[[str], Any | Awaitable[Any]]) -> None:
         ...
-    
+
     async def login_user(self, request: Request, user: Any, remember: bool = ..., redirect_url: str = ...) -> Response:
         ...
-    
+
     async def logout_user(self, request: Request) -> None:
         ...
-    
+
     async def get_current_user(self, request: Request):
         ...
-    
+
     def __call__(self, f: Callable[..., Any | Awaitable[Any]]) -> Callable[..., Any | Awaitable[Any]]:
         ...
-    
+
     def fresh(self, f: Callable[..., Any | Awaitable[Any]]) -> Callable[..., Any | Awaitable[Any]]:
         ...

{microdot-2.6.2 → microdot-2.8.0}/src/microdot/microdot.py

@@ -495,8 +495,9 @@ class Request:
 
     @property
     def files(self):
-        """The files uploaded in the request as a dictionary, or ``None`` if
-        the request does not have any files.
+        """The files uploaded in the request as a
+        :class:`MultiDict <microdot.MultiDict>` object, or ``None`` if the
+        request does not have any files.
 
         The :func:`with_form_data <microdot.multipart.with_form_data>`
         decorator must be added to the route that receives file uploads for
@@ -613,7 +614,7 @@ class Response:
         """
         if ';' in value:
             raise ValueError('invalid cookie value')
-        http_cookie = '{cookie}={value}'.format(cookie=cookie, value=value)
+        http_cookie = f'{cookie}={value}'
         if path:
             http_cookie += '; Path=' + path
         if domain:
@@ -819,7 +820,7 @@ class Response:
         if max_age is None:
             max_age = cls.default_send_file_max_age
         if max_age is not None:
-            headers['Cache-Control'] = 'max-age={}'.format(max_age)
+            headers['Cache-Control'] = f'max-age={max_age}'
 
         if compressed:
             headers['Content-Encoding'] = compressed \
@@ -862,7 +863,7 @@ class URLPattern():
                        value of the segment. If omitted, the value is returned
                        as a string.
         """
-        cls.segment_patterns[type_name] = '/({})'.format(pattern)
+        cls.segment_patterns[type_name] = f'/({pattern})'
         cls.segment_parsers[type_name] = parser
 
     def __init__(self, url_pattern):
@@ -889,7 +890,7 @@ class URLPattern():
                     name = segment
                 parser = None
                 if type_.startswith('re:'):
-                    pattern += '/({pattern})'.format(pattern=type_[3:])
+                    pattern += f'/({type_[3:]})'
                 else:
                     if type_ not in self.segment_patterns:
                         raise ValueError('invalid URL segment type')
@@ -927,7 +928,7 @@ class URLPattern():
         return args
 
     def __repr__(self):  # pragma: no cover
-        return 'URLPattern: {}'.format(self.url_pattern)
+        return f'URLPattern: {self.url_pattern}'
 
 
 class HTTPException(Exception):
@@ -936,7 +937,7 @@ class HTTPException(Exception):
         self.reason = reason or str(status_code) + ' error'
 
     def __repr__(self):  # pragma: no cover
-        return 'HTTPException: {}'.format(self.status_code)
+        return f'HTTPException: {self.status_code}'
 
 
 class Microdot:
@@ -1091,6 +1092,24 @@ class Microdot:
         """
         return self.route(url_pattern, methods=['DELETE'])
 
+    def query(self, url_pattern):
+        """Decorator that is used to register a function as a ``QUERY``
+        request handler for a given URL.
+
+        :param url_pattern: The URL pattern that will be compared against
+                            incoming requests.
+
+        This decorator can be used as an alias to the ``route`` decorator with
+        ``methods=['QUERY']``.
+
+        Example::
+
+            @app.query('/users/<int:id>')
+            def query_user(request, id):
+                # ...
+        """
+        return self.route(url_pattern, methods=['QUERY'])
+
     def before_request(self, f):
         """Decorator to register a function to run before each request is
         handled. The decorated function must take a single argument, the
@@ -1560,6 +1579,14 @@ class Microdot:
                 res = await invoke_handler(
                     handler, req, res) or res
         res.is_head = (req and req.method == 'HEAD')
+        if req and hasattr(req.g, '_vary'):
+            if res.headers.get('Vary'):
+                vary = set(
+                    [h.strip() for h in res.headers['Vary'].split(',')])
+                vary.update(req.g._vary)
+            else:
+                vary = req.g._vary
+            res.headers['Vary'] = ', '.join(list(vary))
         return res