Add changed files to reload trigger listener

Co-authored-by: L. Kärkkäinen <Tronic@users.noreply.github.com>

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -21,7 +21,14 @@ body:
     id: code
     attributes:
       label: Code snippet
-      description: Relevant source code, make sure to remove what is not necessary.
+      description: |
+          Relevant source code, make sure to remove what is not necessary. Please try and format your code so that it is easier to read. For example:
+
+              ```python
+              from sanic import Sanic
+
+              app = Sanic("Example")
+              ```
     validations:
       required: false
   - type: textarea
@@ -42,11 +49,16 @@ body:
         - ASGI
     validations:
       required: true
-  - type: input
+  - type: dropdown
     id: os
     attributes:
       label: Operating System
       description: What OS?
+      options:
+        - Linux
+        - MacOS
+        - Windows
+        - Other (tell us in the description)
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/rfc.yml

@@ -0,0 +1,33 @@
+name: 💡 Request for Comments
+description: Open an RFC for discussion
+labels: ["RFC"]
+body:
+  - type: input
+    id: compare
+    attributes:
+      label: Link to code
+      description: If available, share a [comparison](https://github.com/sanic-org/sanic/compare) from a POC branch to main
+      placeholder: https://github.com/sanic-org/sanic/compare/main...some-new-branch
+    validations:
+      required: false
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposal
+      description: A thorough discussion of the proposal discussing the problem it solves, potential code, use cases, and impacts
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context that is relevant
+    validations:
+      required: false
+  - type: checkboxes
+    id: breaking
+    attributes:
+      label: Is this a breaking change?
+      options:
+        - label: "Yes"
+          required: false

.github/workflows/codeql-analysis.yml

@@ -4,10 +4,12 @@ on:
   push:
     branches:
       - main
+      - current-release
       - "*LTS"
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
   schedule:

.github/workflows/coverage.yml

@@ -3,12 +3,14 @@ on:
   push:
     branches:
       - main
+      - current-release
       - "*LTS"
     tags:
       - "!*" # Do not execute on tags
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
 jobs:
   test:

.github/workflows/pr-bandit.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
 
@@ -16,7 +17,6 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         config:
-          - { python-version: 3.7, tox-env: security}
           - { python-version: 3.8, tox-env: security}
           - { python-version: 3.9, tox-env: security}
           - { python-version: "3.10", tox-env: security}

.github/workflows/pr-docs.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
 

.github/workflows/pr-linter.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
 

.github/workflows/pr-python-pypy.yml

@@ -5,11 +5,11 @@ on:
       tox-env:
         description: "Tox Env to run on the PyPy Infra"
         required: false
-        default: "pypy37"
+        default: "pypy310"
       pypy-version:
         description: "Version of PyPy to use"
         required: false
-        default: "pypy-3.7"
+        default: "pypy-3.10"
 jobs:
   testPyPy:
     name: ut-${{ matrix.config.tox-env }}-${{ matrix.os }}

.github/workflows/pr-python310.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
 

.github/workflows/pr-python311.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
 

.github/workflows/pr-python37.yml

@@ -1,35 +0,0 @@
-name: Python 3.7 Tests
-on:
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-    types: [opened, synchronize, reopened, ready_for_review]
-
-jobs:
-  testPy37:
-    if: github.event.pull_request.draft == false
-    name: ut-${{ matrix.config.tox-env }}-${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: true
-      matrix:
-        #         os: [ubuntu-latest, macos-latest]
-        os: [ubuntu-latest]
-        config:
-          - { python-version: 3.7, tox-env: py37 }
-          - { python-version: 3.7, tox-env: py37-no-ext }
-    steps:
-      - name: Checkout the Repository
-        uses: actions/checkout@v2
-        id: checkout-branch
-
-      - name: Run Unit Tests
-        uses: harshanarayana/custom-actions@main
-        with:
-          python-version: ${{ matrix.config.python-version }}
-          test-infra-tool: tox
-          test-infra-version: latest
-          action: tests
-          test-additional-args: "-e=${{ matrix.config.tox-env }}"
-          test-failure-retry: "3"

.github/workflows/pr-python38.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
 

.github/workflows/pr-python39.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
 

.github/workflows/pr-type-check.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
 
@@ -16,7 +17,6 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         config:
-          # - { python-version: 3.7, tox-env: type-checking}
           - { python-version: 3.8, tox-env: type-checking}
           - { python-version: 3.9, tox-env: type-checking}
           - { python-version: "3.10", tox-env: type-checking}

.github/workflows/pr-windows.yml

@@ -3,6 +3,7 @@ on:
   pull_request:
     branches:
       - main
+      - current-release
       - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
 
@@ -15,12 +16,10 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          - { python-version: 3.7, tox-env: py37-no-ext }
           - { python-version: 3.8, tox-env: py38-no-ext }
           - { python-version: 3.9, tox-env: py39-no-ext }
           - { python-version: "3.10", tox-env: py310-no-ext }
           - { python-version: "3.11", tox-env: py310-no-ext }
-          - { python-version: pypy-3.7, tox-env: pypy37-no-ext }
 
     steps:
       - name: Checkout Repository

.github/workflows/publish-images.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
       - name: Checkout repository

.github/workflows/publish-package.yml

@@ -1,28 +1,39 @@
-name: Publish Artifacts
+name: Upload Python Package
+
 on:
   release:
     types: [created]
-
+  workflow_dispatch:
 jobs:
-  publishPythonPackage:
+  build-n-publish:
-    name: Publishing Sanic Release Artifacts
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
     runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: true
-      matrix:
-        python-version: ["3.10"]
-
     steps:
-      - name: Checkout Repository
+    - uses: actions/checkout@v3
-        uses: actions/checkout@v2
+    - name: Set up Python
-
+      uses: actions/setup-python@v4
-      - name: Publish Python Package
+      with:
-        uses: harshanarayana/custom-actions@main
+        python-version: "3.x"
-        with:
+    - name: Install pypa/build
-          python-version: ${{ matrix.python-version }}
+      run: >-
-          package-infra-name: "twine"
+        python3 -m
-          pypi-user: __token__
+        pip install
-          pypi-access-token: ${{ secrets.PYPI_ACCESS_TOKEN }}
+        build
-          action: "package-publish"
+        --user
-          pypi-verify-metadata: "true"
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python3 -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+    # - name: Publish distribution 📦 to Test PyPI
+    #   uses: pypa/gh-action-pypi-publish@release/v1
+    #   with:
+    #     password: ${{ secrets.SANIC_TEST_PYPI_API_TOKEN }}
+    #     repository-url: https://test.pypi.org/legacy/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.SANIC_PYPI_API_TOKEN }}

.gitignore

@@ -21,4 +21,5 @@ dist/*
 pip-wheel-metadata/
 .pytest_cache/*
 .venv/*
+venv/*
 .vscode/*

CHANGELOG.rst

@@ -316,8 +316,6 @@ Version 21.3.0
 Version 20.12.3
 ---------------
 
-`Current LTS version`
-
 **Bugfixes**
 
   *

docs/sanic/changelog.rst

@@ -1,6 +1,12 @@
 📜 Changelog
 ============
 
+| 🔶 Current release
+| 🔷 In support release
+|
+
+.. mdinclude:: ./releases/23/23.6.md
+.. mdinclude:: ./releases/23/23.3.md
 .. mdinclude:: ./releases/22/22.12.md
 .. mdinclude:: ./releases/22/22.9.md
 .. mdinclude:: ./releases/22/22.6.md

docs/sanic/releases/22/22.12.md

@@ -1,4 +1,4 @@
-## Version 22.12.0 🔶
+## Version 22.12.0 🔷
 
 _Current version_
 

docs/sanic/releases/23/23.3.md

@@ -0,0 +1,53 @@
+## Version 23.3.0
+
+### Features
+- [#2545](https://github.com/sanic-org/sanic/pull/2545) Standardize init of exceptions for more consistent control of HTTP responses using exceptions
+- [#2606](https://github.com/sanic-org/sanic/pull/2606) Decode headers as UTF-8 also in ASGI
+- [#2646](https://github.com/sanic-org/sanic/pull/2646) Separate ASGI request and lifespan callables
+- [#2659](https://github.com/sanic-org/sanic/pull/2659) Use ``FALLBACK_ERROR_FORMAT`` for handlers that return ``empty()``
+- [#2662](https://github.com/sanic-org/sanic/pull/2662) Add basic file browser (HTML page) and auto-index serving
+- [#2667](https://github.com/sanic-org/sanic/pull/2667) Nicer traceback formatting (HTML page)
+- [#2668](https://github.com/sanic-org/sanic/pull/2668) Smarter error page rendering format selection; more reliant upon header and "common sense" defaults
+- [#2680](https://github.com/sanic-org/sanic/pull/2680) Check the status of socket before shutting down with ``SHUT_RDWR``
+- [#2687](https://github.com/sanic-org/sanic/pull/2687) Refresh ``Request.accept`` functionality to be more performant and spec-compliant
+- [#2696](https://github.com/sanic-org/sanic/pull/2696) Add header accessors as properties
+    ```
+    Example-Field: Foo, Bar
+    Example-Field: Baz
+    ```
+    ```python
+    request.headers.example_field == "Foo, Bar,Baz"
+    ```
+- [#2700](https://github.com/sanic-org/sanic/pull/2700) Simpler CLI targets
+
+    ```sh
+    $ sanic path.to.module:app          # global app instance
+    $ sanic path.to.module:create_app   # factory pattern
+    $ sanic ./path/to/directory/        # simple serve
+    ```
+- [#2701](https://github.com/sanic-org/sanic/pull/2701) API to define a number of workers in managed processes
+- [#2704](https://github.com/sanic-org/sanic/pull/2704) Add convenience for dynamic changes to routing
+- [#2706](https://github.com/sanic-org/sanic/pull/2706) Add convenience methods for cookie creation and deletion
+    
+    ```python
+    response = text("...")
+    response.add_cookie("test", "It worked!", domain=".yummy-yummy-cookie.com")
+    ```
+- [#2707](https://github.com/sanic-org/sanic/pull/2707) Simplified ``parse_content_header`` escaping to be RFC-compliant and remove outdated FF hack
+- [#2710](https://github.com/sanic-org/sanic/pull/2710) Stricter charset handling and escaping of request URLs
+- [#2711](https://github.com/sanic-org/sanic/pull/2711) Consume body on ``DELETE`` by default
+- [#2719](https://github.com/sanic-org/sanic/pull/2719) Allow ``password`` to be passed to TLS context
+- [#2720](https://github.com/sanic-org/sanic/pull/2720) Skip middleware on ``RequestCancelled``
+- [#2721](https://github.com/sanic-org/sanic/pull/2721) Change access logging format to ``%s``
+- [#2722](https://github.com/sanic-org/sanic/pull/2722) Add ``CertLoader`` as application option for directly controlling ``SSLContext`` objects
+- [#2725](https://github.com/sanic-org/sanic/pull/2725) Worker sync state tolerance on race condition
+
+### Bugfixes
+- [#2651](https://github.com/sanic-org/sanic/pull/2651) ASGI websocket to pass thru bytes as is
+- [#2697](https://github.com/sanic-org/sanic/pull/2697) Fix comparison between datetime aware and naive in ``file`` when using ``If-Modified-Since``
+
+### Deprecations and Removals
+- [#2666](https://github.com/sanic-org/sanic/pull/2666) Remove deprecated ``__blueprintname__`` property
+
+### Improved Documentation
+- [#2712](https://github.com/sanic-org/sanic/pull/2712) Improved example using ``'https'`` to create the redirect

docs/sanic/releases/23/23.6.md

@@ -0,0 +1,33 @@
+## Version 23.6.0  🔶
+
+### Features
+- [#2670](https://github.com/sanic-org/sanic/pull/2670) Increase `KEEP_ALIVE_TIMEOUT` default to 120 seconds
+- [#2716](https://github.com/sanic-org/sanic/pull/2716) Adding allow route overwrite option in blueprint
+- [#2724](https://github.com/sanic-org/sanic/pull/2724) and [#2792](https://github.com/sanic-org/sanic/pull/2792) Add a new exception signal for ALL exceptions raised anywhere in application
+- [#2727](https://github.com/sanic-org/sanic/pull/2727) Add name prefixing to BP groups
+- [#2754](https://github.com/sanic-org/sanic/pull/2754) Update request type on middleware types
+- [#2770](https://github.com/sanic-org/sanic/pull/2770) Better exception message on startup time application induced import error
+- [#2776](https://github.com/sanic-org/sanic/pull/2776) Set multiprocessing start method early
+- [#2785](https://github.com/sanic-org/sanic/pull/2785) Add custom typing to config and ctx objects
+- [#2790](https://github.com/sanic-org/sanic/pull/2790) Add `request.client_ip`
+
+### Bugfixes
+- [#2728](https://github.com/sanic-org/sanic/pull/2728) Fix traversals for intended results
+- [#2729](https://github.com/sanic-org/sanic/pull/2729) Handle case when headers argument of ResponseStream constructor is None
+- [#2737](https://github.com/sanic-org/sanic/pull/2737) Fix type annotation for `JSONREsponse` default content type
+- [#2740](https://github.com/sanic-org/sanic/pull/2740) Use Sanic's serializer for JSON responses in the Inspector
+- [#2760](https://github.com/sanic-org/sanic/pull/2760) Support for `Request.get_current` in ASGI mode
+- [#2773](https://github.com/sanic-org/sanic/pull/2773) Alow Blueprint routes to explicitly define error_format
+- [#2774](https://github.com/sanic-org/sanic/pull/2774) Resolve headers on different renderers
+- [#2782](https://github.com/sanic-org/sanic/pull/2782) Resolve pypy compatibility issues
+
+### Deprecations and Removals
+- [#2777](https://github.com/sanic-org/sanic/pull/2777) Remove Python 3.7 support
+
+### Developer infrastructure
+- [#2766](https://github.com/sanic-org/sanic/pull/2766) Unpin setuptools version
+- [#2779](https://github.com/sanic-org/sanic/pull/2779) Run keep alive tests in loop to get available port
+
+### Improved Documentation
+- [#2741](https://github.com/sanic-org/sanic/pull/2741) Better documentation examples about running Sanic
+From that list, the items to highlight in the release notes:

examples/amending_request_object.py

@@ -25,5 +25,5 @@ def key_exist_handler(request):
 
     return text("num does not exist in request")
 
-
+if __name__ == "__main__":
-app.run(host="0.0.0.0", port=8000, debug=True)
+    app.run(host="0.0.0.0", port=8000, debug=True)

examples/blueprint_middlware_execution_order.py

@@ -50,4 +50,5 @@ def pop_handler(request):
 
 app.blueprint(bp, url_prefix="/bp")
 
-app.run(host="0.0.0.0", port=8000, debug=True, auto_reload=False)
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000, debug=True, auto_reload=False)

examples/blueprints.py

@@ -37,4 +37,5 @@ app.blueprint(blueprint)
 app.blueprint(blueprint2)
 app.blueprint(blueprint3)
 
-app.run(host="0.0.0.0", port=9999, debug=True)
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=9999, debug=True)

examples/http_redirect.py

@@ -29,7 +29,7 @@ def proxy(request, path):
         path=path,
         _server=https.config.SERVER_NAME,
         _external=True,
-        _scheme="http",
+        _scheme="https",
     )
     return response.redirect(url)
 
@@ -69,5 +69,5 @@ async def runner(app: Sanic, app_server: AsyncioServer):
         app.is_running = False
         app.is_stopping = True
 
-
+if __name__ == "__main__":
-https.run(port=HTTPS_PORT, debug=True)
+    https.run(port=HTTPS_PORT, debug=True)

examples/limit_concurrency.py

@@ -39,4 +39,5 @@ async def test(request):
         return json(response)
 
 
-app.run(host="0.0.0.0", port=8000, workers=2)
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000, workers=2)

examples/override_logging.py

@@ -20,4 +20,5 @@ def test(request):
     return text("hey")
 
 
-app.run(host="0.0.0.0", port=8000)
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000)

examples/request_stream/client.py

@@ -6,5 +6,5 @@ data = ""
 for i in range(1, 250000):
     data += str(i)
 
-r = requests.post('http://0.0.0.0:8000/stream', data=data)
+r = requests.post("http://0.0.0.0:8000/stream", data=data)
 print(r.text)

examples/request_timeout.py

@@ -20,4 +20,5 @@ def timeout(request, exception):
     return response.text("RequestTimeout from error_handler.", 408)
 
 
-app.run(host="0.0.0.0", port=8000)
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000)

examples/run_async_advanced.py

@@ -35,34 +35,34 @@ async def after_server_stop(app, loop):
 async def test(request):
     return response.json({"answer": "42"})
 
+if __name__ == "__main__":
+    asyncio.set_event_loop(uvloop.new_event_loop())
+    serv_coro = app.create_server(
+        host="0.0.0.0", port=8000, return_asyncio_server=True
+    )
+    loop = asyncio.get_event_loop()
+    serv_task = asyncio.ensure_future(serv_coro, loop=loop)
+    signal(SIGINT, lambda s, f: loop.stop())
+    server: AsyncioServer = loop.run_until_complete(serv_task)
+    loop.run_until_complete(server.startup())
 
-asyncio.set_event_loop(uvloop.new_event_loop())
+    # When using app.run(), this actually triggers before the serv_coro.
-serv_coro = app.create_server(
+    # But, in this example, we are using the convenience method, even if it is
-    host="0.0.0.0", port=8000, return_asyncio_server=True
+    # out of order.
-)
+    loop.run_until_complete(server.before_start())
-loop = asyncio.get_event_loop()
+    loop.run_until_complete(server.after_start())
-serv_task = asyncio.ensure_future(serv_coro, loop=loop)
+    try:
-signal(SIGINT, lambda s, f: loop.stop())
+        loop.run_forever()
-server: AsyncioServer = loop.run_until_complete(serv_task)
+    except KeyboardInterrupt:
-loop.run_until_complete(server.startup())
+        loop.stop()
+    finally:
+        loop.run_until_complete(server.before_stop())
 
-# When using app.run(), this actually triggers before the serv_coro.
+        # Wait for server to close
-# But, in this example, we are using the convenience method, even if it is
+        close_task = server.close()
-# out of order.
+        loop.run_until_complete(close_task)
-loop.run_until_complete(server.before_start())
-loop.run_until_complete(server.after_start())
-try:
-    loop.run_forever()
-except KeyboardInterrupt:
-    loop.stop()
-finally:
-    loop.run_until_complete(server.before_stop())
 
-    # Wait for server to close
+        # Complete all tasks on the loop
-    close_task = server.close()
+        for connection in server.connections:
-    loop.run_until_complete(close_task)
+            connection.close_if_idle()
-
+        loop.run_until_complete(server.after_stop())
-    # Complete all tasks on the loop
-    for connection in server.connections:
-        connection.close_if_idle()
-    loop.run_until_complete(server.after_stop())

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools<60.0", "wheel"]
+requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.black]

sanic/__init__.py

@@ -1,7 +1,28 @@
+from types import SimpleNamespace
+
+from typing_extensions import TypeAlias
+
 from sanic.__version__ import __version__
 from sanic.app import Sanic
 from sanic.blueprints import Blueprint
+from sanic.config import Config
 from sanic.constants import HTTPMethod
+from sanic.exceptions import (
+    BadRequest,
+    ExpectationFailed,
+    FileNotFound,
+    Forbidden,
+    HeaderNotFound,
+    InternalServerError,
+    InvalidHeader,
+    MethodNotAllowed,
+    NotFound,
+    RangeNotSatisfiable,
+    SanicException,
+    ServerError,
+    ServiceUnavailable,
+    Unauthorized,
+)
 from sanic.request import Request
 from sanic.response import (
     HTTPResponse,
@@ -9,24 +30,57 @@ from sanic.response import (
     file,
     html,
     json,
+    raw,
     redirect,
     text,
 )
 from sanic.server.websockets.impl import WebsocketImplProtocol as Websocket
 
 
+DefaultSanic: TypeAlias = "Sanic[Config, SimpleNamespace]"
+"""
+A type alias for a Sanic app with a default config and namespace.
+"""
+
+DefaultRequest: TypeAlias = Request[DefaultSanic, SimpleNamespace]
+"""
+A type alias for a request with a default Sanic app and namespace.
+"""
+
 __all__ = (
     "__version__",
+    # Common objects
     "Sanic",
+    "Config",
     "Blueprint",
     "HTTPMethod",
     "HTTPResponse",
     "Request",
     "Websocket",
+    # Common types
+    "DefaultSanic",
+    "DefaultRequest",
+    # Common exceptions
+    "BadRequest",
+    "ExpectationFailed",
+    "FileNotFound",
+    "Forbidden",
+    "HeaderNotFound",
+    "InternalServerError",
+    "InvalidHeader",
+    "MethodNotAllowed",
+    "NotFound",
+    "RangeNotSatisfiable",
+    "SanicException",
+    "ServerError",
+    "ServiceUnavailable",
+    "Unauthorized",
+    # Common response methods
     "empty",
     "file",
     "html",
     "json",
+    "raw",
     "redirect",
     "text",
 )

sanic/__version__.py

@@ -1,10 +1 @@
-__version__ = "23.3.0"
+__version__ = "23.6.0"
-__compatibility__ = "22.12"
-
-from inspect import currentframe, stack
-
-for frame_info in stack():
-    if frame_info.frame is not currentframe():
-        value = frame_info.frame.f_globals.get("__SANIC_COMPATIBILITY__")
-        if value:
-            __compatibility__ = value

sanic/app.py

@@ -16,8 +16,8 @@ from asyncio import (
 )
 from asyncio.futures import Future
 from collections import defaultdict, deque
-from contextlib import suppress
+from contextlib import contextmanager, suppress
-from functools import partial
+from functools import partial, wraps
 from inspect import isawaitable
 from os import environ
 from socket import socket
@@ -29,10 +29,13 @@ from typing import (
     AnyStr,
     Awaitable,
     Callable,
+    ClassVar,
     Coroutine,
     Deque,
     Dict,
+    Generic,
     Iterable,
+    Iterator,
     List,
     Optional,
     Set,
@@ -40,6 +43,8 @@ from typing import (
     Type,
     TypeVar,
     Union,
+    cast,
+    overload,
 )
 from urllib.parse import urlencode, urlunparse
 
@@ -48,7 +53,7 @@ from sanic_routing.route import Route
 
 from sanic.application.ext import setup_ext
 from sanic.application.state import ApplicationState, ServerStage
-from sanic.asgi import ASGIApp
+from sanic.asgi import ASGIApp, Lifespan
 from sanic.base.root import BaseSanic
 from sanic.blueprint_group import BlueprintGroup
 from sanic.blueprints import Blueprint
@@ -63,12 +68,7 @@ from sanic.exceptions import (
 from sanic.handlers import ErrorHandler
 from sanic.helpers import Default, _default
 from sanic.http import Stage
-from sanic.log import (
+from sanic.log import LOGGING_CONFIG_DEFAULTS, error_logger, logger
-    LOGGING_CONFIG_DEFAULTS,
-    deprecation,
-    error_logger,
-    logger,
-)
 from sanic.middleware import Middleware, MiddlewareLocation
 from sanic.mixins.listeners import ListenerEvent
 from sanic.mixins.startup import StartupMixin
@@ -87,10 +87,11 @@ from sanic.request import Request
 from sanic.response import BaseHTTPResponse, HTTPResponse, ResponseStream
 from sanic.router import Router
 from sanic.server.websockets.impl import ConnectionClosed
-from sanic.signals import Signal, SignalRouter
+from sanic.signals import Event, Signal, SignalRouter
 from sanic.touchup import TouchUp, TouchUpMeta
 from sanic.types.shared_ctx import SharedContext
 from sanic.worker.inspector import Inspector
+from sanic.worker.loader import CertLoader
 from sanic.worker.manager import WorkerManager
 
 
@@ -105,8 +106,17 @@ if TYPE_CHECKING:
 if OS_IS_WINDOWS:  # no cov
     enable_windows_color_support()
 
+ctx_type = TypeVar("ctx_type")
+config_type = TypeVar("config_type", bound=Config)
 
-class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
+
+class Sanic(
+    Generic[config_type, ctx_type],
+    StaticHandleMixin,
+    BaseSanic,
+    StartupMixin,
+    metaclass=TouchUpMeta,
+):
     """
     The main application instance
     """
@@ -119,6 +129,7 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
     )
     __slots__ = (
         "_asgi_app",
+        "_asgi_lifespan",
         "_asgi_client",
         "_blueprint_order",
         "_delayed_tasks",
@@ -137,6 +148,7 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
         "_test_client",
         "_test_manager",
         "blueprints",
+        "certloader_class",
         "config",
         "configure_logging",
         "ctx",
@@ -159,14 +171,15 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
         "websocket_tasks",
     )
 
-    _app_registry: Dict[str, "Sanic"] = {}
+    _app_registry: ClassVar[Dict[str, "Sanic"]] = {}
-    test_mode = False
+    test_mode: ClassVar[bool] = False
 
+    @overload
     def __init__(
-        self,
+        self: Sanic[Config, SimpleNamespace],
-        name: Optional[str] = None,
+        name: str,
-        config: Optional[Config] = None,
+        config: None = None,
-        ctx: Optional[Any] = None,
+        ctx: None = None,
         router: Optional[Router] = None,
         signal_router: Optional[SignalRouter] = None,
         error_handler: Optional[ErrorHandler] = None,
@@ -179,6 +192,94 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
         loads: Optional[Callable[..., Any]] = None,
         inspector: bool = False,
         inspector_class: Optional[Type[Inspector]] = None,
+        certloader_class: Optional[Type[CertLoader]] = None,
+    ) -> None:
+        ...
+
+    @overload
+    def __init__(
+        self: Sanic[config_type, SimpleNamespace],
+        name: str,
+        config: Optional[config_type] = None,
+        ctx: None = None,
+        router: Optional[Router] = None,
+        signal_router: Optional[SignalRouter] = None,
+        error_handler: Optional[ErrorHandler] = None,
+        env_prefix: Optional[str] = SANIC_PREFIX,
+        request_class: Optional[Type[Request]] = None,
+        strict_slashes: bool = False,
+        log_config: Optional[Dict[str, Any]] = None,
+        configure_logging: bool = True,
+        dumps: Optional[Callable[..., AnyStr]] = None,
+        loads: Optional[Callable[..., Any]] = None,
+        inspector: bool = False,
+        inspector_class: Optional[Type[Inspector]] = None,
+        certloader_class: Optional[Type[CertLoader]] = None,
+    ) -> None:
+        ...
+
+    @overload
+    def __init__(
+        self: Sanic[Config, ctx_type],
+        name: str,
+        config: None = None,
+        ctx: Optional[ctx_type] = None,
+        router: Optional[Router] = None,
+        signal_router: Optional[SignalRouter] = None,
+        error_handler: Optional[ErrorHandler] = None,
+        env_prefix: Optional[str] = SANIC_PREFIX,
+        request_class: Optional[Type[Request]] = None,
+        strict_slashes: bool = False,
+        log_config: Optional[Dict[str, Any]] = None,
+        configure_logging: bool = True,
+        dumps: Optional[Callable[..., AnyStr]] = None,
+        loads: Optional[Callable[..., Any]] = None,
+        inspector: bool = False,
+        inspector_class: Optional[Type[Inspector]] = None,
+        certloader_class: Optional[Type[CertLoader]] = None,
+    ) -> None:
+        ...
+
+    @overload
+    def __init__(
+        self: Sanic[config_type, ctx_type],
+        name: str,
+        config: Optional[config_type] = None,
+        ctx: Optional[ctx_type] = None,
+        router: Optional[Router] = None,
+        signal_router: Optional[SignalRouter] = None,
+        error_handler: Optional[ErrorHandler] = None,
+        env_prefix: Optional[str] = SANIC_PREFIX,
+        request_class: Optional[Type[Request]] = None,
+        strict_slashes: bool = False,
+        log_config: Optional[Dict[str, Any]] = None,
+        configure_logging: bool = True,
+        dumps: Optional[Callable[..., AnyStr]] = None,
+        loads: Optional[Callable[..., Any]] = None,
+        inspector: bool = False,
+        inspector_class: Optional[Type[Inspector]] = None,
+        certloader_class: Optional[Type[CertLoader]] = None,
+    ) -> None:
+        ...
+
+    def __init__(
+        self,
+        name: str,
+        config: Optional[config_type] = None,
+        ctx: Optional[ctx_type] = None,
+        router: Optional[Router] = None,
+        signal_router: Optional[SignalRouter] = None,
+        error_handler: Optional[ErrorHandler] = None,
+        env_prefix: Optional[str] = SANIC_PREFIX,
+        request_class: Optional[Type[Request]] = None,
+        strict_slashes: bool = False,
+        log_config: Optional[Dict[str, Any]] = None,
+        configure_logging: bool = True,
+        dumps: Optional[Callable[..., AnyStr]] = None,
+        loads: Optional[Callable[..., Any]] = None,
+        inspector: bool = False,
+        inspector_class: Optional[Type[Inspector]] = None,
+        certloader_class: Optional[Type[CertLoader]] = None,
     ) -> None:
         super().__init__(name=name)
         # logging
@@ -193,11 +294,15 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
             )
 
         # First setup config
-        self.config: Config = config or Config(env_prefix=env_prefix)
+        self.config: config_type = cast(
+            config_type, config or Config(env_prefix=env_prefix)
+        )
         if inspector:
             self.config.INSPECTOR = inspector
 
         # Then we can do the rest
+        self._asgi_app: Optional[ASGIApp] = None
+        self._asgi_lifespan: Optional[Lifespan] = None
         self._asgi_client: Any = None
         self._blueprint_order: List[Blueprint] = []
         self._delayed_tasks: List[str] = []
@@ -211,8 +316,11 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
         self.asgi = False
         self.auto_reload = False
         self.blueprints: Dict[str, Blueprint] = {}
+        self.certloader_class: Type[CertLoader] = (
+            certloader_class or CertLoader
+        )
         self.configure_logging: bool = configure_logging
-        self.ctx: Any = ctx or SimpleNamespace()
+        self.ctx: ctx_type = cast(ctx_type, ctx or SimpleNamespace())
         self.error_handler: ErrorHandler = error_handler or ErrorHandler()
         self.inspector_class: Type[Inspector] = inspector_class or Inspector
         self.listeners: Dict[str, List[ListenerType[Any]]] = defaultdict(list)
@@ -412,8 +520,11 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
     def _apply_listener(self, listener: FutureListener):
         return self.register_listener(listener.listener, listener.event)
 
-    def _apply_route(self, route: FutureRoute) -> List[Route]:
+    def _apply_route(
+        self, route: FutureRoute, overwrite: bool = False
+    ) -> List[Route]:
         params = route._asdict()
+        params["overwrite"] = overwrite
         websocket = params.pop("websocket", False)
         subprotocols = params.pop("subprotocols", None)
 
@@ -430,14 +541,15 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
 
         ctx = params.pop("route_context")
 
-        routes = self.router.add(**params)
+        with self.amend():
-        if isinstance(routes, Route):
+            routes = self.router.add(**params)
-            routes = [routes]
+            if isinstance(routes, Route):
+                routes = [routes]
 
-        for r in routes:
+            for r in routes:
-            r.extra.websocket = websocket
+                r.extra.websocket = websocket
-            r.extra.static = params.get("static", False)
+                r.extra.static = params.get("static", False)
-            r.ctx.__dict__.update(ctx)
+                r.ctx.__dict__.update(ctx)
 
         return routes
 
@@ -446,17 +558,19 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
         middleware: FutureMiddleware,
         route_names: Optional[List[str]] = None,
     ):
-        if route_names:
+        with self.amend():
-            return self.register_named_middleware(
+            if route_names:
-                middleware.middleware, route_names, middleware.attach_to
+                return self.register_named_middleware(
-            )
+                    middleware.middleware, route_names, middleware.attach_to
-        else:
+                )
-            return self.register_middleware(
+            else:
-                middleware.middleware, middleware.attach_to
+                return self.register_middleware(
-            )
+                    middleware.middleware, middleware.attach_to
+                )
 
     def _apply_signal(self, signal: FutureSignal) -> Signal:
-        return self.signal_router.add(*signal)
+        with self.amend():
+            return self.signal_router.add(*signal)
 
     def dispatch(
         self,
@@ -491,6 +605,19 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
                 raise NotFound("Could not find signal %s" % event)
         return await wait_for(signal.ctx.event.wait(), timeout=timeout)
 
+    def report_exception(
+        self, handler: Callable[[Sanic, Exception], Coroutine[Any, Any, None]]
+    ):
+        @wraps(handler)
+        async def report(exception: Exception) -> None:
+            await handler(self, exception)
+
+        self.add_signal(
+            handler=report, event=Event.SERVER_EXCEPTION_REPORT.value
+        )
+
+        return report
+
     def enable_websocket(self, enable=True):
         """Enable or disable the support for websocket.
 
@@ -542,6 +669,9 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
                             )
                         else:
                             params["version_prefix"] = blueprint.version_prefix
+                    name_prefix = getattr(blueprint, "name_prefix", None)
+                    if name_prefix and "name_prefix" not in params:
+                        params["name_prefix"] = name_prefix
                 self.blueprint(item, **params)
             return
         if blueprint.name in self.blueprints:
@@ -759,6 +889,12 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
         :raises ServerError: response 500
         """
         response = None
+        if not getattr(exception, "__dispatched__", False):
+            ...  # DO NOT REMOVE THIS LINE. IT IS NEEDED FOR TOUCHUP.
+            await self.dispatch(
+                "server.exception.report",
+                context={"exception": exception},
+            )
         await self.dispatch(
             "http.lifecycle.exception",
             inline=True,
@@ -1189,13 +1325,28 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
         app,
         loop,
     ):
-        if callable(task):
+        async def do(task):
             try:
-                task = task(app)
+                if callable(task):
-            except TypeError:
+                    try:
-                task = task()
+                        task = task(app)
+                    except TypeError:
+                        task = task()
+                if isawaitable(task):
+                    await task
+            except CancelledError:
+                error_logger.warning(
+                    f"Task {task} was cancelled before it completed."
+                )
+                raise
+            except Exception as e:
+                await app.dispatch(
+                    "server.exception.report",
+                    context={"exception": e},
+                )
+                raise
 
-        return task
+        return do(task)
 
     @classmethod
     def _loop_add_task(
@@ -1209,18 +1360,9 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
     ) -> Task:
         if not isinstance(task, Future):
             prepped = cls._prep_task(task, app, loop)
-            if sys.version_info < (3, 8):  # no cov
+            task = loop.create_task(prepped, name=name)
-                task = loop.create_task(prepped)
-                if name:
-                    error_logger.warning(
-                        "Cannot set a name for a task when using Python 3.7. "
-                        "Your task will be created without a name."
-                    )
-                task.get_name = lambda: name
-            else:
-                task = loop.create_task(prepped, name=name)
 
-        if name and register and sys.version_info > (3, 7):
+        if name and register:
             app._task_registry[name] = task
 
         return task
@@ -1349,12 +1491,14 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
         three arguments: scope, receive, send. See the ASGI reference for more
         details: https://asgi.readthedocs.io/en/latest
         """
-        self.asgi = True
         if scope["type"] == "lifespan":
+            self.asgi = True
             self.motd("")
-        self._asgi_app = await ASGIApp.create(self, scope, receive, send)
+            self._asgi_lifespan = Lifespan(self, scope, receive, send)
-        asgi_app = self._asgi_app
+            await self._asgi_lifespan()
-        await asgi_app()
+        else:
+            self._asgi_app = await ASGIApp.create(self, scope, receive, send)
+            await self._asgi_app()
 
     _asgi_single_callable = True  # We conform to ASGI 3.0 single-callable
 
@@ -1515,6 +1659,27 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
     # Lifecycle
     # -------------------------------------------------------------------- #
 
+    @contextmanager
+    def amend(self) -> Iterator[None]:
+        """
+        If the application has started, this function allows changes
+        to be made to add routes, middleware, and signals.
+        """
+        if not self.state.is_started:
+            yield
+        else:
+            do_router = self.router.finalized
+            do_signal_router = self.signal_router.finalized
+            if do_router:
+                self.router.reset()
+            if do_signal_router:
+                self.signal_router.reset()
+            yield
+            if do_signal_router:
+                self.signalize(self.config.TOUCHUP)
+            if do_router:
+                self.finalize()
+
     def finalize(self):
         try:
             self.router.finalize()
@@ -1548,17 +1713,20 @@ class Sanic(StaticHandleMixin, BaseSanic, StartupMixin, metaclass=TouchUpMeta):
         self.signalize(self.config.TOUCHUP)
         self.finalize()
 
-        route_names = [route.name for route in self.router.routes]
+        route_names = [route.extra.ident for route in self.router.routes]
         duplicates = {
             name for name in route_names if route_names.count(name) > 1
         }
         if duplicates:
             names = ", ".join(duplicates)
-            deprecation(
+            message = (
-                f"Duplicate route names detected: {names}. In the future, "
+                f"Duplicate route names detected: {names}. You should rename "
-                "Sanic will enforce uniqueness in route naming.",
+                "one or more of them explicitly by using the `name` param, "
-                23.3,
+                "or changing the implicit name derived from the class and "
+                "function name. For more details, please see "
+                "https://sanic.dev/en/guide/release-notes/v23.3.html#duplicated-route-names-are-no-longer-allowed"  # noqa
             )
+            raise ServerError(message)
 
         Sanic._check_uvloop_conflict()
 

sanic/application/logo.py

@@ -3,7 +3,7 @@ import sys
 
 from os import environ
 
-from sanic.compat import is_atty
+from sanic.helpers import is_atty
 
 
 BASE_LOGO = """

sanic/application/motd.py

@@ -4,7 +4,7 @@ from textwrap import indent, wrap
 from typing import Dict, Optional
 
 from sanic import __version__
-from sanic.compat import is_atty
+from sanic.helpers import is_atty
 from sanic.log import logger
 
 

sanic/asgi.py

@@ -3,10 +3,9 @@ from __future__ import annotations
 import warnings
 
 from typing import TYPE_CHECKING, Optional
-from urllib.parse import quote
 
 from sanic.compat import Header
-from sanic.exceptions import ServerError
+from sanic.exceptions import BadRequest, ServerError
 from sanic.helpers import Default
 from sanic.http import Stage
 from sanic.log import error_logger, logger
@@ -22,13 +21,15 @@ if TYPE_CHECKING:
 
 
 class Lifespan:
-    def __init__(self, asgi_app: ASGIApp) -> None:
+    def __init__(
-        self.asgi_app = asgi_app
+        self, sanic_app, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
+    ) -> None:
+        self.sanic_app = sanic_app
+        self.scope = scope
+        self.receive = receive
+        self.send = send
 
-        if (
+        if "server.init.before" in self.sanic_app.signal_router.name_index:
-            "server.init.before"
-            in self.asgi_app.sanic_app.signal_router.name_index
-        ):
             logger.debug(
                 'You have set a listener for "before_server_start" '
                 "in ASGI mode. "
@@ -36,10 +37,7 @@ class Lifespan:
                 "the ASGI server is started.",
                 extra={"verbosity": 1},
             )
-        if (
+        if "server.shutdown.after" in self.sanic_app.signal_router.name_index:
-            "server.shutdown.after"
-            in self.asgi_app.sanic_app.signal_router.name_index
-        ):
             logger.debug(
                 'You have set a listener for "after_server_stop" '
                 "in ASGI mode. "
@@ -57,11 +55,11 @@ class Lifespan:
         in sequence since the ASGI lifespan protocol only supports a single
         startup event.
         """
-        await self.asgi_app.sanic_app._startup()
+        await self.sanic_app._startup()
-        await self.asgi_app.sanic_app._server_event("init", "before")
+        await self.sanic_app._server_event("init", "before")
-        await self.asgi_app.sanic_app._server_event("init", "after")
+        await self.sanic_app._server_event("init", "after")
 
-        if not isinstance(self.asgi_app.sanic_app.config.USE_UVLOOP, Default):
+        if not isinstance(self.sanic_app.config.USE_UVLOOP, Default):
             warnings.warn(
                 "You have set the USE_UVLOOP configuration option, but Sanic "
                 "cannot control the event loop when running in ASGI mode."
@@ -77,35 +75,33 @@ class Lifespan:
         in sequence since the ASGI lifespan protocol only supports a single
         shutdown event.
         """
-        await self.asgi_app.sanic_app._server_event("shutdown", "before")
+        await self.sanic_app._server_event("shutdown", "before")
-        await self.asgi_app.sanic_app._server_event("shutdown", "after")
+        await self.sanic_app._server_event("shutdown", "after")
 
-    async def __call__(
+    async def __call__(self) -> None:
-        self, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
+        while True:
-    ) -> None:
+            message = await self.receive()
-        message = await receive()
+            if message["type"] == "lifespan.startup":
-        if message["type"] == "lifespan.startup":
+                try:
-            try:
+                    await self.startup()
-                await self.startup()
+                except Exception as e:
-            except Exception as e:
+                    error_logger.exception(e)
-                error_logger.exception(e)
+                    await self.send(
-                await send(
+                        {"type": "lifespan.startup.failed", "message": str(e)}
-                    {"type": "lifespan.startup.failed", "message": str(e)}
+                    )
-                )
+                else:
-            else:
+                    await self.send({"type": "lifespan.startup.complete"})
-                await send({"type": "lifespan.startup.complete"})
+            elif message["type"] == "lifespan.shutdown":
-
+                try:
-        message = await receive()
+                    await self.shutdown()
-        if message["type"] == "lifespan.shutdown":
+                except Exception as e:
-            try:
+                    error_logger.exception(e)
-                await self.shutdown()
+                    await self.send(
-            except Exception as e:
+                        {"type": "lifespan.shutdown.failed", "message": str(e)}
-                error_logger.exception(e)
+                    )
-                await send(
+                else:
-                    {"type": "lifespan.shutdown.failed", "message": str(e)}
+                    await self.send({"type": "lifespan.shutdown.complete"})
-                )
+                return
-            else:
-                await send({"type": "lifespan.shutdown.complete"})
 
 
 class ASGIApp:
@@ -117,73 +113,79 @@ class ASGIApp:
     stage: Stage
     response: Optional[BaseHTTPResponse]
 
-    def __init__(self) -> None:
-        self.ws = None
-
     @classmethod
     async def create(
-        cls, sanic_app, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
+        cls,
-    ) -> "ASGIApp":
+        sanic_app: Sanic,
+        scope: ASGIScope,
+        receive: ASGIReceive,
+        send: ASGISend,
+    ) -> ASGIApp:
         instance = cls()
+        instance.ws = None
         instance.sanic_app = sanic_app
         instance.transport = MockTransport(scope, receive, send)
         instance.transport.loop = sanic_app.loop
         instance.stage = Stage.IDLE
         instance.response = None
+        instance.sanic_app.state.is_started = True
         setattr(instance.transport, "add_task", sanic_app.loop.create_task)
 
-        headers = Header(
+        try:
-            [
+            headers = Header(
-                (key.decode("latin-1"), value.decode("latin-1"))
+                [
-                for key, value in scope.get("headers", [])
+                    (
-            ]
+                        key.decode("ASCII"),
-        )
+                        value.decode(errors="surrogateescape"),
-        instance.lifespan = Lifespan(instance)
+                    )
+                    for key, value in scope.get("headers", [])
+                ]
+            )
+        except UnicodeDecodeError:
+            raise BadRequest(
+                "Header names can only contain US-ASCII characters"
+            )
 
-        if scope["type"] == "lifespan":
+        if scope["type"] == "http":
-            await instance.lifespan(scope, receive, send)
+            version = scope["http_version"]
+            method = scope["method"]
+        elif scope["type"] == "websocket":
+            version = "1.1"
+            method = "GET"
+
+            instance.ws = instance.transport.create_websocket_connection(
+                send, receive
+            )
         else:
-            path = (
+            raise ServerError("Received unknown ASGI scope")
-                scope["path"][1:]
-                if scope["path"].startswith("/")
-                else scope["path"]
-            )
-            url = "/".join([scope.get("root_path", ""), quote(path)])
-            url_bytes = url.encode("latin-1")
-            url_bytes += b"?" + scope["query_string"]
 
-            if scope["type"] == "http":
+        url_bytes, query = scope["raw_path"], scope["query_string"]
-                version = scope["http_version"]
+        if query:
-                method = scope["method"]
+            # httpx ASGI client sends query string as part of raw_path
-            elif scope["type"] == "websocket":
+            url_bytes = url_bytes.split(b"?", 1)[0]
-                version = "1.1"
+            # All servers send them separately
-                method = "GET"
+            url_bytes = b"%b?%b" % (url_bytes, query)
 
-                instance.ws = instance.transport.create_websocket_connection(
+        request_class = sanic_app.request_class or Request
-                    send, receive
+        instance.request = request_class(
-                )
+            url_bytes,
-            else:
+            headers,
-                raise ServerError("Received unknown ASGI scope")
+            version,
+            method,
+            instance.transport,
+            sanic_app,
+        )
+        request_class._current.set(instance.request)
+        instance.request.stream = instance  # type: ignore
+        instance.request_body = True
+        instance.request.conn_info = ConnInfo(instance.transport)
 
-            request_class = sanic_app.request_class or Request
+        await instance.sanic_app.dispatch(
-            instance.request = request_class(
+            "http.lifecycle.request",
-                url_bytes,
+            inline=True,
-                headers,
+            context={"request": instance.request},
-                version,
+            fail_not_found=False,
-                method,
+        )
-                instance.transport,
-                sanic_app,
-            )
-            instance.request.stream = instance
-            instance.request_body = True
-            instance.request.conn_info = ConnInfo(instance.transport)
-
-            await sanic_app.dispatch(
-                "http.lifecycle.request",
-                inline=True,
-                context={"request": instance.request},
-                fail_not_found=False,
-            )
 
         return instance
 

sanic/blueprint_group.py

@@ -65,6 +65,7 @@ class BlueprintGroup(MutableSequence):
         "_version",
         "_strict_slashes",
         "_version_prefix",
+        "_name_prefix",
     )
 
     def __init__(
@@ -73,6 +74,7 @@ class BlueprintGroup(MutableSequence):
         version: Optional[Union[int, str, float]] = None,
         strict_slashes: Optional[bool] = None,
         version_prefix: str = "/v",
+        name_prefix: Optional[str] = "",
     ):
         """
         Create a new Blueprint Group
@@ -87,6 +89,7 @@ class BlueprintGroup(MutableSequence):
         self._version = version
         self._version_prefix = version_prefix
         self._strict_slashes = strict_slashes
+        self._name_prefix = name_prefix
 
     @property
     def url_prefix(self) -> Optional[Union[int, str, float]]:
@@ -134,6 +137,15 @@ class BlueprintGroup(MutableSequence):
         """
         return self._version_prefix
 
+    @property
+    def name_prefix(self) -> Optional[str]:
+        """
+        Name prefix for the blueprint group
+
+        :return: str
+        """
+        return self._name_prefix
+
     def __iter__(self):
         """
         Tun the class Blueprint Group into an Iterable item

sanic/blueprints.py

@@ -93,6 +93,8 @@ class Blueprint(BaseSanic):
         "_future_listeners",
         "_future_exceptions",
         "_future_signals",
+        "_allow_route_overwrite",
+        "copied_from",
         "ctx",
         "exceptions",
         "host",
@@ -109,7 +111,7 @@ class Blueprint(BaseSanic):
 
     def __init__(
         self,
-        name: str = None,
+        name: str,
         url_prefix: Optional[str] = None,
         host: Optional[Union[List[str], str]] = None,
         version: Optional[Union[int, str, float]] = None,
@@ -118,6 +120,8 @@ class Blueprint(BaseSanic):
     ):
         super().__init__(name=name)
         self.reset()
+        self._allow_route_overwrite = False
+        self.copied_from = ""
         self.ctx = SimpleNamespace()
         self.host = host
         self.strict_slashes = strict_slashes
@@ -167,6 +171,7 @@ class Blueprint(BaseSanic):
 
     def reset(self):
         self._apps: Set[Sanic] = set()
+        self._allow_route_overwrite = False
         self.exceptions: List[RouteHandler] = []
         self.listeners: Dict[str, List[ListenerType[Any]]] = {}
         self.middlewares: List[MiddlewareType] = []
@@ -180,6 +185,7 @@ class Blueprint(BaseSanic):
         url_prefix: Optional[Union[str, Default]] = _default,
         version: Optional[Union[int, str, float, Default]] = _default,
         version_prefix: Union[str, Default] = _default,
+        allow_route_overwrite: Union[bool, Default] = _default,
         strict_slashes: Optional[Union[bool, Default]] = _default,
         with_registration: bool = True,
         with_ctx: bool = False,
@@ -213,6 +219,7 @@ class Blueprint(BaseSanic):
         self.reset()
         new_bp = deepcopy(self)
         new_bp.name = name
+        new_bp.copied_from = self.name
 
         if not isinstance(url_prefix, Default):
             new_bp.url_prefix = url_prefix
@@ -222,6 +229,8 @@ class Blueprint(BaseSanic):
             new_bp.strict_slashes = strict_slashes
         if not isinstance(version_prefix, Default):
             new_bp.version_prefix = version_prefix
+        if not isinstance(allow_route_overwrite, Default):
+            new_bp._allow_route_overwrite = allow_route_overwrite
 
         for key, value in attrs_backup.items():
             setattr(self, key, value)
@@ -247,6 +256,7 @@ class Blueprint(BaseSanic):
         version: Optional[Union[int, str, float]] = None,
         strict_slashes: Optional[bool] = None,
         version_prefix: str = "/v",
+        name_prefix: Optional[str] = "",
     ) -> BlueprintGroup:
         """
         Create a list of blueprints, optionally grouping them under a
@@ -272,6 +282,7 @@ class Blueprint(BaseSanic):
             version=version,
             strict_slashes=strict_slashes,
             version_prefix=version_prefix,
+            name_prefix=name_prefix,
         )
         for bp in chain(blueprints):
             bps.append(bp)
@@ -292,6 +303,7 @@ class Blueprint(BaseSanic):
         opt_version = options.get("version", None)
         opt_strict_slashes = options.get("strict_slashes", None)
         opt_version_prefix = options.get("version_prefix", self.version_prefix)
+        opt_name_prefix = options.get("name_prefix", None)
         error_format = options.get(
             "error_format", app.config.FALLBACK_ERROR_FORMAT
         )
@@ -307,6 +319,10 @@ class Blueprint(BaseSanic):
             # Prepend the blueprint URI prefix if available
             uri = self._setup_uri(future.uri, url_prefix)
 
+            route_error_format = (
+                future.error_format if future.error_format else error_format
+            )
+
             version_prefix = self.version_prefix
             for prefix in (
                 future.version_prefix,
@@ -323,7 +339,10 @@ class Blueprint(BaseSanic):
                 future.strict_slashes, opt_strict_slashes, self.strict_slashes
             )
 
-            name = app._generate_name(future.name)
+            name = future.name
+            if opt_name_prefix:
+                name = f"{opt_name_prefix}_{future.name}"
+            name = app._generate_name(name)
             host = future.host or self.host
             if isinstance(host, list):
                 host = tuple(host)
@@ -343,7 +362,7 @@ class Blueprint(BaseSanic):
                 future.unquote,
                 future.static,
                 version_prefix,
-                error_format,
+                route_error_format,
                 future.route_context,
             )
 
@@ -351,7 +370,19 @@ class Blueprint(BaseSanic):
                 continue
 
             registered.add(apply_route)
-            route = app._apply_route(apply_route)
+            route = app._apply_route(
+                apply_route, overwrite=self._allow_route_overwrite
+            )
+
+            # If it is a copied BP, then make sure all of the names of routes
+            # matchup with the new BP name
+            if self.copied_from:
+                for r in route:
+                    r.name = r.name.replace(self.copied_from, self.name)
+                    r.extra.ident = r.extra.ident.replace(
+                        self.copied_from, self.name
+                    )
+
             operation = (
                 routes.extend if isinstance(route, list) else routes.append
             )

sanic/breaking/__init__.py

@@ -1,18 +0,0 @@
-from sanic.__version__ import __compatibility__
-
-if __compatibility__ == "22.12":
-    from .v22_12.request import (
-        File,
-        Request,
-        RequestParameters,
-        parse_multipart_form,
-    )
-elif __compatibility__ == "23.3":
-    from .v23_3.request import (
-        File,
-        Request,
-        RequestParameters,
-        parse_multipart_form,
-    )
-else:
-    raise RuntimeError(f"Unknown compatibility value: {__compatibility__}")

sanic/breaking/v23_3/request.py

@@ -1,9 +0,0 @@
-from ..v22_12.request import File
-from ..v22_12.request import Request as LegacyRequest
-from ..v22_12.request import RequestParameters, parse_multipart_form
-
-
-class Request(LegacyRequest):
-    @property
-    def something_new(self):
-        return 123

sanic/cli/app.py

@@ -1,4 +1,3 @@
-import logging
 import os
 import shutil
 import sys
@@ -6,7 +5,7 @@ import sys
 from argparse import Namespace
 from functools import partial
 from textwrap import indent
-from typing import List, Union, cast
+from typing import List, Union
 
 from sanic.app import Sanic
 from sanic.application.logo import get_logo
@@ -14,7 +13,7 @@ from sanic.cli.arguments import Group
 from sanic.cli.base import SanicArgumentParser, SanicHelpFormatter
 from sanic.cli.inspector import make_inspector_parser
 from sanic.cli.inspector_client import InspectorClient
-from sanic.log import Colors, error_logger
+from sanic.log import error_logger
 from sanic.worker.loader import AppLoader
 
 
@@ -24,17 +23,22 @@ class SanicCLI:
 {get_logo(True)}
 
 To start running a Sanic application, provide a path to the module, where
-app is a Sanic() instance:
+app is a Sanic() instance in the global scope:
 
     $ sanic path.to.server:app
 
+If the Sanic instance variable is called 'app', you can leave off the last
+part, and only provide a path to the module where the instance is:
+
+    $ sanic path.to.server
+
 Or, a path to a callable that returns a Sanic() instance:
 
-    $ sanic path.to.factory:create_app --factory
+    $ sanic path.to.factory:create_app
 
 Or, a path to a directory to run as a simple HTTP server:
 
-    $ sanic ./path/to/static --simple
+    $ sanic ./path/to/static
 """,
         prefix=" ",
     )
@@ -95,13 +99,9 @@ Or, a path to a directory to run as a simple HTTP server:
         self.args = self.parser.parse_args(args=parse_args)
         self._precheck()
         app_loader = AppLoader(
-            self.args.module, self.args.factory, self.args.simple, self.args
+            self.args.target, self.args.factory, self.args.simple, self.args
         )
 
-        if self.args.inspect or self.args.inspect_raw or self.args.trigger:
-            self._inspector_legacy(app_loader)
-            return
-
         try:
             app = self._get_app(app_loader)
             kwargs = self._build_run_kwargs()
@@ -112,38 +112,10 @@ Or, a path to a directory to run as a simple HTTP server:
                 app.prepare(**kwargs, version=http_version)
             if self.args.single:
                 serve = Sanic.serve_single
-            elif self.args.legacy:
-                serve = Sanic.serve_legacy
             else:
                 serve = partial(Sanic.serve, app_loader=app_loader)
             serve(app)
 
-    def _inspector_legacy(self, app_loader: AppLoader):
-        host = port = None
-        module = cast(str, self.args.module)
-        if ":" in module:
-            maybe_host, maybe_port = module.rsplit(":", 1)
-            if maybe_port.isnumeric():
-                host, port = maybe_host, int(maybe_port)
-        if not host:
-            app = self._get_app(app_loader)
-            host, port = app.config.INSPECTOR_HOST, app.config.INSPECTOR_PORT
-
-        action = self.args.trigger or "info"
-
-        InspectorClient(
-            str(host), int(port or 6457), False, self.args.inspect_raw, ""
-        ).do(action)
-        sys.stdout.write(
-            f"\n{Colors.BOLD}{Colors.YELLOW}WARNING:{Colors.END} "
-            "You are using the legacy CLI command that will be removed in "
-            f"{Colors.RED}v23.3{Colors.END}. See "
-            "https://sanic.dev/en/guide/release-notes/v22.12.html"
-            "#deprecations-and-removals or checkout the new "
-            "style commands:\n\n\t"
-            f"{Colors.YELLOW}sanic inspect --help{Colors.END}\n"
-        )
-
     def _inspector(self):
         args = sys.argv[2:]
         self.args, unknown = self.parser.parse_known_args(args=args)
@@ -197,8 +169,6 @@ Or, a path to a directory to run as a simple HTTP server:
             )
             error_logger.error(message)
             sys.exit(1)
-        if self.args.inspect or self.args.inspect_raw:
-            logging.disable(logging.CRITICAL)
 
     def _get_app(self, app_loader: AppLoader):
         try:
@@ -210,6 +180,10 @@ Or, a path to a directory to run as a simple HTTP server:
                     "  Example File: project/sanic_server.py -> app\n"
                     "  Example Module: project.sanic_server.app"
                 )
+                error_logger.error(
+                    "\nThe error below might have caused the above one:\n"
+                    f"{e.msg}"
+                )
                 sys.exit(1)
             else:
                 raise e
@@ -246,7 +220,6 @@ Or, a path to a directory to run as a simple HTTP server:
             "workers": self.args.workers,
             "auto_tls": self.args.auto_tls,
             "single_process": self.args.single,
-            "legacy": self.args.legacy,
         }
 
         for maybe_arg in ("auto_reload", "dev"):

sanic/cli/arguments.py

@@ -57,11 +57,15 @@ class GeneralGroup(Group):
         )
 
         self.container.add_argument(
-            "module",
+            "target",
             help=(
-                "Path to your Sanic app. Example: path.to.server:app\n"
+                "Path to your Sanic app instance.\n"
-                "If running a Simple Server, path to directory to serve. "
+                "\tExample: path.to.server:app\n"
-                "Example: ./\n"
+                "If running a Simple Server, path to directory to serve.\n"
+                "\tExample: ./\n"
+                "Additionally, this can be a path to a factory function\n"
+                "that returns a Sanic app instance.\n"
+                "\tExample: path.to.server:create_app\n"
             ),
         )
 
@@ -89,32 +93,6 @@ class ApplicationGroup(Group):
                 "a directory\n(module arg should be a path)"
             ),
         )
-        group.add_argument(
-            "--inspect",
-            dest="inspect",
-            action="store_true",
-            help=("Inspect the state of a running instance, human readable"),
-        )
-        group.add_argument(
-            "--inspect-raw",
-            dest="inspect_raw",
-            action="store_true",
-            help=("Inspect the state of a running instance, JSON output"),
-        )
-        group.add_argument(
-            "--trigger-reload",
-            dest="trigger",
-            action="store_const",
-            const="reload",
-            help=("Trigger worker processes to reload"),
-        )
-        group.add_argument(
-            "--trigger-shutdown",
-            dest="trigger",
-            action="store_const",
-            const="shutdown",
-            help=("Trigger all processes to shutdown"),
-        )
 
 
 class HTTPVersionGroup(Group):
@@ -243,11 +221,6 @@ class WorkerGroup(Group):
             action="store_true",
             help="Do not use multiprocessing, run server in a single process",
         )
-        self.container.add_argument(
-            "--legacy",
-            action="store_true",
-            help="Use the legacy server manager",
-        )
         self.add_bool_arguments(
             "--access-logs",
             dest="access_log",

sanic/compat.py

@@ -1,5 +1,6 @@
 import asyncio
 import os
+import platform
 import signal
 import sys
 
@@ -10,6 +11,7 @@ from typing import Awaitable, Union
 from multidict import CIMultiDict  # type: ignore
 
 from sanic.helpers import Default
+from sanic.log import error_logger
 
 
 if sys.version_info < (3, 8):  # no cov
@@ -22,6 +24,7 @@ else:  # no cov
     ]
 
 OS_IS_WINDOWS = os.name == "nt"
+PYPY_IMPLEMENTATION = platform.python_implementation() == "PyPy"
 UVLOOP_INSTALLED = False
 
 try:
@@ -73,6 +76,38 @@ def enable_windows_color_support():
     kernel.SetConsoleMode(kernel.GetStdHandle(-11), 7)
 
 
+def pypy_os_module_patch() -> None:
+    """
+    The PyPy os module is missing the 'readlink' function, which causes issues
+    withaiofiles. This workaround replaces the missing 'readlink' function
+    with 'os.path.realpath', which serves the same purpose.
+    """
+    if hasattr(os, "readlink"):
+        error_logger.warning(
+            "PyPy: Skipping patching of the os module as it appears the "
+            "'readlink' function has been added."
+        )
+        return
+
+    module = sys.modules["os"]
+    module.readlink = os.path.realpath  # type: ignore
+
+
+def pypy_windows_set_console_cp_patch() -> None:
+    """
+    A patch function for PyPy on Windows that sets the console code page to
+    UTF-8 encodingto allow for proper handling of non-ASCII characters. This
+    function uses ctypes to call the Windows API functions SetConsoleCP and
+    SetConsoleOutputCP to set the code page.
+    """
+    from ctypes import windll  # type: ignore
+
+    code: int = windll.kernel32.GetConsoleOutputCP()
+    if code != 65001:
+        windll.kernel32.SetConsoleCP(65001)
+        windll.kernel32.SetConsoleOutputCP(65001)
+
+
 class Header(CIMultiDict):
     """
     Container used for both request and response headers. It is a subclass of
@@ -86,7 +121,7 @@ class Header(CIMultiDict):
     <https://multidict.readthedocs.io/en/stable/multidict.html#multidict>`_
     for more details about how to use the object. In general, it should work
     very similar to a regular dictionary.
-    """
+    """  # noqa: E501
 
     def __getattr__(self, key: str) -> str:
         if key.startswith("_"):
@@ -112,6 +147,12 @@ if use_trio:  # pragma: no cover
     open_async = trio.open_file
     CancelledErrors = tuple([asyncio.CancelledError, trio.Cancelled])
 else:
+    if PYPY_IMPLEMENTATION:
+        pypy_os_module_patch()
+
+        if OS_IS_WINDOWS:
+            pypy_windows_set_console_cp_patch()
+
     from aiofiles import open as aio_open  # type: ignore
     from aiofiles.os import stat as stat_async  # type: ignore  # noqa: F401
 
@@ -143,7 +184,3 @@ def ctrlc_workaround_for_windows(app):
     die = False
     signal.signal(signal.SIGINT, ctrlc_handler)
     app.add_task(stay_active)
-
-
-def is_atty() -> bool:
-    return bool(sys.stdout and sys.stdout.isatty())

sanic/config.py

@@ -43,14 +43,14 @@ DEFAULT_CONFIG = {
     "DEPRECATION_FILTER": "once",
     "FORWARDED_FOR_HEADER": "X-Forwarded-For",
     "FORWARDED_SECRET": None,
-    "GRACEFUL_SHUTDOWN_TIMEOUT": 15.0,  # 15 sec
+    "GRACEFUL_SHUTDOWN_TIMEOUT": 15.0,
     "INSPECTOR": False,
     "INSPECTOR_HOST": "localhost",
     "INSPECTOR_PORT": 6457,
     "INSPECTOR_TLS_KEY": _default,
     "INSPECTOR_TLS_CERT": _default,
     "INSPECTOR_API_KEY": "",
-    "KEEP_ALIVE_TIMEOUT": 5,  # 5 seconds
+    "KEEP_ALIVE_TIMEOUT": 120,
     "KEEP_ALIVE": True,
     "LOCAL_CERT_CREATOR": LocalCertCreator.AUTO,
     "LOCAL_TLS_KEY": _default,
@@ -61,16 +61,16 @@ DEFAULT_CONFIG = {
     "NOISY_EXCEPTIONS": False,
     "PROXIES_COUNT": None,
     "REAL_IP_HEADER": None,
-    "REQUEST_BUFFER_SIZE": 65536,  # 64 KiB
+    "REQUEST_BUFFER_SIZE": 65536,
-    "REQUEST_MAX_HEADER_SIZE": 8192,  # 8 KiB, but cannot exceed 16384
+    "REQUEST_MAX_HEADER_SIZE": 8192,  # Cannot exceed 16384
     "REQUEST_ID_HEADER": "X-Request-ID",
-    "REQUEST_MAX_SIZE": 100000000,  # 100 megabytes
+    "REQUEST_MAX_SIZE": 100_000_000,
-    "REQUEST_TIMEOUT": 60,  # 60 seconds
+    "REQUEST_TIMEOUT": 60,
-    "RESPONSE_TIMEOUT": 60,  # 60 seconds
+    "RESPONSE_TIMEOUT": 60,
     "TLS_CERT_PASSWORD": "",
     "TOUCHUP": _default,
     "USE_UVLOOP": _default,
-    "WEBSOCKET_MAX_SIZE": 2**20,  # 1 megabyte
+    "WEBSOCKET_MAX_SIZE": 2**20,  # 1 MiB
     "WEBSOCKET_PING_INTERVAL": 20,
     "WEBSOCKET_PING_TIMEOUT": 20,
 }

sanic/cookies.py

@@ -1,156 +0,0 @@
-import re
-import string
-
-from datetime import datetime
-from typing import Dict
-
-
-DEFAULT_MAX_AGE = 0
-
-# ------------------------------------------------------------ #
-#  SimpleCookie
-# ------------------------------------------------------------ #
-
-# Straight up copied this section of dark magic from SimpleCookie
-
-_LegalChars = string.ascii_letters + string.digits + "!#$%&'*+-.^_`|~:"
-_UnescapedChars = _LegalChars + " ()/<=>?@[]{}"
-
-_Translator = {
-    n: "\\%03o" % n for n in set(range(256)) - set(map(ord, _UnescapedChars))
-}
-_Translator.update({ord('"'): '\\"', ord("\\"): "\\\\"})
-
-
-def _quote(str):
-    r"""Quote a string for use in a cookie header.
-    If the string does not need to be double-quoted, then just return the
-    string.  Otherwise, surround the string in doublequotes and quote
-    (with a \) special characters.
-    """
-    if str is None or _is_legal_key(str):
-        return str
-    else:
-        return '"' + str.translate(_Translator) + '"'
-
-
-_is_legal_key = re.compile("[%s]+" % re.escape(_LegalChars)).fullmatch
-
-# ------------------------------------------------------------ #
-#  Custom SimpleCookie
-# ------------------------------------------------------------ #
-
-
-class CookieJar(dict):
-    """
-    CookieJar dynamically writes headers as cookies are added and removed
-    It gets around the limitation of one header per name by using the
-    MultiHeader class to provide a unique key that encodes to Set-Cookie.
-    """
-
-    def __init__(self, headers):
-        super().__init__()
-        self.headers: Dict[str, str] = headers
-        self.cookie_headers: Dict[str, str] = {}
-        self.header_key: str = "Set-Cookie"
-
-    def __setitem__(self, key, value):
-        # If this cookie doesn't exist, add it to the header keys
-        if not self.cookie_headers.get(key):
-            cookie = Cookie(key, value)
-            cookie["path"] = "/"
-            self.cookie_headers[key] = self.header_key
-            self.headers.add(self.header_key, cookie)
-            return super().__setitem__(key, cookie)
-        else:
-            self[key].value = value
-
-    def __delitem__(self, key):
-        if key not in self.cookie_headers:
-            self[key] = ""
-            self[key]["max-age"] = 0
-        else:
-            cookie_header = self.cookie_headers[key]
-            # remove it from header
-            cookies = self.headers.popall(cookie_header)
-            for cookie in cookies:
-                if cookie.key != key:
-                    self.headers.add(cookie_header, cookie)
-            del self.cookie_headers[key]
-            return super().__delitem__(key)
-
-
-class Cookie(dict):
-    """A stripped down version of Morsel from SimpleCookie #gottagofast"""
-
-    _keys = {
-        "expires": "expires",
-        "path": "Path",
-        "comment": "Comment",
-        "domain": "Domain",
-        "max-age": "Max-Age",
-        "secure": "Secure",
-        "httponly": "HttpOnly",
-        "version": "Version",
-        "samesite": "SameSite",
-    }
-    _flags = {"secure", "httponly"}
-
-    def __init__(self, key, value):
-        if key in self._keys:
-            raise KeyError("Cookie name is a reserved word")
-        if not _is_legal_key(key):
-            raise KeyError("Cookie key contains illegal characters")
-        self.key = key
-        self.value = value
-        super().__init__()
-
-    def __setitem__(self, key, value):
-        if key not in self._keys:
-            raise KeyError("Unknown cookie property")
-        if value is not False:
-            if key.lower() == "max-age":
-                if not str(value).isdigit():
-                    raise ValueError("Cookie max-age must be an integer")
-            elif key.lower() == "expires":
-                if not isinstance(value, datetime):
-                    raise TypeError(
-                        "Cookie 'expires' property must be a datetime"
-                    )
-            return super().__setitem__(key, value)
-
-    def encode(self, encoding):
-        """
-        Encode the cookie content in a specific type of encoding instructed
-        by the developer. Leverages the :func:`str.encode` method provided
-        by python.
-
-        This method can be used to encode and embed ``utf-8`` content into
-        the cookies.
-
-        :param encoding: Encoding to be used with the cookie
-        :return: Cookie encoded in a codec of choosing.
-        :except: UnicodeEncodeError
-        """
-        return str(self).encode(encoding)
-
-    def __str__(self):
-        """Format as a Set-Cookie header value."""
-        output = ["%s=%s" % (self.key, _quote(self.value))]
-        for key, value in self.items():
-            if key == "max-age":
-                try:
-                    output.append("%s=%d" % (self._keys[key], value))
-                except TypeError:
-                    output.append("%s=%s" % (self._keys[key], value))
-            elif key == "expires":
-                output.append(
-                    "%s=%s"
-                    % (self._keys[key], value.strftime("%a, %d-%b-%Y %T GMT"))
-                )
-            elif key in self._flags and self[key]:
-                output.append(self._keys[key])
-            else:
-                output.append("%s=%s" % (self._keys[key], value))
-
-        return "; ".join(output)

sanic/cookies/__init__.py

@@ -0,0 +1,4 @@
+from .response import Cookie, CookieJar
+
+
+__all__ = ("Cookie", "CookieJar")

sanic/cookies/request.py

@@ -0,0 +1,119 @@
+import re
+
+from typing import Any, Dict, List, Optional
+
+from sanic.cookies.response import Cookie
+from sanic.log import deprecation
+from sanic.request.parameters import RequestParameters
+
+
+COOKIE_NAME_RESERVED_CHARS = re.compile(
+    '[\x00-\x1F\x7F-\xFF()<>@,;:\\\\"/[\\]?={} \x09]'
+)
+OCTAL_PATTERN = re.compile(r"\\[0-3][0-7][0-7]")
+QUOTE_PATTERN = re.compile(r"[\\].")
+
+
+def _unquote(str):  # no cov
+    if str is None or len(str) < 2:
+        return str
+    if str[0] != '"' or str[-1] != '"':
+        return str
+
+    str = str[1:-1]
+
+    i = 0
+    n = len(str)
+    res = []
+    while 0 <= i < n:
+        o_match = OCTAL_PATTERN.search(str, i)
+        q_match = QUOTE_PATTERN.search(str, i)
+        if not o_match and not q_match:
+            res.append(str[i:])
+            break
+        # else:
+        j = k = -1
+        if o_match:
+            j = o_match.start(0)
+        if q_match:
+            k = q_match.start(0)
+        if q_match and (not o_match or k < j):
+            res.append(str[i:k])
+            res.append(str[k + 1])
+            i = k + 2
+        else:
+            res.append(str[i:j])
+            res.append(chr(int(str[j + 1 : j + 4], 8)))  # noqa: E203
+            i = j + 4
+    return "".join(res)
+
+
+def parse_cookie(raw: str):
+    cookies: Dict[str, List] = {}
+
+    for token in raw.split(";"):
+        name, __, value = token.partition("=")
+        name = name.strip()
+        value = value.strip()
+
+        if not name:
+            continue
+
+        if COOKIE_NAME_RESERVED_CHARS.search(name):  # no cov
+            continue
+
+        if len(value) > 2 and value[0] == '"' and value[-1] == '"':  # no cov
+            value = _unquote(value)
+
+        if name in cookies:
+            cookies[name].append(value)
+        else:
+            cookies[name] = [value]
+
+    return cookies
+
+
+class CookieRequestParameters(RequestParameters):
+    def __getitem__(self, key: str) -> Optional[str]:
+        deprecation(
+            f"You are accessing cookie key '{key}', which is currently in "
+            "compat mode returning a single cookie value. Starting in v24.3 "
+            "accessing a cookie value like this will return a list of values. "
+            "To avoid this behavior and continue accessing a single value, "
+            f"please upgrade from request.cookies['{key}'] to "
+            f"request.cookies.get('{key}'). See more details: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#request-cookies",  # noqa
+            24.3,
+        )
+        try:
+            value = self._get_prefixed_cookie(key)
+        except KeyError:
+            value = super().__getitem__(key)
+        return value[0]
+
+    def __getattr__(self, key: str) -> str:
+        if key.startswith("_"):
+            return self.__getattribute__(key)
+        key = key.rstrip("_").replace("_", "-")
+        return str(self.get(key, ""))
+
+    def get(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
+        try:
+            return self._get_prefixed_cookie(name)[0]
+        except KeyError:
+            return super().get(name, default)
+
+    def getlist(
+        self, name: str, default: Optional[Any] = None
+    ) -> Optional[Any]:
+        try:
+            return self._get_prefixed_cookie(name)
+        except KeyError:
+            return super().getlist(name, default)
+
+    def _get_prefixed_cookie(self, name: str) -> Any:
+        getitem = super().__getitem__
+        try:
+            return getitem(f"{Cookie.HOST_PREFIX}{name}")
+        except KeyError:
+            return getitem(f"{Cookie.SECURE_PREFIX}{name}")

sanic/cookies/response.py

@@ -0,0 +1,617 @@
+from __future__ import annotations
+
+import re
+import string
+import sys
+
+from datetime import datetime
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
+
+from sanic.exceptions import ServerError
+from sanic.log import deprecation
+
+
+if TYPE_CHECKING:
+    from sanic.compat import Header
+
+if sys.version_info < (3, 8):  # no cov
+    SameSite = str
+else:  # no cov
+    from typing import Literal
+
+    SameSite = Union[
+        Literal["Strict"],
+        Literal["Lax"],
+        Literal["None"],
+        Literal["strict"],
+        Literal["lax"],
+        Literal["none"],
+    ]
+
+DEFAULT_MAX_AGE = 0
+SAMESITE_VALUES = ("strict", "lax", "none")
+
+LEGAL_CHARS = string.ascii_letters + string.digits + "!#$%&'*+-.^_`|~:"
+UNESCAPED_CHARS = LEGAL_CHARS + " ()/<=>?@[]{}"
+TRANSLATOR = {ch: f"\\{ch:03o}" for ch in bytes(range(32)) + b'";\\\x7F'}
+
+
+def _quote(str):  # no cov
+    r"""Quote a string for use in a cookie header.
+    If the string does not need to be double-quoted, then just return the
+    string.  Otherwise, surround the string in doublequotes and quote
+    (with a \) special characters.
+    """
+    if str is None or _is_legal_key(str):
+        return str
+    else:
+        return f'"{str.translate(TRANSLATOR)}"'
+
+
+_is_legal_key = re.compile("[%s]+" % re.escape(LEGAL_CHARS)).fullmatch
+
+
+# In v24.3, we should remove this as being a subclass of dict
+class CookieJar(dict):
+    """
+    CookieJar dynamically writes headers as cookies are added and removed
+    It gets around the limitation of one header per name by using the
+    MultiHeader class to provide a unique key that encodes to Set-Cookie.
+    """
+
+    HEADER_KEY = "Set-Cookie"
+
+    def __init__(self, headers: Header):
+        super().__init__()
+        self.headers = headers
+
+    def __setitem__(self, key, value):
+        # If this cookie doesn't exist, add it to the header keys
+        deprecation(
+            "Setting cookie values using the dict pattern has been "
+            "deprecated. You should instead use the cookies.add_cookie "
+            "method. To learn more, please see: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies",  # noqa
+            0,
+        )
+        if key not in self:
+            self.add_cookie(key, value, secure=False, samesite=None)
+        else:
+            self[key].value = value
+
+    def __delitem__(self, key):
+        deprecation(
+            "Deleting cookie values using the dict pattern has been "
+            "deprecated. You should instead use the cookies.delete_cookie "
+            "method. To learn more, please see: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies",  # noqa
+            0,
+        )
+        if key in self:
+            super().__delitem__(key)
+        self.delete_cookie(key)
+
+    def __len__(self):  # no cov
+        return len(self.cookies)
+
+    def __getitem__(self, key: str) -> Cookie:
+        deprecation(
+            "Accessing cookies from the CookieJar by dict key is deprecated. "
+            "You should instead use the cookies.get_cookie method. "
+            "To learn more, please see: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies",  # noqa
+            0,
+        )
+        return super().__getitem__(key)
+
+    def __iter__(self):  # no cov
+        deprecation(
+            "Iterating over the CookieJar has been deprecated and will be "
+            "removed in v24.3. To learn more, please see: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies",  # noqa
+            24.3,
+        )
+        return super().__iter__()
+
+    def keys(self):  # no cov
+        deprecation(
+            "Accessing CookieJar.keys() has been deprecated and will be "
+            "removed in v24.3. To learn more, please see: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies",  # noqa
+            24.3,
+        )
+        return super().keys()
+
+    def values(self):  # no cov
+        deprecation(
+            "Accessing CookieJar.values() has been deprecated and will be "
+            "removed in v24.3. To learn more, please see: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies",  # noqa
+            24.3,
+        )
+        return super().values()
+
+    def items(self):  # no cov
+        deprecation(
+            "Accessing CookieJar.items() has been deprecated and will be "
+            "removed in v24.3. To learn more, please see: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies",  # noqa
+            24.3,
+        )
+        return super().items()
+
+    def get(self, *args, **kwargs):  # no cov
+        deprecation(
+            "Accessing cookies from the CookieJar using get is deprecated "
+            "and will be removed in v24.3. You should instead use the "
+            "cookies.get_cookie method. To learn more, please see: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies",  # noqa
+            24.3,
+        )
+        return super().get(*args, **kwargs)
+
+    def pop(self, key, *args, **kwargs):  # no cov
+        deprecation(
+            "Using CookieJar.pop() has been deprecated and will be "
+            "removed in v24.3. To learn more, please see: "
+            "https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies",  # noqa
+            24.3,
+        )
+        self.delete(key)
+        return super().pop(key, *args, **kwargs)
+
+    @property
+    def header_key(self):  # no cov
+        deprecation(
+            "The CookieJar.header_key property has been deprecated and will "
+            "be removed in version 24.3. Use CookieJar.HEADER_KEY. ",
+            24.3,
+        )
+        return CookieJar.HEADER_KEY
+
+    @property
+    def cookie_headers(self) -> Dict[str, str]:  # no cov
+        deprecation(
+            "The CookieJar.coookie_headers property has been deprecated "
+            "and will be removed in version 24.3. If you need to check if a "
+            "particular cookie key has been set, use CookieJar.has_cookie.",
+            24.3,
+        )
+        return {key: self.header_key for key in self}
+
+    @property
+    def cookies(self) -> List[Cookie]:
+        return self.headers.getall(self.HEADER_KEY)
+
+    def get_cookie(
+        self,
+        key: str,
+        path: str = "/",
+        domain: Optional[str] = None,
+        host_prefix: bool = False,
+        secure_prefix: bool = False,
+    ) -> Optional[Cookie]:
+        for cookie in self.cookies:
+            if (
+                cookie.key == Cookie.make_key(key, host_prefix, secure_prefix)
+                and cookie.path == path
+                and cookie.domain == domain
+            ):
+                return cookie
+        return None
+
+    def has_cookie(
+        self,
+        key: str,
+        path: str = "/",
+        domain: Optional[str] = None,
+        host_prefix: bool = False,
+        secure_prefix: bool = False,
+    ) -> bool:
+        for cookie in self.cookies:
+            if (
+                cookie.key == Cookie.make_key(key, host_prefix, secure_prefix)
+                and cookie.path == path
+                and cookie.domain == domain
+            ):
+                return True
+        return False
+
+    def add_cookie(
+        self,
+        key: str,
+        value: str,
+        *,
+        path: str = "/",
+        domain: Optional[str] = None,
+        secure: bool = True,
+        max_age: Optional[int] = None,
+        expires: Optional[datetime] = None,
+        httponly: bool = False,
+        samesite: Optional[SameSite] = "Lax",
+        partitioned: bool = False,
+        comment: Optional[str] = None,
+        host_prefix: bool = False,
+        secure_prefix: bool = False,
+    ) -> Cookie:
+        """
+        Add a cookie to the CookieJar
+
+        :param key: Key of the cookie
+        :type key: str
+        :param value: Value of the cookie
+        :type value: str
+        :param path: Path of the cookie, defaults to None
+        :type path: Optional[str], optional
+        :param domain: Domain of the cookie, defaults to None
+        :type domain: Optional[str], optional
+        :param secure: Whether to set it as a secure cookie, defaults to True
+        :type secure: bool
+        :param max_age: Max age of the cookie in seconds; if set to 0 a
+            browser should delete it, defaults to None
+        :type max_age: Optional[int], optional
+        :param expires: When the cookie expires; if set to None browsers
+            should set it as a session cookie, defaults to None
+        :type expires: Optional[datetime], optional
+        :param httponly: Whether to set it as HTTP only, defaults to False
+        :type httponly: bool
+        :param samesite: How to set the samesite property, should be
+            strict, lax or none (case insensitive), defaults to Lax
+        :type samesite: Optional[SameSite], optional
+        :param partitioned: Whether to set it as partitioned, defaults to False
+        :type partitioned: bool
+        :param comment: A cookie comment, defaults to None
+        :type comment: Optional[str], optional
+        :param host_prefix: Whether to add __Host- as a prefix to the key.
+            This requires that path="/", domain=None, and secure=True,
+            defaults to False
+        :type host_prefix: bool
+        :param secure_prefix: Whether to add __Secure- as a prefix to the key.
+            This requires that secure=True, defaults to False
+        :type secure_prefix: bool
+        :return: The instance of the created cookie
+        :rtype: Cookie
+        """
+        cookie = Cookie(
+            key,
+            value,
+            path=path,
+            expires=expires,
+            comment=comment,
+            domain=domain,
+            max_age=max_age,
+            secure=secure,
+            httponly=httponly,
+            samesite=samesite,
+            partitioned=partitioned,
+            host_prefix=host_prefix,
+            secure_prefix=secure_prefix,
+        )
+        self.headers.add(self.HEADER_KEY, cookie)
+
+        # This should be removed in v24.3
+        super().__setitem__(key, cookie)
+
+        return cookie
+
+    def delete_cookie(
+        self,
+        key: str,
+        *,
+        path: str = "/",
+        domain: Optional[str] = None,
+        host_prefix: bool = False,
+        secure_prefix: bool = False,
+    ) -> None:
+        """
+        Delete a cookie
+
+        This will effectively set it as Max-Age: 0, which a browser should
+        interpret it to mean: "delete the cookie".
+
+        Since it is a browser/client implementation, your results may vary
+        depending upon which client is being used.
+
+        :param key: The key to be deleted
+        :type key: str
+        :param path: Path of the cookie, defaults to None
+        :type path: Optional[str], optional
+        :param domain: Domain of the cookie, defaults to None
+        :type domain: Optional[str], optional
+        :param host_prefix: Whether to add __Host- as a prefix to the key.
+            This requires that path="/", domain=None, and secure=True,
+            defaults to False
+        :type host_prefix: bool
+        :param secure_prefix: Whether to add __Secure- as a prefix to the key.
+            This requires that secure=True, defaults to False
+        :type secure_prefix: bool
+        """
+        # remove it from header
+        cookies: List[Cookie] = self.headers.popall(self.HEADER_KEY, [])
+        for cookie in cookies:
+            if (
+                cookie.key != Cookie.make_key(key, host_prefix, secure_prefix)
+                or cookie.path != path
+                or cookie.domain != domain
+            ):
+                self.headers.add(self.HEADER_KEY, cookie)
+
+        # This should be removed in v24.3
+        try:
+            super().__delitem__(key)
+        except KeyError:
+            ...
+
+        self.add_cookie(
+            key=key,
+            value="",
+            path=path,
+            domain=domain,
+            max_age=0,
+            samesite=None,
+            host_prefix=host_prefix,
+            secure_prefix=secure_prefix,
+        )
+
+
+# In v24.3, we should remove this as being a subclass of dict
+# Instead, it should be an object with __slots__
+# All of the current property accessors should be removed in favor
+# of actual slotted properties.
+class Cookie(dict):
+    """A stripped down version of Morsel from SimpleCookie"""
+
+    HOST_PREFIX = "__Host-"
+    SECURE_PREFIX = "__Secure-"
+
+    _keys = {
+        "path": "Path",
+        "comment": "Comment",
+        "domain": "Domain",
+        "max-age": "Max-Age",
+        "expires": "expires",
+        "samesite": "SameSite",
+        "version": "Version",
+        "secure": "Secure",
+        "httponly": "HttpOnly",
+        "partitioned": "Partitioned",
+    }
+    _flags = {"secure", "httponly", "partitioned"}
+
+    def __init__(
+        self,
+        key: str,
+        value: str,
+        *,
+        path: str = "/",
+        domain: Optional[str] = None,
+        secure: bool = True,
+        max_age: Optional[int] = None,
+        expires: Optional[datetime] = None,
+        httponly: bool = False,
+        samesite: Optional[SameSite] = "Lax",
+        partitioned: bool = False,
+        comment: Optional[str] = None,
+        host_prefix: bool = False,
+        secure_prefix: bool = False,
+    ):
+        if key in self._keys:
+            raise KeyError("Cookie name is a reserved word")
+        if not _is_legal_key(key):
+            raise KeyError("Cookie key contains illegal characters")
+        if host_prefix:
+            if not secure:
+                raise ServerError(
+                    "Cannot set host_prefix on a cookie without secure=True"
+                )
+            if path != "/":
+                raise ServerError(
+                    "Cannot set host_prefix on a cookie unless path='/'"
+                )
+            if domain:
+                raise ServerError(
+                    "Cannot set host_prefix on a cookie with a defined domain"
+                )
+        elif secure_prefix and not secure:
+            raise ServerError(
+                "Cannot set secure_prefix on a cookie without secure=True"
+            )
+        if partitioned and not host_prefix:
+            # This is technically possible, but it is not advisable so we will
+            # take a stand and say "don't shoot yourself in the foot"
+            raise ServerError(
+                "Cannot create a partitioned cookie without "
+                "also setting host_prefix=True"
+            )
+
+        self.key = self.make_key(key, host_prefix, secure_prefix)
+        self.value = value
+        super().__init__()
+
+        # This is a temporary solution while this object is a dict. We update
+        # all of the values in bulk, except for the values that have
+        # key-specific validation in _set_value
+        self.update(
+            {
+                "path": path,
+                "comment": comment,
+                "domain": domain,
+                "secure": secure,
+                "httponly": httponly,
+                "partitioned": partitioned,
+                "expires": None,
+                "max-age": None,
+                "samesite": None,
+            }
+        )
+        if expires is not None:
+            self._set_value("expires", expires)
+        if max_age is not None:
+            self._set_value("max-age", max_age)
+        if samesite is not None:
+            self._set_value("samesite", samesite)
+
+    def __setitem__(self, key, value):
+        deprecation(
+            "Setting values on a Cookie object as a dict has been deprecated. "
+            "This feature will be removed in v24.3. You should instead set "
+            f"values on cookies as object properties: cookie.{key}=... ",
+            24.3,
+        )
+        self._set_value(key, value)
+
+    # This is a temporary method for backwards compat and should be removed
+    # in v24.3 when this is no longer a dict
+    def _set_value(self, key: str, value: Any) -> None:
+        if key not in self._keys:
+            raise KeyError("Unknown cookie property: %s=%s" % (key, value))
+
+        if value is not None:
+            if key.lower() == "max-age" and not str(value).isdigit():
+                raise ValueError("Cookie max-age must be an integer")
+            elif key.lower() == "expires" and not isinstance(value, datetime):
+                raise TypeError("Cookie 'expires' property must be a datetime")
+            elif key.lower() == "samesite":
+                if value.lower() not in SAMESITE_VALUES:
+                    raise TypeError(
+                        "Cookie 'samesite' property must "
+                        f"be one of: {','.join(SAMESITE_VALUES)}"
+                    )
+                value = value.title()
+
+        super().__setitem__(key, value)
+
+    def encode(self, encoding):
+        """
+        Encode the cookie content in a specific type of encoding instructed
+        by the developer. Leverages the :func:`str.encode` method provided
+        by python.
+
+        This method can be used to encode and embed ``utf-8`` content into
+        the cookies.
+
+        :param encoding: Encoding to be used with the cookie
+        :return: Cookie encoded in a codec of choosing.
+        :except: UnicodeEncodeError
+        """
+        deprecation(
+            "Direct encoding of a Cookie object has been deprecated and will "
+            "be removed in v24.3.",
+            24.3,
+        )
+        return str(self).encode(encoding)
+
+    def __str__(self):
+        """Format as a Set-Cookie header value."""
+        output = ["%s=%s" % (self.key, _quote(self.value))]
+        key_index = list(self._keys)
+        for key, value in sorted(
+            self.items(), key=lambda x: key_index.index(x[0])
+        ):
+            if value is not None and value is not False:
+                if key == "max-age":
+                    try:
+                        output.append("%s=%d" % (self._keys[key], value))
+                    except TypeError:
+                        output.append("%s=%s" % (self._keys[key], value))
+                elif key == "expires":
+                    output.append(
+                        "%s=%s"
+                        % (
+                            self._keys[key],
+                            value.strftime("%a, %d-%b-%Y %T GMT"),
+                        )
+                    )
+                elif key in self._flags:
+                    output.append(self._keys[key])
+                else:
+                    output.append("%s=%s" % (self._keys[key], value))
+
+        return "; ".join(output)
+
+    @property
+    def path(self) -> str:  # no cov
+        return self["path"]
+
+    @path.setter
+    def path(self, value: str) -> None:  # no cov
+        self._set_value("path", value)
+
+    @property
+    def expires(self) -> Optional[datetime]:  # no cov
+        return self.get("expires")
+
+    @expires.setter
+    def expires(self, value: datetime) -> None:  # no cov
+        self._set_value("expires", value)
+
+    @property
+    def comment(self) -> Optional[str]:  # no cov
+        return self.get("comment")
+
+    @comment.setter
+    def comment(self, value: str) -> None:  # no cov
+        self._set_value("comment", value)
+
+    @property
+    def domain(self) -> Optional[str]:  # no cov
+        return self.get("domain")
+
+    @domain.setter
+    def domain(self, value: str) -> None:  # no cov
+        self._set_value("domain", value)
+
+    @property
+    def max_age(self) -> Optional[int]:  # no cov
+        return self.get("max-age")
+
+    @max_age.setter
+    def max_age(self, value: int) -> None:  # no cov
+        self._set_value("max-age", value)
+
+    @property
+    def secure(self) -> bool:  # no cov
+        return self.get("secure", False)
+
+    @secure.setter
+    def secure(self, value: bool) -> None:  # no cov
+        self._set_value("secure", value)
+
+    @property
+    def httponly(self) -> bool:  # no cov
+        return self.get("httponly", False)
+
+    @httponly.setter
+    def httponly(self, value: bool) -> None:  # no cov
+        self._set_value("httponly", value)
+
+    @property
+    def samesite(self) -> Optional[SameSite]:  # no cov
+        return self.get("samesite")
+
+    @samesite.setter
+    def samesite(self, value: SameSite) -> None:  # no cov
+        self._set_value("samesite", value)
+
+    @property
+    def partitioned(self) -> bool:  # no cov
+        return self.get("partitioned", False)
+
+    @partitioned.setter
+    def partitioned(self, value: bool) -> None:  # no cov
+        self._set_value("partitioned", value)
+
+    @classmethod
+    def make_key(
+        cls, key: str, host_prefix: bool = False, secure_prefix: bool = False
+    ) -> str:
+        if host_prefix and secure_prefix:
+            raise ServerError(
+                "Both host_prefix and secure_prefix were requested. "
+                "A cookie should have only one prefix."
+            )
+        elif host_prefix:
+            key = cls.HOST_PREFIX + key
+        elif secure_prefix:
+            key = cls.SECURE_PREFIX + key
+        return key

sanic/errorpages.py

@@ -92,8 +92,10 @@ class BaseRenderer:
             self.full
             if self.debug and not getattr(self.exception, "quiet", False)
             else self.minimal
-        )
+        )()
-        return output()
+        output.status = self.status
+        output.headers.update(self.headers)
+        return output
 
     def minimal(self) -> HTTPResponse:  # noqa
         """
@@ -125,7 +127,7 @@ class HTMLRenderer(BaseRenderer):
             request=self.request,
             exc=self.exception,
         )
-        return html(page.render(), status=self.status, headers=self.headers)
+        return html(page.render())
 
     def minimal(self) -> HTTPResponse:
         return self.full()
@@ -146,8 +148,7 @@ class TextRenderer(BaseRenderer):
                 text=self.text,
                 bar=("=" * len(self.title)),
                 body=self._generate_body(full=True),
-            ),
+            )
-            status=self.status,
         )
 
     def minimal(self) -> HTTPResponse:
@@ -157,9 +158,7 @@ class TextRenderer(BaseRenderer):
                 text=self.text,
                 bar=("=" * len(self.title)),
                 body=self._generate_body(full=False),
-            ),
+            )
-            status=self.status,
-            headers=self.headers,
         )
 
     @property
@@ -218,11 +217,11 @@ class JSONRenderer(BaseRenderer):
 
     def full(self) -> HTTPResponse:
         output = self._generate_output(full=True)
-        return json(output, status=self.status, dumps=self.dumps)
+        return json(output, dumps=self.dumps)
 
     def minimal(self) -> HTTPResponse:
         output = self._generate_output(full=False)
-        return json(output, status=self.status, dumps=self.dumps)
+        return json(output, dumps=self.dumps)
 
     def _generate_output(self, *, full):
         output = {
@@ -313,7 +312,7 @@ def exception_response(
     debug: bool,
     fallback: str,
     base: t.Type[BaseRenderer],
-    renderer: t.Type[t.Optional[BaseRenderer]] = None,
+    renderer: t.Optional[t.Type[BaseRenderer]] = None,
 ) -> HTTPResponse:
     """
     Render a response for the default FALLBACK exception handler.

sanic/exceptions.py

@@ -1,5 +1,6 @@
-from asyncio import CancelledError
+from asyncio import CancelledError, Protocol
-from typing import Any, Dict, Optional, Union
+from os import PathLike
+from typing import Any, Dict, Optional, Sequence, Union
 
 from sanic.helpers import STATUS_CODES
 
@@ -9,51 +10,158 @@ class RequestCancelled(CancelledError):
 
 
 class ServerKilled(Exception):
-    ...
+    """
+    Exception Sanic server uses when killing a server process for something
+    unexpected happening.
+    """
 
 
 class SanicException(Exception):
+    """
+    Generic exception that will generate an HTTP response when raised
+    in the context of a request lifecycle.
+
+    Usually it is best practice to use one of the more specific exceptions
+    than this generic. Even when trying to raise a 500, it is generally
+    preferrable to use :class:`.ServerError`
+
+    .. code-block:: python
+
+        raise SanicException(
+            "Something went wrong",
+            status_code=999,
+            context={
+                "info": "Some additional details",
+            },
+            headers={
+                "X-Foo": "bar"
+            }
+        )
+
+    :param message: The message to be sent to the client. If ``None``
+        then the appropriate HTTP response status message will be used
+        instead, defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param status_code: The HTTP response code to send, if applicable. If
+        ``None``, then it will be 500, defaults to None
+    :type status_code: Optional[int], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
+    """
+
+    status_code: int = 500
+    quiet: Optional[bool] = False
+    headers: Dict[str, str] = {}
     message: str = ""
 
     def __init__(
         self,
         message: Optional[Union[str, bytes]] = None,
         status_code: Optional[int] = None,
+        *,
         quiet: Optional[bool] = None,
         context: Optional[Dict[str, Any]] = None,
         extra: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, Any]] = None,
     ) -> None:
         self.context = context
         self.extra = extra
+        status_code = status_code or getattr(
+            self.__class__, "status_code", None
+        )
+        quiet = quiet or getattr(self.__class__, "quiet", None)
+        headers = headers or getattr(self.__class__, "headers", {})
         if message is None:
             if self.message:
                 message = self.message
-            elif status_code is not None:
+            elif status_code:
                 msg: bytes = STATUS_CODES.get(status_code, b"")
                 message = msg.decode("utf8")
 
         super().__init__(message)
 
-        if status_code is not None:
+        self.status_code = status_code or self.status_code
-            self.status_code = status_code
+        self.quiet = quiet
-
+        self.headers = headers
-        # quiet=None/False/True with None meaning choose by status
-        if quiet or quiet is None and status_code not in (None, 500):
-            self.quiet = True
 
 
-class NotFound(SanicException):
+class HTTPException(SanicException):
+    """
+    A base class for other exceptions and should not be called directly.
+    """
+
+    def __init__(
+        self,
+        message: Optional[Union[str, bytes]] = None,
+        *,
+        quiet: Optional[bool] = None,
+        context: Optional[Dict[str, Any]] = None,
+        extra: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, Any]] = None,
+    ) -> None:
+        super().__init__(
+            message,
+            quiet=quiet,
+            context=context,
+            extra=extra,
+            headers=headers,
+        )
+
+
+class NotFound(HTTPException):
     """
     **Status**: 404 Not Found
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Not Found' will be sent, defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
     status_code = 404
     quiet = True
 
 
-class BadRequest(SanicException):
+class BadRequest(HTTPException):
     """
     **Status**: 400 Bad Request
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Bad Request' will be sent, defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
     status_code = 400
@@ -61,51 +169,133 @@ class BadRequest(SanicException):
 
 
 InvalidUsage = BadRequest
+BadURL = BadRequest
 
 
-class BadURL(BadRequest):
+class MethodNotAllowed(HTTPException):
-    ...
-
-
-class MethodNotAllowed(SanicException):
     """
     **Status**: 405 Method Not Allowed
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Method Not Allowed' will be sent,
+        defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param method: The HTTP method that was used, defaults to  an empty string
+    :type method: Optional[str], optional
+    :param allowed_methods: The HTTP methods that can be used instead of the
+        one that was attempted
+    :type allowed_methods: Optional[Sequence[str]], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
     status_code = 405
     quiet = True
 
-    def __init__(self, message, method, allowed_methods):
+    def __init__(
-        super().__init__(message)
+        self,
-        self.headers = {"Allow": ", ".join(allowed_methods)}
+        message: Optional[Union[str, bytes]] = None,
+        method: str = "",
+        allowed_methods: Optional[Sequence[str]] = None,
+        *,
+        quiet: Optional[bool] = None,
+        context: Optional[Dict[str, Any]] = None,
+        extra: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, Any]] = None,
+    ):
+        super().__init__(
+            message,
+            quiet=quiet,
+            context=context,
+            extra=extra,
+            headers=headers,
+        )
+        if allowed_methods:
+            self.headers = {
+                **self.headers,
+                "Allow": ", ".join(allowed_methods),
+            }
+        self.method = method
+        self.allowed_methods = allowed_methods
 
 
 MethodNotSupported = MethodNotAllowed
 
 
-class ServerError(SanicException):
+class ServerError(HTTPException):
     """
     **Status**: 500 Internal Server Error
+
+    A general server-side error has occurred. If no other HTTP exception is
+    appropriate, then this should be used
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Internal Server Error' will be sent,
+         defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
     status_code = 500
 
 
-class ServiceUnavailable(SanicException):
+InternalServerError = ServerError
+
+
+class ServiceUnavailable(HTTPException):
     """
     **Status**: 503 Service Unavailable
 
     The server is currently unavailable (because it is overloaded or
     down for maintenance). Generally, this is a temporary state.
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Bad Request' will be sent, defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
     status_code = 503
     quiet = True
 
 
-class URLBuildError(ServerError):
+class URLBuildError(HTTPException):
     """
     **Status**: 500 Internal Server Error
+
+    An exception used by Sanic internals when unable to build a URL.
     """
 
     status_code = 500
@@ -114,30 +304,77 @@ class URLBuildError(ServerError):
 class FileNotFound(NotFound):
     """
     **Status**: 404 Not Found
+
+    A specific form of :class:`.NotFound` that is specifically when looking
+    for a file on the file system at a known path.
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Not Found' will be sent, defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param path: The path, if any, to the file that could not
+        be found, defaults to None
+    :type path: Optional[PathLike], optional
+    :param relative_url: A relative URL of the file, defaults to None
+    :type relative_url: Optional[str], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
-    def __init__(self, message, path, relative_url):
+    def __init__(
-        super().__init__(message)
+        self,
+        message: Optional[Union[str, bytes]] = None,
+        path: Optional[PathLike] = None,
+        relative_url: Optional[str] = None,
+        *,
+        quiet: Optional[bool] = None,
+        context: Optional[Dict[str, Any]] = None,
+        extra: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, Any]] = None,
+    ):
+        super().__init__(
+            message,
+            quiet=quiet,
+            context=context,
+            extra=extra,
+            headers=headers,
+        )
         self.path = path
         self.relative_url = relative_url
 
 
-class RequestTimeout(SanicException):
+class RequestTimeout(HTTPException):
-    """The Web server (running the Web site) thinks that there has been too
+    """
+    The Web server (running the Web site) thinks that there has been too
     long an interval of time between 1) the establishment of an IP
     connection (socket) between the client and the server and
     2) the receipt of any data on that socket, so the server has dropped
     the connection. The socket connection has actually been lost - the Web
     server has 'timed out' on that particular socket connection.
+
+    This is an internal exception thrown by Sanic and should not be used
+    directly.
     """
 
     status_code = 408
     quiet = True
 
 
-class PayloadTooLarge(SanicException):
+class PayloadTooLarge(HTTPException):
     """
     **Status**: 413 Payload Too Large
+
+    This is an internal exception thrown by Sanic and should not be used
+    directly.
     """
 
     status_code = 413
@@ -147,34 +384,126 @@ class PayloadTooLarge(SanicException):
 class HeaderNotFound(BadRequest):
     """
     **Status**: 400 Bad Request
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Bad Request' will be sent, defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
 
 class InvalidHeader(BadRequest):
     """
     **Status**: 400 Bad Request
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Bad Request' will be sent, defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
 
-class RangeNotSatisfiable(SanicException):
+class ContentRange(Protocol):
+    total: int
+
+
+class RangeNotSatisfiable(HTTPException):
     """
     **Status**: 416 Range Not Satisfiable
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Range Not Satisfiable' will be sent,
+        defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param content_range: An object meeting the :class:`.ContentRange` protocol
+        that has a ``total`` property, defaults to None
+    :type content_range: Optional[ContentRange], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
     status_code = 416
     quiet = True
 
-    def __init__(self, message, content_range):
+    def __init__(
-        super().__init__(message)
+        self,
-        self.headers = {"Content-Range": f"bytes */{content_range.total}"}
+        message: Optional[Union[str, bytes]] = None,
+        content_range: Optional[ContentRange] = None,
+        *,
+        quiet: Optional[bool] = None,
+        context: Optional[Dict[str, Any]] = None,
+        extra: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, Any]] = None,
+    ):
+        super().__init__(
+            message,
+            quiet=quiet,
+            context=context,
+            extra=extra,
+            headers=headers,
+        )
+        if content_range is not None:
+            self.headers = {
+                **self.headers,
+                "Content-Range": f"bytes */{content_range.total}",
+            }
 
 
 ContentRangeError = RangeNotSatisfiable
 
 
