Comment out premature tests

.coveragerc

@@ -1,14 +1,7 @@
 [run]
 branch = True
 source = sanic
-omit =
-    site-packages
-    sanic/__main__.py
-    sanic/compat.py
-    sanic/reloader_helpers.py
-    sanic/simple.py
-    sanic/utils.py
-    sanic/cli
+omit = site-packages, sanic/utils.py, sanic/__main__.py
 
 [html]
 directory = coverage
@@ -20,12 +13,3 @@ exclude_lines =
     noqa
     NOQA
     pragma: no cover
-omit =
-    site-packages
-    sanic/__main__.py
-    sanic/compat.py
-    sanic/reloader_helpers.py
-    sanic/simple.py
-    sanic/utils.py
-    sanic/cli
-skip_empty = True

.github/workflows/codeql-analysis.yml

@@ -1,21 +1,27 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
 name: "CodeQL"
 
 on:
   push:
-    branches:
-      - main
-      - "*LTS"
+    branches: [ master ]
   pull_request:
-    branches:
-      - main
-      - "*LTS"
-    types: [opened, synchronize, reopened, ready_for_review]
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
   schedule:
     - cron: '25 16 * * 0'
 
 jobs:
   analyze:
-    if: github.event.pull_request.draft == false
     name: Analyze
     runs-on: ubuntu-latest
 
@@ -23,18 +29,39 @@ jobs:
       fail-fast: false
       matrix:
         language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
     - name: Checkout repository
       uses: actions/checkout@v2
 
+    # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1
       with:
         languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
       uses: github/codeql-action/autobuild@v1
 
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v1

.github/workflows/coverage.yml

@@ -1,38 +0,0 @@
-name: Coverage check
-on:
-  push:
-    branches:
-      - main
-      - "*LTS"
-    tags:
-      - "!*" # Do not execute on tags
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-jobs:
-  test:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        python-version: [3.9]
-        os: [ubuntu-latest]
-      fail-fast: false
-
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies 🔨
-        run: |
-          python -m pip install --upgrade pip
-          pip install tox
-      - name: Run coverage
-        run: tox -e coverage
-        continue-on-error: true
-      - uses: codecov/codecov-action@v2
-        with:
-          files: ./coverage.xml
-          fail_ci_if_error: false

.github/workflows/on-demand.yml

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

@@ -1,36 +0,0 @@
-name: Security Analysis
-on:
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-    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

@@ -1,32 +0,0 @@
-name: Document Linter
-on:
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-    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

@@ -1,33 +0,0 @@
-name: Linter Checks
-on:
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-    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

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

@@ -1,47 +0,0 @@
-name: Python 3.10 Tests
-on:
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-    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

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

.github/workflows/pr-python38.yml

@@ -1,35 +0,0 @@
-name: Python 3.8 Tests
-on:
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-    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

@@ -1,47 +0,0 @@
-name: Python 3.9 Tests
-on:
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-    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

@@ -1,36 +0,0 @@
-name: Typing Checks
-on:
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-    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

@@ -1,38 +0,0 @@
-name: Run Unit Tests on Windows
-on:
-  pull_request:
-    branches:
-      - main
-      - "*LTS"
-    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

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

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

.gitignore

@@ -6,7 +6,6 @@
 .coverage
 .coverage.*
 coverage
