Prepare for 2.0.7

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-ignore = E203, E266, W503
+ignore = E203, E266, W503, E704, E701
 max-line-length = 88
 max-complexity = 18
 per-file-ignores =

.github/workflows/main.yml

@@ -93,7 +93,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -r requirements.txt
-          pip install black isort flake8
+          pip install black==24.2.0 isort==5.13.2 flake8==7.0.0
 
       - name: Compile Cython extensions
         run: |

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.7] - 2024-02-17 :tulip:
+
+- Fixes bug [#38](https://github.com/Neoteroi/BlackSheep-Docs/issues/38),
+  to support properly `list[T]` and `tuple[T]` when defining query string
+  parameters. Reported by @ranggakd.
+- Passes annotated origin type to build OpenAPI docs (#475), by @tyzhnenko.
+- Fixes #481, disabling signal handling by default to avoid negative side
+  effects. Handling signals is now opt-in and can be achieved using the env
+  variable `APP_SIGNAL_HANDLER=1`. The `is_stopping` function is modified to
+  work only when the option is enabled. Issue reported by @netanel-haber.
+- Upgrades `black` version and format files accordingly.
+
 ## [2.0.6] - 2024-01-17 :kr: :heart:
 
 - Adds built-in support for [Server-Sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events).

blacksheep/__init__.py

@@ -2,8 +2,9 @@
 Root module of the framework. This module re-exports the most commonly
 used types to reduce the verbosity of the imports statements.
 """
+
 __author__ = "Roberto Prevato <[email protected]>"
-__version__ = "2.0.6"
+__version__ = "2.0.7"
 
 from .contents import Content as Content
 from .contents import FormContent as FormContent

blacksheep/baseapp.pyi

@@ -18,6 +18,7 @@ class BaseApplication:
         self.router = router
         self.exceptions_handlers = self.init_exceptions_handlers()
         self.show_error_details = show_error_details
+
     def init_exceptions_handlers(self) -> ExceptionHandlersType: ...
     async def handle(self, request: Request) -> Response: ...
     async def handle_internal_server_error(

blacksheep/common/types.py

@@ -1,6 +1,7 @@
 """
 Common types annotations and functions.
 """
+
 from typing import AnyStr, Dict, Iterable, List, Optional, Tuple, Union
 
 from blacksheep.url import URL

blacksheep/contents.pyi

@@ -16,8 +16,10 @@ class Content:
         self.type = content_type
         self.body = data
         self.length = len(data)
+
     async def read(self) -> bytes:
         return self.body
+
     def dispose(self) -> None: ...
 
 class StreamedContent(Content):
@@ -31,6 +33,7 @@ class StreamedContent(Content):
         self.body = None
         self.length = data_length
         self.generator = data_provider
+
     async def get_parts(self) -> AsyncIterable[bytes]: ...
 
 class ASGIContent(Content):
@@ -39,6 +42,7 @@ class ASGIContent(Content):
         self.body = None
         self.length = -1
         self.receive = receive
+
     def dispose(self): ...
     async def stream(self) -> AsyncIterable[bytes]: ...
     async def read(self) -> bytes: ...
@@ -85,6 +89,7 @@ class FormPart:
         self.file_name = file_name
         self.content_type = content_type
         self.charset = charset
+
     def __repr__(self):
         return f"<FormPart {self.name} - at {id(self)}>"
 

blacksheep/cookies.pyi

@@ -36,6 +36,7 @@ class Cookie:
         self.secure = secure
         self.max_age = max_age
         self.same_site = same_site
+
     def clone(self) -> "Cookie": ...
     def __eq__(self, other: Union[str, bytes, "Cookie"]) -> bool: ...
     def __repr__(self) -> str:

blacksheep/headers.pyi

@@ -5,6 +5,7 @@ class Header:
     def __init__(self, name: bytes, value: bytes):
         self.name = name
         self.value = value
+
     def __repr__(self) -> str: ...
     def __iter__(self) -> Generator[bytes, None, None]: ...
     def __eq__(self, other: object) -> bool: ...
@@ -14,6 +15,7 @@ HeaderType = Tuple[bytes, bytes]
 class Headers:
     def __init__(self, values: Optional[List[HeaderType]] = None):
         self.values = values
+
     def get(self, name: bytes) -> Tuple[HeaderType]: ...
     def get_tuples(self, name: bytes) -> List[HeaderType]: ...
     def get_first(self, key: bytes) -> Optional[bytes]: ...

blacksheep/messages.pyi

@@ -38,11 +38,13 @@ class Message:
         otherwise kept as raw bytes.
         In case of ambiguity, use the dedicated `multiparts()` method.
         """
+
     async def multipart(self) -> List[FormPart]:
         """
         Returns parts read from multipart/form-data, if present, otherwise
         None
         """
+
     def declares_content_type(self, type: bytes) -> bool: ...
     def declares_json(self) -> bool: ...
     def declares_xml(self) -> bool: ...
@@ -68,6 +70,7 @@ class Request(Message):
         self.user: Optional[Identity] = ...
         self.scope: ASGIScopeInterface = ...
         self._session: Optional[Session]
+
     @classmethod
     def incoming(
         cls, method: str, path: bytes, query: bytes, headers: List[HeaderType]
@@ -143,6 +146,7 @@ class Response(Message):
     ) -> None:
         self.status = status
         self.content = content
+
     def __repr__(self) -> str: ...
     @property
     def cookies(self) -> Cookies: ...

blacksheep/server/authentication/oidc.py

@@ -2,6 +2,7 @@
 This module provides classes to handle OpenID Connect authentication through integration
 with OAuth applications, supporting Authorization Code Grant and Hybrid flows.
 """
+
 import logging
 from abc import ABC, abstractmethod
 from dataclasses import dataclass

blacksheep/server/bindings.py

@@ -7,6 +7,7 @@
 See:
     https://docs.microsoft.com/en-us/aspnet/core/mvc/models/model-binding?view=aspnetcore-2.2
 """
+
 from abc import abstractmethod
 from base64 import urlsafe_b64decode
 from collections.abc import Iterable as IterableAbc
@@ -442,8 +443,8 @@ def _get_default_converter_single(self, expected_type):
         if expected_type is bytes:
             # note: the code is optimized for strings here, not bytes
             # since most of times the user will want to handle strings
-            return (
-                lambda value: urlsafe_b64decode(value.encode("utf8")).decode("utf8")
+            return lambda value: (
+                urlsafe_b64decode(value.encode("utf8")).decode("utf8")
                 if value
                 else None
             )
@@ -645,8 +646,8 @@ def _get_default_converter_single(self, expected_type):
             return lambda value: dateutil_parser(unquote(value)) if value else None
 
         if expected_type is date:
-            return (
-                lambda value: dateutil_parser(unquote(value)).date() if value else None
+            return lambda value: (
+                dateutil_parser(unquote(value)).date() if value else None
             )
 
         raise MissingConverterError(expected_type, self.__class__)
@@ -684,10 +685,8 @@ def _get_default_converter(self, expected_type):
             return lambda value: dateutil_parser(unquote(value[0])) if value else None
 
         if expected_type is date:
-            return (
-                lambda value: dateutil_parser(unquote(value[0])).date()
-                if value
-                else None
+            return lambda value: (
+                dateutil_parser(unquote(value[0])).date() if value else None
             )
 
         raise MissingConverterError(expected_type, self.__class__)

blacksheep/server/env.py

@@ -40,4 +40,4 @@ def __init__(self) -> None:
         self.show_error_details = truthy(os.environ.get("APP_SHOW_ERROR_DETAILS", ""))
         self.mount_auto_events = truthy(os.environ.get("APP_MOUNT_AUTO_EVENTS", "1"))
         self.use_default_router = truthy(os.environ.get("APP_DEFAULT_ROUTER", "1"))
-        self.add_signal_handler = truthy(os.environ.get("APP_SIGNAL_HANDLER", "1"))
+        self.add_signal_handler = truthy(os.environ.get("APP_SIGNAL_HANDLER", ""))

blacksheep/server/normalization.py

@@ -136,8 +136,7 @@ def ensure_response(result) -> Response:
     return result
 
 
-class NormalizationError(Exception):
-    ...
+class NormalizationError(Exception): ...
 
 
 class UnsupportedSignatureError(NormalizationError):
@@ -238,6 +237,23 @@ def __init__(self, parameter_name, route):
     Tuple[UUID],
 }
 
+try:
+    # Note: try catch here is to support Python 3.8
+    # it can be removed when support for Python 3.8 is dropped
+    _types_handled_with_query |= {
+        list[str],
+        list[int],
+        list[float],
+        list[bool],
+        list[UUID],
+        tuple[str],
+        tuple[int],
+        tuple[float],
+        tuple[bool],
+    }
+except TypeError:
+    pass
+
 
 def _check_union(
     parameter: ParamInfo, annotation: Any, method: Callable[..., Any]

blacksheep/server/openapi/common.py

@@ -6,6 +6,7 @@
 OpenAPI Documentation v2 and v3 (currently only v3 is supported) from these types, and
 potentially in the future v4, if it will be so different from v3.
 """
+
 import json
 from abc import ABC, abstractmethod
 from dataclasses import dataclass

blacksheep/server/openapi/docstrings.py

@@ -17,6 +17,7 @@
 * tests/test_openapi_docstrings.py
 
 """
+
 import re
 import warnings
 from abc import ABC, abstractmethod
@@ -212,9 +213,9 @@ def parse_docstring(self, docstring: str) -> DocstringInfo:
             description=collapse(description),
             parameters=self.get_parameters_info(docstring),
             return_type=return_type,
-            return_description=collapse(return_description)
-            if return_description
-            else None,
+            return_description=(
+                collapse(return_description) if return_description else None
+            ),
         )
 
 
@@ -401,9 +402,9 @@ def parse_docstring(self, docstring: str) -> DocstringInfo:
             description=collapse(info.description),
             parameters=self.get_parameters_info(docstring),
             return_type=return_info.return_type if return_info else None,
-            return_description=collapse(return_info.return_description)
-            if return_info
-            else None,
+            return_description=(
+                collapse(return_info.return_description) if return_info else None
+            ),
         )
 
 
@@ -482,9 +483,9 @@ def parse_docstring(self, docstring: str) -> DocstringInfo:
             description=collapse(info.description),
             parameters=self.get_parameters_info(docstring),
             return_type=return_info.return_type if return_info else None,
-            return_description=collapse(return_info.return_description)
-            if return_info
-            else None,
+            return_description=(
+                collapse(return_info.return_description) if return_info else None
+            ),
         )
 
 

blacksheep/server/openapi/ui.py

@@ -59,8 +59,7 @@ def get_ui_handler(self) -> Callable[[Request], Response]:
         """
 
     @property
-    def default_ui_files(self) -> UIFilesOptions:
-        ...
+    def default_ui_files(self) -> UIFilesOptions: ...
 
 
 class SwaggerUIProvider(UIProvider):

blacksheep/server/openapi/v3.py

@@ -399,9 +399,9 @@ def __init__(
             DataClassTypeHandler(),
             PydanticModelTypeHandler(),
         ]
-        self._binder_docs: Dict[
-            Type[Binder], Iterable[Union[Parameter, Reference]]
-        ] = {}
+        self._binder_docs: Dict[Type[Binder], Iterable[Union[Parameter, Reference]]] = (
+            {}
+        )
         self.security_schemes = security_schemes or {}
 
     @property
@@ -915,9 +915,11 @@ def get_parameters(
                         param_info.source or ParameterSource.QUERY
                     ),
                     required=param_info.required,
-                    schema=self.get_schema_by_type(param_info.value_type)
-                    if param_info.value_type
-                    else None,
+                    schema=(
+                        self.get_schema_by_type(param_info.value_type)
+                        if param_info.value_type
+                        else None
+                    ),
                     description=param_info.description,
                     example=param_info.example,
                 )
@@ -975,9 +977,9 @@ def _get_content_from_response_info(
 
         for content in response_content:
             if content.content_type not in oad_content:
-                oad_content[
-                    content.content_type
-                ] = self._get_media_type_from_content_doc(content)
+                oad_content[content.content_type] = (
+                    self._get_media_type_from_content_doc(content)
+                )
             else:
                 raise DuplicatedContentTypeDocsException(content.content_type)
 

blacksheep/server/process.py

@@ -1,9 +1,13 @@
 """
 Provides functions related to the server process.
 """
+
+import os
 import signal
 from typing import TYPE_CHECKING
 
+from blacksheep.utils import truthy
+
 if TYPE_CHECKING:
     from blacksheep.server.application import Application
 
@@ -15,6 +19,10 @@ def is_stopping() -> bool:
     Returns a value indicating whether the server process received a SIGINT or a SIGTERM
     signal, and therefore the application is stopping.
     """
+    if not truthy(os.environ.get("APP_SIGNAL_HANDLER", "")):
+        raise RuntimeError(
+            "This function can only be used if the env variable `APP_SIGNAL_HANDLER=1`"
+        )
     return _STOPPING
 
 

blacksheep/server/sse.py

@@ -1,6 +1,7 @@
 """
 This module offer built-in functions for Server Sent Events.
 """
+
 from typing import AsyncIterable, Callable, List, Optional, Tuple
 
 from blacksheep.contents import ServerSentEvent, StreamedContent

blacksheep/testing/messages.py

@@ -41,9 +41,9 @@ async def __call__(self):
         return {
             "body": message,
             "type": "http.message",
-            "more_body": False
-            if (len(self.messages) == self.index or not message)
-            else True,
+            "more_body": (
+                False if (len(self.messages) == self.index or not message) else True
+            ),
         }