-class ExpectationFailed(SanicException):
+class ExpectationFailed(HTTPException):
     """
     **Status**: 417 Expectation Failed
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Expectation Failed' will be sent,
+        defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
     status_code = 417
@@ -184,9 +513,25 @@ class ExpectationFailed(SanicException):
 HeaderExpectationFailed = ExpectationFailed
 
 
-class Forbidden(SanicException):
+class Forbidden(HTTPException):
     """
     **Status**: 403 Forbidden
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Forbidden' will be sent, defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
     status_code = 403
@@ -202,20 +547,33 @@ class InvalidRangeType(RangeNotSatisfiable):
     quiet = True
 
 
-class PyFileError(Exception):
+class PyFileError(SanicException):
-    def __init__(self, file):
+    def __init__(
-        super().__init__("could not execute config file %s", file)
+        self,
+        file,
+        status_code: Optional[int] = None,
+        *,
+        quiet: Optional[bool] = None,
+        context: Optional[Dict[str, Any]] = None,
+        extra: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, Any]] = None,
+    ):
+        super().__init__(
+            "could not execute config file %s" % file,
+            status_code=status_code,
+            quiet=quiet,
+            context=context,
+            extra=extra,
+            headers=headers,
+        )
 
 
-class Unauthorized(SanicException):
+class Unauthorized(HTTPException):
     """
     **Status**: 401 Unauthorized
 
-    :param message: Message describing the exception.
+    When present, additional keyword arguments may be used to complete
-    :param status_code: HTTP Status code.
+    the WWW-Authentication header.
-    :param scheme: Name of the authentication scheme to be used.
-
-    When present, kwargs is used to complete the WWW-Authentication header.
 
     Examples::
 
@@ -240,21 +598,58 @@ class Unauthorized(SanicException):
         raise Unauthorized("Auth required.",
                            scheme="Bearer",
                            realm="Restricted Area")
+
+    :param message: The message to be sent to the client. If ``None``
+        then the HTTP status 'Bad Request' will be sent, defaults to None
+    :type message: Optional[Union[str, bytes]], optional
+    :param scheme: Name of the authentication scheme to be used.
+    :type scheme: Optional[str], optional
+    :param quiet: When ``True``, the error traceback will be suppressed
+        from the logs, defaults to None
+    :type quiet: Optional[bool], optional
+    :param context: Additional mapping of key/value data that will be
+        sent to the client upon exception, defaults to None
+    :type context: Optional[Dict[str, Any]], optional
+    :param extra: Additional mapping of key/value data that will NOT be
+        sent to the client when in PRODUCTION mode, defaults to None
+    :type extra: Optional[Dict[str, Any]], optional
+    :param headers: Additional headers that should be sent with the HTTP
+        response, defaults to None
+    :type headers: Optional[Dict[str, Any]], optional
     """
 
     status_code = 401
     quiet = True
 