-coverage.xml
 .tox
 settings.py
 .idea/*
@@ -19,6 +18,3 @@ build/*
 .DS_Store
 dist/*
 pip-wheel-metadata/
-.pytest_cache/*
-.venv/*
-.vscode/*

.travis.yml

@@ -0,0 +1,94 @@
+sudo: false
+language: python
+cache:
+  directories:
+    - $HOME/.cache/pip
+matrix:
+  include:
+    - env: TOX_ENV=py37
+      python: 3.7
+      dist: xenial
+      sudo: true
+      name: "Python 3.7 with Extensions"
+    - env: TOX_ENV=py37-no-ext
+      python: 3.7
+      dist: xenial
+      sudo: true
+      name: "Python 3.7 without Extensions"
+    - env: TOX_ENV=py38
+      python: 3.8
+      dist: xenial
+      sudo: true
+      name: "Python 3.8 with Extensions"
+    - env: TOX_ENV=py38-no-ext
+      python: 3.8
+      dist: xenial
+      sudo: true
+      name: "Python 3.8 without Extensions"
+    - env: TOX_ENV=py39
+      python: 3.9
+      dist: bionic
+      sudo: true
+      name: "Python 3.9 with Extensions"
+    - env: TOX_ENV=py39-no-ext
+      python: 3.9
+      dist: bionic
+      sudo: true
+      name: "Python 3.9 without Extensions"
+    - env: TOX_ENV=type-checking
+      python: 3.7
+      name: "Python 3.7 Type checks"
+    - env: TOX_ENV=type-checking
+      python: 3.8
+      name: "Python 3.8 Type checks"
+    - env: TOX_ENV=type-checking
+      python: 3.9
+      dist: bionic
+      name: "Python 3.9 Type checks"
+    - env: TOX_ENV=security
+      python: 3.7
+      dist: xenial
+      sudo: true
+      name: "Python 3.7 Bandit security scan"
+    - env: TOX_ENV=security
+      python: 3.8
+      dist: xenial
+      sudo: true
+      name: "Python 3.8 Bandit security scan"
+    - env: TOX_ENV=security
+      python: 3.9
+      dist: bionic
+      sudo: true
+      name: "Python 3.9 Bandit security scan"
+    - env: TOX_ENV=docs
+      python: 3.7
+      dist: xenial
+      sudo: true
+      name: "Python 3.7 Documentation tests"
+    - env: TOX_ENV=pyNightly
+      python: "nightly"
+      name: "Python nightly with Extensions"
+    - env: TOX_ENV=pyNightly-no-ext
+      python: "nightly"
+      name: "Python nightly without Extensions"
+  allow_failures:
+    - env: TOX_ENV=pyNightly
+      python: "nightly"
+      name: "Python nightly with Extensions"
+    - env: TOX_ENV=pyNightly-no-ext
+      python: "nightly"
+      name: "Python nightly without Extensions"
+install:
+  - pip install -U tox
+  - pip install codecov
+script: travis_retry tox -e $TOX_ENV
+after_success:
+  - codecov
+deploy:
+  provider: pypi
+  user: brewmaster
+  password:
+    secure: "GoawLwmbtJOgKB6AJ0ZSYUUnNwIoonseHBxaAUH3zu79TS/Afrq+yB3lsVaMSG0CbyDgN4FrfD1phT1NzbvZ1VcLIOTDtCrmpQ1kLDw+zwgF40ab8sp8fPkKVHHHfCCs1mjltHIpxQa5lZTJcAs6Bpi/lbUWWwYxFzSV8pHw4W4hY09EHUd2o+evLTSVxaploetSt725DJUYKICUr2eAtCC11IDnIW4CzBJEx6krVV3uhzfTJW0Ls17x0c6sdZ9icMnV/G9xO/eQH6RIHe4xcrWJ6cmLDNKoGAkJp+BKr1CeVVg7Jw/MzPjvZKL2/ki6Beue1y6GUIy7lOS7jPVaOEhJ23b0zQwFcLMZw+Tt+E3v6QfHk+B/WBBBnM3zUZed9UI+QyW8+lqLLt39sQX0FO0P3eaDh8qTXtUuon2jTyFMMAMTFRTNpJmpAzuBH9yeMmDeALPTh0HphI+BkoUl5q1QbWFYjjnZMH2CatApxpLybt9A7rwm//PbOG0TSI93GEKNQ4w5DYryKTfwHzRBptNSephJSuxZYEfJsmUtas5es1D7Fe0PkyjxNNSU+eO+8wsTlitLUsJO4k0jAgy+cEKdU7YJ3J0GZVXocSkrNnUfd2hQPcJ3UtEJx3hLqqr8EM7EZBAasc1yGHh36NFetclzFY24YPih0G1+XurhTys="
+  on:
+    tags: true
+  distributions: "sdist bdist_wheel"

CHANGELOG.rst

@@ -1,113 +1,8 @@
-.. 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.
-
-
-Version 21.6.1
---------------
-
-**Bugfixes**
-
-  * `#2178 <https://github.com/sanic-org/sanic/pull/2178>`_
-    Update sanic-routing to allow for better splitting of complex URI templates
-  * `#2183 <https://github.com/sanic-org/sanic/pull/2183>`_
-    Proper handling of chunked request bodies to resolve phantom 503 in logs
-  * `#2181 <https://github.com/sanic-org/sanic/pull/2181>`_
-    Resolve regression in exception logging
-  * `#2201 <https://github.com/sanic-org/sanic/pull/2201>`_
-    Cleanup request info in pipelined requests
-
-Version 21.6.0
---------------
-
-**Features**
-
-  * `#2094 <https://github.com/sanic-org/sanic/pull/2094>`_
-    Add ``response.eof()`` method for closing a stream in a handler
-  * `#2097 <https://github.com/sanic-org/sanic/pull/2097>`_
-    Allow case-insensitive HTTP Upgrade header
-  * `#2104 <https://github.com/sanic-org/sanic/pull/2104>`_
-    Explicit usage of CIMultiDict getters
-  * `#2109 <https://github.com/sanic-org/sanic/pull/2109>`_
-    Consistent use of error loggers
-  * `#2114 <https://github.com/sanic-org/sanic/pull/2114>`_
-    New ``client_ip`` access of connection info instance
-  * `#2119 <https://github.com/sanic-org/sanic/pull/2119>`_
-    Alternatate classes on instantiation for ``Config`` and ``Sanic.ctx``
-  * `#2133 <https://github.com/sanic-org/sanic/pull/2133>`_
-    Implement new version of AST router
-
-      * Proper differentiation between ``alpha`` and ``string`` param types
-      * Adds a ``slug`` param type, example: ``<foo:slug>``
-      * Deprecates ``<foo:string>`` in favor of ``<foo:str>``
-      * Deprecates ``<foo:number>`` in favor of ``<foo:float>``
-      * Adds a ``route.uri`` accessor
-  * `#2136 <https://github.com/sanic-org/sanic/pull/2136>`_
-    CLI improvements with new optional params
-  * `#2137 <https://github.com/sanic-org/sanic/pull/2137>`_
-    Add ``version_prefix`` to URL builders
-  * `#2140 <https://github.com/sanic-org/sanic/pull/2140>`_
-    Event autoregistration with ``EVENT_AUTOREGISTER``
-  * `#2146 <https://github.com/sanic-org/sanic/pull/2146>`_, `#2147 <https://github.com/sanic-org/sanic/pull/2147>`_
-    Require stricter names on  ``Sanic()`` and ``Blueprint()``
-  * `#2150 <https://github.com/sanic-org/sanic/pull/2150>`_
-    Infinitely reusable and nestable ``Blueprint`` and ``BlueprintGroup``
-  * `#2154 <https://github.com/sanic-org/sanic/pull/2154>`_
-    Upgrade ``websockets`` dependency to min version
-  * `#2155 <https://github.com/sanic-org/sanic/pull/2155>`_
-    Allow for maximum header sizes to be increased: ``REQUEST_MAX_HEADER_SIZE``
-  * `#2157 <https://github.com/sanic-org/sanic/pull/2157>`_
-    Allow app factory pattern in CLI
-  * `#2165 <https://github.com/sanic-org/sanic/pull/2165>`_
-    Change HTTP methods to enums
-  * `#2167 <https://github.com/sanic-org/sanic/pull/2167>`_
-    Allow auto-reloading on additional directories
-  * `#2168 <https://github.com/sanic-org/sanic/pull/2168>`_
-    Add simple HTTP server to CLI
-  * `#2170 <https://github.com/sanic-org/sanic/pull/2170>`_
-    Additional methods for attaching ``HTTPMethodView``
-
-**Bugfixes**
-
-  * `#2091 <https://github.com/sanic-org/sanic/pull/2091>`_
-    Fix ``UserWarning`` in ASGI mode for missing ``__slots__``
-  * `#2099 <https://github.com/sanic-org/sanic/pull/2099>`_
-    Fix static request handler logging exception on 404
-  * `#2110 <https://github.com/sanic-org/sanic/pull/2110>`_
-    Fix request.args.pop removes parameters inconsistently
-  * `#2107 <https://github.com/sanic-org/sanic/pull/2107>`_
-    Fix type hinting for load_env
-  * `#2127 <https://github.com/sanic-org/sanic/pull/2127>`_
-    Make sure ASGI ws subprotocols is a list
-  * `#2128 <https://github.com/sanic-org/sanic/pull/2128>`_
-    Fix issue where Blueprint exception handlers do not consistently route to proper handler
-
-
-**Deprecations and Removals**
-
-  * `#2156 <https://github.com/sanic-org/sanic/pull/2156>`_
-    Remove config value ``REQUEST_BUFFER_QUEUE_SIZE``
-  * `#2170 <https://github.com/sanic-org/sanic/pull/2170>`_
-    ``CompositionView`` deprecated and marked for removal in 21.12
-  * `#2172 <https://github.com/sanic-org/sanic/pull/2170>`_
-    Deprecate StreamingHTTPResponse
-
-**Developer infrastructure**
-
-  * `#2149 <https://github.com/sanic-org/sanic/pull/2149>`_
-    Remove Travis CI in favor of GitHub Actions
-
-**Improved Documentation**
-
-  * `#2164 <https://github.com/sanic-org/sanic/pull/2164>`_
-    Fix typo in documentation
-  * `#2100 <https://github.com/sanic-org/sanic/pull/2100>`_
-    Remove documentation for non-existent arguments
-
 Version 21.3.2
 --------------
 
-**Bugfixes**
+Bugfixes
+********
 
   * `#2081 <https://github.com/sanic-org/sanic/pull/2081>`_
     Disable response timeout on websocket connections
@@ -118,7 +13,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 +24,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 +78,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 +109,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 +129,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 +148,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 +171,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 +218,8 @@ Version 21.3.0
 Version 20.12.3
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#2021 <https://github.com/sanic-org/sanic/pull/2021>`_
@@ -325,7 +228,8 @@ Version 20.12.3
 Version 20.12.2
 ---------------
 
-**Dependencies**
+Dependencies
+************
 
   *
     `#2026 <https://github.com/sanic-org/sanic/pull/2026>`_
@@ -338,7 +242,8 @@ Version 20.12.2
 Version 19.12.5
 ---------------
 
-**Dependencies**
+Dependencies
+************
 
   *
     `#2025 <https://github.com/sanic-org/sanic/pull/2025>`_
@@ -351,7 +256,8 @@ Version 19.12.5
 Version 20.12.0
 ---------------
 
-**Features**
+Features
+********
 
   *
     `#1993 <https://github.com/sanic-org/sanic/pull/1993>`_
@@ -360,7 +266,8 @@ Version 20.12.0
 Version 20.12.0
 ---------------
 
-**Features**
+Features
+********
 
   *
     `#1945 <https://github.com/sanic-org/sanic/pull/1945>`_
@@ -398,19 +305,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>`_
@@ -424,7 +334,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>`_
@@ -442,7 +353,8 @@ Version 20.12.0
 Version 20.9.1
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1954 <https://github.com/sanic-org/sanic/pull/1954>`_
@@ -455,7 +367,8 @@ Version 20.9.1
 Version 19.12.3
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1959 <https://github.com/sanic-org/sanic/pull/1959>`_
@@ -466,7 +379,8 @@ Version 20.9.0
 ---------------
 
 
-**Features**
+Features
+********
 
   *
     `#1887 <https://github.com/sanic-org/sanic/pull/1887>`_
@@ -493,19 +407,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>`_,
@@ -520,7 +437,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>`_
@@ -530,7 +448,8 @@ Version 20.9.0
 Version 20.6.3
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1884 <https://github.com/sanic-org/sanic/pull/1884>`_
@@ -540,7 +459,8 @@ Version 20.6.3
 Version 20.6.2
 ---------------
 
-**Features**
+Features
+********
 
   *
     `#1641 <https://github.com/sanic-org/sanic/pull/1641>`_
@@ -550,7 +470,8 @@ Version 20.6.2
 Version 20.6.1
 ---------------
 
-**Features**
+Features
+********
 
   *
     `#1760 <https://github.com/sanic-org/sanic/pull/1760>`_
@@ -564,7 +485,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>`_
@@ -586,13 +508,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>`_
@@ -607,7 +531,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>`_
@@ -621,13 +546,14 @@ Version 20.6.1
 Version 20.6.0
 ---------------
 
-*Released, but unintentionally omitting PR #1880, so was replaced by 20.6.1*
+*Released, but unintentionally ommitting PR #1880, so was replaced by 20.6.1*
 
 
 Version 20.3.0
 ---------------
 
-**Features**
+Features
+********
 
   *
     `#1762 <https://github.com/sanic-org/sanic/pull/1762>`_
@@ -658,7 +584,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>`_
@@ -676,7 +603,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>`_
@@ -694,7 +622,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>`_
@@ -704,13 +633,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>`_
@@ -752,7 +683,8 @@ Version 20.3.0
 Version 19.12.0
 ---------------
 
-**Bugfixes**
+Bugfixes
+********
 
 - Fix blueprint middleware application
 
@@ -771,7 +703,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
 
@@ -785,7 +718,8 @@ Version 19.12.0
 Version 19.6.3
 --------------
 
-**Features**
+Features
+********
 
 - Enable Towncrier Support
 
@@ -793,7 +727,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
 
@@ -806,7 +741,8 @@ Version 19.6.3
 Version 19.6.2
 --------------
 
-**Features**
+Features
+********
 
   *
     `#1562 <https://github.com/sanic-org/sanic/pull/1562>`_
@@ -822,7 +758,8 @@ Version 19.6.2
     Add Configure support from object string
 
 
-**Bugfixes**
+Bugfixes
+********
 
   *
     `#1587 <https://github.com/sanic-org/sanic/pull/1587>`_
@@ -840,7 +777,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>`_
@@ -864,7 +802,8 @@ Version 19.6.2
 Version 19.3
 ------------
 
-**Features**
+Features
+********
 
   *
     `#1497 <https://github.com/sanic-org/sanic/pull/1497>`_
@@ -932,7 +871,8 @@ Version 19.3
 
     This is a breaking change.
 
-**Bugfixes**
+Bugfixes
+********
 
 
   *
@@ -968,7 +908,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)
@@ -976,7 +917,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
@@ -1037,19 +979,21 @@ Version 18.12
   * Fix Range header handling for static files (#1402)
   * Fix the logger and make it work (#1397)
   * Fix type pikcle->pickle in multiprocessing test
-  * Fix pickling blueprints Change the string passed in the "name" section of the namedtuples in Blueprint to match the name of the Blueprint module attribute name. This allows blueprints to be pickled and unpickled, without errors, which is a requirement of running Sanic in multiprocessing mode in Windows. Added a test for pickling and unpickling blueprints Added a test for pickling and unpickling sanic itself Added a test for enabling multiprocessing on an app with a blueprint (only useful to catch this bug if the tests are run on Windows).
+  * Fix pickling blueprints Change the string passed in the "name" section of the namedtuples in Blueprint to match the name of the Blueprint module attribute name. This allows blueprints to be pickled and unpickled, without errors, which is a requirment of running Sanic in multiprocessing mode in Windows. Added a test for pickling and unpickling blueprints Added a test for pickling and unpickling sanic itself Added a test for enabling multiprocessing on an app with a blueprint (only useful to catch this bug if the tests are run on Windows).
   * Fix document for logging
 
 Version 0.8
 -----------
 
-**0.8.3**
+0.8.3
+*****
 
 * Changes:
 
   * Ownership changed to org 'sanic-org'
 
-**0.8.0**
+0.8.0
+*****
 
 * Changes:
 
@@ -1074,7 +1018,7 @@ Version 0.8
   * Content-length header on 204/304 responses (Arnulfo Solís)
   * Extend WebSocketProtocol arguments and add docs (Bob Olde Hampsink, yunstanford)
   * Update development status from pre-alpha to beta (Maksim Anisenkov)
-  * KeepAlive Timeout log level changed to debug (Arnulfo Solís)
+  * KeepAlive Timout log level changed to debug (Arnulfo Solís)
   * Pin pytest to 3.3.2 because of pytest-dev/pytest#3170 (Maksim Aniskenov)
   * Install Python 3.5 and 3.6 on docker container for tests (Shahin Azad)
   * Add support for blueprint groups and nesting (Elias Tarhini)
@@ -1129,16 +1073,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
@@ -1146,19 +1093,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

CONTRIBUTING.rst

@@ -19,7 +19,7 @@ a virtual environment already set up, then run:
 
 .. code-block:: bash
 
-   pip install -e ".[dev]"
+   pip3 install -e . ".[dev]"
 
 Dependency Changes
 ------------------
@@ -87,7 +87,7 @@ Permform ``flake8``\ , ``black`` and ``isort`` checks.
    tox -e lint
 
 Run type annotation checks
---------------------------
+---------------
 
 ``tox`` environment -> ``[testenv:type-checking]``
 

Makefile

@@ -49,9 +49,6 @@ test: clean
 test-coverage: clean
 	python setup.py test --pytest-args="--cov sanic --cov-report term --cov-append "
 
-view-coverage:
-	sanic ./coverage --simple
-
 install:
 	python setup.py install
 
@@ -88,7 +85,8 @@ docs-test: docs-clean
 	cd docs && make dummy
 
 docs-serve:
-	sphinx-autobuild docs docs/_build/html --port 9999 --watch ./
+	# python -m http.server --directory=./docs/_build/html 9999
+	sphinx-autobuild docs docs/_build/html --port 9999 --watch ./sanic
 
 changelog:
 	python scripts/changelog.py

README.rst

@@ -11,7 +11,7 @@ Sanic | Build fast. Run fast.
     :stub-columns: 1
 
     * - Build
-      - | |Py310Test| |Py39Test| |Py38Test| |Py37Test|
+      - | |Build Status| |AppVeyor Build Status| |Codecov|
     * - Docs
       - | |UserGuide| |Documentation|
     * - Package
@@ -27,14 +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
-.. |Py310Test| image:: https://github.com/sanic-org/sanic/actions/workflows/pr-python310.yml/badge.svg?branch=main
-   :target: https://github.com/sanic-org/sanic/actions/workflows/pr-python310.yml
-.. |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/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
+.. |Codecov| image:: https://codecov.io/gh/sanic-org/sanic/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/sanic-org/sanic
+.. |Build Status| image:: https://travis-ci.com/sanic-org/sanic.svg?branch=master
+   :target: https://travis-ci.com/sanic-org/sanic
+.. |AppVeyor Build Status| image:: https://ci.appveyor.com/api/projects/status/d8pt3ids0ynexi8c/branch/master?svg=true
+   :target: https://ci.appveyor.com/project/sanic-org/sanic
 .. |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
@@ -66,7 +64,7 @@ Sanic | Build fast. Run fast.
 
 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>`_
 
@@ -77,11 +75,17 @@ The goal of the project is to provide a simple way to get up and running a highl
 Sponsor
 -------
 
-Check out `open collective <https://opencollective.com/sanic-org>`_ to learn more about helping to fund Sanic. 
+|Try CodeStream|
 
-Thanks to `Linode <https://www.linode.com>`_ for their contribution towards the development and community of Sanic.
+.. |Try CodeStream| image:: https://alt-images.codestream.com/codestream_logo_sanicorg.png
+   :target: https://codestream.com/?utm_source=github&amp;utm_campaign=sanicorg&amp;utm_medium=banner
+   :alt: Try CodeStream
 
-|Linode|
+Manage pull requests and conduct code reviews in your IDE with full source-tree context. Comment on any line, not just the diffs. Use jump-to-definition, your favorite keybindings, and code intelligence with more of your workflow.
+
+`Learn More <https://codestream.com/?utm_source=github&amp;utm_campaign=sanicorg&amp;utm_medium=banner>`_
+
+Thank you to our sponsor. Check out `open collective <https://opencollective.com/sanic-org>`_ to learn more about helping to fund Sanic.
 
 Installation
 ------------
@@ -166,8 +170,3 @@ 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

codecov.yml

@@ -1,27 +1,14 @@
+codecov:
+  require_ci_to_pass: no
 coverage:
+  precision: 3
+  round: nearest
   status:
-    patch:
-      default:
-        target: auto
-        threshold: 0.75
     project:
       default:
         target: auto
-        threshold: 0.5
-  precision: 3
-codecov:
-  require_ci_to_pass: false
-ignore:
-  - "sanic/__main__.py"
-  - "sanic/compat.py"
-  - "sanic/reloader_helpers.py"
-  - "sanic/simple.py"
-  - "sanic/utils.py"
-  - "sanic/cli"
-  - ".github/"
-  - "changelogs/"
-  - "docker/"
-  - "docs/"
-  - "examples/"
-  - "scripts/"
-  - "tests/"
+        threshold: 0.5%
+    patch:
+      default:
+        target: auto
+        threshold: 0.75%

docker/Dockerfile

@@ -1,9 +1,28 @@
-ARG BASE_IMAGE_TAG
+FROM alpine:3.7
 
-FROM sanicframework/sanic-build:${BASE_IMAGE_TAG}
+RUN apk add --no-cache --update \
+        curl \
+        bash \
+        build-base \
+        ca-certificates \
+        git \
+        bzip2-dev \
+        linux-headers \
+        ncurses-dev \
+        openssl \
+        openssl-dev \
+        readline-dev \
+        sqlite-dev
 
-RUN apk update
 RUN update-ca-certificates
+RUN rm -rf /var/cache/apk/*
 
-RUN pip install sanic
-RUN apk del build-base
+ENV PYENV_ROOT="/root/.pyenv"
+ENV PATH="$PYENV_ROOT/bin:$PATH"
+
+ADD . /app
+WORKDIR /app
+
+RUN /app/docker/bin/install_python.sh 3.5.4 3.6.4
+
+ENTRYPOINT ["./docker/bin/entrypoint.sh"]

docker/Dockerfile-base

@@ -1,9 +0,0 @@
-ARG PYTHON_VERSION
-
-FROM python:${PYTHON_VERSION}-alpine
-RUN apk update
-RUN apk add --no-cache --update build-base \
-        ca-certificates \
-        openssl
-RUN update-ca-certificates
-RUN rm -rf /var/cache/apk/*

docker/bin/entrypoint.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -e
+
+eval "$(pyenv init -)"
+eval "$(pyenv virtualenv-init -)"
+source /root/.pyenv/completions/pyenv.bash
+
+pip install tox
+
+exec $@
+

docker/bin/install_python.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -e
+
+export CFLAGS='-O2'
+export EXTRA_CFLAGS="-DTHREAD_STACK_SIZE=0x100000"
+
+curl -L https://raw.githubusercontent.com/pyenv/pyenv-installer/master/bin/pyenv-installer | bash
+eval "$(pyenv init -)"
+
+for ver in $@
+do
+    pyenv install $ver
+done
+
+pyenv global $@
+pip install --upgrade pip
+pyenv rehash

docs/conf.py

@@ -10,8 +10,10 @@
 import os
 import sys
 
-
 # Add support for auto-doc
+import recommonmark
+
+from recommonmark.transform import AutoStructify
 
 
 # Ensure that sanic is present in the path, to allow sphinx-apidoc to
@@ -24,7 +26,7 @@ import sanic
 
 # -- General configuration ------------------------------------------------
 
-extensions = ["sphinx.ext.autodoc", "m2r2"]
+extensions = ["sphinx.ext.autodoc", "recommonmark"]
 
 templates_path = ["_templates"]
 
@@ -160,6 +162,20 @@ autodoc_default_options = {
     "member-order": "groupwise",
 }
 
+
+# app setup hook
+def setup(app):
+    app.add_config_value(
+        "recommonmark_config",
+        {
+            "enable_eval_rst": True,
+            "enable_auto_doc_ref": False,
+        },
+        True,
+    )
+    app.add_transform(AutoStructify)
+
+
 html_theme_options = {
     "style_external_links": False,
 }

docs/sanic/api/app.rst

@@ -1,17 +0,0 @@
-Application
-===========
-
-sanic.app
----------
-
-.. automodule:: sanic.app
-    :members:
-    :show-inheritance:
-    :inherited-members:
-
-sanic.config
-------------
-
-.. automodule:: sanic.config
-    :members:
-    :show-inheritance:

docs/sanic/api/blueprints.rst

@@ -1,17 +0,0 @@
-Blueprints
-==========
-
-sanic.blueprints
-----------------
-
-.. automodule:: sanic.blueprints
-    :members:
-    :show-inheritance:
-    :inherited-members:
-
-sanic.blueprint_group
----------------------
-
-.. automodule:: sanic.blueprint_group
-    :members:
-    :special-members:

docs/sanic/api/core.rst

@@ -1,40 +0,0 @@
-Core
-====
-
-sanic.cookies
--------------
-
-.. automodule:: sanic.cookies
-    :members:
-    :show-inheritance:
-
-
-sanic.handlers
---------------
-
-.. automodule:: sanic.handlers
-    :members:
-    :show-inheritance:
-
-
-sanic.request
--------------
-
-.. automodule:: sanic.request
-    :members:
-    :show-inheritance:
-
-sanic.response
---------------
-
-.. automodule:: sanic.response
-    :members:
-    :show-inheritance:
-
-
-sanic.views
------------
-
-.. automodule:: sanic.views
-    :members:
-    :show-inheritance:

docs/sanic/api/exceptions.rst

@@ -1,16 +0,0 @@
-Exceptions
-==========
-
-sanic.errorpages
-----------------
-
-.. automodule:: sanic.errorpages
-    :members:
-    :show-inheritance:
-
-sanic.exceptions
-----------------
-
-.. automodule:: sanic.exceptions
-    :members:
-    :show-inheritance:

docs/sanic/api/router.rst

@@ -1,18 +0,0 @@
-Routing
-=======
-
-sanic_routing models
---------------------
-
-.. autoclass:: sanic_routing.route::Route
-    :members:
-
-.. autoclass:: sanic_routing.group::RouteGroup
-    :members:
-
-sanic.router
-------------
-
-.. automodule:: sanic.router
-    :members:
-    :show-inheritance:

docs/sanic/api/server.rst

@@ -1,25 +0,0 @@
-Sanic Server
-============
-
-sanic.http
-----------
-
-.. automodule:: sanic.http
-    :members:
-    :show-inheritance:
-
-
-sanic.server
-------------
-
-.. automodule:: sanic.server
-    :members:
-    :show-inheritance:
-
-
-sanic.worker
-------------
-
-.. automodule:: sanic.worker
-    :members:
-    :show-inheritance:

docs/sanic/api/utility.rst

@@ -1,16 +0,0 @@
-Utility
-=======
-
-sanic.compat
-------------
-
-.. automodule:: sanic.compat
-    :members:
-    :show-inheritance:
-
-sanic.log
----------
-
-.. automodule:: sanic.log
-    :members:
-    :show-inheritance:

docs/sanic/api_reference.rst

@@ -1,13 +1,132 @@
 📑 API Reference
 ================
 
-.. toctree::
-   :maxdepth: 2
+sanic.app
+---------
 
-   api/app
-   api/blueprints
-   api/core
-   api/exceptions
-   api/router
-   api/server
-   api/utility
+.. automodule:: sanic.app
+    :members:
+    :show-inheritance:
+    :inherited-members:
+
+sanic.blueprints
+----------------
+
+.. automodule:: sanic.blueprints
+    :members:
+    :show-inheritance:
+    :inherited-members:
+
+sanic.blueprint_group
+---------------------
+
+.. automodule:: sanic.blueprint_group
+    :members:
+    :special-members:
+
+
+sanic.compat
+------------
+
+.. automodule:: sanic.compat
+    :members:
+    :show-inheritance:
+
+sanic.config
+------------
+
+.. automodule:: sanic.config
+    :members:
+    :show-inheritance:
+
+sanic.cookies
+-------------
+
+.. automodule:: sanic.cookies
+    :members:
+    :show-inheritance:
+
+sanic.errorpages
+----------------
+
+.. automodule:: sanic.errorpages
+    :members:
+    :show-inheritance:
+
+sanic.exceptions
+----------------
+
+.. automodule:: sanic.exceptions
+    :members:
+    :show-inheritance:
+
+sanic.handlers
+--------------
+
+.. automodule:: sanic.handlers
+    :members:
+    :show-inheritance:
+
+sanic.http
+----------
+
+.. automodule:: sanic.http
+    :members:
+    :show-inheritance:
+
+sanic.log
+---------
+
+.. automodule:: sanic.log
+    :members:
+    :show-inheritance:
+
+sanic.request
+-------------
+
+.. automodule:: sanic.request
+    :members:
+    :show-inheritance:
+
+sanic.response
+--------------
+
+.. automodule:: sanic.response
+    :members:
+    :show-inheritance:
+
+sanic.router
+------------
+
+.. automodule:: sanic.router
+    :members:
+    :show-inheritance:
+
+sanic.server
+------------
+
+.. automodule:: sanic.server
+    :members:
+    :show-inheritance:
+
+
+sanic.views
+-----------
+
+.. automodule:: sanic.views
+    :members:
+    :show-inheritance:
+
+sanic.websocket
+---------------
+
+.. automodule:: sanic.websocket
+    :members:
+    :show-inheritance:
+
+sanic.worker
+------------
+
+.. automodule:: sanic.worker
+    :members:
+    :show-inheritance:

docs/sanic/changelog.rst

@@ -1,6 +1,4 @@
 📜 Changelog
 ============
 
-.. mdinclude:: ./releases/21/21.12.md
-.. mdinclude:: ./releases/21/21.9.md
 .. include:: ../../CHANGELOG.rst

docs/sanic/releases/21/21.12.md

@@ -1,64 +0,0 @@
-## Version 21.12.1
-
-- [#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/21/21.9.md

@@ -1,50 +0,0 @@
-## Version 21.9.3
-*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
-- [#2160](https://github.com/sanic-org/sanic/pull/2160) Add new 17 signals into server and request lifecycles
-- [#2162](https://github.com/sanic-org/sanic/pull/2162) Smarter `auto` fallback formatting upon exception
-- [#2184](https://github.com/sanic-org/sanic/pull/2184) Introduce implementation for copying a Blueprint
-- [#2200](https://github.com/sanic-org/sanic/pull/2200) Accept header parsing
-- [#2207](https://github.com/sanic-org/sanic/pull/2207) Log remote address if available
-- [#2209](https://github.com/sanic-org/sanic/pull/2209) Add convenience methods to BP groups
-- [#2216](https://github.com/sanic-org/sanic/pull/2216) Add default messages to SanicExceptions
-- [#2225](https://github.com/sanic-org/sanic/pull/2225) Type annotation convenience for annotated handlers with path parameters
-- [#2236](https://github.com/sanic-org/sanic/pull/2236) Allow Falsey (but not-None) responses from route handlers
-- [#2238](https://github.com/sanic-org/sanic/pull/2238) Add `exception` decorator to Blueprint Groups
-- [#2244](https://github.com/sanic-org/sanic/pull/2244) Explicit static directive for serving file or dir (ex: `static(..., resource_type="file")`)
-- [#2245](https://github.com/sanic-org/sanic/pull/2245) Close HTTP loop when connection task cancelled
-
-### Bugfixes
-- [#2188](https://github.com/sanic-org/sanic/pull/2188) Fix the handling of the end of a chunked request
-- [#2195](https://github.com/sanic-org/sanic/pull/2195) Resolve unexpected error handling on static requests
-- [#2208](https://github.com/sanic-org/sanic/pull/2208) Make blueprint-based exceptions attach and trigger in a more intuitive manner
-- [#2211](https://github.com/sanic-org/sanic/pull/2211) Fixed for handling exceptions of asgi app call
-- [#2213](https://github.com/sanic-org/sanic/pull/2213) Fix bug where ws exceptions not being logged
-- [#2231](https://github.com/sanic-org/sanic/pull/2231) Cleaner closing of tasks by using `abort()` in strategic places to avoid dangling sockets
-- [#2247](https://github.com/sanic-org/sanic/pull/2247) Fix logging of auto-reload status in debug mode
-- [#2246](https://github.com/sanic-org/sanic/pull/2246) Account for BP with exception handler but no routes
-
-### Developer infrastructure  
-- [#2194](https://github.com/sanic-org/sanic/pull/2194) HTTP unit tests with raw client
-- [#2199](https://github.com/sanic-org/sanic/pull/2199) Switch to codeclimate
-- [#2214](https://github.com/sanic-org/sanic/pull/2214) Try Reopening Windows Tests
-- [#2229](https://github.com/sanic-org/sanic/pull/2229) Refactor `HttpProtocol` into a base class
-- [#2230](https://github.com/sanic-org/sanic/pull/2230) Refactor `server.py` into multi-file module
-
-### Miscellaneous
-- [#2173](https://github.com/sanic-org/sanic/pull/2173) Remove Duplicated Dependencies and PEP 517 Support 
-- [#2193](https://github.com/sanic-org/sanic/pull/2193), [#2196](https://github.com/sanic-org/sanic/pull/2196), [#2217](https://github.com/sanic-org/sanic/pull/2217) Type annotation changes
-
-
-

examples/add_task_sanic.py

@@ -4,14 +4,12 @@ import asyncio
 
 from sanic import Sanic
 
-
-app = Sanic("Example")
+app = Sanic()
 
 
 async def notify_server_started_after_five_seconds():
     await asyncio.sleep(5)
-    print("Server successfully started!")
-
+    print('Server successfully started!')
 
 app.add_task(notify_server_started_after_five_seconds())
 

examples/amending_request_object.py

@@ -1,29 +1,30 @@
-from random import randint
-
 from sanic import Sanic
 from sanic.response import text
+from random import randint
+
+app = Sanic()
 
 
-app = Sanic("Example")
-
-
-@app.middleware("request")
+@app.middleware('request')
 def append_request(request):
-    request.ctx.num = randint(0, 100)
+    # Add new key with random value
+    request['num'] = randint(0, 100)
 
 
-@app.get("/pop")
+@app.get('/pop')
 def pop_handler(request):
-    return text(request.ctx.num)
+    # Pop key from request object
+    num = request.pop('num')
+    return text(num)
 
 
-@app.get("/key_exist")
+@app.get('/key_exist')
 def key_exist_handler(request):
     # Check the key is exist or not
-    if hasattr(request.ctx, "num"):
-        return text("num exist in request")
+    if 'num' in request:
+        return text('num exist in request')
 
-    return text("num does not exist in request")
+    return text('num does not exist in reqeust')
 
 
 app.run(host="0.0.0.0", port=8000, debug=True)

examples/authorized_sanic.py

@@ -1,12 +1,10 @@
 # -*- coding: utf-8 -*-
 
-from functools import wraps
-
 from sanic import Sanic
+from functools import wraps
 from sanic.response import json
 
-
-app = Sanic("Example")
+app = Sanic()
 
 
 def check_request_for_authorization_status(request):
@@ -29,16 +27,14 @@ def authorized(f):
             return response
         else:
             # the user is not authorized.
-            return json({"status": "not_authorized"}, 403)
-
+            return json({'status': 'not_authorized'}, 403)
     return decorated_function
 
 
 @app.route("/")
 @authorized
 async def test(request):
-    return json({"status": "authorized"})
-
+    return json({'status': 'authorized'})
 
 if __name__ == "__main__":
     app.run(host="0.0.0.0", port=8000)

examples/blueprint_middlware_execution_order.py

@@ -1,53 +1,43 @@
-from sanic import Blueprint, Sanic
+from sanic import Sanic, Blueprint
 from sanic.response import text
-
-
-"""
-Demonstrates that blueprint request middleware are executed in the order they
+'''
+Demonstrates that blueprint request middleware are executed in the order they 
 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
+@bp.middleware('request')
 def request_middleware_1(request):
-    print("1")
+    print('1')
 
-
-@bp.on_request
+@bp.middleware('request')
 def request_middleware_2(request):
-    print("2")
+    print('2')
 
-
-@bp.on_request
+@bp.middleware('request')
 def request_middleware_3(request):
-    print("3")
+    print('3')
 
-
-@bp.on_response
+@bp.middleware('response')
 def resp_middleware_4(request, response):
-    print("4")
+    print('4')
 
-
-@bp.on_response
+@bp.middleware('response')
 def resp_middleware_5(request, response):
-    print("5")
+    print('5')
 
-
-@bp.on_response
+@bp.middleware('response')
 def resp_middleware_6(request, response):
-    print("6")
+    print('6')
 
-
-@bp.route("/")
+@bp.route('/')
 def pop_handler(request):
-    return text("hello world")
+    return text('hello world')
 
-
-app.blueprint(bp, url_prefix="/bp")
+app.blueprint(bp, url_prefix='/bp')
 
 app.run(host="0.0.0.0", port=8000, debug=True, auto_reload=False)

examples/blueprints.py

@@ -1,11 +1,10 @@
 from sanic import Blueprint, Sanic
 from sanic.response import file, json
 
-
-app = Sanic("Example")
-blueprint = Blueprint("bp_example", url_prefix="/my_blueprint")
-blueprint2 = Blueprint("bp_example2", url_prefix="/my_blueprint2")
-blueprint3 = Blueprint("bp_example3", url_prefix="/my_blueprint3")
+app = Sanic(__name__)
+blueprint = Blueprint("name", url_prefix="/my_blueprint")
+blueprint2 = Blueprint("name2", url_prefix="/my_blueprint2")
+blueprint3 = Blueprint("name3", url_prefix="/my_blueprint3")
 
 
 @blueprint.route("/foo")

examples/delayed_response.py

@@ -2,20 +2,17 @@ from asyncio import sleep
 
 from sanic import Sanic, response
 
-
-app = Sanic("DelayedResponseApp", strict_slashes=True)
-
+app = Sanic(__name__, strict_slashes=True)
 
 @app.get("/")
 async def handler(request):
     return response.redirect("/sleep/3")
 
-
 @app.get("/sleep/<t:number>")
 async def handler2(request, t=0.3):
     await sleep(t)
     return response.text(f"Slept {t:.1f} seconds.\n")
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     app.run(host="0.0.0.0", port=8000)

examples/exception_monitoring.py

@@ -7,10 +7,8 @@ and pass in an instance of it when we create our Sanic instance. Inside this
 class' default handler, we can do anything including sending exceptions to
 an external service.
 """
-from sanic.exceptions import SanicException
 from sanic.handlers import ErrorHandler
-
-
+from sanic.exceptions import SanicException
 """
 Imports and code relevant for our CustomHandler class
 (Ordinarily this would be in a separate file)
@@ -18,6 +16,7 @@ Imports and code relevant for our CustomHandler class
 
 
 class CustomHandler(ErrorHandler):
+
     def default(self, request, exception):
         # Here, we have access to the exception object
         # and can do anything with it (log, send to external service, etc)
@@ -39,17 +38,17 @@ server's error_handler to an instance of our CustomHandler
 
 from sanic import Sanic
 
+app = Sanic(__name__)
 
 handler = CustomHandler()
-app = Sanic("Example", error_handler=handler)
+app.error_handler = handler
 
 
 @app.route("/")
 async def test(request):
     # Here, something occurs which causes an unexpected exception
     # This exception will flow to our custom handler.
-    raise SanicException("You Broke It!")
+    raise SanicException('You Broke It!')
 
-
-if __name__ == "__main__":
+if __name__ == '__main__':
     app.run(host="0.0.0.0", port=8000, debug=True)

examples/http_redirect.py

@@ -1,6 +1,4 @@
 from sanic import Sanic, response, text
-from sanic.handlers import ErrorHandler
-from sanic.server.async_server import AsyncioServer
 
 
 HTTP_PORT = 9999
@@ -34,40 +32,20 @@ def proxy(request, path):
     return response.redirect(url)
 
 
-@https.main_process_start
+@https.listener("main_process_start")
 async def start(app, _):
-    http_server = await http.create_server(
+    global http
+    app.http_server = await http.create_server(
         port=HTTP_PORT, return_asyncio_server=True
     )
-    app.add_task(runner(http, http_server))
-    app.ctx.http_server = http_server
-    app.ctx.http = http
+    app.http_server.after_start()
 
 
-@https.main_process_stop
+@https.listener("main_process_stop")
 async def stop(app, _):
-    await app.ctx.http_server.before_stop()
-    await app.ctx.http_server.close()
-    for connection in app.ctx.http_server.connections:
-        connection.close_if_idle()
-    await app.ctx.http_server.after_stop()
-    app.ctx.http = False
-
-
-async def runner(app: Sanic, app_server: AsyncioServer):
-    app.is_running = True
-    try:
-        app.signalize()
-        app.finalize()
-        ErrorHandler.finalize(app.error_handler)
-        app_server.init = True
-
-        await app_server.before_start()
-        await app_server.after_start()
-        await app_server.serve_forever()
-    finally:
-        app.is_running = False
-        app.is_stopping = True
+    app.http_server.before_stop()
+    await app.http_server.close()
+    app.http_server.after_stop()
 
 
 https.run(port=HTTPS_PORT, debug=True)

examples/limit_concurrency.py

@@ -1,30 +1,26 @@
-import asyncio
-
-import httpx
-
 from sanic import Sanic
 from sanic.response import json
 
+import asyncio
+import aiohttp
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 sem = None
 
 
-@app.before_server_start
-def init(sanic, _):
+@app.listener('before_server_start')
+def init(sanic, loop):
     global sem
     concurrency_per_worker = 4
-    sem = asyncio.Semaphore(concurrency_per_worker)
-
+    sem = asyncio.Semaphore(concurrency_per_worker, loop=loop)
 
 async def bounded_fetch(session, url):
     """
     Use session object to perform 'get' request on url
     """
-    async with sem:
-        response = await session.get(url)
-        return response.json()
+    async with sem, session.get(url) as response:
+        return await response.json()
 
 
 @app.route("/")
@@ -32,9 +28,9 @@ async def test(request):
     """
     Download and serve example JSON
     """
-    url = "https://api.github.com/repos/sanic-org/sanic"
+    url = "https://api.github.com/repos/channelcat/sanic"
 
-    async with httpx.AsyncClient() as session:
+    async with aiohttp.ClientSession() as session:
         response = await bounded_fetch(session, url)
         return json(response)
 

examples/log_request_id.py

@@ -1,6 +1,6 @@
 import logging
 
-from contextvars import ContextVar
+import aiotask_context as context
 
 from sanic import Sanic, response
 
@@ -11,8 +11,8 @@ log = logging.getLogger(__name__)
 class RequestIdFilter(logging.Filter):
     def filter(self, record):
         try:
-            record.request_id = app.ctx.request_id.get(None) or "n/a"
-        except AttributeError:
+            record.request_id = context.get("X-Request-ID")
+        except ValueError:
             record.request_id = "n/a"
         return True
 
@@ -44,12 +44,13 @@ LOG_SETTINGS = {
 }
 
 
-app = Sanic("Example", log_config=LOG_SETTINGS)
+app = Sanic(__name__, log_config=LOG_SETTINGS)
 
 
 @app.on_request
 async def set_request_id(request):
-    request.app.ctx.request_id.set(request.id)
+    request_id = request.id
+    context.set("X-Request-ID", request_id)
     log.info(f"Setting {request.id=}")
 
 
@@ -60,14 +61,14 @@ async def set_request_header(request, response):
 
 @app.route("/")
 async def test(request):
-    log.debug("X-Request-ID: %s", request.id)
+    log.debug("X-Request-ID: %s", context.get("X-Request-ID"))
     log.info("Hello from test!")
     return response.json({"test": True})
 
 
 @app.before_server_start
 def setup(app, loop):
-    app.ctx.request_id = ContextVar("request_id")
+    loop.set_task_factory(context.task_factory)
 
 
 if __name__ == "__main__":

examples/logdna_example.py

@@ -1,6 +1,5 @@
 import logging
 import socket
-
 from os import getenv
 from platform import node
 from uuid import getnode as get_mac
@@ -8,11 +7,10 @@ from uuid import getnode as get_mac
 from logdna import LogDNAHandler
 
 from sanic import Sanic
-from sanic.request import Request
 from sanic.response import json
+from sanic.request import Request
 
-
-log = logging.getLogger("logdna")
+log = logging.getLogger('logdna')
 log.setLevel(logging.INFO)
 
 
@@ -32,18 +30,16 @@ logdna_options = {
     "index_meta": True,
     "hostname": node(),
     "ip": get_my_ip_address(),
-    "mac": get_mac_address(),
+    "mac": get_mac_address()
 }
 
-logdna_handler = LogDNAHandler(
-    getenv("LOGDNA_API_KEY"), options=logdna_options
-)
+logdna_handler = LogDNAHandler(getenv("LOGDNA_API_KEY"), options=logdna_options)
 
 logdna = logging.getLogger(__name__)
 logdna.setLevel(logging.INFO)
 logdna.addHandler(logdna_handler)
 
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.middleware
@@ -53,8 +49,13 @@ def log_request(request: Request):
 
 @app.route("/")
 def default(request):
-    return json({"response": "I was here"})
+    return json({
+        "response": "I was here"
+    })
 
 
 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/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!"},
-        headers={"X-Served-By": "sanic"},
-        status=200,
+        {'message': 'Hello world!'},
+        headers={'X-Served-By': 'sanic'},
+        status=200
     )
 
 
-@app.route("/unauthorized")
+@app.route('/unauthorized')
 def handle_request(request):
     return response.json(
-        {"message": "You are not authorized"},
-        headers={"X-Served-By": "sanic"},
-        status=404,
+        {'message': 'You are not authorized'},
+        headers={'X-Served-By': 'sanic'},
+        status=404
     )
 
-
-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/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__":
-    app.run(host="0.0.0.0", port=getenv("PORT", 8080))
+if __name__ == '__main__':
+    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__":
-    app.run(host="0.0.0.0", port=8000)
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000)

examples/request_stream/client.py

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

examples/request_stream/server.py

@@ -1,63 +1,65 @@
 from sanic import Sanic
-from sanic.blueprints import Blueprint
-from sanic.response import stream, text
+from sanic.views import CompositionView
 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("bp_example")
-app = Sanic("Example")
+bp = Blueprint('blueprint_request_stream')
+app = Sanic('request_stream')
 
 
 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__":
-    app.run(host="0.0.0.0", port=8000)
+if __name__ == '__main__':
+    app.run(host='0.0.0.0', port=8000)

examples/request_timeout.py

@@ -1,23 +1,21 @@
 import asyncio
-
-from sanic import Sanic, response
+from sanic import Sanic
+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)
+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")
@@ -59,31 +59,31 @@ async def handler_stream(request):
     return response.stream(body)
 
 
-@app.before_server_start
+@app.listener("before_server_start")
 async def listener_before_server_start(*args, **kwargs):
     print("before_server_start")
 
 
-@app.after_server_start
+@app.listener("after_server_start")
 async def listener_after_server_start(*args, **kwargs):
     print("after_server_start")
 
 
-@app.before_server_stop
+@app.listener("before_server_stop")
 async def listener_before_server_stop(*args, **kwargs):
     print("before_server_stop")
 
 
-@app.after_server_stop
+@app.listener("after_server_stop")
 async def listener_after_server_stop(*args, **kwargs):
     print("after_server_stop")
 
 
-@app.on_request
+@app.middleware("request")
 async def print_on_request(request):
     print("print_on_request")
 
 
-@app.on_response
+@app.middleware("response")
 async def print_on_response(request, response):
     print("print_on_response")

examples/run_async.py

@@ -1,30 +1,22 @@
+from sanic import Sanic
+from sanic import response
+from signal import signal, SIGINT
 import asyncio
-
 import uvloop
 
-from sanic import Sanic, response
-
-
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.route("/")
 async def test(request):
     return response.json({"answer": "42"})
 
-
-async def main():
-    server = await app.create_server(
-        port=8000, host="0.0.0.0", return_asyncio_server=True
-    )
-
-    if server is None:
-        return
-
-    await server.startup()
-    await server.serve_forever()
-
-
-if __name__ == "__main__":
-    asyncio.set_event_loop(uvloop.new_event_loop())
-    asyncio.run(main())
+asyncio.set_event_loop(uvloop.new_event_loop())
+server = app.create_server(host="0.0.0.0", port=8000, return_asyncio_server=True)
+loop = asyncio.get_event_loop()
+task = asyncio.ensure_future(server)
+signal(SIGINT, lambda s, f: loop.stop())
+try:
+    loop.run_forever()
+except:
+    loop.stop()

examples/run_async_advanced.py

@@ -1,62 +1,32 @@
+from sanic import Sanic
+from sanic import response
+from signal import signal, SIGINT
 import asyncio
-
-from signal import SIGINT, signal
-
 import uvloop
 
-from sanic import Sanic, response
-from sanic.server import AsyncioServer
-
-
-app = Sanic("Example")
-
-
-@app.before_server_start
-async def before_server_start(app, loop):
-    print("Async Server starting")
-
-
-@app.after_server_start
-async def after_server_start(app, loop):
-    print("Async Server started")
-
-
-@app.before_server_stop
-async def before_server_stop(app, loop):
-    print("Async Server stopping")
-
-
-@app.after_server_stop
-async def after_server_stop(app, loop):
-    print("Async Server stopped")
+app = Sanic(__name__)
 
+@app.listener('after_server_start')
+async def after_start_test(app, loop):
+    print("Async Server Started!")
 
 @app.route("/")
 async def test(request):
     return response.json({"answer": "42"})
 
-
 asyncio.set_event_loop(uvloop.new_event_loop())
-serv_coro = app.create_server(
-    host="0.0.0.0", port=8000, return_asyncio_server=True
-)
+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.
-# But, in this example, we are using the convenience method, even if it is
-# out of order.
-loop.run_until_complete(server.before_start())
-loop.run_until_complete(server.after_start())
+server = loop.run_until_complete(serv_task)
+server.after_start()
 try:
     loop.run_forever()
-except KeyboardInterrupt:
+except KeyboardInterrupt as e:
     loop.stop()
 finally:
-    loop.run_until_complete(server.before_stop())
+    server.before_stop()
 
     # Wait for server to close
     close_task = server.close()
@@ -65,4 +35,4 @@ finally:
     # Complete all tasks on the loop
     for connection in server.connections:
         connection.close_if_idle()
-    loop.run_until_complete(server.after_stop())
+    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__":
-    app.run(host="0.0.0.0", port=getenv("PORT", 8080))
+if __name__ == '__main__':
+    app.run(
+        host="0.0.0.0",
+        port=getenv("PORT", 8080)
+    )

examples/simple_async_view.py

@@ -1,41 +1,42 @@
 from sanic import Sanic
-from sanic.response import text
 from sanic.views import HTTPMethodView
+from sanic.response import text
 
-
-app = Sanic("some_name")
+app = Sanic('some_name')
 
 
 class SimpleView(HTTPMethodView):
+
     def get(self, request):
-        return text("I am get method")
+        return text('I am get method')
 
     def post(self, request):
-        return text("I am post method")
+        return text('I am post method')
 
     def put(self, request):
-        return text("I am put method")
+        return text('I am put method')
 
     def patch(self, request):
-        return text("I am patch method")
+        return text('I am patch method')
 
     def delete(self, request):
-        return text("I am delete method")
+        return text('I am delete method')
 
 
 class SimpleAsyncView(HTTPMethodView):
+
     async def get(self, request):
-        return text("I am async get method")
+        return text('I am async get method')
 
     async def post(self, request):
-        return text("I am async post method")
+        return text('I am async post method')
 
     async def put(self, request):
-        return text("I am async put method")
+        return text('I am async put method')
 
 
-app.add_route(SimpleView.as_view(), "/")
-app.add_route(SimpleAsyncView.as_view(), "/async")
+app.add_route(SimpleView.as_view(), '/')
+app.add_route(SimpleAsyncView.as_view(), '/async')
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     app.run(host="0.0.0.0", port=8000, debug=True)

examples/simple_server.py

@@ -1,7 +1,7 @@
-from sanic import Sanic, response
+from sanic import Sanic
+from sanic import response
 
-
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @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/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("Example")
+app = Sanic(__name__)
 
 
 @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

@@ -1,11 +1,11 @@
 import os
 
-from sanic import Sanic, response
-from sanic.exceptions import ServerError
+from sanic import Sanic
 from sanic.log import logger as log
+from sanic import response
+from sanic.exceptions import ServerError
 
-
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.route("/")
@@ -13,7 +13,7 @@ async def test_async(request):
     return response.json({"test": True})
 
 
-@app.route("/sync", methods=["GET", "POST"])
+@app.route("/sync", methods=['GET', 'POST'])
 def test_sync(request):
     return response.json({"test": True})
 
@@ -31,7 +31,6 @@ def exception(request):
 @app.route("/await")
 async def test_await(request):
     import asyncio
-
     await asyncio.sleep(5)
     return response.text("I'm feeling sleepy")
 
@@ -43,10 +42,8 @@ async def test_file(request):
 
 @app.route("/file_stream")
 async def test_file_stream(request):
-    return await response.file_stream(
-        os.path.abspath("setup.py"), chunk_size=1024
-    )
-
+    return await response.file_stream(os.path.abspath("setup.py"),
+                                      chunk_size=1024)
 
 # ----------------------------------------------- #
 # Exceptions
@@ -55,17 +52,14 @@ async def test_file_stream(request):
 
 @app.exception(ServerError)
 async def test(request, exception):
-    return response.json(
-        {"exception": str(exception), "status": exception.status_code},
-        status=exception.status_code,
-    )
+    return response.json({"exception": "{}".format(exception), "status": exception.status_code},
+                         status=exception.status_code)
 
 
 # ----------------------------------------------- #
 # Read from request
 # ----------------------------------------------- #
 
-
 @app.route("/json")
 def post_json(request):
     return response.json({"received": True, "message": request.json})
@@ -73,51 +67,38 @@ def post_json(request):
 
 @app.route("/form")
 def post_form_json(request):
-    return response.json(
-        {
-            "received": True,
-            "form_data": request.form,
-            "test": request.form.get("test"),
-        }
-    )
+    return response.json({"received": True, "form_data": request.form, "test": request.form.get('test')})
 
 
 @app.route("/query_string")
 def query_string(request):
-    return response.json(
-        {
-            "parsed": True,
-            "args": request.args,
-            "url": request.url,
-            "query_string": request.query_string,
-        }
-    )
+    return response.json({"parsed": True, "args": request.args, "url": request.url,
+                          "query_string": request.query_string})
 
 
 # ----------------------------------------------- #
 # Run Server
 # ----------------------------------------------- #
 
-
-@app.before_server_start
+@app.listener('before_server_start')
 def before_start(app, loop):
     log.info("SERVER STARTING")
 
 
-@app.after_server_start
+@app.listener('after_server_start')
 def after_start(app, loop):
     log.info("OH OH OH OH OHHHHHHHH")
 
 
-@app.before_server_stop
+@app.listener('before_server_stop')
 def before_stop(app, loop):
     log.info("SERVER STOPPING")
 
 
-@app.after_server_stop
+@app.listener('after_server_stop')
 def after_stop(app, loop):
     log.info("TRIED EVERYTHING")
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     app.run(host="0.0.0.0", port=8000, debug=True)

examples/unix_socket.py

@@ -1,25 +1,23 @@
-import os
+from sanic import Sanic
+from sanic import response
 import socket
+import os
 
-from sanic import Sanic, response
-
-
-app = Sanic("Example")
+app = Sanic(__name__)
 
 
 @app.route("/test")
 async def test(request):
     return response.text("OK")
 
-
-if __name__ == "__main__":
-    server_address = "./uds_socket"
+if __name__ == '__main__':
+    server_address = './uds_socket'
     # Make sure the socket does not already exist
     try:
-        os.unlink(server_address)
+            os.unlink(server_address)
     except OSError:
-        if os.path.exists(server_address):
-            raise
+            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,21 +1,20 @@
-from sanic import Sanic, response
+from sanic import Sanic
+from sanic import response
+
+app = Sanic(__name__)
 
 
-app = Sanic("Example")
-
-
-@app.route("/")
+@app.route('/')
 async def index(request):
     # generate a URL for the endpoint `post_handler`
-    url = app.url_for("post_handler", post_id=5)
+    url = app.url_for('post_handler', post_id=5)
     # the URL is `/posts/5`, redirect to it
     return response.redirect(url)
 
 
-@app.route("/posts/<post_id>")
+@app.route('/posts/<post_id>')
 async def post_handler(request, post_id):
-    return response.text("Post - {}".format(post_id))
-
-
-if __name__ == "__main__":
+    return response.text('Post - {}'.format(post_id))
+    
+if __name__ == '__main__':
     app.run(host="0.0.0.0", port=8000, debug=True)

examples/versioned_blueprint_group.py

@@ -8,9 +8,7 @@ app = Sanic(name="blue-print-group-version-example")
 bp1 = Blueprint(name="ultron", url_prefix="/ultron")
 bp2 = Blueprint(name="vision", url_prefix="/vision", strict_slashes=None)
 
-bpg = Blueprint.group(
-    bp1, bp2, url_prefix="/sentient/robot", version=1, strict_slashes=True
-)
+bpg = Blueprint.group([bp1, bp2], url_prefix="/sentient/robot", version=1, strict_slashes=True)
 
 
 @bp1.get("/name")
@@ -33,5 +31,5 @@ async def bp2_revised_name(request):
 
 app.blueprint(bpg)
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     app.run(host="0.0.0.0", port=8000)

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

@@ -1,27 +1,24 @@
 from sanic import Sanic
-from sanic.response import redirect
+from sanic.response import file
+
+app = Sanic(__name__)
 
 
-app = Sanic("Example")
+@app.route('/')
+async def index(request):
+    return await file('websocket.html')
 
 
-app.static("index.html", "websocket.html")
-
-
-@app.route("/")
-def index(request):
-    return redirect("index.html")
-
-
-@app.websocket("/feed")
+@app.websocket('/feed')
 async def feed(request, ws):
     while True:
-        data = "hello!"
-        print("Sending: " + data)
+        data = 'hello!'
+        print('Sending: ' + data)
         await ws.send(data)
         data = await ws.recv()
-        print("Received: " + data)
+        print('Received: ' + data)
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     app.run(host="0.0.0.0", port=8000, debug=True)
+

pyproject.toml

@@ -1,3 +0,0 @@
-[build-system]
-requires = ["setuptools<60.0", "wheel"]
-build-backend = "setuptools.build_meta"

readthedocs.yml

@@ -6,4 +6,4 @@ python:
         path: .
         extra_requirements:
             - docs
-   system_packages: true
+   system_packages: true

sanic/__init__.py

@@ -1,7 +1,6 @@
 from sanic.__version__ import __version__
 from sanic.app import Sanic
 from sanic.blueprints import Blueprint
-from sanic.constants import HTTPMethod
 from sanic.request import Request
 from sanic.response import HTTPResponse, html, json, text
 
@@ -10,7 +9,6 @@ __all__ = (
     "__version__",
     "Sanic",
     "Blueprint",
-    "HTTPMethod",
     "HTTPResponse",
     "Request",
     "html",

sanic/__main__.py

@@ -1,15 +1,131 @@
-from sanic.cli.app import SanicCLI
-from sanic.compat import OS_IS_WINDOWS, enable_windows_color_support
+import os
+import sys
+
+from argparse import ArgumentParser, RawDescriptionHelpFormatter
+from importlib import import_module
+from typing import Any, Dict, Optional
+
+from sanic import __version__
+from sanic.app import Sanic
+from sanic.config import BASE_LOGO
+from sanic.log import logger
 
 
-if OS_IS_WINDOWS:
-    enable_windows_color_support()
+class SanicArgumentParser(ArgumentParser):
+    def add_bool_arguments(self, *args, **kwargs):
+        group = self.add_mutually_exclusive_group()
+        group.add_argument(*args, action="store_true", **kwargs)
+        kwargs["help"] = "no " + kwargs["help"]
+        group.add_argument(
+            "--no-" + args[0][2:], *args[1:], action="store_false", **kwargs
+        )
 
 
 def main():
-    cli = SanicCLI()
-    cli.attach()
-    cli.run()
+    parser = SanicArgumentParser(
+        prog="sanic",
+        description=BASE_LOGO,
+        formatter_class=RawDescriptionHelpFormatter,
+    )
+    parser.add_argument(
+        "-H",
+        "--host",
+        dest="host",
+        type=str,
+        default="127.0.0.1",
+        help="host address [default 127.0.0.1]",
+    )
+    parser.add_argument(
+        "-p",
+        "--port",
+        dest="port",
+        type=int,
+        default=8000,
+        help="port to serve on [default 8000]",
+    )
+    parser.add_argument(
+        "-u",
+        "--unix",
+        dest="unix",
+        type=str,
+        default="",
+        help="location of unix socket",
+    )
+    parser.add_argument(
+        "--cert", dest="cert", type=str, help="location of certificate for SSL"
+    )
+    parser.add_argument(
+        "--key", dest="key", type=str, help="location of keyfile for SSL."
+    )
+    parser.add_argument(
+        "-w",
+        "--workers",
+        dest="workers",
+        type=int,
+        default=1,
+        help="number of worker processes [default 1]",
+    )
+    parser.add_argument("--debug", dest="debug", action="store_true")
+    parser.add_bool_arguments(
+        "--access-logs", dest="access_log", help="display access logs"
+    )
+    parser.add_argument(
+        "-v",
+        "--version",
+        action="version",
+        version=f"Sanic {__version__}",
+    )
+    parser.add_argument(
+        "module", help="path to your Sanic app. Example: path.to.server:app"
+    )
+    args = parser.parse_args()
+
+    try:
+        module_path = os.path.abspath(os.getcwd())
+        if module_path not in sys.path:
+            sys.path.append(module_path)
+
+        if ":" in args.module:
+            module_name, app_name = args.module.rsplit(":", 1)
+        else:
+            module_parts = args.module.split(".")
+            module_name = ".".join(module_parts[:-1])
+            app_name = module_parts[-1]
+
+        module = import_module(module_name)
+        app = getattr(module, app_name, None)
+        app_name = type(app).__name__
+
+        if not isinstance(app, Sanic):
+            raise ValueError(
+                f"Module is not a Sanic app, it is a {app_name}.  "
+                f"Perhaps you meant {args.module}.app?"
+            )
+        if args.cert is not None or args.key is not None:
+            ssl = {
+                "cert": args.cert,
+                "key": args.key,
+            }  # type: Optional[Dict[str, Any]]
+        else:
+            ssl = None
+
+        app.run(
+            host=args.host,
+            port=args.port,
+            unix=args.unix,
+            workers=args.workers,
+            debug=args.debug,
+            access_log=args.access_log,
+            ssl=ssl,
+        )
+    except ImportError as e:
+        logger.error(
+            f"No module named {e.name} found.\n"
+            f"  Example File: project/sanic_server.py -> app\n"
+            f"  Example Module: project.sanic_server.app"
+        )
+    except ValueError:
+        logger.exception("Failed to run app")
 
 
 if __name__ == "__main__":

sanic/__version__.py

@@ -1 +1 @@
-__version__ = "22.3.0.dev1"
+__version__ = "21.3.2"

sanic/application/ext.py

@@ -1,39 +0,0 @@
-from __future__ import annotations
-
-from contextlib import suppress
-from importlib import import_module
-from typing import TYPE_CHECKING
-
-
-if TYPE_CHECKING:  # no cov
-    from sanic import Sanic
-
-    try:
-        from sanic_ext import Extend  # type: ignore
-    except ImportError:
-        ...
-
-
-def setup_ext(app: Sanic, *, fail: bool = False, **kwargs):
-    if not app.config.AUTO_EXTEND:
-        return
-
-    sanic_ext = None
-    with suppress(ModuleNotFoundError):
-        sanic_ext = import_module("sanic_ext")
-
-    if not sanic_ext:
-        if fail:
-            raise RuntimeError(
-                "Sanic Extensions is not installed. You can add it to your "
-                "environment using:\n$ pip install sanic[ext]\nor\n$ pip "
-                "install sanic-ext"
-            )
-
-        return
-
-    if not getattr(app, "_ext", None):
-        Ext: Extend = getattr(sanic_ext, "Extend")
-        app._ext = Ext(app, **kwargs)
-
-        return app.ext

sanic/application/logo.py

@@ -1,57 +0,0 @@
-import re
-import sys
-
-from os import environ
-
-
-BASE_LOGO = """
-
-                 Sanic
-         Build Fast. Run Fast.
-
-"""
-COFFEE_LOGO = """\033[48;2;255;13;104m                     \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m     ▄████████▄      \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m    ██       ██▀▀▄   \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m    ███████████  █   \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m    ███████████▄▄▀   \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m     ▀███████▀       \033[0m
-\033[48;2;255;13;104m                     \033[0m
-Dark roast. No sugar."""
-
-COLOR_LOGO = """\033[48;2;255;13;104m                     \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m    ▄███ █████ ██    \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m   ██                \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m    ▀███████ ███▄    \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m                ██   \033[0m
-\033[38;2;255;255;255;48;2;255;13;104m   ████ ████████▀    \033[0m
-\033[48;2;255;13;104m                     \033[0m
-Build Fast. Run Fast."""
-
-FULL_COLOR_LOGO = """
-
-\033[38;2;255;13;104m  ▄███ █████ ██ \033[0m     ▄█▄      ██       █   █   ▄██████████
-\033[38;2;255;13;104m ██             \033[0m    █   █     █ ██     █   █  ██
-\033[38;2;255;13;104m  ▀███████ ███▄ \033[0m   ▀     █    █   ██   ▄   █  ██
-\033[38;2;255;13;104m              ██\033[0m  █████████   █     ██ █   █  ▄▄
-\033[38;2;255;13;104m ████ ████████▀ \033[0m █         █  █       ██   █   ▀██ ███████
-
-"""  # noqa
-
-ansi_pattern = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
-
-
-def get_logo(full=False, coffee=False):
-    logo = (
-        (FULL_COLOR_LOGO if full else (COFFEE_LOGO if coffee else COLOR_LOGO))
-        if sys.stdout.isatty()
-        else BASE_LOGO
-    )
-
-    if (
-        sys.platform == "darwin"
-        and environ.get("TERM_PROGRAM") == "Apple_Terminal"
-    ):
-        logo = ansi_pattern.sub("", logo)
-
-    return logo

sanic/application/motd.py

@@ -1,143 +0,0 @@
-import sys
-
-from abc import ABC, abstractmethod
-from shutil import get_terminal_size
-from textwrap import indent, wrap
-from typing import Dict, Optional
-
-from sanic import __version__
-from sanic.log import logger
-
-
-class MOTD(ABC):
-    def __init__(
-        self,
-        logo: Optional[str],
-        serve_location: str,
-        data: Dict[str, str],
-        extra: Dict[str, str],
-    ) -> None:
-        self.logo = logo
-        self.serve_location = serve_location
-        self.data = data
-        self.extra = extra
-        self.key_width = 0
-        self.value_width = 0
-
-    @abstractmethod
-    def display(self):
-        ...  # noqa
-
-    @classmethod
-    def output(
-        cls,
-        logo: Optional[str],
-        serve_location: str,
-        data: Dict[str, str],
-        extra: Dict[str, str],
-    ) -> None:
-        motd_class = MOTDTTY if sys.stdout.isatty() else MOTDBasic
-        motd_class(logo, serve_location, data, extra).display()
-
-
-class MOTDBasic(MOTD):
-    def display(self):
-        if self.logo:
-            logger.debug(self.logo)
-        lines = [f"Sanic v{__version__}"]
-        if self.serve_location:
-            lines.append(f"Goin' Fast @ {self.serve_location}")
-        lines += [
-            *(f"{key}: {value}" for key, value in self.data.items()),
-            *(f"{key}: {value}" for key, value in self.extra.items()),
-        ]
-        for line in lines:
-            logger.info(line)
-
-
-class MOTDTTY(MOTD):
-    def __init__(self, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
-        self.set_variables()
-
-    def set_variables(self):  # no  cov
-        fallback = (108, 24)
-        terminal_width = max(
-            get_terminal_size(fallback=fallback).columns, fallback[0]
-        )
-        self.max_value_width = terminal_width - fallback[0] + 36
-
-        self.key_width = 4
-        self.value_width = self.max_value_width
-        if self.data:
-            self.key_width = max(map(len, self.data.keys()))
-            self.value_width = min(
-                max(map(len, self.data.values())), self.max_value_width
-            )
-        self.logo_lines = self.logo.split("\n") if self.logo else []
-        self.logo_line_length = 24
-        self.centering_length = (
-            self.key_width + self.value_width + 2 + self.logo_line_length
-        )
-        self.display_length = self.key_width + self.value_width + 2
-
-    def display(self):
-        version = f"Sanic v{__version__}".center(self.centering_length)
-        running = (
-            f"Goin' Fast @ {self.serve_location}"
-            if self.serve_location
-            else ""
-        ).center(self.centering_length)
-        length = len(version) + 2 - self.logo_line_length
-        first_filler = "─" * (self.logo_line_length - 1)
-        second_filler = "─" * length
-        display_filler = "─" * (self.display_length + 2)
-        lines = [
-            f"\n┌{first_filler}─{second_filler}┐",
-            f"│ {version} │",
-            f"│ {running} │",
-            f"├{first_filler}┬{second_filler}┤",
-        ]
-
-        self._render_data(lines, self.data, 0)
-        if self.extra:
-            logo_part = self._get_logo_part(len(lines) - 4)
-            lines.append(f"| {logo_part} ├{display_filler}┤")
-            self._render_data(lines, self.extra, len(lines) - 4)
-
-        self._render_fill(lines)
-
-        lines.append(f"└{first_filler}┴{second_filler}┘\n")
-        logger.info(indent("\n".join(lines), "  "))
-
-    def _render_data(self, lines, data, start):
-        offset = 0
-        for idx, (key, value) in enumerate(data.items(), start=start):
-            key = key.rjust(self.key_width)
-
-            wrapped = wrap(value, self.max_value_width, break_on_hyphens=False)
-            for wrap_index, part in enumerate(wrapped):
-                part = part.ljust(self.value_width)
-                logo_part = self._get_logo_part(idx + offset + wrap_index)
-                display = (
-                    f"{key}: {part}"
-                    if wrap_index == 0
-                    else (" " * len(key) + f"  {part}")
-                )
-                lines.append(f"│ {logo_part} │ {display} │")
-                if wrap_index:
-                    offset += 1
-
-    def _render_fill(self, lines):
-        filler = " " * self.display_length
-        idx = len(lines) - 5
-        for i in range(1, len(self.logo_lines) - idx):
-            logo_part = self.logo_lines[idx + i]
-            lines.append(f"│ {logo_part} │ {filler} │")
-
-    def _get_logo_part(self, idx):
-        try:
-            logo_part = self.logo_lines[idx]
-        except IndexError:
-            logo_part = " " * (self.logo_line_length - 3)
-        return logo_part

sanic/application/state.py

@@ -1,110 +0,0 @@
-from __future__ import annotations
-
-import logging
-
-from dataclasses import dataclass, field
-from enum import Enum, IntEnum, auto
-from pathlib import Path
-from socket import socket
-from ssl import SSLContext
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Union
-
-from sanic.log import logger
-from sanic.server.async_server import AsyncioServer
-
-
-if TYPE_CHECKING:  # no cov
-    from sanic import Sanic
-
-
-class StrEnum(str, Enum):
-    def _generate_next_value_(name: str, *args) -> str:  # type: ignore
-        return name.lower()
-
-
-class Server(StrEnum):
-    SANIC = auto()
-    ASGI = auto()
-    GUNICORN = auto()
-
-
-class Mode(StrEnum):
-    PRODUCTION = auto()
-    DEBUG = auto()
-
-
-class ServerStage(IntEnum):
-    STOPPED = auto()
-    PARTIAL = auto()
-    SERVING = auto()
-
-
-@dataclass
-class ApplicationServerInfo:
-    settings: Dict[str, Any]
-    stage: ServerStage = field(default=ServerStage.STOPPED)
-    server: Optional[AsyncioServer] = field(default=None)
-
-
-@dataclass
-class ApplicationState:
-    app: Sanic
-    asgi: bool = field(default=False)
-    coffee: bool = field(default=False)
-    fast: bool = field(default=False)
-    host: str = field(default="")
-    port: int = field(default=0)
-    ssl: Optional[SSLContext] = field(default=None)
-    sock: Optional[socket] = field(default=None)
-    unix: Optional[str] = field(default=None)
-    mode: Mode = field(default=Mode.PRODUCTION)
-    reload_dirs: Set[Path] = field(default_factory=set)
-    auto_reload: bool = field(default=False)
-    server: Server = field(default=Server.SANIC)
-    is_running: bool = field(default=False)
-    is_started: bool = field(default=False)
-    is_stopping: bool = field(default=False)
-    verbosity: int = field(default=0)
-    workers: int = field(default=0)
-    primary: bool = field(default=True)
-    server_info: List[ApplicationServerInfo] = field(default_factory=list)
-
-    # This property relates to the ApplicationState instance and should
-    # not be changed except in the __post_init__ method
-    _init: bool = field(default=False)
-
-    def __post_init__(self) -> None:
-        self._init = True
-
-    def __setattr__(self, name: str, value: Any) -> None:
-        if self._init and name == "_init":
-            raise RuntimeError(
-                "Cannot change the value of _init after instantiation"
-            )
-        super().__setattr__(name, value)
-        if self._init and hasattr(self, f"set_{name}"):
-            getattr(self, f"set_{name}")(value)
-
-    def set_mode(self, value: Union[str, Mode]):
-        if hasattr(self.app, "error_handler"):
-            self.app.error_handler.debug = self.app.debug
-        if getattr(self.app, "configure_logging", False) and self.app.debug:
-            logger.setLevel(logging.DEBUG)
-
-    @property
-    def is_debug(self):
-        return self.mode is Mode.DEBUG
-
-    @property
-    def stage(self) -> ServerStage:
-        if not self.server_info:
-            return ServerStage.STOPPED
-
-        if all(info.stage is ServerStage.SERVING for info in self.server_info):
-            return ServerStage.SERVING
-        elif any(
-            info.stage is ServerStage.SERVING for info in self.server_info
-        ):
-            return ServerStage.PARTIAL
-
-        return ServerStage.STOPPED

sanic/asgi.py

@@ -1,51 +1,37 @@
-from __future__ import annotations
-
 import warnings
 
-from typing import TYPE_CHECKING, Optional
+from inspect import isawaitable
+from typing import Optional
 from urllib.parse import quote
 
+import sanic.app  # noqa
+
 from sanic.compat import Header
 from sanic.exceptions import ServerError
-from sanic.helpers import _default
-from sanic.http import Stage
-from sanic.log import logger
 from sanic.models.asgi import ASGIReceive, ASGIScope, ASGISend, MockTransport
 from sanic.request import Request
-from sanic.response import BaseHTTPResponse
 from sanic.server import ConnInfo
-from sanic.server.websockets.connection import WebSocketConnection
-
-
-if TYPE_CHECKING:  # no cov
-    from sanic import Sanic
+from sanic.websocket import WebSocketConnection
 
 
 class Lifespan:
-    def __init__(self, asgi_app: ASGIApp) -> None:
+    def __init__(self, asgi_app: "ASGIApp") -> None:
         self.asgi_app = asgi_app
 
-        if self.asgi_app.sanic_app.state.verbosity > 0:
-            if (
-                "server.init.before"
-                in self.asgi_app.sanic_app.signal_router.name_index
-            ):
-                logger.debug(
-                    'You have set a listener for "before_server_start" '
-                    "in ASGI mode. "
-                    "It will be executed as early as possible, but not before "
-                    "the ASGI server is started."
-                )
-            if (
-                "server.shutdown.after"
-                in self.asgi_app.sanic_app.signal_router.name_index
-            ):
-                logger.debug(
-                    'You have set a listener for "after_server_stop" '
-                    "in ASGI mode. "
-                    "It will be executed as late as possible, but not after "
-                    "the ASGI server is stopped."
-                )
+        if "before_server_start" in self.asgi_app.sanic_app.listeners:
+            warnings.warn(
+                'You have set a listener for "before_server_start" '
+                "in ASGI mode. "
+                "It will be executed as early as possible, but not before "
+                "the ASGI server is started."
+            )
+        if "after_server_stop" in self.asgi_app.sanic_app.listeners:
+            warnings.warn(
+                'You have set a listener for "after_server_stop" '
+                "in ASGI mode. "
+                "It will be executed as late as possible, but not after "
+                "the ASGI server is stopped."
+            )
 
     async def startup(self) -> None:
         """
@@ -56,16 +42,19 @@ class Lifespan:
         in sequence since the ASGI lifespan protocol only supports a single
         startup event.
         """
-        await self.asgi_app.sanic_app._startup()
-        await self.asgi_app.sanic_app._server_event("init", "before")
-        await self.asgi_app.sanic_app._server_event("init", "after")
+        self.asgi_app.sanic_app.router.finalize()
+        if self.asgi_app.sanic_app.signal_router.routes:
+            self.asgi_app.sanic_app.signal_router.finalize()
+        listeners = self.asgi_app.sanic_app.listeners.get(
+            "before_server_start", []
+        ) + self.asgi_app.sanic_app.listeners.get("after_server_start", [])
 
-        if self.asgi_app.sanic_app.config.USE_UVLOOP is not _default:
-            warnings.warn(
-                "You have set the USE_UVLOOP configuration option, but Sanic "
-                "cannot control the event loop when running in ASGI mode."
-                "This option will be ignored."
+        for handler in listeners:
+            response = handler(
+                self.asgi_app.sanic_app, self.asgi_app.sanic_app.loop
             )
+            if response and isawaitable(response):
+                await response
 
     async def shutdown(self) -> None:
         """
@@ -76,8 +65,16 @@ class Lifespan:
         in sequence since the ASGI lifespan protocol only supports a single
         shutdown event.
         """
-        await self.asgi_app.sanic_app._server_event("shutdown", "before")
-        await self.asgi_app.sanic_app._server_event("shutdown", "after")
+        listeners = self.asgi_app.sanic_app.listeners.get(
+            "before_server_stop", []
+        ) + self.asgi_app.sanic_app.listeners.get("after_server_stop", [])
+
+        for handler in listeners:
+            response = handler(
+                self.asgi_app.sanic_app, self.asgi_app.sanic_app.loop
+            )
+            if response and isawaitable(response):
+                await response
 
     async def __call__(
         self, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
@@ -94,13 +91,11 @@ class Lifespan:
 
 
 class ASGIApp:
-    sanic_app: Sanic
+    sanic_app: "sanic.app.Sanic"
     request: Request
     transport: MockTransport
     lifespan: Lifespan
     ws: Optional[WebSocketConnection]
-    stage: Stage
-    response: Optional[BaseHTTPResponse]
 
     def __init__(self) -> None:
         self.ws = None
@@ -113,8 +108,6 @@ class ASGIApp:
         instance.sanic_app = sanic_app
         instance.transport = MockTransport(scope, receive, send)
         instance.transport.loop = sanic_app.loop
-        instance.stage = Stage.IDLE
-        instance.response = None
         setattr(instance.transport, "add_task", sanic_app.loop.create_task)
 
         headers = Header(
@@ -147,6 +140,7 @@ class ASGIApp:
                 instance.ws = instance.transport.create_websocket_connection(
                     send, receive
                 )
+                await instance.ws.accept()
             else:
                 raise ServerError("Received unknown ASGI scope")
 
@@ -169,8 +163,6 @@ class ASGIApp:
         """
         Read and stream the body in chunks from an incoming ASGI message.
         """
-        if self.stage is Stage.IDLE:
-            self.stage = Stage.REQUEST
         message = await self.transport.receive()
         body = message.get("body", b"")
         if not message.get("more_body", False):
@@ -185,17 +177,11 @@ class ASGIApp:
             if data:
                 yield data
 
-    def respond(self, response: BaseHTTPResponse):
-        if self.stage is not Stage.HANDLER:
-            self.stage = Stage.FAILED
-            raise RuntimeError("Response already started")
-        if self.response is not None:
-            self.response.stream = None
+    def respond(self, response):
         response.stream, self.response = self, response
         return response
 
     async def send(self, data, end_stream):
-        self.stage = Stage.IDLE if end_stream else Stage.RESPONSE
         if self.response:
             response, self.response = self.response, None
             await self.transport.send(
@@ -222,8 +208,4 @@ class ASGIApp:
         """
         Handle the incoming request.
         """
-        try:
-            self.stage = Stage.HANDLER
-            await self.sanic_app.handle_request(self.request)
-        except Exception as e:
-            await self.sanic_app.handle_exception(self.request, e)
+        await self.sanic_app.handle_request(self.request)

sanic/base.py

@@ -0,0 +1,41 @@
+from typing import Any, Tuple
+from warnings import warn
+
+from sanic.mixins.exceptions import ExceptionMixin
+from sanic.mixins.listeners import ListenerMixin
+from sanic.mixins.middleware import MiddlewareMixin
+from sanic.mixins.routes import RouteMixin
+from sanic.mixins.signals import SignalMixin
+
+
+class BaseSanic(
+    RouteMixin,
+    MiddlewareMixin,
+    ListenerMixin,
+    ExceptionMixin,
+    SignalMixin,
+):
+    __fake_slots__: Tuple[str, ...]
+
+    def __init__(self, *args, **kwargs) -> None:
+        for base in BaseSanic.__bases__:
+            base.__init__(self, *args, **kwargs)  # type: ignore
+
+    def __str__(self) -> str:
+        return f"<{self.__class__.__name__} {self.name}>"
+
+    def __repr__(self) -> str:
+        return f'{self.__class__.__name__}(name="{self.name}")'
+
+    def __setattr__(self, name: str, value: Any) -> None:
+        # This is a temporary compat layer so we can raise a warning until
+        # setting attributes on the app instance can be removed and deprecated
+        # with a proper implementation of __slots__
+        if name not in self.__fake_slots__:
+            warn(
+                f"Setting variables on {self.__class__.__name__} instances is "
+                "deprecated and will be removed in version 21.9. You should "
+                f"change your {self.__class__.__name__} instance to use "
+                f"instance.ctx.{name} instead."
+            )
+        super().__setattr__(name, value)

sanic/base/meta.py

@@ -1,6 +0,0 @@
-class SanicMeta(type):
-    @classmethod
-    def __prepare__(metaclass, name, bases, **kwds):
-        cls = super().__prepare__(metaclass, name, bases, **kwds)
-        cls["__slots__"] = ()
-        return cls

sanic/base/root.py

@@ -1,63 +0,0 @@
-import re
-
-from typing import Any
-
-from sanic.base.meta import SanicMeta
-from sanic.exceptions import SanicException
-from sanic.mixins.exceptions import ExceptionMixin
-from sanic.mixins.listeners import ListenerMixin
-from sanic.mixins.middleware import MiddlewareMixin
-from sanic.mixins.routes import RouteMixin
-from sanic.mixins.signals import SignalMixin
-
-
-VALID_NAME = re.compile(r"^[a-zA-Z_][a-zA-Z0-9_\-]*$")
-
-
-class BaseSanic(
-    RouteMixin,
-    MiddlewareMixin,
-    ListenerMixin,
-    ExceptionMixin,
-    SignalMixin,
-    metaclass=SanicMeta,
-):
-    __slots__ = ("name",)
-
-    def __init__(self, name: str = None, *args: Any, **kwargs: Any) -> None:
-        class_name = self.__class__.__name__
-
-        if name is None:
-            raise SanicException(
-                f"{class_name} instance cannot be unnamed. "
-                "Please use Sanic(name='your_application_name') instead.",
-            )
-
-        if not VALID_NAME.match(name):
-            raise SanicException(
-                f"{class_name} instance named '{name}' uses an invalid "
-                "format. Names must begin with a character and may only "
-                "contain alphanumeric characters, _, or -."
-            )
-
-        self.name = name
-
-        for base in BaseSanic.__bases__:
-            base.__init__(self, *args, **kwargs)  # type: ignore
-
-    def __str__(self) -> str:
-        return f"<{self.__class__.__name__} {self.name}>"
-
-    def __repr__(self) -> str:
-        return f'{self.__class__.__name__}(name="{self.name}")'
-
-    def __setattr__(self, name: str, value: Any) -> None:
-        try:
-            super().__setattr__(name, value)
-        except AttributeError as e:
-            raise AttributeError(
-                f"Setting variables on {self.__class__.__name__} instances is "
-                "not allowed. You should change your "
-                f"{self.__class__.__name__} instance to use "
-                f"instance.ctx.{name} instead.",
-            ) from e

sanic/blueprint_group.py

@@ -1,11 +1,10 @@
-from __future__ import annotations
-
 from collections.abc import MutableSequence
-from functools import partial
 from typing import TYPE_CHECKING, List, Optional, Union
 
+import sanic
 
-if TYPE_CHECKING:  # no cov
+
+if TYPE_CHECKING:
     from sanic.blueprints import Blueprint
 
 
@@ -59,20 +58,13 @@ class BlueprintGroup(MutableSequence):
         app.blueprint(bpg)
     """
 
-    __slots__ = (
-        "_blueprints",
-        "_url_prefix",
-        "_version",
-        "_strict_slashes",
-        "_version_prefix",
-    )
+    __slots__ = ("_blueprints", "_url_prefix", "_version", "_strict_slashes")
 
     def __init__(
         self,
         url_prefix: Optional[str] = None,
         version: Optional[Union[int, str, float]] = None,
         strict_slashes: Optional[bool] = None,
-        version_prefix: str = "/v",
     ):
         """
         Create a new Blueprint Group
@@ -85,7 +77,6 @@ class BlueprintGroup(MutableSequence):
         self._blueprints: List[Blueprint] = []
         self._url_prefix = url_prefix
         self._version = version
-        self._version_prefix = version_prefix
         self._strict_slashes = strict_slashes
 
     @property
@@ -98,7 +89,7 @@ class BlueprintGroup(MutableSequence):
         return self._url_prefix
 
     @property
-    def blueprints(self) -> List[Blueprint]:
+    def blueprints(self) -> List["sanic.Blueprint"]:
         """
         Retrieve a list of all the available blueprints under this group.
 
@@ -125,15 +116,6 @@ class BlueprintGroup(MutableSequence):
         """
         return self._strict_slashes
 
-    @property
-    def version_prefix(self) -> str:
-        """
-        Version prefix; defaults to ``/v``
-
-        :return: str
-        """
-        return self._version_prefix
-
     def __iter__(self):
         """
         Tun the class Blueprint Group into an Iterable item
@@ -188,37 +170,34 @@ class BlueprintGroup(MutableSequence):
         """
         return len(self._blueprints)
 
-    def append(self, value: Blueprint) -> None:
+    def _sanitize_blueprint(self, bp: "sanic.Blueprint") -> "sanic.Blueprint":
+        """
+        Sanitize the Blueprint Entity to override the Version and strict slash
+        behaviors as required.
+
+        :param bp: Sanic Blueprint entity Object
+        :return: Modified Blueprint
+        """
+        if self._url_prefix:
+            merged_prefix = "/".join(
+                u.strip("/") for u in [self._url_prefix, bp.url_prefix or ""]
+            ).rstrip("/")
+            bp.url_prefix = f"/{merged_prefix}"
+        for _attr in ["version", "strict_slashes"]:
+            if getattr(bp, _attr) is None:
+                setattr(bp, _attr, getattr(self, _attr))
+        return bp
+
+    def append(self, value: "sanic.Blueprint") -> None:
         """
         The Abstract class `MutableSequence` leverages this append method to
         perform the `BlueprintGroup.append` operation.
         :param value: New `Blueprint` object.
         :return: None
         """
-        self._blueprints.append(value)
+        self._blueprints.append(self._sanitize_blueprint(bp=value))
 
-    def exception(self, *exceptions, **kwargs):
-        """
-        A decorator that can be used to implement a global exception handler
-        for all the Blueprints that belong to this Blueprint Group.
-
-        In case of nested Blueprint Groups, the same handler is applied
-        across each of the Blueprints recursively.
-
-        :param args: List of Python exceptions to be caught by the handler
-        :param kwargs: Additional optional arguments to be passed to the
-            exception handler
-        :return: a decorated method to handle global exceptions for any
-            blueprint registered under this group.
-        """
-
-        def register_exception_handler_for_blueprints(fn):
-            for blueprint in self.blueprints:
-                blueprint.exception(*exceptions, **kwargs)(fn)
-
-        return register_exception_handler_for_blueprints
-
-    def insert(self, index: int, item: Blueprint) -> None:
+    def insert(self, index: int, item: "sanic.Blueprint") -> None:
         """
         The Abstract class `MutableSequence` leverages this insert method to
         perform the `BlueprintGroup.append` operation.
@@ -227,7 +206,7 @@ class BlueprintGroup(MutableSequence):
         :param item: New `Blueprint` object.
         :return: None
         """
-        self._blueprints.insert(index, item)
+        self._blueprints.insert(index, self._sanitize_blueprint(item))
 
     def middleware(self, *args, **kwargs):
         """
@@ -251,15 +230,3 @@ class BlueprintGroup(MutableSequence):
             args = list(args)[1:]
             return register_middleware_for_blueprints(fn)
         return register_middleware_for_blueprints
-
-    def on_request(self, middleware=None):
-        if callable(middleware):
-            return self.middleware(middleware, "request")
-        else:
-            return partial(self.middleware, attach_to="request")
-
-    def on_response(self, middleware=None):
-        if callable(middleware):
-            return self.middleware(middleware, "response")
-        else:
-            return partial(self.middleware, attach_to="response")

sanic/blueprints.py

@@ -3,31 +3,15 @@ from __future__ import annotations
 import asyncio
 
 from collections import defaultdict
-from copy import deepcopy
-from functools import wraps
-from inspect import isfunction
-from itertools import chain
 from types import SimpleNamespace
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    Dict,
-    Iterable,
-    List,
-    Optional,
-    Sequence,
-    Set,
-    Tuple,
-    Union,
-)
+from typing import TYPE_CHECKING, Dict, Iterable, List, Optional, Set, Union
 
 from sanic_routing.exceptions import NotFound  # type: ignore
 from sanic_routing.route import Route  # type: ignore
 
-from sanic.base.root import BaseSanic
+from sanic.base import BaseSanic
 from sanic.blueprint_group import BlueprintGroup
 from sanic.exceptions import SanicException
-from sanic.helpers import Default, _default
 from sanic.models.futures import FutureRoute, FutureStatic
 from sanic.models.handler_types import (
     ListenerType,
@@ -36,34 +20,8 @@ from sanic.models.handler_types import (
 )
 
 
-if TYPE_CHECKING:  # no cov
-    from sanic import Sanic
-
-
-def lazy(func, as_decorator=True):
-    @wraps(func)
-    def decorator(bp, *args, **kwargs):
-        nonlocal as_decorator
-        kwargs["apply"] = False
-        pass_handler = None
-
-        if args and isfunction(args[0]):
-            as_decorator = False
-
-        def wrapper(handler):
-            future = func(bp, *args, **kwargs)
-            if as_decorator:
-                future = future(handler)
-
-            if bp.registered:
-                for app in bp.apps:
-                    bp.register(app, {})
-
-            return future
-
-        return wrapper if as_decorator else wrapper(pass_handler)
-
-    return decorator
+if TYPE_CHECKING:
+    from sanic import Sanic  # noqa
 
 
 class Blueprint(BaseSanic):
@@ -79,13 +37,13 @@ class Blueprint(BaseSanic):
 
     :param name: unique name of the blueprint
     :param url_prefix: URL to be prefixed before all route URLs
-    :param host: IP Address or FQDN for the sanic server to use.
+    :param host: IP Address of FQDN for the sanic server to use.
     :param version: Blueprint Version
     :param strict_slashes: Enforce the API urls are requested with a
-        trailing */*
+        training */*
     """
 
-    __slots__ = (
+    __fake_slots__ = (
         "_apps",
         "_future_routes",
         "_future_statics",
@@ -98,28 +56,34 @@ class Blueprint(BaseSanic):
         "host",
         "listeners",
         "middlewares",
+        "name",
         "routes",
         "statics",
         "strict_slashes",
         "url_prefix",
         "version",
-        "version_prefix",
         "websocket_routes",
     )
 
     def __init__(
         self,
-        name: str = None,
+        name: str,
         url_prefix: Optional[str] = None,
-        host: Optional[Union[List[str], str]] = None,
+        host: Optional[str] = None,
         version: Optional[Union[int, str, float]] = None,
         strict_slashes: Optional[bool] = None,
-        version_prefix: str = "/v",
     ):
-        super().__init__(name=name)
-        self.reset()
+        super().__init__()
+
+        self._apps: Set[Sanic] = set()
         self.ctx = SimpleNamespace()
+        self.exceptions: List[RouteHandler] = []
         self.host = host
+        self.listeners: Dict[str, List[ListenerType]] = {}
+        self.middlewares: List[MiddlewareType] = []
+        self.name = name
+        self.routes: List[Route] = []
+        self.statics: List[RouteHandler] = []
         self.strict_slashes = strict_slashes
         self.url_prefix = (
             url_prefix[:-1]
@@ -127,7 +91,7 @@ class Blueprint(BaseSanic):
             else url_prefix
         )
         self.version = version
-        self.version_prefix = version_prefix
+        self.websocket_routes: List[Route] = []
 
     def __repr__(self) -> str:
         args = ", ".join(
@@ -154,100 +118,32 @@ class Blueprint(BaseSanic):
             )
         return self._apps
 
-    @property
-    def registered(self) -> bool:
-        return bool(self._apps)
+    def route(self, *args, **kwargs):
+        kwargs["apply"] = False
+        return super().route(*args, **kwargs)
 
-    exception = lazy(BaseSanic.exception)
-    listener = lazy(BaseSanic.listener)
-    middleware = lazy(BaseSanic.middleware)
-    route = lazy(BaseSanic.route)
-    signal = lazy(BaseSanic.signal)
-    static = lazy(BaseSanic.static, as_decorator=False)
+    def static(self, *args, **kwargs):
+        kwargs["apply"] = False
+        return super().static(*args, **kwargs)
 
-    def reset(self):
-        self._apps: Set[Sanic] = set()
-        self.exceptions: List[RouteHandler] = []
-        self.listeners: Dict[str, List[ListenerType[Any]]] = {}
-        self.middlewares: List[MiddlewareType] = []
-        self.routes: List[Route] = []
-        self.statics: List[RouteHandler] = []
-        self.websocket_routes: List[Route] = []
+    def middleware(self, *args, **kwargs):
+        kwargs["apply"] = False
+        return super().middleware(*args, **kwargs)
 
-    def copy(
-        self,
-        name: str,
-        url_prefix: Optional[Union[str, Default]] = _default,
-        version: Optional[Union[int, str, float, Default]] = _default,
-        version_prefix: Union[str, Default] = _default,
-        strict_slashes: Optional[Union[bool, Default]] = _default,
-        with_registration: bool = True,
-        with_ctx: bool = False,
-    ):
-        """
-        Copy a blueprint instance with some optional parameters to
-        override the values of attributes in the old instance.
+    def listener(self, *args, **kwargs):
+        kwargs["apply"] = False
+        return super().listener(*args, **kwargs)
 
-        :param name: unique name of the blueprint
-        :param url_prefix: URL to be prefixed before all route URLs
-        :param version: Blueprint Version
-        :param version_prefix: the prefix of the version number shown in the
-            URL.
-        :param strict_slashes: Enforce the API urls are requested with a
-            trailing */*
-        :param with_registration: whether register new blueprint instance with
-            sanic apps that were registered with the old instance or not.
-        :param with_ctx: whether ``ctx`` will be copied or not.
-        """
+    def exception(self, *args, **kwargs):
+        kwargs["apply"] = False
+        return super().exception(*args, **kwargs)
 
-        attrs_backup = {
-            "_apps": self._apps,
-            "routes": self.routes,
-            "websocket_routes": self.websocket_routes,
-            "middlewares": self.middlewares,
-            "exceptions": self.exceptions,
-            "listeners": self.listeners,
-            "statics": self.statics,
-        }
-
-        self.reset()
-        new_bp = deepcopy(self)
-        new_bp.name = name
-
-        if not isinstance(url_prefix, Default):
-            new_bp.url_prefix = url_prefix
-        if not isinstance(version, Default):
-            new_bp.version = version
-        if not isinstance(strict_slashes, Default):
-            new_bp.strict_slashes = strict_slashes
-        if not isinstance(version_prefix, Default):
-            new_bp.version_prefix = version_prefix
-
-        for key, value in attrs_backup.items():
-            setattr(self, key, value)
-
-        if with_registration and self._apps:
-            if new_bp._future_statics:
-                raise SanicException(
-                    "Static routes registered with the old blueprint instance,"
-                    " cannot be registered again."
-                )
-            for app in self._apps:
-                app.blueprint(new_bp)
-
-        if not with_ctx:
-            new_bp.ctx = SimpleNamespace()
-
-        return new_bp
+    def signal(self, event: str, *args, **kwargs):
+        kwargs["apply"] = False
+        return super().signal(event, *args, **kwargs)
 
     @staticmethod
-    def group(
-        *blueprints: Union[Blueprint, BlueprintGroup],
-        url_prefix: Optional[str] = None,
-        version: Optional[Union[int, str, float]] = None,
-        strict_slashes: Optional[bool] = None,
-        version_prefix: str = "/v",
-    ) -> BlueprintGroup:
+    def group(*blueprints, url_prefix="", version=None, strict_slashes=None):
         """
         Create a list of blueprints, optionally grouping them under a
         general URL prefix.
