Allow application creation from Blueprint at startup

.black.toml

@@ -0,0 +1,2 @@
+[tool.black]
+line-length = 79

.codeclimate.yml

@@ -0,0 +1,28 @@
+exclude_patterns:
+  - "sanic/__main__.py"
+  - "sanic/application/logo.py"
+  - "sanic/application/motd.py"
+  - "sanic/reloader_helpers.py"
+  - "sanic/simple.py"
+  - "sanic/utils.py"
+  - ".github/"
+  - "changelogs/"
+  - "docker/"
+  - "docs/"
+  - "examples/"
+  - "scripts/"
+  - "tests/"
+checks:
+  argument-count:
+    enabled: false
+  file-lines:
+    config:
+      threshold: 1000
+  method-count:
+    config:
+      threshold: 40
+  complex-logic:
+    enabled: false
+  method-complexity:
+    config:
+      threshold: 10

.coveragerc

@@ -3,13 +3,13 @@ branch = True
 source = sanic
 omit =
     site-packages
+    sanic/application/logo.py
+    sanic/application/motd.py
+    sanic/cli
     sanic/__main__.py
-    sanic/server/legacy.py
+    sanic/reloader_helpers.py
-    sanic/compat.py
     sanic/simple.py
     sanic/utils.py
-    sanic/cli
-    sanic/pages
 
 [html]
 directory = coverage
@@ -21,5 +21,3 @@ exclude_lines =
     noqa
     NOQA
     pragma: no cover
-    TYPE_CHECKING
-skip_empty = True

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,78 +0,0 @@
-name: 🐞 Bug report
-description: Create a report to help us improve
-labels: ["bug", "triage"]
-body:
-  - type: checkboxes
-    id: existing
-    attributes:
-      label: Is there an existing issue for this?
-      description: Please search to see if an issue already exists for the bug you encountered.
-      options:
-      - label: I have searched the existing issues
-        required: true
-  - type: textarea
-    id: description
-    attributes:
-      label: Describe the bug
-      description: A clear and concise description of what the bug is, make sure to paste any exceptions and tracebacks using markdown code-block syntax to make it easier to read.
-    validations:
-      required: true
-  - type: textarea
-    id: code
-    attributes:
-      label: Code snippet
-      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
-    id: expected
-    attributes:
-      label: Expected Behavior
-      description: A concise description of what you expected to happen.
-    validations:
-      required: false
-  - type: dropdown
-    id: running
-    attributes:
-      label: How do you run Sanic?
-      options:
-        - Sanic CLI
-        - As a module
-        - As a script (`app.run` or `Sanic.serve`)
-        - ASGI
-    validations:
-      required: true
-  - 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
-    id: version
-    attributes:
-      label: Sanic Version
-      description: Check startup logs or try `sanic --version`
-    validations:
-      required: true
-  - type: textarea
-    id: additional
-    attributes:
-      label: Additional context
-      description: Add any other context about the problem here.
-    validations:
-      required: false
-

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is, make sure to paste any exceptions and tracebacks.
+
+
+**Code snippet**
+Relevant source code, make sure to remove what is not necessary.
+
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+
+**Environment (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Version [e.g. 0.8.3]
+
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,5 @@
-blank_issues_enabled: false
+blank_issues_enabled: true
 contact_links:
   - name: Questions and Help
     url: https://community.sanicframework.org/c/questions-and-help
     about: Do you need help with Sanic? Ask your questions here.
-  - name: Discussion and Support
-    url: https://discord.gg/FARQzAEMAA
-    about: For live discussion and support, checkout the Sanic Discord server.

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,34 +0,0 @@
-name: 🌟 Feature request
-description: Suggest an enhancement for Sanic
-labels: ["feature request"]
-body:
-  - type: checkboxes
-    id: existing
-    attributes:
-      label: Is there an existing issue for this?
-      description: Please search to see if an issue already exists for the enhancement you are proposing.
-      options:
-      - label: I have searched the existing issues
-        required: true
-  - type: textarea
-    id: description
-    attributes:
-      label: Is your feature request related to a problem? Please describe.
-      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-    validations:
-      required: false
-  - type: textarea
-    id: code
-    attributes:
-      label: Describe the solution you'd like
-      description: A clear and concise description of what you want to happen.
-    validations:
-      required: true
-  - type: textarea
-    id: additional
-    attributes:
-      label: Additional context
-      description: Add any other context about the problem here.
-    validations:
-      required: false
-

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Suggest an idea for Sanic
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+
+**Additional context**
+Add any other context or sample code about the feature request here.

.github/ISSUE_TEMPLATE/rfc.yml

@@ -1,33 +0,0 @@
-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

@@ -2,15 +2,9 @@ name: "CodeQL"
 
 on:
   push:
-    branches:
+    branches: [ main ]
-      - main
-      - current-release
-      - "*LTS"
   pull_request:
-    branches:
+    branches: [ main ]
-      - main
-      - current-release
-      - "*LTS"
     types: [opened, synchronize, reopened, ready_for_review]
   schedule:
     - cron: '25 16 * * 0'

.github/workflows/coverage.yml

@@ -3,32 +3,34 @@ on:
   push:
     branches:
       - main
-      - current-release
-      - "*LTS"
     tags:
       - "!*" # Do not execute on tags
   pull_request:
-    branches:
+    types: [opened, synchronize, reopened, ready_for_review]
-      - main
-      - current-release
-      - "*LTS"
-
 jobs:
-  coverage:
+  test:
-    name: Check coverage
+    if: github.event.pull_request.draft == false
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
+      matrix:
+        python-version: [3.9]
+        os: [ubuntu-latest]
       fail-fast: false
 
     steps:
-      - name: Run coverage
+      - uses: actions/checkout@v2
-        uses: sanic-org/simple-tox-action@v1
+
+      - uses: actions/setup-python@v1
         with:
-          python-version: "3.11"
+          python-version: ${{ matrix.python-version }}
-          tox-env: coverage
+
-          ignore-errors: true
+      - name: Install dependencies 🔨
-      - name: Run Codecov
+        run: |
-        uses: codecov/codecov-action@v3
+          python -m pip install --upgrade pip
+          pip install tox
+      - uses: paambaati/codeclimate-action@v2.5.3
+        if: always()
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CODECLIMATE }}
         with:
-          files: ./coverage.xml
+          coverageCommand: tox -e coverage
-          fail_ci_if_error: false

.github/workflows/on-demand.yml

@@ -0,0 +1,39 @@
+name: On Demand Task
+on:
+  workflow_dispatch:
+    inputs:
+      python-version:
+        description: 'Version of Python to use for running Test'
+        required: false
+        default: "3.8"
+      tox-env:
+        description: 'Test Environment to Run'
+        required: true
+        default: ''
+      os:
+        description: 'Operating System to Run Test on'
+        required: false
+        default: ubuntu-latest
+jobs:
+  onDemand:
+    name: tox-${{ matrix.config.tox-env }}-on-${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["${{ github.event.inputs.os}}"]
+        config:
+          - { tox-env: "${{ github.event.inputs.tox-env }}", py-version: "${{ github.event.inputs.python-version }}"}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Run tests
+        uses: harshanarayana/custom-actions@main
+        with:
+          python-version: ${{ matrix.config.py-version }}
+          test-infra-tool: tox
+          test-infra-version: latest
+          action: tests
+          test-additional-args: "-e=${{ matrix.config.tox-env }}"
+          experimental-ignore-error: "yes"

.github/workflows/pr-bandit.yml

@@ -0,0 +1,35 @@
+name: Security Analysis
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  bandit:
+    if: github.event.pull_request.draft == false
+    name: type-check-${{ matrix.config.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      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}
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+        id: checkout-branch
+
+      - name: Run Linter Checks
+        id: linter-check
+        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 }}"

.github/workflows/pr-docs.yml

@@ -0,0 +1,31 @@
+name: Document Linter
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  docsLinter:
+    if: github.event.pull_request.draft == false
+    name: Lint Documentation
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        config:
+          - {python-version: "3.8", tox-env: "docs"}
+      fail-fast: false
+
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Run Document Linter
+        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 }}"

.github/workflows/pr-linter.yml

@@ -0,0 +1,32 @@
+name: Linter Checks
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  linter:
+    if: github.event.pull_request.draft == false
+    name: lint
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        config:
+          - { python-version: 3.8, tox-env: lint}
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+        id: checkout-branch
+
+      - name: Run Linter Checks
+        id: linter-check
+        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 }}"

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

@@ -0,0 +1,41 @@
+name: Python PyPy Tests
+on:
+  workflow_dispatch:
+    inputs:
+      tox-env:
+        description: "Tox Env to run on the PyPy Infra"
+        required: false
+        default: "pypy37"
+      pypy-version:
+        description: "Version of PyPy to use"
+        required: false
+        default: "pypy-3.7"
+jobs:
+  testPyPy:
+    name: ut-${{ matrix.config.tox-env }}-${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest]
+        config:
+          - {
+              python-version: "${{ github.event.inputs.pypy-version }}",
+              tox-env: "${{ github.event.inputs.tox-env }}",
+            }
+    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 }}"
+          experimental-ignore-error: "true"
+          command-timeout: "600000"

.github/workflows/pr-python310.yml

@@ -0,0 +1,46 @@
+name: Python 3.10 Tests
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  testPy310:
+    if: github.event.pull_request.draft == false
+    name: ut-${{ matrix.config.tox-env }}-${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest]
+        config:
+          - {
+              python-version: "3.10",
+              tox-env: py310,
+              ignore-error-flake: "false",
+              command-timeout: "0",
+            }
+          - {
+              python-version: "3.10",
+              tox-env: py310-no-ext,
+              ignore-error-flake: "true",
+              command-timeout: "600000",
+            }
+    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 }},-vv=''"
+          experimental-ignore-error: "${{ matrix.config.ignore-error-flake }}"
+          command-timeout: "${{ matrix.config.command-timeout }}"
+          test-failure-retry: "3"

.github/workflows/pr-python37.yml

@@ -0,0 +1,34 @@
+name: Python 3.7 Tests
+on:
+  pull_request:
+    branches:
+      - main
+    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

@@ -0,0 +1,34 @@
+name: Python 3.8 Tests
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  testPy38:
+    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.8, tox-env: py38 }
+          - { python-version: 3.8, tox-env: py38-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-python39.yml

@@ -0,0 +1,46 @@
+name: Python 3.9 Tests
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  testPy39:
+    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.9,
+              tox-env: py39,
+              ignore-error-flake: "false",
+              command-timeout: "0",
+            }
+          - {
+              python-version: 3.9,
+              tox-env: py39-no-ext,
+              ignore-error-flake: "true",
+              command-timeout: "600000",
+            }
+    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 }},-vv=''"
+          experimental-ignore-error: "${{ matrix.config.ignore-error-flake }}"
+          command-timeout: "${{ matrix.config.command-timeout }}"
+          test-failure-retry: "3"

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

@@ -0,0 +1,35 @@
+name: Typing Checks
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  typeChecking:
+    if: github.event.pull_request.draft == false
+    name: type-check-${{ matrix.config.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      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}
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+        id: checkout-branch
+
+      - name: Run Linter Checks
+        id: linter-check
+        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 }}"

.github/workflows/pr-windows.yml

@@ -0,0 +1,37 @@
+name: Run Unit Tests on Windows
+on:
+  pull_request:
+    branches:
+      - main
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  testsOnWindows:
+    if: github.event.pull_request.draft == false
+    name: ut-${{ matrix.config.tox-env }}
+    runs-on: windows-latest
+    strategy:
+      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: pypy-3.7, tox-env: pypy37-no-ext }
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Run Unit Tests
+        uses: ahopkins/custom-actions@pip-extra-args
+        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 }}"
+          experimental-ignore-error: "true"
+          command-timeout: "600000"
+          pip-extra-args: "--user"

.github/workflows/publish-images.yml

@@ -0,0 +1,48 @@
+name: Publish Docker Images
+on:
+  workflow_run:
+    workflows:
+      - 'Publish Artifacts'
+    types:
+      - completed
+
+jobs:
+  publishDockerImages:
+    name: Docker Image Build [${{ matrix.python-version }}]
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Build Latest Base images for ${{ matrix.python-version }}
+        uses: harshanarayana/custom-actions@main
+        with:
+          docker-image-base-name: sanicframework/sanic-build
+          ignore-python-setup: 'true'
+          dockerfile-base-dir: './docker'
+          action: 'image-publish'
+          docker-image-tag: "${{ matrix.python-version }}"
+          docker-file-suffix: "base"
+          docker-build-args: "PYTHON_VERSION=${{ matrix.python-version }}"
+          registry-auth-user: ${{ secrets.DOCKER_ACCESS_USER }}
+          registry-auth-password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
+          push-images: 'true'
+
+      - name: Publish Sanic Docker Image for ${{ matrix.python-version }}
+        uses: harshanarayana/custom-actions@main
+        with:
+          docker-image-base-name: sanicframework/sanic
+          ignore-python-setup: 'true'
+          dockerfile-base-dir: './docker'
+          action: 'image-publish'
+          docker-build-args: "BASE_IMAGE_TAG=${{ matrix.python-version }}"
+          docker-image-prefix: "${{ matrix.python-version }}"
+          registry-auth-user: ${{ secrets.DOCKER_ACCESS_USER }}
+          registry-auth-password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
+          push-images: 'true'

.github/workflows/publish-package.yml

@@ -0,0 +1,28 @@
+name: Publish Artifacts
+on:
+  release:
+    types: [created]
+
+jobs:
+  publishPythonPackage:
+    name: Publishing Sanic Release Artifacts
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.8"]
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Publish Python Package
+        uses: harshanarayana/custom-actions@main
+        with:
+          python-version: ${{ matrix.python-version }}
+          package-infra-name: "twine"
+          pypi-user: __token__
+          pypi-access-token: ${{ secrets.PYPI_ACCESS_TOKEN }}
+          action: "package-publish"
+          pypi-verify-metadata: "true"

.github/workflows/publish-release.yml