-    def __init__(self, message, status_code=None, scheme=None, **kwargs):
+    def __init__(
-        super().__init__(message, status_code)
+        self,
+        message: Optional[Union[str, bytes]] = None,
+        scheme: Optional[str] = None,
+        *,
+        quiet: Optional[bool] = None,
+        context: Optional[Dict[str, Any]] = None,
+        extra: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, Any]] = None,
+        **challenges,
+    ):
+        super().__init__(
+            message,
+            quiet=quiet,
+            context=context,
+            extra=extra,
+            headers=headers,
+        )
 
         # if auth-scheme is specified, set "WWW-Authenticate" header
         if scheme is not None:
-            values = ['{!s}="{!s}"'.format(k, v) for k, v in kwargs.items()]
+            values = [
+                '{!s}="{!s}"'.format(k, v) for k, v in challenges.items()
+            ]
             challenge = ", ".join(values)
 
             self.headers = {
-                "WWW-Authenticate": f"{scheme} {challenge}".rstrip()
+                **self.headers,
+                "WWW-Authenticate": f"{scheme} {challenge}".rstrip(),
             }
 
 

sanic/handlers/content_range.py

@@ -75,4 +75,4 @@ class ContentRangeHandler:
         }
 
     def __bool__(self):
-        return self.size > 0
+        return hasattr(self, "size") and self.size > 0