@@ -264,6 +160,8 @@ class Blueprint(BaseSanic):
             for i in nested:
                 if isinstance(i, (list, tuple)):
                     yield from chain(i)
+                elif isinstance(i, BlueprintGroup):
+                    yield from i.blueprints
                 else:
                     yield i
 
@@ -271,7 +169,6 @@ class Blueprint(BaseSanic):
             url_prefix=url_prefix,
             version=version,
             strict_slashes=strict_slashes,
-            version_prefix=version_prefix,
         )
         for bp in chain(blueprints):
             bps.append(bp)
@@ -289,18 +186,11 @@ class Blueprint(BaseSanic):
 
         self._apps.add(app)
         url_prefix = options.get("url_prefix", self.url_prefix)
-        opt_version = options.get("version", None)
-        opt_strict_slashes = options.get("strict_slashes", None)
-        opt_version_prefix = options.get("version_prefix", self.version_prefix)
-        error_format = options.get(
-            "error_format", app.config.FALLBACK_ERROR_FORMAT
-        )
 
         routes = []
         middleware = []
         exception_handlers = []
         listeners = defaultdict(list)
-        registered = set()
 
         # Routes
         for future in self._future_routes:
@@ -310,50 +200,30 @@ class Blueprint(BaseSanic):
             # Prepend the blueprint URI prefix if available
             uri = url_prefix + future.uri if url_prefix else future.uri
 
