Prepare for 2.1.0 (#528)

Author: RobertoPrevato

.github/workflows/main.yml

@@ -30,7 +30,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ 3.9, "3.10", "3.11", "3.12", "3.13"]
+        python-version: [3.9, "3.10", "3.11", "3.12", "3.13"]
     runs-on: windows-latest
     if: github.event_name == 'pull_request' || github.event_name == 'push'
 
@@ -181,7 +181,7 @@ jobs:
 
       - name: Install build dependencies
         run: |
-          pip install cython==3.0.11
+          pip install cython==3.0.12
           pip install --upgrade build
 
       - name: Compile Cython extensions
@@ -227,10 +227,10 @@ jobs:
           merge-multiple: true
           path: dist
 
-      - name: Use Python 3.11
+      - name: Use Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: '3.12'
 
       - name: Install dependencies
         run: |

CHANGELOG.md

@@ -5,6 +5,62 @@ 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.1.0] - 2025-03-23
+
+- Remove support for Python 3.8, by @bymoye.
+- Fix a bug in the `ClientSession`, happening when the server returns a response
+  body without specifying `Content-Length` and without specifying a
+  `Transfer-Encoding`.
+- Fix a bug in the `ClientSession`, happening when a server closes the
+  connection, and the response content is not set as completed.
+- Add a default `User-Agent` to web requests sent using the `ClientSession`,
+  the user agent is: `python-blacksheep/{__version__}`.
+- Add an async method `raise_for_status` to the `Response` object, which raises
+  an exception of type `FailedRequestError` if the response status is not in
+  the range **200-299**. The method is asynchronous because in case of failure
+  it waits for the response body to be downloaded, to include it in the raised
+  exception.
+- Add support for specifying a prefix for the `Router`, and for configuring a
+  global prefix for all routes using the env variable `APP_ROUTE_PREFIX`.
+  If specified, the prefix is applied to all routes registered in the
+  application router. The prefix is used automatically by the
+  `serve_files` method, the `get_absolute_url_to_path` method, and by the
+  OpenAPI UI feature, to serve documentation to the correct path.
+  This feature is useful when exposing applications behind proxies using
+  path based routing, to maintain the same path between the proxy server and
+  the BlackSheep application. This is an alternative approach to the one used
+  by the `root_path` offered by `ASGI` (still supported in `BlackSheep`).
+  ASGI `root_path` and route prefix in BlackSheep are alternative ways to
+  address the same issue, and should not be used together.
+- Improve the OpenAPI UI to support router prefixes, and fetching the
+  specification file using relative links.
+- Upgrade to `Cython` to `3.0.12` in the GitHub Workflow.
+- Handle setuptools warning: _SetuptoolsDeprecationWarning: License classifiers are deprecated_.
+- Improve `pyproject.toml` to use `tool.setuptools.packages.find`.
+- Add the missing "utf8" encoding to the `request.path` property decode call.
+- Add a middleware to handle automatic redirects from URLs that do not end with
+  a "/" towards the same path with a trailing slash. This is useful for
+  endpoints that serve HTML documents, to ensure that relative URLs in the
+  response body are correctly resolved
+  (`from blacksheep.server.redirects import get_trailing_slash_middleware`).
+- Add a built-in strategy to handle startup errors and display an error page
+  when an application fails during initialization, in
+  `blacksheep.server.diagnostics.get_diagnostic_app`. Error details are not
+  displayed by default, but can be displayed setting the environment variable
+  `APP_SHOW_ERROR_DETAILS` to a value such as `1` or `true`.
+- Use `asyncio_mode=auto` for `pytest` (remove `@pytest.mark.asyncio` decorators).
+- Use `Python 3.12` to publish the package, in the GitHub Workflow.
+- Modify the `Application` object to instantiate requests in a dedicated method
+  `instantiate_request`. This is to better support code that modifies how
+  incoming requests are created.
+- Modify the `OpenAPIHandler` class to support specifying the list of `Server`
+  objects in the constructor.
+- Update `essentials-openapi` pinned version, by @stollero.
+- Bump jinja2 from 3.1.4 to 3.1.6.
+- Bump cryptography from 44.0.0 to 44.0.1.
+- Remove `py` from the list of dependencies in `requirements.txt`.
+- Correct some docstrings.
+
 ## [2.0.8] - 2025-01-25
 
 - Add Python 3.13 to the build matrix and several maintenance fixes, by @waketzheng.