sanic/handlers/error.py

@@ -3,9 +3,12 @@ from __future__ import annotations
 from typing import Dict, List, Optional, Tuple, Type
 
 from sanic.errorpages import BaseRenderer, TextRenderer, exception_response
-from sanic.log import deprecation, error_logger
+from sanic.exceptions import ServerError
+from sanic.log import error_logger
 from sanic.models.handler_types import RouteHandler
+from sanic.request.types import Request
 from sanic.response import text
+from sanic.response.types import HTTPResponse
 
 
 class ErrorHandler:
@@ -43,16 +46,11 @@ class ErrorHandler:
             if name is None:
                 name = "__ALL_ROUTES__"
 
-            error_logger.warning(
+            message = (
                 f"Duplicate exception handler definition on: route={name} "
                 f"and exception={exc}"
             )
-            deprecation(
+            raise ServerError(message)
-                "A duplicate exception handler definition was discovered. "
-                "This may cause unintended consequences. A warning has been "
-                "issued now, but it will not be allowed starting in v23.3.",
-                23.3,
-            )
         self.cached_handlers[key] = handler
 
     def add(self, exception, handler, route_names: Optional[List[str]] = None):
@@ -152,7 +150,7 @@ class ErrorHandler:
                 return text("An error occurred while handling an error", 500)
         return response
 
-    def default(self, request, exception):
+    def default(self, request: Request, exception: Exception) -> HTTPResponse:
         """
         Provide a default behavior for the objects of :class:`ErrorHandler`.
         If a developer chooses to extent the :class:`ErrorHandler` they can

sanic/headers.py

@@ -436,7 +436,7 @@ def format_http1_response(status: int, headers: HeaderBytesIterable) -> bytes:
 
 def parse_credentials(
     header: Optional[str],
-    prefixes: Union[List, Tuple, Set] = None,
+    prefixes: Optional[Union[List, Tuple, Set]] = None,
 ) -> Tuple[Optional[str], Optional[str]]:
     """Parses any header with the aim to retrieve any credentials from it."""
     if not prefixes or not isinstance(prefixes, (list, tuple, set)):

sanic/helpers.py

@@ -1,5 +1,7 @@
 """Defines basics of HTTP standard."""
 
+import sys
+
 from importlib import import_module
 from inspect import ismodule
 from typing import Dict
@@ -157,6 +159,10 @@ def import_string(module_name, package=None):
     return obj()
 
 
+def is_atty() -> bool:
+    return bool(sys.stdout and sys.stdout.isatty())
+
+
 class Default:
     """
     It is used to replace `None` or `object()` as a sentinel

sanic/http/http1.py

@@ -240,9 +240,14 @@ class Http(Stream, metaclass=TouchUpMeta):
             headers_instance.getone("upgrade", "").lower() == "websocket"
         )
 