-            version_prefix = self.version_prefix
-            for prefix in (
-                future.version_prefix,
-                opt_version_prefix,
-            ):
-                if prefix and prefix != "/v":
-                    version_prefix = prefix
-                    break
-
-            version = self._extract_value(
-                future.version, opt_version, self.version
+            strict_slashes = (
+                self.strict_slashes
+                if future.strict_slashes is None
+                and self.strict_slashes is not None
+                else future.strict_slashes
             )
-            strict_slashes = self._extract_value(
-                future.strict_slashes, opt_strict_slashes, self.strict_slashes
-            )
-
             name = app._generate_name(future.name)
-            host = future.host or self.host
-            if isinstance(host, list):
-                host = tuple(host)
 
             apply_route = FutureRoute(
                 future.handler,
                 uri[1:] if uri.startswith("//") else uri,
                 future.methods,
-                host,
+                future.host or self.host,
                 strict_slashes,
                 future.stream,
-                version,
+                future.version or self.version,
                 name,
                 future.ignore_body,
                 future.websocket,
                 future.subprotocols,
                 future.unquote,
                 future.static,
-                version_prefix,
-                error_format,
-                future.route_context,
             )
 
-            if (self, apply_route) in app._future_registry:
-                continue
-
-            registered.add(apply_route)
             route = app._apply_route(apply_route)
             operation = (
                 routes.extend if isinstance(route, list) else routes.append
@@ -365,69 +235,41 @@ class Blueprint(BaseSanic):
             # Prepend the blueprint URI prefix if available
             uri = url_prefix + future.uri if url_prefix else future.uri
             apply_route = FutureStatic(uri, *future[1:])
-
-            if (self, apply_route) in app._future_registry:
-                continue
-
-            registered.add(apply_route)
             route = app._apply_static(apply_route)
             routes.append(route)
 
         route_names = [route.name for route in routes if route]
 
+        # Middleware
         if route_names:
-            # Middleware
             for future in self._future_middleware:
-                if (self, future) in app._future_registry:
-                    continue
                 middleware.append(app._apply_middleware(future, route_names))
 
-            # Exceptions
-            for future in self._future_exceptions:
-                if (self, future) in app._future_registry:
-                    continue
-                exception_handlers.append(
-                    app._apply_exception_handler(future, route_names)
-                )
+        # Exceptions
+        for future in self._future_exceptions:
+            exception_handlers.append(app._apply_exception_handler(future))
 
         # Event listeners
-        for future in self._future_listeners:
-            if (self, future) in app._future_registry:
-                continue
-            listeners[future.event].append(app._apply_listener(future))
+        for listener in self._future_listeners:
+            listeners[listener.event].append(app._apply_listener(listener))
 
-        # Signals
-        for future in self._future_signals:
-            if (self, future) in app._future_registry:
-                continue
-            future.condition.update({"__blueprint__": self.name})
-            # Force exclusive to be False
-            app._apply_signal(tuple((*future[:-1], False)))
+        for signal in self._future_signals:
+            signal.condition.update({"blueprint": self.name})
+            app._apply_signal(signal)
 
-        self.routes += [route for route in routes if isinstance(route, Route)]
-        self.websocket_routes += [
+        self.routes = [route for route in routes if isinstance(route, Route)]
+
+        # Deprecate these in 21.6
+        self.websocket_routes = [
             route for route in self.routes if route.ctx.websocket
         ]
-        self.middlewares += middleware
-        self.exceptions += exception_handlers
-        self.listeners.update(dict(listeners))
-
-        if self.registered:
-            self.register_futures(
-                self.apps,
-                self,
-                chain(
-                    registered,
-                    self._future_middleware,
-                    self._future_exceptions,
-                    self._future_listeners,
-                    self._future_signals,
-                ),
-            )
+        self.middlewares = middleware
+        self.exceptions = exception_handlers
+        self.listeners = dict(listeners)
 
     async def dispatch(self, *args, **kwargs):
         condition = kwargs.pop("condition", {})
-        condition.update({"__blueprint__": self.name})
+        condition.update({"blueprint": self.name})
         kwargs["condition"] = condition
         await asyncio.gather(
             *[app.dispatch(*args, **kwargs) for app in self.apps]
@@ -446,19 +288,3 @@ class Blueprint(BaseSanic):
             return_when=asyncio.FIRST_COMPLETED,
             timeout=timeout,
         )
-
-    @staticmethod
-    def _extract_value(*values):
-        value = values[-1]
-        for v in values:
-            if v is not None:
-                value = v
-                break
-        return value
-
-    @staticmethod
-    def register_futures(
-        apps: Set[Sanic], bp: Blueprint, futures: Sequence[Tuple[Any, ...]]
-    ):
-        for app in apps:
-            app._future_registry.update(set((bp, item) for item in futures))

sanic/cli/app.py

@@ -1,177 +0,0 @@
-import os
-import shutil
-import sys
-
-from argparse import ArgumentParser, RawTextHelpFormatter
-from importlib import import_module
-from pathlib import Path
-from textwrap import indent
-from typing import Any, List, Union
-
-from sanic.app import Sanic
-from sanic.application.logo import get_logo
-from sanic.cli.arguments import Group
-from sanic.log import error_logger
-from sanic.simple import create_simple_server
-
-
-class SanicArgumentParser(ArgumentParser):
-    ...
-
-
-class SanicCLI:
-    DESCRIPTION = indent(
-        f"""
-{get_logo(True)}
-
-To start running a Sanic application, provide a path to the module, where
-app is a Sanic() instance:
-
-    $ sanic path.to.server:app
-
-Or, a path to a callable that returns a Sanic() instance:
-
-    $ sanic path.to.factory:create_app --factory
-
-Or, a path to a directory to run as a simple HTTP server:
-
-    $ sanic ./path/to/static --simple
-""",
-        prefix=" ",
-    )
-
-    def __init__(self) -> None:
-        width = shutil.get_terminal_size().columns
-        self.parser = SanicArgumentParser(
-            prog="sanic",
-            description=self.DESCRIPTION,
-            formatter_class=lambda prog: RawTextHelpFormatter(
-                prog,
-                max_help_position=36 if width > 96 else 24,
-                indent_increment=4,
-                width=None,
-            ),
-        )
-        self.parser._positionals.title = "Required\n========\n  Positional"
-        self.parser._optionals.title = "Optional\n========\n  General"
-        self.main_process = (
-            os.environ.get("SANIC_RELOADER_PROCESS", "") != "true"
-        )
-        self.args: List[Any] = []
-
-    def attach(self):
-        for group in Group._registry:
-            group.create(self.parser).attach()
-
-    def run(self):
-        # This is to provide backwards compat -v to display version
-        legacy_version = len(sys.argv) == 2 and sys.argv[-1] == "-v"
-        parse_args = ["--version"] if legacy_version else None
-
-        self.args = self.parser.parse_args(args=parse_args)
-        self._precheck()
-
-        try:
-            app = self._get_app()
-            kwargs = self._build_run_kwargs()
-            app.run(**kwargs)
-        except ValueError:
-            error_logger.exception("Failed to run app")
-
-    def _precheck(self):
-        # # Custom TLS mismatch handling for better diagnostics
-        if self.main_process and (
-            # one of cert/key missing
-            bool(self.args.cert) != bool(self.args.key)
-            # new and old style self.args used together
-            or self.args.tls
-            and self.args.cert
-            # strict host checking without certs would always fail
-            or self.args.tlshost
-            and not self.args.tls
-            and not self.args.cert
-        ):
-            self.parser.print_usage(sys.stderr)
-            message = (
-                "TLS certificates must be specified by either of:\n"
-                "  --cert certdir/fullchain.pem --key certdir/privkey.pem\n"
-                "  --tls certdir  (equivalent to the above)"
-            )
-            error_logger.error(message)
-            sys.exit(1)
-
-    def _get_app(self):
-        try:
-            module_path = os.path.abspath(os.getcwd())
-            if module_path not in sys.path:
-                sys.path.append(module_path)
-
-            if self.args.simple:
-                path = Path(self.args.module)
-                app = create_simple_server(path)
-            else:
-                delimiter = ":" if ":" in self.args.module else "."
-                module_name, app_name = self.args.module.rsplit(delimiter, 1)
-
-                if app_name.endswith("()"):
-                    self.args.factory = True
-                    app_name = app_name[:-2]
-
-                module = import_module(module_name)
-                app = getattr(module, app_name, None)
-                if self.args.factory:
-                    app = app()
-
-                app_type_name = type(app).__name__
-
-                if not isinstance(app, Sanic):
-                    raise ValueError(
-                        f"Module is not a Sanic app, it is a {app_type_name}\n"
-                        f"  Perhaps you meant {self.args.module}.app?"
-                    )
-        except ImportError as e:
-            if module_name.startswith(e.name):
-                error_logger.error(
-                    f"No module named {e.name} found.\n"
-                    "  Example File: project/sanic_server.py -> app\n"
-                    "  Example Module: project.sanic_server.app"
-                )
-            else:
-                raise e
-        return app
-
-    def _build_run_kwargs(self):
-        ssl: Union[None, dict, str, list] = []
-        if self.args.tlshost:
-            ssl.append(None)
-        if self.args.cert is not None or self.args.key is not None:
-            ssl.append(dict(cert=self.args.cert, key=self.args.key))
-        if self.args.tls:
-            ssl += self.args.tls
-        if not ssl:
-            ssl = None
-        elif len(ssl) == 1 and ssl[0] is not None:
-            # Use only one cert, no TLSSelector.
-            ssl = ssl[0]
-        kwargs = {
-            "access_log": self.args.access_log,
-            "debug": self.args.debug,
-            "fast": self.args.fast,
-            "host": self.args.host,
-            "motd": self.args.motd,
-            "noisy_exceptions": self.args.noisy_exceptions,
-            "port": self.args.port,
-            "ssl": ssl,
-            "unix": self.args.unix,
-            "verbosity": self.args.verbosity or 0,
-            "workers": self.args.workers,
-        }
-
-        for maybe_arg in ("auto_reload", "dev"):
-            if getattr(self.args, maybe_arg, False):
-                kwargs[maybe_arg] = True
-
-        if self.args.path:
-            kwargs["auto_reload"] = True
-            kwargs["reload_dir"] = self.args.path
-        return kwargs

sanic/cli/arguments.py

@@ -1,236 +0,0 @@
-from __future__ import annotations
-
-from argparse import ArgumentParser, _ArgumentGroup
-from typing import List, Optional, Type, Union
-
-from sanic_routing import __version__ as __routing_version__  # type: ignore
-
-from sanic import __version__
-
-
-class Group:
-    name: Optional[str]
-    container: Union[ArgumentParser, _ArgumentGroup]
-    _registry: List[Type[Group]] = []
-
-    def __init_subclass__(cls) -> None:
-        Group._registry.append(cls)
-
-    def __init__(self, parser: ArgumentParser, title: Optional[str]):
-        self.parser = parser
-
-        if title:
-            self.container = self.parser.add_argument_group(title=f"  {title}")
-        else:
-            self.container = self.parser
-
-    @classmethod
-    def create(cls, parser: ArgumentParser):
-        instance = cls(parser, cls.name)
-        return instance
-
-    def add_bool_arguments(self, *args, **kwargs):
-        group = self.container.add_mutually_exclusive_group()
-        kwargs["help"] = kwargs["help"].capitalize()
-        group.add_argument(*args, action="store_true", **kwargs)
-        kwargs["help"] = f"no {kwargs['help'].lower()}".capitalize()
-        group.add_argument(
-            "--no-" + args[0][2:], *args[1:], action="store_false", **kwargs
-        )
-
-
-class GeneralGroup(Group):
-    name = None
-
-    def attach(self):
-        self.container.add_argument(
-            "--version",
-            action="version",
-            version=f"Sanic {__version__}; Routing {__routing_version__}",
-        )
-
-        self.container.add_argument(
-            "module",
-            help=(
-                "Path to your Sanic app. Example: path.to.server:app\n"
-                "If running a Simple Server, path to directory to serve. "
-                "Example: ./\n"
-            ),
-        )
-
-
-class ApplicationGroup(Group):
-    name = "Application"
-
-    def attach(self):
-        self.container.add_argument(
-            "--factory",
-            action="store_true",
-            help=(
-                "Treat app as an application factory, "
-                "i.e. a () -> <Sanic app> callable"
-            ),
-        )
-        self.container.add_argument(
-            "-s",
-            "--simple",
-            dest="simple",
-            action="store_true",
-            help=(
-                "Run Sanic as a Simple Server, and serve the contents of "
-                "a directory\n(module arg should be a path)"
-            ),
-        )
-
-
-class SocketGroup(Group):
-    name = "Socket binding"
-
-    def attach(self):
-        self.container.add_argument(
-            "-H",
-            "--host",
-            dest="host",
-            type=str,
-            default="127.0.0.1",
-            help="Host address [default 127.0.0.1]",
-        )
-        self.container.add_argument(
-            "-p",
-            "--port",
-            dest="port",
-            type=int,
-            default=8000,
-            help="Port to serve on [default 8000]",
-        )
-        self.container.add_argument(
-            "-u",
-            "--unix",
-            dest="unix",
-            type=str,
-            default="",
-            help="location of unix socket",
-        )
-
-
-class TLSGroup(Group):
-    name = "TLS certificate"
-
-    def attach(self):
-        self.container.add_argument(
-            "--cert",
-            dest="cert",
-            type=str,
-            help="Location of fullchain.pem, bundle.crt or equivalent",
-        )
-        self.container.add_argument(
-            "--key",
-            dest="key",
-            type=str,
-            help="Location of privkey.pem or equivalent .key file",
-        )
-        self.container.add_argument(
-            "--tls",
-            metavar="DIR",
-            type=str,
-            action="append",
-            help=(
-                "TLS certificate folder with fullchain.pem and privkey.pem\n"
-                "May be specified multiple times to choose multiple "
-                "certificates"
-            ),
-        )
-        self.container.add_argument(
-            "--tls-strict-host",
-            dest="tlshost",
-            action="store_true",
-            help="Only allow clients that send an SNI matching server certs",
-        )
-
-
-class WorkerGroup(Group):
-    name = "Worker"
-
-    def attach(self):
-        group = self.container.add_mutually_exclusive_group()
-        group.add_argument(
-            "-w",
-            "--workers",
-            dest="workers",
-            type=int,
-            default=1,
-            help="Number of worker processes [default 1]",
-        )
-        group.add_argument(
-            "--fast",
-            dest="fast",
-            action="store_true",
-            help="Set the number of workers to max allowed",
-        )
-        self.add_bool_arguments(
-            "--access-logs", dest="access_log", help="display access logs"
-        )
-
-
-class DevelopmentGroup(Group):
-    name = "Development"
-
-    def attach(self):
-        self.container.add_argument(
-            "--debug",
-            dest="debug",
-            action="store_true",
-            help=(
-                "Run the server in DEBUG mode. It includes DEBUG logging,\n"
-                "additional context on exceptions, and other settings\n"
-                "not-safe for PRODUCTION, but helpful for debugging problems."
-            ),
-        )
-        self.container.add_argument(
-            "-r",
-            "--reload",
-            "--auto-reload",
-            dest="auto_reload",
-            action="store_true",
-            help=(
-                "Watch source directory for file changes and reload on "
-                "changes"
-            ),
-        )
-        self.container.add_argument(
-            "-R",
-            "--reload-dir",
-            dest="path",
-            action="append",
-            help="Extra directories to watch and reload on changes",
-        )
-        self.container.add_argument(
-            "-d",
-            "--dev",
-            dest="dev",
-            action="store_true",
-            help=("debug + auto reload."),
-        )
-
-
-class OutputGroup(Group):
-    name = "Output"
-
-    def attach(self):
-        self.add_bool_arguments(
-            "--motd",
-            dest="motd",
-            default=True,
-            help="Show the startup display",
-        )
-        self.container.add_argument(
-            "-v",
-            "--verbosity",
-            action="count",
-            help="Control logging noise, eg. -vv or --verbosity=2 [default 0]",
-        )
-        self.add_bool_arguments(
-            "--noisy-exceptions",
-            dest="noisy_exceptions",
-            help="Output stack traces for all exceptions",
-        )

sanic/compat.py

@@ -8,21 +8,6 @@ from multidict import CIMultiDict  # type: ignore
 
 
 OS_IS_WINDOWS = os.name == "nt"
-UVLOOP_INSTALLED = False
-
-try:
-    import uvloop  # type: ignore # noqa
-
-    UVLOOP_INSTALLED = True
-except ImportError:
-    pass
-
-
-def enable_windows_color_support():
-    import ctypes
-
-    kernel = ctypes.windll.kernel32
-    kernel.SetConsoleMode(kernel.GetStdHandle(-11), 7)
 
 
 class Header(CIMultiDict):

sanic/config.py

@@ -1,121 +1,58 @@
-from __future__ import annotations
-
-from inspect import getmembers, isclass, isdatadescriptor
+from inspect import isclass
 from os import environ
 from pathlib import Path
-from typing import Any, Callable, Dict, Optional, Sequence, Union
+from typing import Any, Union
 
-from sanic.errorpages import DEFAULT_FORMAT, check_error_format
-from sanic.helpers import Default, _default
-from sanic.http import Http
-from sanic.log import deprecation, error_logger
-from sanic.utils import load_module_from_file_location, str_to_bool
+from .utils import load_module_from_file_location, str_to_bool
 
 
 SANIC_PREFIX = "SANIC_"
+BASE_LOGO = """
 
+                 Sanic
+         Build Fast. Run Fast.
+
+"""
 
 DEFAULT_CONFIG = {
-    "_FALLBACK_ERROR_FORMAT": _default,
-    "ACCESS_LOG": True,
-    "AUTO_EXTEND": True,
-    "AUTO_RELOAD": False,
-    "EVENT_AUTOREGISTER": False,
-    "FORWARDED_FOR_HEADER": "X-Forwarded-For",
-    "FORWARDED_SECRET": None,
-    "GRACEFUL_SHUTDOWN_TIMEOUT": 15.0,  # 15 sec
-    "KEEP_ALIVE_TIMEOUT": 5,  # 5 seconds
-    "KEEP_ALIVE": True,
-    "MOTD": True,
-    "MOTD_DISPLAY": {},
-    "NOISY_EXCEPTIONS": False,
-    "PROXIES_COUNT": None,
-    "REAL_IP_HEADER": None,
-    "REGISTER": True,
-    "REQUEST_BUFFER_SIZE": 65536,  # 64 KiB
-    "REQUEST_MAX_HEADER_SIZE": 8192,  # 8 KiB, but cannot exceed 16384
-    "REQUEST_ID_HEADER": "X-Request-ID",
     "REQUEST_MAX_SIZE": 100000000,  # 100 megabytes
+    "REQUEST_BUFFER_QUEUE_SIZE": 100,
+    "REQUEST_BUFFER_SIZE": 65536,  # 64 KiB
     "REQUEST_TIMEOUT": 60,  # 60 seconds
     "RESPONSE_TIMEOUT": 60,  # 60 seconds
-    "USE_UVLOOP": _default,
-    "WEBSOCKET_MAX_SIZE": 2**20,  # 1 megabyte
-    "WEBSOCKET_PING_INTERVAL": 20,
+    "KEEP_ALIVE": True,
+    "KEEP_ALIVE_TIMEOUT": 5,  # 5 seconds
+    "WEBSOCKET_MAX_SIZE": 2 ** 20,  # 1 megabyte
+    "WEBSOCKET_MAX_QUEUE": 32,
+    "WEBSOCKET_READ_LIMIT": 2 ** 16,
+    "WEBSOCKET_WRITE_LIMIT": 2 ** 16,
     "WEBSOCKET_PING_TIMEOUT": 20,
+    "WEBSOCKET_PING_INTERVAL": 20,
+    "GRACEFUL_SHUTDOWN_TIMEOUT": 15.0,  # 15 sec
+    "ACCESS_LOG": True,
+    "FORWARDED_SECRET": None,
+    "REAL_IP_HEADER": None,
+    "PROXIES_COUNT": None,
+    "FORWARDED_FOR_HEADER": "X-Forwarded-For",
+    "REQUEST_ID_HEADER": "X-Request-ID",
+    "FALLBACK_ERROR_FORMAT": "html",
+    "REGISTER": True,
 }
 
-# These values will be removed from the Config object in v22.6 and moved
-# to the application state
-DEPRECATED_CONFIG = ("SERVER_RUNNING", "RELOADER_PROCESS", "RELOADED_FILES")
 
-
-class DescriptorMeta(type):
-    def __init__(cls, *_):
-        cls.__setters__ = {name for name, _ in getmembers(cls, cls._is_setter)}
-
-    @staticmethod
-    def _is_setter(member: object):
-        return isdatadescriptor(member) and hasattr(member, "setter")
-
-
-class Config(dict, metaclass=DescriptorMeta):
-    ACCESS_LOG: bool
-    AUTO_EXTEND: bool
-    AUTO_RELOAD: bool
-    EVENT_AUTOREGISTER: bool
-    FORWARDED_FOR_HEADER: str
-    FORWARDED_SECRET: Optional[str]
-    GRACEFUL_SHUTDOWN_TIMEOUT: float
-    KEEP_ALIVE_TIMEOUT: int
-    KEEP_ALIVE: bool
-    NOISY_EXCEPTIONS: bool
-    MOTD: bool
-    MOTD_DISPLAY: Dict[str, str]
-    PROXIES_COUNT: Optional[int]
-    REAL_IP_HEADER: Optional[str]
-    REGISTER: bool
-    REQUEST_BUFFER_SIZE: int
-    REQUEST_MAX_HEADER_SIZE: int
-    REQUEST_ID_HEADER: str
-    REQUEST_MAX_SIZE: int
-    REQUEST_TIMEOUT: int
-    RESPONSE_TIMEOUT: int
-    SERVER_NAME: str
-    USE_UVLOOP: Union[Default, bool]
-    WEBSOCKET_MAX_SIZE: int
-    WEBSOCKET_PING_INTERVAL: int
-    WEBSOCKET_PING_TIMEOUT: int
-
-    def __init__(
-        self,
-        defaults: Dict[str, Union[str, bool, int, float, None]] = None,
-        env_prefix: Optional[str] = SANIC_PREFIX,
-        keep_alive: Optional[bool] = None,
-        *,
-        converters: Optional[Sequence[Callable[[str], Any]]] = None,
-    ):
+class Config(dict):
+    def __init__(self, defaults=None, load_env=True, keep_alive=None):
         defaults = defaults or {}
         super().__init__({**DEFAULT_CONFIG, **defaults})
 
-        self._converters = [str, str_to_bool, float, int]
-        self._LOGO = ""
-
-        if converters:
-            for converter in converters:
-                self.register_type(converter)
+        self.LOGO = BASE_LOGO
 
         if keep_alive is not None:
             self.KEEP_ALIVE = keep_alive
 
-        if env_prefix != SANIC_PREFIX:
-            if env_prefix:
-                self.load_environment_vars(env_prefix)
-        else:
-            self.load_environment_vars(SANIC_PREFIX)
-
-        self._configure_header_size()
-        self._check_error_format()
-        self._init = True
+        if load_env:
+            prefix = SANIC_PREFIX if load_env is True else load_env
+            self.load_environment_vars(prefix=prefix)
 
     def __getattr__(self, attr):
         try:
@@ -123,130 +60,36 @@ class Config(dict, metaclass=DescriptorMeta):
         except KeyError as ke:
             raise AttributeError(f"Config has no '{ke.args[0]}'")
 
-    def __setattr__(self, attr, value) -> None:
-        self.update({attr: value})
-
-    def __setitem__(self, attr, value) -> None:
-        self.update({attr: value})
-
-    def update(self, *other, **kwargs) -> None:
-        kwargs.update({k: v for item in other for k, v in dict(item).items()})
-        setters: Dict[str, Any] = {
-            k: kwargs.pop(k)
-            for k in {**kwargs}.keys()
-            if k in self.__class__.__setters__
-        }
-
-        for key, value in setters.items():
-            try:
-                super().__setattr__(key, value)
-            except AttributeError:
-                ...
-
-        super().update(**kwargs)
-        for attr, value in {**setters, **kwargs}.items():
-            self._post_set(attr, value)
-
-    def _post_set(self, attr, value) -> None:
-        if self.get("_init"):
-            if attr in (
-                "REQUEST_MAX_HEADER_SIZE",
-                "REQUEST_BUFFER_SIZE",
-                "REQUEST_MAX_SIZE",
-            ):
-                self._configure_header_size()
-            elif attr == "LOGO":
-                self._LOGO = value
-                deprecation(
-                    "Setting the config.LOGO is deprecated and will no longer "
-                    "be supported starting in v22.6.",
-                    22.6,
-                )
-
-    @property
-    def LOGO(self):
-        return self._LOGO
-
-    @property
-    def FALLBACK_ERROR_FORMAT(self) -> str:
-        if self._FALLBACK_ERROR_FORMAT is _default:
-            return DEFAULT_FORMAT
-        return self._FALLBACK_ERROR_FORMAT
-
-    @FALLBACK_ERROR_FORMAT.setter
-    def FALLBACK_ERROR_FORMAT(self, value):
-        self._check_error_format(value)
-        if (
-            self._FALLBACK_ERROR_FORMAT is not _default
-            and value != self._FALLBACK_ERROR_FORMAT
-        ):
-            error_logger.warning(
-                "Setting config.FALLBACK_ERROR_FORMAT on an already "
-                "configured value may have unintended consequences."
-            )
-        self._FALLBACK_ERROR_FORMAT = value
-
-    def _configure_header_size(self):
-        Http.set_header_max_size(
-            self.REQUEST_MAX_HEADER_SIZE,
-            self.REQUEST_BUFFER_SIZE - 4096,
-            self.REQUEST_MAX_SIZE,
-        )
-
-    def _check_error_format(self, format: Optional[str] = None):
-        check_error_format(format or self.FALLBACK_ERROR_FORMAT)
+    def __setattr__(self, attr, value):
+        self[attr] = value
 
     def load_environment_vars(self, prefix=SANIC_PREFIX):
         """
-        Looks for prefixed environment variables and applies them to the
-        configuration if present. This is called automatically when Sanic
-        starts up to load environment variables into config.
+        Looks for prefixed environment variables and applies
+        them to the configuration if present. This is called automatically when
+        Sanic starts up to load environment variables into config.
 
-        It will automatically hydrate the following types:
+        It will automatically hyrdate the following types:
 
         - ``int``
         - ``float``
         - ``bool``
 
-        Anything else will be imported as a ``str``. If you would like to add
-        additional types to this list, you can use
-        :meth:`sanic.config.Config.register_type`. Just make sure that they
-        are registered before you instantiate your application.
-
-        .. code-block:: python
-
-            class Foo:
-                def __init__(self, name) -> None:
-                    self.name = name
-
-
-            config = Config(converters=[Foo])
-            app = Sanic(__name__, config=config)
-
-        `See user guide re: config
-        <https://sanicframework.org/guide/deployment/configuration.html>`__
+        Anything else will be imported as a ``str``.
         """
-        lower_case_var_found = False
-        for key, value in environ.items():
-            if not key.startswith(prefix):
-                continue
-            if not key.isupper():
-                lower_case_var_found = True
-
-            _, config_key = key.split(prefix, 1)
-
-            for converter in reversed(self._converters):
+        for k, v in environ.items():
+            if k.startswith(prefix):
+                _, config_key = k.split(prefix, 1)
                 try:
-                    self[config_key] = converter(value)
-                    break
+                    self[config_key] = int(v)
                 except ValueError:
-                    pass
-        if lower_case_var_found:
-            deprecation(
-                "Lowercase environment variables will not be "
-                "loaded into Sanic config beginning in v22.9.",
-                22.9,
-            )
+                    try:
+                        self[config_key] = float(v)
+                    except ValueError:
+                        try:
+                            self[config_key] = str_to_bool(v)
+                        except ValueError:
+                            self[config_key] = v
 
     def update_config(self, config: Union[bytes, str, dict, Any]):
         """
@@ -316,17 +159,3 @@ class Config(dict, metaclass=DescriptorMeta):
         self.update(config)
 
     load = update_config
-
-    def register_type(self, converter: Callable[[str], Any]) -> None:
-        """
-        Allows for adding custom function to cast from a string value to any
-        other type. The function should raise ValueError if it is not the
-        correct type.
-        """
-        if converter in self._converters:
-            error_logger.warning(
-                f"Configuration value converter '{converter.__name__}' has "
-                "already been registered"
-            )
-            return
-        self._converters.append(converter)

sanic/constants.py

@@ -1,28 +1,2 @@
-from enum import Enum, auto
-
-
-class HTTPMethod(str, Enum):
-    def _generate_next_value_(name, start, count, last_values):
-        return name.upper()
-
-    def __eq__(self, value: object) -> bool:
-        value = str(value).upper()
-        return super().__eq__(value)
-
-    def __hash__(self) -> int:
-        return hash(self.value)
-
-    def __str__(self) -> str:
-        return self.value
-
-    GET = auto()
-    POST = auto()
-    PUT = auto()
-    HEAD = auto()
-    OPTIONS = auto()
-    PATCH = auto()
-    DELETE = auto()
-
-
-HTTP_METHODS = tuple(HTTPMethod.__members__.values())
+HTTP_METHODS = ("GET", "POST", "PUT", "HEAD", "OPTIONS", "PATCH", "DELETE")
 DEFAULT_HTTP_CONTENT_TYPE = "application/octet-stream"

sanic/errorpages.py

@@ -25,16 +25,14 @@ from sanic.request import Request
 from sanic.response import HTTPResponse, html, json, text
 
 
-dumps: t.Callable[..., str]
 try:
     from ujson import dumps
 
     dumps = partial(dumps, escape_forward_slashes=False)
 except ImportError:  # noqa
-    from json import dumps
+    from json import dumps  # type: ignore
 
 
-DEFAULT_FORMAT = "auto"
 FALLBACK_TEXT = (
     "The server encountered an internal error and "
     "cannot complete your request."
@@ -47,8 +45,6 @@ class BaseRenderer:
     Base class that all renderers must inherit from.
     """
 
-    dumps = staticmethod(dumps)
-
     def __init__(self, request, exception, debug):
         self.request = request
         self.exception = exception
@@ -116,16 +112,14 @@ class HTMLRenderer(BaseRenderer):
     TRACEBACK_STYLE = """
         html { font-family: sans-serif }
         h2 { color: #888; }
-        .tb-wrapper p, dl, dd { margin: 0 }
+        .tb-wrapper p { margin: 0 }
         .frame-border { margin: 1rem }
-        .frame-line > *, dt, dd { padding: 0.3rem 0.6rem }
-        .frame-line, dl { margin-bottom: 0.3rem }
-        .frame-code, dd { font-size: 16px; padding-left: 4ch }
-        .tb-wrapper, dl { border: 1px solid #eee }
-        .tb-header,.obj-header {
-            background: #eee; padding: 0.3rem; font-weight: bold
-        }
-        .frame-descriptor, dt { background: #e2eafb; font-size: 14px }
+        .frame-line > * { padding: 0.3rem 0.6rem }
+        .frame-line { margin-bottom: 0.3rem }
+        .frame-code { font-size: 16px; padding-left: 4ch }
+        .tb-wrapper { border: 1px solid #eee }
+        .tb-header { background: #eee; padding: 0.3rem; font-weight: bold }
+        .frame-descriptor { background: #e2eafb; font-size: 14px }
     """
     TRACEBACK_WRAPPER_HTML = (
         "<div class=tb-header>{exc_name}: {exc_value}</div>"
@@ -144,11 +138,6 @@ class HTMLRenderer(BaseRenderer):
         "<p class=frame-code><code>{0.line}</code>"
         "</div>"
     )
-    OBJECT_WRAPPER_HTML = (
-        "<div class=obj-header>{title}</div>"
-        "<dl class={obj_type}>{display_html}</dl>"
-    )
-    OBJECT_DISPLAY_HTML = "<dt>{key}</dt><dd><code>{value}</code></dd>"
     OUTPUT_HTML = (
         "<!DOCTYPE html><html lang=en>"
         "<meta charset=UTF-8><title>{title}</title>\n"
@@ -163,7 +152,7 @@ class HTMLRenderer(BaseRenderer):
                 title=self.title,
                 text=self.text,
                 style=self.TRACEBACK_STYLE,
-                body=self._generate_body(full=True),
+                body=self._generate_body(),
             ),
             status=self.status,
         )
@@ -174,7 +163,7 @@ class HTMLRenderer(BaseRenderer):
                 title=self.title,
                 text=self.text,
                 style=self.TRACEBACK_STYLE,
-                body=self._generate_body(full=False),
+                body="",
             ),
             status=self.status,
             headers=self.headers,
@@ -188,49 +177,27 @@ class HTMLRenderer(BaseRenderer):
     def title(self):
         return escape(f"⚠️ {super().title}")
 
-    def _generate_body(self, *, full):
-        lines = []
-        if full:
-            _, exc_value, __ = sys.exc_info()
-            exceptions = []
-            while exc_value:
-                exceptions.append(self._format_exc(exc_value))
-                exc_value = exc_value.__cause__
-
-            traceback_html = self.TRACEBACK_BORDER.join(reversed(exceptions))
-            appname = escape(self.request.app.name)
-            name = escape(self.exception.__class__.__name__)
-            value = escape(self.exception)
-            path = escape(self.request.path)
-            lines += [
-                f"<h2>Traceback of {appname} " "(most recent call last):</h2>",
-                f"{traceback_html}",
-                "<div class=summary><p>",
-                f"<b>{name}: {value}</b> "
-                f"while handling path <code>{path}</code>",
-                "</div>",
-            ]
-
-        for attr, display in (("context", True), ("extra", bool(full))):
-            info = getattr(self.exception, attr, None)
-            if info and display:
-                lines.append(self._generate_object_display(info, attr))
+    def _generate_body(self):
+        _, exc_value, __ = sys.exc_info()
+        exceptions = []
+        while exc_value:
+            exceptions.append(self._format_exc(exc_value))
+            exc_value = exc_value.__cause__
 
+        traceback_html = self.TRACEBACK_BORDER.join(reversed(exceptions))
+        appname = escape(self.request.app.name)
+        name = escape(self.exception.__class__.__name__)
+        value = escape(self.exception)
+        path = escape(self.request.path)
+        lines = [
+            f"<h2>Traceback of {appname} (most recent call last):</h2>",
+            f"{traceback_html}",
+            "<div class=summary><p>",
+            f"<b>{name}: {value}</b> while handling path <code>{path}</code>",
+            "</div>",
+        ]
         return "\n".join(lines)
 
-    def _generate_object_display(
-        self, obj: t.Dict[str, t.Any], descriptor: str
-    ) -> str:
-        display = "".join(
-            self.OBJECT_DISPLAY_HTML.format(key=key, value=value)
-            for key, value in obj.items()
-        )
-        return self.OBJECT_WRAPPER_HTML.format(
-            title=descriptor.title(),
-            display_html=display,
-            obj_type=descriptor.lower(),
-        )
-
     def _format_exc(self, exc):
         frames = extract_tb(exc.__traceback__)
         frame_html = "".join(
@@ -257,7 +224,7 @@ class TextRenderer(BaseRenderer):
                 title=self.title,
                 text=self.text,
                 bar=("=" * len(self.title)),
-                body=self._generate_body(full=True),
+                body=self._generate_body(),
             ),
             status=self.status,
         )