Makefile

@@ -90,6 +90,7 @@ format:
 check-flake8:
 	@echo "$(BOLD)Checking flake8$(RESET)"
 	@flake8 blacksheep 2>&1
+	@flake8 itests 2>&1
 	@flake8 tests 2>&1
 
 

blacksheep/__init__.py

@@ -4,7 +4,7 @@
 """
 
 __author__ = "Roberto Prevato <roberto.prevato@gmail.com>"
-__version__ = "2.0.8"
+__version__ = "2.1.0"
 
 from .contents import Content as Content
 from .contents import FormContent as FormContent

blacksheep/client/connection.py

@@ -319,6 +319,7 @@ def connection_lost(self, exc) -> None:
             self.response.content, IncomingContent
         ):
             self.response.content.exc = ConnectionLostError()
+            self.response.content.complete.set()
 
         if self._pending_task:
             self.response_ready.set()
@@ -341,6 +342,11 @@ def on_headers_complete(self) -> None:
 
     def _has_content(self) -> bool:
         assert self.response is not None
+
+        content_type = self.response.get_first_header(b"content-type")
+        if content_type:
+            return True
+
         content_length = self.response.get_first_header(b"content-length")
 
         if content_length:

blacksheep/client/session.py

@@ -4,7 +4,7 @@
 from typing import Any, AnyStr, Callable, Dict, List, Optional, Tuple, Type, Union, cast
 from urllib.parse import urlencode
 
-from blacksheep import URL, Content, InvalidURL, Request, Response
+from blacksheep import URL, Content, InvalidURL, Request, Response, __version__
 from blacksheep.common.types import HeadersType, ParamsType, URLType, normalize_headers
 from blacksheep.middlewares import get_middlewares_chain
 from blacksheep.utils.aio import get_running_loop
@@ -52,6 +52,8 @@ def __init__(self, request, cookies: Optional[CookieJar] = None):
 
 
 class ClientSession:
+    USER_AGENT = f"python-blacksheep/{__version__}".encode("utf-8")
+
     def __init__(
         self,
         loop: Optional[AbstractEventLoop] = None,
@@ -330,6 +332,9 @@ async def send(self, request: Request) -> Response:
     async def _send_core(self, request: Request) -> Response:
         self.check_permanent_redirects(request)
 
+        if not request.has_header(b"user-agent"):
+            request.add_header(b"user-agent", self.USER_AGENT)
+
         return await self._send_using_connection(request)
 
     async def _send_using_connection(self, request, attempt: int = 1) -> Response:

blacksheep/common/__init__.py

@@ -6,5 +6,11 @@ def extend(obj, cls):
     performance fee, so that said fee is paid only when features are used.
     """
     base_cls = obj.__class__
-    base_cls_name = obj.__class__.__name__ + "_" + cls.__name__
+
+    # Check if the mixin is already applied
+    if cls in base_cls.__mro__:
+        return
+
+    # Create a new class that combines the mixin and the original class
+    base_cls_name = f"{base_cls.__name__}_{cls.__name__}"
     obj.__class__ = type(base_cls_name, (cls, base_cls), {})

blacksheep/contents.pyi

@@ -103,7 +103,7 @@ def parse_www_form(content: str) -> Dict[str, Union[str, List[str]]]:
     """Parses application/x-www-form-urlencoded content"""
 
 def write_www_form_urlencoded(
-    data: Union[Dict[str, str], List[Tuple[str, str]]]
+    data: Union[Dict[str, str], List[Tuple[str, str]]],
 ) -> bytes: ...
 
 class ServerSentEvent:

blacksheep/exceptions.pxd

@@ -27,3 +27,7 @@ cdef class InvalidArgument(Exception):
 
 cdef class InvalidOperation(Exception):
     pass
+
+
+cdef class FailedRequestError(HTTPException):
+    cdef public str data

blacksheep/exceptions.pyi

@@ -50,3 +50,11 @@ class InternalServerError(HTTPException):
 class NotImplementedByServer(HTTPException):
     def __init__(self, message: str = "Not Implemented"):
         super().__init__(501, message)
+
+class FailedRequestError(HTTPException):
+    def __init__(self, status: int, data: str) -> None:
+        super().__init__(
+            status,
+            f"The response status code does not indicate success: {status}. Response body: {data}",
+        )
+        self.data = data