+        try:
+            url_bytes = self.url.encode("ASCII")
+        except UnicodeEncodeError:
+            raise BadRequest("URL may only contain US-ASCII characters.")
+
         # Prepare a Request object
         request = self.protocol.request_class(
-            url_bytes=self.url.encode(),
+            url_bytes=url_bytes,
             headers=headers_instance,
             head=bytes(head),
             version=protocol[5:],
@@ -428,7 +433,9 @@ class Http(Stream, metaclass=TouchUpMeta):
             if self.request is None:
                 self.create_empty_request()
 
-            request_middleware = not isinstance(exception, ServiceUnavailable)
+            request_middleware = not isinstance(
+                exception, (ServiceUnavailable, RequestCancelled)
+            )
             try:
                 await app.handle_exception(
                     self.request, exception, request_middleware
@@ -443,9 +450,18 @@ class Http(Stream, metaclass=TouchUpMeta):
         bogus response for error handling use.
         """
 
+        # Reformat any URL already received with \xHH escapes for better logs
+        url_bytes = (
+            self.url.encode(errors="surrogateescape")
+            .decode("ASCII", errors="backslashreplace")
+            .encode("ASCII")
+            if self.url
+            else b"*"
+        )
+
         # FIXME: Avoid this by refactoring error handling and response code
         self.request = self.protocol.request_class(
-            url_bytes=self.url.encode() if self.url else b"*",
+            url_bytes=url_bytes,
             headers=Header({}),
             version="1.1",
             method="NONE",

sanic/http/http3.py

@@ -18,7 +18,12 @@ from typing import (
 
 from sanic.compat import Header
 from sanic.constants import LocalCertCreator
-from sanic.exceptions import PayloadTooLarge, SanicException, ServerError
+from sanic.exceptions import (
+    BadRequest,
+    PayloadTooLarge,
+    SanicException,
+    ServerError,
+)
 from sanic.helpers import has_message_body
 from sanic.http.constants import Stage
 from sanic.http.stream import Stream
@@ -333,7 +338,17 @@ class Http3:
         return self.receivers[stream_id]
 
     def _make_request(self, event: HeadersReceived) -> Request:
-        headers = Header(((k.decode(), v.decode()) for k, v in event.headers))
+        try:
+            headers = Header(
+                (
+                    (k.decode("ASCII"), v.decode(errors="surrogateescape"))
+                    for k, v in event.headers
+                )
+            )
+        except UnicodeDecodeError:
+            raise BadRequest(
+                "Header names may only contain US-ASCII characters."
+            )
         method = headers[":method"]
         path = headers[":path"]
         scheme = headers.pop(":scheme", "")
@@ -342,9 +357,14 @@ class Http3:
         if authority:
             headers["host"] = authority
 
+        try:
+            url_bytes = path.encode("ASCII")
+        except UnicodeEncodeError:
+            raise BadRequest("URL may only contain US-ASCII characters.")
+
         transport = HTTP3Transport(self.protocol)
         request = self.protocol.request_class(
-            path.encode(),
+            url_bytes,
             headers,
             "3",
             method,

sanic/http/tls/context.py

@@ -159,7 +159,7 @@ class CertSimple(SanicSSLContext):
         # try common aliases, rename to cert/key
         certfile = kw["cert"] = kw.pop("certificate", None) or cert
         keyfile = kw["key"] = kw.pop("keyfile", None) or key
-        password = kw.pop("password", None)
+        password = kw.get("password", None)
         if not certfile or not keyfile:
             raise ValueError("SSL dict needs filenames for cert and key.")
         subject = {}

sanic/log.py

@@ -5,7 +5,7 @@ from enum import Enum
 from typing import TYPE_CHECKING, Any, Dict
 from warnings import warn
 
-from sanic.compat import is_atty
+from sanic.helpers import is_atty
 
 
 # Python 3.11 changed the way Enum formatting works for mixed-in types.
@@ -62,13 +62,13 @@ LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict(  # no cov
     },
     formatters={
         "generic": {
-            "format": "%(asctime)s [%(process)d] [%(levelname)s] %(message)s",
+            "format": "%(asctime)s [%(process)s] [%(levelname)s] %(message)s",
             "datefmt": "[%Y-%m-%d %H:%M:%S %z]",
             "class": "logging.Formatter",
         },
         "access": {
             "format": "%(asctime)s - (%(name)s)[%(levelname)s][%(host)s]: "
-            + "%(request)s %(message)s %(status)d %(byte)d",
+            + "%(request)s %(message)s %(status)s %(byte)s",
             "datefmt": "[%Y-%m-%d %H:%M:%S %z]",
             "class": "logging.Formatter",
         },
@@ -126,7 +126,26 @@ logger.addFilter(_verbosity_filter)
 
 
 def deprecation(message: str, version: float):  # no cov
-    version_info = f"[DEPRECATION v{version}] "
+    """
+    Add a deprecation notice
+
+    Example when a feature is being removed. In this case, version
+    should be AT LEAST next version + 2
+
+        deprecation("Helpful message", 99.9)
+
+    Example when a feature is deprecated but not being removed:
+
+        deprecation("Helpful message", 0)
+
+    :param message: The message of the notice
+    :type message: str
+    :param version: The version when the feature will be removed. If it is
+      not being removed, then set version=0.
+    :type version: float
+    """
+    version_display = f" v{version}" if version else ""
+    version_info = f"[DEPRECATION{version_display}] "
     if is_atty():
         version_info = f"{Colors.RED}{version_info}"
         message = f"{Colors.YELLOW}{message}{Colors.END}"

sanic/mixins/exceptions.py

@@ -38,3 +38,15 @@ class ExceptionMixin(metaclass=SanicMeta):
             return handler
 
         return decorator
+
+    def all_exceptions(self, handler):
+        """
+        This method enables the process of creating a global exception
+        handler for the current blueprint under question.
+
+        :param handler: A coroutine function to handle exceptions
+
+        :return a decorated method to handle global exceptions for any
+            route registered under this blueprint.
+        """
+        return self.exception(Exception)(handler)

sanic/mixins/routes.py

@@ -159,7 +159,11 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
                 error_format,
                 route_context,
             )
-
+            overwrite = getattr(self, "_allow_route_overwrite", False)
+            if overwrite:
+                self._future_routes = set(
+                    filter(lambda x: x.uri != uri, self._future_routes)
+                )
             self._future_routes.add(route)
 
             args = list(signature(handler).parameters.keys())
@@ -182,7 +186,7 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
                 handler.is_stream = stream
 
             if apply:
-                self._apply_route(route)
+                self._apply_route(route, overwrite=overwrite)
 
             if static:
                 return route, handler
@@ -546,7 +550,7 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
         strict_slashes: Optional[bool] = None,
         version: Optional[Union[int, str, float]] = None,
         name: Optional[str] = None,
-        ignore_body: bool = True,
+        ignore_body: bool = False,
         version_prefix: str = "/v",
         error_format: Optional[str] = None,
         **ctx_kwargs: Any,

sanic/mixins/signals.py

@@ -4,7 +4,7 @@ from typing import Any, Callable, Dict, Optional, Set, Union
 from sanic.base.meta import SanicMeta
 from sanic.models.futures import FutureSignal
 from sanic.models.handler_types import SignalHandler
-from sanic.signals import Signal
+from sanic.signals import Event, Signal
 from sanic.types import HashableDict
 
 
@@ -80,3 +80,9 @@ class SignalMixin(metaclass=SanicMeta):
 
     def event(self, event: str):
         raise NotImplementedError
+
+    def catch_exception(self, handler):
+        async def signal_handler(exception: Exception):
+            await handler(self, exception)
+
+        self.signal(Event.SERVER_LIFECYCLE_EXCEPTION)(signal_handler)

sanic/mixins/startup.py

@@ -16,7 +16,13 @@ from asyncio import (
 from contextlib import suppress
 from functools import partial
 from importlib import import_module
-from multiprocessing import Manager, Pipe, get_context
+from multiprocessing import (
+    Manager,
+    Pipe,
+    get_context,
+    get_start_method,
+    set_start_method,
+)
 from multiprocessing.context import BaseContext
 from pathlib import Path
 from socket import SHUT_RDWR, socket
@@ -25,6 +31,7 @@ from typing import (
     TYPE_CHECKING,
     Any,
     Callable,
+    ClassVar,
     Dict,
     List,
     Mapping,
@@ -41,23 +48,22 @@ from sanic.application.logo import get_logo
 from sanic.application.motd import MOTD
 from sanic.application.state import ApplicationServerInfo, Mode, ServerStage
 from sanic.base.meta import SanicMeta
-from sanic.compat import OS_IS_WINDOWS, StartMethod, is_atty
+from sanic.compat import OS_IS_WINDOWS, StartMethod
 from sanic.exceptions import ServerKilled
-from sanic.helpers import Default, _default
+from sanic.helpers import Default, _default, is_atty
 from sanic.http.constants import HTTP
 from sanic.http.tls import get_ssl_context, process_to_context
 from sanic.http.tls.context import SanicSSLContext
-from sanic.log import Colors, deprecation, error_logger, logger
+from sanic.log import Colors, error_logger, logger
 from sanic.models.handler_types import ListenerType
 from sanic.server import Signal as ServerSignal
 from sanic.server import try_use_uvloop
 from sanic.server.async_server import AsyncioServer
 from sanic.server.events import trigger_events
-from sanic.server.legacy import watchdog
 from sanic.server.loop import try_windows_loop
 from sanic.server.protocols.http_protocol import HttpProtocol
 from sanic.server.protocols.websocket_protocol import WebSocketProtocol
-from sanic.server.runners import serve, serve_multiple, serve_single
+from sanic.server.runners import serve
 from sanic.server.socket import configure_socket, remove_unix_socket
 from sanic.worker.loader import AppLoader
 from sanic.worker.manager import WorkerManager
@@ -82,13 +88,17 @@ else:  # no cov
 
 
 class StartupMixin(metaclass=SanicMeta):
-    _app_registry: Dict[str, Sanic]
+    _app_registry: ClassVar[Dict[str, Sanic]]
+
     config: Config
     listeners: Dict[str, List[ListenerType[Any]]]
     state: ApplicationState
     websocket_enabled: bool
     multiplexer: WorkerMultiplexer
-    start_method: StartMethod = _default
+
+    test_mode: ClassVar[bool]
+    start_method: ClassVar[StartMethod] = _default
+    START_METHOD_SET: ClassVar[bool] = False
 
     def setup_loop(self):
         if not self.asgi:
@@ -135,7 +145,6 @@ class StartupMixin(metaclass=SanicMeta):
         motd_display: Optional[Dict[str, str]] = None,
         auto_tls: bool = False,
         single_process: bool = False,
-        legacy: bool = False,
     ) -> None:
         """
         Run the HTTP Server and listen until keyboard interrupt or term
@@ -197,13 +206,10 @@ class StartupMixin(metaclass=SanicMeta):
             motd_display=motd_display,
             auto_tls=auto_tls,
             single_process=single_process,
-            legacy=legacy,
         )
 
         if single_process:
             serve = self.__class__.serve_single
-        elif legacy:
-            serve = self.__class__.serve_legacy
         else:
             serve = self.__class__.serve
         serve(primary=self)  # type: ignore
@@ -235,7 +241,6 @@ class StartupMixin(metaclass=SanicMeta):
         coffee: bool = False,
         auto_tls: bool = False,
         single_process: bool = False,
-        legacy: bool = False,
     ) -> None:
         if version == 3 and self.state.server_info:
             raise RuntimeError(
@@ -264,13 +269,10 @@ class StartupMixin(metaclass=SanicMeta):
                 "or auto-reload"
             )
 