@@ -268,7 +235,7 @@ class TextRenderer(BaseRenderer):
                 title=self.title,
                 text=self.text,
                 bar=("=" * len(self.title)),
-                body=self._generate_body(full=False),
+                body="",
             ),
             status=self.status,
             headers=self.headers,
@@ -278,31 +245,21 @@ class TextRenderer(BaseRenderer):
     def title(self):
         return f"⚠️ {super().title}"
 
-    def _generate_body(self, *, full):
-        lines = []
-        if full:
-            _, exc_value, __ = sys.exc_info()
-            exceptions = []
+    def _generate_body(self):
+        _, exc_value, __ = sys.exc_info()
+        exceptions = []
 
-            lines += [
-                f"{self.exception.__class__.__name__}: {self.exception} while "
-                f"handling path {self.request.path}",
-                f"Traceback of {self.request.app.name} "
-                "(most recent call last):\n",
-            ]
+        lines = [
+            f"{self.exception.__class__.__name__}: {self.exception} while "
+            f"handling path {self.request.path}",
+            f"Traceback of {self.request.app.name} (most recent call last):\n",
+        ]
 
-            while exc_value:
-                exceptions.append(self._format_exc(exc_value))
-                exc_value = exc_value.__cause__
+        while exc_value:
+            exceptions.append(self._format_exc(exc_value))
+            exc_value = exc_value.__cause__
 