@@ -1,174 +0,0 @@
-name: Publish release
-
-on:
-  release:
-    types: [created]
-
-env:
-  IS_TEST: false
-  DOCKER_ORG_NAME: sanicframework
-  DOCKER_IMAGE_NAME: sanic
-  DOCKER_BASE_IMAGE_NAME: sanic-build
-  DOCKER_IMAGE_DOCKERFILE: ./docker/Dockerfile
-  DOCKER_BASE_IMAGE_DOCKERFILE: ./docker/Dockerfile-base
-
-jobs:
-  generate_info:
-    name: Generate info
-    runs-on: ubuntu-latest
-    outputs:
-      docker-tags: ${{ steps.generate_docker_info.outputs.tags }}
-      pypi-version: ${{ steps.parse_version_tag.outputs.pypi-version }}
-    steps:
-      - name: Parse version tag
-        id: parse_version_tag
-        env:
-          TAG_NAME: ${{ github.event.release.tag_name }}
-        run: |
-          tag_name="${{ env.TAG_NAME }}"
-
-          if [[ ! "${tag_name}" =~ ^v([0-9]{2})\.([0-9]{1,2})\.([0-9]+)$ ]]; then
-            echo "::error::Tag name must be in the format vYY.MM.MICRO"
-            exit 1
-          fi
-
-          year_output="year=${BASH_REMATCH[1]}"
-          month_output="month=${BASH_REMATCH[2]}"
-          pypi_output="pypi-version=${tag_name#v}"
-
-          echo "${year_output}"
-          echo "${month_output}"
-          echo "${pypi_output}"
-
-          echo "${year_output}" >> $GITHUB_OUTPUT
-          echo "${month_output}" >> $GITHUB_OUTPUT
-          echo "${pypi_output}" >> $GITHUB_OUTPUT
-
-      - name: Get latest release
-        id: get_latest_release
-        run: |
-          latest_tag=$(
-            curl -L \
-              -H "Accept: application/vnd.github+json" \
-              -H "Authorization: Bearer ${{ github.token }}" \
-              -H "X-GitHub-Api-Version: 2022-11-28" \
-              https://api.github.com/repos/${{ github.repository }}/releases/latest \
-              | jq -r '.tag_name'
-          )
-          echo "latest_tag=$latest_tag" >> $GITHUB_OUTPUT
-
-      - name: Generate Docker info
-        id: generate_docker_info
-        run: |
-          tag_year="${{ steps.parse_version_tag.outputs.year }}"
-          tag_month="${{ steps.parse_version_tag.outputs.month }}"
-          latest_tag="${{ steps.get_latest_release.outputs.latest_tag }}"
-          tag="${{ github.event.release.tag_name }}"
-
-          tags="${tag_year}.${tag_month}"
-
-          if [[ "${tag_month}" == "12" ]]; then
-            tags+=",LTS"
-            echo "::notice::Tag ${tag} is LTS version"
-          else
-            echo "::notice::Tag ${tag} is not LTS version"
-          fi
-
-          if [[ "${latest_tag}" == "${{ github.event.release.tag_name }}" ]]; then
-            tags+=",latest"
-            echo "::notice::Tag ${tag} is marked as latest"
-          else
-            echo "::notice::Tag ${tag} is not marked as latest"
-          fi
-
-          tags_output="tags=${tags}"
-
-          echo "${tags_output}"
-          echo "${tags_output}" >> $GITHUB_OUTPUT
-
-  publish_package:
-    name: Build and publish package
-    runs-on: ubuntu-latest
-    needs: generate_info
-    steps:
-    - name: Checkout repo
-      uses: actions/checkout@v3
-
-    - name: Setup Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.11"
-
-    - name: Install dependencies
-      run: pip install build twine
-
-    - name: Update package version
-      run: |
-        echo "__version__ = \"${{ needs.generate_info.outputs.pypi-version }}\"" > sanic/__version__.py
-
-    - name: Build a binary wheel and a source tarball
-      run: python -m build --sdist --wheel --outdir dist/ .
-
-    - name: Publish to PyPi 🚀
-      run: twine upload --non-interactive --disable-progress-bar dist/*
-      env:
-        TWINE_USERNAME: __token__
-        TWINE_PASSWORD: ${{ env.IS_TEST == 'true' && secrets.SANIC_TEST_PYPI_API_TOKEN || secrets.SANIC_PYPI_API_TOKEN }}
-        TWINE_REPOSITORY: ${{ env.IS_TEST == 'true' && 'testpypi' || 'pypi' }}
-
-  publish_docker:
-    name: Publish Docker / Python ${{ matrix.python-version }}
-    needs: [generate_info, publish_package]
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: true
-      matrix:
-        python-version: ["3.10", "3.11"]
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKER_ACCESS_USER }}
-          password: ${{ secrets.DOCKER_ACCESS_TOKEN }}
-
-      - name: Build and push base image
-        uses: docker/build-push-action@v4
-        with:
-          push: ${{ env.IS_TEST == 'false' }}
-          file: ${{ env.DOCKER_BASE_IMAGE_DOCKERFILE }}
-          tags: ${{ env.DOCKER_ORG_NAME }}/${{ env.DOCKER_BASE_IMAGE_NAME }}:${{ matrix.python-version }}
-          build-args: |
-            PYTHON_VERSION=${{ matrix.python-version }}
-
-      - name: Parse tags for this Python version
-        id: parse_tags
-        run: |
-          IFS=',' read -ra tags <<< "${{ needs.generate_info.outputs.docker-tags }}"
-          tag_args=""
-
-          for tag in "${tags[@]}"; do
-              tag_args+=",${{ env.DOCKER_ORG_NAME }}/${{ env.DOCKER_IMAGE_NAME }}:${tag}-py${{ matrix.python-version }}"
-          done
-
-          tag_args_output="tag_args=${tag_args:1}"
-
-          echo "${tag_args_output}"
-          echo "${tag_args_output}" >> $GITHUB_OUTPUT
-
-      - name: Build and push Sanic image
-        uses: docker/build-push-action@v4
-        with:
-          push: ${{ env.IS_TEST == 'false' }}
-          file: ${{ env.DOCKER_IMAGE_DOCKERFILE }}
-          tags: ${{ steps.parse_tags.outputs.tag_args }}
-          build-args: |
-            BASE_IMAGE_ORG=${{ env.DOCKER_ORG_NAME }}
-            BASE_IMAGE_NAME=${{ env.DOCKER_BASE_IMAGE_NAME }}
-            BASE_IMAGE_TAG=${{ matrix.python-version }}
-            SANIC_PYPI_VERSION=${{ needs.generate_info.outputs.pypi-version }}

.github/workflows/tests.yml

@@ -1,56 +0,0 @@
-name: Tests
-
-on:
-  push:
-    branches:
-      - main
-      - current-release
-      - "*LTS"
-    tags:
-      - "!*"
-  pull_request:
-    branches:
-      - main
-      - current-release
-      - "*LTS"
-    types: [opened, synchronize, reopened, ready_for_review]
-
-jobs:
-  run_tests:
-    name: "${{ matrix.config.platform == 'windows-latest' && 'Windows' || 'Linux' }} / Python ${{ matrix.config.python-version }} / tox -e ${{ matrix.config.tox-env }}"
-    if: github.event.pull_request.draft == false
-    runs-on: ${{ matrix.config.platform || 'ubuntu-latest' }}
-    strategy:
-      fail-fast: true
-      matrix:
-        config:
-          - { python-version: "3.8",  tox-env: security }
-          - { python-version: "3.9",  tox-env: security }
-          - { python-version: "3.10", tox-env: security }
-          - { python-version: "3.11", tox-env: security }
-          - { python-version: "3.10", tox-env: lint }
-          # - { python-version: "3.10", tox-env: docs }
-          - { python-version: "3.8",  tox-env: type-checking }
-          - { python-version: "3.9",  tox-env: type-checking }
-          - { python-version: "3.10", tox-env: type-checking }
-          - { python-version: "3.11", tox-env: type-checking }
-          - { python-version: "3.8",  tox-env: py38,          max-attempts: 3 }
-          - { python-version: "3.8",  tox-env: py38-no-ext,   max-attempts: 3 }
-          - { python-version: "3.9",  tox-env: py39,          max-attempts: 3 }
-          - { python-version: "3.9",  tox-env: py39-no-ext,   max-attempts: 3 }
-          - { python-version: "3.10", tox-env: py310,         max-attempts: 3 }
-          - { python-version: "3.10", tox-env: py310-no-ext,  max-attempts: 3 }
-          - { python-version: "3.11", tox-env: py311,         max-attempts: 3 }
-          - { python-version: "3.11", tox-env: py311-no-ext,  max-attempts: 3 }
-          - { python-version: "3.8",  tox-env: py38-no-ext,   platform: windows-latest, ignore-errors: true }
-          - { python-version: "3.9",  tox-env: py39-no-ext,   platform: windows-latest, ignore-errors: true }
-          - { python-version: "3.10", tox-env: py310-no-ext,  platform: windows-latest, ignore-errors: true }
-          - { python-version: "3.11", tox-env: py310-no-ext,  platform: windows-latest, ignore-errors: true }
-    steps:
-      - name: Run tests
-        uses: sanic-org/simple-tox-action@v1
-        with:
-          python-version: ${{ matrix.config.python-version }}
-          tox-env: ${{ matrix.config.tox-env }}
-          max-attempts: ${{ matrix.config.max-attempts || 1 }}
-          ignore-errors: ${{ matrix.config.ignore-errors || false }}

.gitignore

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

CHANGELOG.rst

@@ -1,12 +1,12 @@
 .. note::
 
-  CHANGELOG files are maintained in ``./docs/sanic/releases``. To view the full CHANGELOG, please visit https://sanic.readthedocs.io/en/stable/sanic/changelog.html.
+  From v21.9, CHANGELOG files are maintained in ``./docs/sanic/releases``
-
 
 Version 21.6.1
 --------------
 
-**Bugfixes**
+Bugfixes
+********
 
   * `#2178 <https://github.com/sanic-org/sanic/pull/2178>`_
     Update sanic-routing to allow for better splitting of complex URI templates
@@ -20,7 +20,8 @@ Version 21.6.1
 Version 21.6.0
 --------------
 
-**Features**
+Features
+********
 
   * `#2094 <https://github.com/sanic-org/sanic/pull/2094>`_
     Add ``response.eof()`` method for closing a stream in a handler
@@ -67,7 +68,8 @@ Version 21.6.0
   * `#2170 <https://github.com/sanic-org/sanic/pull/2170>`_
     Additional methods for attaching ``HTTPMethodView``
 
-**Bugfixes**
+Bugfixes
+********
 
   * `#2091 <https://github.com/sanic-org/sanic/pull/2091>`_
     Fix ``UserWarning`` in ASGI mode for missing ``__slots__``
@@ -83,7 +85,8 @@ Version 21.6.0
     Fix issue where Blueprint exception handlers do not consistently route to proper handler
 
 
-**Deprecations and Removals**
+Deprecations and Removals
+*************************
 
   * `#2156 <https://github.com/sanic-org/sanic/pull/2156>`_
     Remove config value ``REQUEST_BUFFER_QUEUE_SIZE``
@@ -92,12 +95,14 @@ Version 21.6.0
   * `#2172 <https://github.com/sanic-org/sanic/pull/2170>`_
     Deprecate StreamingHTTPResponse
 
-**Developer infrastructure**
+Developer infrastructure
+************************
 
   * `#2149 <https://github.com/sanic-org/sanic/pull/2149>`_
     Remove Travis CI in favor of GitHub Actions
 
-**Improved Documentation**
+Improved Documentation
+**********************
 
   * `#2164 <https://github.com/sanic-org/sanic/pull/2164>`_
     Fix typo in documentation
@@ -107,7 +112,8 @@ Version 21.6.0
 Version 21.3.2
 --------------
 
-**Bugfixes**
+Bugfixes
+********
 
   * `#2081 <https://github.com/sanic-org/sanic/pull/2081>`_
     Disable response timeout on websocket connections
@@ -118,7 +124,8 @@ Version 21.3.2
 Version 21.3.1
 --------------
 
-**Bugfixes**
+Bugfixes
+********
 
   * `#2076 <https://github.com/sanic-org/sanic/pull/2076>`_
     Static files inside subfolders are not accessible (404)
@@ -128,7 +135,8 @@ Version 21.3.0
 
 `Release Notes <https://sanicframework.org/en/guide/release-notes/v21.3.html>`_
 
-**Features**
+Features
+********
 
   *
     `#1876 <https://github.com/sanic-org/sanic/pull/1876>`_
@@ -181,7 +189,8 @@ Version 21.3.0
     `#2063 <https://github.com/sanic-org/sanic/pull/2063>`_
     App and connection level context objects
 
-**Bugfixes**
+Bugfixes and issues resolved
+****************************
 
   * Resolve `#1420 <https://github.com/sanic-org/sanic/pull/1420>`_
     ``url_for`` where ``strict_slashes`` are on for a path ending in ``/``
@@ -211,7 +220,8 @@ Version 21.3.0
     `#2001 <https://github.com/sanic-org/sanic/pull/2001>`_
     Raise ValueError when cookie max-age is not an integer
 
-**Deprecations and Removals**
+Deprecations and Removals
+*************************
 
   *
     `#2007 <https://github.com/sanic-org/sanic/pull/2007>`_
@@ -230,7 +240,8 @@ Version 21.3.0
   * ``Request.endpoint`` deprecated in favor of ``Request.name``
   * handler type name prefixes removed (static, websocket, etc)
 
-**Developer infrastructure**
+Developer infrastructure
+************************
 
   *
     `#1995 <https://github.com/sanic-org/sanic/pull/1995>`_
@@ -248,7 +259,8 @@ Version 21.3.0
     `#2049 <https://github.com/sanic-org/sanic/pull/2049>`_
     Updated setup.py to use ``find_packages``
 
-**Improved Documentation**
+Improved Documentation
+**********************
 
   *
     `#1218 <https://github.com/sanic-org/sanic/pull/1218>`_
@@ -270,7 +282,8 @@ Version 21.3.0
     `#2052 <https://github.com/sanic-org/sanic/pull/2052>`_
     Fix some examples and docs
 
-**Miscellaneous**
+Miscellaneous
+*************
 
   * ``Request.route`` property
   * Better websocket subprotocols support
@@ -316,7 +329,8 @@ Version 21.3.0
 Version 20.12.3
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#2021 <https://github.com/sanic-org/sanic/pull/2021>`_
@@ -325,7 +339,8 @@ Version 20.12.3
 Version 20.12.2
 ---------------
 
-**Dependencies**
+Dependencies
+************
 
   *
     `#2026 <https://github.com/sanic-org/sanic/pull/2026>`_
@@ -338,7 +353,8 @@ Version 20.12.2
 Version 19.12.5
 ---------------
 
-**Dependencies**
+Dependencies
+************
 
   *
     `#2025 <https://github.com/sanic-org/sanic/pull/2025>`_
@@ -351,12 +367,19 @@ Version 19.12.5
 Version 20.12.0
 ---------------
 
-**Features**
+Features
+********
 
   *
     `#1993 <https://github.com/sanic-org/sanic/pull/1993>`_
     Add disable app registry
 
+Version 20.12.0
+---------------
+
+Features
+********
+
   *
     `#1945 <https://github.com/sanic-org/sanic/pull/1945>`_
     Static route more verbose if file not found
@@ -393,19 +416,22 @@ Version 20.12.0
     `#1979 <https://github.com/sanic-org/sanic/pull/1979>`_
     Add app registry and Sanic class level app retrieval
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1965 <https://github.com/sanic-org/sanic/pull/1965>`_
     Fix Chunked Transport-Encoding in ASGI streaming response
 
-**Deprecations and Removals**
+Deprecations and Removals
+*************************
 
   *
     `#1981 <https://github.com/sanic-org/sanic/pull/1981>`_
     Cleanup and remove deprecated code
 
-**Developer infrastructure**
+Developer infrastructure
+************************
 
   *
     `#1956 <https://github.com/sanic-org/sanic/pull/1956>`_
@@ -419,7 +445,8 @@ Version 20.12.0
     `#1986 <https://github.com/sanic-org/sanic/pull/1986>`_
     Update tox requirements
 
-**Improved Documentation**
+Improved Documentation
+**********************
 
   *
     `#1951 <https://github.com/sanic-org/sanic/pull/1951>`_
@@ -437,7 +464,8 @@ Version 20.12.0
 Version 20.9.1
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1954 <https://github.com/sanic-org/sanic/pull/1954>`_
@@ -450,7 +478,8 @@ Version 20.9.1
 Version 19.12.3
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1959 <https://github.com/sanic-org/sanic/pull/1959>`_
@@ -461,7 +490,8 @@ Version 20.9.0
 ---------------
 
 
-**Features**
+Features
+********
 
   *
     `#1887 <https://github.com/sanic-org/sanic/pull/1887>`_
@@ -488,19 +518,22 @@ Version 20.9.0
     `#1937 <https://github.com/sanic-org/sanic/pull/1937>`_
     Added auto, text, and json fallback error handlers (in v21.3, the default will change form html to auto)
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1897 <https://github.com/sanic-org/sanic/pull/1897>`_
     Resolves exception from unread bytes in stream
 
-**Deprecations and Removals**
+Deprecations and Removals
+*************************
 
   *
     `#1903 <https://github.com/sanic-org/sanic/pull/1903>`_
     config.from_envar, config.from_pyfile, and config.from_object are deprecated and set to be removed in v21.3
 
-**Developer infrastructure**
+Developer infrastructure
+************************
 
   *
     `#1890 <https://github.com/sanic-org/sanic/pull/1890>`_,
@@ -515,7 +548,8 @@ Version 20.9.0
     `#1924 <https://github.com/sanic-org/sanic/pull/1924>`_
     Adding --strict-markers for pytest
 
-**Improved Documentation**
+Improved Documentation
+**********************
 
   *
     `#1922 <https://github.com/sanic-org/sanic/pull/1922>`_
@@ -525,7 +559,8 @@ Version 20.9.0
 Version 20.6.3
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1884 <https://github.com/sanic-org/sanic/pull/1884>`_
@@ -535,7 +570,8 @@ Version 20.6.3
 Version 20.6.2
 ---------------
 
-**Features**
+Features
+********
 
   *
     `#1641 <https://github.com/sanic-org/sanic/pull/1641>`_
@@ -545,7 +581,8 @@ Version 20.6.2
 Version 20.6.1
 ---------------
 
-**Features**
+Features
+********
 
   *
     `#1760 <https://github.com/sanic-org/sanic/pull/1760>`_
@@ -559,7 +596,8 @@ Version 20.6.1
     `#1880 <https://github.com/sanic-org/sanic/pull/1880>`_
     Add handler names for websockets for url_for usage
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1776 <https://github.com/sanic-org/sanic/pull/1776>`_
@@ -581,13 +619,15 @@ Version 20.6.1
     `#1853 <https://github.com/sanic-org/sanic/pull/1853>`_
     Fix pickle error when attempting to pickle an application which contains websocket routes
 
-**Deprecations and Removals**
+Deprecations and Removals
+*************************
 
   *
     `#1739 <https://github.com/sanic-org/sanic/pull/1739>`_
     Deprecate body_bytes to merge into body
 
-**Developer infrastructure**
+Developer infrastructure
+************************
 
   *
     `#1852 <https://github.com/sanic-org/sanic/pull/1852>`_
@@ -602,7 +642,8 @@ Version 20.6.1
     Wrap run()'s "protocol" type annotation in Optional[]
 
 
-**Improved Documentation**
+Improved Documentation
+**********************
 
   *
     `#1846 <https://github.com/sanic-org/sanic/pull/1846>`_
@@ -622,7 +663,8 @@ Version 20.6.0
 Version 20.3.0
 ---------------
 
-**Features**
+Features
+********
 
   *
     `#1762 <https://github.com/sanic-org/sanic/pull/1762>`_
@@ -653,7 +695,8 @@ Version 20.3.0
     `#1820 <https://github.com/sanic-org/sanic/pull/1820>`_
     Do not set content-type and content-length headers in exceptions
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1748 <https://github.com/sanic-org/sanic/pull/1748>`_
@@ -671,7 +714,8 @@ Version 20.3.0
     `#1808 <https://github.com/sanic-org/sanic/pull/1808>`_
      Fix Ctrl+C and tests on Windows
 
-**Deprecations and Removals**
+Deprecations and Removals
+*************************
 
   *
     `#1800 <https://github.com/sanic-org/sanic/pull/1800>`_
@@ -689,7 +733,8 @@ Version 20.3.0
     `#1818 <https://github.com/sanic-org/sanic/pull/1818>`_
     Complete deprecation of ``app.remove_route`` and ``request.raw_args``
 
-**Dependencies**
+Dependencies
+************
 
   *
     `#1794 <https://github.com/sanic-org/sanic/pull/1794>`_
@@ -699,13 +744,15 @@ Version 20.3.0
     `#1806 <https://github.com/sanic-org/sanic/pull/1806>`_
     Import ``ASGIDispatch`` from top-level ``httpx`` (from third-party deprecation)
 
-**Developer infrastructure**
+Developer infrastructure
+************************
 
   *
     `#1833 <https://github.com/sanic-org/sanic/pull/1833>`_
     Resolve broken documentation builds
 
-**Improved Documentation**
+Improved Documentation
+**********************
 
   *
     `#1755 <https://github.com/sanic-org/sanic/pull/1755>`_
@@ -747,7 +794,8 @@ Version 20.3.0
 Version 19.12.0
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
 - Fix blueprint middleware application
 
@@ -766,7 +814,8 @@ Version 19.12.0
   due to an `AttributeError`. This fix makes the availability of `SERVER_NAME` on our `app.config` an optional behavior. (`#1707 <https://github.com/sanic-org/sanic/issues/1707>`__)
 
 
-**Improved Documentation**
+Improved Documentation
+**********************
 
 - Move docs from MD to RST
 
@@ -780,7 +829,8 @@ Version 19.12.0
 Version 19.6.3
 --------------
 
-**Features**
+Features
+********
 
 - Enable Towncrier Support
 
@@ -788,7 +838,8 @@ Version 19.6.3
   of generating and managing change logs as part of each of pull requests. (`#1631 <https://github.com/sanic-org/sanic/issues/1631>`__)
 
 
-**Improved Documentation**
+Improved Documentation
+**********************
 
 - Documentation infrastructure changes
 
@@ -801,7 +852,8 @@ Version 19.6.3
 Version 19.6.2
 --------------
 
-**Features**
+Features
+********
 
   *
     `#1562 <https://github.com/sanic-org/sanic/pull/1562>`_
@@ -817,7 +869,8 @@ Version 19.6.2
     Add Configure support from object string
 
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1587 <https://github.com/sanic-org/sanic/pull/1587>`_
@@ -835,7 +888,8 @@ Version 19.6.2
     `#1594 <https://github.com/sanic-org/sanic/pull/1594>`_
     Strict Slashes behavior fix
 
-**Deprecations and Removals**
+Deprecations and Removals
+*************************
 
   *
     `#1544 <https://github.com/sanic-org/sanic/pull/1544>`_
@@ -859,7 +913,8 @@ Version 19.6.2
 Version 19.3
 ------------
 
-**Features**
+Features
+********
 
   *
     `#1497 <https://github.com/sanic-org/sanic/pull/1497>`_
@@ -927,7 +982,8 @@ Version 19.3
 
     This is a breaking change.
 
-**Bugfixes**
+Bugfixes
+********
 
 
   *
@@ -963,7 +1019,8 @@ Version 19.3
     This allows the access log to be disabled for example when running via
     gunicorn.
 
-**Developer infrastructure**
+Developer infrastructure
+************************
 
   * `#1529 <https://github.com/sanic-org/sanic/pull/1529>`_ Update project PyPI credentials
   * `#1515 <https://github.com/sanic-org/sanic/pull/1515>`_ fix linter issue causing travis build failures (fix #1514)
@@ -971,7 +1028,8 @@ Version 19.3
   * `#1478 <https://github.com/sanic-org/sanic/pull/1478>`_ Upgrade setuptools version and use native docutils in doc build
   * `#1464 <https://github.com/sanic-org/sanic/pull/1464>`_ Upgrade pytest, and fix caplog unit tests
 
-**Improved Documentation**
+Improved Documentation
+**********************
 
   * `#1516 <https://github.com/sanic-org/sanic/pull/1516>`_ Fix typo at the exception documentation
   * `#1510 <https://github.com/sanic-org/sanic/pull/1510>`_ fix typo in Asyncio example
@@ -1038,13 +1096,15 @@ Version 18.12
 Version 0.8
 -----------
 
-**0.8.3**
+0.8.3
+*****
 
 * Changes:
 
   * Ownership changed to org 'sanic-org'
 
-**0.8.0**
+0.8.0
+*****
 
 * Changes:
 
@@ -1124,16 +1184,19 @@ Version 0.1
 -----------
 
 
-**0.1.7**
+0.1.7
+*****
 
   * Reversed static url and directory arguments to meet spec
 
-**0.1.6**
+0.1.6
+*****
 
   * Static files
   * Lazy Cookie Loading
 
-**0.1.5**
+0.1.5
+*****
 
   * Cookies
   * Blueprint listeners and ordering
@@ -1141,19 +1204,23 @@ Version 0.1
   * Fix: Incomplete file reads on medium+ sized post requests
   * Breaking: after_start and before_stop now pass sanic as their first argument
 
-**0.1.4**
+0.1.4
+*****
 
   * Multiprocessing
 
-**0.1.3**
+0.1.3
+*****
 
   * Blueprint support
   * Faster Response processing
 
-**0.1.1 - 0.1.2**
+0.1.1 - 0.1.2
+*************
 
   * Struggling to update pypi via CI
 
-**0.1.0**
+0.1.0
+*****
 
   * Released to public

CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at adam@sanicframework.org. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at adam@sanicframework.org. All
+reported by contacting the project team at sanic-maintainers@googlegroups.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

CONTRIBUTING.rst

@@ -71,9 +71,9 @@ To execute only unittests, run ``tox`` with environment like so:
 
 .. code-block:: bash
 
-   tox -e py37 -v -- tests/test_config.py
+   tox -e py36 -v -- tests/test_config.py
    # or
-   tox -e py310 -v -- tests/test_config.py
+   tox -e py37 -v -- tests/test_config.py
 
 Run lint checks
 ---------------
@@ -140,7 +140,6 @@ To maintain the code consistency, Sanic uses following tools.
 #. `isort <https://github.com/timothycrosley/isort>`_
 #. `black <https://github.com/python/black>`_
 #. `flake8 <https://github.com/PyCQA/flake8>`_
-#. `slotscheck <https://github.com/ariebovenberg/slotscheck>`_
 
 isort
 *****
@@ -168,13 +167,7 @@ flake8
 #. pycodestyle
 #. Ned Batchelder's McCabe script
 
-slotscheck
+``isort``\ , ``black`` and ``flake8`` checks are performed during ``tox`` lint checks.
-**********
-
-``slotscheck`` ensures that there are no problems with ``__slots__``
-(e.g. overlaps, or missing slots in base classes).
-
-``isort``\ , ``black``\ , ``flake8`` and ``slotscheck`` checks are performed during ``tox`` lint checks.
 
 The **easiest** way to make your code conform is to run the following before committing.
 

Makefile

@@ -66,15 +66,15 @@ ifdef include_tests
 	isort -rc sanic tests
 else
 	$(info Sorting Imports)
-	isort -rc sanic tests
+	isort -rc sanic tests  --profile=black
 endif
 endif
 
 black:
-	black sanic tests
+	black --config ./.black.toml sanic tests
 
 isort:
-	isort sanic tests
+	isort sanic tests --profile=black
 
 pretty: black isort
 
@@ -93,9 +93,6 @@ docs-serve:
 changelog:
 	python scripts/changelog.py
 
-guide-serve:
-	cd guide && sanic server:app -r -R ./content -R ./style
-
 release:
 ifdef version
 	python scripts/release.py --release-version ${version} --generate-changelog

README.rst

@@ -11,7 +11,7 @@ Sanic | Build fast. Run fast.
     :stub-columns: 1
 
     * - Build
-      - | |Tests|
+      - | |Py39Test| |Py38Test| |Py37Test|
     * - Docs
       - | |UserGuide| |Documentation|
     * - Package
@@ -19,7 +19,7 @@ Sanic | Build fast. Run fast.
     * - Support
       - | |Forums| |Discord| |Awesome|
     * - Stats
-      - | |Monthly Downloads| |Weekly Downloads| |Conda downloads|
+      - | |Downloads| |WkDownloads| |Conda downloads|
 
 .. |UserGuide| image:: https://img.shields.io/badge/user%20guide-sanic-ff0068
    :target: https://sanicframework.org/
@@ -27,8 +27,12 @@ Sanic | Build fast. Run fast.
    :target: https://community.sanicframework.org/
 .. |Discord| image:: https://img.shields.io/discord/812221182594121728?logo=discord
    :target: https://discord.gg/FARQzAEMAA
-.. |Tests| image:: https://github.com/sanic-org/sanic/actions/workflows/tests.yml/badge.svg?branch=main
+.. |Py39Test| image:: https://github.com/sanic-org/sanic/actions/workflows/pr-python39.yml/badge.svg?branch=main
-   :target: https://github.com/sanic-org/sanic/actions/workflows/tests.yml
+   :target: https://github.com/sanic-org/sanic/actions/workflows/pr-python39.yml
+.. |Py38Test| image:: https://github.com/sanic-org/sanic/actions/workflows/pr-python38.yml/badge.svg?branch=main
+   :target: https://github.com/sanic-org/sanic/actions/workflows/pr-python38.yml
+.. |Py37Test| image:: https://github.com/sanic-org/sanic/actions/workflows/pr-python37.yml/badge.svg?branch=main
+   :target: https://github.com/sanic-org/sanic/actions/workflows/pr-python37.yml
 .. |Documentation| image:: https://readthedocs.org/projects/sanic/badge/?version=latest
    :target: http://sanic.readthedocs.io/en/latest/?badge=latest
 .. |PyPI| image:: https://img.shields.io/pypi/v/sanic.svg
@@ -46,25 +50,21 @@ Sanic | Build fast. Run fast.
 .. |Awesome| image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg
     :alt: Awesome Sanic List
     :target: https://github.com/mekicha/awesome-sanic
-.. |Monthly Downloads| image:: https://img.shields.io/pypi/dm/sanic.svg
+.. |Downloads| image:: https://pepy.tech/badge/sanic/month
     :alt: Downloads
     :target: https://pepy.tech/project/sanic
-.. |Weekly Downloads| image:: https://img.shields.io/pypi/dw/sanic.svg
+.. |WkDownloads| image:: https://pepy.tech/badge/sanic/week
     :alt: Downloads
     :target: https://pepy.tech/project/sanic
 .. |Conda downloads| image:: https://img.shields.io/conda/dn/conda-forge/sanic.svg
     :alt: Downloads
     :target: https://anaconda.org/conda-forge/sanic
-.. |Linode| image:: https://www.linode.com/wp-content/uploads/2021/01/Linode-Logo-Black.svg
-    :alt: Linode
-    :target: https://www.linode.com
-    :width: 200px
 
 .. end-badges
 
-Sanic is a **Python 3.8+** web server and web framework that's written to go fast. It allows the usage of the ``async/await`` syntax added in Python 3.5, which makes your code non-blocking and speedy.
+Sanic is a **Python 3.7+** web server and web framework that's written to go fast. It allows the usage of the ``async/await`` syntax added in Python 3.5, which makes your code non-blocking and speedy.
 
-Sanic is also ASGI compliant, so you can deploy it with an `alternative ASGI webserver <https://sanicframework.org/en/guide/deployment/running.html#asgi>`_.
+Sanic is also ASGI compliant, so you can deploy it with an `alternative ASGI webserver <https://sanic.readthedocs.io/en/latest/sanic/deploying.html#running-via-asgi>`_.
 
 `Source code on GitHub <https://github.com/sanic-org/sanic/>`_ | `Help and discussion board <https://community.sanicframework.org/>`_ | `User Guide <https://sanicframework.org>`_ | `Chat on Discord <https://discord.gg/FARQzAEMAA>`_
 
@@ -100,6 +100,9 @@ Installation
   If you are running on a clean install of Fedora 28 or above, please make sure you have the ``redhat-rpm-config`` package installed in case if you want to
   use ``sanic`` with ``ujson`` dependency.
 
+.. note::
+
+  Windows support is currently "experimental" and on a best-effort basis. Multiple workers are also not currently supported on Windows (see `Issue #1517 <https://github.com/sanic-org/sanic/issues/1517>`_), but setting ``workers=1`` should launch the server successfully.
 
 Hello World Example
 -------------------
@@ -109,7 +112,7 @@ Hello World Example
     from sanic import Sanic
     from sanic.response import json
 
-    app = Sanic("my-hello-world-app")
+    app = Sanic("My Hello, world app")
 
     @app.route('/')
     async def test(request):
@@ -139,17 +142,17 @@ And, we can verify it is working: ``curl localhost:8000 -i``
 
 **Now, let's go build something fast!**
 
-Minimum Python version is 3.8. If you need Python 3.7 support, please use v22.12LTS.
+Minimum Python version is 3.7. If you need Python 3.6 support, please use v20.12LTS.
 
 Documentation
 -------------
 
-`User Guide <https://sanic.dev>`__ and `API Documentation <http://sanic.readthedocs.io/>`__.
+`User Guide <https://sanicframework.org>`__ and `API Documentation <http://sanic.readthedocs.io/>`__.
 
 Changelog
 ---------
 
-`Release Changelogs <https://sanic.readthedocs.io/en/stable/sanic/changelog.html>`__.
+`Release Changelogs <https://github.com/sanic-org/sanic/blob/master/CHANGELOG.rst>`__.
 
 
 Questions and Discussion
@@ -161,3 +164,8 @@ Contribution
 ------------
 
 We are always happy to have new contributions. We have `marked issues good for anyone looking to get started <https://github.com/sanic-org/sanic/issues?q=is%3Aopen+is%3Aissue+label%3Abeginner>`_, and welcome `questions on the forums <https://community.sanicframework.org/>`_. Please take a look at our `Contribution guidelines <https://github.com/sanic-org/sanic/blob/master/CONTRIBUTING.rst>`_.
+
+.. |Linode| image:: https://www.linode.com/wp-content/uploads/2021/01/Linode-Logo-Black.svg
+    :alt: Linode
+    :target: https://www.linode.com
+    :width: 200px

SECURITY.md

@@ -4,42 +4,31 @@
 
 Sanic releases long term support release once a year in December. LTS releases receive bug and security updates for **24 months**. Interim releases throughout the year occur every three months, and are supported until the subsequent interim release.
 
+| Version | LTS           | Supported          |
+| ------- | ------------- | ------------------ |
+| 20.12   | until 2022-12 | :heavy_check_mark: |
+| 20.9    |               | :x:                |
+| 20.6    |               | :x:                |
+| 20.3    |               | :x:                |
+| 19.12   | until 2021-12 | :white_check_mark: |
+| 19.9    |               | :x:                |
+| 19.6    |               | :x:                |
+| 19.3    |               | :x:                |
+| 18.12   |               | :x:                |
+| 0.8.3   |               | :x:                |
+| 0.7.0   |               | :x:                |
+| 0.6.0   |               | :x:                |
+| 0.5.4   |               | :x:                |
+| 0.4.1   |               | :x:                |
+| 0.3.1   |               | :x:                |
+| 0.2.0   |               | :x:                |
+| 0.1.9   |               | :x:                |
 
-| Version | LTS           | Supported               |
+:white_check_mark: = security/bug fixes
-| ------- | ------------- | ----------------------- |
+:heavy_check_mark: = full support
-| 22.12   | until 2024-12 | :white_check_mark:      |
-| 22.9    |               | :x:                     |
-| 22.6    |               | :x:                     |
-| 22.3    |               | :x:                     |
-| 21.12   | until 2023-12 | :ballot_box_with_check: |
-| 21.9    |               | :x:                     |
-| 21.6    |               | :x:                     |
-| 21.3    |               | :x:                     |
-| 20.12   |               | :x:                     |
-| 20.9    |               | :x:                     |
-| 20.6    |               | :x:                     |
-| 20.3    |               | :x:                     |
-| 19.12   |               | :x:                     |
-| 19.9    |               | :x:                     |
-| 19.6    |               | :x:                     |
-| 19.3    |               | :x:                     |
-| 18.12   |               | :x:                     |
-| 0.8.3   |               | :x:                     |
-| 0.7.0   |               | :x:                     |
-| 0.6.0   |               | :x:                     |
-| 0.5.4   |               | :x:                     |
-| 0.4.1   |               | :x:                     |
-| 0.3.1   |               | :x:                     |
-| 0.2.0   |               | :x:                     |
-| 0.1.9   |               | :x:                     |
-
-:ballot_box_with_check: = security/bug fixes 
-:white_check_mark: = full support
 
 ## Reporting a Vulnerability
 
 If you discover a security vulnerability, we ask that you **do not** create an issue on GitHub. Instead, please [send a message to the core-devs](https://community.sanicframework.org/g/core-devs) on the community forums. Once logged in, you can send a message to the core-devs by clicking the message button.
 
-Alternatively, you can send a private message to Adam Hopkins on Discord. Find him on the [Sanic discord server](https://discord.gg/FARQzAEMAA).
-
 This will help to not publicize the issue until the team can address it and resolve it.

codecov.yml

@@ -1,28 +0,0 @@
-coverage:
-  status:
-    patch:
-      default:
-        target: auto
-        threshold: 0.75
-        informational: true
-    project:
-      default:
-        target: auto
-        threshold: 0.5
-  precision: 3
-codecov:
-  require_ci_to_pass: false
-ignore:
-  - "sanic/__main__.py"
-  - "sanic/compat.py"
-  - "sanic/simple.py"
-  - "sanic/utils.py"
-  - "sanic/cli/"
-  - "sanic/pages/"
-  - ".github/"
-  - "changelogs/"
-  - "docker/"
-  - "docs/"
-  - "examples/"
-  - "scripts/"
-  - "tests/"

docker/Dockerfile

@@ -1,13 +1,9 @@
-ARG BASE_IMAGE_ORG
-ARG BASE_IMAGE_NAME
 ARG BASE_IMAGE_TAG
 
-FROM ${BASE_IMAGE_ORG}/${BASE_IMAGE_NAME}:${BASE_IMAGE_TAG}
+FROM sanicframework/sanic-build:${BASE_IMAGE_TAG}
 
 RUN apk update
 RUN update-ca-certificates
 
-ARG SANIC_PYPI_VERSION
+RUN pip install sanic
-
-RUN pip install -U pip && pip install sanic==${SANIC_PYPI_VERSION}
 RUN apk del build-base

docs/_static/custom.css

@@ -2,12 +2,3 @@
 .wy-nav-top {
   background: #444444;
 }
-
-#changelog section {
-  padding-left: 3rem;
-}
-
-#changelog section h2,
-#changelog section h3 {
-  margin-left: -3rem;
-}

docs/conf.py

@@ -24,11 +24,7 @@ import sanic
 
 # -- General configuration ------------------------------------------------
 
-extensions = [
+extensions = ["sphinx.ext.autodoc", "m2r2"]
-    "sphinx.ext.autodoc",
-    "m2r2",
-    "enum_tools.autoenum",
-]
 
 templates_path = ["_templates"]
 

docs/index.rst

@@ -9,7 +9,7 @@ API
 ===
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
    👥 User Guide <https://sanicframework.org/guide/>
    sanic/api_reference

docs/sanic/api/app.rst

@@ -15,19 +15,3 @@ sanic.config
 .. automodule:: sanic.config
     :members:
     :show-inheritance:
-
-sanic.application.constants
----------------------------
-
-.. automodule:: sanic.application.constants
-    :exclude-members: StrEnum
-    :members:
-    :show-inheritance:
-    :inherited-members:
-
-sanic.application.state
------------------------
-
-.. automodule:: sanic.application.state
-    :members:
-    :show-inheritance:

docs/sanic/api/core.rst

@@ -17,14 +17,6 @@ sanic.handlers
     :show-inheritance:
 
 
-sanic.headers
---------------
-
-.. automodule:: sanic.headers
-    :members:
-    :show-inheritance:
-
-
 sanic.request
 -------------
 
@@ -46,3 +38,10 @@ sanic.views
 .. automodule:: sanic.views
     :members:
     :show-inheritance:
+
+sanic.websocket
+---------------
+
+.. automodule:: sanic.websocket
+    :members:
+    :show-inheritance:

docs/sanic/api/server.rst

@@ -16,3 +16,10 @@ sanic.server
     :members:
     :show-inheritance:
 
+
+sanic.worker
+------------
+
+.. automodule:: sanic.worker
+    :members:
+    :show-inheritance:

docs/sanic/changelog.rst

@@ -1,16 +1,6 @@
 📜 Changelog
 ============
 
-| 🔶 Current release
+.. mdinclude:: ./releases/21.9.md
-| 🔷 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
-.. mdinclude:: ./releases/22/22.3.md
-.. mdinclude:: ./releases/21/21.12.md
-.. mdinclude:: ./releases/21/21.9.md
 .. include:: ../../CHANGELOG.rst

docs/sanic/releases/21.9.md

@@ -1,14 +1,4 @@
-## Version 21.9.3
+## Version 21.9
-*Rerelease of v21.9.2 with some cleanup*
-
-## Version 21.9.2
-- [#2268](https://github.com/sanic-org/sanic/pull/2268) Make HTTP connections start in IDLE stage, avoiding delays and error messages
-- [#2310](https://github.com/sanic-org/sanic/pull/2310) More consistent config setting with post-FALLBACK_ERROR_FORMAT apply
-
-## Version 21.9.1
-- [#2259](https://github.com/sanic-org/sanic/pull/2259) Allow non-conforming ErrorHandlers
-
-## Version 21.9.0
 
 ### Features
 - [#2158](https://github.com/sanic-org/sanic/pull/2158), [#2248](https://github.com/sanic-org/sanic/pull/2248) Complete overhaul of I/O to websockets

docs/sanic/releases/21/21.12.md

@@ -1,66 +0,0 @@
-## Version 21.12.1 🔷
-
-_Current LTS version_
-
-- [#2349](https://github.com/sanic-org/sanic/pull/2349) Only display MOTD on startup
-- [#2354](https://github.com/sanic-org/sanic/pull/2354) Ignore name argument in Python 3.7
-- [#2355](https://github.com/sanic-org/sanic/pull/2355) Add config.update support for all config values
-
-## Version 21.12.0 🔹
-
-### Features
-- [#2260](https://github.com/sanic-org/sanic/pull/2260) Allow early Blueprint registrations to still apply later added objects
-- [#2262](https://github.com/sanic-org/sanic/pull/2262) Noisy exceptions - force logging of all exceptions
-- [#2264](https://github.com/sanic-org/sanic/pull/2264) Optional `uvloop` by configuration
-- [#2270](https://github.com/sanic-org/sanic/pull/2270) Vhost support using multiple TLS certificates
-- [#2277](https://github.com/sanic-org/sanic/pull/2277) Change signal routing for increased consistency
-    - *BREAKING CHANGE*: If you were manually routing signals there is a breaking change. The signal router's `get` is no longer 100% determinative. There is now an additional step to loop thru the returned signals for proper matching on the requirements. If signals are being dispatched using `app.dispatch` or `bp.dispatch`, there is no change.
-- [#2290](https://github.com/sanic-org/sanic/pull/2290) Add contextual exceptions
-- [#2291](https://github.com/sanic-org/sanic/pull/2291) Increase join concat performance 
-- [#2295](https://github.com/sanic-org/sanic/pull/2295), [#2316](https://github.com/sanic-org/sanic/pull/2316), [#2331](https://github.com/sanic-org/sanic/pull/2331) Restructure of CLI and application state with new displays and more command parity with `app.run`
-- [#2302](https://github.com/sanic-org/sanic/pull/2302) Add route context at definition time
-- [#2304](https://github.com/sanic-org/sanic/pull/2304) Named tasks and new API for managing background tasks
-- [#2307](https://github.com/sanic-org/sanic/pull/2307) On app auto-reload, provide insight of changed files
-- [#2308](https://github.com/sanic-org/sanic/pull/2308) Auto extend application with [Sanic Extensions](https://sanicframework.org/en/plugins/sanic-ext/getting-started.html) if it is installed, and provide first class support for accessing the extensions
-- [#2309](https://github.com/sanic-org/sanic/pull/2309) Builtin signals changed to `Enum`
-- [#2313](https://github.com/sanic-org/sanic/pull/2313) Support additional config implementation use case
-- [#2321](https://github.com/sanic-org/sanic/pull/2321) Refactor environment variable hydration logic
-- [#2327](https://github.com/sanic-org/sanic/pull/2327) Prevent sending multiple or mixed responses on a single request
-- [#2330](https://github.com/sanic-org/sanic/pull/2330) Custom type casting on environment variables
-- [#2332](https://github.com/sanic-org/sanic/pull/2332) Make all deprecation notices consistent
-- [#2335](https://github.com/sanic-org/sanic/pull/2335) Allow underscore to start instance names
-
-### Bugfixes
-- [#2273](https://github.com/sanic-org/sanic/pull/2273) Replace assignation by typing for `websocket_handshake`
-- [#2285](https://github.com/sanic-org/sanic/pull/2285) Fix IPv6 display in startup logs
-- [#2299](https://github.com/sanic-org/sanic/pull/2299) Dispatch `http.lifecyle.response` from exception handler
-
-### Deprecations and Removals
-- [#2306](https://github.com/sanic-org/sanic/pull/2306) Removal of deprecated items
-    - `Sanic` and `Blueprint` may no longer have arbitrary properties attached to them
-    - `Sanic` and `Blueprint` forced to have compliant names
-        - alphanumeric + `_` + `-`
-        - must start with letter or `_`
-    - `load_env` keyword argument of `Sanic`
-    - `sanic.exceptions.abort`
-    - `sanic.views.CompositionView`
-    - `sanic.response.StreamingHTTPResponse`
-        - *NOTE:* the `stream()` response method (where you pass a callable streaming function) has been deprecated and will be removed in v22.6. You should upgrade all streaming responses to the new style: https://sanicframework.org/en/guide/advanced/streaming.html#response-streaming
-- [#2320](https://github.com/sanic-org/sanic/pull/2320) Remove app instance from Config for error handler setting
-
-### Developer infrastructure
-- [#2251](https://github.com/sanic-org/sanic/pull/2251) Change dev install command
-- [#2286](https://github.com/sanic-org/sanic/pull/2286) Change codeclimate complexity threshold from 5 to 10
-- [#2287](https://github.com/sanic-org/sanic/pull/2287) Update host test function names so they are not overwritten
-- [#2292](https://github.com/sanic-org/sanic/pull/2292) Fail CI on error
-- [#2311](https://github.com/sanic-org/sanic/pull/2311), [#2324](https://github.com/sanic-org/sanic/pull/2324) Do not run tests for draft PRs
-- [#2336](https://github.com/sanic-org/sanic/pull/2336) Remove paths from coverage checks
-- [#2338](https://github.com/sanic-org/sanic/pull/2338) Cleanup ports on tests
-
-### Improved Documentation
-- [#2269](https://github.com/sanic-org/sanic/pull/2269), [#2329](https://github.com/sanic-org/sanic/pull/2329), [#2333](https://github.com/sanic-org/sanic/pull/2333) Cleanup typos and fix language
-
-### Miscellaneous
-- [#2257](https://github.com/sanic-org/sanic/pull/2257), [#2294](https://github.com/sanic-org/sanic/pull/2294), [#2341](https://github.com/sanic-org/sanic/pull/2341) Add Python 3.10 support
-- [#2279](https://github.com/sanic-org/sanic/pull/2279), [#2317](https://github.com/sanic-org/sanic/pull/2317), [#2322](https://github.com/sanic-org/sanic/pull/2322) Add/correct missing type annotations
-- [#2305](https://github.com/sanic-org/sanic/pull/2305) Fix examples to use modern implementations

docs/sanic/releases/22/22.12.md

@@ -1,55 +0,0 @@
-## Version 22.12.0 🔷
-
-_Current version_
-
-### Features
-
-- [#2569](https://github.com/sanic-org/sanic/pull/2569) Add `JSONResponse` class with some convenient methods when updating a response object
-- [#2598](https://github.com/sanic-org/sanic/pull/2598) Change `uvloop` requirement to `>=0.15.0`
-- [#2609](https://github.com/sanic-org/sanic/pull/2609) Add compatibility with `websockets` v11.0
-- [#2610](https://github.com/sanic-org/sanic/pull/2610) Kill server early on worker error
-    - Raise deadlock timeout to 30s
-- [#2617](https://github.com/sanic-org/sanic/pull/2617) Scale number of running server workers
-- [#2621](https://github.com/sanic-org/sanic/pull/2621) [#2634](https://github.com/sanic-org/sanic/pull/2634) Send `SIGKILL` on subsequent `ctrl+c` to force worker exit
-- [#2622](https://github.com/sanic-org/sanic/pull/2622) Add API to restart all workers from the multiplexer
-- [#2624](https://github.com/sanic-org/sanic/pull/2624) Default to `spawn` for all subprocesses unless specifically set:
-    ```python
-    from sanic import Sanic
-    
-    Sanic.start_method = "fork"
-    ```
-- [#2625](https://github.com/sanic-org/sanic/pull/2625) Filename normalisation of form-data/multipart file uploads
-- [#2626](https://github.com/sanic-org/sanic/pull/2626) Move to HTTP Inspector:
-    - Remote access to inspect running Sanic instances
-    - TLS support for encrypted calls to Inspector
-    - Authentication to Inspector with API key
-    - Ability to extend Inspector with custom commands
-- [#2632](https://github.com/sanic-org/sanic/pull/2632) Control order of restart operations
-- [#2633](https://github.com/sanic-org/sanic/pull/2633) Move reload interval to class variable
-- [#2636](https://github.com/sanic-org/sanic/pull/2636) Add `priority` to `register_middleware` method
-- [#2639](https://github.com/sanic-org/sanic/pull/2639) Add `unquote` to `add_route` method
-- [#2640](https://github.com/sanic-org/sanic/pull/2640) ASGI websockets to receive `text` or `bytes`
-
-
-### Bugfixes
-
-- [#2607](https://github.com/sanic-org/sanic/pull/2607) Force socket shutdown before close to allow rebinding
-- [#2590](https://github.com/sanic-org/sanic/pull/2590) Use actual `StrEnum` in Python 3.11+
-- [#2615](https://github.com/sanic-org/sanic/pull/2615) Ensure middleware executes only once per request timeout
-- [#2627](https://github.com/sanic-org/sanic/pull/2627) Crash ASGI application on lifespan failure
-- [#2635](https://github.com/sanic-org/sanic/pull/2635) Resolve error with low-level server creation on Windows
-
-
-### Deprecations and Removals
-
-- [#2608](https://github.com/sanic-org/sanic/pull/2608) [#2630](https://github.com/sanic-org/sanic/pull/2630) Signal conditions and triggers saved on `signal.extra` 
-- [#2626](https://github.com/sanic-org/sanic/pull/2626) Move to HTTP Inspector
-    - 🚨 *BREAKING CHANGE*: Moves the Inspector to a Sanic app from a simple TCP socket with a custom protocol
-    - *DEPRECATE*: The `--inspect*` commands have been deprecated in favor of `inspect ...` commands
-- [#2628](https://github.com/sanic-org/sanic/pull/2628) Replace deprecated `distutils.strtobool`
-
-
-### Developer infrastructure
-
-- [#2612](https://github.com/sanic-org/sanic/pull/2612) Add CI testing for Python 3.11
-

docs/sanic/releases/22/22.3.md

@@ -1,52 +0,0 @@
-## Version 22.3.0
-
-### Features
-- [#2347](https://github.com/sanic-org/sanic/pull/2347) API for multi-application server
-    - 🚨 *BREAKING CHANGE*: The old `sanic.worker.GunicornWorker` has been **removed**. To run Sanic with `gunicorn`, you should use it thru `uvicorn` [as described in their docs](https://www.uvicorn.org/#running-with-gunicorn).
-    - 🧁 *SIDE EFFECT*: Named background tasks are now supported, even in Python 3.7
-- [#2357](https://github.com/sanic-org/sanic/pull/2357) Parse `Authorization` header as `Request.credentials`
-- [#2361](https://github.com/sanic-org/sanic/pull/2361) Add config option to skip `Touchup` step in application startup
-- [#2372](https://github.com/sanic-org/sanic/pull/2372) Updates to CLI help messaging
-- [#2382](https://github.com/sanic-org/sanic/pull/2382) Downgrade warnings to backwater debug messages 
-- [#2396](https://github.com/sanic-org/sanic/pull/2396) Allow for `multidict` v0.6
-- [#2401](https://github.com/sanic-org/sanic/pull/2401) Upgrade CLI catching for alternative application run types
-- [#2402](https://github.com/sanic-org/sanic/pull/2402) Conditionally inject CLI arguments into factory
-- [#2413](https://github.com/sanic-org/sanic/pull/2413) Add new start and stop event listeners to reloader process
-- [#2414](https://github.com/sanic-org/sanic/pull/2414) Remove loop as required listener arg
-- [#2415](https://github.com/sanic-org/sanic/pull/2415) Better exception for bad URL parsing
-- [sanic-routing#47](https://github.com/sanic-org/sanic-routing/pull/47) Add a new extention parameter type: `<file:ext>`, `<file:ext=jpg>`, `<file:ext=jpg|png|gif|svg>`, `<file=int:ext>`, `<file=int:ext=jpg|png|gif|svg>`, `<file=float:ext=tar.gz>`
-    - 👶 *BETA FEATURE*: This feature will not work with `path` type matching, and is being released as a beta feature only.
-- [sanic-routing#57](https://github.com/sanic-org/sanic-routing/pull/57) Change `register_pattern` to accept a `str` or `Pattern`
-- [sanic-routing#58](https://github.com/sanic-org/sanic-routing/pull/58) Default matching on non-empty strings only, and new `strorempty` pattern type
-    - 🚨 *BREAKING CHANGE*: Previously a route with a dynamic string parameter (`/<foo>` or `/<foo:str>`) would match on any string, including empty strings. It will now **only** match a non-empty string. To retain the old behavior, you should use the new parameter type: `/<foo:strorempty>`.
-
-### Bugfixes
-- [#2373](https://github.com/sanic-org/sanic/pull/2373) Remove `error_logger` on websockets
-- [#2381](https://github.com/sanic-org/sanic/pull/2381) Fix newly assigned `None` in task registry
-- [sanic-routing#52](https://github.com/sanic-org/sanic-routing/pull/52) Add type casting to regex route matching
-- [sanic-routing#60](https://github.com/sanic-org/sanic-routing/pull/60) Add requirements check on regex routes (this resolves, for example, multiple static directories with differing `host` values)
-
-### Deprecations and Removals
-- [#2362](https://github.com/sanic-org/sanic/pull/2362) 22.3 Deprecations and changes
-    1. `debug=True` and `--debug` do _NOT_ automatically run `auto_reload`
-    2. Default error render is with plain text (browsers still get HTML by default because `auto` looks at headers)
-    3. `config` is required for `ErrorHandler.finalize`
-    4. `ErrorHandler.lookup` requires two positional args
-    5. Unused websocket protocol args removed
-- [#2344](https://github.com/sanic-org/sanic/pull/2344) Deprecate loading of lowercase environment variables
-
-### Developer infrastructure
-- [#2363](https://github.com/sanic-org/sanic/pull/2363) Revert code coverage back to Codecov
-- [#2405](https://github.com/sanic-org/sanic/pull/2405) Upgrade tests for `sanic-routing` changes
-- [sanic-testing#35](https://github.com/sanic-org/sanic-testing/pull/35) Allow for httpx v0.22
-
-### Improved Documentation
-- [#2350](https://github.com/sanic-org/sanic/pull/2350) Fix link in README for ASGI
-- [#2398](https://github.com/sanic-org/sanic/pull/2398) Document middleware on_request and on_response
-- [#2409](https://github.com/sanic-org/sanic/pull/2409) Add missing documentation for `Request.respond`
-
-### Miscellaneous
-- [#2376](https://github.com/sanic-org/sanic/pull/2376) Fix typing for `ListenerMixin.listener`
-- [#2383](https://github.com/sanic-org/sanic/pull/2383) Clear deprecation warning in `asyncio.wait`
-- [#2387](https://github.com/sanic-org/sanic/pull/2387) Cleanup `__slots__` implementations
-- [#2390](https://github.com/sanic-org/sanic/pull/2390) Clear deprecation warning in `asyncio.get_event_loop`

docs/sanic/releases/22/22.6.md

@@ -1,54 +0,0 @@
-## Version 22.6.2
-
-### Bugfixes
-
-- [#2522](https://github.com/sanic-org/sanic/pull/2522) Always show server location in ASGI
-
-## Version 22.6.1
-
-### Bugfixes
-
-- [#2477](https://github.com/sanic-org/sanic/pull/2477) Sanic static directory fails when folder name ends with ".."
-
-
-## Version 22.6.0
-
-### Features
-- [#2378](https://github.com/sanic-org/sanic/pull/2378) Introduce HTTP/3 and autogeneration of TLS certificates in `DEBUG` mode
-    - 👶 *EARLY RELEASE FEATURE*: Serving Sanic over HTTP/3 is an early release feature. It does not yet fully cover the HTTP/3 spec, but instead aims for feature parity with Sanic's existing HTTP/1.1 server. Websockets, WebTransport, push responses are examples of some features not yet implemented.
-    - 📦 *EXTRA REQUIREMENT*: Not all HTTP clients are capable of interfacing with HTTP/3 servers. You may need to install a [HTTP/3 capable client](https://curl.se/docs/http3.html).
-    - 📦 *EXTRA REQUIREMENT*: In order to use TLS autogeneration, you must install either [mkcert](https://github.com/FiloSottile/mkcert) or [trustme](https://github.com/python-trio/trustme).
-- [#2416](https://github.com/sanic-org/sanic/pull/2416) Add message to `task.cancel`
-- [#2420](https://github.com/sanic-org/sanic/pull/2420) Add exception aliases for more consistent naming with standard HTTP response types (`BadRequest`, `MethodNotAllowed`, `RangeNotSatisfiable`)
-- [#2432](https://github.com/sanic-org/sanic/pull/2432) Expose ASGI `scope` as a property on the `Request` object
-- [#2438](https://github.com/sanic-org/sanic/pull/2438) Easier access to websocket class for annotation: `from sanic import Websocket`
-- [#2439](https://github.com/sanic-org/sanic/pull/2439) New API for reading form values with options: `Request.get_form` 
-- [#2445](https://github.com/sanic-org/sanic/pull/2445) Add custom `loads` function
-- [#2447](https://github.com/sanic-org/sanic/pull/2447), [#2486](https://github.com/sanic-org/sanic/pull/2486) Improved API to support setting cache control headers
-- [#2453](https://github.com/sanic-org/sanic/pull/2453) Move verbosity filtering to logger
-- [#2475](https://github.com/sanic-org/sanic/pull/2475) Expose getter for current request using `Request.get_current()`
-
-### Bugfixes
-- [#2448](https://github.com/sanic-org/sanic/pull/2448) Fix to allow running with `pythonw.exe` or places where there is no `sys.stdout`
-- [#2451](https://github.com/sanic-org/sanic/pull/2451) Trigger `http.lifecycle.request` signal in ASGI mode
-- [#2455](https://github.com/sanic-org/sanic/pull/2455) Resolve typing of stacked route definitions
-- [#2463](https://github.com/sanic-org/sanic/pull/2463) Properly catch websocket CancelledError in websocket handler in Python 3.7
-
-### Deprecations and Removals
-- [#2487](https://github.com/sanic-org/sanic/pull/2487) v22.6 deprecations and changes
-    1. Optional application registry
-    1. Execution of custom handlers after some part of response was sent
-    1. Configuring fallback handlers on the `ErrorHandler`
-    1. Custom `LOGO` setting
-    1. `sanic.response.stream`
-    1. `AsyncioServer.init`
-
-### Developer infrastructure
-- [#2449](https://github.com/sanic-org/sanic/pull/2449) Clean up `black` and `isort` config
-- [#2479](https://github.com/sanic-org/sanic/pull/2479) Fix some flappy tests
-
-### Improved Documentation
-- [#2461](https://github.com/sanic-org/sanic/pull/2461) Update example to match current application naming standards
-- [#2466](https://github.com/sanic-org/sanic/pull/2466) Better type annotation for `Extend`
-- [#2485](https://github.com/sanic-org/sanic/pull/2485) Improved help messages in CLI
-

docs/sanic/releases/22/22.9.md

@@ -1,74 +0,0 @@
-## Version 22.9.1
-
-### Features
-
-- [#2585](https://github.com/sanic-org/sanic/pull/2585) Improved error message when no applications have been registered
-
-
-### Bugfixes
-
-- [#2578](https://github.com/sanic-org/sanic/pull/2578) Add certificate loader for in process certificate creation
-- [#2591](https://github.com/sanic-org/sanic/pull/2591) Do not use sentinel identity for `spawn` compatibility
-- [#2592](https://github.com/sanic-org/sanic/pull/2592) Fix properties in nested blueprint groups
-- [#2595](https://github.com/sanic-org/sanic/pull/2595) Introduce sleep interval on new worker reloader
-
-
-### Deprecations and Removals
-
-
-### Developer infrastructure
-
-- [#2588](https://github.com/sanic-org/sanic/pull/2588) Markdown templates on issue forms
-
-
-### Improved Documentation
-
-- [#2556](https://github.com/sanic-org/sanic/pull/2556) v22.9 documentation
-- [#2582](https://github.com/sanic-org/sanic/pull/2582) Cleanup documentation on Windows support
-
-
-## Version 22.9.0
-
-### Features
-
-- [#2445](https://github.com/sanic-org/sanic/pull/2445) Add custom loads function 
-- [#2490](https://github.com/sanic-org/sanic/pull/2490) Make `WebsocketImplProtocol` async iterable
-- [#2499](https://github.com/sanic-org/sanic/pull/2499) Sanic Server WorkerManager refactor
-- [#2506](https://github.com/sanic-org/sanic/pull/2506) Use `pathlib` for path resolution (for static file serving)
-- [#2508](https://github.com/sanic-org/sanic/pull/2508) Use `path.parts` instead of `match` (for static file serving)
-- [#2513](https://github.com/sanic-org/sanic/pull/2513) Better request cancel handling
-- [#2516](https://github.com/sanic-org/sanic/pull/2516) Add request properties for HTTP method info:
-    - `request.is_safe`
-    - `request.is_idempotent`
-    - `request.is_cacheable`
-    - *See* [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) *for more information about when these apply*
-- [#2522](https://github.com/sanic-org/sanic/pull/2522) Always show server location in ASGI
-- [#2526](https://github.com/sanic-org/sanic/pull/2526) Cache control support for static files for returning 304 when appropriate
-- [#2533](https://github.com/sanic-org/sanic/pull/2533) Refactor `_static_request_handler`
-- [#2540](https://github.com/sanic-org/sanic/pull/2540) Add signals before and after handler execution
-    - `http.handler.before`
-    - `http.handler.after`
-- [#2542](https://github.com/sanic-org/sanic/pull/2542) Add *[redacted]* to CLI :)
-- [#2546](https://github.com/sanic-org/sanic/pull/2546) Add deprecation warning filter
-- [#2550](https://github.com/sanic-org/sanic/pull/2550) Middleware priority and performance enhancements
-
-### Bugfixes
-
-- [#2495](https://github.com/sanic-org/sanic/pull/2495) Prevent directory traversion with static files
-- [#2515](https://github.com/sanic-org/sanic/pull/2515) Do not apply double slash to paths in certain static dirs in Blueprints
-
-### Deprecations and Removals
-
-- [#2525](https://github.com/sanic-org/sanic/pull/2525) Warn on duplicate route names, will be prevented outright in v23.3
-- [#2537](https://github.com/sanic-org/sanic/pull/2537) Raise warning and deprecation notice on duplicate exceptions, will be prevented outright in v23.3
-
-### Developer infrastructure
-
-- [#2504](https://github.com/sanic-org/sanic/pull/2504) Cleanup test suite
-- [#2505](https://github.com/sanic-org/sanic/pull/2505) Replace Unsupported Python Version Number from the Contributing Doc
-- [#2530](https://github.com/sanic-org/sanic/pull/2530) Do not include tests folder in installed package resolver
-
-### Improved Documentation
-
-- [#2502](https://github.com/sanic-org/sanic/pull/2502) Fix a few typos
-- [#2517](https://github.com/sanic-org/sanic/pull/2517) [#2536](https://github.com/sanic-org/sanic/pull/2536) Add some type hints

docs/sanic/releases/23/23.3.md

@@ -1,53 +0,0 @@
-## 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

@@ -1,33 +0,0 @@
-## 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/add_task_sanic.py

@@ -5,7 +5,7 @@ import asyncio
 from sanic import Sanic
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 async def notify_server_started_after_five_seconds():

examples/amending_request_object.py

@@ -4,7 +4,7 @@ from sanic import Sanic
 from sanic.response import text
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.middleware("request")
@@ -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/authorized_sanic.py

@@ -6,7 +6,7 @@ from sanic import Sanic
 from sanic.response import json
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 def check_request_for_authorization_status(request):

examples/blueprint_middlware_execution_order.py

@@ -8,9 +8,9 @@ are added. And blueprint response middleware are executed in _reverse_ order.
 On a valid request, it should print "1 2 3 6 5 4" to terminal
 """
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
-bp = Blueprint("bp_example")
+bp = Blueprint("bp_" + __name__)
 
 
 @bp.on_request
@@ -50,5 +50,4 @@ def pop_handler(request):
 
 app.blueprint(bp, url_prefix="/bp")
 
-if __name__ == "__main__":
+app.run(host="0.0.0.0", port=8000, debug=True, auto_reload=False)
-    app.run(host="0.0.0.0", port=8000, debug=True, auto_reload=False)

examples/blueprints.py

@@ -2,10 +2,10 @@ from sanic import Blueprint, Sanic
 from sanic.response import file, json
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
-blueprint = Blueprint("bp_example", url_prefix="/my_blueprint")
+blueprint = Blueprint("name", url_prefix="/my_blueprint")
-blueprint2 = Blueprint("bp_example2", url_prefix="/my_blueprint2")
+blueprint2 = Blueprint("name2", url_prefix="/my_blueprint2")
-blueprint3 = Blueprint("bp_example3", url_prefix="/my_blueprint3")
+blueprint3 = Blueprint("name3", url_prefix="/my_blueprint3")
 
 
 @blueprint.route("/foo")
@@ -37,5 +37,4 @@ app.blueprint(blueprint)
 app.blueprint(blueprint2)
 app.blueprint(blueprint3)
 
-if __name__ == "__main__":
+app.run(host="0.0.0.0", port=9999, debug=True)
-    app.run(host="0.0.0.0", port=9999, debug=True)

examples/delayed_response.py

@@ -3,8 +3,7 @@ from asyncio import sleep
 from sanic import Sanic, response
 
 
-app = Sanic("DelayedResponseApp", strict_slashes=True)
+app = Sanic(__name__, strict_slashes=True)
-app.config.AUTO_EXTEND = False
 
 
 @app.get("/")
@@ -12,7 +11,7 @@ async def handler(request):
     return response.redirect("/sleep/3")
 
 
-@app.get("/sleep/<t:float>")
+@app.get("/sleep/<t:number>")
 async def handler2(request, t=0.3):
     await sleep(t)
     return response.text(f"Slept {t:.1f} seconds.\n")

examples/exception_monitoring.py

@@ -41,7 +41,7 @@ from sanic import Sanic
 
 
 handler = CustomHandler()
-app = Sanic("Example", error_handler=handler)
+app = Sanic(__name__, error_handler=handler)
 
 
 @app.route("/")

examples/hello_world.py

@@ -1,7 +1,7 @@
-from sanic import Sanic, response
+from sanic import Sanic
+from sanic import response
 
-
+app = Sanic(__name__)
-app = Sanic("Example")
 
 
 @app.route("/")
@@ -9,5 +9,5 @@ async def test(request):
     return response.json({"test": True})
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     app.run(host="0.0.0.0", port=8000)

examples/http_redirect.py

@@ -29,7 +29,7 @@ def proxy(request, path):
         path=path,
         _server=https.config.SERVER_NAME,
         _external=True,
-        _scheme="https",
+        _scheme="http",
     )
     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

@@ -6,7 +6,7 @@ from sanic import Sanic
 from sanic.response import json
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 sem = None
 
@@ -39,5 +39,4 @@ async def test(request):
         return json(response)
 
 
-if __name__ == "__main__":
+app.run(host="0.0.0.0", port=8000, workers=2)
-    app.run(host="0.0.0.0", port=8000, workers=2)

examples/log_request_id.py

@@ -44,7 +44,7 @@ LOG_SETTINGS = {
 }
 
 
-app = Sanic("Example", log_config=LOG_SETTINGS)
+app = Sanic(__name__, log_config=LOG_SETTINGS)
 
 
 @app.on_request

examples/logdna_example.py

@@ -43,7 +43,7 @@ logdna = logging.getLogger(__name__)
 logdna.setLevel(logging.INFO)
 logdna.addHandler(logdna_handler)
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.middleware

examples/modify_header_example.py

@@ -2,29 +2,27 @@
 Modify header or status in response
 """
 
-from sanic import Sanic, response
+from sanic import Sanic
+from sanic import response
+
+app = Sanic(__name__)
 
 
-app = Sanic("Example")
+@app.route('/')
-
-
-@app.route("/")
 def handle_request(request):
     return response.json(
-        {"message": "Hello world!"},
+        {'message': 'Hello world!'},
-        headers={"X-Served-By": "sanic"},
+        headers={'X-Served-By': 'sanic'},
-        status=200,
+        status=200
     )
 
 
-@app.route("/unauthorized")
+@app.route('/unauthorized')
 def handle_request(request):
     return response.json(
-        {"message": "You are not authorized"},
+        {'message': 'You are not authorized'},
-        headers={"X-Served-By": "sanic"},
+        headers={'X-Served-By': 'sanic'},
-        status=404,
+        status=404
     )
 
-
+app.run(host="0.0.0.0", port=8000, debug=True)
-if __name__ == "__main__":
-    app.run(host="0.0.0.0", port=8000, debug=True)

examples/override_logging.py

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

examples/pytest_xdist.py

@@ -32,7 +32,7 @@ def test_port(worker_id):
 
 @pytest.fixture(scope="session")
 def app():
-    app = Sanic("Example")
+    app = Sanic()
 
     @app.route("/")
     async def index(request):

examples/raygun_example.py

@@ -8,6 +8,7 @@ from sanic.handlers import ErrorHandler
 
 
 class RaygunExceptionReporter(ErrorHandler):
+
     def __init__(self, raygun_api_key=None):
         super().__init__()
         if raygun_api_key is None:
@@ -21,13 +22,16 @@ class RaygunExceptionReporter(ErrorHandler):
 
 
 raygun_error_reporter = RaygunExceptionReporter()
-app = Sanic("Example", error_handler=raygun_error_reporter)
+app = Sanic(__name__, error_handler=raygun_error_reporter)
 
 
 @app.route("/raise")
 async def test(request):
-    raise SanicException("You Broke It!")
+    raise SanicException('You Broke It!')
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
-    app.run(host="0.0.0.0", port=getenv("PORT", 8080))
+    app.run(
+        host="0.0.0.0",
+        port=getenv("PORT", 8080)
+    )

examples/redirect_example.py

@@ -1,18 +1,18 @@
-from sanic import Sanic, response
+from sanic import Sanic
+from sanic import response
+
+app = Sanic(__name__)
 
     
-app = Sanic("Example")
+@app.route('/')
-
-
-@app.route("/")
 def handle_request(request):
-    return response.redirect("/redirect")
+    return response.redirect('/redirect')
 
 
-@app.route("/redirect")
+@app.route('/redirect')
 async def test(request):
     return response.json({"Redirected": True})
 
 
-if __name__ == "__main__":
+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_stream/server.py

@@ -1,63 +1,65 @@
 from sanic import Sanic
-from sanic.blueprints import Blueprint
+from sanic.views import CompositionView
-from sanic.response import stream, text
 from sanic.views import HTTPMethodView
 from sanic.views import stream as stream_decorator
+from sanic.blueprints import Blueprint
+from sanic.response import stream, text
 
-
+bp = Blueprint('blueprint_request_stream')
-bp = Blueprint("bp_example")
+app = Sanic('request_stream')
-app = Sanic("Example")
 
 
 class SimpleView(HTTPMethodView):
+
     @stream_decorator
     async def post(self, request):
-        result = ""
+        result = ''
         while True:
             body = await request.stream.get()
             if body is None:
                 break
-            result += body.decode("utf-8")
+            result += body.decode('utf-8')
         return text(result)
 
 
-@app.post("/stream", stream=True)
+@app.post('/stream', stream=True)
 async def handler(request):
     async def streaming(response):
         while True:
             body = await request.stream.get()
             if body is None:
                 break
-            body = body.decode("utf-8").replace("1", "A")
+            body = body.decode('utf-8').replace('1', 'A')
             await response.write(body)
-
     return stream(streaming)
 
 
-@bp.put("/bp_stream", stream=True)
+@bp.put('/bp_stream', stream=True)
 async def bp_handler(request):
-    result = ""
+    result = ''
     while True:
         body = await request.stream.get()
         if body is None:
             break
-        result += body.decode("utf-8").replace("1", "A")
+        result += body.decode('utf-8').replace('1', 'A')
     return text(result)
 
 
 async def post_handler(request):
-    result = ""
+    result = ''
     while True:
         body = await request.stream.get()
         if body is None:
             break
-        result += body.decode("utf-8")
+        result += body.decode('utf-8')
     return text(result)
 
-
 app.blueprint(bp)
-app.add_route(SimpleView.as_view(), "/method_view")
+app.add_route(SimpleView.as_view(), '/method_view')
+view = CompositionView()
+view.add(['POST'], post_handler, stream=True)
+app.add_route(view, '/composition_view')
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
-    app.run(host="0.0.0.0", port=8000)
+    app.run(host='0.0.0.0', port=8000)

examples/request_timeout.py

@@ -1,24 +1,21 @@
 import asyncio
-
+from sanic import Sanic
-from sanic import Sanic, response
+from sanic import response
 from sanic.config import Config
 from sanic.exceptions import RequestTimeout
 
-
 Config.REQUEST_TIMEOUT = 1
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
-@app.route("/")
+@app.route('/')
 async def test(request):
     await asyncio.sleep(3)
-    return response.text("Hello, world!")
+    return response.text('Hello, world!')
 
 
 @app.exception(RequestTimeout)
 def timeout(request, exception):
-    return response.text("RequestTimeout from error_handler.", 408)
+    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/rollbar_example.py

@@ -1,22 +1,21 @@
-from os import getenv
-
 import rollbar
 
+from sanic.handlers import ErrorHandler
 from sanic import Sanic
 from sanic.exceptions import SanicException
-from sanic.handlers import ErrorHandler
+from os import getenv
-
 
 rollbar.init(getenv("ROLLBAR_API_KEY"))
 
 
 class RollbarExceptionHandler(ErrorHandler):
+
     def default(self, request, exception):
         rollbar.report_message(str(exception))
         return super().default(request, exception)
 
 
-app = Sanic("Example", error_handler=RollbarExceptionHandler())
+app = Sanic(__name__, error_handler=RollbarExceptionHandler())
 
 
 @app.route("/raise")
@@ -25,4 +24,7 @@ def create_error(request):
 
 
 if __name__ == "__main__":
-    app.run(host="0.0.0.0", port=getenv("PORT", 8080))
+    app.run(
+        host="0.0.0.0",
+        port=getenv("PORT", 8080)
+    )

examples/run_asgi.py

@@ -11,7 +11,7 @@ from pathlib import Path
 from sanic import Sanic, response
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.route("/text")

examples/run_async.py

@@ -5,7 +5,7 @@ import uvloop
 from sanic import Sanic, response
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.route("/")

examples/run_async_advanced.py

@@ -8,7 +8,7 @@ from sanic import Sanic, response
 from sanic.server import AsyncioServer
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.before_server_start
@@ -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())
 
-    # When using app.run(), this actually triggers before the serv_coro.
+asyncio.set_event_loop(uvloop.new_event_loop())
-    # But, in this example, we are using the convenience method, even if it is
+serv_coro = app.create_server(
-    # out of order.
+    host="0.0.0.0", port=8000, return_asyncio_server=True
-    loop.run_until_complete(server.before_start())
+)
-    loop.run_until_complete(server.after_start())
+loop = asyncio.get_event_loop()
-    try:
+serv_task = asyncio.ensure_future(serv_coro, loop=loop)
-        loop.run_forever()
+signal(SIGINT, lambda s, f: loop.stop())
-    except KeyboardInterrupt:
+server: AsyncioServer = loop.run_until_complete(serv_task)
-        loop.stop()
+loop.run_until_complete(server.startup())
-    finally:
-        loop.run_until_complete(server.before_stop())
 
-        # Wait for server to close
+# When using app.run(), this actually triggers before the serv_coro.
-        close_task = server.close()
+# But, in this example, we are using the convenience method, even if it is
-        loop.run_until_complete(close_task)
+# out of order.
+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())
 
-        # Complete all tasks on the loop
+    # Wait for server to close
-        for connection in server.connections:
+    close_task = server.close()
-            connection.close_if_idle()
+    loop.run_until_complete(close_task)
-        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())

examples/sentry_example.py

@@ -6,19 +6,20 @@ from sentry_sdk.integrations.sanic import SanicIntegration
 from sanic import Sanic
 from sanic.response import json
 
-
 sentry_init(
     dsn=getenv("SENTRY_DSN"),
     integrations=[SanicIntegration()],
 )
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 # noinspection PyUnusedLocal
 @app.route("/working")
 async def working_path(request):
-    return json({"response": "Working API Response"})
+    return json({
+        "response": "Working API Response"
+    })
 
 
 # noinspection PyUnusedLocal
@@ -27,5 +28,8 @@ async def raise_error(request):
     raise Exception("Testing Sentry Integration")
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
-    app.run(host="0.0.0.0", port=getenv("PORT", 8080))
+    app.run(
+        host="0.0.0.0",
+        port=getenv("PORT", 8080)
+    )

examples/static_assets.py

@@ -1,6 +1,6 @@
 from sanic import Sanic
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 app.static("/", "./static")

examples/teapot.py

@@ -1,14 +1,13 @@
 from sanic import Sanic
 from sanic import response as res
 
-
+app = Sanic(__name__)
-app = Sanic("Example")
 
 
 @app.route("/")
 async def test(req):
-    return res.text("I'm a teapot", status=418)
+    return res.text("I\'m a teapot", status=418)
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     app.run(host="0.0.0.0", port=8000)

examples/try_everything.py

@@ -5,7 +5,7 @@ from sanic.exceptions import ServerError
 from sanic.log import logger as log
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.route("/")

examples/unix_socket.py

@@ -1,7 +1,10 @@
+import os
+import socket
+
 from sanic import Sanic, response
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.route("/test")
@@ -10,4 +13,13 @@ async def test(request):
 
 
 if __name__ == "__main__":
-    app.run(unix="./uds_socket")
+    server_address = "./uds_socket"
+    # Make sure the socket does not already exist
+    try:
+        os.unlink(server_address)
+    except OSError:
+        if os.path.exists(server_address):
+            raise
+    sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+    sock.bind(server_address)
+    app.run(sock=sock)

examples/url_for_example.py

@@ -1,7 +1,7 @@
 from sanic import Sanic, response
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.route("/")

examples/vhosts.py

@@ -8,7 +8,7 @@ from sanic.blueprints import Blueprint
 # curl -H "Host: bp.example.com" localhost:8000/question
 # curl -H "Host: bp.example.com" localhost:8000/answer
 
-app = Sanic("Example")
+app = Sanic(__name__)
 bp = Blueprint("bp", host="bp.example.com")
 
 

examples/websocket.py

@@ -2,7 +2,7 @@ from sanic import Sanic
 from sanic.response import redirect
 
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 app.static("index.html", "websocket.html")

guide/Procfile

@@ -1 +0,0 @@
-web: sanic --port=${PORT} --host=0.0.0.0 --workers=1 server:app

guide/config/en/general.yaml

@@ -1 +0,0 @@
-current_version: "23.6"

guide/config/en/navbar.yaml

@@ -1,15 +0,0 @@
-root:
-    - label: Home
-      path: index.html
-    - label: Community
-      items:
-          - label: Forums
-            href: https://community.sanicframework.org
-          - label: Discord
-            href: https://discord.gg/FARQzAEMAA
-          - label: Twitter
-            href: https://twitter.com/sanicframework
-    - label: Help
-      path: ./help.html
-    - label: GitHub
-      href: https://github.com/sanic-org/sanic

guide/config/en/sidebar.yaml

@@ -1,257 +0,0 @@
-root:
-    - label: User Guide
-      items:
-          - label: General
-            items:
-                - label: Introduction
-                  path: guide/introduction.html
-                - label: Getting Started
-                  path: guide/getting-started.html
-          - label: Basics
-            items:
-                - label: Sanic Application
-                  path: guide/basics/app.html
-                - label: Handlers
-                  path: guide/basics/handlers.html
-                - label: Request
-                  path: guide/basics/request.html
-                - label: Response
-                  path: guide/basics/response.html
-                - label: Routing
-                  path: guide/basics/routing.html
-                - label: Listeners
-                  path: guide/basics/listeners.html
-                - label: Middleware
-                  path: guide/basics/middleware.html
-                - label: Headers
-                  path: guide/basics/headers.html
-                - label: Cookies
-                  path: guide/basics/cookies.html
-                - label: Background Tasks
-                  path: guide/basics/tasks.html
-          - label: Advanced
-            items:
-                - label: Class Based Views
-                  path: guide/advanced/class-based-views.html
-                - label: Proxy Configuration
-                  path: guide/advanced/proxy-headers.html
-                - label: Streaming
-                  path: guide/advanced/streaming.html
-                - label: Websockets
-                  path: guide/advanced/websockets.html
-                - label: Versioning
-                  path: guide/advanced/versioning.html
-                - label: Signals
-                  path: guide/advanced/signals.html
-          - label: Best Practices
-            items:
-                - label: Blueprints
-                  path: guide/best-practices/blueprints.html
-                - label: Exceptions
-                  path: guide/best-practices/exceptions.html
-                - label: Decorators
-                  path: guide/best-practices/decorators.html
-                - label: Logging
-                  path: guide/best-practices/logging.html
-                - label: Testing
-                  path: guide/best-practices/testing.html
-          - label: Running Sanic
-            items:
-                - label: Configuration
-                  path: guide/running/configuration.html
-                - label: Development
-                  path: guide/running/development.html
-                - label: Server
-                  path: guide/running/running.html
-                - label: Worker Manager
-                  path: guide/running/manager.html
-                - label: Dynamic Applications
-                  path: guide/running/app-loader.html
-                - label: Inspector
-                  path: guide/running/inspector.html
-          - label: Deployment
-            items:
-                - label: Caddy
-                  path: guide/deployment/caddy.html
-                - label: Nginx
-                  path: guide/deployment/nginx.html
-                - label: Docker
-                  path: guide/deployment/docker.html
-          - label: How to ...
-            items:
-                - label: Table of Contents
-                  path: guide/how-to/table-of-contents.html
-                - label: Application Mounting
-                  path: guide/how-to/mounting.html
-                - label: Authentication
-                  path: guide/how-to/authentication.html
-                - label: Autodiscovery
-                  path: guide/how-to/autodiscovery.html
-                - label: CORS
-                  path: guide/how-to/cors.html
-                - label: ORM
-                  path: guide/how-to/orm.html
-                - label: Static Redirects
-                  path: guide/how-to/static-redirects.html
-                - label: TLS/SSL/HTTPS
-                  path: guide/how-to/tls.html
-    - label: Plugins
-      items:
-          - label: Sanic Extensions
-            items:
-                - label: Getting Started
-                  path: plugins/sanic-ext/getting-started.html
-                - label: HTTP - Methods
-                  path: plugins/sanic-ext/http/methods.html
-                - label: HTTP - CORS Protection
-                  path: plugins/sanic-ext/http/cors.html
-                - label: OpenAPI - Basics
-                  path: plugins/sanic-ext/openapi/basics.html
-                - label: OpenAPI - UI
-                  path: plugins/sanic-ext/openapi/ui.html
-                - label: OpenAPI - Decorators
-                  path: plugins/sanic-ext/openapi/decorators.html
-                # - label: OpenAPI - Advanced
-                #   path: plugins/sanic-ext/openapi/advanced.html
-                - label: OpenAPI - Auto Documentation
-                  path: plugins/sanic-ext/openapi/autodoc.html
-                - label: OpenAPI - Security
-                  path: plugins/sanic-ext/openapi/security.html
-                - label: Convenience
-                  path: plugins/sanic-ext/convenience.html
-                - label: Templating - Jinja
-                  path: plugins/sanic-ext/templating/jinja.html
-                - label: Templating - html5tagger
-                  path: plugins/sanic-ext/templating/html5tagger.html
-                - label: Dependency Injection
-                  path: plugins/sanic-ext/injection.html
-                - label: Validation
-                  path: plugins/sanic-ext/validation.html
-                - label: Health Monitor
-                  path: plugins/sanic-ext/health-monitor.html
-                - label: Background Logger
-                  path: plugins/sanic-ext/logger.html
-                - label: Configuration
-                  path: plugins/sanic-ext/configuration.html
-                - label: Custom Extensions
-                  path: plugins/sanic-ext/custom.html
-          - label: Sanic Testing
-            items:
-                - label: Getting Started
-                  path: plugins/sanic-testing/getting-started.html
-                - label: Test Clients
-                  path: plugins/sanic-testing/clients.html
-    - label: Release Notes
-      items:
-          - label: "2023"
-            items:
-                - label: Sanic 23.6
-                  path: release-notes/2023/v23.6.html
-                - label: Sanic 23.3
-                  path: release-notes/2023/v23.3.html
-          - label: "2022"
-            items:
-                - label: Sanic 22.12
-                  path: release-notes/2022/v22.12.html
-                - label: Sanic 22.9
-                  path: release-notes/2022/v22.9.html
-                - label: Sanic 22.6
-                  path: release-notes/2022/v22.6.html
-                - label: Sanic 22.3
-                  path: release-notes/2022/v22.3.html
-          - label: "2021"
-            items:
-                - label: Sanic 21.12
-                  path: release-notes/2021/v21.12.html
-                - label: Sanic 21.9
-                  path: release-notes/2021/v21.9.html
-                - label: Sanic 21.6
-                  path: release-notes/2021/v21.6.html
-                - label: Sanic 21.3
-                  path: release-notes/2021/v21.3.html
-    - label: Organization
-      items:
-          - label: Contributing
-            path: organization/contributing.html
-          - label: Code of Conduct
-            path: organization/code-of-conduct.html
-          - label: S.C.O.P.E. (Governance)
-            path: organization/scope.html
-          - label: Policies
-            path: organization/policies.html
-    - label: API Reference
-      items:
-          - label: Application
-            items:
-                - label: sanic.app
-                  path: /api/sanic.app.html
-                - label: sanic.config
-                  path: /api/sanic.config.html
-                - label: sanic.application
-                  path: /api/sanic.application.html
-          - label: Blueprint
-            items:
-                - label: sanic.blueprints
-                  path: /api/sanic.blueprints.html
-                - label: sanic.blueprint_group
-                  path: /api/sanic.blueprint_group.html
-          - label: Constant
-            items:
-                - label: sanic.constants
-                  path: /api/sanic.constants.html
-          - label: Core
-            items:
-                - label: sanic.cookies
-                  path: /api/sanic.cookies.html
-                - label: sanic.handlers
-                  path: /api/sanic.handlers.html
-                - label: sanic.headers
-                  path: /api/sanic.headers.html
-                - label: sanic.middleware
-                  path: /api/sanic.middleware.html
-                - label: sanic.mixins
-                  path: /api/sanic.mixins.html
-                - label: sanic.request
-                  path: /api/sanic.request.html
-                - label: sanic.response
-                  path: /api/sanic.response.html
-                - label: sanic.views
-                  path: /api/sanic.views.html
-          - label: Display
-            items:
-                - label: sanic.pages
-                  path: /api/sanic.pages.html
-          - label: Exception
-            items:
-                - label: sanic.errorpages
-                  path: /api/sanic.errorpages.html
-                - label: sanic.exceptions
-                  path: /api/sanic.exceptions.html
-          - label: Model
-            items:
-                - label: sanic.models
-                  path: /api/sanic.models.html
-          - label: Routing
-            items:
-                - label: sanic.router
-                  path: /api/sanic.router.html
-                - label: sanic.signals
-                  path: /api/sanic.signals.html
-          - label: Server
-            items:
-                - label: sanic.http
-                  path: /api/sanic.http.html
-                - label: sanic.server
-                  path: /api/sanic.server.html
-                - label: sanic.worker
-                  path: /api/sanic.worker.html
-          - label: Utility
-            items:
-                - label: sanic.compat
-                  path: /api/sanic.compat.html
-                - label: sanic.helpers
-                  path: /api/sanic.helpers.html
-                - label: sanic.log
-                  path: /api/sanic.log.html
-                - label: sanic.utils
-                  path: /api/sanic.utils.html

guide/content/en/guide/advanced/class-based-views.md

@@ -1,202 +0,0 @@
-# Class Based Views
-
-## Why use them?
-
-.. column::
-
-    ### The problem
-
-    A common pattern when designing an API is to have multiple functionality on the same endpoint that depends upon the HTTP method.
-
-    While both of these options work, they are not good design practices and may be hard to maintain over time as your project grows.
-
-.. column::
-
-    ```python
-    @app.get("/foo")
-    async def foo_get(request):
-        ...
-
-    @app.post("/foo")
-    async def foo_post(request):
-        ...
-
-    @app.put("/foo")
-    async def foo_put(request):
-        ...
-
-    @app.route("/bar", methods=["GET", "POST", "PATCH"])
-    async def bar(request):
-        if request.method == "GET":
-            ...
-
-        elif request.method == "POST":
-            ...
-            
-        elif request.method == "PATCH":
-            ...
-    ```
-
-
-.. column::
-
-    ### The solution
-
-    Class-based views are simply classes that implement response behavior to requests. They provide a way to compartmentalize handling of different HTTP request types at the same endpoint.
-
-.. column::
-
-    ```python
-    from sanic.views import HTTPMethodView
-
-    class FooBar(HTTPMethodView):
-        async def get(self, request):
-            ...
-        
-        async def post(self, request):
-            ...
-        
-        async def put(self, request):
-            ...
-
-    app.add_route(FooBar.as_view(), "/foobar")
-    ```
-
-## Defining a view
-
-A class-based view should subclass `HTTPMethodView`. You can then implement class methods with the name of the corresponding HTTP method. If a request is received that has no defined method, a `405: Method not allowed` response will be generated.
-
-.. column::
-
-    To register a class-based view on an endpoint, the `app.add_route` method is used. The first argument should be the defined class with the method `as_view` invoked, and the second should be the URL endpoint.
-
-    The available methods are:
-
-    - get
-    - post
-    - put
-    - patch
-    - delete
-    - head
-    - options
-
-.. column::
-
-    ```python
-    from sanic.views import HTTPMethodView
-    from sanic.response import text
-
-    class SimpleView(HTTPMethodView):
-
-      def get(self, request):
-          return text("I am get method")
-
-      # You can also use async syntax
-      async def post(self, request):
-          return text("I am post method")
-
-      def put(self, request):
-          return text("I am put method")
-
-      def patch(self, request):
-          return text("I am patch method")
-
-      def delete(self, request):
-          return text("I am delete method")
-
-    app.add_route(SimpleView.as_view(), "/")
-    ```
-
-## Path parameters
-
-.. column::
-
-    You can use path parameters exactly as discussed in [the routing section](/guide/basics/routing.md).
-
-.. column::
-
-    ```python
-    class NameView(HTTPMethodView):
-
-      def get(self, request, name):
-        return text("Hello {}".format(name))
-
-    app.add_route(NameView.as_view(), "/<name>")
-    ```
-
-## Decorators
-
-As discussed in [the decorators section](/guide/best-practices/decorators.md), often you will need to add functionality to endpoints with the use of decorators. You have two options with CBV:
-
-1. Apply to _all_ HTTP methods in the view
-2. Apply individually to HTTP methods in the view
-
-Let's see what the options look like:
-
-.. column::
-
-    ### Apply to all methods
-
-    If you want to add any decorators to the class, you can set the `decorators` class variable. These will be applied to the class when `as_view` is called.
-
-.. column::
-
-    ```python
-    class ViewWithDecorator(HTTPMethodView):
-      decorators = [some_decorator_here]
-
-      def get(self, request, name):
-        return text("Hello I have a decorator")
-
-      def post(self, request, name):
-        return text("Hello I also have a decorator")
-
-    app.add_route(ViewWithDecorator.as_view(), "/url")
-    ```
-
-
-.. column::
-
-    ### Apply to individual methods
-
-    But if you just want to decorate some methods and not all methods, you can as shown here.
-
-.. column::
-
-    ```python
-    class ViewWithSomeDecorator(HTTPMethodView):
-
-        @staticmethod
-        @some_decorator_here
-        def get(request, name):
-            return text("Hello I have a decorator")
-
-        def post(self, request, name):
-            return text("Hello I do not have any decorators")
-
-        @some_decorator_here
-        def patch(self, request, name):
-            return text("Hello I have a decorator")
-    ```
-
-## Generating a URL
-
-.. column::
-
-    This works just like [generating any other URL](/guide/basics/routing.md#generating-a-url), except that the class name is a part of the endpoint.
-
-.. column::
-
-    ```python
-    @app.route("/")
-    def index(request):
-        url = app.url_for("SpecialClassView")
-        return redirect(url)
-
-    class SpecialClassView(HTTPMethodView):
-        def get(self, request):
-            return text("Hello from the Special Class View!")
-
-    app.add_route(SpecialClassView.as_view(), "/special_class_view")
-    ```
-

guide/content/en/guide/advanced/proxy-headers.md

@@ -1,477 +0,0 @@
-# Proxy configuration
-
-When you use a reverse proxy server (e.g. nginx), the value of `request.ip` will contain the IP of a proxy, typically `127.0.0.1`. Almost always, this is **not** what you will want.
-
-Sanic may be configured to use proxy headers for determining the true client IP, available as `request.remote_addr`. The full external URL is also constructed from header fields _if available_.
-
-
-.. tip:: Heads up
-
-    Without proper precautions, a malicious client may use proxy headers to spoof its own IP. To avoid such issues, Sanic does not use any proxy headers unless explicitly enabled.
-
-
-
-.. column::
-
-    Services behind reverse proxies must configure one or more of the following [configuration values](/guide/deployment/configuration.md):
-
-    - `FORWARDED_SECRET`
-    - `REAL_IP_HEADER`
-    - `PROXIES_COUNT`
-
-.. column::
-
-    ```python
-    app.config.FORWARDED_SECRET = "super-duper-secret"
-    app.config.REAL_IP_HEADER = "CF-Connecting-IP"
-    app.config.PROXIES_COUNT = 2
-    ```
-
-## Forwarded header
-
-In order to use the `Forwarded` header, you should set `app.config.FORWARDED_SECRET` to a value known to the trusted proxy server. The secret is used to securely identify a specific proxy server.
-
-Sanic ignores any elements without the secret key, and will not even parse the header if no secret is set.
-
-All other proxy headers are ignored once a trusted forwarded element is found, as it already carries complete information about the client.
-
-To learn more about the `Forwarded` header, read the related [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Forwarded) and [Nginx](https://www.nginx.com/resources/wiki/start/topics/examples/forwarded/) articles.
-
-## Traditional proxy headers
-
-### IP Headers
-
-When your proxy forwards you the IP address in a known header, you can tell Sanic what that is with the `REAL_IP_HEADER` config value.
-
-### X-Forwarded-For
-
-This header typically contains a chain of IP addresses through each layer of a proxy. Setting `PROXIES_COUNT` tells Sanic how deep to look to get an actual IP address for the client. This value should equal the _expected_ number of IP addresses in the chain.
-
-### Other X-headers
-
-If a client IP is found by one of these methods, Sanic uses the following headers for URL parts:
-
-- x-forwarded-proto
-- x-forwarded-host
-- x-forwarded-port
-- x-forwarded-path
-- x-scheme
-
-## Examples
-
-In the following examples, all requests will assume that the endpoint looks like this:
-```python
-@app.route("/fwd")
-async def forwarded(request):
-    return json(
-        {
-            "remote_addr": request.remote_addr,
-            "scheme": request.scheme,
-            "server_name": request.server_name,
-            "server_port": request.server_port,
-            "forwarded": request.forwarded,
-        }
-    )
-```
-
-.. column::
-
-    ---
-
-    ##### Example 1
-    Without configured FORWARDED_SECRET, x-headers should be respected
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H 'Forwarded: for=1.1.1.1, for=injected;host=", for="[::2]";proto=https;host=me.tld;path="/app/";secret=mySecret,for=broken;;secret=b0rked, for=127.0.0.3;scheme=http;port=1234' \
-        -H "X-Real-IP: 127.0.0.2" \
-        -H "X-Forwarded-For: 127.0.1.1" \
-        -H "X-Scheme: ws" \
-        -H "Host: local.site" | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "127.0.0.2",
-      "scheme": "ws",
-      "server_name": "local.site",
-      "server_port": 80,
-      "forwarded": {
-        "for": "127.0.0.2",
-        "proto": "ws"
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 2
-    FORWARDED_SECRET now configured
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H 'Forwarded: for=1.1.1.1, for=injected;host=", for="[::2]";proto=https;host=me.tld;path="/app/";secret=mySecret,for=broken;;secret=b0rked, for=127.0.0.3;scheme=http;port=1234' \
-        -H "X-Real-IP: 127.0.0.2" \
-        -H "X-Forwarded-For: 127.0.1.1" \
-        -H "X-Scheme: ws" \
-        -H "Host: local.site" | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "[::2]",
-      "scheme": "https",
-      "server_name": "me.tld",
-      "server_port": 443,
-      "forwarded": {
-        "for": "[::2]",
-        "proto": "https",
-        "host": "me.tld",
-        "path": "/app/",
-        "secret": "mySecret"
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 3
-    Empty Forwarded header -> use X-headers
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H "X-Real-IP: 127.0.0.2" \
-        -H "X-Forwarded-For: 127.0.1.1" \
-        -H "X-Scheme: ws" \
-        -H "Host: local.site" | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "127.0.0.2",
-      "scheme": "ws",
-      "server_name": "local.site",
-      "server_port": 80,
-      "forwarded": {
-        "for": "127.0.0.2",
-        "proto": "ws"
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 4
-    Header present but not matching anything
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H "Forwarded: nomatch" | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "",
-      "scheme": "http",
-      "server_name": "localhost",
-      "server_port": 8000,
-      "forwarded": {}
-    }
-
-    ```
-
----
-
-.. column::
-
-    ##### Example 5
-    Forwarded header present but no matching secret -> use X-headers
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H "Forwarded: for=1.1.1.1;secret=x, for=127.0.0.1" \
-        -H "X-Real-IP: 127.0.0.2" | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "127.0.0.2",
-      "scheme": "http",
-      "server_name": "localhost",
-      "server_port": 8000,
-      "forwarded": {
-        "for": "127.0.0.2"
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 6
-    Different formatting and hitting both ends of the header
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H 'Forwarded: Secret="mySecret";For=127.0.0.4;Port=1234' | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "127.0.0.4",
-      "scheme": "http",
-      "server_name": "localhost",
-      "server_port": 1234,
-      "forwarded": {
-        "secret": "mySecret",
-        "for": "127.0.0.4",
-        "port": 1234
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 7
-    Test escapes (modify this if you see anyone implementing quoted-pairs)
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H 'Forwarded: for=test;quoted="\,x=x;y=\";secret=mySecret' | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "test",
-      "scheme": "http",
-      "server_name": "localhost",
-      "server_port": 8000,
-      "forwarded": {
-        "for": "test",
-        "quoted": "\\,x=x;y=\\",
-        "secret": "mySecret"
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 8
-    Secret insulated by malformed field #1
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H 'Forwarded: for=test;secret=mySecret;b0rked;proto=wss;' | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "test",
-      "scheme": "http",
-      "server_name": "localhost",
-      "server_port": 8000,
-      "forwarded": {
-        "for": "test",
-        "secret": "mySecret"
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 9
-    Secret insulated by malformed field #2
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H 'Forwarded: for=test;b0rked;secret=mySecret;proto=wss' | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "",
-      "scheme": "wss",
-      "server_name": "localhost",
-      "server_port": 8000,
-      "forwarded": {
-        "secret": "mySecret",
-        "proto": "wss"
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 10
-    Unexpected termination should not lose existing acceptable values
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H 'Forwarded: b0rked;secret=mySecret;proto=wss' | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "",
-      "scheme": "wss",
-      "server_name": "localhost",
-      "server_port": 8000,
-      "forwarded": {
-        "secret": "mySecret",
-        "proto": "wss"
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 11
-    Field normalization
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "mySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H 'Forwarded: PROTO=WSS;BY="CAFE::8000";FOR=unknown;PORT=X;HOST="A:2";PATH="/With%20Spaces%22Quoted%22/sanicApp?key=val";SECRET=mySecret' | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "",
-      "scheme": "wss",
-      "server_name": "a",
-      "server_port": 2,
-      "forwarded": {
-        "proto": "wss",
-        "by": "[cafe::8000]",
-        "host": "a:2",
-        "path": "/With Spaces\"Quoted\"/sanicApp?key=val",
-        "secret": "mySecret"
-      }
-    }
-    ```
-
----
-
-.. column::
-
-    ##### Example 12
-    Using "by" field as secret
-    ```python
-    app.config.PROXIES_COUNT = 1
-    app.config.REAL_IP_HEADER = "x-real-ip"
-    app.config.FORWARDED_SECRET = "_proxySecret"
-    ```
-    ```bash
-    $ curl localhost:8000/fwd \
-        -H 'Forwarded: for=1.2.3.4; by=_proxySecret' | jq
-    ```
-
-.. column::
-
-    ```bash
-    # curl response
-    {
-      "remote_addr": "1.2.3.4",
-      "scheme": "http",
-      "server_name": "localhost",
-      "server_port": 8000,
-      "forwarded": {
-        "for": "1.2.3.4",
-        "by": "_proxySecret"
-      }
-    }
-
-    ```
-

guide/content/en/guide/advanced/signals.md

@@ -1,346 +0,0 @@
-# Signals
-
-Signals provide a way for one part of your application to tell another part that something happened.
-
-```python
-@app.signal("user.registration.created")
-async def send_registration_email(**context):
-    await send_email(context["email"], template="registration")
-
-@app.post("/register")
-async def handle_registration(request):
-    await do_registration(request)
-    await request.app.dispatch(
-        "user.registration.created",
-        context={"email": request.json.email}
-    })
-```
-
-## Adding a signal
-
-.. column::
-
-    The API for adding a signal is very similar to adding a route.
-
-.. column::
-
-    ```python
-    async def my_signal_handler():
-        print("something happened")
-
-    app.add_signal(my_signal_handler, "something.happened.ohmy")
-    ```
-
-
-.. column::
-
-    But, perhaps a slightly more convenient method is to use the built-in decorators.
-
-.. column::
-
-    ```python
-    @app.signal("something.happened.ohmy")
-    async def my_signal_handler():
-        print("something happened")
-    ```
-
-
-.. column::
-
-    If the signal requires conditions, make sure to add them while adding the handler.
-
-.. column::
-
-    ```python
-    async def my_signal_handler1():
-        print("something happened")
-
-    app.add_signal(
-        my_signal_handler,
-        "something.happened.ohmy1",
-        conditions={"some_condition": "value"}
-    )
-
-    @app.signal("something.happened.ohmy2", conditions={"some_condition": "value"})
-    async def my_signal_handler2():
-        print("something happened")
-    ```
-
-
-.. column::
-
-    Signals can also be declared on blueprints
-
-.. column::
-
-    ```python
-    bp = Blueprint("foo")
-
-    @bp.signal("something.happened.ohmy")
-    async def my_signal_handler():
-        print("something happened")
-    ```
-
-## Built-in signals
-
-In addition to creating a new signal, there are a number of built-in signals that are dispatched from Sanic itself. These signals exist to provide developers with more opportunities to add functionality into the request and server lifecycles.
-
-*Added in v21.9*
-
-.. column::
-
-    You can attach them just like any other signal to an application or blueprint instance.
-
-.. column::
-
-    ```python
-    @app.signal("http.lifecycle.complete")
-    async def my_signal_handler(conn_info):
-        print("Connection has been closed")
-    ```
-
-These signals are the signals that are available, along with the arguments that the handlers take, and the conditions that attach (if any).
-
-| Event name                 | Arguments                       | Conditions                                                |
-| -------------------------- | ------------------------------- | --------------------------------------------------------- |
-| `http.routing.before`      | request                         |                                                           |
-| `http.routing.after`       | request, route, kwargs, handler |                                                           |
-| `http.handler.before`      | request                         |                                                           |
-| `http.handler.after`       | request                         |                                                           |
-| `http.lifecycle.begin`     | conn_info                       |                                                           |
-| `http.lifecycle.read_head` | head                            |                                                           |
-| `http.lifecycle.request`   | request                         |                                                           |
-| `http.lifecycle.handle`    | request                         |                                                           |
-| `http.lifecycle.read_body` | body                            |                                                           |
-| `http.lifecycle.exception` | request, exception              |                                                           |
-| `http.lifecycle.response`  | request, response               |                                                           |
-| `http.lifecycle.send`      | data                            |                                                           |
-| `http.lifecycle.complete`  | conn_info                       |                                                           |
-| `http.middleware.before`   | request, response               | `{"attach_to": "request"}` or `{"attach_to": "response"}` |
-| `http.middleware.after`    | request, response               | `{"attach_to": "request"}` or `{"attach_to": "response"}` |
-| `server.exception.report`  | app, exception                  |                                                           |
-| `server.init.before`       | app, loop                       |                                                           |
-| `server.init.after`        | app, loop                       |                                                           |
-| `server.shutdown.before`   | app, loop                       |                                                           |
-| `server.shutdown.after`    | app, loop                       |                                                           |
-
-Version 22.9 added `http.handler.before` and `http.handler.after`.
-
-Version 23.6 added `server.exception.report`.
-
-.. column::
-
-    To make using the built-in signals easier, there is an `Enum` object that contains all of the allowed built-ins. With a modern IDE this will help so that you do not need to remember the full list of event names as strings.
-
-    *Added in v21.12*
-
-.. column::
-
-    ```python
-    from sanic.signals import Event
-
-    @app.signal(Event.HTTP_LIFECYCLE_COMPLETE)
-    async def my_signal_handler(conn_info):
-        print("Connection has been closed")
-    ```
-
-## Events
-
-.. column::
-
-    Signals are based off of an _event_. An event, is simply a string in the following pattern:
-
-.. column::
-
-    ```
-    namespace.reference.action
-    ```
-
-
-
-.. tip:: Events must have three parts. If you do not know what to use, try these patterns:
-
-    - `my_app.something.happened`
-    - `sanic.notice.hello`
-
-
-### Event parameters
-
-.. column::
-
-    An event can be "dynamic" and declared using the same syntax as [path parameters](../basics/routing.md#path-parameters). This allows matching based upon arbitrary values.
-
-.. column::
-
-    ```python
-    @app.signal("foo.bar.<thing>")
-    async def signal_handler(thing):
-        print(f"[signal_handler] {thing=}")
-
-    @app.get("/")
-    async def trigger(request):
-        await app.dispatch("foo.bar.baz")
-        return response.text("Done.")
-    ```
-
-Checkout [path parameters](../basics/routing.md#path-parameters) for more information on allowed type definitions.
-
-
-.. warning:: Only the third part of an event (the action) may be dynamic:
-
-    - `foo.bar.<thing>` 🆗
-    - `foo.<bar>.baz` ❌
-
-
-### Waiting
-
-.. column::
-
-    In addition to executing a signal handler, your application can wait for an event to be triggered.
-
-.. column::
-
-    ```python
-    await app.event("foo.bar.baz")
-    ```
-
-
-.. column::
-
-    **IMPORTANT**: waiting is a blocking function. Therefore, you likely will want this to run in a [background task](../basics/tasks.md).
-
-.. column::
-
-    ```python
-    async def wait_for_event(app):
-        while True:
-            print("> waiting")
-            await app.event("foo.bar.baz")
-            print("> event found\n")
-
-    @app.after_server_start
-    async def after_server_start(app, loop):
-        app.add_task(wait_for_event(app))
-    ```
-
-
-.. column::
-
-    If your event was defined with a dynamic path, you can use `*` to catch any action.
-
-.. column::
-
-    ```python
-    @app.signal("foo.bar.<thing>")
-
-    ...
-
-    await app.event("foo.bar.*")
-    ```
-
-## Dispatching
-
-*In the future, Sanic will dispatch some events automatically to assist developers to hook into life cycle events.*
-
-.. column::
-
-    Dispatching an event will do two things:
-
-    1. execute any signal handlers defined on the event, and
-    2. resolve anything that is "waiting" for the event to complete.
-
-.. column::
-
-    ```python
-    @app.signal("foo.bar.<thing>")
-    async def foo_bar(thing):
-        print(f"{thing=}")
-
-    await app.dispatch("foo.bar.baz")
-    ```
-    ```
-    thing=baz
-    ```
-
-### Context
-
-.. column::
-
-    Sometimes you may find the need to pass extra information into the signal handler. In our first example above, we wanted our email registration process to have the email address for the user.
-
-.. column::
-
-    ```python
-    @app.signal("user.registration.created")
-    async def send_registration_email(**context):
-        print(context)
-
-    await app.dispatch(
-        "user.registration.created",
-        context={"hello": "world"}
-    )
-    ```
-    ```
-    {'hello': 'world'}
-    ```
-
-
-
-.. tip:: FYI
-
-    Signals are dispatched in a background task.
-
-
-### Blueprints
-
-Dispatching blueprint signals works similar in concept to [middleware](../basics/middleware.md). Anything that is done from the app level, will trickle down to the blueprints. However, dispatching on a blueprint, will only execute the signals that are defined on that blueprint.
-
-.. column::
-
-    Perhaps an example is easier to explain:
-
-.. column::
-
-    ```python
-    bp = Blueprint("bp")
-
-    app_counter = 0
-    bp_counter = 0
-
-    @app.signal("foo.bar.baz")
-    def app_signal():
-        nonlocal app_counter
-        app_counter += 1
-
-    @bp.signal("foo.bar.baz")
-    def bp_signal():
-        nonlocal bp_counter
-        bp_counter += 1
-    ```
-
-
-.. column::
-
-    Running `app.dispatch("foo.bar.baz")` will execute both signals.
-
-.. column::
-
-    ```python
-    await app.dispatch("foo.bar.baz")
-    assert app_counter == 1
-    assert bp_counter == 1
-    ```
-
-
-.. column::
-
-    Running `bp.dispatch("foo.bar.baz")` will execute only the blueprint signal.
-
-.. column::
-
-    ```python
-    await bp.dispatch("foo.bar.baz")
-    assert app_counter == 1
-    assert bp_counter == 2
-    ```
-

guide/content/en/guide/advanced/streaming.md

@@ -1,151 +0,0 @@
-# Streaming
-
-## Request streaming
-
-Sanic allows you to stream data sent by the client to begin processing data as the bytes arrive.
-
-.. column::
-
-    When enabled on an endpoint, you can stream the request body using `await request.stream.read()`.
-
-    That method will return `None` when the body is completed.
-
-.. column::
-
-    ```python
-    from sanic.views import stream
-
-    class SimpleView(HTTPMethodView):
-        @stream
-        async def post(self, request):
-            result = ""
-            while True:
-                body = await request.stream.read()
-                if body is None:
-                    break
-                result += body.decode("utf-8")
-            return text(result)
-    ```
-
-
-.. column::
-
-    It also can be enabled with a keyword argument in the decorator...
-
-.. column::
-
-    ```python
-    @app.post("/stream", stream=True)
-    async def handler(request):
-            ...
-            body = await request.stream.read()
-            ...
-    ```
-
-
-.. column::
-
-    ... or the `add_route()` method.
-
-.. column::
-
-    ```python
-    bp.add_route(
-        bp_handler,
-        "/bp_stream",
-        methods=["POST"],
-        stream=True,
-    )
-    ```
-
-
-
-.. tip:: FYI
-
-    Only post, put and patch decorators have stream argument.
-
-
-## Response streaming
-
-.. column::
-
-    Sanic allows you to stream content to the client.
-
-.. column::
-
-    ```python
-    @app.route("/")
-    async def test(request):
-        response = await request.respond(content_type="text/csv")
-        await response.send("foo,")
-        await response.send("bar")
-
-        # Optionally, you can explicitly end the stream by calling:
-        await response.eof()
-    ```
-
-This is useful in situations where you want to stream content to the client that originates in an external service, like a database. For example, you can stream database records to the client with the asynchronous cursor that `asyncpg` provides.
-
-```python
-@app.route("/")
-async def index(request):
-    response = await request.respond()
-    conn = await asyncpg.connect(database='test')
-    async with conn.transaction():
-        async for record in conn.cursor('SELECT generate_series(0, 10)'):
-            await response.send(record[0])
-```
-
-
-You can explicitly end a stream by calling `await response.eof()`. It a convenience method to replace `await response.send("", True)`. It should be called **one time** *after* your handler has determined that it has nothing left to send back to the client. While it is *optional* to use with Sanic server, if you are running Sanic in ASGI mode, then you **must** explicitly terminate the stream.
-
-*Calling `eof` became optional in v21.6*
-
-## File streaming
-
-.. column::
-
-    Sanic provides `sanic.response.file_stream` function that is useful when you want to send a large file. It returns a `StreamingHTTPResponse` object and will use chunked transfer encoding by default; for this reason Sanic doesn’t add `Content-Length` HTTP header in the response.
-
-    A typical use case might be streaming an video file.
-
-.. column::
-
-    ```python
-    @app.route("/mp4")
-    async def handler_file_stream(request):
-        return await response.file_stream(
-            "/path/to/sample.mp4",
-            chunk_size=1024,
-            mime_type="application/metalink4+xml",
-            headers={
-                "Content-Disposition": 'Attachment; filename="nicer_name.meta4"',
-                "Content-Type": "application/metalink4+xml",
-            },
-        )
-    ```
-
-
-.. column::
-
-    If you want to use the `Content-Length` header, you can disable chunked transfer encoding and add it manually simply by adding the `Content-Length` header.
-
-.. column::
-
-    ```python
-    from aiofiles import os as async_os
-    from sanic.response import file_stream
-
-    @app.route("/")
-    async def index(request):
-        file_path = "/srv/www/whatever.png"
-
-        file_stat = await async_os.stat(file_path)
-        headers = {"Content-Length": str(file_stat.st_size)}
-
-        return await file_stream(
-            file_path,
-            headers=headers,
-        )
-    ```
-

guide/content/en/guide/advanced/versioning.md

@@ -1,170 +0,0 @@
-# Versioning
-
-It is standard practice in API building to add versions to your endpoints. This allows you to easily differentiate incompatible endpoints when you try and change your API down the road in a breaking manner.
-
-Adding a version will add a `/v{version}` url prefix to your endpoints.
-
-The version can be a `int`, `float`, or `str`. Acceptable values:
-
-- `1`, `2`, `3`
-- `1.1`, `2.25`, `3.0`
-- `"1"`, `"v1"`, `"v1.1"`
-
-## Per route
-
-.. column::
-
-    You can pass a version number to the routes directly.
-
-.. column::
-
-    ```python
-    # /v1/text
-    @app.route("/text", version=1)
-    def handle_request(request):
-        return response.text("Hello world! Version 1")
-
-    # /v2/text
-    @app.route("/text", version=2)
-    def handle_request(request):
-        return response.text("Hello world! Version 2")
-    ```
-
-## Per Blueprint
-
-.. column::
-
-    You can also pass a version number to the blueprint, which will apply to all routes in that blueprint.
-
-.. column::
-
-    ```python
-    bp = Blueprint("test", url_prefix="/foo", version=1)
-
-    # /v1/foo/html
-    @bp.route("/html")
-    def handle_request(request):
-        return response.html("<p>Hello world!</p>")
-    ```
-
-## Per Blueprint Group
-
-.. column::
-
-    In order to simplify the management of the versioned blueprints, you can provide a version number in the blueprint
-    group. The same will be inherited to all the blueprint grouped under it if the blueprints don't already override the
-    same information with a value specified while creating a blueprint instance.
-
-    When using blueprint groups for managing the versions, the following order is followed to apply the Version prefix to
-    the routes being registered.
-
-    1. Route Level configuration
-    2. Blueprint level configuration
-    3. Blueprint Group level configuration
-
-    If we find a more pointed versioning specification, we will pick that over the more generic versioning specification
-    provided under the Blueprint or Blueprint Group
-
-.. column::
-
-    ```python
-    from sanic.blueprints import Blueprint
-    from sanic.response import json
-
-    bp1 = Blueprint(
-        name="blueprint-1",
-        url_prefix="/bp1",
-        version=1.25,
-    )
-    bp2 = Blueprint(
-        name="blueprint-2",
-        url_prefix="/bp2",
-    )
-
-    group = Blueprint.group(
-        [bp1, bp2],
-        url_prefix="/bp-group",
-        version="v2",
-    )
-
-    # GET /v1.25/bp-group/bp1/endpoint-1
-    @bp1.get("/endpoint-1")
-    async def handle_endpoint_1_bp1(request):
-        return json({"Source": "blueprint-1/endpoint-1"})
-
-    # GET /v2/bp-group/bp2/endpoint-2
-    @bp2.get("/endpoint-1")
-    async def handle_endpoint_1_bp2(request):
-        return json({"Source": "blueprint-2/endpoint-1"})
-
-    # GET /v1/bp-group/bp2/endpoint-2
-    @bp2.get("/endpoint-2", version=1)
-    async def handle_endpoint_2_bp2(request):
-        return json({"Source": "blueprint-2/endpoint-2"})
-    ```
-
-## Version prefix
-
-As seen above, the `version` that is applied to a route is **always** the first segment in the generated URI path. Therefore, to make it possible to add path segments before the version, every place that a `version` argument is passed, you can also pass `version_prefix`. 
-
-The `version_prefix` argument can be defined in:
-
-- `app.route` and `bp.route` decorators (and all the convenience decorators also)
-- `Blueprint` instantiation
-- `Blueprint.group` constructor
-- `BlueprintGroup` instantiation
-- `app.blueprint` registration
-
-If there are definitions in multiple places, a more specific definition overrides a more general. This list provides that hierarchy.
-
-The default value of `version_prefix` is `/v`.
-
-.. column::
-
-    An often requested feature is to be able to mount versioned routes on `/api`. This can easily be accomplished with `version_prefix`.
-
-.. column::
-
-    ```python
-    # /v1/my/path
-    app.route("/my/path", version=1, version_prefix="/api/v")
-    ```
-
-
-.. column::
-
-    Perhaps a more compelling usage is to load all `/api` routes into a single `BlueprintGroup`.
-
-.. column::
-
-    ```python
-    # /v1/my/path
-    app = Sanic(__name__)
-    v2ip = Blueprint("v2ip", url_prefix="/ip", version=2)
-    api = Blueprint.group(v2ip, version_prefix="/api/version")
-
-    # /api/version2/ip
-    @v2ip.get("/")
-    async def handler(request):
-        return text(request.ip)
-
-    app.blueprint(api)
-    ```
-
-We can therefore learn that a route's URI is:
-
-```
-version_prefix + version + url_prefix + URI definition
-```
-
-
-.. tip:: 
-    
-    Just like with `url_prefix`, it is possible to define path parameters inside a `version_prefix`. It is perfectly legitimate to do this. Just remember that every route will have that parameter injected into the handler.
-
-    ```python
-    version_prefix="/<foo:str>/v"
-    ```
-
-
-*Added in v21.6*

guide/content/en/guide/advanced/websockets.md

@@ -1,82 +0,0 @@
-# Websockets
-
-Sanic provides an easy to use abstraction on top of [websockets](https://websockets.readthedocs.io/en/stable/).
-
-## Routing
-
-.. column::
-
-    Websocket handlers can be hooked up to the router similar to regular handlers.
-
-.. column::
-
-    ```python
-    from sanic import Request, Websocket
-
-    async def feed(request: Request, ws: Websocket):
-        pass
-
-    app.add_websocket_route(feed, "/feed")
-    ```
-    ```python
-    from sanic import Request, Websocket
-
-    @app.websocket("/feed")
-    async def feed(request: Request, ws: Websocket):
-        pass
-    ```
-
-## Handler
-
-
-.. column::
-
-    Typically, a websocket handler will want to hold open a loop.
-
-    It can then use the `send()` and `recv()` methods on the second object injected into the handler.
-
-    This example is a simple endpoint that echos back to the client messages that it receives.
-
-.. column::
-
-    ```python
-    from sanic import Request, Websocket
-
-    @app.websocket("/feed")
-    async def feed(request: Request, ws: Websocket):
-        while True:
-            data = "hello!"
-            print("Sending: " + data)
-            await ws.send(data)
-            data = await ws.recv()
-            print("Received: " + data)
-    ```
-
-
-.. column::
-
-    You can simplify your loop by just iterating over the `Websocket` object in a for loop.
-
-    *Added in v22.9*
-
-.. column::
-
-    ```python
-    from sanic import Request, Websocket
-
-    @app.websocket("/feed")
-    async def feed(request: Request, ws: Websocket):
-        async for msg in ws:
-            await ws.send(msg)
-    ```
-
-
-## Configuration
-
-See [configuration section](/guide/deployment/configuration.md) for more details, however the defaults are shown below.
-
-```python
-app.config.WEBSOCKET_MAX_SIZE = 2 ** 20
-app.config.WEBSOCKET_PING_INTERVAL = 20
-app.config.WEBSOCKET_PING_TIMEOUT = 20
-```

guide/content/en/guide/basics/README.md

@@ -1 +0,0 @@
-# Basics

guide/content/en/guide/basics/app.md

@@ -1,517 +0,0 @@
-# Sanic Application
-
-## Instance
-
-.. column::
-
-    The most basic building block is the `Sanic()` instance. It is not required, but the custom is to instantiate this in a file called `server.py`.
-
-.. column::
-
-    ```python
-    # /path/to/server.py
-
-    from sanic import Sanic
-
-    app = Sanic("MyHelloWorldApp")
-    ```
-
-## Application context
-
-Most applications will have the need to share/reuse data or objects across different parts of the code base. The most common example is DB connections. 
-
-.. column::
-
-    In versions of Sanic prior to v21.3, this was commonly done by attaching an attribute to the application instance
-
-.. column::
-
-    ```python
-    # Raises a warning as deprecated feature in 21.3
-    app = Sanic("MyApp")
-    app.db = Database()
-    ```
-
-
-.. column::
-
-    Because this can create potential problems with name conflicts, and to be consistent with [request context](./request.md#context) objects, v21.3 introduces application level context object.
-
-.. column::
-
-    ```python
-    # Correct way to attach objects to the application
-    app = Sanic("MyApp")
-    app.ctx.db = Database()
-    ```
-
-## App Registry
-
-.. column::
-
-    When you instantiate a Sanic instance, that can be retrieved at a later time from the Sanic app registry. This can be useful, for example, if you need to access your Sanic instance from a location where it is not otherwise accessible.
-
-.. column::
-
-    ```python
-    # ./path/to/server.py
-    from sanic import Sanic
-
-    app = Sanic("my_awesome_server")
-
-    # ./path/to/somewhere_else.py
-    from sanic import Sanic
-
-    app = Sanic.get_app("my_awesome_server")
-    ```
-
-
-.. column::
-
-    If you call `Sanic.get_app("non-existing")` on an app that does not exist, it will raise `SanicException` by default. You can, instead, force the method to return a new instance of Sanic with that name.
-
-.. column::
-
-    ```python
-    app = Sanic.get_app(
-        "non-existing",
-        force_create=True,
-    )
-    ```
-
-
-.. column::
-
-    If there is **only one** Sanic instance registered, then calling `Sanic.get_app()` with no arguments will return that instance
-
-.. column::
-
-    ```python
-    Sanic("My only app")
-
-    app = Sanic.get_app()
-    ```
-
-## Configuration
-
-.. column::
-
-    Sanic holds the configuration in the `config` attribute of the `Sanic` instance. Configuration can be modified **either** using dot-notation **OR** like a dictionary.
-
-.. column::
-
-    ```python
-    app = Sanic('myapp')
-
-    app.config.DB_NAME = 'appdb'
-    app.config['DB_USER'] = 'appuser'
-
-    db_settings = {
-        'DB_HOST': 'localhost',
-        'DB_NAME': 'appdb',
-        'DB_USER': 'appuser'
-    }
-    app.config.update(db_settings)
-    ```
-
-
-
-.. note:: Heads up
-
-    Config keys _should_ be uppercase. But, this is mainly by convention, and lowercase will work most of the time.
-    ```
-    app.config.GOOD = "yay!"
-    app.config.bad = "boo"
-    ```
-
-
-There is much [more detail about configuration](/guide/deployment/configuration.md) later on.
-
-## Customization
-
-The Sanic application instance can be customized for your application needs in a variety of ways at instantiation. 
-
-### Custom configuration
-
-.. column::
-
-    This simplest form of custom configuration would be to pass your own object directly into that Sanic application instance
-
-    If you create a custom configuration object, it is *highly* recommended that you subclass the Sanic `Config` option to inherit its behavior. You could use this option for adding properties, or your own set of custom logic.
-
-    *Added in v21.6*
-
-.. column::
-
-    ```python
-    from sanic.config import Config
-
-    class MyConfig(Config):
-        FOO = "bar"
-
-    app = Sanic(..., config=MyConfig())
-    ```
-
-
-.. column::
-
-    A useful example of this feature would be if you wanted to use a config file in a form that differs from what is [supported](../deployment/configuration.md#using-sanic-update-config).
-
-.. column::
-
-    ```python
-    from sanic import Sanic, text
-    from sanic.config import Config
-
-    class TomlConfig(Config):
-        def __init__(self, *args, path: str, **kwargs):
-            super().__init__(*args, **kwargs)
-
-            with open(path, "r") as f:
-                self.apply(toml.load(f))
-
-        def apply(self, config):
-            self.update(self._to_uppercase(config))
-
-        def _to_uppercase(self, obj: Dict[str, Any]) -> Dict[str, Any]:
-            retval: Dict[str, Any] = {}
-            for key, value in obj.items():
-                upper_key = key.upper()
-                if isinstance(value, list):
-                    retval[upper_key] = [
-                        self._to_uppercase(item) for item in value
-                    ]
-                elif isinstance(value, dict):
-                    retval[upper_key] = self._to_uppercase(value)
-                else:
-                    retval[upper_key] = value
-            return retval
-
-    toml_config = TomlConfig(path="/path/to/config.toml")
-    app = Sanic(toml_config.APP_NAME, config=toml_config)
-    ```
-
-### Custom context
-
-.. column::
-
-    By default, the application context is a [`SimpleNamespace()`](https://docs.python.org/3/library/types.html#types.SimpleNamespace) that allows you to set any properties you want on it. However, you also have the option of passing any object whatsoever instead.
-
-    *Added in v21.6*
-
-.. column::
-
-    ```python
-    app = Sanic(..., ctx=1)
-    ```
-
-    ```python
-    app = Sanic(..., ctx={})
-    ```
-
-    ```python
-    class MyContext:
-        ...
-
-    app = Sanic(..., ctx=MyContext())
-    ```
-
-### Custom requests
-
-.. column::
-
-    It is sometimes helpful to have your own `Request` class, and tell Sanic to use that instead of the default. One example is if you wanted to modify the default `request.id` generator.
-
-    
-
-    .. note:: Important
-
-        It is important to remember that you are passing the *class* not an instance of the class.
-
-
-.. column::
-
-    ```python
-    import time
-
-    from sanic import Request, Sanic, text
-
-    class NanoSecondRequest(Request):
-        @classmethod
-        def generate_id(*_):
-            return time.time_ns()
-
-    app = Sanic(..., request_class=NanoSecondRequest)
-
-    @app.get("/")
-    async def handler(request):
-        return text(str(request.id))
-    ```
-
-### Custom error handler
-
-.. column::
-
-    See [exception handling](../best-practices/exceptions.md#custom-error-handling) for more
-
-.. column::
-
-    ```python
-    from sanic.handlers import ErrorHandler
-
-    class CustomErrorHandler(ErrorHandler):
-        def default(self, request, exception):
-            ''' handles errors that have no error handlers assigned '''
-            # You custom error handling logic...
-            return super().default(request, exception)
-
-    app = Sanic(..., error_handler=CustomErrorHandler())
-    ```
-
-### Custom dumps function
-
-.. column::
-
-    It may sometimes be necessary or desirable to provide a custom function that serializes an object to JSON data.
-
-.. column::
-
-    ```python
-    import ujson
-
-    dumps = partial(ujson.dumps, escape_forward_slashes=False)
-    app = Sanic(__name__, dumps=dumps)
-    ```
-
-
-.. column::
-
-    Or, perhaps use another library or create your own.
-
-.. column::
-
-    ```python
-    from orjson import dumps
-
-    app = Sanic(__name__, dumps=dumps)
-    ```
-
-### Custom loads function
-
-.. column::
-
-    Similar to `dumps`, you can also provide a custom function for deserializing data.
-
-    *Added in v22.9*
-
-.. column::
-
-    ```python
-    from orjson import loads
-
-    app = Sanic(__name__, loads=loads)
-    ```
-
-
-
-.. new:: NEW in v23.6
-
-    ### Custom typed application
-
-The correct, default type of a Sanic application instance is:
-
-```python
-sanic.app.Sanic[sanic.config.Config, types.SimpleNamespace]
-```
-
-It refers to two generic types:
-
-1. The first is the type of the configuration object. It defaults to `sanic.config.Config`, but can be any subclass of that.
-2. The second is the type of the application context. It defaults to `types.SimpleNamespace`, but can be **any object** as show above.
-
-Let's look at some examples of how the type will change.
-
-.. column::
-
-    Consider this example where we pass a custom subclass of `Config` and a custom context object.
-
-.. column::
-
-    ```python
-    from sanic import Sanic
-    from sanic.config import Config
-
-    class CustomConfig(Config):
-        pass
-
-    app = Sanic("test", config=CustomConfig())
-    reveal_type(app) # N: Revealed type is "sanic.app.Sanic[main.CustomConfig, types.SimpleNamespace]"
-    ```
-    ```
-    sanic.app.Sanic[main.CustomConfig, types.SimpleNamespace]
-    ```
-
-
-.. column::
-
-    Similarly, when passing a custom context object, the type will change to reflect that.
-
-.. column::
-
-    ```python
-    from sanic import Sanic
-
-    class Foo:
-        pass
-
-    app = Sanic("test", ctx=Foo())
-    reveal_type(app)  # N: Revealed type is "sanic.app.Sanic[sanic.config.Config, main.Foo]"
-    ```
-    ```
-    sanic.app.Sanic[sanic.config.Config, main.Foo]
-    ```
-
-
-.. column::
-
-    Of course, you can set both the config and context to custom types.
-
-.. column::
-
-    ```python
-    from sanic import Sanic
-    from sanic.config import Config
-
-    class CustomConfig(Config):
-        pass
-
-    class Foo:
-        pass
-
-    app = Sanic("test", config=CustomConfig(), ctx=Foo())
-    reveal_type(app)  # N: Revealed type is "sanic.app.Sanic[main.CustomConfig, main.Foo]"
-    ```
-    ```
-    sanic.app.Sanic[main.CustomConfig, main.Foo]
-    ```
-
-This pattern is particularly useful if you create a custom type alias for your application instance so that you can use it to annotate listeners and handlers.
-
-```python
-# ./path/to/types.py
-from sanic.app import Sanic
-from sanic.config import Config
-from myapp.context import MyContext
-from typing import TypeAlias
-
-MyApp = TypeAlias("MyApp", Sanic[Config, MyContext])
-```
-
-```python
-# ./path/to/listeners.py
-from myapp.types import MyApp
-
-def add_listeners(app: MyApp):
-    @app.before_server_start
-    async def before_server_start(app: MyApp):
-        # do something with your fully typed app instance
-        await app.ctx.db.connect()
-```
-
-```python
-# ./path/to/server.py
-from myapp.types import MyApp
-from myapp.context import MyContext
-from myapp.config import MyConfig
-from myapp.listeners import add_listeners
-
-app = Sanic("myapp", config=MyConfig(), ctx=MyContext())
-add_listeners(app)
-```
-
-*Added in v23.6*
-
-### Custom typed request
-
-Sanic also allows you to customize the type of the request object. This is useful if you want to add custom properties to the request object, or be able to access your custom properties of a typed application instance.
-
-The correct, default type of a Sanic request instance is:
-
-```python
-sanic.request.Request[
-    sanic.app.Sanic[sanic.config.Config, types.SimpleNamespace],
-    types.SimpleNamespace
-]
-```
-
-It refers to two generic types:
-
-1. The first is the type of the application instance. It defaults to `sanic.app.Sanic[sanic.config.Config, types.SimpleNamespace]`, but can be any subclass of that.
-2. The second is the type of the request context. It defaults to `types.SimpleNamespace`, but can be **any object** as show above in [custom requests](#custom-requests).
-
-Let's look at some examples of how the type will change.
-
-.. column::
-
-    Expanding upon the full example above where there is a type alias for a customized application instance, we can also create a custom request type so that we can access those same type annotations.
-
-    Of course, you do not need type aliases for this to work. We are only showing them here to cut down on the amount of code shown.
-
-.. column::
-
-    ```python
-    from sanic import Request
-    from myapp.types import MyApp
-    from types import SimpleNamespace
-
-    def add_routes(app: MyApp):
-        @app.get("/")
-        async def handler(request: Request[MyApp, SimpleNamespace]):
-            # do something with your fully typed app instance
-            results = await request.app.ctx.db.query("SELECT * FROM foo")
-    ```
-
-
-.. column::
-
-    Perhaps you have a custom request object that generates a custom context object. You can type annotate it to properly access those properties with your IDE as shown here.
-
-.. column::
-
-    ```python
-    from sanic import Request, Sanic
-    from sanic.config import Config
-
-    class CustomConfig(Config):
-        pass
-
-    class Foo:
-        pass
-
-    class RequestContext:
-        foo: Foo
-
-    class CustomRequest(Request[Sanic[CustomConfig, Foo], RequestContext]):
-        @staticmethod
-        def make_context() -> RequestContext:
-            ctx = RequestContext()
-            ctx.foo = Foo()
-            return ctx
-
-    app = Sanic(
-        "test", config=CustomConfig(), ctx=Foo(), request_class=CustomRequest
-    )
-
-    @app.get("/")
-    async def handler(request: CustomRequest):
-        # Full access to typed:
-        # - custom application configuration object
-        # - custom application context object
-        # - custom request context object
-        pass
-    ```
-
-See more information in the [custom request context](./request.md#custom-request-context) section.
-
-*Added in v23.6*
-

guide/content/en/guide/basics/cookies.md

@@ -1,108 +0,0 @@
-# Cookies
-
-## Reading
-
-.. column::
-
-    Cookies can be accessed via the `Request` object’s `cookies` dictionary.
-
-.. column::
-
-    ```python
-    @app.route("/cookie")
-    async def test(request):
-        test_cookie = request.cookies.get("test")
-        return text(f"Test cookie: {test_cookie}")
-    ```
-
-
-
-.. tip:: FYI
-
-    💡 The `request.cookies` object is one of a few types that is a dictionary with each value being a `list`. This is because HTTP allows a single key to be reused to send multiple values.
-
-    Most of the time you will want to use the `.get()` method to access the first element and not a `list`. If you do want a `list` of all items, you can use `.getlist()`.
-
-    *Added in v23.3*
-
-
-
-## Writing
-
-.. column::
-
-    When returning a response, cookies can be set on the `Response` object: `response.cookies`. This object is an instance of `CookieJar` which is a special sort of dictionary that automatically will write the response headers for you.
-
-.. column::
-
-    ```python
-    @app.route("/cookie")
-    async def test(request):
-        response = text("There's a cookie up in this response")
-        response.add_cookie(
-            "test",
-            "It worked!",
-            domain=".yummy-yummy-cookie.com",
-            httponly=True
-        )
-        return response
-    ```
-
-Response cookies can be set like dictionary values and have the following parameters available:
-
-- `path: str` - The subset of URLs to which this cookie applies. Defaults to `/`.
-- `domain: str` - Specifies the domain for which the cookie is valid. An explicitly specified domain must always start with a dot.
-- `max_age: int` - Number of seconds the cookie should live for.
-- `expires: datetime` - The time for the cookie to expire on the client’s browser. Usually it is better to use max-age instead.
-- `secure: bool` - Specifies whether the cookie will only be sent via HTTPS. Defaults to `True`.
-- `httponly: bool` - Specifies whether the cookie cannot be read by JavaScript.
-- `samesite: str` - Available values: Lax, Strict, and None. Defaults to `Lax`.
-- `comment: str` - A comment (metadata).
-- `host_prefix: bool` - Whether to add the `__Host-` prefix to the cookie.
-- `secure_prefix: bool` - Whether to add the `__Secure-` prefix to the cookie.
-- `partitioned: bool` - Whether to mark the cookie as partitioned.
-
-To better understand the implications and usage of these values, it might be helpful to read the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) on [setting cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie).
-
-
-.. tip:: FYI
-
-    By default, Sanic will set the `secure` flag to `True` to ensure that cookies are only sent over HTTPS as a sensible default. This should not be impactful for local development since secure cookies over HTTP should still be sent to `localhost`. For more information, you should read the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#restrict_access_to_cookies) on [secure cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Secure).
-
-
-## Deleting
-
-.. column::
-
-    Cookies can be removed semantically or explicitly.
-
-.. column::
-
-    ```python
-    @app.route("/cookie")
-    async def test(request):
-        response = text("Time to eat some cookies muahaha")
-
-        # This cookie will be set to expire in 0 seconds
-        response.delete_cookie("eat_me")
-
-        # This cookie will self destruct in 5 seconds
-        response.add_cookie("fast_bake", "Be quick!", max_age=5)
-
-        return response
-    ```
-
-    *Don't forget to add `path` or `domain` if needed!*
-
-## Eating
-
-.. column::
-
-    Sanic likes cookies
-    
-.. column::
-
-    .. attrs::
-        :class: is-size-1 has-text-centered
-        
-        🍪

guide/content/en/guide/basics/handlers.md

@@ -1,131 +0,0 @@
-# Handlers
-
-The next important building block are your _handlers_. These are also sometimes called "views".
-
-In Sanic, a handler is any callable that takes at least a `Request` instance as an argument, and returns either an `HTTPResponse` instance, or a coroutine that does the same.
-
-
-
-.. column::
-
-    Huh? 😕
-
-    It is a **function**; either synchronous or asynchronous.
-
-    The job of the handler is to respond to an endpoint and do something. This is where the majority of your business logic will go.
-
-.. column::
-
-    ```python
-    def i_am_a_handler(request):
-        return HTTPResponse()
-
-    async def i_am_ALSO_a_handler(request):
-        return HTTPResponse()
-    ```
-
-.. tip:: Heads up
-
-    If you want to learn more about encapsulating your logic, checkout [class based views](/guide/advanced/class-based-views.md).
-
-
-.. column::
-
-    Then, all you need to do is wire it up to an endpoint. We'll learn more about [routing soon](./routing.md).
-
-    Let's look at a practical example.
-
-    - We use a convenience decorator on our app instance: `@app.get()`
-    - And a handy convenience method for generating out response object: `text()`
-
-    Mission accomplished :muscle:
-
-.. column::
-
-    ```python
-    from sanic.response import text
-
-    @app.get("/foo")
-    async def foo_handler(request):
-        return text("I said foo!")
-    ```
-
----
-
-## A word about _async_...
-
-.. column::
-
-    It is entirely possible to write handlers that are synchronous.
-
-    In this example, we are using the _blocking_ `time.sleep()` to simulate 100ms of processing time. Perhaps this represents fetching data from a DB, or a 3rd-party website.
-
-    Using four (4) worker processes and a common benchmarking tool:
-
-    - **956** requests in 30.10s
-    - Or, about **31.76** requests/second
-
-.. column::
-
-    ```python
-    @app.get("/sync")
-    def sync_handler(request):
-        time.sleep(0.1)
-        return text("Done.")
-    ```
-
-
-.. column::
-
-    Just by changing to the asynchronous alternative `asyncio.sleep()`, we see an incredible change in performance. 🚀
-
-    Using the same four (4) worker processes:
-
-    - **115,590** requests in 30.08s
-    - Or, about **3,843.17** requests/second
-
-    .. attrs::
-        :class: is-size-3
-    
-        🤯
-
-    Okay... this is a ridiculously overdramatic result. And any benchmark you see is inherently very biased. This example is meant to over-the-top show the benefit of `async/await` in the web world. Results will certainly vary. Tools like Sanic and other async Python libraries are not magic bullets that make things faster. They make them _more efficient_.
-
-    In our example, the asynchronous version is so much better because while one request is sleeping, it is able to start another one, and another one, and another one, and another one...
-
-    But, this is the point! Sanic is fast because it takes the available resources and squeezes performance out of them. It can handle many requests concurrently, which means more requests per second.
-
-.. column::
-
-    ```python
-    @app.get("/async")
-    async def async_handler(request):
-        await asyncio.sleep(0.1)
-        return text("Done.")
-    ```
-
-
-
-.. warning:: A common mistake!
-
-    Don't do this! You need to ping a website. What do you use? `pip install your-fav-request-library` 🙈
-
-    Instead, try using a client that is `async/await` capable. Your server will thank you. Avoid using blocking tools, and favor those that play well in the asynchronous ecosystem. If you need recommendations, check out [Awesome Sanic](https://github.com/mekicha/awesome-sanic).
-
-    Sanic uses [httpx](https://www.python-httpx.org/) inside of its testing package (sanic-testing) :wink:.
-
-
----
-
-## A fully annotated handler
-
-For those that are using type annotations...
-
-```python
-from sanic.response import HTTPResponse, text
-from sanic.request import Request
-
-@app.get("/typed")
-async def typed_handler(request: Request) -> HTTPResponse:
-    return text("Done.")
-```

guide/content/en/guide/basics/headers.md

@@ -1,229 +0,0 @@
-# Headers
-
-Request and response headers are available in the `Request` and `HTTPResponse` objects, respectively. They make use of the [`multidict` package](https://multidict.readthedocs.io/en/stable/multidict.html#cimultidict) that allows a single key to have multiple values.
-
-
-.. tip:: FYI
-
-    Header keys are converted to *lowercase* when parsed. Capitalization is not considered for headers.
-
-
-## Request
-
-Sanic does attempt to do some normalization on request headers before presenting them to the developer, and also make some potentially meaningful extractions for common use cases.
-
-.. column::
-
-    #### Tokens
-
-    Authorization tokens in the form `Token <token>` or `Bearer <token>` are extracted to the request object: `request.token`.
-
-.. column::
-
-    ```python
-    @app.route("/")
-    async def handler(request):
-        return text(request.token)
-    ```
-
-    ```bash
-    $ curl localhost:8000 \
-        -H "Authorization: Token ABCDEF12345679"
-    ABCDEF12345679
-    ```
-
-    ```bash
-    $ curl localhost:8000 \
-        -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
-    eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
-    ```
-
-### Proxy headers
-
-Sanic has special handling for proxy headers. See the [proxy headers](/guide/advanced/proxy-headers.md) section for more details.
-
-### Host header and dynamic URL construction
-
-.. column::
-
-    The *effective host* is available via `request.host`. This is not necessarily the same as the host header, as it prefers proxy-forwarded host and can be forced by the server name setting.
-
-    Webapps should generally use this accessor so that they can function the same no matter how they are deployed. The actual host header, if needed, can be found via `request.headers`
-
-    The effective host is also used in dynamic URL construction via `request.url_for`, which uses the request to determine the external address of a handler.
-
-    .. tip:: Be wary of malicious clients
-
-        These URLs can be manipulated by sending misleading host headers. `app.url_for` should be used instead if this is a concern.
-
-.. column::
-
-    ```python
-    app.config.SERVER_NAME = "https://example.com"
-
-    @app.route("/hosts", name="foo")
-    async def handler(request):
-        return json(
-            {
-                "effective host": request.host,
-                "host header": request.headers.get("host"),
-                "forwarded host": request.forwarded.get("host"),
-                "you are here": request.url_for("foo"),
-            }
-        )
-    ```
-
-    ```bash
-    $ curl localhost:8000/hosts
-    {
-      "effective host": "example.com",
-      "host header": "localhost:8000",
-      "forwarded host": null,
-      "you are here": "https://example.com/hosts"
-    }
-    ```
-
-### Other headers
-
-.. column::
-
-
-    All request headers are available on `request.headers`, and can be accessed in dictionary form. Capitalization is not considered for headers, and can be accessed using either uppercase or lowercase keys.
-
-.. column::
-
-    ```python
-    @app.route("/")
-    async def handler(request):
-        return json(
-            {
-                "foo_weakref": request.headers["foo"],
-                "foo_get": request.headers.get("Foo"),
-                "foo_getone": request.headers.getone("FOO"),
-                "foo_getall": request.headers.getall("fOo"),
-                "all": list(request.headers.items()),
-            }
-        )
-    ```
-
-    ```bash
-    $ curl localhost:9999/headers -H "Foo: one" -H "FOO: two"|jq
-    {
-      "foo_weakref": "one",
-      "foo_get": "one",
-      "foo_getone": "one",
-      "foo_getall": [
-        "one",
-        "two"
-      ],
-      "all": [
-        [
-          "host",
-          "localhost:9999"
-        ],
-        [
-          "user-agent",
-          "curl/7.76.1"
-        ],
-        [
-          "accept",
-          "*/*"
-        ],
-        [
-          "foo",
-          "one"
-        ],
-        [
-          "foo",
-          "two"
-        ]
-      ]
-    }
-    ```
-
-
-
-.. tip:: FYI
-
-    💡 The request.headers object is one of a few types that is a dictionary with each value being a list. This is because HTTP allows a single key to be reused to send multiple values.
-
-    Most of the time you will want to use the .get() or .getone() methods to access the first element and not a list. If you do want a list of all items, you can use .getall().
-
-
-### Request ID
-
-.. column::
-
-    Often it is convenient or necessary to track a request by its `X-Request-ID` header. You can easily access that as: `request.id`.
-
-.. column::
-
-    ```python
-    @app.route("/")
-    async def handler(request):
-        return text(request.id)
-    ```
-
-    ```bash
-    $ curl localhost:8000 \
-        -H "X-Request-ID: ABCDEF12345679"
-    ABCDEF12345679
-    ```
-
-## Response
-
-Sanic will automatically set the following response headers (when appropriate) for you:
-
-- `content-length`
-- `content-type`
-- `connection`
-- `transfer-encoding`
-
-In most circumstances, you should never need to worry about setting these headers.
-
-.. column::
-
-    Any other header that you would like to set can be done either in the route handler, or a response middleware.
-
-.. column::
-
-    ```python
-    @app.route("/")
-    async def handler(request):
-        return text("Done.", headers={"content-language": "en-US"})
-
-    @app.middleware("response")
-    async def add_csp(request, response):
-        response.headers["content-security-policy"] = "default-src 'none'; script-src 'self'; connect-src 'self'; img-src 'self'; style-src 'self';base-uri 'self';form-action 'self'"
-    ```
-
-
-.. column::
-
-    A common [middleware](middleware.md) you might want is to add a `X-Request-ID` header to every response. As stated above: `request.id` will provide the ID from the incoming request. But, even if no ID was supplied in the request headers, one will be automatically supplied for you.
-
-    [See API docs for more details](https://sanic.readthedocs.io/en/latest/sanic/api_reference.html#sanic.request.Request.id)
-
-.. column::
-
-    ```python
-    @app.route("/")
-    async def handler(request):
-        return text(str(request.id))
-
-    @app.on_response
-    async def add_request_id_header(request, response):
-        response.headers["X-Request-ID"] = request.id
-    ```
-
-    ```bash
-    $ curl localhost:8000 -i
-    HTTP/1.1 200 OK
-    X-Request-ID: 805a958e-9906-4e7a-8fe0-cbe83590431b
-    content-length: 36
-    connection: keep-alive
-    content-type: text/plain; charset=utf-8
-
-    805a958e-9906-4e7a-8fe0-cbe83590431b
-    ```
-

guide/content/en/guide/basics/listeners.md

@@ -1,243 +0,0 @@
-# Listeners
-
-Sanic provides you with eight (8) opportunities to inject an operation into the life cycle of your application server. This does not include the [signals](../advanced/signals.md), which allow further injection customization.
-
-There are two (2) that run **only** on your main Sanic process (ie, once per call to `sanic server.app`.)
-
-- `main_process_start`
-- `main_process_stop`
-
-There are also two (2) that run **only** in a reloader process if auto-reload has been turned on.
-
-- `reload_process_start`
-- `reload_process_stop`
-
-*Added `reload_process_start` and `reload_process_stop` in v22.3*
-
-There are four (4) that enable you to execute startup/teardown code as your server starts or closes.
-
-- `before_server_start`
-- `after_server_start`
-- `before_server_stop`
-- `after_server_stop`
-
-The life cycle of a worker process looks like this:
-
-.. mermaid::
-
-    sequenceDiagram
-    autonumber
-    participant Process
-    participant Worker
-    participant Listener
-    participant Handler
-    Note over Process: sanic server.app
-    loop
-        Process->>Listener: @app.main_process_start
-        Listener->>Handler: Invoke event handler
-    end
-    Process->>Worker: Run workers
-    loop Start each worker
-        loop
-            Worker->>Listener: @app.before_server_start
-            Listener->>Handler: Invoke event handler
-        end
-        Note over Worker: Server status: started
-        loop
-            Worker->>Listener: @app.after_server_start
-            Listener->>Handler: Invoke event handler
-        end
-        Note over Worker: Server status: ready
-    end
-    Process->>Worker: Graceful shutdown
-    loop Stop each worker
-        loop
-            Worker->>Listener: @app.before_server_stop
-            Listener->>Handler: Invoke event handler
-        end
-        Note over Worker: Server status: stopped
-        loop
-            Worker->>Listener: @app.after_server_stop
-            Listener->>Handler: Invoke event handler
-        end
-        Note over Worker: Server status: closed
-    end
-    loop
-        Process->>Listener: @app.main_process_stop
-        Listener->>Handler: Invoke event handler
-    end
-    Note over Process: exit
-
-
-The reloader process live outside of this worker process inside of a process that is responsible for starting and stopping the Sanic processes. Consider the following example:
-
-```python
-@app.reload_process_start
-async def reload_start(*_):
-    print(">>>>>> reload_start <<<<<<")
-
-@app.main_process_start
-async def main_start(*_):
-    print(">>>>>> main_start <<<<<<")
-```
-
-If this application were run with auto-reload turned on, the `reload_start` function would be called once. This is contrasted with `main_start`, which would be run every time a file is save and the reloader restarts the applicaition process.
-
-## Attaching a listener
-
-.. column::
-
-    The process to setup a function as a listener is similar to declaring a route.
-
-    The currently running `Sanic()` instance is injected into the listener.
-
-.. column::
-
-    ```python
-    async def setup_db(app):
-        app.ctx.db = await db_setup()
-
-    app.register_listener(setup_db, "before_server_start")
-    ```
-
-
-.. column::
-
-    The `Sanic` app instance also has a convenience decorator.
-
-.. column::
-
-    ```python
-    @app.listener("before_server_start")
-    async def setup_db(app):
-        app.ctx.db = await db_setup()
-    ```
-
-
-.. column::
-
-    Prior to v22.3, both the application instance and the current event loop were injected into the function. However, only the application instance is injected by default. If your function signature will accept both, then both the application and the loop will be injected as shown here.
-
-.. column::
-
-    ```python
-    @app.listener("before_server_start")
-    async def setup_db(app, loop):
-        app.ctx.db = await db_setup()
-    ```
-
-
-.. column::
-
-    You can shorten the decorator even further. This is helpful if you have an IDE with autocomplete.
-
-.. column::
-
-    ```python
-    @app.before_server_start
-    async def setup_db(app):
-        app.ctx.db = await db_setup()
-    ```
-
-## Order of execution
-
-Listeners are executed in the order they are declared during startup, and reverse order of declaration during teardown
-
-|                       | Phase           | Order   |
-|-----------------------|-----------------|---------|
-| `main_process_start`  | main startup    | regular 🙂 ⬇️ |
-| `before_server_start` | worker startup  | regular 🙂 ⬇️ |
-| `after_server_start`  | worker startup  | regular 🙂 ⬇️ |
-| `before_server_stop`  | worker shutdown | 🙃 ⬆️ reverse |
-| `after_server_stop`   | worker shutdown | 🙃 ⬆️ reverse |
-| `main_process_stop`   | main shutdown   | 🙃 ⬆️ reverse |
-
-Given the following setup, we should expect to see this in the console if we run two workers.
-
-.. column::
-
-    ```python
-    @app.listener("before_server_start")
-    async def listener_1(app, loop):
-        print("listener_1")
-
-    @app.before_server_start
-    async def listener_2(app, loop):
-        print("listener_2")
-
-    @app.listener("after_server_start")
-    async def listener_3(app, loop):
-        print("listener_3")
-
-    @app.after_server_start
-    async def listener_4(app, loop):
-        print("listener_4")
-
-    @app.listener("before_server_stop")
-    async def listener_5(app, loop):
-        print("listener_5")
-
-    @app.before_server_stop
-    async def listener_6(app, loop):
-        print("listener_6")
-
-    @app.listener("after_server_stop")
-    async def listener_7(app, loop):
-        print("listener_7")
-
-    @app.after_server_stop
-    async def listener_8(app, loop):
-        print("listener_8")
-    ```
-
-.. column::
-
-    ```bash
-    [pid: 1000000] [INFO] Goin' Fast @ http://127.0.0.1:9999
-    [pid: 1000000] [INFO] listener_0
-    [pid: 1111111] [INFO] listener_1
-    [pid: 1111111] [INFO] listener_2
-    [pid: 1111111] [INFO] listener_3
-    [pid: 1111111] [INFO] listener_4
-    [pid: 1111111] [INFO] Starting worker [1111111]
-    [pid: 1222222] [INFO] listener_1
-    [pid: 1222222] [INFO] listener_2
-    [pid: 1222222] [INFO] listener_3
-    [pid: 1222222] [INFO] listener_4
-    [pid: 1222222] [INFO] Starting worker [1222222]
-    [pid: 1111111] [INFO] Stopping worker [1111111]
-    [pid: 1222222] [INFO] Stopping worker [1222222]
-    [pid: 1222222] [INFO] listener_6
-    [pid: 1222222] [INFO] listener_5
-    [pid: 1222222] [INFO] listener_8
-    [pid: 1222222] [INFO] listener_7
-    [pid: 1111111] [INFO] listener_6
-    [pid: 1111111] [INFO] listener_5
-    [pid: 1111111] [INFO] listener_8
-    [pid: 1111111] [INFO] listener_7
-    [pid: 1000000] [INFO] listener_9
-    [pid: 1000000] [INFO] Server Stopped
-    ```
-    In the above example, notice how there are three processes running:
-
-    - `pid: 1000000` - The *main* process
-    - `pid: 1111111` - Worker 1
-    - `pid: 1222222` - Worker 2
-
-    *Just because our example groups all of one worker and then all of another, in reality since these are running on separate processes, the ordering between processes is not guaranteed. But, you can be sure that a single worker will **always** maintain its order.*
-
-
-
-.. tip:: FYI
-
-    The practical result of this is that if the first listener in `before_server_start` handler setups a database connection, listeners that are registered after it can rely upon that connection being alive both when they are started and stopped.
-
-
-## ASGI Mode
-
-If you are running your application with an ASGI server, then make note of the following changes:
-
-- `reload_process_start` and `reload_process_stop` will be **ignored**
-- `main_process_start` and `main_process_stop` will be **ignored**
-- `before_server_start` will run as early as it can, and will be before `after_server_start`, but technically, the server is already running at that point
-- `after_server_stop` will run as late as it can, and will be after `before_server_stop`, but technically, the server is still running at that point