-        if single_process and legacy:
+        if register_sys_signals is False and not single_process:
-            raise RuntimeError("Cannot run single process and legacy mode")
-
-        if register_sys_signals is False and not (single_process or legacy):
             raise RuntimeError(
                 "Cannot run Sanic.serve with register_sys_signals=False. "
-                "Use either Sanic.serve_single or Sanic.serve_legacy."
+                "Use Sanic.serve_single."
             )
 
         if motd_display:
@@ -700,11 +702,26 @@ class StartupMixin(metaclass=SanicMeta):
             else "spawn"
         )
 
+    @classmethod
+    def _set_startup_method(cls) -> None:
+        if cls.START_METHOD_SET and not cls.test_mode:
+            return
+
+        method = cls._get_startup_method()
+        set_start_method(method, force=cls.test_mode)
+        cls.START_METHOD_SET = True
+
     @classmethod
     def _get_context(cls) -> BaseContext:
         method = cls._get_startup_method()
         logger.debug("Creating multiprocessing context using '%s'", method)
-        return get_context(method)
+        actual = get_start_method()
+        if method != actual:
+            raise RuntimeError(
+                f"Start method '{method}' was requested, but '{actual}' "
+                "was actually set."
+            )
+        return get_context()
 
     @classmethod
     def serve(
@@ -714,6 +731,7 @@ class StartupMixin(metaclass=SanicMeta):
         app_loader: Optional[AppLoader] = None,
         factory: Optional[Callable[[], Sanic]] = None,
     ) -> None:
+        cls._set_startup_method()
         os.environ["SANIC_MOTD_OUTPUT"] = "true"
         apps = list(cls._app_registry.values())
         if factory:
@@ -811,7 +829,7 @@ class StartupMixin(metaclass=SanicMeta):
             ssl = kwargs.get("ssl")
 
             if isinstance(ssl, SanicSSLContext):