-            lines += exceptions[::-1]
-
-        for attr, display in (("context", True), ("extra", bool(full))):
-            info = getattr(self.exception, attr, None)
-            if info and display:
-                lines += self._generate_object_display_list(info, attr)
-
-        return "\n".join(lines)
+        return "\n".join(lines + exceptions[::-1])
 
     def _format_exc(self, exc):
         frames = "\n\n".join(
@@ -315,13 +272,6 @@ class TextRenderer(BaseRenderer):
         )
         return f"{self.SPACER}{exc.__class__.__name__}: {exc}\n{frames}"
 
-    def _generate_object_display_list(self, obj, descriptor):
-        lines = [f"\n{descriptor.title()}"]
-        for key, value in obj.items():
-            display = self.dumps(value)
-            lines.append(f"{self.SPACER * 2}{key}: {display}")
-        return lines
-
 
 class JSONRenderer(BaseRenderer):
     """
@@ -330,11 +280,11 @@ class JSONRenderer(BaseRenderer):
 
     def full(self) -> HTTPResponse:
         output = self._generate_output(full=True)
-        return json(output, status=self.status, dumps=self.dumps)
+        return json(output, status=self.status, dumps=dumps)
 
     def minimal(self) -> HTTPResponse:
         output = self._generate_output(full=False)
-        return json(output, status=self.status, dumps=self.dumps)
+        return json(output, status=self.status, dumps=dumps)
 
     def _generate_output(self, *, full):
         output = {
@@ -343,11 +293,6 @@ class JSONRenderer(BaseRenderer):
             "message": self.text,
         }
 
-        for attr, display in (("context", True), ("extra", bool(full))):
-            info = getattr(self.exception, attr, None)
-            if info and display:
-                output[attr] = info
-
         if full:
             _, exc_value, __ = sys.exc_info()
             exceptions = []
@@ -395,139 +340,41 @@ RENDERERS_BY_CONFIG = {
 }
 
 RENDERERS_BY_CONTENT_TYPE = {
-    "text/plain": TextRenderer,
-    "application/json": JSONRenderer,
     "multipart/form-data": HTMLRenderer,
-    "text/html": HTMLRenderer,
+    "application/json": JSONRenderer,
+    "text/plain": TextRenderer,
 }
-CONTENT_TYPE_BY_RENDERERS = {
-    v: k for k, v in RENDERERS_BY_CONTENT_TYPE.items()
-}
-
-RESPONSE_MAPPING = {
-    "empty": "html",
-    "json": "json",
-    "text": "text",
-    "raw": "text",
-    "html": "html",
-    "file": "html",
-    "file_stream": "text",
-    "stream": "text",
-    "redirect": "html",
-    "text/plain": "text",
-    "text/html": "html",
-    "application/json": "json",
-}
-
-
-def check_error_format(format):
-    if format not in RENDERERS_BY_CONFIG and format != "auto":
-        raise SanicException(f"Unknown format: {format}")
 
 
 def exception_response(
     request: Request,
     exception: Exception,
     debug: bool,
-    fallback: str,
-    base: t.Type[BaseRenderer],
     renderer: t.Type[t.Optional[BaseRenderer]] = None,
 ) -> HTTPResponse:
     """
     Render a response for the default FALLBACK exception handler.
     """
-    content_type = None
 
     if not renderer:
-        # Make sure we have something set
-        renderer = base
-        render_format = fallback
+        renderer = HTMLRenderer
 
         if request:
-            # If there is a request, try and get the format
-            # from the route
-            if request.route:
+            if request.app.config.FALLBACK_ERROR_FORMAT == "auto":
                 try:
-                    if request.route.ctx.error_format:
-                        render_format = request.route.ctx.error_format
-                except AttributeError:
-                    ...
-
-            content_type = request.headers.getone("content-type", "").split(
-                ";"
-            )[0]
-
-            acceptable = request.accept
-
-            # If the format is auto still, make a guess
-            if render_format == "auto":
-                # First, if there is an Accept header, check if text/html
-                # is the first option
-                # According to MDN Web Docs, all major browsers use text/html
-                # as the primary value in Accept (with the exception of IE 8,
-                # and, well, if you are supporting IE 8, then you have bigger
-                # problems to concern yourself with than what default exception
-                # renderer is used)
-                # Source:
-                # https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation/List_of_default_Accept_values
-
-                if acceptable and acceptable[0].match(
-                    "text/html",
-                    allow_type_wildcard=False,
-                    allow_subtype_wildcard=False,
-                ):
+                    renderer = JSONRenderer if request.json else HTMLRenderer
+                except InvalidUsage:
                     renderer = HTMLRenderer
 
-                # Second, if there is an Accept header, check if
-                # application/json is an option, or if the content-type
-                # is application/json
-                elif (
-                    acceptable
-                    and acceptable.match(
-                        "application/json",
-                        allow_type_wildcard=False,
-                        allow_subtype_wildcard=False,
-                    )
-                    or content_type == "application/json"
-                ):
-                    renderer = JSONRenderer
-
-                # Third, if there is no Accept header, assume we want text.
-                # The likely use case here is a raw socket.
-                elif not acceptable:
-                    renderer = TextRenderer
-                else:
-                    # Fourth, look to see if there was a JSON body
-                    # When in this situation, the request is probably coming
-                    # from curl, an API client like Postman or Insomnia, or a
-                    # package like requests or httpx
-                    try:
-                        # Give them the benefit of the doubt if they did:
-                        # $ curl localhost:8000 -d '{"foo": "bar"}'
-                        # And provide them with JSONRenderer
-                        renderer = JSONRenderer if request.json else base
-                    except InvalidUsage:
-                        renderer = base
+                content_type, *_ = request.headers.get(
+                    "content-type", ""
+                ).split(";")
+                renderer = RENDERERS_BY_CONTENT_TYPE.get(
+                    content_type, renderer
+                )
             else:
+                render_format = request.app.config.FALLBACK_ERROR_FORMAT
                 renderer = RENDERERS_BY_CONFIG.get(render_format, renderer)
 
-            # Lastly, if there is an Accept header, make sure
-            # our choice is okay
-            if acceptable:
-                type_ = CONTENT_TYPE_BY_RENDERERS.get(renderer)  # type: ignore
-                if type_ and type_ not in acceptable:
-                    # If the renderer selected is not in the Accept header
-                    # look through what is in the Accept header, and select
-                    # the first option that matches. Otherwise, just drop back
-                    # to the original default
-                    for accept in acceptable:
-                        mtype = f"{accept.type_}/{accept.subtype}"
-                        maybe = RENDERERS_BY_CONTENT_TYPE.get(mtype)
-                        if maybe:
-                            renderer = maybe
-                            break
-                    else:
-                        renderer = base
-
     renderer = t.cast(t.Type[BaseRenderer], renderer)
     return renderer(request, exception, debug).render()

sanic/exceptions.py

@@ -1,28 +1,28 @@
-from typing import Any, Dict, Optional, Union
+from typing import Optional, Union
 
 from sanic.helpers import STATUS_CODES
 
 
+_sanic_exceptions = {}
+
+
+def add_status_code(code, quiet=None):
+    """
+    Decorator used for adding exceptions to :class:`SanicException`.
+    """
+
+    def class_decorator(cls):
+        cls.status_code = code
+        if quiet or quiet is None and code != 500:
+            cls.quiet = True
+        _sanic_exceptions[code] = cls
+        return cls
+
+    return class_decorator
+
+
 class SanicException(Exception):
-    message: str = ""
-
-    def __init__(
-        self,
-        message: Optional[Union[str, bytes]] = None,
-        status_code: Optional[int] = None,
-        quiet: Optional[bool] = None,
-        context: Optional[Dict[str, Any]] = None,
-        extra: Optional[Dict[str, Any]] = None,
-    ) -> None:
-        self.context = context
-        self.extra = extra
-        if message is None:
-            if self.message:
-                message = self.message
-            elif status_code is not None:
-                msg: bytes = STATUS_CODES.get(status_code, b"")
-                message = msg.decode("utf8")
-
+    def __init__(self, message, status_code=None, quiet=None):
         super().__init__(message)
 
         if status_code is not None:
@@ -33,45 +33,45 @@ class SanicException(Exception):
             self.quiet = True
 
 
+@add_status_code(404)
 class NotFound(SanicException):
     """
     **Status**: 404 Not Found
     """
 
-    status_code = 404
-    quiet = True
+    pass
 
 
+@add_status_code(400)
 class InvalidUsage(SanicException):
     """
     **Status**: 400 Bad Request
     """
 
-    status_code = 400
-    quiet = True
+    pass
 
 
+@add_status_code(405)
 class MethodNotSupported(SanicException):
     """
     **Status**: 405 Method Not Allowed
     """
 
-    status_code = 405
-    quiet = True
-
     def __init__(self, message, method, allowed_methods):
         super().__init__(message)
         self.headers = {"Allow": ", ".join(allowed_methods)}
 
 
+@add_status_code(500)
 class ServerError(SanicException):
     """
     **Status**: 500 Internal Server Error
     """
 
-    status_code = 500
+    pass
 
 
+@add_status_code(503)
 class ServiceUnavailable(SanicException):
     """
     **Status**: 503 Service Unavailable
@@ -80,8 +80,7 @@ class ServiceUnavailable(SanicException):
     down for maintenance). Generally, this is a temporary state.
     """
 
-    status_code = 503
-    quiet = True
+    pass
 
 
 class URLBuildError(ServerError):
@@ -89,7 +88,7 @@ class URLBuildError(ServerError):
     **Status**: 500 Internal Server Error
     """
 
-    status_code = 500
+    pass
 
 
 class FileNotFound(NotFound):
@@ -103,6 +102,7 @@ class FileNotFound(NotFound):
         self.relative_url = relative_url
 
 
+@add_status_code(408)
 class RequestTimeout(SanicException):
     """The Web server (running the Web site) thinks that there has been too
     long an interval of time between 1) the establishment of an IP
@@ -112,17 +112,16 @@ class RequestTimeout(SanicException):
     server has 'timed out' on that particular socket connection.
     """
 
-    status_code = 408
-    quiet = True
+    pass
 
 
+@add_status_code(413)
 class PayloadTooLarge(SanicException):
     """
     **Status**: 413 Payload Too Large
     """
 
-    status_code = 413
-    quiet = True
+    pass
 
 
 class HeaderNotFound(InvalidUsage):
@@ -130,42 +129,36 @@ class HeaderNotFound(InvalidUsage):
     **Status**: 400 Bad Request
     """
 
-
-class InvalidHeader(InvalidUsage):
-    """
-    **Status**: 400 Bad Request
-    """
+    pass
 
 
+@add_status_code(416)
 class ContentRangeError(SanicException):
     """
     **Status**: 416 Range Not Satisfiable
     """
 
-    status_code = 416
-    quiet = True
-
     def __init__(self, message, content_range):
         super().__init__(message)
         self.headers = {"Content-Range": f"bytes */{content_range.total}"}
 
 
+@add_status_code(417)
 class HeaderExpectationFailed(SanicException):
     """
     **Status**: 417 Expectation Failed
     """
 
-    status_code = 417
-    quiet = True
+    pass
 
 
+@add_status_code(403)
 class Forbidden(SanicException):
     """
     **Status**: 403 Forbidden
     """
 
-    status_code = 403
-    quiet = True
+    pass
 
 
 class InvalidRangeType(ContentRangeError):
@@ -173,8 +166,7 @@ class InvalidRangeType(ContentRangeError):
     **Status**: 416 Range Not Satisfiable
     """
 