-                kwargs["ssl"] = kwargs["ssl"].sanic
+                kwargs["ssl"] = ssl.sanic
 
             manager = WorkerManager(
                 primary.state.workers,
@@ -956,76 +974,6 @@ class StartupMixin(metaclass=SanicMeta):
             cls._cleanup_env_vars()
             cls._cleanup_apps()
 
-    @classmethod
-    def serve_legacy(cls, primary: Optional[Sanic] = None) -> None:
-        apps = list(cls._app_registry.values())
-
-        if not primary:
-            try:
-                primary = apps[0]
-            except IndexError:
-                raise RuntimeError("Did not find any applications.")
-
-        reloader_start = primary.listeners.get("reload_process_start")
-        reloader_stop = primary.listeners.get("reload_process_stop")
-        # We want to run auto_reload if ANY of the applications have it enabled
-        if (
-            cls.should_auto_reload()
-            and os.environ.get("SANIC_SERVER_RUNNING") != "true"
-        ):  # no cov
-            loop = new_event_loop()
-            trigger_events(reloader_start, loop, primary)
-            reload_dirs: Set[Path] = primary.state.reload_dirs.union(
-                *(app.state.reload_dirs for app in apps)
-            )
-            watchdog(1.0, reload_dirs)
-            trigger_events(reloader_stop, loop, primary)
-            return
-
-        # This exists primarily for unit testing
-        if not primary.state.server_info:  # no cov
-            for app in apps:
-                app.state.server_info.clear()
-            return
-
-        primary_server_info = primary.state.server_info[0]
-        primary.before_server_start(partial(primary._start_servers, apps=apps))
-
-        deprecation(
-            f"{Colors.YELLOW}Running {Colors.SANIC}Sanic {Colors.YELLOW}w/ "
-            f"LEGACY manager.{Colors.END} Support for will be dropped in "
-            "version 23.3.",
-            23.3,
-        )
-        try:
-            primary_server_info.stage = ServerStage.SERVING
-
-            if primary.state.workers > 1 and os.name != "posix":  # no cov
-                logger.warning(
-                    f"Multiprocessing is currently not supported on {os.name},"
-                    " using workers=1 instead"
-                )
-                primary.state.workers = 1
-            if primary.state.workers == 1:
-                serve_single(primary_server_info.settings)
-            elif primary.state.workers == 0:
-                raise RuntimeError("Cannot serve with no workers")
-            else:
-                serve_multiple(
-                    primary_server_info.settings, primary.state.workers
-                )
-        except BaseException:
-            error_logger.exception(
-                "Experienced exception while trying to serve"
-            )
-            raise
-        finally:
-            primary_server_info.stage = ServerStage.STOPPED
-        logger.info("Server Stopped")
-
-        cls._cleanup_env_vars()
-        cls._cleanup_apps()
-
     async def _start_servers(
         self,
         primary: Sanic,

sanic/mixins/static.py

@@ -3,7 +3,7 @@ from functools import partial, wraps
 from mimetypes import guess_type
 from os import PathLike, path
 from pathlib import Path, PurePath
-from typing import Optional, Sequence, Set, Union, cast
+from typing import Optional, Sequence, Set, Union
 from urllib.parse import unquote
 
 from sanic_routing.route import Route
@@ -14,7 +14,7 @@ from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE
 from sanic.exceptions import FileNotFound, HeaderNotFound, RangeNotSatisfiable
 from sanic.handlers import ContentRangeHandler
 from sanic.handlers.directory import DirectoryHandler
-from sanic.log import deprecation, error_logger
+from sanic.log import error_logger
 from sanic.mixins.base import BaseMixin
 from sanic.models.futures import FutureStatic
 from sanic.request import Request
@@ -31,7 +31,7 @@ class StaticMixin(BaseMixin, metaclass=SanicMeta):
     def static(
         self,
         uri: str,
-        file_or_directory: Union[PathLike, str, bytes],
+        file_or_directory: Union[PathLike, str],
         pattern: str = r"/?.+",
         use_modified_since: bool = True,
         use_content_range: bool = False,
@@ -94,14 +94,12 @@ class StaticMixin(BaseMixin, metaclass=SanicMeta):
                 f"Static route must be a valid path, not {file_or_directory}"
             )
 
-        if isinstance(file_or_directory, bytes):
+        try:
-            deprecation(
+            file_or_directory = Path(file_or_directory).resolve()
-                "Serving a static directory with a bytes string is "
+        except TypeError:
-                "deprecated and will be removed in v22.9.",
+            raise TypeError(
-                22.9,
+                "Static file or directory must be a path-like object or string"
             )
-            file_or_directory = cast(str, file_or_directory.decode())
-        file_or_directory = Path(file_or_directory)
 
         if directory_handler and (directory_view or index):
             raise ValueError(

sanic/models/asgi.py

@@ -1,5 +1,4 @@
 import asyncio
-import sys
 
 from typing import Any, Awaitable, Callable, MutableMapping, Optional, Union
 
@@ -16,20 +15,10 @@ ASGIReceive = Callable[[], Awaitable[ASGIMessage]]
 
 class MockProtocol:  # no cov
     def __init__(self, transport: "MockTransport", loop):
-        # This should be refactored when < 3.8 support is dropped
         self.transport = transport
-        # Fixup for 3.8+; Sanic still supports 3.7 where loop is required
+        self._not_paused = asyncio.Event()
-        loop = loop if sys.version_info[:2] < (3, 8) else None
+        self._not_paused.set()
-        # Optional in 3.9, necessary in 3.10 because the parameter "loop"
+        self._complete = asyncio.Event()
-        # was completely removed
-        if not loop:
-            self._not_paused = asyncio.Event()
-            self._not_paused.set()
-            self._complete = asyncio.Event()
-        else:
-            self._not_paused = asyncio.Event(loop=loop)
-            self._not_paused.set()
-            self._complete = asyncio.Event(loop=loop)
 
     def pause_writing(self) -> None:
         self._not_paused.clear()

sanic/models/handler_types.py

@@ -3,11 +3,12 @@ from typing import Any, Callable, Coroutine, Optional, TypeVar, Union
 
 import sanic
 
-from sanic.request import Request
+from sanic import request
 from sanic.response import BaseHTTPResponse, HTTPResponse
 
 
 Sanic = TypeVar("Sanic", bound="sanic.Sanic")
+Request = TypeVar("Request", bound="request.Request")
 
 MiddlewareResponse = Union[
     Optional[HTTPResponse], Coroutine[Any, Any, Optional[HTTPResponse]]

sanic/request.py

@@ -1,6 +0,0 @@
-from sanic.breaking import (
-    File,
-    Request,
-    RequestParameters,
-    parse_multipart_form,
-)

sanic/request/__init__.py

@@ -0,0 +1,11 @@
+from .form import File, parse_multipart_form
+from .parameters import RequestParameters
+from .types import Request
+
+
+__all__ = (
+    "File",
+    "parse_multipart_form",
+    "Request",
+    "RequestParameters",
+)

sanic/request/form.py

@@ -0,0 +1,110 @@
+from __future__ import annotations
+
+import email.utils
+import unicodedata
+
+from typing import NamedTuple
+from urllib.parse import unquote
+
+from sanic.headers import parse_content_header
+from sanic.log import logger
+
+from .parameters import RequestParameters
+
+
+class File(NamedTuple):
+    """
+    Model for defining a file. It is a ``namedtuple``, therefore you can
+    iterate over the object, or access the parameters by name.
+
+    :param type: The mimetype, defaults to text/plain
+    :param body: Bytes of the file
+    :param name: The filename
+    """
+
+    type: str
+    body: bytes
+    name: str
+
+
+def parse_multipart_form(body, boundary):
+    """
+    Parse a request body and returns fields and files
+
+    :param body: bytes request body
+    :param boundary: bytes multipart boundary
+    :return: fields (RequestParameters), files (RequestParameters)
+    """
+    files = {}
+    fields = {}
+
+    form_parts = body.split(boundary)
+    for form_part in form_parts[1:-1]:
+        file_name = None
+        content_type = "text/plain"
+        content_charset = "utf-8"
+        field_name = None
+        line_index = 2
+        line_end_index = 0
+        while not line_end_index == -1:
+            line_end_index = form_part.find(b"\r\n", line_index)
+            form_line = form_part[line_index:line_end_index].decode("utf-8")
+            line_index = line_end_index + 2
+
+            if not form_line:
+                break
+
+            colon_index = form_line.index(":")
+            idx = colon_index + 2
+            form_header_field = form_line[0:colon_index].lower()
+            form_header_value, form_parameters = parse_content_header(
+                form_line[idx:]
+            )
+
+            if form_header_field == "content-disposition":
+                field_name = form_parameters.get("name")
+                file_name = form_parameters.get("filename")
+
+                # non-ASCII filenames in RFC2231, "filename*" format
+                if file_name is None and form_parameters.get("filename*"):
+                    encoding, _, value = email.utils.decode_rfc2231(
+                        form_parameters["filename*"]
+                    )
+                    file_name = unquote(value, encoding=encoding)
+
+                # Normalize to NFC (Apple MacOS/iOS send NFD)
+                # Notes:
+                # - No effect for Windows, Linux or Android clients which
+                #   already send NFC
+                # - Python open() is tricky (creates files in NFC no matter
+                #   which form you use)
+                if file_name is not None:
+                    file_name = unicodedata.normalize("NFC", file_name)
+
+            elif form_header_field == "content-type":
+                content_type = form_header_value
+                content_charset = form_parameters.get("charset", "utf-8")
+
+        if field_name:
+            post_data = form_part[line_index:-4]
+            if file_name is None:
+                value = post_data.decode(content_charset)
+                if field_name in fields:
+                    fields[field_name].append(value)
+                else:
+                    fields[field_name] = [value]
+            else:
+                form_file = File(
+                    type=content_type, name=file_name, body=post_data
+                )
+                if field_name in files:
+                    files[field_name].append(form_file)
+                else:
+                    files[field_name] = [form_file]
+        else:
+            logger.debug(
+                "Form-data field does not have a 'name' parameter "
+                "in the Content-Disposition header"
+            )
+
+    return RequestParameters(fields), RequestParameters(files)

sanic/request/parameters.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from typing import Any, Optional
+
+
+class RequestParameters(dict):
+    """
+    Hosts a dict with lists as values where get returns the first
+    value of the list and getlist returns the whole shebang
+    """
+
+    def get(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
+        """Return the first value, either the default or actual"""
+        return super().get(name, [default])[0]
+
+    def getlist(
+        self, name: str, default: Optional[Any] = None
+    ) -> Optional[Any]:
+        """
+        Return the entire list
+        """
+        return super().get(name, default)

sanic/request/types.py

@@ -2,36 +2,38 @@ from __future__ import annotations
 
 from contextvars import ContextVar
 from inspect import isawaitable
+from types import SimpleNamespace
 from typing import (
     TYPE_CHECKING,
     Any,
     DefaultDict,
     Dict,
+    Generic,
     List,
-    NamedTuple,
     Optional,
     Tuple,
     Union,
+    cast,
 )
 
 from sanic_routing.route import Route
+from typing_extensions import TypeVar
 
 from sanic.http.constants import HTTP  # type: ignore
 from sanic.http.stream import Stream
 from sanic.models.asgi import ASGIScope
 from sanic.models.http_types import Credentials
 
-if TYPE_CHECKING:
-    from sanic.server import ConnInfo
-    from sanic.app import Sanic
 
-import email.utils
+if TYPE_CHECKING:
-import unicodedata
+    from sanic.app import Sanic
+    from sanic.config import Config
+    from sanic.server import ConnInfo
+
 import uuid
+
 from collections import defaultdict
-from http.cookies import SimpleCookie
+from urllib.parse import parse_qs, parse_qsl, urlunparse
-from types import SimpleNamespace
-from urllib.parse import parse_qs, parse_qsl, unquote, urlunparse
 
 from httptools import parse_url
 from httptools.parser.errors import HttpParserInvalidURLError
@@ -43,6 +45,7 @@ from sanic.constants import (
     IDEMPOTENT_HTTP_METHODS,
     SAFE_HTTP_METHODS,
 )
+from sanic.cookies.request import CookieRequestParameters, parse_cookie
 from sanic.exceptions import BadRequest, BadURL, ServerError
 from sanic.headers import (
     AcceptList,
@@ -55,36 +58,34 @@ from sanic.headers import (
     parse_xforwarded,
 )
 from sanic.http import Stage
-from sanic.log import deprecation, error_logger, logger
+from sanic.log import error_logger
 from sanic.models.protocol_types import TransportProtocol
 from sanic.response import BaseHTTPResponse, HTTPResponse
 
+from .form import parse_multipart_form
+from .parameters import RequestParameters
+
+
 try:
     from ujson import loads as json_loads  # type: ignore
 except ImportError:
     from json import loads as json_loads  # type: ignore
 
-
+if TYPE_CHECKING:
-class RequestParameters(dict):
+    # The default argument of TypeVar is proposed to be added in Python 3.13
-    """
+    # by PEP 696 (https://www.python.org/dev/peps/pep-0696/).
-    Hosts a dict with lists as values where get returns the first
+    # Therefore, we use typing_extensions.TypeVar for compatibility.
-    value of the list and getlist returns the whole shebang
+    # For more information, see:
-    """
+    # https://discuss.python.org/t/pep-696-type-defaults-for-typevarlikes
-
+    sanic_type = TypeVar(
-    def get(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
+        "sanic_type", bound=Sanic, default=Sanic[Config, SimpleNamespace]
-        """Return the first value, either the default or actual"""
+    )
-        return super().get(name, [default])[0]
+else:
-
+    sanic_type = TypeVar("sanic_type")
-    def getlist(
+ctx_type = TypeVar("ctx_type")
-        self, name: str, default: Optional[Any] = None
-    ) -> Optional[Any]:
-        """
-        Return the entire list
-        """
-        return super().get(name, default)
 
 
-class Request:
+class Request(Generic[sanic_type, ctx_type]):
     """
     Properties of an HTTP request such as URL, headers, etc.
     """
@@ -95,6 +96,7 @@ class Request:
     __slots__ = (
         "__weakref__",
         "_cookies",
+        "_ctx",
         "_id",
         "_ip",
         "_parsed_url",
@@ -111,12 +113,12 @@ class Request:
         "app",
         "body",
         "conn_info",
-        "ctx",
         "head",
         "headers",
         "method",
         "parsed_accept",
         "parsed_args",
+        "parsed_cookies",
         "parsed_credentials",
         "parsed_files",
         "parsed_form",
@@ -139,7 +141,7 @@ class Request:
         version: str,
         method: str,
         transport: TransportProtocol,
-        app: Sanic,
+        app: sanic_type,
         head: bytes = b"",
         stream_id: int = 0,
     ):
@@ -147,7 +149,8 @@ class Request:
         try:
             self._parsed_url = parse_url(url_bytes)
         except HttpParserInvalidURLError:
-            raise BadURL(f"Bad URL: {url_bytes.decode()}")
+            url = url_bytes.decode(errors="backslashreplace")
+            raise BadURL(f"Bad URL: {url}")
         self._id: Optional[Union[uuid.UUID, str, int]] = None
         self._name: Optional[str] = None
         self._stream_id = stream_id
@@ -162,26 +165,26 @@ class Request:
         # Init but do not inhale
         self.body = b""
         self.conn_info: Optional[ConnInfo] = None
-        self.ctx = SimpleNamespace()
+        self._ctx: Optional[ctx_type] = None
-        self.parsed_forwarded: Optional[Options] = None
         self.parsed_accept: Optional[AcceptList] = None
-        self.parsed_credentials: Optional[Credentials] = None
-        self.parsed_json = None
-        self.parsed_form: Optional[RequestParameters] = None
-        self.parsed_files: Optional[RequestParameters] = None
-        self.parsed_token: Optional[str] = None
         self.parsed_args: DefaultDict[
             Tuple[bool, bool, str, str], RequestParameters
         ] = defaultdict(RequestParameters)
+        self.parsed_cookies: Optional[RequestParameters] = None
+        self.parsed_credentials: Optional[Credentials] = None
+        self.parsed_files: Optional[RequestParameters] = None
+        self.parsed_form: Optional[RequestParameters] = None
+        self.parsed_forwarded: Optional[Options] = None
+        self.parsed_json = None
         self.parsed_not_grouped_args: DefaultDict[
             Tuple[bool, bool, str, str], List[Tuple[str, str]]
         ] = defaultdict(list)
+        self.parsed_token: Optional[str] = None
         self._request_middleware_started = False
         self._response_middleware_started = False
         self.responded: bool = False
         self.route: Optional[Route] = None
         self.stream: Optional[Stream] = None
-        self._cookies: Optional[Dict[str, str]] = None
         self._match_info: Dict[str, Any] = {}
         self._protocol = None
 
@@ -189,6 +192,10 @@ class Request:
         class_name = self.__class__.__name__
         return f"<{class_name}: {self.method} {self.path}>"
 
+    @staticmethod
+    def make_context() -> ctx_type:
+        return cast(ctx_type, SimpleNamespace())
+
     @classmethod
     def get_current(cls) -> Request:
         """
@@ -219,14 +226,13 @@ class Request:
         return uuid.uuid4()
 
     @property
-    def request_middleware_started(self):
+    def ctx(self) -> ctx_type:
-        deprecation(
+        """
-            "Request.request_middleware_started has been deprecated and will"
+        :return: The current request context
-            "be removed. You should set a flag on the request context using"
+        """
-            "either middleware or signals if you need this feature.",
+        if not self._ctx:
-            23.3,
+            self._ctx = self.make_context()
-        )
+        return self._ctx
-        return self._request_middleware_started
 
     @property
     def stream_id(self):
@@ -728,24 +734,21 @@ class Request:
     default values.
     """
 
+    def get_cookies(self) -> RequestParameters:
+        cookie = self.headers.getone("cookie", "")
+        self.parsed_cookies = CookieRequestParameters(parse_cookie(cookie))
+        return self.parsed_cookies
+
     @property
-    def cookies(self) -> Dict[str, str]:
+    def cookies(self) -> RequestParameters:
         """
         :return: Incoming cookies on the request
         :rtype: Dict[str, str]
         """
 
-        if self._cookies is None:
+        if self.parsed_cookies is None:
-            cookie = self.headers.getone("cookie", None)
+            self.get_cookies()
-            if cookie is not None:
+        return cast(CookieRequestParameters, self.parsed_cookies)
-                cookies: SimpleCookie = SimpleCookie()
-                cookies.load(cookie)
-                self._cookies = {
-                    name: cookie.value for name, cookie in cookies.items()
-                }
-            else:
-                self._cookies = {}
-        return self._cookies
 
     @property
     def content_type(self) -> str:
@@ -835,19 +838,31 @@ class Request:
     @property
     def remote_addr(self) -> str:
         """
-        Client IP address, if available.
+        Client IP address, if available from proxy.
-        1. proxied remote address `self.forwarded['for']`
-        2. local remote address `self.ip`
 
         :return: IPv4, bracketed IPv6, UNIX socket name or arbitrary string
         :rtype: str
         """
         if not hasattr(self, "_remote_addr"):
-            self._remote_addr = str(
+            self._remote_addr = str(self.forwarded.get("for", ""))
-                self.forwarded.get("for", "")
-            )  # or self.ip
         return self._remote_addr
 
+    @property
+    def client_ip(self) -> str:
+        """
+        Client IP address.
+        1. proxied remote address `self.forwarded['for']`
+        2. local peer address `self.ip`
+
+        New in Sanic 23.6. Prefer this over `remote_addr` for determining the
+        client address regardless of whether the service runs behind a proxy
+        or not (proxy deployment needs separate configuration).
+
+        :return: IPv4, bracketed IPv6, UNIX socket name or arbitrary string
+        :rtype: str
+        """
+        return self.remote_addr or self.ip
+
     @property
     def scheme(self) -> str:
         """
@@ -1023,101 +1038,3 @@ class Request:
         :rtype: bool
         """
         return self.method in CACHEABLE_HTTP_METHODS
-
-
-class File(NamedTuple):
-    """
-    Model for defining a file. It is a ``namedtuple``, therefore you can
-    iterate over the object, or access the parameters by name.
-
-    :param type: The mimetype, defaults to text/plain
-    :param body: Bytes of the file
-    :param name: The filename
-    """
-
-    type: str
-    body: bytes
-    name: str
-
-
-def parse_multipart_form(body, boundary):
-    """
-    Parse a request body and returns fields and files
-
-    :param body: bytes request body
-    :param boundary: bytes multipart boundary
-    :return: fields (RequestParameters), files (RequestParameters)
-    """
-    files = RequestParameters()
-    fields = RequestParameters()
-
-    form_parts = body.split(boundary)
-    for form_part in form_parts[1:-1]:
-        file_name = None
-        content_type = "text/plain"
-        content_charset = "utf-8"
-        field_name = None
-        line_index = 2
-        line_end_index = 0
-        while not line_end_index == -1:
-            line_end_index = form_part.find(b"\r\n", line_index)
-            form_line = form_part[line_index:line_end_index].decode("utf-8")
-            line_index = line_end_index + 2
-
-            if not form_line:
-                break
-
-            colon_index = form_line.index(":")
-            idx = colon_index + 2
-            form_header_field = form_line[0:colon_index].lower()
-            form_header_value, form_parameters = parse_content_header(
-                form_line[idx:]
-            )
-
-            if form_header_field == "content-disposition":
-                field_name = form_parameters.get("name")
-                file_name = form_parameters.get("filename")
-
-                # non-ASCII filenames in RFC2231, "filename*" format
-                if file_name is None and form_parameters.get("filename*"):
-                    encoding, _, value = email.utils.decode_rfc2231(
-                        form_parameters["filename*"]
-                    )
-                    file_name = unquote(value, encoding=encoding)
-
-                # Normalize to NFC (Apple MacOS/iOS send NFD)
-                # Notes:
-                # - No effect for Windows, Linux or Android clients which
-                #   already send NFC
-                # - Python open() is tricky (creates files in NFC no matter
-                #   which form you use)
-                if file_name is not None:
-                    file_name = unicodedata.normalize("NFC", file_name)
-
-            elif form_header_field == "content-type":
-                content_type = form_header_value
-                content_charset = form_parameters.get("charset", "utf-8")
-
-        if field_name:
-            post_data = form_part[line_index:-4]
-            if file_name is None:
-                value = post_data.decode(content_charset)
-                if field_name in fields:
-                    fields[field_name].append(value)
-                else:
-                    fields[field_name] = [value]
-            else:
-                form_file = File(
-                    type=content_type, name=file_name, body=post_data
-                )
-                if field_name in files:
-                    files[field_name].append(form_file)
-                else:
-                    files[field_name] = [form_file]
-        else:
-            logger.debug(
-                "Form-data field does not have a 'name' parameter "
-                "in the Content-Disposition header"
-            )
-
-    return fields, files

sanic/response/convenience.py

@@ -148,7 +148,26 @@ async def validate_file(
         last_modified = datetime.fromtimestamp(
             float(last_modified), tz=timezone.utc
         ).replace(microsecond=0)
-    if last_modified <= if_modified_since:
+
+    if (
+        last_modified.utcoffset() is None
+        and if_modified_since.utcoffset() is not None
+    ):
+        logger.warning(
+            "Cannot compare tz-aware and tz-naive datetimes. To avoid "
+            "this conflict Sanic is converting last_modified to UTC."
+        )
+        last_modified.replace(tzinfo=timezone.utc)
+    elif (
+        last_modified.utcoffset() is not None
+        and if_modified_since.utcoffset() is None
+    ):
+        logger.warning(
+            "Cannot compare tz-aware and tz-naive datetimes. To avoid "
+            "this conflict Sanic is converting if_modified_since to UTC."
+        )
+        if_modified_since.replace(tzinfo=timezone.utc)
+    if last_modified.timestamp() <= if_modified_since.timestamp():
         return HTTPResponse(status=304)
 
 

sanic/response/types.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from datetime import datetime
 from functools import partial
 from typing import (
     TYPE_CHECKING,
@@ -17,6 +18,7 @@ from typing import (
 
 from sanic.compat import Header
 from sanic.cookies import CookieJar
+from sanic.cookies.response import Cookie, SameSite
 from sanic.exceptions import SanicException, ServerError
 from sanic.helpers import (
     Default,
@@ -36,7 +38,9 @@ else:
 
 
 try:
-    from ujson import dumps as json_dumps
+    from ujson import dumps as ujson_dumps
+
+    json_dumps = partial(ujson_dumps, escape_forward_slashes=False)
 except ImportError:
     # This is done in order to ensure that the JSON response is
     # kept consistent across both ujson and inbuilt json usage.
@@ -158,6 +162,117 @@ class BaseHTTPResponse:
             end_stream=end_stream or False,
         )
 
+    def add_cookie(
+        self,
+        key: str,
+        value: str,
+        *,
+        path: str = "/",
+        domain: Optional[str] = None,
+        secure: bool = True,
+        max_age: Optional[int] = None,
+        expires: Optional[datetime] = None,
+        httponly: bool = False,
+        samesite: Optional[SameSite] = "Lax",
+        partitioned: bool = False,
+        comment: Optional[str] = None,
+        host_prefix: bool = False,
+        secure_prefix: bool = False,
+    ) -> Cookie:
+        """
+        Add a cookie to the CookieJar
+
+        :param key: Key of the cookie
+        :type key: str
+        :param value: Value of the cookie
+        :type value: str
+        :param path: Path of the cookie, defaults to None
+        :type path: Optional[str], optional
+        :param domain: Domain of the cookie, defaults to None
+        :type domain: Optional[str], optional
+        :param secure: Whether to set it as a secure cookie, defaults to True
+        :type secure: bool
+        :param max_age: Max age of the cookie in seconds; if set to 0 a
+            browser should delete it, defaults to None
+        :type max_age: Optional[int], optional
+        :param expires: When the cookie expires; if set to None browsers
+            should set it as a session cookie, defaults to None
+        :type expires: Optional[datetime], optional
+        :param httponly: Whether to set it as HTTP only, defaults to False
+        :type httponly: bool
+        :param samesite: How to set the samesite property, should be
+            strict, lax or none (case insensitive), defaults to Lax
+        :type samesite: Optional[SameSite], optional
+        :param partitioned: Whether to set it as partitioned, defaults to False
+        :type partitioned: bool
+        :param comment: A cookie comment, defaults to None
+        :type comment: Optional[str], optional
+        :param host_prefix: Whether to add __Host- as a prefix to the key.
+            This requires that path="/", domain=None, and secure=True,
+            defaults to False
+        :type host_prefix: bool
+        :param secure_prefix: Whether to add __Secure- as a prefix to the key.
+            This requires that secure=True, defaults to False
+        :type secure_prefix: bool
+        :return: The instance of the created cookie
+        :rtype: Cookie
+        """
+        return self.cookies.add_cookie(
+            key=key,
+            value=value,
+            path=path,
+            domain=domain,
+            secure=secure,
+            max_age=max_age,
+            expires=expires,
+            httponly=httponly,
+            samesite=samesite,
+            partitioned=partitioned,
+            comment=comment,
+            host_prefix=host_prefix,
+            secure_prefix=secure_prefix,
+        )
+
+    def delete_cookie(
+        self,
+        key: str,
+        *,
+        path: str = "/",
+        domain: Optional[str] = None,
+        host_prefix: bool = False,
+        secure_prefix: bool = False,
+    ) -> None:
+        """
+        Delete a cookie
+
+        This will effectively set it as Max-Age: 0, which a browser should
+        interpret it to mean: "delete the cookie".
+
+        Since it is a browser/client implementation, your results may vary
+        depending upon which client is being used.
+
+        :param key: The key to be deleted
+        :type key: str
+        :param path: Path of the cookie, defaults to None
+        :type path: Optional[str], optional
+        :param domain: Domain of the cookie, defaults to None
+        :type domain: Optional[str], optional
+        :param host_prefix: Whether to add __Host- as a prefix to the key.
+            This requires that path="/", domain=None, and secure=True,
+            defaults to False
+        :type host_prefix: bool
+        :param secure_prefix: Whether to add __Secure- as a prefix to the key.
+            This requires that secure=True, defaults to False
+        :type secure_prefix: bool
+        """
+        self.cookies.delete_cookie(
+            key=key,
+            path=path,
+            domain=domain,
+            host_prefix=host_prefix,
+            secure_prefix=secure_prefix,
+        )
+
 
 class HTTPResponse(BaseHTTPResponse):
     """
@@ -232,7 +347,7 @@ class JSONResponse(HTTPResponse):
         body: Optional[Any] = None,
         status: int = 200,
         headers: Optional[Union[Header, Dict[str, str]]] = None,
-        content_type: Optional[str] = None,
+        content_type: str = "application/json",
         dumps: Optional[Callable[..., str]] = None,
         **kwargs: Any,
     ):
@@ -407,6 +522,10 @@ class ResponseStream:
         headers: Optional[Union[Header, Dict[str, str]]] = None,
         content_type: Optional[str] = None,
     ):
+        if headers is None:
+            headers = Header()
+        elif not isinstance(headers, Header):
+            headers = Header(headers)
         self.streaming_fn = streaming_fn
         self.status = status
         self.headers = headers or Header()

sanic/router.py

@@ -44,7 +44,9 @@ class Router(BaseRouter):
             raise MethodNotAllowed(
                 f"Method {method} not allowed for URL {path}",
                 method=method,
-                allowed_methods=e.allowed_methods,
+                allowed_methods=tuple(e.allowed_methods)
+                if e.allowed_methods
+                else None,
             ) from None
 
     @lru_cache(maxsize=ROUTER_CACHE_SIZE)
@@ -73,11 +75,12 @@ class Router(BaseRouter):
         strict_slashes: bool = False,
         stream: bool = False,
         ignore_body: bool = False,
-        version: Union[str, float, int] = None,
+        version: Optional[Union[str, float, int]] = None,
         name: Optional[str] = None,
         unquote: bool = False,
         static: bool = False,
         version_prefix: str = "/v",
+        overwrite: bool = False,
         error_format: Optional[str] = None,
     ) -> Union[Route, List[Route]]:
         """
@@ -120,6 +123,7 @@ class Router(BaseRouter):
             name=name,
             strict=strict_slashes,
             unquote=unquote,
+            overwrite=overwrite,
         )
 
         if isinstance(host, str):
@@ -133,7 +137,16 @@ class Router(BaseRouter):
             if host:
                 params.update({"requirements": {"host": host}})
 
+            ident = name
+            if len(hosts) > 1:
+                ident = (
+                    f"{name}_{host.replace('.', '_')}"
+                    if name
+                    else "__unnamed__"
+                )
+
             route = super().add(**params)  # type: ignore
+            route.extra.ident = ident
             route.extra.ignore_body = ignore_body
             route.extra.stream = stream
             route.extra.hosts = hosts

sanic/server/__init__.py

@@ -2,7 +2,7 @@ from sanic.models.server_types import ConnInfo, Signal
 from sanic.server.async_server import AsyncioServer
 from sanic.server.loop import try_use_uvloop
 from sanic.server.protocols.http_protocol import HttpProtocol
-from sanic.server.runners import serve, serve_multiple, serve_single
+from sanic.server.runners import serve
 
 
 __all__ = (
@@ -11,7 +11,5 @@ __all__ = (
     "HttpProtocol",
     "Signal",
     "serve",
-    "serve_multiple",
-    "serve_single",
     "try_use_uvloop",
 )

sanic/server/events.py

@@ -3,7 +3,6 @@ from __future__ import annotations
 from inspect import isawaitable
 from typing import TYPE_CHECKING, Any, Callable, Iterable, Optional
 
-
 if TYPE_CHECKING:
     from sanic import Sanic
 
@@ -12,6 +11,7 @@ def trigger_events(
     events: Optional[Iterable[Callable[..., Any]]],
     loop,
     app: Optional[Sanic] = None,
+    **kwargs,
 ):
     """
     Trigger event callbacks (functions or async)
@@ -22,8 +22,12 @@ def trigger_events(
     if events:
         for event in events:
             try:
-                result = event() if not app else event(app)
+                result = event(**kwargs) if not app else event(app, **kwargs)
             except TypeError:
-                result = event(loop) if not app else event(app, loop)
+                result = (
+                    event(loop, **kwargs)
+                    if not app
+                    else event(app, loop, **kwargs)
+                )
             if isawaitable(result):
                 loop.run_until_complete(result)

sanic/server/legacy.py

@@ -1,123 +0,0 @@
-import itertools
-import os
-import signal
-import subprocess
-import sys
-
-from time import sleep
-
-
-def _iter_module_files():
-    """This iterates over all relevant Python files.
-    It goes through all
-    loaded files from modules, all files in folders of already loaded modules
-    as well as all files reachable through a package.
-    """
-    # The list call is necessary on Python 3 in case the module
-    # dictionary modifies during iteration.
-    for module in list(sys.modules.values()):
-        if module is None:
-            continue
-        filename = getattr(module, "__file__", None)
-        if filename:
-            old = None
-            while not os.path.isfile(filename):
-                old = filename
-                filename = os.path.dirname(filename)
-                if filename == old:
-                    break
-            else:
-                if filename[-4:] in (".pyc", ".pyo"):
-                    filename = filename[:-1]
-                yield filename
-
-
-def _get_args_for_reloading():
-    """Returns the executable."""
-    main_module = sys.modules["__main__"]
-    mod_spec = getattr(main_module, "__spec__", None)
-    if sys.argv[0] in ("", "-c"):
-        raise RuntimeError(
-            f"Autoreloader cannot work with argv[0]={sys.argv[0]!r}"
-        )
-    if mod_spec:
-        # Parent exe was launched as a module rather than a script
-        return [sys.executable, "-m", mod_spec.name] + sys.argv[1:]
-    return [sys.executable] + sys.argv
-
-
-def restart_with_reloader(changed=None):
-    """Create a new process and a subprocess in it with the same arguments as
-    this one.
-    """
-    reloaded = ",".join(changed) if changed else ""
-    return subprocess.Popen(  # nosec B603
-        _get_args_for_reloading(),
-        env={
-            **os.environ,
-            "SANIC_SERVER_RUNNING": "true",
-            "SANIC_RELOADER_PROCESS": "true",
-            "SANIC_RELOADED_FILES": reloaded,
-        },
-    )
-
-
-def _check_file(filename, mtimes):
-    need_reload = False
-
-    mtime = os.stat(filename).st_mtime
-    old_time = mtimes.get(filename)
-    if old_time is None:
-        mtimes[filename] = mtime
-    elif mtime > old_time:
-        mtimes[filename] = mtime
-        need_reload = True
-
-    return need_reload
-
-
-def watchdog(sleep_interval, reload_dirs):
-    """Watch project files, restart worker process if a change happened.
-    :param sleep_interval: interval in second.
-    :return: Nothing
-    """
-
-    def interrupt_self(*args):
-        raise KeyboardInterrupt
-
-    mtimes = {}
-    signal.signal(signal.SIGTERM, interrupt_self)
-    if os.name == "nt":
-        signal.signal(signal.SIGBREAK, interrupt_self)
-
-    worker_process = restart_with_reloader()
-
-    try:
-        while True:
-            changed = set()
-            for filename in itertools.chain(
-                _iter_module_files(),
-                *(d.glob("**/*") for d in reload_dirs),
-            ):
-                try:
-                    if _check_file(filename, mtimes):
-                        path = (
-                            filename
-                            if isinstance(filename, str)
-                            else filename.resolve()
-                        )
-                        changed.add(str(path))
-                except OSError:
-                    continue
-
-            if changed:
-                worker_process.terminate()
-                worker_process.wait()
-                worker_process = restart_with_reloader(changed)
-
-            sleep(sleep_interval)
-    except KeyboardInterrupt:
-        pass
-    finally:
-        worker_process.terminate()
-        worker_process.wait()

sanic/server/protocols/websocket_protocol.py

@@ -10,7 +10,7 @@ except ImportError:  # websockets >= 11.0
 
 from websockets.typing import Subprotocol
 
-from sanic.exceptions import ServerError
+from sanic.exceptions import SanicException
 from sanic.log import logger
 from sanic.server import HttpProtocol
 
@@ -123,7 +123,7 @@ class WebSocketProtocol(HttpProtocol):
                 "Failed to open a WebSocket connection.\n"
                 "See server log for more information.\n"
             )
-            raise ServerError(msg, status_code=500)
+            raise SanicException(msg, status_code=500)
         if 100 <= resp.status_code <= 299:
             first_line = (
                 f"HTTP/1.1 {resp.status_code} {resp.reason_phrase}\r\n"
@@ -138,7 +138,7 @@ class WebSocketProtocol(HttpProtocol):
                 rbody += b"\r\n\r\n"
             await super().send(rbody)
         else:
-            raise ServerError(resp.body, resp.status_code)
+            raise SanicException(resp.body, resp.status_code)
         self.websocket = WebsocketImplProtocol(
             ws_proto,
             ping_interval=self.websocket_ping_interval,

sanic/server/runners.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-import sys
-
 from ssl import SSLContext
 from typing import TYPE_CHECKING, Dict, Optional, Type, Union
 
@@ -9,19 +7,17 @@ from sanic.config import Config
 from sanic.exceptions import ServerError
 from sanic.http.constants import HTTP
 from sanic.http.tls import get_ssl_context
-from sanic.server.events import trigger_events
 
 
 if TYPE_CHECKING:
     from sanic.app import Sanic
 
 import asyncio
-import multiprocessing
 import os
 import socket
 
 from functools import partial
-from signal import SIG_IGN, SIGINT, SIGTERM, Signals
+from signal import SIG_IGN, SIGINT, SIGTERM
 from signal import signal as signal_func
 
 from sanic.application.ext import setup_ext
@@ -31,11 +27,7 @@ from sanic.log import error_logger, server_logger
 from sanic.models.server_types import Signal
 from sanic.server.async_server import AsyncioServer
 from sanic.server.protocols.http_protocol import Http3Protocol, HttpProtocol
-from sanic.server.socket import (
+from sanic.server.socket import bind_unix_socket, remove_unix_socket
-    bind_socket,
-    bind_unix_socket,
-    remove_unix_socket,
-)
 
 
 try:
@@ -257,8 +249,7 @@ def _serve_http_1(
             loop.run_until_complete(asyncio.sleep(0.1))
             start_shutdown = start_shutdown + 0.1
 
-        if sys.version_info > (3, 7):
+        app.shutdown_tasks(graceful - start_shutdown)
-            app.shutdown_tasks(graceful - start_shutdown)
 
         # Force close non-idle connection after waiting for
         # graceful_shutdown_timeout
@@ -319,94 +310,6 @@ def _serve_http_3(
     )
 
 
-def serve_single(server_settings):
-    main_start = server_settings.pop("main_start", None)
-    main_stop = server_settings.pop("main_stop", None)
-
-    if not server_settings.get("run_async"):
-        # create new event_loop after fork
-        loop = asyncio.new_event_loop()
-        asyncio.set_event_loop(loop)
-        server_settings["loop"] = loop
-
-    trigger_events(main_start, server_settings["loop"])
-    serve(**server_settings)
-    trigger_events(main_stop, server_settings["loop"])
-
-    server_settings["loop"].close()
-
-
-def serve_multiple(server_settings, workers):
-    """Start multiple server processes simultaneously.  Stop on interrupt
-    and terminate signals, and drain connections when complete.
-
-    :param server_settings: kw arguments to be passed to the serve function
-    :param workers: number of workers to launch
-    :param stop_event: if provided, is used as a stop signal
-    :return:
-    """
-    server_settings["reuse_port"] = True
-    server_settings["run_multiple"] = True
-
-    main_start = server_settings.pop("main_start", None)
-    main_stop = server_settings.pop("main_stop", None)
-    loop = asyncio.new_event_loop()
-    asyncio.set_event_loop(loop)
-
-    trigger_events(main_start, loop)
-
-    # Create a listening socket or use the one in settings
-    sock = server_settings.get("sock")
-    unix = server_settings["unix"]
-    backlog = server_settings["backlog"]
-    if unix:
-        sock = bind_unix_socket(unix, backlog=backlog)
-        server_settings["unix"] = unix
-    if sock is None:
-        sock = bind_socket(
-            server_settings["host"], server_settings["port"], backlog=backlog
-        )
-        sock.set_inheritable(True)
-        server_settings["sock"] = sock
-        server_settings["host"] = None
-        server_settings["port"] = None
-
-    processes = []
-
-    def sig_handler(signal, frame):
-        server_logger.info(
-            "Received signal %s. Shutting down.", Signals(signal).name
-        )
-        for process in processes:
-            os.kill(process.pid, SIGTERM)
-
-    signal_func(SIGINT, lambda s, f: sig_handler(s, f))
-    signal_func(SIGTERM, lambda s, f: sig_handler(s, f))
-    mp = multiprocessing.get_context("fork")
-
-    for _ in range(workers):
-        process = mp.Process(
-            target=serve,
-            kwargs=server_settings,
-        )
-        process.daemon = True
-        process.start()
-        processes.append(process)
-
-    for process in processes:
-        process.join()
-
-    # the above processes will block this until they're stopped
-    for process in processes:
-        process.terminate()
-
-    trigger_events(main_stop, loop)
-
-    sock.close()
-    loop.close()
-    remove_unix_socket(unix)
-
-
 def _build_protocol_kwargs(
     protocol: Type[asyncio.Protocol], config: Config
 ) -> Dict[str, Union[int, float]]:

sanic/server/websockets/frame.py

@@ -96,6 +96,7 @@ class WebsocketFrameAssembler:
         If ``timeout`` is set and elapses before a complete message is
         received, :meth:`get` returns ``None``.
         """
+        completed: bool
         async with self.read_mutex:
             if timeout is not None and timeout <= 0:
                 if not self.message_complete.is_set():

sanic/server/websockets/impl.py

@@ -21,7 +21,7 @@ from websockets.frames import Frame, Opcode
 
 
 try:  # websockets < 11.0
-    from websockets.connection import Event, State
+    from websockets.connection import Event, State  # type: ignore
     from websockets.server import ServerConnection as ServerProtocol
 except ImportError:  # websockets >= 11.0
     from websockets.protocol import Event, State  # type: ignore
@@ -29,7 +29,7 @@ except ImportError:  # websockets >= 11.0
 
 from websockets.typing import Data
 
-from sanic.log import deprecation, error_logger, logger
+from sanic.log import error_logger, logger
 from sanic.server.protocols.base_protocol import SanicProtocol
 
 from ...exceptions import ServerError, WebsocketClosed
@@ -99,15 +99,6 @@ class WebsocketImplProtocol:
     def subprotocol(self):
         return self.ws_proto.subprotocol
 
-    @property
-    def connection(self):
-        deprecation(
-            "The connection property has been deprecated and will be removed. "
-            "Please use the ws_proto property instead going forward.",
-            22.6,
-        )
-        return self.ws_proto
-
     def pause_frames(self):
         if not self.can_pause:
             return False

sanic/signals.py

@@ -16,6 +16,7 @@ from sanic.models.handler_types import SignalHandler
 
 
 class Event(Enum):
+    SERVER_EXCEPTION_REPORT = "server.exception.report"
     SERVER_INIT_AFTER = "server.init.after"
     SERVER_INIT_BEFORE = "server.init.before"
     SERVER_SHUTDOWN_AFTER = "server.shutdown.after"
@@ -39,6 +40,7 @@ class Event(Enum):
 
 RESERVED_NAMESPACES = {
     "server": (
+        Event.SERVER_EXCEPTION_REPORT.value,
         Event.SERVER_INIT_AFTER.value,
         Event.SERVER_INIT_BEFORE.value,
         Event.SERVER_SHUTDOWN_AFTER.value,
@@ -168,6 +170,17 @@ class SignalRouter(BaseRouter):
                     elif maybe_coroutine:
                         return maybe_coroutine
             return None
+        except Exception as e:
+            if self.ctx.app.debug and self.ctx.app.state.verbosity >= 1:
+                error_logger.exception(e)
+
+            if event != Event.SERVER_EXCEPTION_REPORT.value:
+                await self.dispatch(
+                    Event.SERVER_EXCEPTION_REPORT.value,
+                    context={"exception": e},
+                )
+                setattr(e, "__dispatched__", True)
+            raise e
         finally:
             for signal_event in events:
                 signal_event.clear()
@@ -217,14 +230,6 @@ class SignalRouter(BaseRouter):
         if not trigger:
             event = ".".join([*parts[:2], "<__trigger__>"])
 
-        try:
-            # Attaching __requirements__ and __trigger__ to the handler
-            # is deprecated and will be removed in v23.6.
-            handler.__requirements__ = condition  # type: ignore
-            handler.__trigger__ = trigger  # type: ignore
-        except AttributeError:
-            pass
-
         signal = super().add(
             event,
             handler,

sanic/worker/inspector.py

@@ -83,10 +83,7 @@ class Inspector:
 
     async def _respond(self, request: Request, output: Any):
         name = request.match_info.get("action", "info")
-        return json(
+        return json({"meta": {"action": name}, "result": output})
-            {"meta": {"action": name}, "result": output},
-            escape_forward_slashes=False,
-        )
 
     def _state_to_json(self) -> Dict[str, Any]:
         output = {"info": self.app_info}

sanic/worker/loader.py

@@ -3,8 +3,11 @@ from __future__ import annotations
 import os
 import sys
 
+from contextlib import suppress
 from importlib import import_module
+from inspect import isfunction
 from pathlib import Path
+from ssl import SSLContext
 from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Union, cast
 
 from sanic.http.tls.context import process_to_context
@@ -14,6 +17,8 @@ from sanic.http.tls.creators import MkcertCreator, TrustmeCreator
 if TYPE_CHECKING:
     from sanic import Sanic as SanicApp
 
+DEFAULT_APP_NAME = "app"
+
 
 class AppLoader:
     def __init__(
@@ -35,7 +40,11 @@ class AppLoader:
 
         if module_input:
             delimiter = ":" if ":" in module_input else "."
-            if module_input.count(delimiter):
+            if (
+                delimiter in module_input
+                and "\\" not in module_input
+                and "/" not in module_input
+            ):
                 module_name, app_name = module_input.rsplit(delimiter, 1)
                 self.module_name = module_name
                 self.app_name = app_name
@@ -54,21 +63,30 @@ class AppLoader:
             from sanic.app import Sanic
             from sanic.simple import create_simple_server
 
-            if self.as_simple:
+            maybe_path = Path(self.module_input)
-                path = Path(self.module_input)
+            if self.as_simple or (
-                app = create_simple_server(path)
+                maybe_path.is_dir()
+                and ("\\" in self.module_input or "/" in self.module_input)
+            ):
+                app = create_simple_server(maybe_path)
             else:
-                if self.module_name == "" and os.path.isdir(self.module_input):
+                implied_app_name = False
-                    raise ValueError(
+                if not self.module_name and not self.app_name:
-                        "App not found.\n"
+                    self.module_name = self.module_input
-                        "   Please use --simple if you are passing a "
+                    self.app_name = DEFAULT_APP_NAME
-                        "directory to sanic.\n"
+                    implied_app_name = True
-                        f"   eg. sanic {self.module_input} --simple"
-                    )
-
                 module = import_module(self.module_name)
                 app = getattr(module, self.app_name, None)
-                if self.as_factory:
+                if not app and implied_app_name:
+                    raise ValueError(
+                        "Looks like you only supplied a module name. Sanic "
+                        "tried to locate an application instance named "
+                        f"{self.module_name}:app, but was unable to locate "
+                        "an application instance. Please provide a path "
+                        "to a global instance of Sanic(), or a callable that "
+                        "will return a Sanic() application instance."
+                    )
+                if self.as_factory or isfunction(app):
                     try:
                         app = app(self.args)
                     except TypeError:
@@ -79,21 +97,18 @@ class AppLoader:
                 if (
                     not isinstance(app, Sanic)
                     and self.args
-                    and hasattr(self.args, "module")
+                    and hasattr(self.args, "target")
                 ):
-                    if callable(app):
+                    with suppress(ModuleNotFoundError):
-                        solution = f"sanic {self.args.module} --factory"
+                        maybe_module = import_module(self.module_input)
-                        raise ValueError(
+                        app = getattr(maybe_module, "app", None)
-                            "Module is not a Sanic app, it is a "
+                    if not app:
-                            f"{app_type_name}\n"
+                        message = (
-                            "  If this callable returns a "
+                            "Module is not a Sanic app, "
-                            f"Sanic instance try: \n{solution}"
+                            f"it is a {app_type_name}\n"
+                            f"  Perhaps you meant {self.args.target}:app?"
                         )
-
+                        raise ValueError(message)
-                    raise ValueError(
-                        f"Module is not a Sanic app, it is a {app_type_name}\n"
-                        f"  Perhaps you meant {self.args.module}:app?"
-                    )
         return app
 
 
@@ -103,8 +118,16 @@ class CertLoader:
         "trustme": TrustmeCreator,
     }
 
-    def __init__(self, ssl_data: Dict[str, Union[str, os.PathLike]]):
+    def __init__(
+        self,
+        ssl_data: Optional[
+            Union[SSLContext, Dict[str, Union[str, os.PathLike]]]
+        ],
+    ):
         self._ssl_data = ssl_data
+        self._creator_class = None
+        if not ssl_data or not isinstance(ssl_data, dict):
+            return
 
         creator_name = cast(str, ssl_data.get("creator"))
 

sanic/worker/manager.py

@@ -5,7 +5,7 @@ from itertools import count
 from random import choice
 from signal import SIGINT, SIGTERM, Signals
 from signal import signal as signal_func
-from typing import Dict, List, Optional
+from typing import Any, Callable, Dict, List, Optional
 
 from sanic.compat import OS_IS_WINDOWS
 from sanic.exceptions import ServerKilled
@@ -54,9 +54,36 @@ class WorkerManager:
         signal_func(SIGINT, self.shutdown_signal)
         signal_func(SIGTERM, self.shutdown_signal)
 
-    def manage(self, ident, func, kwargs, transient=False) -> Worker:
+    def manage(
+        self,
+        ident: str,
+        func: Callable[..., Any],
+        kwargs: Dict[str, Any],
+        transient: bool = False,
+        workers: int = 1,
+    ) -> Worker:
+        """
+        Instruct Sanic to manage a custom process.
+
+        :param ident: A name for the worker process
+        :type ident: str
+        :param func: The function to call in the background process
+        :type func: Callable[..., Any]
+        :param kwargs: Arguments to pass to the function
+        :type kwargs: Dict[str, Any]
+        :param transient: Whether to mark the process as transient. If True
+            then the Worker Manager will restart the process along
+            with any global restart (ex: auto-reload), defaults to False
+        :type transient: bool, optional
+        :param workers: The number of worker processes to run, defaults to 1
+        :type workers: int, optional
+        :return: The Worker instance
+        :rtype: Worker
+        """
         container = self.transient if transient else self.durable
-        worker = Worker(ident, func, kwargs, self.context, self.worker_state)
+        worker = Worker(
+            ident, func, kwargs, self.context, self.worker_state, workers
+        )
         container[worker.ident] = worker
         return worker
 
@@ -285,6 +312,10 @@ class WorkerManager:
 
     def _sync_states(self):
         for process in self.processes:
-            state = self.worker_state[process.name].get("state")
+            try:
+                state = self.worker_state[process.name].get("state")
+            except KeyError:
+                process.set_state(ProcessState.TERMINATED, True)
+                continue
             if state and process.state.name != state:
                 process.set_state(ProcessState[state], True)

sanic/worker/process.py

@@ -192,14 +192,17 @@ class Worker:
         server_settings,
         context: BaseContext,
         worker_state: Dict[str, Any],
+        num: int = 1,
     ):
         self.ident = ident
+        self.num = num
         self.context = context
         self.serve = serve
         self.server_settings = server_settings
         self.worker_state = worker_state
         self.processes: Set[WorkerProcess] = set()
-        self.create_process()
+        for _ in range(num):
+            self.create_process()
 
     def create_process(self) -> WorkerProcess:
         process = WorkerProcess(

sanic/worker/reloader.py

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 import os
 import sys
-
 from asyncio import new_event_loop
 from itertools import chain
 from multiprocessing.connection import Connection
@@ -64,7 +63,7 @@ class Reloader:
                     trigger_events(before_trigger, loop, app)
                 self.reload(",".join(changed) if changed else "unknown")
                 if after_trigger:
-                    trigger_events(after_trigger, loop, app)
+                    trigger_events(after_trigger, loop, app, changed=changed)
             sleep(self.interval)
         else:
             if reloader_stop:

sanic/worker/serve.py

@@ -73,8 +73,8 @@ def worker_serve(
                             info.settings["app"] = a
                         a.state.server_info.append(info)
 
-        if isinstance(ssl, dict):
+        if isinstance(ssl, dict) or app.certloader_class is not CertLoader:
-            cert_loader = CertLoader(ssl)
+            cert_loader = app.certloader_class(ssl or {})
             ssl = cert_loader.load(app)
             for info in app.state.server_info:
                 info.settings["ssl"] = ssl

setup.cfg

@@ -1,4 +1,2 @@
 [flake8]
 ignore = E203, W503
-per-file-ignores =
-    sanic/app.py:E402

setup.py

@@ -83,12 +83,11 @@ setup_kwargs = {
     "packages": find_packages(exclude=("tests", "tests.*")),
     "package_data": {"sanic": ["py.typed", "pages/styles/*"]},
     "platforms": "any",
-    "python_requires": ">=3.7",
+    "python_requires": ">=3.8",
     "classifiers": [
         "Development Status :: 4 - Beta",
         "Environment :: Web Environment",
         "License :: OSI Approved :: MIT License",
-        "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
@@ -104,7 +103,7 @@ ujson = "ujson>=1.35" + env_dependency
 uvloop = "uvloop>=0.15.0" + env_dependency
 types_ujson = "types-ujson" + env_dependency
 requirements = [
-    "sanic-routing>=22.8.0",
+    "sanic-routing>=23.6.0",
     "httptools>=0.0.10",
     uvloop,
     ujson,
@@ -113,10 +112,11 @@ requirements = [
     "multidict>=5.0,<7.0",
     "html5tagger>=1.2.1",
     "tracerite>=1.0.0",
+    "typing-extensions>=4.4.0",
 ]
 
 tests_require = [
-    "sanic-testing>=22.9.0",
+    "sanic-testing>=23.6.0",
     "pytest==7.1.*",
     "coverage",
     "beautifulsoup4",
@@ -127,7 +127,7 @@ tests_require = [
     "black",
     "isort>=5.0.0",
     "bandit",
-    "mypy>=0.901,<0.910",
+    "mypy",
     "docutils",
     "pygments",
     "uvicorn<0.15.0",

tests/certs/password/fullchain.pem

@@ -0,0 +1,19 @@
+-----BEGIN CERTIFICATE-----
+MIIDCTCCAfGgAwIBAgIUa7OOlAGQfXOgUgRENJ9GbUgO7kwwDQYJKoZIhvcNAQEL
+BQAwFDESMBAGA1UEAwwJMTI3LjAuMC4xMB4XDTIzMDMyMDA3MzE1M1oXDTIzMDQx
+OTA3MzE1M1owFDESMBAGA1UEAwwJMTI3LjAuMC4xMIIBIjANBgkqhkiG9w0BAQEF
+AAOCAQ8AMIIBCgKCAQEAn2/RqVpzO7GFrgVGiowR5CzcFzf1tSFti1K/WIGr/jsu
+NP+1R3sim17pgg6SCOFnUMRS0KnDihkzoeP6z+0tFsrbCH4V1+fq0iud8WgYQrgD
+3ttUcHrz04p7wsMoeqndUQoLbyJzP8MpA2XJsoacdIVkuLv2AESGXLhJym/e9HGN
+g8bqdz25X0hVTczZW1FN9AZyWWVf9Go6jqC7LCaOnYXAnOkEy2/JHdkeNXYFZHB3
+71UemfkCjfp0vlRV8pVpkBGMhRNFphBTfxdqeWiGQwVqrhaJO4M7DJlQHCAPY16P
+o9ywnhLDhFHD7KIfTih9XxrdgTowqcwyGX3e3aJpTwIDAQABo1MwUTAdBgNVHQ4E
+FgQU5NogMq6mRBeGl4i6hIuUlcR2bVEwHwYDVR0jBBgwFoAU5NogMq6mRBeGl4i6
+hIuUlcR2bVEwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAYW34
+JY1kd0UO5HE41oxJD4PioQboXXX0al4RgKaUUsPykeHQbK0q0TSYAZLwRjooTVUO
+Wvna5bU2mzyULqA2r/Cr/w4zb9xybO3SiHFHcU1RacouauHXROHwRm98i8A73xnH
+vHws5BADr2ggnVcPNh4VOQ9ZvBlC7jhgpvMjqOEu5ZPCovhfZYfSsvBDHcD74ZYm
+Di9DvqsJmrb23Dv3SUykm3W+Ql2q+JyjFj30rhD89CFwJ9iSlFwTYEwZLHA+mV6p
+UKy3I3Fiht1Oc+nIivX5uhRSMbDVvDTVHbjjPujxxFjkiHXMjtwvwfg4Sb6du61q
+AjBRFyXbNu4hZkkHOA==
+-----END CERTIFICATE-----

tests/certs/password/privkey.pem

@@ -0,0 +1,30 @@
+-----BEGIN ENCRYPTED PRIVATE KEY-----
+MIIFLTBXBgkqhkiG9w0BBQ0wSjApBgkqhkiG9w0BBQwwHAQI94UBqjaZlG4CAggA
+MAwGCCqGSIb3DQIJBQAwHQYJYIZIAWUDBAEqBBCvJhEy+3/+0Ec0gpd5dkP6BIIE
+0E7rLplTe9rxK3sR9V0cx8Xn6V+uFhG3p7dzeMDCCKpGo9MEaacF5m+paGnBkMlH
+Pz3rRoLA5jqzwXl4US/C5E1Or//2YBgF1XXKi3BPF/bVx/g6vR+xeobf9kQGbqQk
+FNPYtP7mpg2dekp5BUsKSosIt8BkknWFvhBeNuGZT/zlMUuq1WpMe4KIh/W9IdNr
+HolcuZJWBhQAwGPciWIZRyq48wKa++W7Jdg/aG8FviJQnjaAUv4CyZJHUJnaNwUx
+iHOETpzIC+bhF2K+s4g5w68VCj6Jtz78sIBEZKzo7LI5QHdRHqYB5SJ/dGiV+h09
+R/rQ/M+24mwHDlRSCxxq0yuDwUuGBlHyATeDCFeE3L5OX8yTLuqYJ6vUa6UbzMYA
+8H4l5zfu9RrAhKYa9tD+4ONxMmHziIgmn5zvSXeBwJKfeUbnN4IKWLsSoSVspBRh
+zLl51DMAnem4NEjLfIW8WYjhsvSYwd9BYqxXaAiv4Wjx9ZV1yLqFICC7tejpVdRT
+afI0qMOfWu4ma6xVBg1ezLgF1wHIPrq6euTvWdnifYQopVICALlltEo5oxQ2i/OM
+NY8RyovWujiGNsa3pId9HmZXiLyLXjKPstGWRK4liMyc2EiP099gTdBvrb+VQp+I
+EyPavmh3WNhgZGOh3qah39X8HrBprc0PPfSPlxpaWdNMIIMSbcIWWdJEA/e4tcy/
+uBaV4H3sNCtBApgrb6B9YUbS9CXNUburJo19T1sk2uCaO12qYfdu2IDEnFf8JiF3
+i7nyftotRuoKq2D+V8d0PeMi/vJSo6+eZIn7VNe6ejYf+w0s7sxlpiKVzkslyOhq
+n0T4M3ZkSwGIETzgkRRuTY1OK7slhglMgXlQ2FuIUUo6CRg9WjRJvI5rujLzLWfB
+hkgP8STirjTV0DUWPFGtUcenvEcZPkYIQcoPHxOJGNW3ZPXNpt4RjbvPLeVzDm0O
+WJiay/qhag/bXGqKraO3b6Y7FOzJa8kG4G0XrcFY1s2oCXRqRqYJAtwaEeVCjCSJ
+Qy0OZkqcJEU7pv98pLMpG9OWz4Gle77g4KoQUJjQGtmg0MUMoPd0iPRmvkxsYg8E
+Q9uZS3m6PpWmmYDY0Ik1w/4avs3skl2mW3dqcZGLEepkjiQSnFABsuvxKd+uIEQy
+lyf9FrynXVcUI87LUkuniLRKwZZzFALVuc+BwtO3SA5mvEK22ZEq9QOysbwlpN54
+G5xXJKJEeexUSjEUIij4J89RLsXldibhp7YYZ7rFviR6chIqC0V7G6VqAM9TOCrV
+PWZXr3ZY5/pCZYs5DYKFJBFMSQ2UT/++VYxdZCeBH75vaxugbS8RdUM+iVDevWpQ
+/AnP1FolNAgkVhi3Rw4L16SibkqpEzIi1svPWKMwXdvewA32UidLElhuTWWjI2Wm
+veXhmEqwk/7ML4JMI7wHcDQdvSKen0mCL2J9tB7A/pewYyDE0ffIUmjxglOtw30f
+ZOlQKhMaKJGXp00U2zsHA2NJRI/hThbJncsnZyvuLei0P42RrF+r64b/0gUH6IZ5
+wPUttT815KSNoy+XXXum9YGDYYFoAL+6WVEkl6dgo+X0hcH7DDf5Nkewiq8UcJGh
+/69vFIfp+JlpicXzZ+R42LO3T3luC907aFBywF3pmi//
+-----END ENCRYPTED PRIVATE KEY-----

tests/fake/server.py

@@ -49,6 +49,6 @@ def create_app_with_args(args):
     try:
         logger.info(f"foo={args.foo}")
     except AttributeError:
-        logger.info(f"module={args.module}")
+        logger.info(f"target={args.target}")
 
     return app

tests/http3/test_http_receiver.py

@@ -11,7 +11,7 @@ from aioquic.quic.events import ProtocolNegotiated
 from sanic import Request, Sanic
 from sanic.compat import Header
 from sanic.config import DEFAULT_CONFIG
-from sanic.exceptions import PayloadTooLarge
+from sanic.exceptions import BadRequest, PayloadTooLarge
 from sanic.http.constants import Stage
 from sanic.http.http3 import Http3, HTTPReceiver
 from sanic.models.server_types import ConnInfo
@@ -292,3 +292,48 @@ def test_request_conn_info(app):
     receiver = http3.get_receiver_by_stream_id(1)
 
     assert isinstance(receiver.request.conn_info, ConnInfo)
+
+
+def test_request_header_encoding(app):
+    protocol = generate_protocol(app)
+    http3 = Http3(protocol, protocol.transmit)
+    with pytest.raises(BadRequest) as exc_info:
+        http3.http_event_received(
+            HeadersReceived(
+                [
+                    (b":method", b"GET"),
+                    (b":path", b"/location"),
+                    (b":scheme", b"https"),
+                    (b":authority", b"localhost:8443"),
+                    ("foo\u00A0".encode(), b"bar"),
+                ],
+                1,
+                False,
+            )
+        )
+    assert exc_info.value.status_code == 400
+    assert (
+        str(exc_info.value)
+        == "Header names may only contain US-ASCII characters."
+    )
+
+
+def test_request_url_encoding(app):
+    protocol = generate_protocol(app)
+    http3 = Http3(protocol, protocol.transmit)
+    with pytest.raises(BadRequest) as exc_info:
+        http3.http_event_received(
+            HeadersReceived(
+                [
+                    (b":method", b"GET"),
+                    (b":path", b"/location\xA0"),
+                    (b":scheme", b"https"),
+                    (b":authority", b"localhost:8443"),
+                    (b"foo", b"bar"),
+                ],
+                1,
+                False,
+            )
+        )
+    assert exc_info.value.status_code == 400
+    assert str(exc_info.value) == "URL may only contain US-ASCII characters."

tests/test_app.py

@@ -293,7 +293,7 @@ def test_handle_request_with_nested_sanic_exception(
 
 
 def test_app_name_required():
-    with pytest.raises(SanicException):
+    with pytest.raises(TypeError):
         Sanic()
 
 
@@ -448,7 +448,7 @@ def test_custom_context():
 
 @pytest.mark.parametrize("use", (False, True))
 def test_uvloop_config(app: Sanic, monkeypatch, use):
-    @app.get("/test")
+    @app.get("/test", name="test")
     def handler(request):
         return text("ok")
 
@@ -571,21 +571,6 @@ def test_cannot_run_single_process_and_workers_or_auto_reload(
         app.run(single_process=True, **extra)
 
 
-def test_cannot_run_single_process_and_legacy(app: Sanic):
-    message = "Cannot run single process and legacy mode"
-    with pytest.raises(RuntimeError, match=message):
-        app.run(single_process=True, legacy=True)
-
-
-def test_cannot_run_without_sys_signals_with_workers(app: Sanic):
-    message = (
-        "Cannot run Sanic.serve with register_sys_signals=False. "
-        "Use either Sanic.serve_single or Sanic.serve_legacy."
-    )
-    with pytest.raises(RuntimeError, match=message):
-        app.run(register_sys_signals=False, single_process=False, legacy=False)
-
-
 def test_default_configure_logging():
     with patch("sanic.app.logging") as mock:
         Sanic("Test")

tests/test_asgi.py

@@ -2,13 +2,17 @@ import asyncio
 import logging
 
 from collections import deque, namedtuple
+from unittest.mock import call
 
 import pytest
 import uvicorn
 
+from httpx import Headers
+from pytest import MonkeyPatch
+
 from sanic import Sanic
 from sanic.application.state import Mode
-from sanic.asgi import ASGIApp, MockTransport
+from sanic.asgi import ASGIApp, Lifespan, MockTransport
 from sanic.exceptions import BadRequest, Forbidden, ServiceUnavailable
 from sanic.request import Request
 from sanic.response import json, text
@@ -116,10 +120,6 @@ def test_listeners_triggered(caplog):
         stop_message,
     ) not in caplog.record_tuples
 
-    all_tasks = asyncio.all_tasks(asyncio.get_event_loop())
-    for task in all_tasks:
-        task.cancel()
-
     assert before_server_start
     assert after_server_start
     assert before_server_stop
@@ -218,10 +218,6 @@ def test_listeners_triggered_async(app, caplog):
         stop_message,
     ) not in caplog.record_tuples
 
-    all_tasks = asyncio.all_tasks(asyncio.get_event_loop())
-    for task in all_tasks:
-        task.cancel()
-
     assert before_server_start
     assert after_server_start
     assert before_server_stop
@@ -272,10 +268,6 @@ def test_non_default_uvloop_config_raises_warning(app):
     with pytest.warns(UserWarning) as records:
         server.run()
 
-    all_tasks = asyncio.all_tasks(asyncio.get_event_loop())
-    for task in all_tasks:
-        task.cancel()
-
     msg = ""
     for record in records:
         _msg = str(record.message)
@@ -583,15 +575,28 @@ async def test_error_on_lifespan_exception_start(app, caplog):
     async def before_server_start(_):
         1 / 0
 
-    recv = AsyncMock(return_value={"type": "lifespan.startup"})
+    recv = AsyncMock(
+        side_effect=[
+            {"type": "lifespan.startup"},
+            {"type": "lifespan.shutdown"},
+        ]
+    )
     send = AsyncMock()
     app.asgi = True
 
+    lifespan = Lifespan(app, {"type": "lifespan"}, recv, send)
     with caplog.at_level(logging.ERROR):
-        await ASGIApp.create(app, {"type": "lifespan"}, recv, send)
+        await lifespan()
 
-    send.assert_awaited_once_with(
+    send.assert_has_calls(
-        {"type": "lifespan.startup.failed", "message": "division by zero"}
+        [
+            call(
+                {
+                    "type": "lifespan.startup.failed",
+                    "message": "division by zero",
+                }
+            )
+        ]
     )
 
 
@@ -601,13 +606,63 @@ async def test_error_on_lifespan_exception_stop(app: Sanic):
     async def before_server_stop(_):
         1 / 0
 
-    recv = AsyncMock(return_value={"type": "lifespan.shutdown"})
+    recv = AsyncMock(
+        side_effect=[
+            {"type": "lifespan.startup"},
+            {"type": "lifespan.shutdown"},
+        ]
+    )
     send = AsyncMock()
     app.asgi = True
     await app._startup()
 
-    await ASGIApp.create(app, {"type": "lifespan"}, recv, send)
+    lifespan = Lifespan(app, {"type": "lifespan"}, recv, send)
+    await lifespan()
 
-    send.assert_awaited_once_with(
+    send.assert_has_calls(
-        {"type": "lifespan.shutdown.failed", "message": "division by zero"}
+        [
+            call(
+                {
+                    "type": "lifespan.shutdown.failed",
+                    "message": "division by zero",
+                }
+            )
+        ]
     )
+
+
+@pytest.mark.asyncio
+async def test_asgi_headers_decoding(app: Sanic, monkeypatch: MonkeyPatch):
+    @app.get("/")
+    def handler(request: Request):
+        return text("")
+
+    headers_init = Headers.__init__
+
+    def mocked_headers_init(self, *args, **kwargs):
+        if "encoding" in kwargs:
+            kwargs.pop("encoding")
+        headers_init(self, encoding="utf-8", *args, **kwargs)
+
+    monkeypatch.setattr(Headers, "__init__", mocked_headers_init)
+
+    message = "Header names can only contain US-ASCII characters"
+    with pytest.raises(BadRequest, match=message):
+        _, response = await app.asgi_client.get("/", headers={"😂": "😅"})
+
+    _, response = await app.asgi_client.get("/", headers={"Test-Header": "😅"})
+    assert response.status_code == 200
+
+
+@pytest.mark.asyncio
+async def test_asgi_url_decoding(app):
+    @app.get("/dir/<name>", unquote=True)
+    def _request(request: Request, name):
+        return text(name)
+
+    # 2F should not become a path separator (unquoted later)
+    _, response = await app.asgi_client.get("/dir/some%2Fpath")
+    assert response.text == "some/path"
+
+    _, response = await app.asgi_client.get("/dir/some%F0%9F%98%80path")
+    assert response.text == "some😀path"