-    status_code = 416
-    quiet = True
+    pass
 
 
 class PyFileError(Exception):
@@ -182,6 +174,7 @@ class PyFileError(Exception):
         super().__init__("could not execute config file %s", file)
 
 
+@add_status_code(401)
 class Unauthorized(SanicException):
     """
     **Status**: 401 Unauthorized
@@ -217,9 +210,6 @@ class Unauthorized(SanicException):
                            realm="Restricted Area")
     """
 
-    status_code = 401
-    quiet = True
-
     def __init__(self, message, status_code=None, scheme=None, **kwargs):
         super().__init__(message, status_code)
 
@@ -241,6 +231,19 @@ class InvalidSignal(SanicException):
     pass
 
 
-class WebsocketClosed(SanicException):
-    quiet = True
-    message = "Client has closed the websocket connection"
+def abort(status_code: int, message: Optional[Union[str, bytes]] = None):
+    """
+    Raise an exception based on SanicException. Returns the HTTP response
+    message appropriate for the given status code, unless provided.
+
+    STATUS_CODES from sanic.helpers for the given status code.
+
+    :param status_code: The HTTP status code to return.
+    :param message: The HTTP response body. Defaults to the messages in
+    """
+    if message is None:
+        msg: bytes = STATUS_CODES[status_code]
+        # These are stored as bytes in the STATUS_CODES dict
+        message = msg.decode("utf8")
+    sanic_exception = _sanic_exceptions.get(status_code, SanicException)
+    raise sanic_exception(message=message, status_code=status_code)

sanic/handlers.py

@@ -1,23 +1,12 @@
-from __future__ import annotations
+from traceback import format_exc
 
-from typing import Dict, List, Optional, Tuple, Type, Union
-
-from sanic.config import Config
-from sanic.errorpages import (
-    DEFAULT_FORMAT,
-    BaseRenderer,
-    TextRenderer,
-    exception_response,
-)
+from sanic.errorpages import exception_response
 from sanic.exceptions import (
     ContentRangeError,
     HeaderNotFound,
     InvalidRangeType,
-    SanicException,
 )
-from sanic.helpers import Default, _default
-from sanic.log import deprecation, error_logger
-from sanic.models.handler_types import RouteHandler
+from sanic.log import logger
 from sanic.response import text
 
 
@@ -34,97 +23,16 @@ class ErrorHandler:
 
     """
 
-    def __init__(
-        self,
-        fallback: Union[str, Default] = _default,
-        base: Type[BaseRenderer] = TextRenderer,
-    ):
-        self.cached_handlers: Dict[
-            Tuple[Type[BaseException], Optional[str]], Optional[RouteHandler]
-        ] = {}
+    handlers = None
+    cached_handlers = None
+    _missing = object()
+
+    def __init__(self):
+        self.handlers = []
+        self.cached_handlers = {}
         self.debug = False
-        self._fallback = fallback
-        self.base = base
 
-        if fallback is not _default:
-            self._warn_fallback_deprecation()
-
-    @property
-    def fallback(self):  # no cov
-        # This is for backwards compat and can be removed in v22.6
-        if self._fallback is _default:
-            return DEFAULT_FORMAT
-        return self._fallback
-
-    @fallback.setter
-    def fallback(self, value: str):  # no cov
-        self._warn_fallback_deprecation()
-        if not isinstance(value, str):
-            raise SanicException(
-                f"Cannot set error handler fallback to: value={value}"
-            )
-        self._fallback = value
-
-    @staticmethod
-    def _warn_fallback_deprecation():
-        deprecation(
-            "Setting the ErrorHandler fallback value directly is "
-            "deprecated and no longer supported. This feature will "
-            "be removed in v22.6. Instead, use "
-            "app.config.FALLBACK_ERROR_FORMAT.",
-            22.6,
-        )
-
-    @classmethod
-    def _get_fallback_value(cls, error_handler: ErrorHandler, config: Config):
-        if error_handler._fallback is not _default:
-            if config._FALLBACK_ERROR_FORMAT is _default:
-                return error_handler.fallback
-
-            error_logger.warning(
-                "Conflicting error fallback values were found in the "
-                "error handler and in the app.config while handling an "
-                "exception. Using the value from app.config."
-            )
-        return config.FALLBACK_ERROR_FORMAT
-
-    @classmethod
-    def finalize(
-        cls,
-        error_handler: ErrorHandler,
-        config: Config,
-        fallback: Optional[str] = None,
-    ):
-        if fallback:
-            deprecation(
-                "Setting the ErrorHandler fallback value via finalize() "
-                "is deprecated and no longer supported. This feature will "
-                "be removed in v22.6. Instead, use "
-                "app.config.FALLBACK_ERROR_FORMAT.",
-                22.6,
-            )
-
-        if not fallback:
-            fallback = config.FALLBACK_ERROR_FORMAT
-
-        if fallback != DEFAULT_FORMAT:
-            if error_handler._fallback is not _default:
-                error_logger.warning(
-                    f"Setting the fallback value to {fallback}. This changes "
-                    "the current non-default value "
-                    f"'{error_handler._fallback}'."
-                )
-            error_handler._fallback = fallback
-
-        if not isinstance(error_handler, cls):
-            error_logger.warning(
-                f"Error handler is non-conforming: {type(error_handler)}"
-            )
-
-    def _full_lookup(self, exception, route_name: Optional[str] = None):
-        return self.lookup(exception, route_name)
-
-    def add(self, exception, handler, route_names: Optional[List[str]] = None):
+    def add(self, exception, handler):
         """
         Add a new exception handler to an already existing handler object.
 
@@ -137,13 +45,9 @@ class ErrorHandler:
 
         :return: None
         """
-        if route_names:
-            for route in route_names:
-                self.cached_handlers[(exception, route)] = handler
-        else:
-            self.cached_handlers[(exception, None)] = handler
+        self.handlers.append((exception, handler))
 
-    def lookup(self, exception, route_name: Optional[str] = None):
+    def lookup(self, exception):
         """
         Lookup the existing instance of :class:`ErrorHandler` and fetch the
         registered handler for a specific type of exception.
@@ -157,32 +61,16 @@ class ErrorHandler:
 
         :return: Registered function if found ``None`` otherwise
         """
-        exception_class = type(exception)
-
-        for name in (route_name, None):
-            exception_key = (exception_class, name)
-            handler = self.cached_handlers.get(exception_key)
-            if handler:
-                return handler
-
-        for name in (route_name, None):
-            for ancestor in type.mro(exception_class):
-                exception_key = (ancestor, name)
-                if exception_key in self.cached_handlers:
-                    handler = self.cached_handlers[exception_key]
-                    self.cached_handlers[
-                        (exception_class, route_name)
-                    ] = handler
+        handler = self.cached_handlers.get(type(exception), self._missing)
+        if handler is self._missing:
+            for exception_class, handler in self.handlers:
+                if isinstance(exception, exception_class):
+                    self.cached_handlers[type(exception)] = handler
                     return handler
-
-                if ancestor is BaseException:
-                    break
-        self.cached_handlers[(exception_class, route_name)] = None
-        handler = None
+            self.cached_handlers[type(exception)] = None
+            handler = None
         return handler
 
-    _lookup = _full_lookup
-
     def response(self, request, exception):
         """Fetches and executes an exception handler and returns a response
         object
@@ -197,8 +85,7 @@ class ErrorHandler:
         :return: Wrap the return value obtained from :func:`default`
             or registered handler for that type of exception.
         """
-        route_name = request.name if request else None
-        handler = self._lookup(exception, route_name)
+        handler = self.lookup(exception)
         response = None
         try:
             if handler:
@@ -206,14 +93,15 @@ class ErrorHandler:
             if response is None:
                 response = self.default(request, exception)
         except Exception:
+            self.log(format_exc())
             try:
                 url = repr(request.url)
-            except AttributeError:  # no cov
+            except AttributeError:
                 url = "unknown"
             response_message = (
                 "Exception raised in exception handler " '"%s" for uri: %s'
             )
-            error_logger.exception(response_message, handler.__name__, url)
+            logger.exception(response_message, handler.__name__, url)
 
             if self.debug:
                 return text(response_message % (handler.__name__, url), 500)
@@ -221,6 +109,11 @@ class ErrorHandler:
                 return text("An error occurred while handling an error", 500)
         return response
 
+    def log(self, message, level="error"):
+        """
+        Deprecated, do not use.
+        """
+
     def default(self, request, exception):
         """
         Provide a default behavior for the objects of :class:`ErrorHandler`.
@@ -236,29 +129,17 @@ class ErrorHandler:
             :class:`Exception`
         :return:
         """
-        self.log(request, exception)
-        fallback = ErrorHandler._get_fallback_value(self, request.app.config)
-        return exception_response(
-            request,
-            exception,
-            debug=self.debug,
-            base=self.base,
-            fallback=fallback,
-        )
-
-    @staticmethod
-    def log(request, exception):
         quiet = getattr(exception, "quiet", False)
-        noisy = getattr(request.app.config, "NOISY_EXCEPTIONS", False)
-        if quiet is False or noisy is True:
+        if quiet is False:
             try:
                 url = repr(request.url)
-            except AttributeError:  # no cov
+            except AttributeError:
                 url = "unknown"
 
-            error_logger.exception(
-                "Exception occurred while handling uri: %s", url
-            )
+            self.log(format_exc())
+            logger.exception("Exception occurred while handling uri: %s", url)
+
+        return exception_response(request, exception, self.debug)
 
 
 class ContentRangeHandler:
@@ -284,7 +165,7 @@ class ContentRangeHandler:
 
     def __init__(self, request, stats):
         self.total = stats.st_size
-        _range = request.headers.getone("range", None)
+        _range = request.headers.get("Range")
         if _range is None:
             raise HeaderNotFound("Range Header Not Found")
         unit, _, value = tuple(map(str.strip, _range.partition("=")))

sanic/headers.py

@@ -1,11 +1,8 @@
-from __future__ import annotations
-
 import re
 
-from typing import Any, Dict, Iterable, List, Optional, Set, Tuple, Union
+from typing import Any, Dict, Iterable, List, Optional, Tuple, Union
 from urllib.parse import unquote
 
-from sanic.exceptions import InvalidHeader
 from sanic.helpers import STATUS_CODES
 
 
@@ -18,7 +15,7 @@ Options = Dict[str, Union[int, str]]  # key=value fields in various headers
 OptionsIterable = Iterable[Tuple[str, str]]  # May contain duplicate keys
 
 _token, _quoted = r"([\w!#$%&'*+\-.^_`|~]+)", r'"([^"]*)"'
-_param = re.compile(rf";\s*{_token}=(?:{_token}|{_quoted})", re.ASCII)
+_param = re.compile(fr";\s*{_token}=(?:{_token}|{_quoted})", re.ASCII)
 _firefox_quote_escape = re.compile(r'\\"(?!; |\s*$)')
 _ipv6 = "(?:[0-9A-Fa-f]{0,4}:){2,7}[0-9A-Fa-f]{0,4}"
 _ipv6_re = re.compile(_ipv6)
@@ -28,180 +25,11 @@ _host_re = re.compile(
 
 # RFC's quoted-pair escapes are mostly ignored by browsers. Chrome, Firefox and
 # curl all have different escaping, that we try to handle as well as possible,
-# even though no client escapes in a way that would allow perfect handling.
+# even though no client espaces in a way that would allow perfect handling.
 
 # For more information, consult ../tests/test_requests.py
 
 
-def parse_arg_as_accept(f):
-    def func(self, other, *args, **kwargs):
-        if not isinstance(other, Accept) and other:
-            other = Accept.parse(other)
-        return f(self, other, *args, **kwargs)
-
-    return func
-
-
-class MediaType(str):
-    def __new__(cls, value: str):
-        return str.__new__(cls, value)
-
-    def __init__(self, value: str) -> None:
-        self.value = value
-        self.is_wildcard = self.check_if_wildcard(value)
-
-    def __eq__(self, other):
-        if self.is_wildcard:
-            return True
-
-        if self.match(other):
-            return True
-
-        other_is_wildcard = (
-            other.is_wildcard
-            if isinstance(other, MediaType)
-            else self.check_if_wildcard(other)
-        )
-
-        return other_is_wildcard
-
-    def match(self, other):
-        other_value = other.value if isinstance(other, MediaType) else other
-        return self.value == other_value
-
-    @staticmethod
-    def check_if_wildcard(value):
-        return value == "*"
-
-
-class Accept(str):
-    def __new__(cls, value: str, *args, **kwargs):
-        return str.__new__(cls, value)
-
-    def __init__(
-        self,
-        value: str,
-        type_: MediaType,
-        subtype: MediaType,
-        *,
-        q: str = "1.0",
-        **kwargs: str,
-    ):
-        qvalue = float(q)
-        if qvalue > 1 or qvalue < 0:
-            raise InvalidHeader(
-                f"Accept header qvalue must be between 0 and 1, not: {qvalue}"
-            )
-        self.value = value
-        self.type_ = type_
-        self.subtype = subtype
-        self.qvalue = qvalue
-        self.params = kwargs
-
-    def _compare(self, other, method):
-        try:
-            return method(self.qvalue, other.qvalue)
-        except (AttributeError, TypeError):
-            return NotImplemented
-
-    @parse_arg_as_accept
-    def __lt__(self, other: Union[str, Accept]):
-        return self._compare(other, lambda s, o: s < o)
-
-    @parse_arg_as_accept
-    def __le__(self, other: Union[str, Accept]):
-        return self._compare(other, lambda s, o: s <= o)
-
-    @parse_arg_as_accept
-    def __eq__(self, other: Union[str, Accept]):  # type: ignore
-        return self._compare(other, lambda s, o: s == o)
-
-    @parse_arg_as_accept
-    def __ge__(self, other: Union[str, Accept]):
-        return self._compare(other, lambda s, o: s >= o)
-
-    @parse_arg_as_accept
-    def __gt__(self, other: Union[str, Accept]):
-        return self._compare(other, lambda s, o: s > o)
-
-    @parse_arg_as_accept
-    def __ne__(self, other: Union[str, Accept]):  # type: ignore
-        return self._compare(other, lambda s, o: s != o)
-
-    @parse_arg_as_accept
-    def match(
-        self,
-        other,
-        *,
-        allow_type_wildcard: bool = True,
-        allow_subtype_wildcard: bool = True,
-    ) -> bool:
-        type_match = (
-            self.type_ == other.type_
-            if allow_type_wildcard
-            else (
-                self.type_.match(other.type_)
-                and not self.type_.is_wildcard
-                and not other.type_.is_wildcard
-            )
-        )
-        subtype_match = (
-            self.subtype == other.subtype
-            if allow_subtype_wildcard
-            else (
-                self.subtype.match(other.subtype)
-                and not self.subtype.is_wildcard
-                and not other.subtype.is_wildcard
-            )
-        )
-
-        return type_match and subtype_match
-
-    @classmethod
-    def parse(cls, raw: str) -> Accept:
-        invalid = False
-        mtype = raw.strip()
-
-        try:
-            media, *raw_params = mtype.split(";")
-            type_, subtype = media.split("/")
-        except ValueError:
-            invalid = True
-
-        if invalid or not type_ or not subtype:
-            raise InvalidHeader(f"Header contains invalid Accept value: {raw}")
-
-        params = dict(
-            [
-                (key.strip(), value.strip())
-                for key, value in (param.split("=", 1) for param in raw_params)
-            ]
-        )
-
-        return cls(mtype, MediaType(type_), MediaType(subtype), **params)
-
-
-class AcceptContainer(list):
-    def __contains__(self, o: object) -> bool:
-        return any(item.match(o) for item in self)
-
-    def match(
-        self,
-        o: object,
-        *,
-        allow_type_wildcard: bool = True,
-        allow_subtype_wildcard: bool = True,
-    ) -> bool:
-        return any(
-            item.match(
-                o,
-                allow_type_wildcard=allow_type_wildcard,
-                allow_subtype_wildcard=allow_subtype_wildcard,
-            )
-            for item in self
-        )
-
-
 def parse_content_header(value: str) -> Tuple[str, Options]:
     """Parse content-type and content-disposition header values.
 
@@ -274,7 +102,7 @@ def parse_xforwarded(headers, config) -> Optional[Options]:
     """Parse traditional proxy headers."""
     real_ip_header = config.REAL_IP_HEADER
     proxies_count = config.PROXIES_COUNT
-    addr = real_ip_header and headers.getone(real_ip_header, None)
+    addr = real_ip_header and headers.get(real_ip_header)
     if not addr and proxies_count:
         assert proxies_count > 0
         try:
@@ -303,7 +131,7 @@ def parse_xforwarded(headers, config) -> Optional[Options]:
             ("port", "x-forwarded-port"),
             ("path", "x-forwarded-path"),
         ):
-            yield key, headers.getone(header, None)
+            yield key, headers.get(header)
 
     return fwd_normalize(options())
 
@@ -366,45 +194,3 @@ def format_http1_response(status: int, headers: HeaderBytesIterable) -> bytes:
         ret += b"%b: %b\r\n" % h
     ret += b"\r\n"
     return ret
-
-
-def _sort_accept_value(accept: Accept):
-    return (
-        accept.qvalue,
-        len(accept.params),
-        accept.subtype != "*",
-        accept.type_ != "*",
-    )
-
-
-def parse_accept(accept: str) -> AcceptContainer:
-    """Parse an Accept header and order the acceptable media types in
-    accorsing to RFC 7231, s. 5.3.2
-    https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2
-    """
-    media_types = accept.split(",")
-    accept_list: List[Accept] = []
-
-    for mtype in media_types:
-        if not mtype:
-            continue
-
-        accept_list.append(Accept.parse(mtype))
-
-    return AcceptContainer(
-        sorted(accept_list, key=_sort_accept_value, reverse=True)
-    )
-
-
-def parse_credentials(
-    header: Optional[str],
-    prefixes: Union[List, Tuple, Set] = None,
-) -> Tuple[Optional[str], Optional[str]]:
-    """Parses any header with the aim to retrieve any credentials from it."""
-    if not prefixes or not isinstance(prefixes, (list, tuple, set)):
-        prefixes = ("Basic", "Bearer", "Token")
-    if header is not None:
-        for prefix in prefixes:
-            if prefix in header:
-                return prefix, header.partition(prefix)[-1].strip()
-    return None, header