Compare commits
10 Commits
smoother-p
...
monitor-re
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f83553be9e | ||
|
|
0c3527b8b2 | ||
|
|
232bbce1e0 | ||
|
|
f034a31d29 | ||
|
|
3536c0af27 | ||
|
|
0e7ee94574 | ||
|
|
4e4e2b036b | ||
|
|
7f682cea02 | ||
|
|
ae1669cd8f | ||
|
|
3c4c136090 |
@@ -9,7 +9,6 @@ omit =
|
|||||||
sanic/simple.py
|
sanic/simple.py
|
||||||
sanic/utils.py
|
sanic/utils.py
|
||||||
sanic/cli
|
sanic/cli
|
||||||
sanic/pages
|
|
||||||
|
|
||||||
[html]
|
[html]
|
||||||
directory = coverage
|
directory = coverage
|
||||||
|
|||||||
16
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
16
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
@@ -21,14 +21,7 @@ body:
|
|||||||
id: code
|
id: code
|
||||||
attributes:
|
attributes:
|
||||||
label: Code snippet
|
label: Code snippet
|
||||||
description: |
|
description: Relevant source code, make sure to remove what is not necessary.
|
||||||
Relevant source code, make sure to remove what is not necessary. Please try and format your code so that it is easier to read. For example:
|
|
||||||
|
|
||||||
```python
|
|
||||||
from sanic import Sanic
|
|
||||||
|
|
||||||
app = Sanic("Example")
|
|
||||||
```
|
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
- type: textarea
|
- type: textarea
|
||||||
@@ -49,16 +42,11 @@ body:
|
|||||||
- ASGI
|
- ASGI
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: dropdown
|
- type: input
|
||||||
id: os
|
id: os
|
||||||
attributes:
|
attributes:
|
||||||
label: Operating System
|
label: Operating System
|
||||||
description: What OS?
|
description: What OS?
|
||||||
options:
|
|
||||||
- Linux
|
|
||||||
- MacOS
|
|
||||||
- Windows
|
|
||||||
- Other (tell us in the description)
|
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
|
|||||||
33
.github/ISSUE_TEMPLATE/rfc.yml
vendored
33
.github/ISSUE_TEMPLATE/rfc.yml
vendored
@@ -1,33 +0,0 @@
|
|||||||
name: 💡 Request for Comments
|
|
||||||
description: Open an RFC for discussion
|
|
||||||
labels: ["RFC"]
|
|
||||||
body:
|
|
||||||
- type: input
|
|
||||||
id: compare
|
|
||||||
attributes:
|
|
||||||
label: Link to code
|
|
||||||
description: If available, share a [comparison](https://github.com/sanic-org/sanic/compare) from a POC branch to main
|
|
||||||
placeholder: https://github.com/sanic-org/sanic/compare/main...some-new-branch
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
id: proposal
|
|
||||||
attributes:
|
|
||||||
label: Proposal
|
|
||||||
description: A thorough discussion of the proposal discussing the problem it solves, potential code, use cases, and impacts
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
id: additional
|
|
||||||
attributes:
|
|
||||||
label: Additional context
|
|
||||||
description: Add any other context that is relevant
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: checkboxes
|
|
||||||
id: breaking
|
|
||||||
attributes:
|
|
||||||
label: Is this a breaking change?
|
|
||||||
options:
|
|
||||||
- label: "Yes"
|
|
||||||
required: false
|
|
||||||
2
.github/workflows/codeql-analysis.yml
vendored
2
.github/workflows/codeql-analysis.yml
vendored
@@ -4,12 +4,10 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
schedule:
|
schedule:
|
||||||
|
|||||||
2
.github/workflows/coverage.yml
vendored
2
.github/workflows/coverage.yml
vendored
@@ -3,14 +3,12 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
tags:
|
tags:
|
||||||
- "!*" # Do not execute on tags
|
- "!*" # Do not execute on tags
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
|
|||||||
3
.github/workflows/pr-bandit.yml
vendored
3
.github/workflows/pr-bandit.yml
vendored
@@ -3,7 +3,6 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
|
|
||||||
@@ -17,10 +16,10 @@ jobs:
|
|||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest]
|
os: [ubuntu-latest]
|
||||||
config:
|
config:
|
||||||
|
- { python-version: 3.7, tox-env: security}
|
||||||
- { python-version: 3.8, tox-env: security}
|
- { python-version: 3.8, tox-env: security}
|
||||||
- { python-version: 3.9, tox-env: security}
|
- { python-version: 3.9, tox-env: security}
|
||||||
- { python-version: "3.10", tox-env: security}
|
- { python-version: "3.10", tox-env: security}
|
||||||
- { python-version: "3.11", tox-env: security}
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout the repository
|
- name: Checkout the repository
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
|
|||||||
3
.github/workflows/pr-docs.yml
vendored
3
.github/workflows/pr-docs.yml
vendored
@@ -3,7 +3,6 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
|
|
||||||
@@ -15,7 +14,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
config:
|
config:
|
||||||
- {python-version: "3.10", tox-env: "docs"}
|
- {python-version: "3.8", tox-env: "docs"}
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
3
.github/workflows/pr-linter.yml
vendored
3
.github/workflows/pr-linter.yml
vendored
@@ -3,7 +3,6 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
|
|
||||||
@@ -17,7 +16,7 @@ jobs:
|
|||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest]
|
os: [ubuntu-latest]
|
||||||
config:
|
config:
|
||||||
- { python-version: "3.10", tox-env: lint}
|
- { python-version: 3.8, tox-env: lint}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout the repository
|
- name: Checkout the repository
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
|
|||||||
4
.github/workflows/pr-python-pypy.yml
vendored
4
.github/workflows/pr-python-pypy.yml
vendored
@@ -5,11 +5,11 @@ on:
|
|||||||
tox-env:
|
tox-env:
|
||||||
description: "Tox Env to run on the PyPy Infra"
|
description: "Tox Env to run on the PyPy Infra"
|
||||||
required: false
|
required: false
|
||||||
default: "pypy310"
|
default: "pypy37"
|
||||||
pypy-version:
|
pypy-version:
|
||||||
description: "Version of PyPy to use"
|
description: "Version of PyPy to use"
|
||||||
required: false
|
required: false
|
||||||
default: "pypy-3.10"
|
default: "pypy-3.7"
|
||||||
jobs:
|
jobs:
|
||||||
testPyPy:
|
testPyPy:
|
||||||
name: ut-${{ matrix.config.tox-env }}-${{ matrix.os }}
|
name: ut-${{ matrix.config.tox-env }}-${{ matrix.os }}
|
||||||
|
|||||||
1
.github/workflows/pr-python310.yml
vendored
1
.github/workflows/pr-python310.yml
vendored
@@ -3,7 +3,6 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
|
|
||||||
|
|||||||
@@ -1,35 +1,24 @@
|
|||||||
name: Python 3.11 Tests
|
name: Python 3.7 Tests
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
testPy311:
|
testPy37:
|
||||||
if: github.event.pull_request.draft == false
|
if: github.event.pull_request.draft == false
|
||||||
name: ut-${{ matrix.config.tox-env }}-${{ matrix.os }}
|
name: ut-${{ matrix.config.tox-env }}-${{ matrix.os }}
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: true
|
||||||
matrix:
|
matrix:
|
||||||
# os: [ubuntu-latest, macos-latest]
|
# os: [ubuntu-latest, macos-latest]
|
||||||
os: [ubuntu-latest]
|
os: [ubuntu-latest]
|
||||||
config:
|
config:
|
||||||
- {
|
- { python-version: 3.7, tox-env: py37 }
|
||||||
python-version: "3.11",
|
- { python-version: 3.7, tox-env: py37-no-ext }
|
||||||
tox-env: py311,
|
|
||||||
ignore-error-flake: "false",
|
|
||||||
command-timeout: "0",
|
|
||||||
}
|
|
||||||
- {
|
|
||||||
python-version: "3.11",
|
|
||||||
tox-env: py311-no-ext,
|
|
||||||
ignore-error-flake: "true",
|
|
||||||
command-timeout: "600000",
|
|
||||||
}
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout the Repository
|
- name: Checkout the Repository
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
@@ -42,7 +31,5 @@ jobs:
|
|||||||
test-infra-tool: tox
|
test-infra-tool: tox
|
||||||
test-infra-version: latest
|
test-infra-version: latest
|
||||||
action: tests
|
action: tests
|
||||||
test-additional-args: "-e=${{ matrix.config.tox-env }},-vv=''"
|
test-additional-args: "-e=${{ matrix.config.tox-env }}"
|
||||||
experimental-ignore-error: "${{ matrix.config.ignore-error-flake }}"
|
|
||||||
command-timeout: "${{ matrix.config.command-timeout }}"
|
|
||||||
test-failure-retry: "3"
|
test-failure-retry: "3"
|
||||||
1
.github/workflows/pr-python38.yml
vendored
1
.github/workflows/pr-python38.yml
vendored
@@ -3,7 +3,6 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
|
|
||||||
|
|||||||
1
.github/workflows/pr-python39.yml
vendored
1
.github/workflows/pr-python39.yml
vendored
@@ -3,7 +3,6 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
|
|
||||||
|
|||||||
3
.github/workflows/pr-type-check.yml
vendored
3
.github/workflows/pr-type-check.yml
vendored
@@ -3,7 +3,6 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
|
|
||||||
@@ -17,10 +16,10 @@ jobs:
|
|||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest]
|
os: [ubuntu-latest]
|
||||||
config:
|
config:
|
||||||
|
# - { python-version: 3.7, tox-env: type-checking}
|
||||||
- { python-version: 3.8, tox-env: type-checking}
|
- { python-version: 3.8, tox-env: type-checking}
|
||||||
- { python-version: 3.9, tox-env: type-checking}
|
- { python-version: 3.9, tox-env: type-checking}
|
||||||
- { python-version: "3.10", tox-env: type-checking}
|
- { python-version: "3.10", tox-env: type-checking}
|
||||||
- { python-version: "3.11", tox-env: type-checking}
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout the repository
|
- name: Checkout the repository
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
|
|||||||
4
.github/workflows/pr-windows.yml
vendored
4
.github/workflows/pr-windows.yml
vendored
@@ -3,7 +3,6 @@ on:
|
|||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- current-release
|
|
||||||
- "*LTS"
|
- "*LTS"
|
||||||
types: [opened, synchronize, reopened, ready_for_review]
|
types: [opened, synchronize, reopened, ready_for_review]
|
||||||
|
|
||||||
@@ -16,10 +15,11 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
config:
|
config:
|
||||||
|
- { python-version: 3.7, tox-env: py37-no-ext }
|
||||||
- { python-version: 3.8, tox-env: py38-no-ext }
|
- { python-version: 3.8, tox-env: py38-no-ext }
|
||||||
- { python-version: 3.9, tox-env: py39-no-ext }
|
- { python-version: 3.9, tox-env: py39-no-ext }
|
||||||
- { python-version: "3.10", tox-env: py310-no-ext }
|
- { python-version: "3.10", tox-env: py310-no-ext }
|
||||||
- { python-version: "3.11", tox-env: py310-no-ext }
|
- { python-version: pypy-3.7, tox-env: pypy37-no-ext }
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout Repository
|
- name: Checkout Repository
|
||||||
|
|||||||
2
.github/workflows/publish-images.yml
vendored
2
.github/workflows/publish-images.yml
vendored
@@ -14,7 +14,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: true
|
fail-fast: true
|
||||||
matrix:
|
matrix:
|
||||||
python-version: ["3.8", "3.9", "3.10", "3.11"]
|
python-version: ["3.7", "3.8", "3.9", "3.10"]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
|
|||||||
53
.github/workflows/publish-package.yml
vendored
53
.github/workflows/publish-package.yml
vendored
@@ -1,39 +1,28 @@
|
|||||||
name: Upload Python Package
|
name: Publish Artifacts
|
||||||
|
|
||||||
on:
|
on:
|
||||||
release:
|
release:
|
||||||
types: [created]
|
types: [created]
|
||||||
workflow_dispatch:
|
|
||||||
jobs:
|
jobs:
|
||||||
build-n-publish:
|
publishPythonPackage:
|
||||||
name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
|
name: Publishing Sanic Release Artifacts
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
fail-fast: true
|
||||||
|
matrix:
|
||||||
|
python-version: ["3.8"]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v3
|
- name: Checkout Repository
|
||||||
- name: Set up Python
|
uses: actions/checkout@v2
|
||||||
uses: actions/setup-python@v4
|
|
||||||
|
- name: Publish Python Package
|
||||||
|
uses: harshanarayana/custom-actions@main
|
||||||
with:
|
with:
|
||||||
python-version: "3.x"
|
python-version: ${{ matrix.python-version }}
|
||||||
- name: Install pypa/build
|
package-infra-name: "twine"
|
||||||
run: >-
|
pypi-user: __token__
|
||||||
python3 -m
|
pypi-access-token: ${{ secrets.PYPI_ACCESS_TOKEN }}
|
||||||
pip install
|
action: "package-publish"
|
||||||
build
|
pypi-verify-metadata: "true"
|
||||||
--user
|
|
||||||
- name: Build a binary wheel and a source tarball
|
|
||||||
run: >-
|
|
||||||
python3 -m
|
|
||||||
build
|
|
||||||
--sdist
|
|
||||||
--wheel
|
|
||||||
--outdir dist/
|
|
||||||
.
|
|
||||||
# - name: Publish distribution 📦 to Test PyPI
|
|
||||||
# uses: pypa/gh-action-pypi-publish@release/v1
|
|
||||||
# with:
|
|
||||||
# password: ${{ secrets.SANIC_TEST_PYPI_API_TOKEN }}
|
|
||||||
# repository-url: https://test.pypi.org/legacy/
|
|
||||||
- name: Publish distribution 📦 to PyPI
|
|
||||||
uses: pypa/gh-action-pypi-publish@release/v1
|
|
||||||
with:
|
|
||||||
password: ${{ secrets.SANIC_PYPI_API_TOKEN }}
|
|
||||||
|
|||||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -21,5 +21,4 @@ dist/*
|
|||||||
pip-wheel-metadata/
|
pip-wheel-metadata/
|
||||||
.pytest_cache/*
|
.pytest_cache/*
|
||||||
.venv/*
|
.venv/*
|
||||||
venv/*
|
|
||||||
.vscode/*
|
.vscode/*
|
||||||
|
|||||||
@@ -313,8 +313,10 @@ Version 21.3.0
|
|||||||
`#2074 <https://github.com/sanic-org/sanic/pull/2074>`_
|
`#2074 <https://github.com/sanic-org/sanic/pull/2074>`_
|
||||||
Performance adjustments in ``handle_request_``
|
Performance adjustments in ``handle_request_``
|
||||||
|
|
||||||
Version 20.12.3
|
Version 20.12.3 🔷
|
||||||
---------------
|
------------------
|
||||||
|
|
||||||
|
`Current LTS version`
|
||||||
|
|
||||||
**Bugfixes**
|
**Bugfixes**
|
||||||
|
|
||||||
@@ -348,8 +350,8 @@ Version 19.12.5
|
|||||||
`#2027 <https://github.com/sanic-org/sanic/pull/2027>`_
|
`#2027 <https://github.com/sanic-org/sanic/pull/2027>`_
|
||||||
Remove old chardet requirement, add in hard multidict requirement
|
Remove old chardet requirement, add in hard multidict requirement
|
||||||
|
|
||||||
Version 20.12.0
|
Version 20.12.0 🔹
|
||||||
---------------
|
-----------------
|
||||||
|
|
||||||
**Features**
|
**Features**
|
||||||
|
|
||||||
|
|||||||
27
README.rst
27
README.rst
@@ -11,7 +11,7 @@ Sanic | Build fast. Run fast.
|
|||||||
:stub-columns: 1
|
:stub-columns: 1
|
||||||
|
|
||||||
* - Build
|
* - Build
|
||||||
- | |Py310Test| |Py39Test| |Py38Test|
|
- | |Py310Test| |Py39Test| |Py38Test| |Py37Test|
|
||||||
* - Docs
|
* - Docs
|
||||||
- | |UserGuide| |Documentation|
|
- | |UserGuide| |Documentation|
|
||||||
* - Package
|
* - Package
|
||||||
@@ -19,7 +19,7 @@ Sanic | Build fast. Run fast.
|
|||||||
* - Support
|
* - Support
|
||||||
- | |Forums| |Discord| |Awesome|
|
- | |Forums| |Discord| |Awesome|
|
||||||
* - Stats
|
* - Stats
|
||||||
- | |Monthly Downloads| |Weekly Downloads| |Conda downloads|
|
- | |Downloads| |WkDownloads| |Conda downloads|
|
||||||
|
|
||||||
.. |UserGuide| image:: https://img.shields.io/badge/user%20guide-sanic-ff0068
|
.. |UserGuide| image:: https://img.shields.io/badge/user%20guide-sanic-ff0068
|
||||||
:target: https://sanicframework.org/
|
:target: https://sanicframework.org/
|
||||||
@@ -33,6 +33,8 @@ Sanic | Build fast. Run fast.
|
|||||||
:target: https://github.com/sanic-org/sanic/actions/workflows/pr-python39.yml
|
:target: https://github.com/sanic-org/sanic/actions/workflows/pr-python39.yml
|
||||||
.. |Py38Test| image:: https://github.com/sanic-org/sanic/actions/workflows/pr-python38.yml/badge.svg?branch=main
|
.. |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
|
:target: https://github.com/sanic-org/sanic/actions/workflows/pr-python38.yml
|
||||||
|
.. |Py37Test| image:: https://github.com/sanic-org/sanic/actions/workflows/pr-python37.yml/badge.svg?branch=main
|
||||||
|
:target: https://github.com/sanic-org/sanic/actions/workflows/pr-python37.yml
|
||||||
.. |Documentation| image:: https://readthedocs.org/projects/sanic/badge/?version=latest
|
.. |Documentation| image:: https://readthedocs.org/projects/sanic/badge/?version=latest
|
||||||
:target: http://sanic.readthedocs.io/en/latest/?badge=latest
|
:target: http://sanic.readthedocs.io/en/latest/?badge=latest
|
||||||
.. |PyPI| image:: https://img.shields.io/pypi/v/sanic.svg
|
.. |PyPI| image:: https://img.shields.io/pypi/v/sanic.svg
|
||||||
@@ -50,23 +52,19 @@ Sanic | Build fast. Run fast.
|
|||||||
.. |Awesome| image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg
|
.. |Awesome| image:: https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg
|
||||||
:alt: Awesome Sanic List
|
:alt: Awesome Sanic List
|
||||||
:target: https://github.com/mekicha/awesome-sanic
|
:target: https://github.com/mekicha/awesome-sanic
|
||||||
.. |Monthly Downloads| image:: https://img.shields.io/pypi/dm/sanic.svg
|
.. |Downloads| image:: https://pepy.tech/badge/sanic/month
|
||||||
:alt: Downloads
|
:alt: Downloads
|
||||||
:target: https://pepy.tech/project/sanic
|
:target: https://pepy.tech/project/sanic
|
||||||
.. |Weekly Downloads| image:: https://img.shields.io/pypi/dw/sanic.svg
|
.. |WkDownloads| image:: https://pepy.tech/badge/sanic/week
|
||||||
:alt: Downloads
|
:alt: Downloads
|
||||||
:target: https://pepy.tech/project/sanic
|
:target: https://pepy.tech/project/sanic
|
||||||
.. |Conda downloads| image:: https://img.shields.io/conda/dn/conda-forge/sanic.svg
|
.. |Conda downloads| image:: https://img.shields.io/conda/dn/conda-forge/sanic.svg
|
||||||
:alt: Downloads
|
:alt: Downloads
|
||||||
:target: https://anaconda.org/conda-forge/sanic
|
:target: https://anaconda.org/conda-forge/sanic
|
||||||
.. |Linode| image:: https://www.linode.com/wp-content/uploads/2021/01/Linode-Logo-Black.svg
|
|
||||||
:alt: Linode
|
|
||||||
:target: https://www.linode.com
|
|
||||||
:width: 200px
|
|
||||||
|
|
||||||
.. end-badges
|
.. end-badges
|
||||||
|
|
||||||
Sanic is a **Python 3.8+** web server and web framework that's written to go fast. It allows the usage of the ``async/await`` syntax added in Python 3.5, which makes your code non-blocking and speedy.
|
Sanic is a **Python 3.7+** web server and web framework that's written to go fast. It allows the usage of the ``async/await`` syntax added in Python 3.5, which makes your code non-blocking and speedy.
|
||||||
|
|
||||||
Sanic is also ASGI compliant, so you can deploy it with an `alternative ASGI webserver <https://sanicframework.org/en/guide/deployment/running.html#asgi>`_.
|
Sanic is also ASGI compliant, so you can deploy it with an `alternative ASGI webserver <https://sanicframework.org/en/guide/deployment/running.html#asgi>`_.
|
||||||
|
|
||||||
@@ -143,17 +141,17 @@ And, we can verify it is working: ``curl localhost:8000 -i``
|
|||||||
|
|
||||||
**Now, let's go build something fast!**
|
**Now, let's go build something fast!**
|
||||||
|
|
||||||
Minimum Python version is 3.8. If you need Python 3.7 support, please use v22.12LTS.
|
Minimum Python version is 3.7. If you need Python 3.6 support, please use v20.12LTS.
|
||||||
|
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
`User Guide <https://sanic.dev>`__ and `API Documentation <http://sanic.readthedocs.io/>`__.
|
`User Guide <https://sanicframework.org>`__ and `API Documentation <http://sanic.readthedocs.io/>`__.
|
||||||
|
|
||||||
Changelog
|
Changelog
|
||||||
---------
|
---------
|
||||||
|
|
||||||
`Release Changelogs <https://sanic.readthedocs.io/en/stable/sanic/changelog.html>`__.
|
`Release Changelogs <https://github.com/sanic-org/sanic/blob/master/CHANGELOG.rst>`__.
|
||||||
|
|
||||||
|
|
||||||
Questions and Discussion
|
Questions and Discussion
|
||||||
@@ -165,3 +163,8 @@ Contribution
|
|||||||
------------
|
------------
|
||||||
|
|
||||||
We are always happy to have new contributions. We have `marked issues good for anyone looking to get started <https://github.com/sanic-org/sanic/issues?q=is%3Aopen+is%3Aissue+label%3Abeginner>`_, and welcome `questions on the forums <https://community.sanicframework.org/>`_. Please take a look at our `Contribution guidelines <https://github.com/sanic-org/sanic/blob/master/CONTRIBUTING.rst>`_.
|
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
|
||||||
|
|||||||
@@ -7,15 +7,14 @@ Sanic releases long term support release once a year in December. LTS releases r
|
|||||||
|
|
||||||
| Version | LTS | Supported |
|
| Version | LTS | Supported |
|
||||||
| ------- | ------------- | ----------------------- |
|
| ------- | ------------- | ----------------------- |
|
||||||
| 22.12 | until 2024-12 | :white_check_mark: |
|
| 22.9 | | :white_check_mark: |
|
||||||
| 22.9 | | :x: |
|
|
||||||
| 22.6 | | :x: |
|
| 22.6 | | :x: |
|
||||||
| 22.3 | | :x: |
|
| 22.3 | | :x: |
|
||||||
| 21.12 | until 2023-12 | :ballot_box_with_check: |
|
| 21.12 | until 2023-12 | :white_check_mark: |
|
||||||
| 21.9 | | :x: |
|
| 21.9 | | :x: |
|
||||||
| 21.6 | | :x: |
|
| 21.6 | | :x: |
|
||||||
| 21.3 | | :x: |
|
| 21.3 | | :x: |
|
||||||
| 20.12 | | :x: |
|
| 20.12 | until 2022-12 | :ballot_box_with_check: |
|
||||||
| 20.9 | | :x: |
|
| 20.9 | | :x: |
|
||||||
| 20.6 | | :x: |
|
| 20.6 | | :x: |
|
||||||
| 20.3 | | :x: |
|
| 20.3 | | :x: |
|
||||||
|
|||||||
@@ -17,8 +17,7 @@ ignore:
|
|||||||
- "sanic/compat.py"
|
- "sanic/compat.py"
|
||||||
- "sanic/simple.py"
|
- "sanic/simple.py"
|
||||||
- "sanic/utils.py"
|
- "sanic/utils.py"
|
||||||
- "sanic/cli/"
|
- "sanic/cli"
|
||||||
- "sanic/pages/"
|
|
||||||
- ".github/"
|
- ".github/"
|
||||||
- "changelogs/"
|
- "changelogs/"
|
||||||
- "docker/"
|
- "docker/"
|
||||||
|
|||||||
@@ -1,13 +1,6 @@
|
|||||||
📜 Changelog
|
📜 Changelog
|
||||||
============
|
============
|
||||||
|
|
||||||
| 🔶 Current release
|
|
||||||
| 🔷 In support release
|
|
||||||
|
|
|
||||||
|
|
||||||
.. mdinclude:: ./releases/23/23.6.md
|
|
||||||
.. mdinclude:: ./releases/23/23.3.md
|
|
||||||
.. mdinclude:: ./releases/22/22.12.md
|
|
||||||
.. mdinclude:: ./releases/22/22.9.md
|
.. mdinclude:: ./releases/22/22.9.md
|
||||||
.. mdinclude:: ./releases/22/22.6.md
|
.. mdinclude:: ./releases/22/22.6.md
|
||||||
.. mdinclude:: ./releases/22/22.3.md
|
.. mdinclude:: ./releases/22/22.3.md
|
||||||
|
|||||||
@@ -1,55 +0,0 @@
|
|||||||
## Version 22.12.0 🔷
|
|
||||||
|
|
||||||
_Current version_
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
- [#2569](https://github.com/sanic-org/sanic/pull/2569) Add `JSONResponse` class with some convenient methods when updating a response object
|
|
||||||
- [#2598](https://github.com/sanic-org/sanic/pull/2598) Change `uvloop` requirement to `>=0.15.0`
|
|
||||||
- [#2609](https://github.com/sanic-org/sanic/pull/2609) Add compatibility with `websockets` v11.0
|
|
||||||
- [#2610](https://github.com/sanic-org/sanic/pull/2610) Kill server early on worker error
|
|
||||||
- Raise deadlock timeout to 30s
|
|
||||||
- [#2617](https://github.com/sanic-org/sanic/pull/2617) Scale number of running server workers
|
|
||||||
- [#2621](https://github.com/sanic-org/sanic/pull/2621) [#2634](https://github.com/sanic-org/sanic/pull/2634) Send `SIGKILL` on subsequent `ctrl+c` to force worker exit
|
|
||||||
- [#2622](https://github.com/sanic-org/sanic/pull/2622) Add API to restart all workers from the multiplexer
|
|
||||||
- [#2624](https://github.com/sanic-org/sanic/pull/2624) Default to `spawn` for all subprocesses unless specifically set:
|
|
||||||
```python
|
|
||||||
from sanic import Sanic
|
|
||||||
|
|
||||||
Sanic.start_method = "fork"
|
|
||||||
```
|
|
||||||
- [#2625](https://github.com/sanic-org/sanic/pull/2625) Filename normalisation of form-data/multipart file uploads
|
|
||||||
- [#2626](https://github.com/sanic-org/sanic/pull/2626) Move to HTTP Inspector:
|
|
||||||
- Remote access to inspect running Sanic instances
|
|
||||||
- TLS support for encrypted calls to Inspector
|
|
||||||
- Authentication to Inspector with API key
|
|
||||||
- Ability to extend Inspector with custom commands
|
|
||||||
- [#2632](https://github.com/sanic-org/sanic/pull/2632) Control order of restart operations
|
|
||||||
- [#2633](https://github.com/sanic-org/sanic/pull/2633) Move reload interval to class variable
|
|
||||||
- [#2636](https://github.com/sanic-org/sanic/pull/2636) Add `priority` to `register_middleware` method
|
|
||||||
- [#2639](https://github.com/sanic-org/sanic/pull/2639) Add `unquote` to `add_route` method
|
|
||||||
- [#2640](https://github.com/sanic-org/sanic/pull/2640) ASGI websockets to receive `text` or `bytes`
|
|
||||||
|
|
||||||
|
|
||||||
### Bugfixes
|
|
||||||
|
|
||||||
- [#2607](https://github.com/sanic-org/sanic/pull/2607) Force socket shutdown before close to allow rebinding
|
|
||||||
- [#2590](https://github.com/sanic-org/sanic/pull/2590) Use actual `StrEnum` in Python 3.11+
|
|
||||||
- [#2615](https://github.com/sanic-org/sanic/pull/2615) Ensure middleware executes only once per request timeout
|
|
||||||
- [#2627](https://github.com/sanic-org/sanic/pull/2627) Crash ASGI application on lifespan failure
|
|
||||||
- [#2635](https://github.com/sanic-org/sanic/pull/2635) Resolve error with low-level server creation on Windows
|
|
||||||
|
|
||||||
|
|
||||||
### Deprecations and Removals
|
|
||||||
|
|
||||||
- [#2608](https://github.com/sanic-org/sanic/pull/2608) [#2630](https://github.com/sanic-org/sanic/pull/2630) Signal conditions and triggers saved on `signal.extra`
|
|
||||||
- [#2626](https://github.com/sanic-org/sanic/pull/2626) Move to HTTP Inspector
|
|
||||||
- 🚨 *BREAKING CHANGE*: Moves the Inspector to a Sanic app from a simple TCP socket with a custom protocol
|
|
||||||
- *DEPRECATE*: The `--inspect*` commands have been deprecated in favor of `inspect ...` commands
|
|
||||||
- [#2628](https://github.com/sanic-org/sanic/pull/2628) Replace deprecated `distutils.strtobool`
|
|
||||||
|
|
||||||
|
|
||||||
### Developer infrastructure
|
|
||||||
|
|
||||||
- [#2612](https://github.com/sanic-org/sanic/pull/2612) Add CI testing for Python 3.11
|
|
||||||
|
|
||||||
@@ -1,33 +1,6 @@
|
|||||||
## Version 22.9.1
|
## Version 22.9.0 🔶
|
||||||
|
|
||||||
### Features
|
_Current version_
|
||||||
|
|
||||||
- [#2585](https://github.com/sanic-org/sanic/pull/2585) Improved error message when no applications have been registered
|
|
||||||
|
|
||||||
|
|
||||||
### Bugfixes
|
|
||||||
|
|
||||||
- [#2578](https://github.com/sanic-org/sanic/pull/2578) Add certificate loader for in process certificate creation
|
|
||||||
- [#2591](https://github.com/sanic-org/sanic/pull/2591) Do not use sentinel identity for `spawn` compatibility
|
|
||||||
- [#2592](https://github.com/sanic-org/sanic/pull/2592) Fix properties in nested blueprint groups
|
|
||||||
- [#2595](https://github.com/sanic-org/sanic/pull/2595) Introduce sleep interval on new worker reloader
|
|
||||||
|
|
||||||
|
|
||||||
### Deprecations and Removals
|
|
||||||
|
|
||||||
|
|
||||||
### Developer infrastructure
|
|
||||||
|
|
||||||
- [#2588](https://github.com/sanic-org/sanic/pull/2588) Markdown templates on issue forms
|
|
||||||
|
|
||||||
|
|
||||||
### Improved Documentation
|
|
||||||
|
|
||||||
- [#2556](https://github.com/sanic-org/sanic/pull/2556) v22.9 documentation
|
|
||||||
- [#2582](https://github.com/sanic-org/sanic/pull/2582) Cleanup documentation on Windows support
|
|
||||||
|
|
||||||
|
|
||||||
## Version 22.9.0
|
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
|
|||||||
@@ -1,53 +0,0 @@
|
|||||||
## Version 23.3.0
|
|
||||||
|
|
||||||
### Features
|
|
||||||
- [#2545](https://github.com/sanic-org/sanic/pull/2545) Standardize init of exceptions for more consistent control of HTTP responses using exceptions
|
|
||||||
- [#2606](https://github.com/sanic-org/sanic/pull/2606) Decode headers as UTF-8 also in ASGI
|
|
||||||
- [#2646](https://github.com/sanic-org/sanic/pull/2646) Separate ASGI request and lifespan callables
|
|
||||||
- [#2659](https://github.com/sanic-org/sanic/pull/2659) Use ``FALLBACK_ERROR_FORMAT`` for handlers that return ``empty()``
|
|
||||||
- [#2662](https://github.com/sanic-org/sanic/pull/2662) Add basic file browser (HTML page) and auto-index serving
|
|
||||||
- [#2667](https://github.com/sanic-org/sanic/pull/2667) Nicer traceback formatting (HTML page)
|
|
||||||
- [#2668](https://github.com/sanic-org/sanic/pull/2668) Smarter error page rendering format selection; more reliant upon header and "common sense" defaults
|
|
||||||
- [#2680](https://github.com/sanic-org/sanic/pull/2680) Check the status of socket before shutting down with ``SHUT_RDWR``
|
|
||||||
- [#2687](https://github.com/sanic-org/sanic/pull/2687) Refresh ``Request.accept`` functionality to be more performant and spec-compliant
|
|
||||||
- [#2696](https://github.com/sanic-org/sanic/pull/2696) Add header accessors as properties
|
|
||||||
```
|
|
||||||
Example-Field: Foo, Bar
|
|
||||||
Example-Field: Baz
|
|
||||||
```
|
|
||||||
```python
|
|
||||||
request.headers.example_field == "Foo, Bar,Baz"
|
|
||||||
```
|
|
||||||
- [#2700](https://github.com/sanic-org/sanic/pull/2700) Simpler CLI targets
|
|
||||||
|
|
||||||
```sh
|
|
||||||
$ sanic path.to.module:app # global app instance
|
|
||||||
$ sanic path.to.module:create_app # factory pattern
|
|
||||||
$ sanic ./path/to/directory/ # simple serve
|
|
||||||
```
|
|
||||||
- [#2701](https://github.com/sanic-org/sanic/pull/2701) API to define a number of workers in managed processes
|
|
||||||
- [#2704](https://github.com/sanic-org/sanic/pull/2704) Add convenience for dynamic changes to routing
|
|
||||||
- [#2706](https://github.com/sanic-org/sanic/pull/2706) Add convenience methods for cookie creation and deletion
|
|
||||||
|
|
||||||
```python
|
|
||||||
response = text("...")
|
|
||||||
response.add_cookie("test", "It worked!", domain=".yummy-yummy-cookie.com")
|
|
||||||
```
|
|
||||||
- [#2707](https://github.com/sanic-org/sanic/pull/2707) Simplified ``parse_content_header`` escaping to be RFC-compliant and remove outdated FF hack
|
|
||||||
- [#2710](https://github.com/sanic-org/sanic/pull/2710) Stricter charset handling and escaping of request URLs
|
|
||||||
- [#2711](https://github.com/sanic-org/sanic/pull/2711) Consume body on ``DELETE`` by default
|
|
||||||
- [#2719](https://github.com/sanic-org/sanic/pull/2719) Allow ``password`` to be passed to TLS context
|
|
||||||
- [#2720](https://github.com/sanic-org/sanic/pull/2720) Skip middleware on ``RequestCancelled``
|
|
||||||
- [#2721](https://github.com/sanic-org/sanic/pull/2721) Change access logging format to ``%s``
|
|
||||||
- [#2722](https://github.com/sanic-org/sanic/pull/2722) Add ``CertLoader`` as application option for directly controlling ``SSLContext`` objects
|
|
||||||
- [#2725](https://github.com/sanic-org/sanic/pull/2725) Worker sync state tolerance on race condition
|
|
||||||
|
|
||||||
### Bugfixes
|
|
||||||
- [#2651](https://github.com/sanic-org/sanic/pull/2651) ASGI websocket to pass thru bytes as is
|
|
||||||
- [#2697](https://github.com/sanic-org/sanic/pull/2697) Fix comparison between datetime aware and naive in ``file`` when using ``If-Modified-Since``
|
|
||||||
|
|
||||||
### Deprecations and Removals
|
|
||||||
- [#2666](https://github.com/sanic-org/sanic/pull/2666) Remove deprecated ``__blueprintname__`` property
|
|
||||||
|
|
||||||
### Improved Documentation
|
|
||||||
- [#2712](https://github.com/sanic-org/sanic/pull/2712) Improved example using ``'https'`` to create the redirect
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
## Version 23.6.0 🔶
|
|
||||||
|
|
||||||
### Features
|
|
||||||
- [#2670](https://github.com/sanic-org/sanic/pull/2670) Increase `KEEP_ALIVE_TIMEOUT` default to 120 seconds
|
|
||||||
- [#2716](https://github.com/sanic-org/sanic/pull/2716) Adding allow route overwrite option in blueprint
|
|
||||||
- [#2724](https://github.com/sanic-org/sanic/pull/2724) and [#2792](https://github.com/sanic-org/sanic/pull/2792) Add a new exception signal for ALL exceptions raised anywhere in application
|
|
||||||
- [#2727](https://github.com/sanic-org/sanic/pull/2727) Add name prefixing to BP groups
|
|
||||||
- [#2754](https://github.com/sanic-org/sanic/pull/2754) Update request type on middleware types
|
|
||||||
- [#2770](https://github.com/sanic-org/sanic/pull/2770) Better exception message on startup time application induced import error
|
|
||||||
- [#2776](https://github.com/sanic-org/sanic/pull/2776) Set multiprocessing start method early
|
|
||||||
- [#2785](https://github.com/sanic-org/sanic/pull/2785) Add custom typing to config and ctx objects
|
|
||||||
- [#2790](https://github.com/sanic-org/sanic/pull/2790) Add `request.client_ip`
|
|
||||||
|
|
||||||
### Bugfixes
|
|
||||||
- [#2728](https://github.com/sanic-org/sanic/pull/2728) Fix traversals for intended results
|
|
||||||
- [#2729](https://github.com/sanic-org/sanic/pull/2729) Handle case when headers argument of ResponseStream constructor is None
|
|
||||||
- [#2737](https://github.com/sanic-org/sanic/pull/2737) Fix type annotation for `JSONREsponse` default content type
|
|
||||||
- [#2740](https://github.com/sanic-org/sanic/pull/2740) Use Sanic's serializer for JSON responses in the Inspector
|
|
||||||
- [#2760](https://github.com/sanic-org/sanic/pull/2760) Support for `Request.get_current` in ASGI mode
|
|
||||||
- [#2773](https://github.com/sanic-org/sanic/pull/2773) Alow Blueprint routes to explicitly define error_format
|
|
||||||
- [#2774](https://github.com/sanic-org/sanic/pull/2774) Resolve headers on different renderers
|
|
||||||
- [#2782](https://github.com/sanic-org/sanic/pull/2782) Resolve pypy compatibility issues
|
|
||||||
|
|
||||||
### Deprecations and Removals
|
|
||||||
- [#2777](https://github.com/sanic-org/sanic/pull/2777) Remove Python 3.7 support
|
|
||||||
|
|
||||||
### Developer infrastructure
|
|
||||||
- [#2766](https://github.com/sanic-org/sanic/pull/2766) Unpin setuptools version
|
|
||||||
- [#2779](https://github.com/sanic-org/sanic/pull/2779) Run keep alive tests in loop to get available port
|
|
||||||
|
|
||||||
### Improved Documentation
|
|
||||||
- [#2741](https://github.com/sanic-org/sanic/pull/2741) Better documentation examples about running Sanic
|
|
||||||
From that list, the items to highlight in the release notes:
|
|
||||||
@@ -25,5 +25,5 @@ def key_exist_handler(request):
|
|||||||
|
|
||||||
return text("num does not exist in request")
|
return text("num does not exist in request")
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
app.run(host="0.0.0.0", port=8000, debug=True)
|
app.run(host="0.0.0.0", port=8000, debug=True)
|
||||||
|
|||||||
@@ -50,5 +50,4 @@ def pop_handler(request):
|
|||||||
|
|
||||||
app.blueprint(bp, url_prefix="/bp")
|
app.blueprint(bp, url_prefix="/bp")
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
app.run(host="0.0.0.0", port=8000, debug=True, auto_reload=False)
|
app.run(host="0.0.0.0", port=8000, debug=True, auto_reload=False)
|
||||||
|
|||||||
@@ -37,5 +37,4 @@ app.blueprint(blueprint)
|
|||||||
app.blueprint(blueprint2)
|
app.blueprint(blueprint2)
|
||||||
app.blueprint(blueprint3)
|
app.blueprint(blueprint3)
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
app.run(host="0.0.0.0", port=9999, debug=True)
|
app.run(host="0.0.0.0", port=9999, debug=True)
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ def proxy(request, path):
|
|||||||
path=path,
|
path=path,
|
||||||
_server=https.config.SERVER_NAME,
|
_server=https.config.SERVER_NAME,
|
||||||
_external=True,
|
_external=True,
|
||||||
_scheme="https",
|
_scheme="http",
|
||||||
)
|
)
|
||||||
return response.redirect(url)
|
return response.redirect(url)
|
||||||
|
|
||||||
@@ -69,5 +69,5 @@ async def runner(app: Sanic, app_server: AsyncioServer):
|
|||||||
app.is_running = False
|
app.is_running = False
|
||||||
app.is_stopping = True
|
app.is_stopping = True
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
https.run(port=HTTPS_PORT, debug=True)
|
https.run(port=HTTPS_PORT, debug=True)
|
||||||
|
|||||||
@@ -39,5 +39,4 @@ async def test(request):
|
|||||||
return json(response)
|
return json(response)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
app.run(host="0.0.0.0", port=8000, workers=2)
|
app.run(host="0.0.0.0", port=8000, workers=2)
|
||||||
|
|||||||
@@ -20,5 +20,4 @@ def test(request):
|
|||||||
return text("hey")
|
return text("hey")
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
app.run(host="0.0.0.0", port=8000)
|
app.run(host="0.0.0.0", port=8000)
|
||||||
|
|||||||
@@ -6,5 +6,5 @@ data = ""
|
|||||||
for i in range(1, 250000):
|
for i in range(1, 250000):
|
||||||
data += str(i)
|
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)
|
print(r.text)
|
||||||
|
|||||||
@@ -20,5 +20,4 @@ def timeout(request, exception):
|
|||||||
return response.text("RequestTimeout from error_handler.", 408)
|
return response.text("RequestTimeout from error_handler.", 408)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
app.run(host="0.0.0.0", port=8000)
|
app.run(host="0.0.0.0", port=8000)
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ async def after_server_stop(app, loop):
|
|||||||
async def test(request):
|
async def test(request):
|
||||||
return response.json({"answer": "42"})
|
return response.json({"answer": "42"})
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
asyncio.set_event_loop(uvloop.new_event_loop())
|
asyncio.set_event_loop(uvloop.new_event_loop())
|
||||||
serv_coro = app.create_server(
|
serv_coro = app.create_server(
|
||||||
host="0.0.0.0", port=8000, return_asyncio_server=True
|
host="0.0.0.0", port=8000, return_asyncio_server=True
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
[build-system]
|
[build-system]
|
||||||
requires = ["setuptools", "wheel"]
|
requires = ["setuptools<60.0", "wheel"]
|
||||||
build-backend = "setuptools.build_meta"
|
build-backend = "setuptools.build_meta"
|
||||||
|
|
||||||
[tool.black]
|
[tool.black]
|
||||||
@@ -22,8 +22,5 @@ module = [
|
|||||||
"httptools.*",
|
"httptools.*",
|
||||||
"trustme.*",
|
"trustme.*",
|
||||||
"sanic_routing.*",
|
"sanic_routing.*",
|
||||||
"aioquic.*",
|
|
||||||
"html5tagger.*",
|
|
||||||
"tracerite.*",
|
|
||||||
]
|
]
|
||||||
ignore_missing_imports = true
|
ignore_missing_imports = true
|
||||||
|
|||||||
@@ -1,28 +1,7 @@
|
|||||||
from types import SimpleNamespace
|
|
||||||
|
|
||||||
from typing_extensions import TypeAlias
|
|
||||||
|
|
||||||
from sanic.__version__ import __version__
|
from sanic.__version__ import __version__
|
||||||
from sanic.app import Sanic
|
from sanic.app import Sanic
|
||||||
from sanic.blueprints import Blueprint
|
from sanic.blueprints import Blueprint
|
||||||
from sanic.config import Config
|
|
||||||
from sanic.constants import HTTPMethod
|
from sanic.constants import HTTPMethod
|
||||||
from sanic.exceptions import (
|
|
||||||
BadRequest,
|
|
||||||
ExpectationFailed,
|
|
||||||
FileNotFound,
|
|
||||||
Forbidden,
|
|
||||||
HeaderNotFound,
|
|
||||||
InternalServerError,
|
|
||||||
InvalidHeader,
|
|
||||||
MethodNotAllowed,
|
|
||||||
NotFound,
|
|
||||||
RangeNotSatisfiable,
|
|
||||||
SanicException,
|
|
||||||
ServerError,
|
|
||||||
ServiceUnavailable,
|
|
||||||
Unauthorized,
|
|
||||||
)
|
|
||||||
from sanic.request import Request
|
from sanic.request import Request
|
||||||
from sanic.response import (
|
from sanic.response import (
|
||||||
HTTPResponse,
|
HTTPResponse,
|
||||||
@@ -30,57 +9,24 @@ from sanic.response import (
|
|||||||
file,
|
file,
|
||||||
html,
|
html,
|
||||||
json,
|
json,
|
||||||
raw,
|
|
||||||
redirect,
|
redirect,
|
||||||
text,
|
text,
|
||||||
)
|
)
|
||||||
from sanic.server.websockets.impl import WebsocketImplProtocol as Websocket
|
from sanic.server.websockets.impl import WebsocketImplProtocol as Websocket
|
||||||
|
|
||||||
|
|
||||||
DefaultSanic: TypeAlias = "Sanic[Config, SimpleNamespace]"
|
|
||||||
"""
|
|
||||||
A type alias for a Sanic app with a default config and namespace.
|
|
||||||
"""
|
|
||||||
|
|
||||||
DefaultRequest: TypeAlias = Request[DefaultSanic, SimpleNamespace]
|
|
||||||
"""
|
|
||||||
A type alias for a request with a default Sanic app and namespace.
|
|
||||||
"""
|
|
||||||
|
|
||||||
__all__ = (
|
__all__ = (
|
||||||
"__version__",
|
"__version__",
|
||||||
# Common objects
|
|
||||||
"Sanic",
|
"Sanic",
|
||||||
"Config",
|
|
||||||
"Blueprint",
|
"Blueprint",
|
||||||
"HTTPMethod",
|
"HTTPMethod",
|
||||||
"HTTPResponse",
|
"HTTPResponse",
|
||||||
"Request",
|
"Request",
|
||||||
"Websocket",
|
"Websocket",
|
||||||
# Common types
|
|
||||||
"DefaultSanic",
|
|
||||||
"DefaultRequest",
|
|
||||||
# Common exceptions
|
|
||||||
"BadRequest",
|
|
||||||
"ExpectationFailed",
|
|
||||||
"FileNotFound",
|
|
||||||
"Forbidden",
|
|
||||||
"HeaderNotFound",
|
|
||||||
"InternalServerError",
|
|
||||||
"InvalidHeader",
|
|
||||||
"MethodNotAllowed",
|
|
||||||
"NotFound",
|
|
||||||
"RangeNotSatisfiable",
|
|
||||||
"SanicException",
|
|
||||||
"ServerError",
|
|
||||||
"ServiceUnavailable",
|
|
||||||
"Unauthorized",
|
|
||||||
# Common response methods
|
|
||||||
"empty",
|
"empty",
|
||||||
"file",
|
"file",
|
||||||
"html",
|
"html",
|
||||||
"json",
|
"json",
|
||||||
"raw",
|
|
||||||
"redirect",
|
"redirect",
|
||||||
"text",
|
"text",
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
__version__ = "23.6.0"
|
__version__ = "22.12.0a0"
|
||||||
|
|||||||
335
sanic/app.py
335
sanic/app.py
@@ -5,6 +5,7 @@ import logging
|
|||||||
import logging.config
|
import logging.config
|
||||||
import re
|
import re
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from asyncio import (
|
from asyncio import (
|
||||||
AbstractEventLoop,
|
AbstractEventLoop,
|
||||||
CancelledError,
|
CancelledError,
|
||||||
@@ -15,8 +16,8 @@ from asyncio import (
|
|||||||
)
|
)
|
||||||
from asyncio.futures import Future
|
from asyncio.futures import Future
|
||||||
from collections import defaultdict, deque
|
from collections import defaultdict, deque
|
||||||
from contextlib import contextmanager, suppress
|
from contextlib import suppress
|
||||||
from functools import partial, wraps
|
from functools import partial
|
||||||
from inspect import isawaitable
|
from inspect import isawaitable
|
||||||
from os import environ
|
from os import environ
|
||||||
from socket import socket
|
from socket import socket
|
||||||
@@ -28,13 +29,10 @@ from typing import (
|
|||||||
AnyStr,
|
AnyStr,
|
||||||
Awaitable,
|
Awaitable,
|
||||||
Callable,
|
Callable,
|
||||||
ClassVar,
|
|
||||||
Coroutine,
|
Coroutine,
|
||||||
Deque,
|
Deque,
|
||||||
Dict,
|
Dict,
|
||||||
Generic,
|
|
||||||
Iterable,
|
Iterable,
|
||||||
Iterator,
|
|
||||||
List,
|
List,
|
||||||
Optional,
|
Optional,
|
||||||
Set,
|
Set,
|
||||||
@@ -42,8 +40,6 @@ from typing import (
|
|||||||
Type,
|
Type,
|
||||||
TypeVar,
|
TypeVar,
|
||||||
Union,
|
Union,
|
||||||
cast,
|
|
||||||
overload,
|
|
||||||
)
|
)
|
||||||
from urllib.parse import urlencode, urlunparse
|
from urllib.parse import urlencode, urlunparse
|
||||||
|
|
||||||
@@ -52,7 +48,7 @@ from sanic_routing.route import Route
|
|||||||
|
|
||||||
from sanic.application.ext import setup_ext
|
from sanic.application.ext import setup_ext
|
||||||
from sanic.application.state import ApplicationState, ServerStage
|
from sanic.application.state import ApplicationState, ServerStage
|
||||||
from sanic.asgi import ASGIApp, Lifespan
|
from sanic.asgi import ASGIApp
|
||||||
from sanic.base.root import BaseSanic
|
from sanic.base.root import BaseSanic
|
||||||
from sanic.blueprint_group import BlueprintGroup
|
from sanic.blueprint_group import BlueprintGroup
|
||||||
from sanic.blueprints import Blueprint
|
from sanic.blueprints import Blueprint
|
||||||
@@ -65,13 +61,16 @@ from sanic.exceptions import (
|
|||||||
URLBuildError,
|
URLBuildError,
|
||||||
)
|
)
|
||||||
from sanic.handlers import ErrorHandler
|
from sanic.handlers import ErrorHandler
|
||||||
from sanic.helpers import Default, _default
|
from sanic.helpers import Default
|
||||||
from sanic.http import Stage
|
from sanic.http import Stage
|
||||||
from sanic.log import LOGGING_CONFIG_DEFAULTS, error_logger, logger
|
from sanic.log import (
|
||||||
from sanic.middleware import Middleware, MiddlewareLocation
|
LOGGING_CONFIG_DEFAULTS,
|
||||||
|
deprecation,
|
||||||
|
error_logger,
|
||||||
|
logger,
|
||||||
|
)
|
||||||
from sanic.mixins.listeners import ListenerEvent
|
from sanic.mixins.listeners import ListenerEvent
|
||||||
from sanic.mixins.startup import StartupMixin
|
from sanic.mixins.startup import StartupMixin
|
||||||
from sanic.mixins.static import StaticHandleMixin
|
|
||||||
from sanic.models.futures import (
|
from sanic.models.futures import (
|
||||||
FutureException,
|
FutureException,
|
||||||
FutureListener,
|
FutureListener,
|
||||||
@@ -79,6 +78,7 @@ from sanic.models.futures import (
|
|||||||
FutureRegistry,
|
FutureRegistry,
|
||||||
FutureRoute,
|
FutureRoute,
|
||||||
FutureSignal,
|
FutureSignal,
|
||||||
|
FutureStatic,
|
||||||
)
|
)
|
||||||
from sanic.models.handler_types import ListenerType, MiddlewareType
|
from sanic.models.handler_types import ListenerType, MiddlewareType
|
||||||
from sanic.models.handler_types import Sanic as SanicVar
|
from sanic.models.handler_types import Sanic as SanicVar
|
||||||
@@ -86,13 +86,13 @@ from sanic.request import Request
|
|||||||
from sanic.response import BaseHTTPResponse, HTTPResponse, ResponseStream
|
from sanic.response import BaseHTTPResponse, HTTPResponse, ResponseStream
|
||||||
from sanic.router import Router
|
from sanic.router import Router
|
||||||
from sanic.server.websockets.impl import ConnectionClosed
|
from sanic.server.websockets.impl import ConnectionClosed
|
||||||
from sanic.signals import Event, Signal, SignalRouter
|
from sanic.signals import Signal, SignalRouter
|
||||||
from sanic.touchup import TouchUp, TouchUpMeta
|
from sanic.touchup import TouchUp, TouchUpMeta
|
||||||
from sanic.types.shared_ctx import SharedContext
|
from sanic.types.shared_ctx import SharedContext
|
||||||
from sanic.worker.inspector import Inspector
|
from sanic.worker.inspector import Inspector
|
||||||
from sanic.worker.loader import CertLoader
|
|
||||||
from sanic.worker.manager import WorkerManager
|
from sanic.worker.manager import WorkerManager
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
try:
|
try:
|
||||||
from sanic_ext import Extend # type: ignore
|
from sanic_ext import Extend # type: ignore
|
||||||
@@ -104,17 +104,8 @@ if TYPE_CHECKING:
|
|||||||
if OS_IS_WINDOWS: # no cov
|
if OS_IS_WINDOWS: # no cov
|
||||||
enable_windows_color_support()
|
enable_windows_color_support()
|
||||||
|
|
||||||
ctx_type = TypeVar("ctx_type")
|
|
||||||
config_type = TypeVar("config_type", bound=Config)
|
|
||||||
|
|
||||||
|
class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta):
|
||||||
class Sanic(
|
|
||||||
Generic[config_type, ctx_type],
|
|
||||||
StaticHandleMixin,
|
|
||||||
BaseSanic,
|
|
||||||
StartupMixin,
|
|
||||||
metaclass=TouchUpMeta,
|
|
||||||
):
|
|
||||||
"""
|
"""
|
||||||
The main application instance
|
The main application instance
|
||||||
"""
|
"""
|
||||||
@@ -127,7 +118,6 @@ class Sanic(
|
|||||||
)
|
)
|
||||||
__slots__ = (
|
__slots__ = (
|
||||||
"_asgi_app",
|
"_asgi_app",
|
||||||
"_asgi_lifespan",
|
|
||||||
"_asgi_client",
|
"_asgi_client",
|
||||||
"_blueprint_order",
|
"_blueprint_order",
|
||||||
"_delayed_tasks",
|
"_delayed_tasks",
|
||||||
@@ -146,12 +136,10 @@ class Sanic(
|
|||||||
"_test_client",
|
"_test_client",
|
||||||
"_test_manager",
|
"_test_manager",
|
||||||
"blueprints",
|
"blueprints",
|
||||||
"certloader_class",
|
|
||||||
"config",
|
"config",
|
||||||
"configure_logging",
|
"configure_logging",
|
||||||
"ctx",
|
"ctx",
|
||||||
"error_handler",
|
"error_handler",
|
||||||
"inspector_class",
|
|
||||||
"go_fast",
|
"go_fast",
|
||||||
"listeners",
|
"listeners",
|
||||||
"multiplexer",
|
"multiplexer",
|
||||||
@@ -169,102 +157,14 @@ class Sanic(
|
|||||||
"websocket_tasks",
|
"websocket_tasks",
|
||||||
)
|
)
|
||||||
|
|
||||||
_app_registry: ClassVar[Dict[str, "Sanic"]] = {}
|
_app_registry: Dict[str, "Sanic"] = {}
|
||||||
test_mode: ClassVar[bool] = False
|
test_mode = False
|
||||||
|
|
||||||
@overload
|
|
||||||
def __init__(
|
|
||||||
self: Sanic[Config, SimpleNamespace],
|
|
||||||
name: str,
|
|
||||||
config: None = None,
|
|
||||||
ctx: None = None,
|
|
||||||
router: Optional[Router] = None,
|
|
||||||
signal_router: Optional[SignalRouter] = None,
|
|
||||||
error_handler: Optional[ErrorHandler] = None,
|
|
||||||
env_prefix: Optional[str] = SANIC_PREFIX,
|
|
||||||
request_class: Optional[Type[Request]] = None,
|
|
||||||
strict_slashes: bool = False,
|
|
||||||
log_config: Optional[Dict[str, Any]] = None,
|
|
||||||
configure_logging: bool = True,
|
|
||||||
dumps: Optional[Callable[..., AnyStr]] = None,
|
|
||||||
loads: Optional[Callable[..., Any]] = None,
|
|
||||||
inspector: bool = False,
|
|
||||||
inspector_class: Optional[Type[Inspector]] = None,
|
|
||||||
certloader_class: Optional[Type[CertLoader]] = None,
|
|
||||||
) -> None:
|
|
||||||
...
|
|
||||||
|
|
||||||
@overload
|
|
||||||
def __init__(
|
|
||||||
self: Sanic[config_type, SimpleNamespace],
|
|
||||||
name: str,
|
|
||||||
config: Optional[config_type] = None,
|
|
||||||
ctx: None = None,
|
|
||||||
router: Optional[Router] = None,
|
|
||||||
signal_router: Optional[SignalRouter] = None,
|
|
||||||
error_handler: Optional[ErrorHandler] = None,
|
|
||||||
env_prefix: Optional[str] = SANIC_PREFIX,
|
|
||||||
request_class: Optional[Type[Request]] = None,
|
|
||||||
strict_slashes: bool = False,
|
|
||||||
log_config: Optional[Dict[str, Any]] = None,
|
|
||||||
configure_logging: bool = True,
|
|
||||||
dumps: Optional[Callable[..., AnyStr]] = None,
|
|
||||||
loads: Optional[Callable[..., Any]] = None,
|
|
||||||
inspector: bool = False,
|
|
||||||
inspector_class: Optional[Type[Inspector]] = None,
|
|
||||||
certloader_class: Optional[Type[CertLoader]] = None,
|
|
||||||
) -> None:
|
|
||||||
...
|
|
||||||
|
|
||||||
@overload
|
|
||||||
def __init__(
|
|
||||||
self: Sanic[Config, ctx_type],
|
|
||||||
name: str,
|
|
||||||
config: None = None,
|
|
||||||
ctx: Optional[ctx_type] = None,
|
|
||||||
router: Optional[Router] = None,
|
|
||||||
signal_router: Optional[SignalRouter] = None,
|
|
||||||
error_handler: Optional[ErrorHandler] = None,
|
|
||||||
env_prefix: Optional[str] = SANIC_PREFIX,
|
|
||||||
request_class: Optional[Type[Request]] = None,
|
|
||||||
strict_slashes: bool = False,
|
|
||||||
log_config: Optional[Dict[str, Any]] = None,
|
|
||||||
configure_logging: bool = True,
|
|
||||||
dumps: Optional[Callable[..., AnyStr]] = None,
|
|
||||||
loads: Optional[Callable[..., Any]] = None,
|
|
||||||
inspector: bool = False,
|
|
||||||
inspector_class: Optional[Type[Inspector]] = None,
|
|
||||||
certloader_class: Optional[Type[CertLoader]] = None,
|
|
||||||
) -> None:
|
|
||||||
...
|
|
||||||
|
|
||||||
@overload
|
|
||||||
def __init__(
|
|
||||||
self: Sanic[config_type, ctx_type],
|
|
||||||
name: str,
|
|
||||||
config: Optional[config_type] = None,
|
|
||||||
ctx: Optional[ctx_type] = None,
|
|
||||||
router: Optional[Router] = None,
|
|
||||||
signal_router: Optional[SignalRouter] = None,
|
|
||||||
error_handler: Optional[ErrorHandler] = None,
|
|
||||||
env_prefix: Optional[str] = SANIC_PREFIX,
|
|
||||||
request_class: Optional[Type[Request]] = None,
|
|
||||||
strict_slashes: bool = False,
|
|
||||||
log_config: Optional[Dict[str, Any]] = None,
|
|
||||||
configure_logging: bool = True,
|
|
||||||
dumps: Optional[Callable[..., AnyStr]] = None,
|
|
||||||
loads: Optional[Callable[..., Any]] = None,
|
|
||||||
inspector: bool = False,
|
|
||||||
inspector_class: Optional[Type[Inspector]] = None,
|
|
||||||
certloader_class: Optional[Type[CertLoader]] = None,
|
|
||||||
) -> None:
|
|
||||||
...
|
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
name: str,
|
name: str = None,
|
||||||
config: Optional[config_type] = None,
|
config: Optional[Config] = None,
|
||||||
ctx: Optional[ctx_type] = None,
|
ctx: Optional[Any] = None,
|
||||||
router: Optional[Router] = None,
|
router: Optional[Router] = None,
|
||||||
signal_router: Optional[SignalRouter] = None,
|
signal_router: Optional[SignalRouter] = None,
|
||||||
error_handler: Optional[ErrorHandler] = None,
|
error_handler: Optional[ErrorHandler] = None,
|
||||||
@@ -276,8 +176,6 @@ class Sanic(
|
|||||||
dumps: Optional[Callable[..., AnyStr]] = None,
|
dumps: Optional[Callable[..., AnyStr]] = None,
|
||||||
loads: Optional[Callable[..., Any]] = None,
|
loads: Optional[Callable[..., Any]] = None,
|
||||||
inspector: bool = False,
|
inspector: bool = False,
|
||||||
inspector_class: Optional[Type[Inspector]] = None,
|
|
||||||
certloader_class: Optional[Type[CertLoader]] = None,
|
|
||||||
) -> None:
|
) -> None:
|
||||||
super().__init__(name=name)
|
super().__init__(name=name)
|
||||||
# logging
|
# logging
|
||||||
@@ -292,15 +190,11 @@ class Sanic(
|
|||||||
)
|
)
|
||||||
|
|
||||||
# First setup config
|
# First setup config
|
||||||
self.config: config_type = cast(
|
self.config: Config = config or Config(env_prefix=env_prefix)
|
||||||
config_type, config or Config(env_prefix=env_prefix)
|
|
||||||
)
|
|
||||||
if inspector:
|
if inspector:
|
||||||
self.config.INSPECTOR = inspector
|
self.config.INSPECTOR = inspector
|
||||||
|
|
||||||
# Then we can do the rest
|
# Then we can do the rest
|
||||||
self._asgi_app: Optional[ASGIApp] = None
|
|
||||||
self._asgi_lifespan: Optional[Lifespan] = None
|
|
||||||
self._asgi_client: Any = None
|
self._asgi_client: Any = None
|
||||||
self._blueprint_order: List[Blueprint] = []
|
self._blueprint_order: List[Blueprint] = []
|
||||||
self._delayed_tasks: List[str] = []
|
self._delayed_tasks: List[str] = []
|
||||||
@@ -314,13 +208,9 @@ class Sanic(
|
|||||||
self.asgi = False
|
self.asgi = False
|
||||||
self.auto_reload = False
|
self.auto_reload = False
|
||||||
self.blueprints: Dict[str, Blueprint] = {}
|
self.blueprints: Dict[str, Blueprint] = {}
|
||||||
self.certloader_class: Type[CertLoader] = (
|
|
||||||
certloader_class or CertLoader
|
|
||||||
)
|
|
||||||
self.configure_logging: bool = configure_logging
|
self.configure_logging: bool = configure_logging
|
||||||
self.ctx: ctx_type = cast(ctx_type, ctx or SimpleNamespace())
|
self.ctx: Any = ctx or SimpleNamespace()
|
||||||
self.error_handler: ErrorHandler = error_handler or ErrorHandler()
|
self.error_handler: ErrorHandler = error_handler or ErrorHandler()
|
||||||
self.inspector_class: Type[Inspector] = inspector_class or Inspector
|
|
||||||
self.listeners: Dict[str, List[ListenerType[Any]]] = defaultdict(list)
|
self.listeners: Dict[str, List[ListenerType[Any]]] = defaultdict(list)
|
||||||
self.named_request_middleware: Dict[str, Deque[MiddlewareType]] = {}
|
self.named_request_middleware: Dict[str, Deque[MiddlewareType]] = {}
|
||||||
self.named_response_middleware: Dict[str, Deque[MiddlewareType]] = {}
|
self.named_response_middleware: Dict[str, Deque[MiddlewareType]] = {}
|
||||||
@@ -401,12 +291,8 @@ class Sanic(
|
|||||||
return listener
|
return listener
|
||||||
|
|
||||||
def register_middleware(
|
def register_middleware(
|
||||||
self,
|
self, middleware: MiddlewareType, attach_to: str = "request"
|
||||||
middleware: Union[MiddlewareType, Middleware],
|
) -> MiddlewareType:
|
||||||
attach_to: str = "request",
|
|
||||||
*,
|
|
||||||
priority: Union[Default, int] = _default,
|
|
||||||
) -> Union[MiddlewareType, Middleware]:
|
|
||||||
"""
|
"""
|
||||||
Register an application level middleware that will be attached
|
Register an application level middleware that will be attached
|
||||||
to all the API URLs registered under this application.
|
to all the API URLs registered under this application.
|
||||||
@@ -422,37 +308,19 @@ class Sanic(
|
|||||||
**response** - Invoke before the response is returned back
|
**response** - Invoke before the response is returned back
|
||||||
:return: decorated method
|
:return: decorated method
|
||||||
"""
|
"""
|
||||||
retval = middleware
|
if attach_to == "request":
|
||||||
location = MiddlewareLocation[attach_to.upper()]
|
|
||||||
|
|
||||||
if not isinstance(middleware, Middleware):
|
|
||||||
middleware = Middleware(
|
|
||||||
middleware,
|
|
||||||
location=location,
|
|
||||||
priority=priority if isinstance(priority, int) else 0,
|
|
||||||
)
|
|
||||||
elif middleware.priority != priority and isinstance(priority, int):
|
|
||||||
middleware = Middleware(
|
|
||||||
middleware.func,
|
|
||||||
location=middleware.location,
|
|
||||||
priority=priority,
|
|
||||||
)
|
|
||||||
|
|
||||||
if location is MiddlewareLocation.REQUEST:
|
|
||||||
if middleware not in self.request_middleware:
|
if middleware not in self.request_middleware:
|
||||||
self.request_middleware.append(middleware)
|
self.request_middleware.append(middleware)
|
||||||
if location is MiddlewareLocation.RESPONSE:
|
if attach_to == "response":
|
||||||
if middleware not in self.response_middleware:
|
if middleware not in self.response_middleware:
|
||||||
self.response_middleware.appendleft(middleware)
|
self.response_middleware.appendleft(middleware)
|
||||||
return retval
|
return middleware
|
||||||
|
|
||||||
def register_named_middleware(
|
def register_named_middleware(
|
||||||
self,
|
self,
|
||||||
middleware: MiddlewareType,
|
middleware: MiddlewareType,
|
||||||
route_names: Iterable[str],
|
route_names: Iterable[str],
|
||||||
attach_to: str = "request",
|
attach_to: str = "request",
|
||||||
*,
|
|
||||||
priority: Union[Default, int] = _default,
|
|
||||||
):
|
):
|
||||||
"""
|
"""
|
||||||
Method for attaching middleware to specific routes. This is mainly an
|
Method for attaching middleware to specific routes. This is mainly an
|
||||||
@@ -466,35 +334,19 @@ class Sanic(
|
|||||||
defaults to "request"
|
defaults to "request"
|
||||||
:type attach_to: str, optional
|
:type attach_to: str, optional
|
||||||
"""
|
"""
|
||||||
retval = middleware
|
if attach_to == "request":
|
||||||
location = MiddlewareLocation[attach_to.upper()]
|
|
||||||
|
|
||||||
if not isinstance(middleware, Middleware):
|
|
||||||
middleware = Middleware(
|
|
||||||
middleware,
|
|
||||||
location=location,
|
|
||||||
priority=priority if isinstance(priority, int) else 0,
|
|
||||||
)
|
|
||||||
elif middleware.priority != priority and isinstance(priority, int):
|
|
||||||
middleware = Middleware(
|
|
||||||
middleware.func,
|
|
||||||
location=middleware.location,
|
|
||||||
priority=priority,
|
|
||||||
)
|
|
||||||
|
|
||||||
if location is MiddlewareLocation.REQUEST:
|
|
||||||
for _rn in route_names:
|
for _rn in route_names:
|
||||||
if _rn not in self.named_request_middleware:
|
if _rn not in self.named_request_middleware:
|
||||||
self.named_request_middleware[_rn] = deque()
|
self.named_request_middleware[_rn] = deque()
|
||||||
if middleware not in self.named_request_middleware[_rn]:
|
if middleware not in self.named_request_middleware[_rn]:
|
||||||
self.named_request_middleware[_rn].append(middleware)
|
self.named_request_middleware[_rn].append(middleware)
|
||||||
if location is MiddlewareLocation.RESPONSE:
|
if attach_to == "response":
|
||||||
for _rn in route_names:
|
for _rn in route_names:
|
||||||
if _rn not in self.named_response_middleware:
|
if _rn not in self.named_response_middleware:
|
||||||
self.named_response_middleware[_rn] = deque()
|
self.named_response_middleware[_rn] = deque()
|
||||||
if middleware not in self.named_response_middleware[_rn]:
|
if middleware not in self.named_response_middleware[_rn]:
|
||||||
self.named_response_middleware[_rn].appendleft(middleware)
|
self.named_response_middleware[_rn].appendleft(middleware)
|
||||||
return retval
|
return middleware
|
||||||
|
|
||||||
def _apply_exception_handler(
|
def _apply_exception_handler(
|
||||||
self,
|
self,
|
||||||
@@ -518,11 +370,8 @@ class Sanic(
|
|||||||
def _apply_listener(self, listener: FutureListener):
|
def _apply_listener(self, listener: FutureListener):
|
||||||
return self.register_listener(listener.listener, listener.event)
|
return self.register_listener(listener.listener, listener.event)
|
||||||
|
|
||||||
def _apply_route(
|
def _apply_route(self, route: FutureRoute) -> List[Route]:
|
||||||
self, route: FutureRoute, overwrite: bool = False
|
|
||||||
) -> List[Route]:
|
|
||||||
params = route._asdict()
|
params = route._asdict()
|
||||||
params["overwrite"] = overwrite
|
|
||||||
websocket = params.pop("websocket", False)
|
websocket = params.pop("websocket", False)
|
||||||
subprotocols = params.pop("subprotocols", None)
|
subprotocols = params.pop("subprotocols", None)
|
||||||
|
|
||||||
@@ -539,7 +388,6 @@ class Sanic(
|
|||||||
|
|
||||||
ctx = params.pop("route_context")
|
ctx = params.pop("route_context")
|
||||||
|
|
||||||
with self.amend():
|
|
||||||
routes = self.router.add(**params)
|
routes = self.router.add(**params)
|
||||||
if isinstance(routes, Route):
|
if isinstance(routes, Route):
|
||||||
routes = [routes]
|
routes = [routes]
|
||||||
@@ -551,12 +399,14 @@ class Sanic(
|
|||||||
|
|
||||||
return routes
|
return routes
|
||||||
|
|
||||||
|
def _apply_static(self, static: FutureStatic) -> Route:
|
||||||
|
return self._register_static(static)
|
||||||
|
|
||||||
def _apply_middleware(
|
def _apply_middleware(
|
||||||
self,
|
self,
|
||||||
middleware: FutureMiddleware,
|
middleware: FutureMiddleware,
|
||||||
route_names: Optional[List[str]] = None,
|
route_names: Optional[List[str]] = None,
|
||||||
):
|
):
|
||||||
with self.amend():
|
|
||||||
if route_names:
|
if route_names:
|
||||||
return self.register_named_middleware(
|
return self.register_named_middleware(
|
||||||
middleware.middleware, route_names, middleware.attach_to
|
middleware.middleware, route_names, middleware.attach_to
|
||||||
@@ -567,7 +417,6 @@ class Sanic(
|
|||||||
)
|
)
|
||||||
|
|
||||||
def _apply_signal(self, signal: FutureSignal) -> Signal:
|
def _apply_signal(self, signal: FutureSignal) -> Signal:
|
||||||
with self.amend():
|
|
||||||
return self.signal_router.add(*signal)
|
return self.signal_router.add(*signal)
|
||||||
|
|
||||||
def dispatch(
|
def dispatch(
|
||||||
@@ -603,19 +452,6 @@ class Sanic(
|
|||||||
raise NotFound("Could not find signal %s" % event)
|
raise NotFound("Could not find signal %s" % event)
|
||||||
return await wait_for(signal.ctx.event.wait(), timeout=timeout)
|
return await wait_for(signal.ctx.event.wait(), timeout=timeout)
|
||||||
|
|
||||||
def report_exception(
|
|
||||||
self, handler: Callable[[Sanic, Exception], Coroutine[Any, Any, None]]
|
|
||||||
):
|
|
||||||
@wraps(handler)
|
|
||||||
async def report(exception: Exception) -> None:
|
|
||||||
await handler(self, exception)
|
|
||||||
|
|
||||||
self.add_signal(
|
|
||||||
handler=report, event=Event.SERVER_EXCEPTION_REPORT.value
|
|
||||||
)
|
|
||||||
|
|
||||||
return report
|
|
||||||
|
|
||||||
def enable_websocket(self, enable=True):
|
def enable_websocket(self, enable=True):
|
||||||
"""Enable or disable the support for websocket.
|
"""Enable or disable the support for websocket.
|
||||||
|
|
||||||
@@ -667,9 +503,6 @@ class Sanic(
|
|||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
params["version_prefix"] = blueprint.version_prefix
|
params["version_prefix"] = blueprint.version_prefix
|
||||||
name_prefix = getattr(blueprint, "name_prefix", None)
|
|
||||||
if name_prefix and "name_prefix" not in params:
|
|
||||||
params["name_prefix"] = name_prefix
|
|
||||||
self.blueprint(item, **params)
|
self.blueprint(item, **params)
|
||||||
return
|
return
|
||||||
if blueprint.name in self.blueprints:
|
if blueprint.name in self.blueprints:
|
||||||
@@ -887,12 +720,6 @@ class Sanic(
|
|||||||
:raises ServerError: response 500
|
:raises ServerError: response 500
|
||||||
"""
|
"""
|
||||||
response = None
|
response = None
|
||||||
if not getattr(exception, "__dispatched__", False):
|
|
||||||
... # DO NOT REMOVE THIS LINE. IT IS NEEDED FOR TOUCHUP.
|
|
||||||
await self.dispatch(
|
|
||||||
"server.exception.report",
|
|
||||||
context={"exception": exception},
|
|
||||||
)
|
|
||||||
await self.dispatch(
|
await self.dispatch(
|
||||||
"http.lifecycle.exception",
|
"http.lifecycle.exception",
|
||||||
inline=True,
|
inline=True,
|
||||||
@@ -1009,8 +836,6 @@ class Sanic(
|
|||||||
:param request: HTTP Request object
|
:param request: HTTP Request object
|
||||||
:return: Nothing
|
:return: Nothing
|
||||||
"""
|
"""
|
||||||
__tracebackhide__ = True
|
|
||||||
|
|
||||||
await self.dispatch(
|
await self.dispatch(
|
||||||
"http.lifecycle.handle",
|
"http.lifecycle.handle",
|
||||||
inline=True,
|
inline=True,
|
||||||
@@ -1023,11 +848,11 @@ class Sanic(
|
|||||||
Union[
|
Union[
|
||||||
BaseHTTPResponse,
|
BaseHTTPResponse,
|
||||||
Coroutine[Any, Any, Optional[BaseHTTPResponse]],
|
Coroutine[Any, Any, Optional[BaseHTTPResponse]],
|
||||||
ResponseStream,
|
|
||||||
]
|
]
|
||||||
] = None
|
] = None
|
||||||
run_middleware = True
|
run_middleware = True
|
||||||
try:
|
try:
|
||||||
|
|
||||||
await self.dispatch(
|
await self.dispatch(
|
||||||
"http.routing.before",
|
"http.routing.before",
|
||||||
inline=True,
|
inline=True,
|
||||||
@@ -1059,6 +884,7 @@ class Sanic(
|
|||||||
and request.stream.request_body
|
and request.stream.request_body
|
||||||
and not route.extra.ignore_body
|
and not route.extra.ignore_body
|
||||||
):
|
):
|
||||||
|
|
||||||
if hasattr(handler, "is_stream"):
|
if hasattr(handler, "is_stream"):
|
||||||
# Streaming handler: lift the size limit
|
# Streaming handler: lift the size limit
|
||||||
request.stream.request_max_size = float("inf")
|
request.stream.request_max_size = float("inf")
|
||||||
@@ -1132,7 +958,7 @@ class Sanic(
|
|||||||
...
|
...
|
||||||
await response.send(end_stream=True)
|
await response.send(end_stream=True)
|
||||||
elif isinstance(response, ResponseStream):
|
elif isinstance(response, ResponseStream):
|
||||||
resp = await response(request)
|
resp = await response(request) # type: ignore
|
||||||
await self.dispatch(
|
await self.dispatch(
|
||||||
"http.lifecycle.response",
|
"http.lifecycle.response",
|
||||||
inline=True,
|
inline=True,
|
||||||
@@ -1141,7 +967,7 @@ class Sanic(
|
|||||||
"response": resp,
|
"response": resp,
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
await response.eof()
|
await response.eof() # type: ignore
|
||||||
else:
|
else:
|
||||||
if not hasattr(handler, "is_websocket"):
|
if not hasattr(handler, "is_websocket"):
|
||||||
raise ServerError(
|
raise ServerError(
|
||||||
@@ -1323,28 +1149,13 @@ class Sanic(
|
|||||||
app,
|
app,
|
||||||
loop,
|
loop,
|
||||||
):
|
):
|
||||||
async def do(task):
|
|
||||||
try:
|
|
||||||
if callable(task):
|
if callable(task):
|
||||||
try:
|
try:
|
||||||
task = task(app)
|
task = task(app)
|
||||||
except TypeError:
|
except TypeError:
|
||||||
task = task()
|
task = task()
|
||||||
if isawaitable(task):
|
|
||||||
await task
|
|
||||||
except CancelledError:
|
|
||||||
error_logger.warning(
|
|
||||||
f"Task {task} was cancelled before it completed."
|
|
||||||
)
|
|
||||||
raise
|
|
||||||
except Exception as e:
|
|
||||||
await app.dispatch(
|
|
||||||
"server.exception.report",
|
|
||||||
context={"exception": e},
|
|
||||||
)
|
|
||||||
raise
|
|
||||||
|
|
||||||
return do(task)
|
return task
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def _loop_add_task(
|
def _loop_add_task(
|
||||||
@@ -1358,9 +1169,18 @@ class Sanic(
|
|||||||
) -> Task:
|
) -> Task:
|
||||||
if not isinstance(task, Future):
|
if not isinstance(task, Future):
|
||||||
prepped = cls._prep_task(task, app, loop)
|
prepped = cls._prep_task(task, app, loop)
|
||||||
|
if sys.version_info < (3, 8): # no cov
|
||||||
|
task = loop.create_task(prepped)
|
||||||
|
if name:
|
||||||
|
error_logger.warning(
|
||||||
|
"Cannot set a name for a task when using Python 3.7. "
|
||||||
|
"Your task will be created without a name."
|
||||||
|
)
|
||||||
|
task.get_name = lambda: name
|
||||||
|
else:
|
||||||
task = loop.create_task(prepped, name=name)
|
task = loop.create_task(prepped, name=name)
|
||||||
|
|
||||||
if name and register:
|
if name and register and sys.version_info > (3, 7):
|
||||||
app._task_registry[name] = task
|
app._task_registry[name] = task
|
||||||
|
|
||||||
return task
|
return task
|
||||||
@@ -1489,14 +1309,12 @@ class Sanic(
|
|||||||
three arguments: scope, receive, send. See the ASGI reference for more
|
three arguments: scope, receive, send. See the ASGI reference for more
|
||||||
details: https://asgi.readthedocs.io/en/latest
|
details: https://asgi.readthedocs.io/en/latest
|
||||||
"""
|
"""
|
||||||
if scope["type"] == "lifespan":
|
|
||||||
self.asgi = True
|
self.asgi = True
|
||||||
|
if scope["type"] == "lifespan":
|
||||||
self.motd("")
|
self.motd("")
|
||||||
self._asgi_lifespan = Lifespan(self, scope, receive, send)
|
|
||||||
await self._asgi_lifespan()
|
|
||||||
else:
|
|
||||||
self._asgi_app = await ASGIApp.create(self, scope, receive, send)
|
self._asgi_app = await ASGIApp.create(self, scope, receive, send)
|
||||||
await self._asgi_app()
|
asgi_app = self._asgi_app
|
||||||
|
await asgi_app()
|
||||||
|
|
||||||
_asgi_single_callable = True # We conform to ASGI 3.0 single-callable
|
_asgi_single_callable = True # We conform to ASGI 3.0 single-callable
|
||||||
|
|
||||||
@@ -1657,27 +1475,6 @@ class Sanic(
|
|||||||
# Lifecycle
|
# Lifecycle
|
||||||
# -------------------------------------------------------------------- #
|
# -------------------------------------------------------------------- #
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def amend(self) -> Iterator[None]:
|
|
||||||
"""
|
|
||||||
If the application has started, this function allows changes
|
|
||||||
to be made to add routes, middleware, and signals.
|
|
||||||
"""
|
|
||||||
if not self.state.is_started:
|
|
||||||
yield
|
|
||||||
else:
|
|
||||||
do_router = self.router.finalized
|
|
||||||
do_signal_router = self.signal_router.finalized
|
|
||||||
if do_router:
|
|
||||||
self.router.reset()
|
|
||||||
if do_signal_router:
|
|
||||||
self.signal_router.reset()
|
|
||||||
yield
|
|
||||||
if do_signal_router:
|
|
||||||
self.signalize(self.config.TOUCHUP)
|
|
||||||
if do_router:
|
|
||||||
self.finalize()
|
|
||||||
|
|
||||||
def finalize(self):
|
def finalize(self):
|
||||||
try:
|
try:
|
||||||
self.router.finalize()
|
self.router.finalize()
|
||||||
@@ -1711,20 +1508,17 @@ class Sanic(
|
|||||||
self.signalize(self.config.TOUCHUP)
|
self.signalize(self.config.TOUCHUP)
|
||||||
self.finalize()
|
self.finalize()
|
||||||
|
|
||||||
route_names = [route.extra.ident for route in self.router.routes]
|
route_names = [route.name for route in self.router.routes]
|
||||||
duplicates = {
|
duplicates = {
|
||||||
name for name in route_names if route_names.count(name) > 1
|
name for name in route_names if route_names.count(name) > 1
|
||||||
}
|
}
|
||||||
if duplicates:
|
if duplicates:
|
||||||
names = ", ".join(duplicates)
|
names = ", ".join(duplicates)
|
||||||
message = (
|
deprecation(
|
||||||
f"Duplicate route names detected: {names}. You should rename "
|
f"Duplicate route names detected: {names}. In the future, "
|
||||||
"one or more of them explicitly by using the `name` param, "
|
"Sanic will enforce uniqueness in route naming.",
|
||||||
"or changing the implicit name derived from the class and "
|
23.3,
|
||||||
"function name. For more details, please see "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#duplicated-route-names-are-no-longer-allowed" # noqa
|
|
||||||
)
|
)
|
||||||
raise ServerError(message)
|
|
||||||
|
|
||||||
Sanic._check_uvloop_conflict()
|
Sanic._check_uvloop_conflict()
|
||||||
|
|
||||||
@@ -1737,24 +1531,9 @@ class Sanic(
|
|||||||
|
|
||||||
self.state.is_started = True
|
self.state.is_started = True
|
||||||
|
|
||||||
def ack(self):
|
|
||||||
if hasattr(self, "multiplexer"):
|
if hasattr(self, "multiplexer"):
|
||||||
self.multiplexer.ack()
|
self.multiplexer.ack()
|
||||||
|
|
||||||
def set_serving(self, serving: bool) -> None:
|
|
||||||
"""Set the serving state of the application.
|
|
||||||
|
|
||||||
This method is used to set the serving state of the application.
|
|
||||||
It is used internally by Sanic and should not typically be called
|
|
||||||
manually.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
serving (bool): Whether the application is serving.
|
|
||||||
"""
|
|
||||||
self.state.is_running = serving
|
|
||||||
if hasattr(self, "multiplexer"):
|
|
||||||
self.multiplexer.set_serving(serving)
|
|
||||||
|
|
||||||
async def _server_event(
|
async def _server_event(
|
||||||
self,
|
self,
|
||||||
concern: str,
|
concern: str,
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import sys
|
|||||||
|
|
||||||
from os import environ
|
from os import environ
|
||||||
|
|
||||||
from sanic.helpers import is_atty
|
from sanic.compat import is_atty
|
||||||
|
|
||||||
|
|
||||||
BASE_LOGO = """
|
BASE_LOGO = """
|
||||||
@@ -40,8 +40,6 @@ FULL_COLOR_LOGO = """
|
|||||||
|
|
||||||
""" # noqa
|
""" # noqa
|
||||||
|
|
||||||
SVG_LOGO_SIMPLE = """<svg id=logo-simple viewBox="0 0 964 279"><desc>Sanic</desc><path d="M107 222c9-2 10-20 1-22s-20-2-30-2-17 7-16 14 6 10 15 10h30zm115-1c16-2 30-11 35-23s6-24 2-33-6-14-15-20-24-11-38-10c-7 3-10 13-5 19s17-1 24 4 15 14 13 24-5 15-14 18-50 0-74 0h-17c-6 4-10 15-4 20s16 2 23 3zM251 83q9-1 9-7 0-15-10-16h-13c-10 6-10 20 0 22zM147 60c-4 0-10 3-11 11s5 13 10 12 42 0 67 0c5-3 7-10 6-15s-4-8-9-8zm-33 1c-8 0-16 0-24 3s-20 10-25 20-6 24-4 36 15 22 26 27 78 8 94 3c4-4 4-12 0-18s-69 8-93-10c-8-7-9-23 0-30s12-10 20-10 12 2 16-3 1-15-5-18z" fill="#ff0d68"/><path d="M676 74c0-14-18-9-20 0s0 30 0 39 20 9 20 2zm-297-10c-12 2-15 12-23 23l-41 58H340l22-30c8-12 23-13 30-4s20 24 24 38-10 10-17 10l-68 2q-17 1-48 30c-7 6-10 20 0 24s15-8 20-13 20 -20 58-21h50 c20 2 33 9 52 30 8 10 24-4 16-13L384 65q-3-2-5-1zm131 0c-10 1-12 12-11 20v96c1 10-3 23 5 32s20-5 17-15c0-23-3-46 2-67 5-12 22-14 32-5l103 87c7 5 19 1 18-9v-64c-3-10-20-9-21 2s-20 22-30 13l-97-80c-5-4-10-10-18-10zM701 76v128c2 10 15 12 20 4s0-102 0-124s-20-18-20-7z M850 63c-35 0-69-2-86 15s-20 60-13 66 13 8 16 0 1-10 1-27 12-26 20-32 66-5 85-5 31 4 31-10-18-7-54-7M764 159c-6-2-15-2-16 12s19 37 33 43 23 8 25-4-4-11-11-14q-9-3-22-18c-4-7-3-16-10-19zM828 196c-4 0-8 1-10 5s-4 12 0 15 8 2 12 2h60c5 0 10-2 12-6 3-7-1-16-8-16z" fill="#1f1f1f"/></svg>""" # noqa
|
|
||||||
|
|
||||||
ansi_pattern = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
|
ansi_pattern = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from textwrap import indent, wrap
|
|||||||
from typing import Dict, Optional
|
from typing import Dict, Optional
|
||||||
|
|
||||||
from sanic import __version__
|
from sanic import __version__
|
||||||
from sanic.helpers import is_atty
|
from sanic.compat import is_atty
|
||||||
from sanic.log import logger
|
from sanic.log import logger
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
112
sanic/asgi.py
112
sanic/asgi.py
@@ -3,12 +3,13 @@ from __future__ import annotations
|
|||||||
import warnings
|
import warnings
|
||||||
|
|
||||||
from typing import TYPE_CHECKING, Optional
|
from typing import TYPE_CHECKING, Optional
|
||||||
|
from urllib.parse import quote
|
||||||
|
|
||||||
from sanic.compat import Header
|
from sanic.compat import Header
|
||||||
from sanic.exceptions import BadRequest, ServerError
|
from sanic.exceptions import ServerError
|
||||||
from sanic.helpers import Default
|
from sanic.helpers import Default
|
||||||
from sanic.http import Stage
|
from sanic.http import Stage
|
||||||
from sanic.log import error_logger, logger
|
from sanic.log import logger
|
||||||
from sanic.models.asgi import ASGIReceive, ASGIScope, ASGISend, MockTransport
|
from sanic.models.asgi import ASGIReceive, ASGIScope, ASGISend, MockTransport
|
||||||
from sanic.request import Request
|
from sanic.request import Request
|
||||||
from sanic.response import BaseHTTPResponse
|
from sanic.response import BaseHTTPResponse
|
||||||
@@ -21,15 +22,13 @@ if TYPE_CHECKING:
|
|||||||
|
|
||||||
|
|
||||||
class Lifespan:
|
class Lifespan:
|
||||||
def __init__(
|
def __init__(self, asgi_app: ASGIApp) -> None:
|
||||||
self, sanic_app, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
|
self.asgi_app = asgi_app
|
||||||
) -> None:
|
|
||||||
self.sanic_app = sanic_app
|
|
||||||
self.scope = scope
|
|
||||||
self.receive = receive
|
|
||||||
self.send = send
|
|
||||||
|
|
||||||
if "server.init.before" in self.sanic_app.signal_router.name_index:
|
if (
|
||||||
|
"server.init.before"
|
||||||
|
in self.asgi_app.sanic_app.signal_router.name_index
|
||||||
|
):
|
||||||
logger.debug(
|
logger.debug(
|
||||||
'You have set a listener for "before_server_start" '
|
'You have set a listener for "before_server_start" '
|
||||||
"in ASGI mode. "
|
"in ASGI mode. "
|
||||||
@@ -37,7 +36,10 @@ class Lifespan:
|
|||||||
"the ASGI server is started.",
|
"the ASGI server is started.",
|
||||||
extra={"verbosity": 1},
|
extra={"verbosity": 1},
|
||||||
)
|
)
|
||||||
if "server.shutdown.after" in self.sanic_app.signal_router.name_index:
|
if (
|
||||||
|
"server.shutdown.after"
|
||||||
|
in self.asgi_app.sanic_app.signal_router.name_index
|
||||||
|
):
|
||||||
logger.debug(
|
logger.debug(
|
||||||
'You have set a listener for "after_server_stop" '
|
'You have set a listener for "after_server_stop" '
|
||||||
"in ASGI mode. "
|
"in ASGI mode. "
|
||||||
@@ -55,11 +57,11 @@ class Lifespan:
|
|||||||
in sequence since the ASGI lifespan protocol only supports a single
|
in sequence since the ASGI lifespan protocol only supports a single
|
||||||
startup event.
|
startup event.
|
||||||
"""
|
"""
|
||||||
await self.sanic_app._startup()
|
await self.asgi_app.sanic_app._startup()
|
||||||
await self.sanic_app._server_event("init", "before")
|
await self.asgi_app.sanic_app._server_event("init", "before")
|
||||||
await self.sanic_app._server_event("init", "after")
|
await self.asgi_app.sanic_app._server_event("init", "after")
|
||||||
|
|
||||||
if not isinstance(self.sanic_app.config.USE_UVLOOP, Default):
|
if not isinstance(self.asgi_app.sanic_app.config.USE_UVLOOP, Default):
|
||||||
warnings.warn(
|
warnings.warn(
|
||||||
"You have set the USE_UVLOOP configuration option, but Sanic "
|
"You have set the USE_UVLOOP configuration option, but Sanic "
|
||||||
"cannot control the event loop when running in ASGI mode."
|
"cannot control the event loop when running in ASGI mode."
|
||||||
@@ -75,33 +77,21 @@ class Lifespan:
|
|||||||
in sequence since the ASGI lifespan protocol only supports a single
|
in sequence since the ASGI lifespan protocol only supports a single
|
||||||
shutdown event.
|
shutdown event.
|
||||||
"""
|
"""
|
||||||
await self.sanic_app._server_event("shutdown", "before")
|
await self.asgi_app.sanic_app._server_event("shutdown", "before")
|
||||||
await self.sanic_app._server_event("shutdown", "after")
|
await self.asgi_app.sanic_app._server_event("shutdown", "after")
|
||||||
|
|
||||||
async def __call__(self) -> None:
|
async def __call__(
|
||||||
while True:
|
self, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
|
||||||
message = await self.receive()
|
) -> None:
|
||||||
|
message = await receive()
|
||||||
if message["type"] == "lifespan.startup":
|
if message["type"] == "lifespan.startup":
|
||||||
try:
|
|
||||||
await self.startup()
|
await self.startup()
|
||||||
except Exception as e:
|
await send({"type": "lifespan.startup.complete"})
|
||||||
error_logger.exception(e)
|
|
||||||
await self.send(
|
message = await receive()
|
||||||
{"type": "lifespan.startup.failed", "message": str(e)}
|
if message["type"] == "lifespan.shutdown":
|
||||||
)
|
|
||||||
else:
|
|
||||||
await self.send({"type": "lifespan.startup.complete"})
|
|
||||||
elif message["type"] == "lifespan.shutdown":
|
|
||||||
try:
|
|
||||||
await self.shutdown()
|
await self.shutdown()
|
||||||
except Exception as e:
|
await send({"type": "lifespan.shutdown.complete"})
|
||||||
error_logger.exception(e)
|
|
||||||
await self.send(
|
|
||||||
{"type": "lifespan.shutdown.failed", "message": str(e)}
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
await self.send({"type": "lifespan.shutdown.complete"})
|
|
||||||
return
|
|
||||||
|
|
||||||
|
|
||||||
class ASGIApp:
|
class ASGIApp:
|
||||||
@@ -113,38 +103,40 @@ class ASGIApp:
|
|||||||
stage: Stage
|
stage: Stage
|
||||||
response: Optional[BaseHTTPResponse]
|
response: Optional[BaseHTTPResponse]
|
||||||
|
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.ws = None
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
async def create(
|
async def create(
|
||||||
cls,
|
cls, sanic_app, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
|
||||||
sanic_app: Sanic,
|
) -> "ASGIApp":
|
||||||
scope: ASGIScope,
|
|
||||||
receive: ASGIReceive,
|
|
||||||
send: ASGISend,
|
|
||||||
) -> ASGIApp:
|
|
||||||
instance = cls()
|
instance = cls()
|
||||||
instance.ws = None
|
|
||||||
instance.sanic_app = sanic_app
|
instance.sanic_app = sanic_app
|
||||||
instance.transport = MockTransport(scope, receive, send)
|
instance.transport = MockTransport(scope, receive, send)
|
||||||
instance.transport.loop = sanic_app.loop
|
instance.transport.loop = sanic_app.loop
|
||||||
instance.stage = Stage.IDLE
|
instance.stage = Stage.IDLE
|
||||||
instance.response = None
|
instance.response = None
|
||||||
instance.sanic_app.state.is_started = True
|
|
||||||
setattr(instance.transport, "add_task", sanic_app.loop.create_task)
|
setattr(instance.transport, "add_task", sanic_app.loop.create_task)
|
||||||
|
|
||||||
try:
|
|
||||||
headers = Header(
|
headers = Header(
|
||||||
[
|
[
|
||||||
(
|
(key.decode("latin-1"), value.decode("latin-1"))
|
||||||
key.decode("ASCII"),
|
|
||||||
value.decode(errors="surrogateescape"),
|
|
||||||
)
|
|
||||||
for key, value in scope.get("headers", [])
|
for key, value in scope.get("headers", [])
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
except UnicodeDecodeError:
|
instance.lifespan = Lifespan(instance)
|
||||||
raise BadRequest(
|
|
||||||
"Header names can only contain US-ASCII characters"
|
if scope["type"] == "lifespan":
|
||||||
|
await instance.lifespan(scope, receive, send)
|
||||||
|
else:
|
||||||
|
path = (
|
||||||
|
scope["path"][1:]
|
||||||
|
if scope["path"].startswith("/")
|
||||||
|
else scope["path"]
|
||||||
)
|
)
|
||||||
|
url = "/".join([scope.get("root_path", ""), quote(path)])
|
||||||
|
url_bytes = url.encode("latin-1")
|
||||||
|
url_bytes += b"?" + scope["query_string"]
|
||||||
|
|
||||||
if scope["type"] == "http":
|
if scope["type"] == "http":
|
||||||
version = scope["http_version"]
|
version = scope["http_version"]
|
||||||
@@ -159,13 +151,6 @@ class ASGIApp:
|
|||||||
else:
|
else:
|
||||||
raise ServerError("Received unknown ASGI scope")
|
raise ServerError("Received unknown ASGI scope")
|
||||||
|
|
||||||
url_bytes, query = scope["raw_path"], scope["query_string"]
|
|
||||||
if query:
|
|
||||||
# httpx ASGI client sends query string as part of raw_path
|
|
||||||
url_bytes = url_bytes.split(b"?", 1)[0]
|
|
||||||
# All servers send them separately
|
|
||||||
url_bytes = b"%b?%b" % (url_bytes, query)
|
|
||||||
|
|
||||||
request_class = sanic_app.request_class or Request
|
request_class = sanic_app.request_class or Request
|
||||||
instance.request = request_class(
|
instance.request = request_class(
|
||||||
url_bytes,
|
url_bytes,
|
||||||
@@ -175,12 +160,11 @@ class ASGIApp:
|
|||||||
instance.transport,
|
instance.transport,
|
||||||
sanic_app,
|
sanic_app,
|
||||||
)
|
)
|
||||||
request_class._current.set(instance.request)
|
instance.request.stream = instance
|
||||||
instance.request.stream = instance # type: ignore
|
|
||||||
instance.request_body = True
|
instance.request_body = True
|
||||||
instance.request.conn_info = ConnInfo(instance.transport)
|
instance.request.conn_info = ConnInfo(instance.transport)
|
||||||
|
|
||||||
await instance.sanic_app.dispatch(
|
await sanic_app.dispatch(
|
||||||
"http.lifecycle.request",
|
"http.lifecycle.request",
|
||||||
inline=True,
|
inline=True,
|
||||||
context={"request": instance.request},
|
context={"request": instance.request},
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import re
|
import re
|
||||||
|
|
||||||
from typing import Any, Optional
|
from typing import Any
|
||||||
|
|
||||||
from sanic.base.meta import SanicMeta
|
from sanic.base.meta import SanicMeta
|
||||||
from sanic.exceptions import SanicException
|
from sanic.exceptions import SanicException
|
||||||
@@ -9,7 +9,6 @@ from sanic.mixins.listeners import ListenerMixin
|
|||||||
from sanic.mixins.middleware import MiddlewareMixin
|
from sanic.mixins.middleware import MiddlewareMixin
|
||||||
from sanic.mixins.routes import RouteMixin
|
from sanic.mixins.routes import RouteMixin
|
||||||
from sanic.mixins.signals import SignalMixin
|
from sanic.mixins.signals import SignalMixin
|
||||||
from sanic.mixins.static import StaticMixin
|
|
||||||
|
|
||||||
|
|
||||||
VALID_NAME = re.compile(r"^[a-zA-Z_][a-zA-Z0-9_\-]*$")
|
VALID_NAME = re.compile(r"^[a-zA-Z_][a-zA-Z0-9_\-]*$")
|
||||||
@@ -17,7 +16,6 @@ VALID_NAME = re.compile(r"^[a-zA-Z_][a-zA-Z0-9_\-]*$")
|
|||||||
|
|
||||||
class BaseSanic(
|
class BaseSanic(
|
||||||
RouteMixin,
|
RouteMixin,
|
||||||
StaticMixin,
|
|
||||||
MiddlewareMixin,
|
MiddlewareMixin,
|
||||||
ListenerMixin,
|
ListenerMixin,
|
||||||
ExceptionMixin,
|
ExceptionMixin,
|
||||||
@@ -26,9 +24,7 @@ class BaseSanic(
|
|||||||
):
|
):
|
||||||
__slots__ = ("name",)
|
__slots__ = ("name",)
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, name: str = None, *args: Any, **kwargs: Any) -> None:
|
||||||
self, name: Optional[str] = None, *args: Any, **kwargs: Any
|
|
||||||
) -> None:
|
|
||||||
class_name = self.__class__.__name__
|
class_name = self.__class__.__name__
|
||||||
|
|
||||||
if name is None:
|
if name is None:
|
||||||
|
|||||||
@@ -65,7 +65,6 @@ class BlueprintGroup(MutableSequence):
|
|||||||
"_version",
|
"_version",
|
||||||
"_strict_slashes",
|
"_strict_slashes",
|
||||||
"_version_prefix",
|
"_version_prefix",
|
||||||
"_name_prefix",
|
|
||||||
)
|
)
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
@@ -74,7 +73,6 @@ class BlueprintGroup(MutableSequence):
|
|||||||
version: Optional[Union[int, str, float]] = None,
|
version: Optional[Union[int, str, float]] = None,
|
||||||
strict_slashes: Optional[bool] = None,
|
strict_slashes: Optional[bool] = None,
|
||||||
version_prefix: str = "/v",
|
version_prefix: str = "/v",
|
||||||
name_prefix: Optional[str] = "",
|
|
||||||
):
|
):
|
||||||
"""
|
"""
|
||||||
Create a new Blueprint Group
|
Create a new Blueprint Group
|
||||||
@@ -89,7 +87,6 @@ class BlueprintGroup(MutableSequence):
|
|||||||
self._version = version
|
self._version = version
|
||||||
self._version_prefix = version_prefix
|
self._version_prefix = version_prefix
|
||||||
self._strict_slashes = strict_slashes
|
self._strict_slashes = strict_slashes
|
||||||
self._name_prefix = name_prefix
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def url_prefix(self) -> Optional[Union[int, str, float]]:
|
def url_prefix(self) -> Optional[Union[int, str, float]]:
|
||||||
@@ -137,15 +134,6 @@ class BlueprintGroup(MutableSequence):
|
|||||||
"""
|
"""
|
||||||
return self._version_prefix
|
return self._version_prefix
|
||||||
|
|
||||||
@property
|
|
||||||
def name_prefix(self) -> Optional[str]:
|
|
||||||
"""
|
|
||||||
Name prefix for the blueprint group
|
|
||||||
|
|
||||||
:return: str
|
|
||||||
"""
|
|
||||||
return self._name_prefix
|
|
||||||
|
|
||||||
def __iter__(self):
|
def __iter__(self):
|
||||||
"""
|
"""
|
||||||
Tun the class Blueprint Group into an Iterable item
|
Tun the class Blueprint Group into an Iterable item
|
||||||
|
|||||||
@@ -93,8 +93,6 @@ class Blueprint(BaseSanic):
|
|||||||
"_future_listeners",
|
"_future_listeners",
|
||||||
"_future_exceptions",
|
"_future_exceptions",
|
||||||
"_future_signals",
|
"_future_signals",
|
||||||
"_allow_route_overwrite",
|
|
||||||
"copied_from",
|
|
||||||
"ctx",
|
"ctx",
|
||||||
"exceptions",
|
"exceptions",
|
||||||
"host",
|
"host",
|
||||||
@@ -111,7 +109,7 @@ class Blueprint(BaseSanic):
|
|||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
name: str,
|
name: str = None,
|
||||||
url_prefix: Optional[str] = None,
|
url_prefix: Optional[str] = None,
|
||||||
host: Optional[Union[List[str], str]] = None,
|
host: Optional[Union[List[str], str]] = None,
|
||||||
version: Optional[Union[int, str, float]] = None,
|
version: Optional[Union[int, str, float]] = None,
|
||||||
@@ -120,8 +118,6 @@ class Blueprint(BaseSanic):
|
|||||||
):
|
):
|
||||||
super().__init__(name=name)
|
super().__init__(name=name)
|
||||||
self.reset()
|
self.reset()
|
||||||
self._allow_route_overwrite = False
|
|
||||||
self.copied_from = ""
|
|
||||||
self.ctx = SimpleNamespace()
|
self.ctx = SimpleNamespace()
|
||||||
self.host = host
|
self.host = host
|
||||||
self.strict_slashes = strict_slashes
|
self.strict_slashes = strict_slashes
|
||||||
@@ -171,7 +167,6 @@ class Blueprint(BaseSanic):
|
|||||||
|
|
||||||
def reset(self):
|
def reset(self):
|
||||||
self._apps: Set[Sanic] = set()
|
self._apps: Set[Sanic] = set()
|
||||||
self._allow_route_overwrite = False
|
|
||||||
self.exceptions: List[RouteHandler] = []
|
self.exceptions: List[RouteHandler] = []
|
||||||
self.listeners: Dict[str, List[ListenerType[Any]]] = {}
|
self.listeners: Dict[str, List[ListenerType[Any]]] = {}
|
||||||
self.middlewares: List[MiddlewareType] = []
|
self.middlewares: List[MiddlewareType] = []
|
||||||
@@ -185,7 +180,6 @@ class Blueprint(BaseSanic):
|
|||||||
url_prefix: Optional[Union[str, Default]] = _default,
|
url_prefix: Optional[Union[str, Default]] = _default,
|
||||||
version: Optional[Union[int, str, float, Default]] = _default,
|
version: Optional[Union[int, str, float, Default]] = _default,
|
||||||
version_prefix: Union[str, Default] = _default,
|
version_prefix: Union[str, Default] = _default,
|
||||||
allow_route_overwrite: Union[bool, Default] = _default,
|
|
||||||
strict_slashes: Optional[Union[bool, Default]] = _default,
|
strict_slashes: Optional[Union[bool, Default]] = _default,
|
||||||
with_registration: bool = True,
|
with_registration: bool = True,
|
||||||
with_ctx: bool = False,
|
with_ctx: bool = False,
|
||||||
@@ -219,7 +213,6 @@ class Blueprint(BaseSanic):
|
|||||||
self.reset()
|
self.reset()
|
||||||
new_bp = deepcopy(self)
|
new_bp = deepcopy(self)
|
||||||
new_bp.name = name
|
new_bp.name = name
|
||||||
new_bp.copied_from = self.name
|
|
||||||
|
|
||||||
if not isinstance(url_prefix, Default):
|
if not isinstance(url_prefix, Default):
|
||||||
new_bp.url_prefix = url_prefix
|
new_bp.url_prefix = url_prefix
|
||||||
@@ -229,8 +222,6 @@ class Blueprint(BaseSanic):
|
|||||||
new_bp.strict_slashes = strict_slashes
|
new_bp.strict_slashes = strict_slashes
|
||||||
if not isinstance(version_prefix, Default):
|
if not isinstance(version_prefix, Default):
|
||||||
new_bp.version_prefix = version_prefix
|
new_bp.version_prefix = version_prefix
|
||||||
if not isinstance(allow_route_overwrite, Default):
|
|
||||||
new_bp._allow_route_overwrite = allow_route_overwrite
|
|
||||||
|
|
||||||
for key, value in attrs_backup.items():
|
for key, value in attrs_backup.items():
|
||||||
setattr(self, key, value)
|
setattr(self, key, value)
|
||||||
@@ -256,7 +247,6 @@ class Blueprint(BaseSanic):
|
|||||||
version: Optional[Union[int, str, float]] = None,
|
version: Optional[Union[int, str, float]] = None,
|
||||||
strict_slashes: Optional[bool] = None,
|
strict_slashes: Optional[bool] = None,
|
||||||
version_prefix: str = "/v",
|
version_prefix: str = "/v",
|
||||||
name_prefix: Optional[str] = "",
|
|
||||||
) -> BlueprintGroup:
|
) -> BlueprintGroup:
|
||||||
"""
|
"""
|
||||||
Create a list of blueprints, optionally grouping them under a
|
Create a list of blueprints, optionally grouping them under a
|
||||||
@@ -282,7 +272,6 @@ class Blueprint(BaseSanic):
|
|||||||
version=version,
|
version=version,
|
||||||
strict_slashes=strict_slashes,
|
strict_slashes=strict_slashes,
|
||||||
version_prefix=version_prefix,
|
version_prefix=version_prefix,
|
||||||
name_prefix=name_prefix,
|
|
||||||
)
|
)
|
||||||
for bp in chain(blueprints):
|
for bp in chain(blueprints):
|
||||||
bps.append(bp)
|
bps.append(bp)
|
||||||
@@ -303,7 +292,6 @@ class Blueprint(BaseSanic):
|
|||||||
opt_version = options.get("version", None)
|
opt_version = options.get("version", None)
|
||||||
opt_strict_slashes = options.get("strict_slashes", None)
|
opt_strict_slashes = options.get("strict_slashes", None)
|
||||||
opt_version_prefix = options.get("version_prefix", self.version_prefix)
|
opt_version_prefix = options.get("version_prefix", self.version_prefix)
|
||||||
opt_name_prefix = options.get("name_prefix", None)
|
|
||||||
error_format = options.get(
|
error_format = options.get(
|
||||||
"error_format", app.config.FALLBACK_ERROR_FORMAT
|
"error_format", app.config.FALLBACK_ERROR_FORMAT
|
||||||
)
|
)
|
||||||
@@ -316,13 +304,12 @@ class Blueprint(BaseSanic):
|
|||||||
|
|
||||||
# Routes
|
# Routes
|
||||||
for future in self._future_routes:
|
for future in self._future_routes:
|
||||||
|
# attach the blueprint name to the handler so that it can be
|
||||||
|
# prefixed properly in the router
|
||||||
|
future.handler.__blueprintname__ = self.name
|
||||||
# Prepend the blueprint URI prefix if available
|
# Prepend the blueprint URI prefix if available
|
||||||
uri = self._setup_uri(future.uri, url_prefix)
|
uri = self._setup_uri(future.uri, url_prefix)
|
||||||
|
|
||||||
route_error_format = (
|
|
||||||
future.error_format if future.error_format else error_format
|
|
||||||
)
|
|
||||||
|
|
||||||
version_prefix = self.version_prefix
|
version_prefix = self.version_prefix
|
||||||
for prefix in (
|
for prefix in (
|
||||||
future.version_prefix,
|
future.version_prefix,
|
||||||
@@ -339,10 +326,7 @@ class Blueprint(BaseSanic):
|
|||||||
future.strict_slashes, opt_strict_slashes, self.strict_slashes
|
future.strict_slashes, opt_strict_slashes, self.strict_slashes
|
||||||
)
|
)
|
||||||
|
|
||||||
name = future.name
|
name = app._generate_name(future.name)
|
||||||
if opt_name_prefix:
|
|
||||||
name = f"{opt_name_prefix}_{future.name}"
|
|
||||||
name = app._generate_name(name)
|
|
||||||
host = future.host or self.host
|
host = future.host or self.host
|
||||||
if isinstance(host, list):
|
if isinstance(host, list):
|
||||||
host = tuple(host)
|
host = tuple(host)
|
||||||
@@ -362,7 +346,7 @@ class Blueprint(BaseSanic):
|
|||||||
future.unquote,
|
future.unquote,
|
||||||
future.static,
|
future.static,
|
||||||
version_prefix,
|
version_prefix,
|
||||||
route_error_format,
|
error_format,
|
||||||
future.route_context,
|
future.route_context,
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -370,19 +354,7 @@ class Blueprint(BaseSanic):
|
|||||||
continue
|
continue
|
||||||
|
|
||||||
registered.add(apply_route)
|
registered.add(apply_route)
|
||||||
route = app._apply_route(
|
route = app._apply_route(apply_route)
|
||||||
apply_route, overwrite=self._allow_route_overwrite
|
|
||||||
)
|
|
||||||
|
|
||||||
# If it is a copied BP, then make sure all of the names of routes
|
|
||||||
# matchup with the new BP name
|
|
||||||
if self.copied_from:
|
|
||||||
for r in route:
|
|
||||||
r.name = r.name.replace(self.copied_from, self.name)
|
|
||||||
r.extra.ident = r.extra.ident.replace(
|
|
||||||
self.copied_from, self.name
|
|
||||||
)
|
|
||||||
|
|
||||||
operation = (
|
operation = (
|
||||||
routes.extend if isinstance(route, list) else routes.append
|
routes.extend if isinstance(route, list) else routes.append
|
||||||
)
|
)
|
||||||
@@ -470,7 +442,7 @@ class Blueprint(BaseSanic):
|
|||||||
events.add(signal.ctx.event)
|
events.add(signal.ctx.event)
|
||||||
|
|
||||||
return asyncio.wait(
|
return asyncio.wait(
|
||||||
[asyncio.create_task(event.wait()) for event in events],
|
[event.wait() for event in events],
|
||||||
return_when=asyncio.FIRST_COMPLETED,
|
return_when=asyncio.FIRST_COMPLETED,
|
||||||
timeout=timeout,
|
timeout=timeout,
|
||||||
)
|
)
|
||||||
|
|||||||
101
sanic/cli/app.py
101
sanic/cli/app.py
@@ -1,44 +1,42 @@
|
|||||||
|
import logging
|
||||||
import os
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from argparse import Namespace
|
from argparse import ArgumentParser, RawTextHelpFormatter
|
||||||
from functools import partial
|
from functools import partial
|
||||||
from textwrap import indent
|
from textwrap import indent
|
||||||
from typing import List, Union
|
from typing import Any, List, Union
|
||||||
|
|
||||||
from sanic.app import Sanic
|
from sanic.app import Sanic
|
||||||
from sanic.application.logo import get_logo
|
from sanic.application.logo import get_logo
|
||||||
from sanic.cli.arguments import Group
|
from sanic.cli.arguments import Group
|
||||||
from sanic.cli.base import SanicArgumentParser, SanicHelpFormatter
|
|
||||||
from sanic.cli.inspector import make_inspector_parser
|
|
||||||
from sanic.cli.inspector_client import InspectorClient
|
|
||||||
from sanic.log import error_logger
|
from sanic.log import error_logger
|
||||||
|
from sanic.worker.inspector import inspect
|
||||||
from sanic.worker.loader import AppLoader
|
from sanic.worker.loader import AppLoader
|
||||||
|
|
||||||
|
|
||||||
|
class SanicArgumentParser(ArgumentParser):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
class SanicCLI:
|
class SanicCLI:
|
||||||
DESCRIPTION = indent(
|
DESCRIPTION = indent(
|
||||||
f"""
|
f"""
|
||||||
{get_logo(True)}
|
{get_logo(True)}
|
||||||
|
|
||||||
To start running a Sanic application, provide a path to the module, where
|
To start running a Sanic application, provide a path to the module, where
|
||||||
app is a Sanic() instance in the global scope:
|
app is a Sanic() instance:
|
||||||
|
|
||||||
$ sanic path.to.server:app
|
$ sanic path.to.server:app
|
||||||
|
|
||||||
If the Sanic instance variable is called 'app', you can leave off the last
|
|
||||||
part, and only provide a path to the module where the instance is:
|
|
||||||
|
|
||||||
$ sanic path.to.server
|
|
||||||
|
|
||||||
Or, a path to a callable that returns a Sanic() instance:
|
Or, a path to a callable that returns a Sanic() instance:
|
||||||
|
|
||||||
$ sanic path.to.factory:create_app
|
$ sanic path.to.factory:create_app --factory
|
||||||
|
|
||||||
Or, a path to a directory to run as a simple HTTP server:
|
Or, a path to a directory to run as a simple HTTP server:
|
||||||
|
|
||||||
$ sanic ./path/to/static
|
$ sanic ./path/to/static --simple
|
||||||
""",
|
""",
|
||||||
prefix=" ",
|
prefix=" ",
|
||||||
)
|
)
|
||||||
@@ -48,7 +46,7 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
self.parser = SanicArgumentParser(
|
self.parser = SanicArgumentParser(
|
||||||
prog="sanic",
|
prog="sanic",
|
||||||
description=self.DESCRIPTION,
|
description=self.DESCRIPTION,
|
||||||
formatter_class=lambda prog: SanicHelpFormatter(
|
formatter_class=lambda prog: RawTextHelpFormatter(
|
||||||
prog,
|
prog,
|
||||||
max_help_position=36 if width > 96 else 24,
|
max_help_position=36 if width > 96 else 24,
|
||||||
indent_increment=4,
|
indent_increment=4,
|
||||||
@@ -60,27 +58,16 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
self.main_process = (
|
self.main_process = (
|
||||||
os.environ.get("SANIC_RELOADER_PROCESS", "") != "true"
|
os.environ.get("SANIC_RELOADER_PROCESS", "") != "true"
|
||||||
)
|
)
|
||||||
self.args: Namespace = Namespace()
|
self.args: List[Any] = []
|
||||||
self.groups: List[Group] = []
|
self.groups: List[Group] = []
|
||||||
self.inspecting = False
|
|
||||||
|
|
||||||
def attach(self):
|
def attach(self):
|
||||||
if len(sys.argv) > 1 and sys.argv[1] == "inspect":
|
|
||||||
self.inspecting = True
|
|
||||||
self.parser.description = get_logo(True)
|
|
||||||
make_inspector_parser(self.parser)
|
|
||||||
return
|
|
||||||
|
|
||||||
for group in Group._registry:
|
for group in Group._registry:
|
||||||
instance = group.create(self.parser)
|
instance = group.create(self.parser)
|
||||||
instance.attach()
|
instance.attach()
|
||||||
self.groups.append(instance)
|
self.groups.append(instance)
|
||||||
|
|
||||||
def run(self, parse_args=None):
|
def run(self, parse_args=None):
|
||||||
if self.inspecting:
|
|
||||||
self._inspector()
|
|
||||||
return
|
|
||||||
|
|
||||||
legacy_version = False
|
legacy_version = False
|
||||||
if not parse_args:
|
if not parse_args:
|
||||||
# This is to provide backwards compat -v to display version
|
# This is to provide backwards compat -v to display version
|
||||||
@@ -99,7 +86,10 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
self.args = self.parser.parse_args(args=parse_args)
|
self.args = self.parser.parse_args(args=parse_args)
|
||||||
self._precheck()
|
self._precheck()
|
||||||
app_loader = AppLoader(
|
app_loader = AppLoader(
|
||||||
self.args.target, self.args.factory, self.args.simple, self.args
|
self.args.module,
|
||||||
|
self.args.factory,
|
||||||
|
self.args.simple,
|
||||||
|
self.args,
|
||||||
)
|
)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -107,47 +97,33 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
kwargs = self._build_run_kwargs()
|
kwargs = self._build_run_kwargs()
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
error_logger.exception(f"Failed to run app: {e}")
|
error_logger.exception(f"Failed to run app: {e}")
|
||||||
|
else:
|
||||||
|
if self.args.inspect or self.args.inspect_raw or self.args.trigger:
|
||||||
|
os.environ["SANIC_IGNORE_PRODUCTION_WARNING"] = "true"
|
||||||
else:
|
else:
|
||||||
for http_version in self.args.http:
|
for http_version in self.args.http:
|
||||||
app.prepare(**kwargs, version=http_version)
|
app.prepare(**kwargs, version=http_version)
|
||||||
|
|
||||||
|
if self.args.inspect or self.args.inspect_raw or self.args.trigger:
|
||||||
|
action = self.args.trigger or (
|
||||||
|
"raw" if self.args.inspect_raw else "pretty"
|
||||||
|
)
|
||||||
|
inspect(
|
||||||
|
app.config.INSPECTOR_HOST,
|
||||||
|
app.config.INSPECTOR_PORT,
|
||||||
|
action,
|
||||||
|
)
|
||||||
|
del os.environ["SANIC_IGNORE_PRODUCTION_WARNING"]
|
||||||
|
return
|
||||||
|
|
||||||
if self.args.single:
|
if self.args.single:
|
||||||
serve = Sanic.serve_single
|
serve = Sanic.serve_single
|
||||||
|
elif self.args.legacy:
|
||||||
|
serve = Sanic.serve_legacy
|
||||||
else:
|
else:
|
||||||
serve = partial(Sanic.serve, app_loader=app_loader)
|
serve = partial(Sanic.serve, app_loader=app_loader)
|
||||||
serve(app)
|
serve(app)
|
||||||
|
|
||||||
def _inspector(self):
|
|
||||||
args = sys.argv[2:]
|
|
||||||
self.args, unknown = self.parser.parse_known_args(args=args)
|
|
||||||
if unknown:
|
|
||||||
for arg in unknown:
|
|
||||||
if arg.startswith("--"):
|
|
||||||
try:
|
|
||||||
key, value = arg.split("=")
|
|
||||||
key = key.lstrip("-")
|
|
||||||
except ValueError:
|
|
||||||
value = False if arg.startswith("--no-") else True
|
|
||||||
key = (
|
|
||||||
arg.replace("--no-", "")
|
|
||||||
.lstrip("-")
|
|
||||||
.replace("-", "_")
|
|
||||||
)
|
|
||||||
setattr(self.args, key, value)
|
|
||||||
|
|
||||||
kwargs = {**self.args.__dict__}
|
|
||||||
host = kwargs.pop("host")
|
|
||||||
port = kwargs.pop("port")
|
|
||||||
secure = kwargs.pop("secure")
|
|
||||||
raw = kwargs.pop("raw")
|
|
||||||
action = kwargs.pop("action") or "info"
|
|
||||||
api_key = kwargs.pop("api_key")
|
|
||||||
positional = kwargs.pop("positional", None)
|
|
||||||
if action == "<custom>" and positional:
|
|
||||||
action = positional[0]
|
|
||||||
if len(positional) > 1:
|
|
||||||
kwargs["args"] = positional[1:]
|
|
||||||
InspectorClient(host, port, secure, raw, api_key).do(action, **kwargs)
|
|
||||||
|
|
||||||
def _precheck(self):
|
def _precheck(self):
|
||||||
# Custom TLS mismatch handling for better diagnostics
|
# Custom TLS mismatch handling for better diagnostics
|
||||||
if self.main_process and (
|
if self.main_process and (
|
||||||
@@ -169,6 +145,8 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
)
|
)
|
||||||
error_logger.error(message)
|
error_logger.error(message)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
if self.args.inspect or self.args.inspect_raw:
|
||||||
|
logging.disable(logging.CRITICAL)
|
||||||
|
|
||||||
def _get_app(self, app_loader: AppLoader):
|
def _get_app(self, app_loader: AppLoader):
|
||||||
try:
|
try:
|
||||||
@@ -180,10 +158,6 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
" Example File: project/sanic_server.py -> app\n"
|
" Example File: project/sanic_server.py -> app\n"
|
||||||
" Example Module: project.sanic_server.app"
|
" Example Module: project.sanic_server.app"
|
||||||
)
|
)
|
||||||
error_logger.error(
|
|
||||||
"\nThe error below might have caused the above one:\n"
|
|
||||||
f"{e.msg}"
|
|
||||||
)
|
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
else:
|
else:
|
||||||
raise e
|
raise e
|
||||||
@@ -220,6 +194,7 @@ Or, a path to a directory to run as a simple HTTP server:
|
|||||||
"workers": self.args.workers,
|
"workers": self.args.workers,
|
||||||
"auto_tls": self.args.auto_tls,
|
"auto_tls": self.args.auto_tls,
|
||||||
"single_process": self.args.single,
|
"single_process": self.args.single,
|
||||||
|
"legacy": self.args.legacy,
|
||||||
}
|
}
|
||||||
|
|
||||||
for maybe_arg in ("auto_reload", "dev"):
|
for maybe_arg in ("auto_reload", "dev"):
|
||||||
|
|||||||
@@ -57,15 +57,11 @@ class GeneralGroup(Group):
|
|||||||
)
|
)
|
||||||
|
|
||||||
self.container.add_argument(
|
self.container.add_argument(
|
||||||
"target",
|
"module",
|
||||||
help=(
|
help=(
|
||||||
"Path to your Sanic app instance.\n"
|
"Path to your Sanic app. Example: path.to.server:app\n"
|
||||||
"\tExample: path.to.server:app\n"
|
"If running a Simple Server, path to directory to serve. "
|
||||||
"If running a Simple Server, path to directory to serve.\n"
|
"Example: ./\n"
|
||||||
"\tExample: ./\n"
|
|
||||||
"Additionally, this can be a path to a factory function\n"
|
|
||||||
"that returns a Sanic app instance.\n"
|
|
||||||
"\tExample: path.to.server:create_app\n"
|
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -93,6 +89,32 @@ class ApplicationGroup(Group):
|
|||||||
"a directory\n(module arg should be a path)"
|
"a directory\n(module arg should be a path)"
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
group.add_argument(
|
||||||
|
"--inspect",
|
||||||
|
dest="inspect",
|
||||||
|
action="store_true",
|
||||||
|
help=("Inspect the state of a running instance, human readable"),
|
||||||
|
)
|
||||||
|
group.add_argument(
|
||||||
|
"--inspect-raw",
|
||||||
|
dest="inspect_raw",
|
||||||
|
action="store_true",
|
||||||
|
help=("Inspect the state of a running instance, JSON output"),
|
||||||
|
)
|
||||||
|
group.add_argument(
|
||||||
|
"--trigger-reload",
|
||||||
|
dest="trigger",
|
||||||
|
action="store_const",
|
||||||
|
const="reload",
|
||||||
|
help=("Trigger worker processes to reload"),
|
||||||
|
)
|
||||||
|
group.add_argument(
|
||||||
|
"--trigger-shutdown",
|
||||||
|
dest="trigger",
|
||||||
|
action="store_const",
|
||||||
|
const="shutdown",
|
||||||
|
help=("Trigger all processes to shutdown"),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class HTTPVersionGroup(Group):
|
class HTTPVersionGroup(Group):
|
||||||
@@ -221,6 +243,11 @@ class WorkerGroup(Group):
|
|||||||
action="store_true",
|
action="store_true",
|
||||||
help="Do not use multiprocessing, run server in a single process",
|
help="Do not use multiprocessing, run server in a single process",
|
||||||
)
|
)
|
||||||
|
self.container.add_argument(
|
||||||
|
"--legacy",
|
||||||
|
action="store_true",
|
||||||
|
help="Use the legacy server manager",
|
||||||
|
)
|
||||||
self.add_bool_arguments(
|
self.add_bool_arguments(
|
||||||
"--access-logs",
|
"--access-logs",
|
||||||
dest="access_log",
|
dest="access_log",
|
||||||
|
|||||||
@@ -1,35 +0,0 @@
|
|||||||
from argparse import (
|
|
||||||
SUPPRESS,
|
|
||||||
Action,
|
|
||||||
ArgumentParser,
|
|
||||||
RawTextHelpFormatter,
|
|
||||||
_SubParsersAction,
|
|
||||||
)
|
|
||||||
from typing import Any
|
|
||||||
|
|
||||||
|
|
||||||
class SanicArgumentParser(ArgumentParser):
|
|
||||||
def _check_value(self, action: Action, value: Any) -> None:
|
|
||||||
if isinstance(action, SanicSubParsersAction):
|
|
||||||
return
|
|
||||||
super()._check_value(action, value)
|
|
||||||
|
|
||||||
|
|
||||||
class SanicHelpFormatter(RawTextHelpFormatter):
|
|
||||||
def add_usage(self, usage, actions, groups, prefix=None):
|
|
||||||
if not usage:
|
|
||||||
usage = SUPPRESS
|
|
||||||
# Add one linebreak, but not two
|
|
||||||
self.add_text("\x1b[1A")
|
|
||||||
super().add_usage(usage, actions, groups, prefix)
|
|
||||||
|
|
||||||
|
|
||||||
class SanicSubParsersAction(_SubParsersAction):
|
|
||||||
def __call__(self, parser, namespace, values, option_string=None):
|
|
||||||
self._name_parser_map
|
|
||||||
parser_name = values[0]
|
|
||||||
if parser_name not in self._name_parser_map:
|
|
||||||
self._name_parser_map[parser_name] = parser
|
|
||||||
values = ["<custom>", *values]
|
|
||||||
|
|
||||||
super().__call__(parser, namespace, values, option_string)
|
|
||||||
@@ -1,105 +0,0 @@
|
|||||||
from argparse import ArgumentParser
|
|
||||||
|
|
||||||
from sanic.application.logo import get_logo
|
|
||||||
from sanic.cli.base import SanicHelpFormatter, SanicSubParsersAction
|
|
||||||
|
|
||||||
|
|
||||||
def _add_shared(parser: ArgumentParser) -> None:
|
|
||||||
parser.add_argument(
|
|
||||||
"--host",
|
|
||||||
"-H",
|
|
||||||
default="localhost",
|
|
||||||
help="Inspector host address [default 127.0.0.1]",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--port",
|
|
||||||
"-p",
|
|
||||||
default=6457,
|
|
||||||
type=int,
|
|
||||||
help="Inspector port [default 6457]",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--secure",
|
|
||||||
"-s",
|
|
||||||
action="store_true",
|
|
||||||
help="Whether to access the Inspector via TLS encryption",
|
|
||||||
)
|
|
||||||
parser.add_argument("--api-key", "-k", help="Inspector authentication key")
|
|
||||||
parser.add_argument(
|
|
||||||
"--raw",
|
|
||||||
action="store_true",
|
|
||||||
help="Whether to output the raw response information",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class InspectorSubParser(ArgumentParser):
|
|
||||||
def __init__(self, *args, **kwargs):
|
|
||||||
super().__init__(*args, **kwargs)
|
|
||||||
_add_shared(self)
|
|
||||||
if not self.description:
|
|
||||||
self.description = ""
|
|
||||||
self.description = get_logo(True) + self.description
|
|
||||||
|
|
||||||
|
|
||||||
def make_inspector_parser(parser: ArgumentParser) -> None:
|
|
||||||
_add_shared(parser)
|
|
||||||
subparsers = parser.add_subparsers(
|
|
||||||
action=SanicSubParsersAction,
|
|
||||||
dest="action",
|
|
||||||
description=(
|
|
||||||
"Run one or none of the below subcommands. Using inspect without "
|
|
||||||
"a subcommand will fetch general information about the state "
|
|
||||||
"of the application instance.\n\n"
|
|
||||||
"Or, you can optionally follow inspect with a subcommand. "
|
|
||||||
"If you have created a custom "
|
|
||||||
"Inspector instance, then you can run custom commands. See "
|
|
||||||
"https://sanic.dev/en/guide/deployment/inspector.html "
|
|
||||||
"for more details."
|
|
||||||
),
|
|
||||||
title=" Subcommands",
|
|
||||||
parser_class=InspectorSubParser,
|
|
||||||
)
|
|
||||||
reloader = subparsers.add_parser(
|
|
||||||
"reload",
|
|
||||||
help="Trigger a reload of the server workers",
|
|
||||||
formatter_class=SanicHelpFormatter,
|
|
||||||
)
|
|
||||||
reloader.add_argument(
|
|
||||||
"--zero-downtime",
|
|
||||||
action="store_true",
|
|
||||||
help=(
|
|
||||||
"Whether to wait for the new process to be online before "
|
|
||||||
"terminating the old"
|
|
||||||
),
|
|
||||||
)
|
|
||||||
subparsers.add_parser(
|
|
||||||
"shutdown",
|
|
||||||
help="Shutdown the application and all processes",
|
|
||||||
formatter_class=SanicHelpFormatter,
|
|
||||||
)
|
|
||||||
scale = subparsers.add_parser(
|
|
||||||
"scale",
|
|
||||||
help="Scale the number of workers",
|
|
||||||
formatter_class=SanicHelpFormatter,
|
|
||||||
)
|
|
||||||
scale.add_argument(
|
|
||||||
"replicas",
|
|
||||||
type=int,
|
|
||||||
help="Number of workers requested",
|
|
||||||
)
|
|
||||||
|
|
||||||
custom = subparsers.add_parser(
|
|
||||||
"<custom>",
|
|
||||||
help="Run a custom command",
|
|
||||||
description=(
|
|
||||||
"keyword arguments:\n When running a custom command, you can "
|
|
||||||
"add keyword arguments by appending them to your command\n\n"
|
|
||||||
"\tsanic inspect foo --one=1 --two=2"
|
|
||||||
),
|
|
||||||
formatter_class=SanicHelpFormatter,
|
|
||||||
)
|
|
||||||
custom.add_argument(
|
|
||||||
"positional",
|
|
||||||
nargs="*",
|
|
||||||
help="Add one or more non-keyword args to your custom command",
|
|
||||||
)
|
|
||||||
@@ -1,119 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from http.client import RemoteDisconnected
|
|
||||||
from textwrap import indent
|
|
||||||
from typing import Any, Dict, Optional
|
|
||||||
from urllib.error import URLError
|
|
||||||
from urllib.request import Request as URequest
|
|
||||||
from urllib.request import urlopen
|
|
||||||
|
|
||||||
from sanic.application.logo import get_logo
|
|
||||||
from sanic.application.motd import MOTDTTY
|
|
||||||
from sanic.log import Colors
|
|
||||||
|
|
||||||
|
|
||||||
try: # no cov
|
|
||||||
from ujson import dumps, loads
|
|
||||||
except ModuleNotFoundError: # no cov
|
|
||||||
from json import dumps, loads # type: ignore
|
|
||||||
|
|
||||||
|
|
||||||
class InspectorClient:
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
host: str,
|
|
||||||
port: int,
|
|
||||||
secure: bool,
|
|
||||||
raw: bool,
|
|
||||||
api_key: Optional[str],
|
|
||||||
) -> None:
|
|
||||||
self.scheme = "https" if secure else "http"
|
|
||||||
self.host = host
|
|
||||||
self.port = port
|
|
||||||
self.raw = raw
|
|
||||||
self.api_key = api_key
|
|
||||||
|
|
||||||
for scheme in ("http", "https"):
|
|
||||||
full = f"{scheme}://"
|
|
||||||
if self.host.startswith(full):
|
|
||||||
self.scheme = scheme
|
|
||||||
self.host = self.host[len(full) :] # noqa E203
|
|
||||||
|
|
||||||
def do(self, action: str, **kwargs: Any) -> None:
|
|
||||||
if action == "info":
|
|
||||||
self.info()
|
|
||||||
return
|
|
||||||
result = self.request(action, **kwargs).get("result")
|
|
||||||
if result:
|
|
||||||
out = (
|
|
||||||
dumps(result)
|
|
||||||
if isinstance(result, (list, dict))
|
|
||||||
else str(result)
|
|
||||||
)
|
|
||||||
sys.stdout.write(out + "\n")
|
|
||||||
|
|
||||||
def info(self) -> None:
|
|
||||||
out = sys.stdout.write
|
|
||||||
response = self.request("", "GET")
|
|
||||||
if self.raw or not response:
|
|
||||||
return
|
|
||||||
data = response["result"]
|
|
||||||
display = data.pop("info")
|
|
||||||
extra = display.pop("extra", {})
|
|
||||||
display["packages"] = ", ".join(display["packages"])
|
|
||||||
MOTDTTY(get_logo(), self.base_url, display, extra).display(
|
|
||||||
version=False,
|
|
||||||
action="Inspecting",
|
|
||||||
out=out,
|
|
||||||
)
|
|
||||||
for name, info in data["workers"].items():
|
|
||||||
info = "\n".join(
|
|
||||||
f"\t{key}: {Colors.BLUE}{value}{Colors.END}"
|
|
||||||
for key, value in info.items()
|
|
||||||
)
|
|
||||||
out(
|
|
||||||
"\n"
|
|
||||||
+ indent(
|
|
||||||
"\n".join(
|
|
||||||
[
|
|
||||||
f"{Colors.BOLD}{Colors.SANIC}{name}{Colors.END}",
|
|
||||||
info,
|
|
||||||
]
|
|
||||||
),
|
|
||||||
" ",
|
|
||||||
)
|
|
||||||
+ "\n"
|
|
||||||
)
|
|
||||||
|
|
||||||
def request(self, action: str, method: str = "POST", **kwargs: Any) -> Any:
|
|
||||||
url = f"{self.base_url}/{action}"
|
|
||||||
params: Dict[str, Any] = {"method": method, "headers": {}}
|
|
||||||
if kwargs:
|
|
||||||
params["data"] = dumps(kwargs).encode()
|
|
||||||
params["headers"]["content-type"] = "application/json"
|
|
||||||
if self.api_key:
|
|
||||||
params["headers"]["authorization"] = f"Bearer {self.api_key}"
|
|
||||||
request = URequest(url, **params)
|
|
||||||
|
|
||||||
try:
|
|
||||||
with urlopen(request) as response: # nosec B310
|
|
||||||
raw = response.read()
|
|
||||||
loaded = loads(raw)
|
|
||||||
if self.raw:
|
|
||||||
sys.stdout.write(dumps(loaded.get("result")) + "\n")
|
|
||||||
return {}
|
|
||||||
return loaded
|
|
||||||
except (URLError, RemoteDisconnected) as e:
|
|
||||||
sys.stderr.write(
|
|
||||||
f"{Colors.RED}Could not connect to inspector at: "
|
|
||||||
f"{Colors.YELLOW}{self.base_url}{Colors.END}\n"
|
|
||||||
"Either the application is not running, or it did not start "
|
|
||||||
f"an inspector instance.\n{e}\n"
|
|
||||||
)
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def base_url(self):
|
|
||||||
return f"{self.scheme}://{self.host}:{self.port}"
|
|
||||||
@@ -1,30 +1,15 @@
|
|||||||
import asyncio
|
import asyncio
|
||||||
import os
|
import os
|
||||||
import platform
|
|
||||||
import signal
|
import signal
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from contextlib import contextmanager
|
|
||||||
from enum import Enum
|
from enum import Enum
|
||||||
from typing import Awaitable, Union
|
from typing import Awaitable
|
||||||
|
|
||||||
from multidict import CIMultiDict # type: ignore
|
from multidict import CIMultiDict # type: ignore
|
||||||
|
|
||||||
from sanic.helpers import Default
|
|
||||||
from sanic.log import error_logger
|
|
||||||
|
|
||||||
|
|
||||||
if sys.version_info < (3, 8): # no cov
|
|
||||||
StartMethod = Union[Default, str]
|
|
||||||
else: # no cov
|
|
||||||
from typing import Literal
|
|
||||||
|
|
||||||
StartMethod = Union[
|
|
||||||
Default, Literal["fork"], Literal["forkserver"], Literal["spawn"]
|
|
||||||
]
|
|
||||||
|
|
||||||
OS_IS_WINDOWS = os.name == "nt"
|
OS_IS_WINDOWS = os.name == "nt"
|
||||||
PYPY_IMPLEMENTATION = platform.python_implementation() == "PyPy"
|
|
||||||
UVLOOP_INSTALLED = False
|
UVLOOP_INSTALLED = False
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -34,6 +19,7 @@ try:
|
|||||||
except ImportError:
|
except ImportError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
# Python 3.11 changed the way Enum formatting works for mixed-in types.
|
# Python 3.11 changed the way Enum formatting works for mixed-in types.
|
||||||
if sys.version_info < (3, 11, 0):
|
if sys.version_info < (3, 11, 0):
|
||||||
|
|
||||||
@@ -59,16 +45,6 @@ class UpperStrEnum(StrEnum):
|
|||||||
return self.value
|
return self.value
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def use_context(method: StartMethod):
|
|
||||||
from sanic import Sanic
|
|
||||||
|
|
||||||
orig = Sanic.start_method
|
|
||||||
Sanic.start_method = method
|
|
||||||
yield
|
|
||||||
Sanic.start_method = orig
|
|
||||||
|
|
||||||
|
|
||||||
def enable_windows_color_support():
|
def enable_windows_color_support():
|
||||||
import ctypes
|
import ctypes
|
||||||
|
|
||||||
@@ -76,38 +52,6 @@ def enable_windows_color_support():
|
|||||||
kernel.SetConsoleMode(kernel.GetStdHandle(-11), 7)
|
kernel.SetConsoleMode(kernel.GetStdHandle(-11), 7)
|
||||||
|
|
||||||
|
|
||||||
def pypy_os_module_patch() -> None:
|
|
||||||
"""
|
|
||||||
The PyPy os module is missing the 'readlink' function, which causes issues
|
|
||||||
withaiofiles. This workaround replaces the missing 'readlink' function
|
|
||||||
with 'os.path.realpath', which serves the same purpose.
|
|
||||||
"""
|
|
||||||
if hasattr(os, "readlink"):
|
|
||||||
error_logger.warning(
|
|
||||||
"PyPy: Skipping patching of the os module as it appears the "
|
|
||||||
"'readlink' function has been added."
|
|
||||||
)
|
|
||||||
return
|
|
||||||
|
|
||||||
module = sys.modules["os"]
|
|
||||||
module.readlink = os.path.realpath # type: ignore
|
|
||||||
|
|
||||||
|
|
||||||
def pypy_windows_set_console_cp_patch() -> None:
|
|
||||||
"""
|
|
||||||
A patch function for PyPy on Windows that sets the console code page to
|
|
||||||
UTF-8 encodingto allow for proper handling of non-ASCII characters. This
|
|
||||||
function uses ctypes to call the Windows API functions SetConsoleCP and
|
|
||||||
SetConsoleOutputCP to set the code page.
|
|
||||||
"""
|
|
||||||
from ctypes import windll # type: ignore
|
|
||||||
|
|
||||||
code: int = windll.kernel32.GetConsoleOutputCP()
|
|
||||||
if code != 65001:
|
|
||||||
windll.kernel32.SetConsoleCP(65001)
|
|
||||||
windll.kernel32.SetConsoleOutputCP(65001)
|
|
||||||
|
|
||||||
|
|
||||||
class Header(CIMultiDict):
|
class Header(CIMultiDict):
|
||||||
"""
|
"""
|
||||||
Container used for both request and response headers. It is a subclass of
|
Container used for both request and response headers. It is a subclass of
|
||||||
@@ -121,13 +65,7 @@ class Header(CIMultiDict):
|
|||||||
<https://multidict.readthedocs.io/en/stable/multidict.html#multidict>`_
|
<https://multidict.readthedocs.io/en/stable/multidict.html#multidict>`_
|
||||||
for more details about how to use the object. In general, it should work
|
for more details about how to use the object. In general, it should work
|
||||||
very similar to a regular dictionary.
|
very similar to a regular dictionary.
|
||||||
""" # noqa: E501
|
"""
|
||||||
|
|
||||||
def __getattr__(self, key: str) -> str:
|
|
||||||
if key.startswith("_"):
|
|
||||||
return self.__getattribute__(key)
|
|
||||||
key = key.rstrip("_").replace("_", "-")
|
|
||||||
return ",".join(self.getall(key, default=[]))
|
|
||||||
|
|
||||||
def get_all(self, key: str):
|
def get_all(self, key: str):
|
||||||
"""
|
"""
|
||||||
@@ -147,12 +85,6 @@ if use_trio: # pragma: no cover
|
|||||||
open_async = trio.open_file
|
open_async = trio.open_file
|
||||||
CancelledErrors = tuple([asyncio.CancelledError, trio.Cancelled])
|
CancelledErrors = tuple([asyncio.CancelledError, trio.Cancelled])
|
||||||
else:
|
else:
|
||||||
if PYPY_IMPLEMENTATION:
|
|
||||||
pypy_os_module_patch()
|
|
||||||
|
|
||||||
if OS_IS_WINDOWS:
|
|
||||||
pypy_windows_set_console_cp_patch()
|
|
||||||
|
|
||||||
from aiofiles import open as aio_open # type: ignore
|
from aiofiles import open as aio_open # type: ignore
|
||||||
from aiofiles.os import stat as stat_async # type: ignore # noqa: F401
|
from aiofiles.os import stat as stat_async # type: ignore # noqa: F401
|
||||||
|
|
||||||
@@ -184,3 +116,7 @@ def ctrlc_workaround_for_windows(app):
|
|||||||
die = False
|
die = False
|
||||||
signal.signal(signal.SIGINT, ctrlc_handler)
|
signal.signal(signal.SIGINT, ctrlc_handler)
|
||||||
app.add_task(stay_active)
|
app.add_task(stay_active)
|
||||||
|
|
||||||
|
|
||||||
|
def is_atty() -> bool:
|
||||||
|
return bool(sys.stdout and sys.stdout.isatty())
|
||||||
|
|||||||
@@ -2,14 +2,13 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from abc import ABCMeta
|
|
||||||
from inspect import getmembers, isclass, isdatadescriptor
|
from inspect import getmembers, isclass, isdatadescriptor
|
||||||
from os import environ
|
from os import environ
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, Callable, Dict, Optional, Sequence, Union
|
from typing import Any, Callable, Dict, Optional, Sequence, Union
|
||||||
from warnings import filterwarnings
|
from warnings import filterwarnings
|
||||||
|
|
||||||
from sanic.constants import LocalCertCreator
|
from sanic.constants import LocalCertCreator, RestartOrder
|
||||||
from sanic.errorpages import DEFAULT_FORMAT, check_error_format
|
from sanic.errorpages import DEFAULT_FORMAT, check_error_format
|
||||||
from sanic.helpers import Default, _default
|
from sanic.helpers import Default, _default
|
||||||
from sanic.http import Http
|
from sanic.http import Http
|
||||||
@@ -43,14 +42,11 @@ DEFAULT_CONFIG = {
|
|||||||
"DEPRECATION_FILTER": "once",
|
"DEPRECATION_FILTER": "once",
|
||||||
"FORWARDED_FOR_HEADER": "X-Forwarded-For",
|
"FORWARDED_FOR_HEADER": "X-Forwarded-For",
|
||||||
"FORWARDED_SECRET": None,
|
"FORWARDED_SECRET": None,
|
||||||
"GRACEFUL_SHUTDOWN_TIMEOUT": 15.0,
|
"GRACEFUL_SHUTDOWN_TIMEOUT": 15.0, # 15 sec
|
||||||
"INSPECTOR": False,
|
"INSPECTOR": False,
|
||||||
"INSPECTOR_HOST": "localhost",
|
"INSPECTOR_HOST": "localhost",
|
||||||
"INSPECTOR_PORT": 6457,
|
"INSPECTOR_PORT": 6457,
|
||||||
"INSPECTOR_TLS_KEY": _default,
|
"KEEP_ALIVE_TIMEOUT": 5, # 5 seconds
|
||||||
"INSPECTOR_TLS_CERT": _default,
|
|
||||||
"INSPECTOR_API_KEY": "",
|
|
||||||
"KEEP_ALIVE_TIMEOUT": 120,
|
|
||||||
"KEEP_ALIVE": True,
|
"KEEP_ALIVE": True,
|
||||||
"LOCAL_CERT_CREATOR": LocalCertCreator.AUTO,
|
"LOCAL_CERT_CREATOR": LocalCertCreator.AUTO,
|
||||||
"LOCAL_TLS_KEY": _default,
|
"LOCAL_TLS_KEY": _default,
|
||||||
@@ -61,22 +57,23 @@ DEFAULT_CONFIG = {
|
|||||||
"NOISY_EXCEPTIONS": False,
|
"NOISY_EXCEPTIONS": False,
|
||||||
"PROXIES_COUNT": None,
|
"PROXIES_COUNT": None,
|
||||||
"REAL_IP_HEADER": None,
|
"REAL_IP_HEADER": None,
|
||||||
"REQUEST_BUFFER_SIZE": 65536,
|
"REQUEST_BUFFER_SIZE": 65536, # 64 KiB
|
||||||
"REQUEST_MAX_HEADER_SIZE": 8192, # Cannot exceed 16384
|
"REQUEST_MAX_HEADER_SIZE": 8192, # 8 KiB, but cannot exceed 16384
|
||||||
"REQUEST_ID_HEADER": "X-Request-ID",
|
"REQUEST_ID_HEADER": "X-Request-ID",
|
||||||
"REQUEST_MAX_SIZE": 100_000_000,
|
"REQUEST_MAX_SIZE": 100000000, # 100 megabytes
|
||||||
"REQUEST_TIMEOUT": 60,
|
"REQUEST_TIMEOUT": 60, # 60 seconds
|
||||||
"RESPONSE_TIMEOUT": 60,
|
"RESPONSE_TIMEOUT": 60, # 60 seconds
|
||||||
|
"RESTART_ORDER": RestartOrder.SHUTDOWN_FIRST,
|
||||||
"TLS_CERT_PASSWORD": "",
|
"TLS_CERT_PASSWORD": "",
|
||||||
"TOUCHUP": _default,
|
"TOUCHUP": _default,
|
||||||
"USE_UVLOOP": _default,
|
"USE_UVLOOP": _default,
|
||||||
"WEBSOCKET_MAX_SIZE": 2**20, # 1 MiB
|
"WEBSOCKET_MAX_SIZE": 2**20, # 1 megabyte
|
||||||
"WEBSOCKET_PING_INTERVAL": 20,
|
"WEBSOCKET_PING_INTERVAL": 20,
|
||||||
"WEBSOCKET_PING_TIMEOUT": 20,
|
"WEBSOCKET_PING_TIMEOUT": 20,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
class DescriptorMeta(ABCMeta):
|
class DescriptorMeta(type):
|
||||||
def __init__(cls, *_):
|
def __init__(cls, *_):
|
||||||
cls.__setters__ = {name for name, _ in getmembers(cls, cls._is_setter)}
|
cls.__setters__ = {name for name, _ in getmembers(cls, cls._is_setter)}
|
||||||
|
|
||||||
@@ -97,9 +94,6 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
INSPECTOR: bool
|
INSPECTOR: bool
|
||||||
INSPECTOR_HOST: str
|
INSPECTOR_HOST: str
|
||||||
INSPECTOR_PORT: int
|
INSPECTOR_PORT: int
|
||||||
INSPECTOR_TLS_KEY: Union[Path, str, Default]
|
|
||||||
INSPECTOR_TLS_CERT: Union[Path, str, Default]
|
|
||||||
INSPECTOR_API_KEY: str
|
|
||||||
KEEP_ALIVE_TIMEOUT: int
|
KEEP_ALIVE_TIMEOUT: int
|
||||||
KEEP_ALIVE: bool
|
KEEP_ALIVE: bool
|
||||||
LOCAL_CERT_CREATOR: Union[str, LocalCertCreator]
|
LOCAL_CERT_CREATOR: Union[str, LocalCertCreator]
|
||||||
@@ -117,6 +111,7 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
REQUEST_MAX_SIZE: int
|
REQUEST_MAX_SIZE: int
|
||||||
REQUEST_TIMEOUT: int
|
REQUEST_TIMEOUT: int
|
||||||
RESPONSE_TIMEOUT: int
|
RESPONSE_TIMEOUT: int
|
||||||
|
RESTART_ORDER: Union[str, RestartOrder]
|
||||||
SERVER_NAME: str
|
SERVER_NAME: str
|
||||||
TLS_CERT_PASSWORD: str
|
TLS_CERT_PASSWORD: str
|
||||||
TOUCHUP: Union[Default, bool]
|
TOUCHUP: Union[Default, bool]
|
||||||
@@ -127,9 +122,7 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
defaults: Optional[
|
defaults: Dict[str, Union[str, bool, int, float, None]] = None,
|
||||||
Dict[str, Union[str, bool, int, float, None]]
|
|
||||||
] = None,
|
|
||||||
env_prefix: Optional[str] = SANIC_PREFIX,
|
env_prefix: Optional[str] = SANIC_PREFIX,
|
||||||
keep_alive: Optional[bool] = None,
|
keep_alive: Optional[bool] = None,
|
||||||
*,
|
*,
|
||||||
@@ -203,6 +196,10 @@ class Config(dict, metaclass=DescriptorMeta):
|
|||||||
self.LOCAL_CERT_CREATOR = LocalCertCreator[
|
self.LOCAL_CERT_CREATOR = LocalCertCreator[
|
||||||
self.LOCAL_CERT_CREATOR.upper()
|
self.LOCAL_CERT_CREATOR.upper()
|
||||||
]
|
]
|
||||||
|
elif attr == "RESTART_ORDER" and not isinstance(
|
||||||
|
self.RESTART_ORDER, RestartOrder
|
||||||
|
):
|
||||||
|
self.RESTART_ORDER = RestartOrder[self.RESTART_ORDER.upper()]
|
||||||
elif attr == "DEPRECATION_FILTER":
|
elif attr == "DEPRECATION_FILTER":
|
||||||
self._configure_warnings()
|
self._configure_warnings()
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ from sanic.compat import UpperStrEnum
|
|||||||
|
|
||||||
|
|
||||||
class HTTPMethod(UpperStrEnum):
|
class HTTPMethod(UpperStrEnum):
|
||||||
|
|
||||||
GET = auto()
|
GET = auto()
|
||||||
POST = auto()
|
POST = auto()
|
||||||
PUT = auto()
|
PUT = auto()
|
||||||
@@ -14,11 +15,18 @@ class HTTPMethod(UpperStrEnum):
|
|||||||
|
|
||||||
|
|
||||||
class LocalCertCreator(UpperStrEnum):
|
class LocalCertCreator(UpperStrEnum):
|
||||||
|
|
||||||
AUTO = auto()
|
AUTO = auto()
|
||||||
TRUSTME = auto()
|
TRUSTME = auto()
|
||||||
MKCERT = auto()
|
MKCERT = auto()
|
||||||
|
|
||||||
|
|
||||||
|
class RestartOrder(UpperStrEnum):
|
||||||
|
|
||||||
|
SHUTDOWN_FIRST = auto()
|
||||||
|
STARTUP_FIRST = auto()
|
||||||
|
|
||||||
|
|
||||||
HTTP_METHODS = tuple(HTTPMethod.__members__.values())
|
HTTP_METHODS = tuple(HTTPMethod.__members__.values())
|
||||||
SAFE_HTTP_METHODS = (HTTPMethod.GET, HTTPMethod.HEAD, HTTPMethod.OPTIONS)
|
SAFE_HTTP_METHODS = (HTTPMethod.GET, HTTPMethod.HEAD, HTTPMethod.OPTIONS)
|
||||||
IDEMPOTENT_HTTP_METHODS = (
|
IDEMPOTENT_HTTP_METHODS = (
|
||||||
|
|||||||
156
sanic/cookies.py
Normal file
156
sanic/cookies.py
Normal file
@@ -0,0 +1,156 @@
|
|||||||
|
import re
|
||||||
|
import string
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
from typing import Dict
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_MAX_AGE = 0
|
||||||
|
|
||||||
|
# ------------------------------------------------------------ #
|
||||||
|
# SimpleCookie
|
||||||
|
# ------------------------------------------------------------ #
|
||||||
|
|
||||||
|
# Straight up copied this section of dark magic from SimpleCookie
|
||||||
|
|
||||||
|
_LegalChars = string.ascii_letters + string.digits + "!#$%&'*+-.^_`|~:"
|
||||||
|
_UnescapedChars = _LegalChars + " ()/<=>?@[]{}"
|
||||||
|
|
||||||
|
_Translator = {
|
||||||
|
n: "\\%03o" % n for n in set(range(256)) - set(map(ord, _UnescapedChars))
|
||||||
|
}
|
||||||
|
_Translator.update({ord('"'): '\\"', ord("\\"): "\\\\"})
|
||||||
|
|
||||||
|
|
||||||
|
def _quote(str):
|
||||||
|
r"""Quote a string for use in a cookie header.
|
||||||
|
If the string does not need to be double-quoted, then just return the
|
||||||
|
string. Otherwise, surround the string in doublequotes and quote
|
||||||
|
(with a \) special characters.
|
||||||
|
"""
|
||||||
|
if str is None or _is_legal_key(str):
|
||||||
|
return str
|
||||||
|
else:
|
||||||
|
return '"' + str.translate(_Translator) + '"'
|
||||||
|
|
||||||
|
|
||||||
|
_is_legal_key = re.compile("[%s]+" % re.escape(_LegalChars)).fullmatch
|
||||||
|
|
||||||
|
# ------------------------------------------------------------ #
|
||||||
|
# Custom SimpleCookie
|
||||||
|
# ------------------------------------------------------------ #
|
||||||
|
|
||||||
|
|
||||||
|
class CookieJar(dict):
|
||||||
|
"""
|
||||||
|
CookieJar dynamically writes headers as cookies are added and removed
|
||||||
|
It gets around the limitation of one header per name by using the
|
||||||
|
MultiHeader class to provide a unique key that encodes to Set-Cookie.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, headers):
|
||||||
|
super().__init__()
|
||||||
|
self.headers: Dict[str, str] = headers
|
||||||
|
self.cookie_headers: Dict[str, str] = {}
|
||||||
|
self.header_key: str = "Set-Cookie"
|
||||||
|
|
||||||
|
def __setitem__(self, key, value):
|
||||||
|
# If this cookie doesn't exist, add it to the header keys
|
||||||
|
if not self.cookie_headers.get(key):
|
||||||
|
cookie = Cookie(key, value)
|
||||||
|
cookie["path"] = "/"
|
||||||
|
self.cookie_headers[key] = self.header_key
|
||||||
|
self.headers.add(self.header_key, cookie)
|
||||||
|
return super().__setitem__(key, cookie)
|
||||||
|
else:
|
||||||
|
self[key].value = value
|
||||||
|
|
||||||
|
def __delitem__(self, key):
|
||||||
|
if key not in self.cookie_headers:
|
||||||
|
self[key] = ""
|
||||||
|
self[key]["max-age"] = 0
|
||||||
|
else:
|
||||||
|
cookie_header = self.cookie_headers[key]
|
||||||
|
# remove it from header
|
||||||
|
cookies = self.headers.popall(cookie_header)
|
||||||
|
for cookie in cookies:
|
||||||
|
if cookie.key != key:
|
||||||
|
self.headers.add(cookie_header, cookie)
|
||||||
|
del self.cookie_headers[key]
|
||||||
|
return super().__delitem__(key)
|
||||||
|
|
||||||
|
|
||||||
|
class Cookie(dict):
|
||||||
|
"""A stripped down version of Morsel from SimpleCookie #gottagofast"""
|
||||||
|
|
||||||
|
_keys = {
|
||||||
|
"expires": "expires",
|
||||||
|
"path": "Path",
|
||||||
|
"comment": "Comment",
|
||||||
|
"domain": "Domain",
|
||||||
|
"max-age": "Max-Age",
|
||||||
|
"secure": "Secure",
|
||||||
|
"httponly": "HttpOnly",
|
||||||
|
"version": "Version",
|
||||||
|
"samesite": "SameSite",
|
||||||
|
}
|
||||||
|
_flags = {"secure", "httponly"}
|
||||||
|
|
||||||
|
def __init__(self, key, value):
|
||||||
|
if key in self._keys:
|
||||||
|
raise KeyError("Cookie name is a reserved word")
|
||||||
|
if not _is_legal_key(key):
|
||||||
|
raise KeyError("Cookie key contains illegal characters")
|
||||||
|
self.key = key
|
||||||
|
self.value = value
|
||||||
|
super().__init__()
|
||||||
|
|
||||||
|
def __setitem__(self, key, value):
|
||||||
|
if key not in self._keys:
|
||||||
|
raise KeyError("Unknown cookie property")
|
||||||
|
if value is not False:
|
||||||
|
if key.lower() == "max-age":
|
||||||
|
if not str(value).isdigit():
|
||||||
|
raise ValueError("Cookie max-age must be an integer")
|
||||||
|
elif key.lower() == "expires":
|
||||||
|
if not isinstance(value, datetime):
|
||||||
|
raise TypeError(
|
||||||
|
"Cookie 'expires' property must be a datetime"
|
||||||
|
)
|
||||||
|
return super().__setitem__(key, value)
|
||||||
|
|
||||||
|
def encode(self, encoding):
|
||||||
|
"""
|
||||||
|
Encode the cookie content in a specific type of encoding instructed
|
||||||
|
by the developer. Leverages the :func:`str.encode` method provided
|
||||||
|
by python.
|
||||||
|
|
||||||
|
This method can be used to encode and embed ``utf-8`` content into
|
||||||
|
the cookies.
|
||||||
|
|
||||||
|
:param encoding: Encoding to be used with the cookie
|
||||||
|
:return: Cookie encoded in a codec of choosing.
|
||||||
|
:except: UnicodeEncodeError
|
||||||
|
"""
|
||||||
|
return str(self).encode(encoding)
|
||||||
|
|
||||||
|
def __str__(self):
|
||||||
|
"""Format as a Set-Cookie header value."""
|
||||||
|
output = ["%s=%s" % (self.key, _quote(self.value))]
|
||||||
|
for key, value in self.items():
|
||||||
|
if key == "max-age":
|
||||||
|
try:
|
||||||
|
output.append("%s=%d" % (self._keys[key], value))
|
||||||
|
except TypeError:
|
||||||
|
output.append("%s=%s" % (self._keys[key], value))
|
||||||
|
elif key == "expires":
|
||||||
|
output.append(
|
||||||
|
"%s=%s"
|
||||||
|
% (self._keys[key], value.strftime("%a, %d-%b-%Y %T GMT"))
|
||||||
|
)
|
||||||
|
elif key in self._flags and self[key]:
|
||||||
|
output.append(self._keys[key])
|
||||||
|
else:
|
||||||
|
output.append("%s=%s" % (self._keys[key], value))
|
||||||
|
|
||||||
|
return "; ".join(output)
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
from .response import Cookie, CookieJar
|
|
||||||
|
|
||||||
|
|
||||||
__all__ = ("Cookie", "CookieJar")
|
|
||||||
@@ -1,119 +0,0 @@
|
|||||||
import re
|
|
||||||
|
|
||||||
from typing import Any, Dict, List, Optional
|
|
||||||
|
|
||||||
from sanic.cookies.response import Cookie
|
|
||||||
from sanic.log import deprecation
|
|
||||||
from sanic.request.parameters import RequestParameters
|
|
||||||
|
|
||||||
|
|
||||||
COOKIE_NAME_RESERVED_CHARS = re.compile(
|
|
||||||
'[\x00-\x1F\x7F-\xFF()<>@,;:\\\\"/[\\]?={} \x09]'
|
|
||||||
)
|
|
||||||
OCTAL_PATTERN = re.compile(r"\\[0-3][0-7][0-7]")
|
|
||||||
QUOTE_PATTERN = re.compile(r"[\\].")
|
|
||||||
|
|
||||||
|
|
||||||
def _unquote(str): # no cov
|
|
||||||
if str is None or len(str) < 2:
|
|
||||||
return str
|
|
||||||
if str[0] != '"' or str[-1] != '"':
|
|
||||||
return str
|
|
||||||
|
|
||||||
str = str[1:-1]
|
|
||||||
|
|
||||||
i = 0
|
|
||||||
n = len(str)
|
|
||||||
res = []
|
|
||||||
while 0 <= i < n:
|
|
||||||
o_match = OCTAL_PATTERN.search(str, i)
|
|
||||||
q_match = QUOTE_PATTERN.search(str, i)
|
|
||||||
if not o_match and not q_match:
|
|
||||||
res.append(str[i:])
|
|
||||||
break
|
|
||||||
# else:
|
|
||||||
j = k = -1
|
|
||||||
if o_match:
|
|
||||||
j = o_match.start(0)
|
|
||||||
if q_match:
|
|
||||||
k = q_match.start(0)
|
|
||||||
if q_match and (not o_match or k < j):
|
|
||||||
res.append(str[i:k])
|
|
||||||
res.append(str[k + 1])
|
|
||||||
i = k + 2
|
|
||||||
else:
|
|
||||||
res.append(str[i:j])
|
|
||||||
res.append(chr(int(str[j + 1 : j + 4], 8))) # noqa: E203
|
|
||||||
i = j + 4
|
|
||||||
return "".join(res)
|
|
||||||
|
|
||||||
|
|
||||||
def parse_cookie(raw: str):
|
|
||||||
cookies: Dict[str, List] = {}
|
|
||||||
|
|
||||||
for token in raw.split(";"):
|
|
||||||
name, __, value = token.partition("=")
|
|
||||||
name = name.strip()
|
|
||||||
value = value.strip()
|
|
||||||
|
|
||||||
if not name:
|
|
||||||
continue
|
|
||||||
|
|
||||||
if COOKIE_NAME_RESERVED_CHARS.search(name): # no cov
|
|
||||||
continue
|
|
||||||
|
|
||||||
if len(value) > 2 and value[0] == '"' and value[-1] == '"': # no cov
|
|
||||||
value = _unquote(value)
|
|
||||||
|
|
||||||
if name in cookies:
|
|
||||||
cookies[name].append(value)
|
|
||||||
else:
|
|
||||||
cookies[name] = [value]
|
|
||||||
|
|
||||||
return cookies
|
|
||||||
|
|
||||||
|
|
||||||
class CookieRequestParameters(RequestParameters):
|
|
||||||
def __getitem__(self, key: str) -> Optional[str]:
|
|
||||||
deprecation(
|
|
||||||
f"You are accessing cookie key '{key}', which is currently in "
|
|
||||||
"compat mode returning a single cookie value. Starting in v24.3 "
|
|
||||||
"accessing a cookie value like this will return a list of values. "
|
|
||||||
"To avoid this behavior and continue accessing a single value, "
|
|
||||||
f"please upgrade from request.cookies['{key}'] to "
|
|
||||||
f"request.cookies.get('{key}'). See more details: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#request-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
try:
|
|
||||||
value = self._get_prefixed_cookie(key)
|
|
||||||
except KeyError:
|
|
||||||
value = super().__getitem__(key)
|
|
||||||
return value[0]
|
|
||||||
|
|
||||||
def __getattr__(self, key: str) -> str:
|
|
||||||
if key.startswith("_"):
|
|
||||||
return self.__getattribute__(key)
|
|
||||||
key = key.rstrip("_").replace("_", "-")
|
|
||||||
return str(self.get(key, ""))
|
|
||||||
|
|
||||||
def get(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
|
|
||||||
try:
|
|
||||||
return self._get_prefixed_cookie(name)[0]
|
|
||||||
except KeyError:
|
|
||||||
return super().get(name, default)
|
|
||||||
|
|
||||||
def getlist(
|
|
||||||
self, name: str, default: Optional[Any] = None
|
|
||||||
) -> Optional[Any]:
|
|
||||||
try:
|
|
||||||
return self._get_prefixed_cookie(name)
|
|
||||||
except KeyError:
|
|
||||||
return super().getlist(name, default)
|
|
||||||
|
|
||||||
def _get_prefixed_cookie(self, name: str) -> Any:
|
|
||||||
getitem = super().__getitem__
|
|
||||||
try:
|
|
||||||
return getitem(f"{Cookie.HOST_PREFIX}{name}")
|
|
||||||
except KeyError:
|
|
||||||
return getitem(f"{Cookie.SECURE_PREFIX}{name}")
|
|
||||||
@@ -1,617 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import re
|
|
||||||
import string
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from datetime import datetime
|
|
||||||
from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
|
|
||||||
|
|
||||||
from sanic.exceptions import ServerError
|
|
||||||
from sanic.log import deprecation
|
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
|
||||||
from sanic.compat import Header
|
|
||||||
|
|
||||||
if sys.version_info < (3, 8): # no cov
|
|
||||||
SameSite = str
|
|
||||||
else: # no cov
|
|
||||||
from typing import Literal
|
|
||||||
|
|
||||||
SameSite = Union[
|
|
||||||
Literal["Strict"],
|
|
||||||
Literal["Lax"],
|
|
||||||
Literal["None"],
|
|
||||||
Literal["strict"],
|
|
||||||
Literal["lax"],
|
|
||||||
Literal["none"],
|
|
||||||
]
|
|
||||||
|
|
||||||
DEFAULT_MAX_AGE = 0
|
|
||||||
SAMESITE_VALUES = ("strict", "lax", "none")
|
|
||||||
|
|
||||||
LEGAL_CHARS = string.ascii_letters + string.digits + "!#$%&'*+-.^_`|~:"
|
|
||||||
UNESCAPED_CHARS = LEGAL_CHARS + " ()/<=>?@[]{}"
|
|
||||||
TRANSLATOR = {ch: f"\\{ch:03o}" for ch in bytes(range(32)) + b'";\\\x7F'}
|
|
||||||
|
|
||||||
|
|
||||||
def _quote(str): # no cov
|
|
||||||
r"""Quote a string for use in a cookie header.
|
|
||||||
If the string does not need to be double-quoted, then just return the
|
|
||||||
string. Otherwise, surround the string in doublequotes and quote
|
|
||||||
(with a \) special characters.
|
|
||||||
"""
|
|
||||||
if str is None or _is_legal_key(str):
|
|
||||||
return str
|
|
||||||
else:
|
|
||||||
return f'"{str.translate(TRANSLATOR)}"'
|
|
||||||
|
|
||||||
|
|
||||||
_is_legal_key = re.compile("[%s]+" % re.escape(LEGAL_CHARS)).fullmatch
|
|
||||||
|
|
||||||
|
|
||||||
# In v24.3, we should remove this as being a subclass of dict
|
|
||||||
class CookieJar(dict):
|
|
||||||
"""
|
|
||||||
CookieJar dynamically writes headers as cookies are added and removed
|
|
||||||
It gets around the limitation of one header per name by using the
|
|
||||||
MultiHeader class to provide a unique key that encodes to Set-Cookie.
|
|
||||||
"""
|
|
||||||
|
|
||||||
HEADER_KEY = "Set-Cookie"
|
|
||||||
|
|
||||||
def __init__(self, headers: Header):
|
|
||||||
super().__init__()
|
|
||||||
self.headers = headers
|
|
||||||
|
|
||||||
def __setitem__(self, key, value):
|
|
||||||
# If this cookie doesn't exist, add it to the header keys
|
|
||||||
deprecation(
|
|
||||||
"Setting cookie values using the dict pattern has been "
|
|
||||||
"deprecated. You should instead use the cookies.add_cookie "
|
|
||||||
"method. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
0,
|
|
||||||
)
|
|
||||||
if key not in self:
|
|
||||||
self.add_cookie(key, value, secure=False, samesite=None)
|
|
||||||
else:
|
|
||||||
self[key].value = value
|
|
||||||
|
|
||||||
def __delitem__(self, key):
|
|
||||||
deprecation(
|
|
||||||
"Deleting cookie values using the dict pattern has been "
|
|
||||||
"deprecated. You should instead use the cookies.delete_cookie "
|
|
||||||
"method. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
0,
|
|
||||||
)
|
|
||||||
if key in self:
|
|
||||||
super().__delitem__(key)
|
|
||||||
self.delete_cookie(key)
|
|
||||||
|
|
||||||
def __len__(self): # no cov
|
|
||||||
return len(self.cookies)
|
|
||||||
|
|
||||||
def __getitem__(self, key: str) -> Cookie:
|
|
||||||
deprecation(
|
|
||||||
"Accessing cookies from the CookieJar by dict key is deprecated. "
|
|
||||||
"You should instead use the cookies.get_cookie method. "
|
|
||||||
"To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
0,
|
|
||||||
)
|
|
||||||
return super().__getitem__(key)
|
|
||||||
|
|
||||||
def __iter__(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Iterating over the CookieJar has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().__iter__()
|
|
||||||
|
|
||||||
def keys(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Accessing CookieJar.keys() has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().keys()
|
|
||||||
|
|
||||||
def values(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Accessing CookieJar.values() has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().values()
|
|
||||||
|
|
||||||
def items(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Accessing CookieJar.items() has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().items()
|
|
||||||
|
|
||||||
def get(self, *args, **kwargs): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Accessing cookies from the CookieJar using get is deprecated "
|
|
||||||
"and will be removed in v24.3. You should instead use the "
|
|
||||||
"cookies.get_cookie method. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return super().get(*args, **kwargs)
|
|
||||||
|
|
||||||
def pop(self, key, *args, **kwargs): # no cov
|
|
||||||
deprecation(
|
|
||||||
"Using CookieJar.pop() has been deprecated and will be "
|
|
||||||
"removed in v24.3. To learn more, please see: "
|
|
||||||
"https://sanic.dev/en/guide/release-notes/v23.3.html#response-cookies", # noqa
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
self.delete(key)
|
|
||||||
return super().pop(key, *args, **kwargs)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def header_key(self): # no cov
|
|
||||||
deprecation(
|
|
||||||
"The CookieJar.header_key property has been deprecated and will "
|
|
||||||
"be removed in version 24.3. Use CookieJar.HEADER_KEY. ",
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return CookieJar.HEADER_KEY
|
|
||||||
|
|
||||||
@property
|
|
||||||
def cookie_headers(self) -> Dict[str, str]: # no cov
|
|
||||||
deprecation(
|
|
||||||
"The CookieJar.coookie_headers property has been deprecated "
|
|
||||||
"and will be removed in version 24.3. If you need to check if a "
|
|
||||||
"particular cookie key has been set, use CookieJar.has_cookie.",
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return {key: self.header_key for key in self}
|
|
||||||
|
|
||||||
@property
|
|
||||||
def cookies(self) -> List[Cookie]:
|
|
||||||
return self.headers.getall(self.HEADER_KEY)
|
|
||||||
|
|
||||||
def get_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> Optional[Cookie]:
|
|
||||||
for cookie in self.cookies:
|
|
||||||
if (
|
|
||||||
cookie.key == Cookie.make_key(key, host_prefix, secure_prefix)
|
|
||||||
and cookie.path == path
|
|
||||||
and cookie.domain == domain
|
|
||||||
):
|
|
||||||
return cookie
|
|
||||||
return None
|
|
||||||
|
|
||||||
def has_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> bool:
|
|
||||||
for cookie in self.cookies:
|
|
||||||
if (
|
|
||||||
cookie.key == Cookie.make_key(key, host_prefix, secure_prefix)
|
|
||||||
and cookie.path == path
|
|
||||||
and cookie.domain == domain
|
|
||||||
):
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
||||||
def add_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
value: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
secure: bool = True,
|
|
||||||
max_age: Optional[int] = None,
|
|
||||||
expires: Optional[datetime] = None,
|
|
||||||
httponly: bool = False,
|
|
||||||
samesite: Optional[SameSite] = "Lax",
|
|
||||||
partitioned: bool = False,
|
|
||||||
comment: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> Cookie:
|
|
||||||
"""
|
|
||||||
Add a cookie to the CookieJar
|
|
||||||
|
|
||||||
:param key: Key of the cookie
|
|
||||||
:type key: str
|
|
||||||
:param value: Value of the cookie
|
|
||||||
:type value: str
|
|
||||||
:param path: Path of the cookie, defaults to None
|
|
||||||
:type path: Optional[str], optional
|
|
||||||
:param domain: Domain of the cookie, defaults to None
|
|
||||||
:type domain: Optional[str], optional
|
|
||||||
:param secure: Whether to set it as a secure cookie, defaults to True
|
|
||||||
:type secure: bool
|
|
||||||
:param max_age: Max age of the cookie in seconds; if set to 0 a
|
|
||||||
browser should delete it, defaults to None
|
|
||||||
:type max_age: Optional[int], optional
|
|
||||||
:param expires: When the cookie expires; if set to None browsers
|
|
||||||
should set it as a session cookie, defaults to None
|
|
||||||
:type expires: Optional[datetime], optional
|
|
||||||
:param httponly: Whether to set it as HTTP only, defaults to False
|
|
||||||
:type httponly: bool
|
|
||||||
:param samesite: How to set the samesite property, should be
|
|
||||||
strict, lax or none (case insensitive), defaults to Lax
|
|
||||||
:type samesite: Optional[SameSite], optional
|
|
||||||
:param partitioned: Whether to set it as partitioned, defaults to False
|
|
||||||
:type partitioned: bool
|
|
||||||
:param comment: A cookie comment, defaults to None
|
|
||||||
:type comment: Optional[str], optional
|
|
||||||
:param host_prefix: Whether to add __Host- as a prefix to the key.
|
|
||||||
This requires that path="/", domain=None, and secure=True,
|
|
||||||
defaults to False
|
|
||||||
:type host_prefix: bool
|
|
||||||
:param secure_prefix: Whether to add __Secure- as a prefix to the key.
|
|
||||||
This requires that secure=True, defaults to False
|
|
||||||
:type secure_prefix: bool
|
|
||||||
:return: The instance of the created cookie
|
|
||||||
:rtype: Cookie
|
|
||||||
"""
|
|
||||||
cookie = Cookie(
|
|
||||||
key,
|
|
||||||
value,
|
|
||||||
path=path,
|
|
||||||
expires=expires,
|
|
||||||
comment=comment,
|
|
||||||
domain=domain,
|
|
||||||
max_age=max_age,
|
|
||||||
secure=secure,
|
|
||||||
httponly=httponly,
|
|
||||||
samesite=samesite,
|
|
||||||
partitioned=partitioned,
|
|
||||||
host_prefix=host_prefix,
|
|
||||||
secure_prefix=secure_prefix,
|
|
||||||
)
|
|
||||||
self.headers.add(self.HEADER_KEY, cookie)
|
|
||||||
|
|
||||||
# This should be removed in v24.3
|
|
||||||
super().__setitem__(key, cookie)
|
|
||||||
|
|
||||||
return cookie
|
|
||||||
|
|
||||||
def delete_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
Delete a cookie
|
|
||||||
|
|
||||||
This will effectively set it as Max-Age: 0, which a browser should
|
|
||||||
interpret it to mean: "delete the cookie".
|
|
||||||
|
|
||||||
Since it is a browser/client implementation, your results may vary
|
|
||||||
depending upon which client is being used.
|
|
||||||
|
|
||||||
:param key: The key to be deleted
|
|
||||||
:type key: str
|
|
||||||
:param path: Path of the cookie, defaults to None
|
|
||||||
:type path: Optional[str], optional
|
|
||||||
:param domain: Domain of the cookie, defaults to None
|
|
||||||
:type domain: Optional[str], optional
|
|
||||||
:param host_prefix: Whether to add __Host- as a prefix to the key.
|
|
||||||
This requires that path="/", domain=None, and secure=True,
|
|
||||||
defaults to False
|
|
||||||
:type host_prefix: bool
|
|
||||||
:param secure_prefix: Whether to add __Secure- as a prefix to the key.
|
|
||||||
This requires that secure=True, defaults to False
|
|
||||||
:type secure_prefix: bool
|
|
||||||
"""
|
|
||||||
# remove it from header
|
|
||||||
cookies: List[Cookie] = self.headers.popall(self.HEADER_KEY, [])
|
|
||||||
for cookie in cookies:
|
|
||||||
if (
|
|
||||||
cookie.key != Cookie.make_key(key, host_prefix, secure_prefix)
|
|
||||||
or cookie.path != path
|
|
||||||
or cookie.domain != domain
|
|
||||||
):
|
|
||||||
self.headers.add(self.HEADER_KEY, cookie)
|
|
||||||
|
|
||||||
# This should be removed in v24.3
|
|
||||||
try:
|
|
||||||
super().__delitem__(key)
|
|
||||||
except KeyError:
|
|
||||||
...
|
|
||||||
|
|
||||||
self.add_cookie(
|
|
||||||
key=key,
|
|
||||||
value="",
|
|
||||||
path=path,
|
|
||||||
domain=domain,
|
|
||||||
max_age=0,
|
|
||||||
samesite=None,
|
|
||||||
host_prefix=host_prefix,
|
|
||||||
secure_prefix=secure_prefix,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# In v24.3, we should remove this as being a subclass of dict
|
|
||||||
# Instead, it should be an object with __slots__
|
|
||||||
# All of the current property accessors should be removed in favor
|
|
||||||
# of actual slotted properties.
|
|
||||||
class Cookie(dict):
|
|
||||||
"""A stripped down version of Morsel from SimpleCookie"""
|
|
||||||
|
|
||||||
HOST_PREFIX = "__Host-"
|
|
||||||
SECURE_PREFIX = "__Secure-"
|
|
||||||
|
|
||||||
_keys = {
|
|
||||||
"path": "Path",
|
|
||||||
"comment": "Comment",
|
|
||||||
"domain": "Domain",
|
|
||||||
"max-age": "Max-Age",
|
|
||||||
"expires": "expires",
|
|
||||||
"samesite": "SameSite",
|
|
||||||
"version": "Version",
|
|
||||||
"secure": "Secure",
|
|
||||||
"httponly": "HttpOnly",
|
|
||||||
"partitioned": "Partitioned",
|
|
||||||
}
|
|
||||||
_flags = {"secure", "httponly", "partitioned"}
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
value: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
secure: bool = True,
|
|
||||||
max_age: Optional[int] = None,
|
|
||||||
expires: Optional[datetime] = None,
|
|
||||||
httponly: bool = False,
|
|
||||||
samesite: Optional[SameSite] = "Lax",
|
|
||||||
partitioned: bool = False,
|
|
||||||
comment: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
):
|
|
||||||
if key in self._keys:
|
|
||||||
raise KeyError("Cookie name is a reserved word")
|
|
||||||
if not _is_legal_key(key):
|
|
||||||
raise KeyError("Cookie key contains illegal characters")
|
|
||||||
if host_prefix:
|
|
||||||
if not secure:
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot set host_prefix on a cookie without secure=True"
|
|
||||||
)
|
|
||||||
if path != "/":
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot set host_prefix on a cookie unless path='/'"
|
|
||||||
)
|
|
||||||
if domain:
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot set host_prefix on a cookie with a defined domain"
|
|
||||||
)
|
|
||||||
elif secure_prefix and not secure:
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot set secure_prefix on a cookie without secure=True"
|
|
||||||
)
|
|
||||||
if partitioned and not host_prefix:
|
|
||||||
# This is technically possible, but it is not advisable so we will
|
|
||||||
# take a stand and say "don't shoot yourself in the foot"
|
|
||||||
raise ServerError(
|
|
||||||
"Cannot create a partitioned cookie without "
|
|
||||||
"also setting host_prefix=True"
|
|
||||||
)
|
|
||||||
|
|
||||||
self.key = self.make_key(key, host_prefix, secure_prefix)
|
|
||||||
self.value = value
|
|
||||||
super().__init__()
|
|
||||||
|
|
||||||
# This is a temporary solution while this object is a dict. We update
|
|
||||||
# all of the values in bulk, except for the values that have
|
|
||||||
# key-specific validation in _set_value
|
|
||||||
self.update(
|
|
||||||
{
|
|
||||||
"path": path,
|
|
||||||
"comment": comment,
|
|
||||||
"domain": domain,
|
|
||||||
"secure": secure,
|
|
||||||
"httponly": httponly,
|
|
||||||
"partitioned": partitioned,
|
|
||||||
"expires": None,
|
|
||||||
"max-age": None,
|
|
||||||
"samesite": None,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
if expires is not None:
|
|
||||||
self._set_value("expires", expires)
|
|
||||||
if max_age is not None:
|
|
||||||
self._set_value("max-age", max_age)
|
|
||||||
if samesite is not None:
|
|
||||||
self._set_value("samesite", samesite)
|
|
||||||
|
|
||||||
def __setitem__(self, key, value):
|
|
||||||
deprecation(
|
|
||||||
"Setting values on a Cookie object as a dict has been deprecated. "
|
|
||||||
"This feature will be removed in v24.3. You should instead set "
|
|
||||||
f"values on cookies as object properties: cookie.{key}=... ",
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
self._set_value(key, value)
|
|
||||||
|
|
||||||
# This is a temporary method for backwards compat and should be removed
|
|
||||||
# in v24.3 when this is no longer a dict
|
|
||||||
def _set_value(self, key: str, value: Any) -> None:
|
|
||||||
if key not in self._keys:
|
|
||||||
raise KeyError("Unknown cookie property: %s=%s" % (key, value))
|
|
||||||
|
|
||||||
if value is not None:
|
|
||||||
if key.lower() == "max-age" and not str(value).isdigit():
|
|
||||||
raise ValueError("Cookie max-age must be an integer")
|
|
||||||
elif key.lower() == "expires" and not isinstance(value, datetime):
|
|
||||||
raise TypeError("Cookie 'expires' property must be a datetime")
|
|
||||||
elif key.lower() == "samesite":
|
|
||||||
if value.lower() not in SAMESITE_VALUES:
|
|
||||||
raise TypeError(
|
|
||||||
"Cookie 'samesite' property must "
|
|
||||||
f"be one of: {','.join(SAMESITE_VALUES)}"
|
|
||||||
)
|
|
||||||
value = value.title()
|
|
||||||
|
|
||||||
super().__setitem__(key, value)
|
|
||||||
|
|
||||||
def encode(self, encoding):
|
|
||||||
"""
|
|
||||||
Encode the cookie content in a specific type of encoding instructed
|
|
||||||
by the developer. Leverages the :func:`str.encode` method provided
|
|
||||||
by python.
|
|
||||||
|
|
||||||
This method can be used to encode and embed ``utf-8`` content into
|
|
||||||
the cookies.
|
|
||||||
|
|
||||||
:param encoding: Encoding to be used with the cookie
|
|
||||||
:return: Cookie encoded in a codec of choosing.
|
|
||||||
:except: UnicodeEncodeError
|
|
||||||
"""
|
|
||||||
deprecation(
|
|
||||||
"Direct encoding of a Cookie object has been deprecated and will "
|
|
||||||
"be removed in v24.3.",
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
return str(self).encode(encoding)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
"""Format as a Set-Cookie header value."""
|
|
||||||
output = ["%s=%s" % (self.key, _quote(self.value))]
|
|
||||||
key_index = list(self._keys)
|
|
||||||
for key, value in sorted(
|
|
||||||
self.items(), key=lambda x: key_index.index(x[0])
|
|
||||||
):
|
|
||||||
if value is not None and value is not False:
|
|
||||||
if key == "max-age":
|
|
||||||
try:
|
|
||||||
output.append("%s=%d" % (self._keys[key], value))
|
|
||||||
except TypeError:
|
|
||||||
output.append("%s=%s" % (self._keys[key], value))
|
|
||||||
elif key == "expires":
|
|
||||||
output.append(
|
|
||||||
"%s=%s"
|
|
||||||
% (
|
|
||||||
self._keys[key],
|
|
||||||
value.strftime("%a, %d-%b-%Y %T GMT"),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
elif key in self._flags:
|
|
||||||
output.append(self._keys[key])
|
|
||||||
else:
|
|
||||||
output.append("%s=%s" % (self._keys[key], value))
|
|
||||||
|
|
||||||
return "; ".join(output)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def path(self) -> str: # no cov
|
|
||||||
return self["path"]
|
|
||||||
|
|
||||||
@path.setter
|
|
||||||
def path(self, value: str) -> None: # no cov
|
|
||||||
self._set_value("path", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def expires(self) -> Optional[datetime]: # no cov
|
|
||||||
return self.get("expires")
|
|
||||||
|
|
||||||
@expires.setter
|
|
||||||
def expires(self, value: datetime) -> None: # no cov
|
|
||||||
self._set_value("expires", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def comment(self) -> Optional[str]: # no cov
|
|
||||||
return self.get("comment")
|
|
||||||
|
|
||||||
@comment.setter
|
|
||||||
def comment(self, value: str) -> None: # no cov
|
|
||||||
self._set_value("comment", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def domain(self) -> Optional[str]: # no cov
|
|
||||||
return self.get("domain")
|
|
||||||
|
|
||||||
@domain.setter
|
|
||||||
def domain(self, value: str) -> None: # no cov
|
|
||||||
self._set_value("domain", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def max_age(self) -> Optional[int]: # no cov
|
|
||||||
return self.get("max-age")
|
|
||||||
|
|
||||||
@max_age.setter
|
|
||||||
def max_age(self, value: int) -> None: # no cov
|
|
||||||
self._set_value("max-age", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def secure(self) -> bool: # no cov
|
|
||||||
return self.get("secure", False)
|
|
||||||
|
|
||||||
@secure.setter
|
|
||||||
def secure(self, value: bool) -> None: # no cov
|
|
||||||
self._set_value("secure", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def httponly(self) -> bool: # no cov
|
|
||||||
return self.get("httponly", False)
|
|
||||||
|
|
||||||
@httponly.setter
|
|
||||||
def httponly(self, value: bool) -> None: # no cov
|
|
||||||
self._set_value("httponly", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def samesite(self) -> Optional[SameSite]: # no cov
|
|
||||||
return self.get("samesite")
|
|
||||||
|
|
||||||
@samesite.setter
|
|
||||||
def samesite(self, value: SameSite) -> None: # no cov
|
|
||||||
self._set_value("samesite", value)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def partitioned(self) -> bool: # no cov
|
|
||||||
return self.get("partitioned", False)
|
|
||||||
|
|
||||||
@partitioned.setter
|
|
||||||
def partitioned(self, value: bool) -> None: # no cov
|
|
||||||
self._set_value("partitioned", value)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def make_key(
|
|
||||||
cls, key: str, host_prefix: bool = False, secure_prefix: bool = False
|
|
||||||
) -> str:
|
|
||||||
if host_prefix and secure_prefix:
|
|
||||||
raise ServerError(
|
|
||||||
"Both host_prefix and secure_prefix were requested. "
|
|
||||||
"A cookie should have only one prefix."
|
|
||||||
)
|
|
||||||
elif host_prefix:
|
|
||||||
key = cls.HOST_PREFIX + key
|
|
||||||
elif secure_prefix:
|
|
||||||
key = cls.SECURE_PREFIX + key
|
|
||||||
return key
|
|
||||||
@@ -12,7 +12,6 @@ Setting ``app.config.FALLBACK_ERROR_FORMAT = "auto"`` will enable a switch that
|
|||||||
will attempt to provide an appropriate response format based upon the
|
will attempt to provide an appropriate response format based upon the
|
||||||
request type.
|
request type.
|
||||||
"""
|
"""
|
||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import sys
|
import sys
|
||||||
import typing as t
|
import typing as t
|
||||||
@@ -22,9 +21,8 @@ from traceback import extract_tb
|
|||||||
|
|
||||||
from sanic.exceptions import BadRequest, SanicException
|
from sanic.exceptions import BadRequest, SanicException
|
||||||
from sanic.helpers import STATUS_CODES
|
from sanic.helpers import STATUS_CODES
|
||||||
from sanic.log import deprecation, logger
|
from sanic.request import Request
|
||||||
from sanic.pages.error import ErrorPage
|
from sanic.response import HTTPResponse, html, json, text
|
||||||
from sanic.response import html, json, text
|
|
||||||
|
|
||||||
|
|
||||||
dumps: t.Callable[..., str]
|
dumps: t.Callable[..., str]
|
||||||
@@ -35,15 +33,13 @@ try:
|
|||||||
except ImportError: # noqa
|
except ImportError: # noqa
|
||||||
from json import dumps
|
from json import dumps
|
||||||
|
|
||||||
if t.TYPE_CHECKING:
|
|
||||||
from sanic import HTTPResponse, Request
|
|
||||||
|
|
||||||
DEFAULT_FORMAT = "auto"
|
DEFAULT_FORMAT = "auto"
|
||||||
FALLBACK_TEXT = """\
|
FALLBACK_TEXT = (
|
||||||
The application encountered an unexpected error and could not continue.\
|
"The server encountered an internal error and "
|
||||||
"""
|
"cannot complete your request."
|
||||||
|
)
|
||||||
FALLBACK_STATUS = 500
|
FALLBACK_STATUS = 500
|
||||||
JSON = "application/json"
|
|
||||||
|
|
||||||
|
|
||||||
class BaseRenderer:
|
class BaseRenderer:
|
||||||
@@ -92,10 +88,8 @@ class BaseRenderer:
|
|||||||
self.full
|
self.full
|
||||||
if self.debug and not getattr(self.exception, "quiet", False)
|
if self.debug and not getattr(self.exception, "quiet", False)
|
||||||
else self.minimal
|
else self.minimal
|
||||||
)()
|
)
|
||||||
output.status = self.status
|
return output()
|
||||||
output.headers.update(self.headers)
|
|
||||||
return output
|
|
||||||
|
|
||||||
def minimal(self) -> HTTPResponse: # noqa
|
def minimal(self) -> HTTPResponse: # noqa
|
||||||
"""
|
"""
|
||||||
@@ -119,18 +113,134 @@ class HTMLRenderer(BaseRenderer):
|
|||||||
The default fallback type.
|
The default fallback type.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def full(self) -> HTTPResponse:
|
TRACEBACK_STYLE = """
|
||||||
page = ErrorPage(
|
html { font-family: sans-serif }
|
||||||
debug=self.debug,
|
h2 { color: #888; }
|
||||||
title=super().title,
|
.tb-wrapper p, dl, dd { margin: 0 }
|
||||||
text=super().text,
|
.frame-border { margin: 1rem }
|
||||||
request=self.request,
|
.frame-line > *, dt, dd { padding: 0.3rem 0.6rem }
|
||||||
exc=self.exception,
|
.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 }
|
||||||
|
"""
|
||||||
|
TRACEBACK_WRAPPER_HTML = (
|
||||||
|
"<div class=tb-header>{exc_name}: {exc_value}</div>"
|
||||||
|
"<div class=tb-wrapper>{frame_html}</div>"
|
||||||
|
)
|
||||||
|
TRACEBACK_BORDER = (
|
||||||
|
"<div class=frame-border>"
|
||||||
|
"The above exception was the direct cause of the following exception:"
|
||||||
|
"</div>"
|
||||||
|
)
|
||||||
|
TRACEBACK_LINE_HTML = (
|
||||||
|
"<div class=frame-line>"
|
||||||
|
"<p class=frame-descriptor>"
|
||||||
|
"File {0.filename}, line <i>{0.lineno}</i>, "
|
||||||
|
"in <code><b>{0.name}</b></code>"
|
||||||
|
"<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"
|
||||||
|
"<style>{style}</style>\n"
|
||||||
|
"<h1>{title}</h1><p>{text}\n"
|
||||||
|
"{body}"
|
||||||
|
)
|
||||||
|
|
||||||
|
def full(self) -> HTTPResponse:
|
||||||
|
return html(
|
||||||
|
self.OUTPUT_HTML.format(
|
||||||
|
title=self.title,
|
||||||
|
text=self.text,
|
||||||
|
style=self.TRACEBACK_STYLE,
|
||||||
|
body=self._generate_body(full=True),
|
||||||
|
),
|
||||||
|
status=self.status,
|
||||||
)
|
)
|
||||||
return html(page.render())
|
|
||||||
|
|
||||||
def minimal(self) -> HTTPResponse:
|
def minimal(self) -> HTTPResponse:
|
||||||
return self.full()
|
return html(
|
||||||
|
self.OUTPUT_HTML.format(
|
||||||
|
title=self.title,
|
||||||
|
text=self.text,
|
||||||
|
style=self.TRACEBACK_STYLE,
|
||||||
|
body=self._generate_body(full=False),
|
||||||
|
),
|
||||||
|
status=self.status,
|
||||||
|
headers=self.headers,
|
||||||
|
)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def text(self):
|
||||||
|
return escape(super().text)
|
||||||
|
|
||||||
|
@property
|
||||||
|
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))
|
||||||
|
|
||||||
|
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(
|
||||||
|
self.TRACEBACK_LINE_HTML.format(frame) for frame in frames
|
||||||
|
)
|
||||||
|
return self.TRACEBACK_WRAPPER_HTML.format(
|
||||||
|
exc_name=escape(exc.__class__.__name__),
|
||||||
|
exc_value=escape(exc),
|
||||||
|
frame_html=frame_html,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class TextRenderer(BaseRenderer):
|
class TextRenderer(BaseRenderer):
|
||||||
@@ -148,7 +258,8 @@ class TextRenderer(BaseRenderer):
|
|||||||
text=self.text,
|
text=self.text,
|
||||||
bar=("=" * len(self.title)),
|
bar=("=" * len(self.title)),
|
||||||
body=self._generate_body(full=True),
|
body=self._generate_body(full=True),
|
||||||
)
|
),
|
||||||
|
status=self.status,
|
||||||
)
|
)
|
||||||
|
|
||||||
def minimal(self) -> HTTPResponse:
|
def minimal(self) -> HTTPResponse:
|
||||||
@@ -158,7 +269,9 @@ class TextRenderer(BaseRenderer):
|
|||||||
text=self.text,
|
text=self.text,
|
||||||
bar=("=" * len(self.title)),
|
bar=("=" * len(self.title)),
|
||||||
body=self._generate_body(full=False),
|
body=self._generate_body(full=False),
|
||||||
)
|
),
|
||||||
|
status=self.status,
|
||||||
|
headers=self.headers,
|
||||||
)
|
)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@@ -217,11 +330,11 @@ class JSONRenderer(BaseRenderer):
|
|||||||
|
|
||||||
def full(self) -> HTTPResponse:
|
def full(self) -> HTTPResponse:
|
||||||
output = self._generate_output(full=True)
|
output = self._generate_output(full=True)
|
||||||
return json(output, dumps=self.dumps)
|
return json(output, status=self.status, dumps=self.dumps)
|
||||||
|
|
||||||
def minimal(self) -> HTTPResponse:
|
def minimal(self) -> HTTPResponse:
|
||||||
output = self._generate_output(full=False)
|
output = self._generate_output(full=False)
|
||||||
return json(output, dumps=self.dumps)
|
return json(output, status=self.status, dumps=self.dumps)
|
||||||
|
|
||||||
def _generate_output(self, *, full):
|
def _generate_output(self, *, full):
|
||||||
output = {
|
output = {
|
||||||
@@ -275,26 +388,32 @@ def escape(text):
|
|||||||
return f"{text}".replace("&", "&").replace("<", "<")
|
return f"{text}".replace("&", "&").replace("<", "<")
|
||||||
|
|
||||||
|
|
||||||
MIME_BY_CONFIG = {
|
RENDERERS_BY_CONFIG = {
|
||||||
"text": "text/plain",
|
"html": HTMLRenderer,
|
||||||
"json": "application/json",
|
"json": JSONRenderer,
|
||||||
"html": "text/html",
|
"text": TextRenderer,
|
||||||
}
|
}
|
||||||
CONFIG_BY_MIME = {v: k for k, v in MIME_BY_CONFIG.items()}
|
|
||||||
RENDERERS_BY_CONTENT_TYPE = {
|
RENDERERS_BY_CONTENT_TYPE = {
|
||||||
"text/plain": TextRenderer,
|
"text/plain": TextRenderer,
|
||||||
"application/json": JSONRenderer,
|
"application/json": JSONRenderer,
|
||||||
"multipart/form-data": HTMLRenderer,
|
"multipart/form-data": HTMLRenderer,
|
||||||
"text/html": HTMLRenderer,
|
"text/html": HTMLRenderer,
|
||||||
}
|
}
|
||||||
|
CONTENT_TYPE_BY_RENDERERS = {
|
||||||
|
v: k for k, v in RENDERERS_BY_CONTENT_TYPE.items()
|
||||||
|
}
|
||||||
|
|
||||||
# Handler source code is checked for which response types it returns with the
|
|
||||||
# route error_format="auto" (default) to determine which format to use.
|
|
||||||
RESPONSE_MAPPING = {
|
RESPONSE_MAPPING = {
|
||||||
|
"empty": "html",
|
||||||
"json": "json",
|
"json": "json",
|
||||||
"text": "text",
|
"text": "text",
|
||||||
|
"raw": "text",
|
||||||
"html": "html",
|
"html": "html",
|
||||||
"JSONResponse": "json",
|
"file": "html",
|
||||||
|
"file_stream": "text",
|
||||||
|
"stream": "text",
|
||||||
|
"redirect": "html",
|
||||||
"text/plain": "text",
|
"text/plain": "text",
|
||||||
"text/html": "html",
|
"text/html": "html",
|
||||||
"application/json": "json",
|
"application/json": "json",
|
||||||
@@ -302,7 +421,7 @@ RESPONSE_MAPPING = {
|
|||||||
|
|
||||||
|
|
||||||
def check_error_format(format):
|
def check_error_format(format):
|
||||||
if format not in MIME_BY_CONFIG and format != "auto":
|
if format not in RENDERERS_BY_CONFIG and format != "auto":
|
||||||
raise SanicException(f"Unknown format: {format}")
|
raise SanicException(f"Unknown format: {format}")
|
||||||
|
|
||||||
|
|
||||||
@@ -312,73 +431,103 @@ def exception_response(
|
|||||||
debug: bool,
|
debug: bool,
|
||||||
fallback: str,
|
fallback: str,
|
||||||
base: t.Type[BaseRenderer],
|
base: t.Type[BaseRenderer],
|
||||||
renderer: t.Optional[t.Type[BaseRenderer]] = None,
|
renderer: t.Type[t.Optional[BaseRenderer]] = None,
|
||||||
) -> HTTPResponse:
|
) -> HTTPResponse:
|
||||||
"""
|
"""
|
||||||
Render a response for the default FALLBACK exception handler.
|
Render a response for the default FALLBACK exception handler.
|
||||||
"""
|
"""
|
||||||
|
content_type = None
|
||||||
|
|
||||||
if not renderer:
|
if not renderer:
|
||||||
mt = guess_mime(request, fallback)
|
# Make sure we have something set
|
||||||
renderer = RENDERERS_BY_CONTENT_TYPE.get(mt, base)
|
renderer = base
|
||||||
|
render_format = fallback
|
||||||
|
|
||||||
|
if request:
|
||||||
|
# If there is a request, try and get the format
|
||||||
|
# from the route
|
||||||
|
if request.route:
|
||||||
|
try:
|
||||||
|
if request.route.extra.error_format:
|
||||||
|
render_format = request.route.extra.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 = 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 BadRequest:
|
||||||
|
renderer = base
|
||||||
|
else:
|
||||||
|
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)
|
renderer = t.cast(t.Type[BaseRenderer], renderer)
|
||||||
return renderer(request, exception, debug).render()
|
return renderer(request, exception, debug).render()
|
||||||
|
|
||||||
|
|
||||||
def guess_mime(req: Request, fallback: str) -> str:
|
|
||||||
# Attempt to find a suitable MIME format for the response.
|
|
||||||
# Insertion-ordered map of formats["html"] = "source of that suggestion"
|
|
||||||
formats = {}
|
|
||||||
name = ""
|
|
||||||
# Route error_format (by magic from handler code if auto, the default)
|
|
||||||
if req.route:
|
|
||||||
name = req.route.name
|
|
||||||
f = req.route.extra.error_format
|
|
||||||
if f in MIME_BY_CONFIG:
|
|
||||||
formats[f] = name
|
|
||||||
|
|
||||||
if not formats and fallback in MIME_BY_CONFIG:
|
|
||||||
formats[fallback] = "FALLBACK_ERROR_FORMAT"
|
|
||||||
|
|
||||||
# If still not known, check for the request for clues of JSON
|
|
||||||
if not formats and fallback == "auto" and req.accept.match(JSON):
|
|
||||||
if JSON in req.accept: # Literally, not wildcard
|
|
||||||
formats["json"] = "request.accept"
|
|
||||||
elif JSON in req.headers.getone("content-type", ""):
|
|
||||||
formats["json"] = "content-type"
|
|
||||||
# DEPRECATION: Remove this block in 24.3
|
|
||||||
else:
|
|
||||||
c = None
|
|
||||||
try:
|
|
||||||
c = req.json
|
|
||||||
except BadRequest:
|
|
||||||
pass
|
|
||||||
if c:
|
|
||||||
formats["json"] = "request.json"
|
|
||||||
deprecation(
|
|
||||||
"Response type was determined by the JSON content of "
|
|
||||||
"the request. This behavior is deprecated and will be "
|
|
||||||
"removed in v24.3. Please specify the format either by\n"
|
|
||||||
f' error_format="json" on route {name}, by\n'
|
|
||||||
' FALLBACK_ERROR_FORMAT = "json", or by adding header\n'
|
|
||||||
" accept: application/json to your requests.",
|
|
||||||
24.3,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Any other supported formats
|
|
||||||
if fallback == "auto":
|
|
||||||
for k in MIME_BY_CONFIG:
|
|
||||||
if k not in formats:
|
|
||||||
formats[k] = "any"
|
|
||||||
|
|
||||||
mimes = [MIME_BY_CONFIG[k] for k in formats]
|
|
||||||
m = req.accept.match(*mimes)
|
|
||||||
if m:
|
|
||||||
format = CONFIG_BY_MIME[m.mime]
|
|
||||||
source = formats[format]
|
|
||||||
logger.debug(
|
|
||||||
f"The client accepts {m.header}, using '{format}' from {source}"
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
logger.debug(f"No format found, the client accepts {req.accept!r}")
|
|
||||||
return m.mime
|
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
from asyncio import CancelledError, Protocol
|
from asyncio import CancelledError
|
||||||
from os import PathLike
|
from typing import Any, Dict, Optional, Union
|
||||||
from typing import Any, Dict, Optional, Sequence, Union
|
|
||||||
|
|
||||||
from sanic.helpers import STATUS_CODES
|
from sanic.helpers import STATUS_CODES
|
||||||
|
|
||||||
@@ -10,158 +9,51 @@ class RequestCancelled(CancelledError):
|
|||||||
|
|
||||||
|
|
||||||
class ServerKilled(Exception):
|
class ServerKilled(Exception):
|
||||||
"""
|
...
|
||||||
Exception Sanic server uses when killing a server process for something
|
|
||||||
unexpected happening.
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
|
||||||
class SanicException(Exception):
|
class SanicException(Exception):
|
||||||
"""
|
|
||||||
Generic exception that will generate an HTTP response when raised
|
|
||||||
in the context of a request lifecycle.
|
|
||||||
|
|
||||||
Usually it is best practice to use one of the more specific exceptions
|
|
||||||
than this generic. Even when trying to raise a 500, it is generally
|
|
||||||
preferrable to use :class:`.ServerError`
|
|
||||||
|
|
||||||
.. code-block:: python
|
|
||||||
|
|
||||||
raise SanicException(
|
|
||||||
"Something went wrong",
|
|
||||||
status_code=999,
|
|
||||||
context={
|
|
||||||
"info": "Some additional details",
|
|
||||||
},
|
|
||||||
headers={
|
|
||||||
"X-Foo": "bar"
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the appropriate HTTP response status message will be used
|
|
||||||
instead, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param status_code: The HTTP response code to send, if applicable. If
|
|
||||||
``None``, then it will be 500, defaults to None
|
|
||||||
:type status_code: Optional[int], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
|
||||||
|
|
||||||
status_code: int = 500
|
|
||||||
quiet: Optional[bool] = False
|
|
||||||
headers: Dict[str, str] = {}
|
|
||||||
message: str = ""
|
message: str = ""
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
message: Optional[Union[str, bytes]] = None,
|
message: Optional[Union[str, bytes]] = None,
|
||||||
status_code: Optional[int] = None,
|
status_code: Optional[int] = None,
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
quiet: Optional[bool] = None,
|
||||||
context: Optional[Dict[str, Any]] = None,
|
context: Optional[Dict[str, Any]] = None,
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
extra: Optional[Dict[str, Any]] = None,
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
) -> None:
|
) -> None:
|
||||||
self.context = context
|
self.context = context
|
||||||
self.extra = extra
|
self.extra = extra
|
||||||
status_code = status_code or getattr(
|
|
||||||
self.__class__, "status_code", None
|
|
||||||
)
|
|
||||||
quiet = quiet or getattr(self.__class__, "quiet", None)
|
|
||||||
headers = headers or getattr(self.__class__, "headers", {})
|
|
||||||
if message is None:
|
if message is None:
|
||||||
if self.message:
|
if self.message:
|
||||||
message = self.message
|
message = self.message
|
||||||
elif status_code:
|
elif status_code is not None:
|
||||||
msg: bytes = STATUS_CODES.get(status_code, b"")
|
msg: bytes = STATUS_CODES.get(status_code, b"")
|
||||||
message = msg.decode("utf8")
|
message = msg.decode("utf8")
|
||||||
|
|
||||||
super().__init__(message)
|
super().__init__(message)
|
||||||
|
|
||||||
self.status_code = status_code or self.status_code
|
if status_code is not None:
|
||||||
self.quiet = quiet
|
self.status_code = status_code
|
||||||
self.headers = headers
|
|
||||||
|
# quiet=None/False/True with None meaning choose by status
|
||||||
|
if quiet or quiet is None and status_code not in (None, 500):
|
||||||
|
self.quiet = True
|
||||||
|
|
||||||
|
|
||||||
class HTTPException(SanicException):
|
class NotFound(SanicException):
|
||||||
"""
|
|
||||||
A base class for other exceptions and should not be called directly.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
message: Optional[Union[str, bytes]] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
) -> None:
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class NotFound(HTTPException):
|
|
||||||
"""
|
"""
|
||||||
**Status**: 404 Not Found
|
**Status**: 404 Not Found
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Not Found' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 404
|
status_code = 404
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
|
|
||||||
class BadRequest(HTTPException):
|
class BadRequest(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 400 Bad Request
|
**Status**: 400 Bad Request
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 400
|
status_code = 400
|
||||||
@@ -169,133 +61,51 @@ class BadRequest(HTTPException):
|
|||||||
|
|
||||||
|
|
||||||
InvalidUsage = BadRequest
|
InvalidUsage = BadRequest
|
||||||
BadURL = BadRequest
|
|
||||||
|
|
||||||
|
|
||||||
class MethodNotAllowed(HTTPException):
|
class BadURL(BadRequest):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
class MethodNotAllowed(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 405 Method Not Allowed
|
**Status**: 405 Method Not Allowed
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Method Not Allowed' will be sent,
|
|
||||||
defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param method: The HTTP method that was used, defaults to an empty string
|
|
||||||
:type method: Optional[str], optional
|
|
||||||
:param allowed_methods: The HTTP methods that can be used instead of the
|
|
||||||
one that was attempted
|
|
||||||
:type allowed_methods: Optional[Sequence[str]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 405
|
status_code = 405
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, message, method, allowed_methods):
|
||||||
self,
|
super().__init__(message)
|
||||||
message: Optional[Union[str, bytes]] = None,
|
self.headers = {"Allow": ", ".join(allowed_methods)}
|
||||||
method: str = "",
|
|
||||||
allowed_methods: Optional[Sequence[str]] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
if allowed_methods:
|
|
||||||
self.headers = {
|
|
||||||
**self.headers,
|
|
||||||
"Allow": ", ".join(allowed_methods),
|
|
||||||
}
|
|
||||||
self.method = method
|
|
||||||
self.allowed_methods = allowed_methods
|
|
||||||
|
|
||||||
|
|
||||||
MethodNotSupported = MethodNotAllowed
|
MethodNotSupported = MethodNotAllowed
|
||||||
|
|
||||||
|
|
||||||
class ServerError(HTTPException):
|
class ServerError(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 500 Internal Server Error
|
**Status**: 500 Internal Server Error
|
||||||
|
|
||||||
A general server-side error has occurred. If no other HTTP exception is
|
|
||||||
appropriate, then this should be used
|
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Internal Server Error' will be sent,
|
|
||||||
defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 500
|
status_code = 500
|
||||||
|
|
||||||
|
|
||||||
InternalServerError = ServerError
|
class ServiceUnavailable(SanicException):
|
||||||
|
|
||||||
|
|
||||||
class ServiceUnavailable(HTTPException):
|
|
||||||
"""
|
"""
|
||||||
**Status**: 503 Service Unavailable
|
**Status**: 503 Service Unavailable
|
||||||
|
|
||||||
The server is currently unavailable (because it is overloaded or
|
The server is currently unavailable (because it is overloaded or
|
||||||
down for maintenance). Generally, this is a temporary state.
|
down for maintenance). Generally, this is a temporary state.
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 503
|
status_code = 503
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
|
|
||||||
class URLBuildError(HTTPException):
|
class URLBuildError(ServerError):
|
||||||
"""
|
"""
|
||||||
**Status**: 500 Internal Server Error
|
**Status**: 500 Internal Server Error
|
||||||
|
|
||||||
An exception used by Sanic internals when unable to build a URL.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 500
|
status_code = 500
|
||||||
@@ -304,77 +114,30 @@ class URLBuildError(HTTPException):
|
|||||||
class FileNotFound(NotFound):
|
class FileNotFound(NotFound):
|
||||||
"""
|
"""
|
||||||
**Status**: 404 Not Found
|
**Status**: 404 Not Found
|
||||||
|
|
||||||
A specific form of :class:`.NotFound` that is specifically when looking
|
|
||||||
for a file on the file system at a known path.
|
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Not Found' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param path: The path, if any, to the file that could not
|
|
||||||
be found, defaults to None
|
|
||||||
:type path: Optional[PathLike], optional
|
|
||||||
:param relative_url: A relative URL of the file, defaults to None
|
|
||||||
:type relative_url: Optional[str], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, message, path, relative_url):
|
||||||
self,
|
super().__init__(message)
|
||||||
message: Optional[Union[str, bytes]] = None,
|
|
||||||
path: Optional[PathLike] = None,
|
|
||||||
relative_url: Optional[str] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
self.path = path
|
self.path = path
|
||||||
self.relative_url = relative_url
|
self.relative_url = relative_url
|
||||||
|
|
||||||
|
|
||||||
class RequestTimeout(HTTPException):
|
class RequestTimeout(SanicException):
|
||||||
"""
|
"""The Web server (running the Web site) thinks that there has been too
|
||||||
The Web server (running the Web site) thinks that there has been too
|
|
||||||
long an interval of time between 1) the establishment of an IP
|
long an interval of time between 1) the establishment of an IP
|
||||||
connection (socket) between the client and the server and
|
connection (socket) between the client and the server and
|
||||||
2) the receipt of any data on that socket, so the server has dropped
|
2) the receipt of any data on that socket, so the server has dropped
|
||||||
the connection. The socket connection has actually been lost - the Web
|
the connection. The socket connection has actually been lost - the Web
|
||||||
server has 'timed out' on that particular socket connection.
|
server has 'timed out' on that particular socket connection.
|
||||||
|
|
||||||
This is an internal exception thrown by Sanic and should not be used
|
|
||||||
directly.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 408
|
status_code = 408
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
|
|
||||||
class PayloadTooLarge(HTTPException):
|
class PayloadTooLarge(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 413 Payload Too Large
|
**Status**: 413 Payload Too Large
|
||||||
|
|
||||||
This is an internal exception thrown by Sanic and should not be used
|
|
||||||
directly.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 413
|
status_code = 413
|
||||||
@@ -384,126 +147,34 @@ class PayloadTooLarge(HTTPException):
|
|||||||
class HeaderNotFound(BadRequest):
|
class HeaderNotFound(BadRequest):
|
||||||
"""
|
"""
|
||||||
**Status**: 400 Bad Request
|
**Status**: 400 Bad Request
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
class InvalidHeader(BadRequest):
|
class InvalidHeader(BadRequest):
|
||||||
"""
|
"""
|
||||||
**Status**: 400 Bad Request
|
**Status**: 400 Bad Request
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
class ContentRange(Protocol):
|
class RangeNotSatisfiable(SanicException):
|
||||||
total: int
|
|
||||||
|
|
||||||
|
|
||||||
class RangeNotSatisfiable(HTTPException):
|
|
||||||
"""
|
"""
|
||||||
**Status**: 416 Range Not Satisfiable
|
**Status**: 416 Range Not Satisfiable
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Range Not Satisfiable' will be sent,
|
|
||||||
defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param content_range: An object meeting the :class:`.ContentRange` protocol
|
|
||||||
that has a ``total`` property, defaults to None
|
|
||||||
:type content_range: Optional[ContentRange], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 416
|
status_code = 416
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, message, content_range):
|
||||||
self,
|
super().__init__(message)
|
||||||
message: Optional[Union[str, bytes]] = None,
|
self.headers = {"Content-Range": f"bytes */{content_range.total}"}
|
||||||
content_range: Optional[ContentRange] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
if content_range is not None:
|
|
||||||
self.headers = {
|
|
||||||
**self.headers,
|
|
||||||
"Content-Range": f"bytes */{content_range.total}",
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
ContentRangeError = RangeNotSatisfiable
|
ContentRangeError = RangeNotSatisfiable
|
||||||
|
|
||||||
|
|
||||||
class ExpectationFailed(HTTPException):
|
class ExpectationFailed(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 417 Expectation Failed
|
**Status**: 417 Expectation Failed
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Expectation Failed' will be sent,
|
|
||||||
defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 417
|
status_code = 417
|
||||||
@@ -513,25 +184,9 @@ class ExpectationFailed(HTTPException):
|
|||||||
HeaderExpectationFailed = ExpectationFailed
|
HeaderExpectationFailed = ExpectationFailed
|
||||||
|
|
||||||
|
|
||||||
class Forbidden(HTTPException):
|
class Forbidden(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 403 Forbidden
|
**Status**: 403 Forbidden
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Forbidden' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 403
|
status_code = 403
|
||||||
@@ -547,33 +202,20 @@ class InvalidRangeType(RangeNotSatisfiable):
|
|||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
|
|
||||||
class PyFileError(SanicException):
|
class PyFileError(Exception):
|
||||||
def __init__(
|
def __init__(self, file):
|
||||||
self,
|
super().__init__("could not execute config file %s", file)
|
||||||
file,
|
|
||||||
status_code: Optional[int] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
"could not execute config file %s" % file,
|
|
||||||
status_code=status_code,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class Unauthorized(HTTPException):
|
class Unauthorized(SanicException):
|
||||||
"""
|
"""
|
||||||
**Status**: 401 Unauthorized
|
**Status**: 401 Unauthorized
|
||||||
|
|
||||||
When present, additional keyword arguments may be used to complete
|
:param message: Message describing the exception.
|
||||||
the WWW-Authentication header.
|
:param status_code: HTTP Status code.
|
||||||
|
:param scheme: Name of the authentication scheme to be used.
|
||||||
|
|
||||||
|
When present, kwargs is used to complete the WWW-Authentication header.
|
||||||
|
|
||||||
Examples::
|
Examples::
|
||||||
|
|
||||||
@@ -598,58 +240,21 @@ class Unauthorized(HTTPException):
|
|||||||
raise Unauthorized("Auth required.",
|
raise Unauthorized("Auth required.",
|
||||||
scheme="Bearer",
|
scheme="Bearer",
|
||||||
realm="Restricted Area")
|
realm="Restricted Area")
|
||||||
|
|
||||||
:param message: The message to be sent to the client. If ``None``
|
|
||||||
then the HTTP status 'Bad Request' will be sent, defaults to None
|
|
||||||
:type message: Optional[Union[str, bytes]], optional
|
|
||||||
:param scheme: Name of the authentication scheme to be used.
|
|
||||||
:type scheme: Optional[str], optional
|
|
||||||
:param quiet: When ``True``, the error traceback will be suppressed
|
|
||||||
from the logs, defaults to None
|
|
||||||
:type quiet: Optional[bool], optional
|
|
||||||
:param context: Additional mapping of key/value data that will be
|
|
||||||
sent to the client upon exception, defaults to None
|
|
||||||
:type context: Optional[Dict[str, Any]], optional
|
|
||||||
:param extra: Additional mapping of key/value data that will NOT be
|
|
||||||
sent to the client when in PRODUCTION mode, defaults to None
|
|
||||||
:type extra: Optional[Dict[str, Any]], optional
|
|
||||||
:param headers: Additional headers that should be sent with the HTTP
|
|
||||||
response, defaults to None
|
|
||||||
:type headers: Optional[Dict[str, Any]], optional
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
status_code = 401
|
status_code = 401
|
||||||
quiet = True
|
quiet = True
|
||||||
|
|
||||||
def __init__(
|
def __init__(self, message, status_code=None, scheme=None, **kwargs):
|
||||||
self,
|
super().__init__(message, status_code)
|
||||||
message: Optional[Union[str, bytes]] = None,
|
|
||||||
scheme: Optional[str] = None,
|
|
||||||
*,
|
|
||||||
quiet: Optional[bool] = None,
|
|
||||||
context: Optional[Dict[str, Any]] = None,
|
|
||||||
extra: Optional[Dict[str, Any]] = None,
|
|
||||||
headers: Optional[Dict[str, Any]] = None,
|
|
||||||
**challenges,
|
|
||||||
):
|
|
||||||
super().__init__(
|
|
||||||
message,
|
|
||||||
quiet=quiet,
|
|
||||||
context=context,
|
|
||||||
extra=extra,
|
|
||||||
headers=headers,
|
|
||||||
)
|
|
||||||
|
|
||||||
# if auth-scheme is specified, set "WWW-Authenticate" header
|
# if auth-scheme is specified, set "WWW-Authenticate" header
|
||||||
if scheme is not None:
|
if scheme is not None:
|
||||||
values = [
|
values = ['{!s}="{!s}"'.format(k, v) for k, v in kwargs.items()]
|
||||||
'{!s}="{!s}"'.format(k, v) for k, v in challenges.items()
|
|
||||||
]
|
|
||||||
challenge = ", ".join(values)
|
challenge = ", ".join(values)
|
||||||
|
|
||||||
self.headers = {
|
self.headers = {
|
||||||
**self.headers,
|
"WWW-Authenticate": f"{scheme} {challenge}".rstrip()
|
||||||
"WWW-Authenticate": f"{scheme} {challenge}".rstrip(),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -3,12 +3,14 @@ from __future__ import annotations
|
|||||||
from typing import Dict, List, Optional, Tuple, Type
|
from typing import Dict, List, Optional, Tuple, Type
|
||||||
|
|
||||||
from sanic.errorpages import BaseRenderer, TextRenderer, exception_response
|
from sanic.errorpages import BaseRenderer, TextRenderer, exception_response
|
||||||
from sanic.exceptions import ServerError
|
from sanic.exceptions import (
|
||||||
from sanic.log import error_logger
|
HeaderNotFound,
|
||||||
|
InvalidRangeType,
|
||||||
|
RangeNotSatisfiable,
|
||||||
|
)
|
||||||
|
from sanic.log import deprecation, error_logger
|
||||||
from sanic.models.handler_types import RouteHandler
|
from sanic.models.handler_types import RouteHandler
|
||||||
from sanic.request.types import Request
|
|
||||||
from sanic.response import text
|
from sanic.response import text
|
||||||
from sanic.response.types import HTTPResponse
|
|
||||||
|
|
||||||
|
|
||||||
class ErrorHandler:
|
class ErrorHandler:
|
||||||
@@ -21,6 +23,7 @@ class ErrorHandler:
|
|||||||
by the developers to perform a wide range of tasks from recording the error
|
by the developers to perform a wide range of tasks from recording the error
|
||||||
stats to reporting them to an external service that can be used for
|
stats to reporting them to an external service that can be used for
|
||||||
realtime alerting system.
|
realtime alerting system.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
@@ -33,6 +36,14 @@ class ErrorHandler:
|
|||||||
self.debug = False
|
self.debug = False
|
||||||
self.base = base
|
self.base = base
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def finalize(cls, *args, **kwargs):
|
||||||
|
deprecation(
|
||||||
|
"ErrorHandler.finalize is deprecated and no longer needed. "
|
||||||
|
"Please remove update your code to remove it. ",
|
||||||
|
22.12,
|
||||||
|
)
|
||||||
|
|
||||||
def _full_lookup(self, exception, route_name: Optional[str] = None):
|
def _full_lookup(self, exception, route_name: Optional[str] = None):
|
||||||
return self.lookup(exception, route_name)
|
return self.lookup(exception, route_name)
|
||||||
|
|
||||||
@@ -46,11 +57,16 @@ class ErrorHandler:
|
|||||||
if name is None:
|
if name is None:
|
||||||
name = "__ALL_ROUTES__"
|
name = "__ALL_ROUTES__"
|
||||||
|
|
||||||
message = (
|
error_logger.warning(
|
||||||
f"Duplicate exception handler definition on: route={name} "
|
f"Duplicate exception handler definition on: route={name} "
|
||||||
f"and exception={exc}"
|
f"and exception={exc}"
|
||||||
)
|
)
|
||||||
raise ServerError(message)
|
deprecation(
|
||||||
|
"A duplicate exception handler definition was discovered. "
|
||||||
|
"This may cause unintended consequences. A warning has been "
|
||||||
|
"issued now, but it will not be allowed starting in v23.3.",
|
||||||
|
23.3,
|
||||||
|
)
|
||||||
self.cached_handlers[key] = handler
|
self.cached_handlers[key] = handler
|
||||||
|
|
||||||
def add(self, exception, handler, route_names: Optional[List[str]] = None):
|
def add(self, exception, handler, route_names: Optional[List[str]] = None):
|
||||||
@@ -150,7 +166,7 @@ class ErrorHandler:
|
|||||||
return text("An error occurred while handling an error", 500)
|
return text("An error occurred while handling an error", 500)
|
||||||
return response
|
return response
|
||||||
|
|
||||||
def default(self, request: Request, exception: Exception) -> HTTPResponse:
|
def default(self, request, exception):
|
||||||
"""
|
"""
|
||||||
Provide a default behavior for the objects of :class:`ErrorHandler`.
|
Provide a default behavior for the objects of :class:`ErrorHandler`.
|
||||||
If a developer chooses to extent the :class:`ErrorHandler` they can
|
If a developer chooses to extent the :class:`ErrorHandler` they can
|
||||||
@@ -188,3 +204,74 @@ class ErrorHandler:
|
|||||||
error_logger.exception(
|
error_logger.exception(
|
||||||
"Exception occurred while handling uri: %s", url
|
"Exception occurred while handling uri: %s", url
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class ContentRangeHandler:
|
||||||
|
"""
|
||||||
|
A mechanism to parse and process the incoming request headers to
|
||||||
|
extract the content range information.
|
||||||
|
|
||||||
|
:param request: Incoming api request
|
||||||
|
:param stats: Stats related to the content
|
||||||
|
|
||||||
|
:type request: :class:`sanic.request.Request`
|
||||||
|
:type stats: :class:`posix.stat_result`
|
||||||
|
|
||||||
|
:ivar start: Content Range start
|
||||||
|
:ivar end: Content Range end
|
||||||
|
:ivar size: Length of the content
|
||||||
|
:ivar total: Total size identified by the :class:`posix.stat_result`
|
||||||
|
instance
|
||||||
|
:ivar ContentRangeHandler.headers: Content range header ``dict``
|
||||||
|
"""
|
||||||
|
|
||||||
|
__slots__ = ("start", "end", "size", "total", "headers")
|
||||||
|
|
||||||
|
def __init__(self, request, stats):
|
||||||
|
self.total = stats.st_size
|
||||||
|
_range = request.headers.getone("range", None)
|
||||||
|
if _range is None:
|
||||||
|
raise HeaderNotFound("Range Header Not Found")
|
||||||
|
unit, _, value = tuple(map(str.strip, _range.partition("=")))
|
||||||
|
if unit != "bytes":
|
||||||
|
raise InvalidRangeType(
|
||||||
|
"%s is not a valid Range Type" % (unit,), self
|
||||||
|
)
|
||||||
|
start_b, _, end_b = tuple(map(str.strip, value.partition("-")))
|
||||||
|
try:
|
||||||
|
self.start = int(start_b) if start_b else None
|
||||||
|
except ValueError:
|
||||||
|
raise RangeNotSatisfiable(
|
||||||
|
"'%s' is invalid for Content Range" % (start_b,), self
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
self.end = int(end_b) if end_b else None
|
||||||
|
except ValueError:
|
||||||
|
raise RangeNotSatisfiable(
|
||||||
|
"'%s' is invalid for Content Range" % (end_b,), self
|
||||||
|
)
|
||||||
|
if self.end is None:
|
||||||
|
if self.start is None:
|
||||||
|
raise RangeNotSatisfiable(
|
||||||
|
"Invalid for Content Range parameters", self
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
# this case represents `Content-Range: bytes 5-`
|
||||||
|
self.end = self.total - 1
|
||||||
|
else:
|
||||||
|
if self.start is None:
|
||||||
|
# this case represents `Content-Range: bytes -5`
|
||||||
|
self.start = self.total - self.end
|
||||||
|
self.end = self.total - 1
|
||||||
|
if self.start >= self.end:
|
||||||
|
raise RangeNotSatisfiable(
|
||||||
|
"Invalid for Content Range parameters", self
|
||||||
|
)
|
||||||
|
self.size = self.end - self.start + 1
|
||||||
|
self.headers = {
|
||||||
|
"Content-Range": "bytes %s-%s/%s"
|
||||||
|
% (self.start, self.end, self.total)
|
||||||
|
}
|
||||||
|
|
||||||
|
def __bool__(self):
|
||||||
|
return self.size > 0
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
from .content_range import ContentRangeHandler
|
|
||||||
from .directory import DirectoryHandler
|
|
||||||
from .error import ErrorHandler
|
|
||||||
|
|
||||||
|
|
||||||
__all__ = (
|
|
||||||
"ContentRangeHandler",
|
|
||||||
"DirectoryHandler",
|
|
||||||
"ErrorHandler",
|
|
||||||
)
|
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
from sanic.exceptions import (
|
|
||||||
HeaderNotFound,
|
|
||||||
InvalidRangeType,
|
|
||||||
RangeNotSatisfiable,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class ContentRangeHandler:
|
|
||||||
"""
|
|
||||||
A mechanism to parse and process the incoming request headers to
|
|
||||||
extract the content range information.
|
|
||||||
|
|
||||||
:param request: Incoming api request
|
|
||||||
:param stats: Stats related to the content
|
|
||||||
|
|
||||||
:type request: :class:`sanic.request.Request`
|
|
||||||
:type stats: :class:`posix.stat_result`
|
|
||||||
|
|
||||||
:ivar start: Content Range start
|
|
||||||
:ivar end: Content Range end
|
|
||||||
:ivar size: Length of the content
|
|
||||||
:ivar total: Total size identified by the :class:`posix.stat_result`
|
|
||||||
instance
|
|
||||||
:ivar ContentRangeHandler.headers: Content range header ``dict``
|
|
||||||
"""
|
|
||||||
|
|
||||||
__slots__ = ("start", "end", "size", "total", "headers")
|
|
||||||
|
|
||||||
def __init__(self, request, stats):
|
|
||||||
self.total = stats.st_size
|
|
||||||
_range = request.headers.getone("range", None)
|
|
||||||
if _range is None:
|
|
||||||
raise HeaderNotFound("Range Header Not Found")
|
|
||||||
unit, _, value = tuple(map(str.strip, _range.partition("=")))
|
|
||||||
if unit != "bytes":
|
|
||||||
raise InvalidRangeType(
|
|
||||||
"%s is not a valid Range Type" % (unit,), self
|
|
||||||
)
|
|
||||||
start_b, _, end_b = tuple(map(str.strip, value.partition("-")))
|
|
||||||
try:
|
|
||||||
self.start = int(start_b) if start_b else None
|
|
||||||
except ValueError:
|
|
||||||
raise RangeNotSatisfiable(
|
|
||||||
"'%s' is invalid for Content Range" % (start_b,), self
|
|
||||||
)
|
|
||||||
try:
|
|
||||||
self.end = int(end_b) if end_b else None
|
|
||||||
except ValueError:
|
|
||||||
raise RangeNotSatisfiable(
|
|
||||||
"'%s' is invalid for Content Range" % (end_b,), self
|
|
||||||
)
|
|
||||||
if self.end is None:
|
|
||||||
if self.start is None:
|
|
||||||
raise RangeNotSatisfiable(
|
|
||||||
"Invalid for Content Range parameters", self
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
# this case represents `Content-Range: bytes 5-`
|
|
||||||
self.end = self.total - 1
|
|
||||||
else:
|
|
||||||
if self.start is None:
|
|
||||||
# this case represents `Content-Range: bytes -5`
|
|
||||||
self.start = self.total - self.end
|
|
||||||
self.end = self.total - 1
|
|
||||||
if self.start >= self.end:
|
|
||||||
raise RangeNotSatisfiable(
|
|
||||||
"Invalid for Content Range parameters", self
|
|
||||||
)
|
|
||||||
self.size = self.end - self.start + 1
|
|
||||||
self.headers = {
|
|
||||||
"Content-Range": "bytes %s-%s/%s"
|
|
||||||
% (self.start, self.end, self.total)
|
|
||||||
}
|
|
||||||
|
|
||||||
def __bool__(self):
|
|
||||||
return hasattr(self, "size") and self.size > 0
|
|
||||||
@@ -1,84 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
from datetime import datetime
|
|
||||||
from operator import itemgetter
|
|
||||||
from pathlib import Path
|
|
||||||
from stat import S_ISDIR
|
|
||||||
from typing import Dict, Iterable, Optional, Sequence, Union, cast
|
|
||||||
|
|
||||||
from sanic.exceptions import NotFound
|
|
||||||
from sanic.pages.directory_page import DirectoryPage, FileInfo
|
|
||||||
from sanic.request import Request
|
|
||||||
from sanic.response import file, html, redirect
|
|
||||||
|
|
||||||
|
|
||||||
class DirectoryHandler:
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
uri: str,
|
|
||||||
directory: Path,
|
|
||||||
directory_view: bool = False,
|
|
||||||
index: Optional[Union[str, Sequence[str]]] = None,
|
|
||||||
) -> None:
|
|
||||||
if isinstance(index, str):
|
|
||||||
index = [index]
|
|
||||||
elif index is None:
|
|
||||||
index = []
|
|
||||||
self.base = uri.strip("/")
|
|
||||||
self.directory = directory
|
|
||||||
self.directory_view = directory_view
|
|
||||||
self.index = tuple(index)
|
|
||||||
|
|
||||||
async def handle(self, request: Request, path: str):
|
|
||||||
current = path.strip("/")[len(self.base) :].strip("/") # noqa: E203
|
|
||||||
for file_name in self.index:
|
|
||||||
index_file = self.directory / current / file_name
|
|
||||||
if index_file.is_file():
|
|
||||||
return await file(index_file)
|
|
||||||
|
|
||||||
if self.directory_view:
|
|
||||||
return self._index(
|
|
||||||
self.directory / current, path, request.app.debug
|
|
||||||
)
|
|
||||||
|
|
||||||
if self.index:
|
|
||||||
raise NotFound("File not found")
|
|
||||||
|
|
||||||
raise IsADirectoryError(f"{self.directory.as_posix()} is a directory")
|
|
||||||
|
|
||||||
def _index(self, location: Path, path: str, debug: bool):
|
|
||||||
# Remove empty path elements, append slash
|
|
||||||
if "//" in path or not path.endswith("/"):
|
|
||||||
return redirect(
|
|
||||||
"/" + "".join([f"{p}/" for p in path.split("/") if p])
|
|
||||||
)
|
|
||||||
|
|
||||||
# Render file browser
|
|
||||||
page = DirectoryPage(self._iter_files(location), path, debug)
|
|
||||||
return html(page.render())
|
|
||||||
|
|
||||||
def _prepare_file(self, path: Path) -> Dict[str, Union[int, str]]:
|
|
||||||
stat = path.stat()
|
|
||||||
modified = (
|
|
||||||
datetime.fromtimestamp(stat.st_mtime)
|
|
||||||
.isoformat()[:19]
|
|
||||||
.replace("T", " ")
|
|
||||||
)
|
|
||||||
is_dir = S_ISDIR(stat.st_mode)
|
|
||||||
icon = "📁" if is_dir else "📄"
|
|
||||||
file_name = path.name
|
|
||||||
if is_dir:
|
|
||||||
file_name += "/"
|
|
||||||
return {
|
|
||||||
"priority": is_dir * -1,
|
|
||||||
"file_name": file_name,
|
|
||||||
"icon": icon,
|
|
||||||
"file_access": modified,
|
|
||||||
"file_size": stat.st_size,
|
|
||||||
}
|
|
||||||
|
|
||||||
def _iter_files(self, location: Path) -> Iterable[FileInfo]:
|
|
||||||
prepared = [self._prepare_file(f) for f in location.iterdir()]
|
|
||||||
for item in sorted(prepared, key=itemgetter("priority", "file_name")):
|
|
||||||
del item["priority"]
|
|
||||||
yield cast(FileInfo, item)
|
|
||||||
380
sanic/headers.py
380
sanic/headers.py
@@ -19,6 +19,7 @@ OptionsIterable = Iterable[Tuple[str, str]] # May contain duplicate keys
|
|||||||
|
|
||||||
_token, _quoted = r"([\w!#$%&'*+\-.^_`|~]+)", r'"([^"]*)"'
|
_token, _quoted = r"([\w!#$%&'*+\-.^_`|~]+)", r'"([^"]*)"'
|
||||||
_param = re.compile(rf";\s*{_token}=(?:{_token}|{_quoted})", re.ASCII)
|
_param = re.compile(rf";\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 = "(?:[0-9A-Fa-f]{0,4}:){2,7}[0-9A-Fa-f]{0,4}"
|
||||||
_ipv6_re = re.compile(_ipv6)
|
_ipv6_re = re.compile(_ipv6)
|
||||||
_host_re = re.compile(
|
_host_re = re.compile(
|
||||||
@@ -32,96 +33,143 @@ _host_re = re.compile(
|
|||||||
# For more information, consult ../tests/test_requests.py
|
# For more information, consult ../tests/test_requests.py
|
||||||
|
|
||||||
|
|
||||||
class MediaType:
|
def parse_arg_as_accept(f):
|
||||||
"""A media type, as used in the Accept header."""
|
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__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
type_: str,
|
value: str,
|
||||||
subtype: str,
|
type_: MediaType,
|
||||||
**params: str,
|
subtype: MediaType,
|
||||||
|
*,
|
||||||
|
q: str = "1.0",
|
||||||
|
**kwargs: str,
|
||||||
):
|
):
|
||||||
self.type = type_
|
qvalue = float(q)
|
||||||
self.subtype = subtype
|
if qvalue > 1 or qvalue < 0:
|
||||||
self.q = float(params.get("q", "1.0"))
|
raise InvalidHeader(
|
||||||
self.params = params
|
f"Accept header qvalue must be between 0 and 1, not: {qvalue}"
|
||||||
self.mime = f"{type_}/{subtype}"
|
|
||||||
self.key = (
|
|
||||||
-1 * self.q,
|
|
||||||
-1 * len(self.params),
|
|
||||||
self.subtype == "*",
|
|
||||||
self.type == "*",
|
|
||||||
)
|
)
|
||||||
|
self.value = value
|
||||||
|
self.type_ = type_
|
||||||
|
self.subtype = subtype
|
||||||
|
self.qvalue = qvalue
|
||||||
|
self.params = kwargs
|
||||||
|
|
||||||
def __repr__(self):
|
def _compare(self, other, method):
|
||||||
return self.mime + "".join(f";{k}={v}" for k, v in self.params.items())
|
try:
|
||||||
|
return method(self.qvalue, other.qvalue)
|
||||||
def __eq__(self, other):
|
except (AttributeError, TypeError):
|
||||||
"""Check for mime (str or MediaType) identical type/subtype.
|
|
||||||
Parameters such as q are not considered."""
|
|
||||||
if isinstance(other, str):
|
|
||||||
# Give a friendly reminder if str contains parameters
|
|
||||||
if ";" in other:
|
|
||||||
raise ValueError("Use match() to compare with parameters")
|
|
||||||
return self.mime == other
|
|
||||||
if isinstance(other, MediaType):
|
|
||||||
# Ignore parameters silently with MediaType objects
|
|
||||||
return self.mime == other.mime
|
|
||||||
return NotImplemented
|
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(
|
def match(
|
||||||
self,
|
self,
|
||||||
mime_with_params: Union[str, MediaType],
|
other,
|
||||||
) -> Optional[MediaType]:
|
*,
|
||||||
"""Check if this media type matches the given mime type/subtype.
|
allow_type_wildcard: bool = True,
|
||||||
Wildcards are supported both ways on both type and subtype.
|
allow_subtype_wildcard: bool = True,
|
||||||
If mime contains a semicolon, optionally followed by parameters,
|
) -> bool:
|
||||||
the parameters of the two media types must match exactly.
|
type_match = (
|
||||||
Note: Use the `==` operator instead to check for literal matches
|
self.type_ == other.type_
|
||||||
without expanding wildcards.
|
if allow_type_wildcard
|
||||||
@param media_type: A type/subtype string to match.
|
else (
|
||||||
@return `self` if the media types are compatible, else `None`
|
self.type_.match(other.type_)
|
||||||
"""
|
and not self.type_.is_wildcard
|
||||||
mt = (
|
and not other.type_.is_wildcard
|
||||||
MediaType._parse(mime_with_params)
|
|
||||||
if isinstance(mime_with_params, str)
|
|
||||||
else mime_with_params
|
|
||||||
)
|
|
||||||
return (
|
|
||||||
self
|
|
||||||
if (
|
|
||||||
mt
|
|
||||||
# All parameters given in the other media type must match
|
|
||||||
and all(self.params.get(k) == v for k, v in mt.params.items())
|
|
||||||
# Subtype match
|
|
||||||
and (
|
|
||||||
self.subtype == mt.subtype
|
|
||||||
or self.subtype == "*"
|
|
||||||
or mt.subtype == "*"
|
|
||||||
)
|
|
||||||
# Type match
|
|
||||||
and (
|
|
||||||
self.type == mt.type or self.type == "*" or mt.type == "*"
|
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
else None
|
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
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
@property
|
return type_match and subtype_match
|
||||||
def has_wildcard(self) -> bool:
|
|
||||||
"""Return True if this media type has a wildcard in it."""
|
|
||||||
return any(part == "*" for part in (self.subtype, self.type))
|
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def _parse(cls, mime_with_params: str) -> Optional[MediaType]:
|
def parse(cls, raw: str) -> Accept:
|
||||||
mtype = mime_with_params.strip()
|
invalid = False
|
||||||
if "/" not in mime_with_params:
|
mtype = raw.strip()
|
||||||
return None
|
|
||||||
|
|
||||||
mime, *raw_params = mtype.split(";")
|
try:
|
||||||
type_, subtype = mime.split("/", 1)
|
media, *raw_params = mtype.split(";")
|
||||||
if not type_ or not subtype:
|
type_, subtype = media.split("/")
|
||||||
raise ValueError(f"Invalid media type: {mtype}")
|
except ValueError:
|
||||||
|
invalid = True
|
||||||
|
|
||||||
|
if invalid or not type_ or not subtype:
|
||||||
|
raise InvalidHeader(f"Header contains invalid Accept value: {raw}")
|
||||||
|
|
||||||
params = dict(
|
params = dict(
|
||||||
[
|
[
|
||||||
@@ -130,160 +178,46 @@ class MediaType:
|
|||||||
]
|
]
|
||||||
)
|
)
|
||||||
|
|
||||||
return cls(type_.lstrip(), subtype.rstrip(), **params)
|
return cls(mtype, MediaType(type_), MediaType(subtype), **params)
|
||||||
|
|
||||||
|
|
||||||
class Matched:
|
class AcceptContainer(list):
|
||||||
"""A matching result of a MIME string against a header."""
|
def __contains__(self, o: object) -> bool:
|
||||||
|
return any(item.match(o) for item in self)
|
||||||
|
|
||||||
def __init__(self, mime: str, header: Optional[MediaType]):
|
def match(
|
||||||
self.mime = mime
|
self,
|
||||||
self.header = header
|
o: object,
|
||||||
|
*,
|
||||||
def __repr__(self):
|
allow_type_wildcard: bool = True,
|
||||||
return f"<{self} matched {self.header}>" if self else "<no match>"
|
allow_subtype_wildcard: bool = True,
|
||||||
|
) -> bool:
|
||||||
def __str__(self):
|
return any(
|
||||||
return self.mime
|
item.match(
|
||||||
|
o,
|
||||||
def __bool__(self):
|
allow_type_wildcard=allow_type_wildcard,
|
||||||
return self.header is not None
|
allow_subtype_wildcard=allow_subtype_wildcard,
|
||||||
|
|
||||||
def __eq__(self, other: Any) -> bool:
|
|
||||||
try:
|
|
||||||
comp, other_accept = self._compare(other)
|
|
||||||
except TypeError:
|
|
||||||
return False
|
|
||||||
|
|
||||||
return bool(
|
|
||||||
comp
|
|
||||||
and (
|
|
||||||
(self.header and other_accept.header)
|
|
||||||
or (not self.header and not other_accept.header)
|
|
||||||
)
|
)
|
||||||
|
for item in self
|
||||||
)
|
)
|
||||||
|
|
||||||
def _compare(self, other) -> Tuple[bool, Matched]:
|
|
||||||
if isinstance(other, str):
|
|
||||||
parsed = Matched.parse(other)
|
|
||||||
if self.mime == other:
|
|
||||||
return True, parsed
|
|
||||||
other = parsed
|
|
||||||
|
|
||||||
if isinstance(other, Matched):
|
|
||||||
return self.header == other.header, other
|
|
||||||
|
|
||||||
raise TypeError(
|
|
||||||
"Comparison not supported between unequal "
|
|
||||||
f"mime types of '{self.mime}' and '{other}'"
|
|
||||||
)
|
|
||||||
|
|
||||||
def match(self, other: Union[str, Matched]) -> Optional[Matched]:
|
|
||||||
accept = Matched.parse(other) if isinstance(other, str) else other
|
|
||||||
if not self.header or not accept.header:
|
|
||||||
return None
|
|
||||||
if self.header.match(accept.header):
|
|
||||||
return accept
|
|
||||||
return None
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def parse(cls, raw: str) -> Matched:
|
|
||||||
media_type = MediaType._parse(raw)
|
|
||||||
return cls(raw, media_type)
|
|
||||||
|
|
||||||
|
|
||||||
class AcceptList(list):
|
|
||||||
"""A list of media types, as used in the Accept header.
|
|
||||||
|
|
||||||
The Accept header entries are listed in order of preference, starting
|
|
||||||
with the most preferred. This class is a list of `MediaType` objects,
|
|
||||||
that encapsulate also the q value or any other parameters.
|
|
||||||
|
|
||||||
Two separate methods are provided for searching the list:
|
|
||||||
- 'match' for finding the most preferred match (wildcards supported)
|
|
||||||
- operator 'in' for checking explicit matches (wildcards as literals)
|
|
||||||
"""
|
|
||||||
|
|
||||||
def match(self, *mimes: str, accept_wildcards=True) -> Matched:
|
|
||||||
"""Find a media type accepted by the client.
|
|
||||||
|
|
||||||
This method can be used to find which of the media types requested by
|
|
||||||
the client is most preferred against the ones given as arguments.
|
|
||||||
|
|
||||||
The ordering of preference is set by:
|
|
||||||
1. The order set by RFC 7231, s. 5.3.2, giving a higher priority
|
|
||||||
to q values and more specific type definitions,
|
|
||||||
2. The order of the arguments (first is most preferred), and
|
|
||||||
3. The first matching entry on the Accept header.
|
|
||||||
|
|
||||||
Wildcards are matched both ways. A match is usually found, as the
|
|
||||||
Accept headers typically include `*/*`, in particular if the header
|
|
||||||
is missing, is not manually set, or if the client is a browser.
|
|
||||||
|
|
||||||
Note: the returned object behaves as a string of the mime argument
|
|
||||||
that matched, and is empty/falsy if no match was found. The matched
|
|
||||||
header entry `MediaType` or `None` is available as the `m` attribute.
|
|
||||||
|
|
||||||
@param mimes: Any MIME types to search for in order of preference.
|
|
||||||
@param accept_wildcards: Match Accept entries with wildcards in them.
|
|
||||||
@return A match object with the mime string and the MediaType object.
|
|
||||||
"""
|
|
||||||
a = sorted(
|
|
||||||
(-acc.q, i, j, mime, acc)
|
|
||||||
for j, acc in enumerate(self)
|
|
||||||
if accept_wildcards or not acc.has_wildcard
|
|
||||||
for i, mime in enumerate(mimes)
|
|
||||||
if acc.match(mime)
|
|
||||||
)
|
|
||||||
return Matched(*(a[0][-2:] if a else ("", None)))
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
"""Format as Accept header value (parsed, not original)."""
|
|
||||||
return ", ".join(str(m) for m in self)
|
|
||||||
|
|
||||||
|
|
||||||
def parse_accept(accept: Optional[str]) -> AcceptList:
|
|
||||||
"""Parse an Accept header and order the acceptable media types in
|
|
||||||
according to RFC 7231, s. 5.3.2
|
|
||||||
https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2
|
|
||||||
"""
|
|
||||||
if not accept:
|
|
||||||
if accept == "":
|
|
||||||
return AcceptList() # Empty header, accept nothing
|
|
||||||
accept = "*/*" # No header means that all types are accepted
|
|
||||||
try:
|
|
||||||
a = [
|
|
||||||
mt
|
|
||||||
for mt in [MediaType._parse(mtype) for mtype in accept.split(",")]
|
|
||||||
if mt
|
|
||||||
]
|
|
||||||
if not a:
|
|
||||||
raise ValueError
|
|
||||||
return AcceptList(sorted(a, key=lambda x: x.key))
|
|
||||||
except ValueError:
|
|
||||||
raise InvalidHeader(f"Invalid header value in Accept: {accept}")
|
|
||||||
|
|
||||||
|
|
||||||
def parse_content_header(value: str) -> Tuple[str, Options]:
|
def parse_content_header(value: str) -> Tuple[str, Options]:
|
||||||
"""Parse content-type and content-disposition header values.
|
"""Parse content-type and content-disposition header values.
|
||||||
|
|
||||||
E.g. `form-data; name=upload; filename="file.txt"` to
|
E.g. 'form-data; name=upload; filename=\"file.txt\"' to
|
||||||
('form-data', {'name': 'upload', 'filename': 'file.txt'})
|
('form-data', {'name': 'upload', 'filename': 'file.txt'})
|
||||||
|
|
||||||
Mostly identical to cgi.parse_header and werkzeug.parse_options_header
|
Mostly identical to cgi.parse_header and werkzeug.parse_options_header
|
||||||
but runs faster and handles special characters better.
|
but runs faster and handles special characters better. Unescapes quotes.
|
||||||
|
|
||||||
Unescapes %22 to `"` and %0D%0A to `\n` in field values.
|
|
||||||
"""
|
"""
|
||||||
|
value = _firefox_quote_escape.sub("%22", value)
|
||||||
pos = value.find(";")
|
pos = value.find(";")
|
||||||
if pos == -1:
|
if pos == -1:
|
||||||
options: Dict[str, Union[int, str]] = {}
|
options: Dict[str, Union[int, str]] = {}
|
||||||
else:
|
else:
|
||||||
options = {
|
options = {
|
||||||
m.group(1)
|
m.group(1).lower(): m.group(2) or m.group(3).replace("%22", '"')
|
||||||
.lower(): (m.group(2) or m.group(3))
|
|
||||||
.replace("%22", '"')
|
|
||||||
.replace("%0D%0A", "\n")
|
|
||||||
for m in _param.finditer(value[pos:])
|
for m in _param.finditer(value[pos:])
|
||||||
}
|
}
|
||||||
value = value[:pos]
|
value = value[:pos]
|
||||||
@@ -434,9 +368,37 @@ def format_http1_response(status: int, headers: HeaderBytesIterable) -> bytes:
|
|||||||
return ret
|
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(
|
def parse_credentials(
|
||||||
header: Optional[str],
|
header: Optional[str],
|
||||||
prefixes: Optional[Union[List, Tuple, Set]] = None,
|
prefixes: Union[List, Tuple, Set] = None,
|
||||||
) -> Tuple[Optional[str], Optional[str]]:
|
) -> Tuple[Optional[str], Optional[str]]:
|
||||||
"""Parses any header with the aim to retrieve any credentials from it."""
|
"""Parses any header with the aim to retrieve any credentials from it."""
|
||||||
if not prefixes or not isinstance(prefixes, (list, tuple, set)):
|
if not prefixes or not isinstance(prefixes, (list, tuple, set)):
|
||||||
|
|||||||
@@ -1,7 +1,5 @@
|
|||||||
"""Defines basics of HTTP standard."""
|
"""Defines basics of HTTP standard."""
|
||||||
|
|
||||||
import sys
|
|
||||||
|
|
||||||
from importlib import import_module
|
from importlib import import_module
|
||||||
from inspect import ismodule
|
from inspect import ismodule
|
||||||
from typing import Dict
|
from typing import Dict
|
||||||
@@ -159,10 +157,6 @@ def import_string(module_name, package=None):
|
|||||||
return obj()
|
return obj()
|
||||||
|
|
||||||
|
|
||||||
def is_atty() -> bool:
|
|
||||||
return bool(sys.stdout and sys.stdout.isatty())
|
|
||||||
|
|
||||||
|
|
||||||
class Default:
|
class Default:
|
||||||
"""
|
"""
|
||||||
It is used to replace `None` or `object()` as a sentinel
|
It is used to replace `None` or `object()` as a sentinel
|
||||||
|
|||||||
@@ -71,6 +71,7 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
"request_body",
|
"request_body",
|
||||||
"request_bytes",
|
"request_bytes",
|
||||||
"request_bytes_left",
|
"request_bytes_left",
|
||||||
|
"request_max_size",
|
||||||
"response",
|
"response",
|
||||||
"response_func",
|
"response_func",
|
||||||
"response_size",
|
"response_size",
|
||||||
@@ -240,14 +241,9 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
headers_instance.getone("upgrade", "").lower() == "websocket"
|
headers_instance.getone("upgrade", "").lower() == "websocket"
|
||||||
)
|
)
|
||||||
|
|
||||||
try:
|
|
||||||
url_bytes = self.url.encode("ASCII")
|
|
||||||
except UnicodeEncodeError:
|
|
||||||
raise BadRequest("URL may only contain US-ASCII characters.")
|
|
||||||
|
|
||||||
# Prepare a Request object
|
# Prepare a Request object
|
||||||
request = self.protocol.request_class(
|
request = self.protocol.request_class(
|
||||||
url_bytes=url_bytes,
|
url_bytes=self.url.encode(),
|
||||||
headers=headers_instance,
|
headers=headers_instance,
|
||||||
head=bytes(head),
|
head=bytes(head),
|
||||||
version=protocol[5:],
|
version=protocol[5:],
|
||||||
@@ -433,9 +429,7 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
if self.request is None:
|
if self.request is None:
|
||||||
self.create_empty_request()
|
self.create_empty_request()
|
||||||
|
|
||||||
request_middleware = not isinstance(
|
request_middleware = not isinstance(exception, ServiceUnavailable)
|
||||||
exception, (ServiceUnavailable, RequestCancelled)
|
|
||||||
)
|
|
||||||
try:
|
try:
|
||||||
await app.handle_exception(
|
await app.handle_exception(
|
||||||
self.request, exception, request_middleware
|
self.request, exception, request_middleware
|
||||||
@@ -450,18 +444,9 @@ class Http(Stream, metaclass=TouchUpMeta):
|
|||||||
bogus response for error handling use.
|
bogus response for error handling use.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# Reformat any URL already received with \xHH escapes for better logs
|
|
||||||
url_bytes = (
|
|
||||||
self.url.encode(errors="surrogateescape")
|
|
||||||
.decode("ASCII", errors="backslashreplace")
|
|
||||||
.encode("ASCII")
|
|
||||||
if self.url
|
|
||||||
else b"*"
|
|
||||||
)
|
|
||||||
|
|
||||||
# FIXME: Avoid this by refactoring error handling and response code
|
# FIXME: Avoid this by refactoring error handling and response code
|
||||||
self.request = self.protocol.request_class(
|
self.request = self.protocol.request_class(
|
||||||
url_bytes=url_bytes,
|
url_bytes=self.url.encode() if self.url else b"*",
|
||||||
headers=Header({}),
|
headers=Header({}),
|
||||||
version="1.1",
|
version="1.1",
|
||||||
method="NONE",
|
method="NONE",
|
||||||
|
|||||||
@@ -18,12 +18,7 @@ from typing import (
|
|||||||
|
|
||||||
from sanic.compat import Header
|
from sanic.compat import Header
|
||||||
from sanic.constants import LocalCertCreator
|
from sanic.constants import LocalCertCreator
|
||||||
from sanic.exceptions import (
|
from sanic.exceptions import PayloadTooLarge, SanicException, ServerError
|
||||||
BadRequest,
|
|
||||||
PayloadTooLarge,
|
|
||||||
SanicException,
|
|
||||||
ServerError,
|
|
||||||
)
|
|
||||||
from sanic.helpers import has_message_body
|
from sanic.helpers import has_message_body
|
||||||
from sanic.http.constants import Stage
|
from sanic.http.constants import Stage
|
||||||
from sanic.http.stream import Stream
|
from sanic.http.stream import Stream
|
||||||
@@ -338,17 +333,7 @@ class Http3:
|
|||||||
return self.receivers[stream_id]
|
return self.receivers[stream_id]
|
||||||
|
|
||||||
def _make_request(self, event: HeadersReceived) -> Request:
|
def _make_request(self, event: HeadersReceived) -> Request:
|
||||||
try:
|
headers = Header(((k.decode(), v.decode()) for k, v in event.headers))
|
||||||
headers = Header(
|
|
||||||
(
|
|
||||||
(k.decode("ASCII"), v.decode(errors="surrogateescape"))
|
|
||||||
for k, v in event.headers
|
|
||||||
)
|
|
||||||
)
|
|
||||||
except UnicodeDecodeError:
|
|
||||||
raise BadRequest(
|
|
||||||
"Header names may only contain US-ASCII characters."
|
|
||||||
)
|
|
||||||
method = headers[":method"]
|
method = headers[":method"]
|
||||||
path = headers[":path"]
|
path = headers[":path"]
|
||||||
scheme = headers.pop(":scheme", "")
|
scheme = headers.pop(":scheme", "")
|
||||||
@@ -357,14 +342,9 @@ class Http3:
|
|||||||
if authority:
|
if authority:
|
||||||
headers["host"] = authority
|
headers["host"] = authority
|
||||||
|
|
||||||
try:
|
|
||||||
url_bytes = path.encode("ASCII")
|
|
||||||
except UnicodeEncodeError:
|
|
||||||
raise BadRequest("URL may only contain US-ASCII characters.")
|
|
||||||
|
|
||||||
transport = HTTP3Transport(self.protocol)
|
transport = HTTP3Transport(self.protocol)
|
||||||
request = self.protocol.request_class(
|
request = self.protocol.request_class(
|
||||||
url_bytes,
|
path.encode(),
|
||||||
headers,
|
headers,
|
||||||
"3",
|
"3",
|
||||||
method,
|
method,
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ class Stream:
|
|||||||
request_max_size: Union[int, float]
|
request_max_size: Union[int, float]
|
||||||
|
|
||||||
__touchup__: Tuple[str, ...] = tuple()
|
__touchup__: Tuple[str, ...] = tuple()
|
||||||
__slots__ = ("request_max_size",)
|
__slots__ = ()
|
||||||
|
|
||||||
def respond(
|
def respond(
|
||||||
self, response: BaseHTTPResponse
|
self, response: BaseHTTPResponse
|
||||||
|
|||||||
@@ -24,14 +24,12 @@ def create_context(
|
|||||||
certfile: Optional[str] = None,
|
certfile: Optional[str] = None,
|
||||||
keyfile: Optional[str] = None,
|
keyfile: Optional[str] = None,
|
||||||
password: Optional[str] = None,
|
password: Optional[str] = None,
|
||||||
purpose: ssl.Purpose = ssl.Purpose.CLIENT_AUTH,
|
|
||||||
) -> ssl.SSLContext:
|
) -> ssl.SSLContext:
|
||||||
"""Create a context with secure crypto and HTTP/1.1 in protocols."""
|
"""Create a context with secure crypto and HTTP/1.1 in protocols."""
|
||||||
context = ssl.create_default_context(purpose=purpose)
|
context = ssl.create_default_context(purpose=ssl.Purpose.CLIENT_AUTH)
|
||||||
context.minimum_version = ssl.TLSVersion.TLSv1_2
|
context.minimum_version = ssl.TLSVersion.TLSv1_2
|
||||||
context.set_ciphers(":".join(CIPHERS_TLS12))
|
context.set_ciphers(":".join(CIPHERS_TLS12))
|
||||||
context.set_alpn_protocols(["http/1.1"])
|
context.set_alpn_protocols(["http/1.1"])
|
||||||
if purpose is ssl.Purpose.CLIENT_AUTH:
|
|
||||||
context.sni_callback = server_name_callback
|
context.sni_callback = server_name_callback
|
||||||
if certfile and keyfile:
|
if certfile and keyfile:
|
||||||
context.load_cert_chain(certfile, keyfile, password)
|
context.load_cert_chain(certfile, keyfile, password)
|
||||||
@@ -159,7 +157,7 @@ class CertSimple(SanicSSLContext):
|
|||||||
# try common aliases, rename to cert/key
|
# try common aliases, rename to cert/key
|
||||||
certfile = kw["cert"] = kw.pop("certificate", None) or cert
|
certfile = kw["cert"] = kw.pop("certificate", None) or cert
|
||||||
keyfile = kw["key"] = kw.pop("keyfile", None) or key
|
keyfile = kw["key"] = kw.pop("keyfile", None) or key
|
||||||
password = kw.get("password", None)
|
password = kw.pop("password", None)
|
||||||
if not certfile or not keyfile:
|
if not certfile or not keyfile:
|
||||||
raise ValueError("SSL dict needs filenames for cert and key.")
|
raise ValueError("SSL dict needs filenames for cert and key.")
|
||||||
subject = {}
|
subject = {}
|
||||||
|
|||||||
@@ -126,6 +126,7 @@ class CertCreator(ABC):
|
|||||||
local_tls_key,
|
local_tls_key,
|
||||||
local_tls_cert,
|
local_tls_cert,
|
||||||
) -> CertCreator:
|
) -> CertCreator:
|
||||||
|
|
||||||
creator: Optional[CertCreator] = None
|
creator: Optional[CertCreator] = None
|
||||||
|
|
||||||
cert_creator_options: Tuple[
|
cert_creator_options: Tuple[
|
||||||
|
|||||||
41
sanic/log.py
41
sanic/log.py
@@ -1,22 +1,10 @@
|
|||||||
import logging
|
import logging
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from enum import Enum
|
from typing import Any, Dict
|
||||||
from typing import TYPE_CHECKING, Any, Dict
|
|
||||||
from warnings import warn
|
from warnings import warn
|
||||||
|
|
||||||
from sanic.helpers import is_atty
|
from sanic.compat import StrEnum, is_atty
|
||||||
|
|
||||||
|
|
||||||
# Python 3.11 changed the way Enum formatting works for mixed-in types.
|
|
||||||
if sys.version_info < (3, 11, 0):
|
|
||||||
|
|
||||||
class StrEnum(str, Enum):
|
|
||||||
pass
|
|
||||||
|
|
||||||
else:
|
|
||||||
if not TYPE_CHECKING:
|
|
||||||
from enum import StrEnum
|
|
||||||
|
|
||||||
|
|
||||||
LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict( # no cov
|
LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict( # no cov
|
||||||
@@ -62,13 +50,13 @@ LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict( # no cov
|
|||||||
},
|
},
|
||||||
formatters={
|
formatters={
|
||||||
"generic": {
|
"generic": {
|
||||||
"format": "%(asctime)s [%(process)s] [%(levelname)s] %(message)s",
|
"format": "%(asctime)s [%(process)d] [%(levelname)s] %(message)s",
|
||||||
"datefmt": "[%Y-%m-%d %H:%M:%S %z]",
|
"datefmt": "[%Y-%m-%d %H:%M:%S %z]",
|
||||||
"class": "logging.Formatter",
|
"class": "logging.Formatter",
|
||||||
},
|
},
|
||||||
"access": {
|
"access": {
|
||||||
"format": "%(asctime)s - (%(name)s)[%(levelname)s][%(host)s]: "
|
"format": "%(asctime)s - (%(name)s)[%(levelname)s][%(host)s]: "
|
||||||
+ "%(request)s %(message)s %(status)s %(byte)s",
|
+ "%(request)s %(message)s %(status)d %(byte)d",
|
||||||
"datefmt": "[%Y-%m-%d %H:%M:%S %z]",
|
"datefmt": "[%Y-%m-%d %H:%M:%S %z]",
|
||||||
"class": "logging.Formatter",
|
"class": "logging.Formatter",
|
||||||
},
|
},
|
||||||
@@ -126,26 +114,7 @@ logger.addFilter(_verbosity_filter)
|
|||||||
|
|
||||||
|
|
||||||
def deprecation(message: str, version: float): # no cov
|
def deprecation(message: str, version: float): # no cov
|
||||||
"""
|
version_info = f"[DEPRECATION v{version}] "
|
||||||
Add a deprecation notice
|
|
||||||
|
|
||||||
Example when a feature is being removed. In this case, version
|
|
||||||
should be AT LEAST next version + 2
|
|
||||||
|
|
||||||
deprecation("Helpful message", 99.9)
|
|
||||||
|
|
||||||
Example when a feature is deprecated but not being removed:
|
|
||||||
|
|
||||||
deprecation("Helpful message", 0)
|
|
||||||
|
|
||||||
:param message: The message of the notice
|
|
||||||
:type message: str
|
|
||||||
:param version: The version when the feature will be removed. If it is
|
|
||||||
not being removed, then set version=0.
|
|
||||||
:type version: float
|
|
||||||
"""
|
|
||||||
version_display = f" v{version}" if version else ""
|
|
||||||
version_info = f"[DEPRECATION{version_display}] "
|
|
||||||
if is_atty():
|
if is_atty():
|
||||||
version_info = f"{Colors.RED}{version_info}"
|
version_info = f"{Colors.RED}{version_info}"
|
||||||
message = f"{Colors.YELLOW}{message}{Colors.END}"
|
message = f"{Colors.YELLOW}{message}{Colors.END}"
|
||||||
|
|||||||
@@ -32,9 +32,6 @@ class Middleware:
|
|||||||
def __call__(self, *args, **kwargs):
|
def __call__(self, *args, **kwargs):
|
||||||
return self.func(*args, **kwargs)
|
return self.func(*args, **kwargs)
|
||||||
|
|
||||||
def __hash__(self) -> int:
|
|
||||||
return hash(self.func)
|
|
||||||
|
|
||||||
def __repr__(self) -> str:
|
def __repr__(self) -> str:
|
||||||
return (
|
return (
|
||||||
f"{self.__class__.__name__}("
|
f"{self.__class__.__name__}("
|
||||||
|
|||||||
@@ -1,35 +0,0 @@
|
|||||||
from typing import Optional
|
|
||||||
|
|
||||||
from sanic.base.meta import SanicMeta
|
|
||||||
|
|
||||||
|
|
||||||
class BaseMixin(metaclass=SanicMeta):
|
|
||||||
name: str
|
|
||||||
strict_slashes: Optional[bool]
|
|
||||||
|
|
||||||
def _generate_name(self, *objects) -> str:
|
|
||||||
name = None
|
|
||||||
|
|
||||||
for obj in objects:
|
|
||||||
if obj:
|
|
||||||
if isinstance(obj, str):
|
|
||||||
name = obj
|
|
||||||
break
|
|
||||||
|
|
||||||
try:
|
|
||||||
name = obj.name
|
|
||||||
except AttributeError:
|
|
||||||
try:
|
|
||||||
name = obj.__name__
|
|
||||||
except AttributeError:
|
|
||||||
continue
|
|
||||||
else:
|
|
||||||
break
|
|
||||||
|
|
||||||
if not name: # noqa
|
|
||||||
raise ValueError("Could not generate a name for handler")
|
|
||||||
|
|
||||||
if not name.startswith(f"{self.name}."):
|
|
||||||
name = f"{self.name}.{name}"
|
|
||||||
|
|
||||||
return name
|
|
||||||
@@ -38,15 +38,3 @@ class ExceptionMixin(metaclass=SanicMeta):
|
|||||||
return handler
|
return handler
|
||||||
|
|
||||||
return decorator
|
return decorator
|
||||||
|
|
||||||
def all_exceptions(self, handler):
|
|
||||||
"""
|
|
||||||
This method enables the process of creating a global exception
|
|
||||||
handler for the current blueprint under question.
|
|
||||||
|
|
||||||
:param handler: A coroutine function to handle exceptions
|
|
||||||
|
|
||||||
:return a decorated method to handle global exceptions for any
|
|
||||||
route registered under this blueprint.
|
|
||||||
"""
|
|
||||||
return self.exception(Exception)(handler)
|
|
||||||
|
|||||||
@@ -1,6 +1,11 @@
|
|||||||
from ast import NodeVisitor, Return, parse
|
from ast import NodeVisitor, Return, parse
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
|
from email.utils import formatdate
|
||||||
|
from functools import partial, wraps
|
||||||
from inspect import getsource, signature
|
from inspect import getsource, signature
|
||||||
|
from mimetypes import guess_type
|
||||||
|
from os import path
|
||||||
|
from pathlib import Path, PurePath
|
||||||
from textwrap import dedent
|
from textwrap import dedent
|
||||||
from typing import (
|
from typing import (
|
||||||
Any,
|
Any,
|
||||||
@@ -14,15 +19,20 @@ from typing import (
|
|||||||
Union,
|
Union,
|
||||||
cast,
|
cast,
|
||||||
)
|
)
|
||||||
|
from urllib.parse import unquote
|
||||||
|
|
||||||
from sanic_routing.route import Route
|
from sanic_routing.route import Route
|
||||||
|
|
||||||
from sanic.base.meta import SanicMeta
|
from sanic.base.meta import SanicMeta
|
||||||
from sanic.constants import HTTP_METHODS
|
from sanic.compat import stat_async
|
||||||
|
from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE, HTTP_METHODS
|
||||||
from sanic.errorpages import RESPONSE_MAPPING
|
from sanic.errorpages import RESPONSE_MAPPING
|
||||||
from sanic.mixins.base import BaseMixin
|
from sanic.exceptions import FileNotFound, HeaderNotFound, RangeNotSatisfiable
|
||||||
|
from sanic.handlers import ContentRangeHandler
|
||||||
|
from sanic.log import error_logger
|
||||||
from sanic.models.futures import FutureRoute, FutureStatic
|
from sanic.models.futures import FutureRoute, FutureStatic
|
||||||
from sanic.models.handler_types import RouteHandler
|
from sanic.models.handler_types import RouteHandler
|
||||||
|
from sanic.response import HTTPResponse, file, file_stream, validate_file
|
||||||
from sanic.types import HashableDict
|
from sanic.types import HashableDict
|
||||||
|
|
||||||
|
|
||||||
@@ -31,14 +41,20 @@ RouteWrapper = Callable[
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
class RouteMixin(BaseMixin, metaclass=SanicMeta):
|
class RouteMixin(metaclass=SanicMeta):
|
||||||
|
name: str
|
||||||
|
|
||||||
def __init__(self, *args, **kwargs) -> None:
|
def __init__(self, *args, **kwargs) -> None:
|
||||||
self._future_routes: Set[FutureRoute] = set()
|
self._future_routes: Set[FutureRoute] = set()
|
||||||
self._future_statics: Set[FutureStatic] = set()
|
self._future_statics: Set[FutureStatic] = set()
|
||||||
|
self.strict_slashes: Optional[bool] = False
|
||||||
|
|
||||||
def _apply_route(self, route: FutureRoute) -> List[Route]:
|
def _apply_route(self, route: FutureRoute) -> List[Route]:
|
||||||
raise NotImplementedError # noqa
|
raise NotImplementedError # noqa
|
||||||
|
|
||||||
|
def _apply_static(self, static: FutureStatic) -> Route:
|
||||||
|
raise NotImplementedError # noqa
|
||||||
|
|
||||||
def route(
|
def route(
|
||||||
self,
|
self,
|
||||||
uri: str,
|
uri: str,
|
||||||
@@ -159,11 +175,7 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
|
|||||||
error_format,
|
error_format,
|
||||||
route_context,
|
route_context,
|
||||||
)
|
)
|
||||||
overwrite = getattr(self, "_allow_route_overwrite", False)
|
|
||||||
if overwrite:
|
|
||||||
self._future_routes = set(
|
|
||||||
filter(lambda x: x.uri != uri, self._future_routes)
|
|
||||||
)
|
|
||||||
self._future_routes.add(route)
|
self._future_routes.add(route)
|
||||||
|
|
||||||
args = list(signature(handler).parameters.keys())
|
args = list(signature(handler).parameters.keys())
|
||||||
@@ -186,7 +198,7 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
|
|||||||
handler.is_stream = stream
|
handler.is_stream = stream
|
||||||
|
|
||||||
if apply:
|
if apply:
|
||||||
self._apply_route(route, overwrite=overwrite)
|
self._apply_route(route)
|
||||||
|
|
||||||
if static:
|
if static:
|
||||||
return route, handler
|
return route, handler
|
||||||
@@ -206,7 +218,6 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
|
|||||||
stream: bool = False,
|
stream: bool = False,
|
||||||
version_prefix: str = "/v",
|
version_prefix: str = "/v",
|
||||||
error_format: Optional[str] = None,
|
error_format: Optional[str] = None,
|
||||||
unquote: bool = False,
|
|
||||||
**ctx_kwargs: Any,
|
**ctx_kwargs: Any,
|
||||||
) -> RouteHandler:
|
) -> RouteHandler:
|
||||||
"""A helper method to register class instance or
|
"""A helper method to register class instance or
|
||||||
@@ -253,7 +264,6 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
|
|||||||
name=name,
|
name=name,
|
||||||
version_prefix=version_prefix,
|
version_prefix=version_prefix,
|
||||||
error_format=error_format,
|
error_format=error_format,
|
||||||
unquote=unquote,
|
|
||||||
**ctx_kwargs,
|
**ctx_kwargs,
|
||||||
)(handler)
|
)(handler)
|
||||||
return handler
|
return handler
|
||||||
@@ -550,7 +560,7 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
|
|||||||
strict_slashes: Optional[bool] = None,
|
strict_slashes: Optional[bool] = None,
|
||||||
version: Optional[Union[int, str, float]] = None,
|
version: Optional[Union[int, str, float]] = None,
|
||||||
name: Optional[str] = None,
|
name: Optional[str] = None,
|
||||||
ignore_body: bool = False,
|
ignore_body: bool = True,
|
||||||
version_prefix: str = "/v",
|
version_prefix: str = "/v",
|
||||||
error_format: Optional[str] = None,
|
error_format: Optional[str] = None,
|
||||||
**ctx_kwargs: Any,
|
**ctx_kwargs: Any,
|
||||||
@@ -676,6 +686,324 @@ class RouteMixin(BaseMixin, metaclass=SanicMeta):
|
|||||||
**ctx_kwargs,
|
**ctx_kwargs,
|
||||||
)(handler)
|
)(handler)
|
||||||
|
|
||||||
|
def static(
|
||||||
|
self,
|
||||||
|
uri: str,
|
||||||
|
file_or_directory: Union[str, bytes, PurePath],
|
||||||
|
pattern: str = r"/?.+",
|
||||||
|
use_modified_since: bool = True,
|
||||||
|
use_content_range: bool = False,
|
||||||
|
stream_large_files: bool = False,
|
||||||
|
name: str = "static",
|
||||||
|
host: Optional[str] = None,
|
||||||
|
strict_slashes: Optional[bool] = None,
|
||||||
|
content_type: Optional[bool] = None,
|
||||||
|
apply: bool = True,
|
||||||
|
resource_type: Optional[str] = None,
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
Register a root to serve files from. The input can either be a
|
||||||
|
file or a directory. This method will enable an easy and simple way
|
||||||
|
to setup the :class:`Route` necessary to serve the static files.
|
||||||
|
|
||||||
|
:param uri: URL path to be used for serving static content
|
||||||
|
:param file_or_directory: Path for the Static file/directory with
|
||||||
|
static files
|
||||||
|
:param pattern: Regex Pattern identifying the valid static files
|
||||||
|
:param use_modified_since: If true, send file modified time, and return
|
||||||
|
not modified if the browser's matches the server's
|
||||||
|
:param use_content_range: If true, process header for range requests
|
||||||
|
and sends the file part that is requested
|
||||||
|
:param stream_large_files: If true, use the
|
||||||
|
:func:`StreamingHTTPResponse.file_stream` handler rather
|
||||||
|
than the :func:`HTTPResponse.file` handler to send the file.
|
||||||
|
If this is an integer, this represents the threshold size to
|
||||||
|
switch to :func:`StreamingHTTPResponse.file_stream`
|
||||||
|
:param name: user defined name used for url_for
|
||||||
|
:param host: Host IP or FQDN for the service to use
|
||||||
|
:param strict_slashes: Instruct :class:`Sanic` to check if the request
|
||||||
|
URLs need to terminate with a */*
|
||||||
|
:param content_type: user defined content type for header
|
||||||
|
:return: routes registered on the router
|
||||||
|
:rtype: List[sanic.router.Route]
|
||||||
|
"""
|
||||||
|
|
||||||
|
name = self._generate_name(name)
|
||||||
|
|
||||||
|
if strict_slashes is None and self.strict_slashes is not None:
|
||||||
|
strict_slashes = self.strict_slashes
|
||||||
|
|
||||||
|
if not isinstance(file_or_directory, (str, bytes, PurePath)):
|
||||||
|
raise ValueError(
|
||||||
|
f"Static route must be a valid path, not {file_or_directory}"
|
||||||
|
)
|
||||||
|
|
||||||
|
static = FutureStatic(
|
||||||
|
uri,
|
||||||
|
file_or_directory,
|
||||||
|
pattern,
|
||||||
|
use_modified_since,
|
||||||
|
use_content_range,
|
||||||
|
stream_large_files,
|
||||||
|
name,
|
||||||
|
host,
|
||||||
|
strict_slashes,
|
||||||
|
content_type,
|
||||||
|
resource_type,
|
||||||
|
)
|
||||||
|
self._future_statics.add(static)
|
||||||
|
|
||||||
|
if apply:
|
||||||
|
self._apply_static(static)
|
||||||
|
|
||||||
|
def _generate_name(self, *objects) -> str:
|
||||||
|
name = None
|
||||||
|
|
||||||
|
for obj in objects:
|
||||||
|
if obj:
|
||||||
|
if isinstance(obj, str):
|
||||||
|
name = obj
|
||||||
|
break
|
||||||
|
|
||||||
|
try:
|
||||||
|
name = obj.name
|
||||||
|
except AttributeError:
|
||||||
|
try:
|
||||||
|
name = obj.__name__
|
||||||
|
except AttributeError:
|
||||||
|
continue
|
||||||
|
else:
|
||||||
|
break
|
||||||
|
|
||||||
|
if not name: # noqa
|
||||||
|
raise ValueError("Could not generate a name for handler")
|
||||||
|
|
||||||
|
if not name.startswith(f"{self.name}."):
|
||||||
|
name = f"{self.name}.{name}"
|
||||||
|
|
||||||
|
return name
|
||||||
|
|
||||||
|
async def _get_file_path(self, file_or_directory, __file_uri__, not_found):
|
||||||
|
file_path_raw = Path(unquote(file_or_directory))
|
||||||
|
root_path = file_path = file_path_raw.resolve()
|
||||||
|
|
||||||
|
if __file_uri__:
|
||||||
|
# Strip all / that in the beginning of the URL to help prevent
|
||||||
|
# python from herping a derp and treating the uri as an
|
||||||
|
# absolute path
|
||||||
|
unquoted_file_uri = unquote(__file_uri__).lstrip("/")
|
||||||
|
file_path_raw = Path(file_or_directory, unquoted_file_uri)
|
||||||
|
file_path = file_path_raw.resolve()
|
||||||
|
if (
|
||||||
|
file_path < root_path and not file_path_raw.is_symlink()
|
||||||
|
) or ".." in file_path_raw.parts:
|
||||||
|
error_logger.exception(
|
||||||
|
f"File not found: path={file_or_directory}, "
|
||||||
|
f"relative_url={__file_uri__}"
|
||||||
|
)
|
||||||
|
raise not_found
|
||||||
|
|
||||||
|
try:
|
||||||
|
file_path.relative_to(root_path)
|
||||||
|
except ValueError:
|
||||||
|
if not file_path_raw.is_symlink():
|
||||||
|
error_logger.exception(
|
||||||
|
f"File not found: path={file_or_directory}, "
|
||||||
|
f"relative_url={__file_uri__}"
|
||||||
|
)
|
||||||
|
raise not_found
|
||||||
|
return file_path
|
||||||
|
|
||||||
|
async def _static_request_handler(
|
||||||
|
self,
|
||||||
|
file_or_directory,
|
||||||
|
use_modified_since,
|
||||||
|
use_content_range,
|
||||||
|
stream_large_files,
|
||||||
|
request,
|
||||||
|
content_type=None,
|
||||||
|
__file_uri__=None,
|
||||||
|
):
|
||||||
|
not_found = FileNotFound(
|
||||||
|
"File not found",
|
||||||
|
path=file_or_directory,
|
||||||
|
relative_url=__file_uri__,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Merge served directory and requested file if provided
|
||||||
|
file_path = await self._get_file_path(
|
||||||
|
file_or_directory, __file_uri__, not_found
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
headers = {}
|
||||||
|
# Check if the client has been sent this file before
|
||||||
|
# and it has not been modified since
|
||||||
|
stats = None
|
||||||
|
if use_modified_since:
|
||||||
|
stats = await stat_async(file_path)
|
||||||
|
modified_since = stats.st_mtime
|
||||||
|
response = await validate_file(request.headers, modified_since)
|
||||||
|
if response:
|
||||||
|
return response
|
||||||
|
headers["Last-Modified"] = formatdate(
|
||||||
|
modified_since, usegmt=True
|
||||||
|
)
|
||||||
|
_range = None
|
||||||
|
if use_content_range:
|
||||||
|
_range = None
|
||||||
|
if not stats:
|
||||||
|
stats = await stat_async(file_path)
|
||||||
|
headers["Accept-Ranges"] = "bytes"
|
||||||
|
headers["Content-Length"] = str(stats.st_size)
|
||||||
|
if request.method != "HEAD":
|
||||||
|
try:
|
||||||
|
_range = ContentRangeHandler(request, stats)
|
||||||
|
except HeaderNotFound:
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
del headers["Content-Length"]
|
||||||
|
headers.update(_range.headers)
|
||||||
|
|
||||||
|
if "content-type" not in headers:
|
||||||
|
content_type = (
|
||||||
|
content_type
|
||||||
|
or guess_type(file_path)[0]
|
||||||
|
or DEFAULT_HTTP_CONTENT_TYPE
|
||||||
|
)
|
||||||
|
|
||||||
|
if "charset=" not in content_type and (
|
||||||
|
content_type.startswith("text/")
|
||||||
|
or content_type == "application/javascript"
|
||||||
|
):
|
||||||
|
content_type += "; charset=utf-8"
|
||||||
|
|
||||||
|
headers["Content-Type"] = content_type
|
||||||
|
|
||||||
|
if request.method == "HEAD":
|
||||||
|
return HTTPResponse(headers=headers)
|
||||||
|
else:
|
||||||
|
if stream_large_files:
|
||||||
|
if type(stream_large_files) == int:
|
||||||
|
threshold = stream_large_files
|
||||||
|
else:
|
||||||
|
threshold = 1024 * 1024
|
||||||
|
|
||||||
|
if not stats:
|
||||||
|
stats = await stat_async(file_path)
|
||||||
|
if stats.st_size >= threshold:
|
||||||
|
return await file_stream(
|
||||||
|
file_path, headers=headers, _range=_range
|
||||||
|
)
|
||||||
|
return await file(file_path, headers=headers, _range=_range)
|
||||||
|
except RangeNotSatisfiable:
|
||||||
|
raise
|
||||||
|
except FileNotFoundError:
|
||||||
|
raise not_found
|
||||||
|
except Exception:
|
||||||
|
error_logger.exception(
|
||||||
|
f"Exception in static request handler: "
|
||||||
|
f"path={file_or_directory}, "
|
||||||
|
f"relative_url={__file_uri__}"
|
||||||
|
)
|
||||||
|
raise
|
||||||
|
|
||||||
|
def _register_static(
|
||||||
|
self,
|
||||||
|
static: FutureStatic,
|
||||||
|
):
|
||||||
|
# TODO: Though sanic is not a file server, I feel like we should
|
||||||
|
# at least make a good effort here. Modified-since is nice, but
|
||||||
|
# we could also look into etags, expires, and caching
|
||||||
|
"""
|
||||||
|
Register a static directory handler with Sanic by adding a route to the
|
||||||
|
router and registering a handler.
|
||||||
|
|
||||||
|
:param app: Sanic
|
||||||
|
:param file_or_directory: File or directory path to serve from
|
||||||
|
:type file_or_directory: Union[str,bytes,Path]
|
||||||
|
:param uri: URL to serve from
|
||||||
|
:type uri: str
|
||||||
|
:param pattern: regular expression used to match files in the URL
|
||||||
|
:param use_modified_since: If true, send file modified time, and return
|
||||||
|
not modified if the browser's matches the
|
||||||
|
server's
|
||||||
|
:param use_content_range: If true, process header for range requests
|
||||||
|
and sends the file part that is requested
|
||||||
|
:param stream_large_files: If true, use the file_stream() handler
|
||||||
|
rather than the file() handler to send the file
|
||||||
|
If this is an integer, this represents the
|
||||||
|
threshold size to switch to file_stream()
|
||||||
|
:param name: user defined name used for url_for
|
||||||
|
:type name: str
|
||||||
|
:param content_type: user defined content type for header
|
||||||
|
:return: registered static routes
|
||||||
|
:rtype: List[sanic.router.Route]
|
||||||
|
"""
|
||||||
|
|
||||||
|
if isinstance(static.file_or_directory, bytes):
|
||||||
|
file_or_directory = static.file_or_directory.decode("utf-8")
|
||||||
|
elif isinstance(static.file_or_directory, PurePath):
|
||||||
|
file_or_directory = str(static.file_or_directory)
|
||||||
|
elif not isinstance(static.file_or_directory, str):
|
||||||
|
raise ValueError("Invalid file path string.")
|
||||||
|
else:
|
||||||
|
file_or_directory = static.file_or_directory
|
||||||
|
|
||||||
|
uri = static.uri
|
||||||
|
name = static.name
|
||||||
|
# If we're not trying to match a file directly,
|
||||||
|
# serve from the folder
|
||||||
|
if not static.resource_type:
|
||||||
|
if not path.isfile(file_or_directory):
|
||||||
|
uri = uri.rstrip("/")
|
||||||
|
uri += "/<__file_uri__:path>"
|
||||||
|
elif static.resource_type == "dir":
|
||||||
|
if path.isfile(file_or_directory):
|
||||||
|
raise TypeError(
|
||||||
|
"Resource type improperly identified as directory. "
|
||||||
|
f"'{file_or_directory}'"
|
||||||
|
)
|
||||||
|
uri = uri.rstrip("/")
|
||||||
|
uri += "/<__file_uri__:path>"
|
||||||
|
elif static.resource_type == "file" and not path.isfile(
|
||||||
|
file_or_directory
|
||||||
|
):
|
||||||
|
raise TypeError(
|
||||||
|
"Resource type improperly identified as file. "
|
||||||
|
f"'{file_or_directory}'"
|
||||||
|
)
|
||||||
|
elif static.resource_type != "file":
|
||||||
|
raise ValueError(
|
||||||
|
"The resource_type should be set to 'file' or 'dir'"
|
||||||
|
)
|
||||||
|
|
||||||
|
# special prefix for static files
|
||||||
|
# if not static.name.startswith("_static_"):
|
||||||
|
# name = f"_static_{static.name}"
|
||||||
|
|
||||||
|
_handler = wraps(self._static_request_handler)(
|
||||||
|
partial(
|
||||||
|
self._static_request_handler,
|
||||||
|
file_or_directory,
|
||||||
|
static.use_modified_since,
|
||||||
|
static.use_content_range,
|
||||||
|
static.stream_large_files,
|
||||||
|
content_type=static.content_type,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
route, _ = self.route( # type: ignore
|
||||||
|
uri=uri,
|
||||||
|
methods=["GET", "HEAD"],
|
||||||
|
name=name,
|
||||||
|
host=static.host,
|
||||||
|
strict_slashes=static.strict_slashes,
|
||||||
|
static=True,
|
||||||
|
)(_handler)
|
||||||
|
|
||||||
|
return route
|
||||||
|
|
||||||
def _determine_error_format(self, handler) -> str:
|
def _determine_error_format(self, handler) -> str:
|
||||||
with suppress(OSError, TypeError):
|
with suppress(OSError, TypeError):
|
||||||
src = dedent(getsource(handler))
|
src = dedent(getsource(handler))
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ from typing import Any, Callable, Dict, Optional, Set, Union
|
|||||||
from sanic.base.meta import SanicMeta
|
from sanic.base.meta import SanicMeta
|
||||||
from sanic.models.futures import FutureSignal
|
from sanic.models.futures import FutureSignal
|
||||||
from sanic.models.handler_types import SignalHandler
|
from sanic.models.handler_types import SignalHandler
|
||||||
from sanic.signals import Event, Signal
|
from sanic.signals import Signal
|
||||||
from sanic.types import HashableDict
|
from sanic.types import HashableDict
|
||||||
|
|
||||||
|
|
||||||
@@ -20,7 +20,7 @@ class SignalMixin(metaclass=SanicMeta):
|
|||||||
event: Union[str, Enum],
|
event: Union[str, Enum],
|
||||||
*,
|
*,
|
||||||
apply: bool = True,
|
apply: bool = True,
|
||||||
condition: Optional[Dict[str, Any]] = None,
|
condition: Dict[str, Any] = None,
|
||||||
exclusive: bool = True,
|
exclusive: bool = True,
|
||||||
) -> Callable[[SignalHandler], SignalHandler]:
|
) -> Callable[[SignalHandler], SignalHandler]:
|
||||||
"""
|
"""
|
||||||
@@ -64,7 +64,7 @@ class SignalMixin(metaclass=SanicMeta):
|
|||||||
self,
|
self,
|
||||||
handler: Optional[Callable[..., Any]],
|
handler: Optional[Callable[..., Any]],
|
||||||
event: str,
|
event: str,
|
||||||
condition: Optional[Dict[str, Any]] = None,
|
condition: Dict[str, Any] = None,
|
||||||
exclusive: bool = True,
|
exclusive: bool = True,
|
||||||
):
|
):
|
||||||
if not handler:
|
if not handler:
|
||||||
@@ -80,9 +80,3 @@ class SignalMixin(metaclass=SanicMeta):
|
|||||||
|
|
||||||
def event(self, event: str):
|
def event(self, event: str):
|
||||||
raise NotImplementedError
|
raise NotImplementedError
|
||||||
|
|
||||||
def catch_exception(self, handler):
|
|
||||||
async def signal_handler(exception: Exception):
|
|
||||||
await handler(self, exception)
|
|
||||||
|
|
||||||
self.signal(Event.SERVER_LIFECYCLE_EXCEPTION)(signal_handler)
|
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ from __future__ import annotations
|
|||||||
import os
|
import os
|
||||||
import platform
|
import platform
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from asyncio import (
|
from asyncio import (
|
||||||
AbstractEventLoop,
|
AbstractEventLoop,
|
||||||
CancelledError,
|
CancelledError,
|
||||||
@@ -15,13 +16,7 @@ from asyncio import (
|
|||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
from functools import partial
|
from functools import partial
|
||||||
from importlib import import_module
|
from importlib import import_module
|
||||||
from multiprocessing import (
|
from multiprocessing import Manager, Pipe, get_context
|
||||||
Manager,
|
|
||||||
Pipe,
|
|
||||||
get_context,
|
|
||||||
get_start_method,
|
|
||||||
set_start_method,
|
|
||||||
)
|
|
||||||
from multiprocessing.context import BaseContext
|
from multiprocessing.context import BaseContext
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from socket import SHUT_RDWR, socket
|
from socket import SHUT_RDWR, socket
|
||||||
@@ -30,10 +25,8 @@ from typing import (
|
|||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
Any,
|
Any,
|
||||||
Callable,
|
Callable,
|
||||||
ClassVar,
|
|
||||||
Dict,
|
Dict,
|
||||||
List,
|
List,
|
||||||
Mapping,
|
|
||||||
Optional,
|
Optional,
|
||||||
Set,
|
Set,
|
||||||
Tuple,
|
Tuple,
|
||||||
@@ -47,30 +40,33 @@ from sanic.application.logo import get_logo
|
|||||||
from sanic.application.motd import MOTD
|
from sanic.application.motd import MOTD
|
||||||
from sanic.application.state import ApplicationServerInfo, Mode, ServerStage
|
from sanic.application.state import ApplicationServerInfo, Mode, ServerStage
|
||||||
from sanic.base.meta import SanicMeta
|
from sanic.base.meta import SanicMeta
|
||||||
from sanic.compat import OS_IS_WINDOWS, StartMethod
|
from sanic.compat import OS_IS_WINDOWS, is_atty
|
||||||
|
from sanic.constants import RestartOrder
|
||||||
from sanic.exceptions import ServerKilled
|
from sanic.exceptions import ServerKilled
|
||||||
from sanic.helpers import Default, _default, is_atty
|
from sanic.helpers import Default
|
||||||
from sanic.http.constants import HTTP
|
from sanic.http.constants import HTTP
|
||||||
from sanic.http.tls import get_ssl_context, process_to_context
|
from sanic.http.tls import get_ssl_context, process_to_context
|
||||||
from sanic.http.tls.context import SanicSSLContext
|
from sanic.http.tls.context import SanicSSLContext
|
||||||
from sanic.log import Colors, error_logger, logger
|
from sanic.log import Colors, deprecation, error_logger, logger
|
||||||
from sanic.models.handler_types import ListenerType
|
from sanic.models.handler_types import ListenerType
|
||||||
from sanic.server import Signal as ServerSignal
|
from sanic.server import Signal as ServerSignal
|
||||||
from sanic.server import try_use_uvloop
|
from sanic.server import try_use_uvloop
|
||||||
from sanic.server.async_server import AsyncioServer
|
from sanic.server.async_server import AsyncioServer
|
||||||
from sanic.server.events import trigger_events
|
from sanic.server.events import trigger_events
|
||||||
|
from sanic.server.legacy import watchdog
|
||||||
from sanic.server.loop import try_windows_loop
|
from sanic.server.loop import try_windows_loop
|
||||||
from sanic.server.protocols.http_protocol import HttpProtocol
|
from sanic.server.protocols.http_protocol import HttpProtocol
|
||||||
from sanic.server.protocols.websocket_protocol import WebSocketProtocol
|
from sanic.server.protocols.websocket_protocol import WebSocketProtocol
|
||||||
from sanic.server.runners import serve
|
from sanic.server.runners import serve, serve_multiple, serve_single
|
||||||
from sanic.server.socket import configure_socket, remove_unix_socket
|
from sanic.server.socket import configure_socket, remove_unix_socket
|
||||||
from sanic.worker.constants import ProcessState
|
from sanic.worker.inspector import Inspector
|
||||||
from sanic.worker.loader import AppLoader
|
from sanic.worker.loader import AppLoader
|
||||||
from sanic.worker.manager import WorkerManager
|
from sanic.worker.manager import WorkerManager
|
||||||
from sanic.worker.multiplexer import WorkerMultiplexer
|
from sanic.worker.multiplexer import WorkerMultiplexer
|
||||||
from sanic.worker.reloader import Reloader
|
from sanic.worker.reloader import Reloader
|
||||||
from sanic.worker.serve import worker_serve
|
from sanic.worker.serve import worker_serve
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from sanic import Sanic
|
from sanic import Sanic
|
||||||
from sanic.application.state import ApplicationState
|
from sanic.application.state import ApplicationState
|
||||||
@@ -87,18 +83,13 @@ else: # no cov
|
|||||||
|
|
||||||
|
|
||||||
class StartupMixin(metaclass=SanicMeta):
|
class StartupMixin(metaclass=SanicMeta):
|
||||||
_app_registry: ClassVar[Dict[str, Sanic]]
|
_app_registry: Dict[str, Sanic]
|
||||||
|
|
||||||
config: Config
|
config: Config
|
||||||
listeners: Dict[str, List[ListenerType[Any]]]
|
listeners: Dict[str, List[ListenerType[Any]]]
|
||||||
state: ApplicationState
|
state: ApplicationState
|
||||||
websocket_enabled: bool
|
websocket_enabled: bool
|
||||||
multiplexer: WorkerMultiplexer
|
multiplexer: WorkerMultiplexer
|
||||||
|
|
||||||
test_mode: ClassVar[bool]
|
|
||||||
start_method: ClassVar[StartMethod] = _default
|
|
||||||
START_METHOD_SET: ClassVar[bool] = False
|
|
||||||
|
|
||||||
def setup_loop(self):
|
def setup_loop(self):
|
||||||
if not self.asgi:
|
if not self.asgi:
|
||||||
if self.config.USE_UVLOOP is True or (
|
if self.config.USE_UVLOOP is True or (
|
||||||
@@ -135,7 +126,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
register_sys_signals: bool = True,
|
register_sys_signals: bool = True,
|
||||||
access_log: Optional[bool] = None,
|
access_log: Optional[bool] = None,
|
||||||
unix: Optional[str] = None,
|
unix: Optional[str] = None,
|
||||||
loop: Optional[AbstractEventLoop] = None,
|
loop: AbstractEventLoop = None,
|
||||||
reload_dir: Optional[Union[List[str], str]] = None,
|
reload_dir: Optional[Union[List[str], str]] = None,
|
||||||
noisy_exceptions: Optional[bool] = None,
|
noisy_exceptions: Optional[bool] = None,
|
||||||
motd: bool = True,
|
motd: bool = True,
|
||||||
@@ -144,6 +135,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
motd_display: Optional[Dict[str, str]] = None,
|
motd_display: Optional[Dict[str, str]] = None,
|
||||||
auto_tls: bool = False,
|
auto_tls: bool = False,
|
||||||
single_process: bool = False,
|
single_process: bool = False,
|
||||||
|
legacy: bool = False,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""
|
"""
|
||||||
Run the HTTP Server and listen until keyboard interrupt or term
|
Run the HTTP Server and listen until keyboard interrupt or term
|
||||||
@@ -205,10 +197,13 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
motd_display=motd_display,
|
motd_display=motd_display,
|
||||||
auto_tls=auto_tls,
|
auto_tls=auto_tls,
|
||||||
single_process=single_process,
|
single_process=single_process,
|
||||||
|
legacy=legacy,
|
||||||
)
|
)
|
||||||
|
|
||||||
if single_process:
|
if single_process:
|
||||||
serve = self.__class__.serve_single
|
serve = self.__class__.serve_single
|
||||||
|
elif legacy:
|
||||||
|
serve = self.__class__.serve_legacy
|
||||||
else:
|
else:
|
||||||
serve = self.__class__.serve
|
serve = self.__class__.serve
|
||||||
serve(primary=self) # type: ignore
|
serve(primary=self) # type: ignore
|
||||||
@@ -230,7 +225,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
register_sys_signals: bool = True,
|
register_sys_signals: bool = True,
|
||||||
access_log: Optional[bool] = None,
|
access_log: Optional[bool] = None,
|
||||||
unix: Optional[str] = None,
|
unix: Optional[str] = None,
|
||||||
loop: Optional[AbstractEventLoop] = None,
|
loop: AbstractEventLoop = None,
|
||||||
reload_dir: Optional[Union[List[str], str]] = None,
|
reload_dir: Optional[Union[List[str], str]] = None,
|
||||||
noisy_exceptions: Optional[bool] = None,
|
noisy_exceptions: Optional[bool] = None,
|
||||||
motd: bool = True,
|
motd: bool = True,
|
||||||
@@ -240,6 +235,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
coffee: bool = False,
|
coffee: bool = False,
|
||||||
auto_tls: bool = False,
|
auto_tls: bool = False,
|
||||||
single_process: bool = False,
|
single_process: bool = False,
|
||||||
|
legacy: bool = False,
|
||||||
) -> None:
|
) -> None:
|
||||||
if version == 3 and self.state.server_info:
|
if version == 3 and self.state.server_info:
|
||||||
raise RuntimeError(
|
raise RuntimeError(
|
||||||
@@ -268,10 +264,13 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
"or auto-reload"
|
"or auto-reload"
|
||||||
)
|
)
|
||||||
|
|
||||||
if register_sys_signals is False and not single_process:
|
if single_process and legacy:
|
||||||
|
raise RuntimeError("Cannot run single process and legacy mode")
|
||||||
|
|
||||||
|
if register_sys_signals is False and not (single_process or legacy):
|
||||||
raise RuntimeError(
|
raise RuntimeError(
|
||||||
"Cannot run Sanic.serve with register_sys_signals=False. "
|
"Cannot run Sanic.serve with register_sys_signals=False. "
|
||||||
"Use Sanic.serve_single."
|
"Use either Sanic.serve_single or Sanic.serve_legacy."
|
||||||
)
|
)
|
||||||
|
|
||||||
if motd_display:
|
if motd_display:
|
||||||
@@ -356,12 +355,12 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
debug: bool = False,
|
debug: bool = False,
|
||||||
ssl: Union[None, SSLContext, dict, str, list, tuple] = None,
|
ssl: Union[None, SSLContext, dict, str, list, tuple] = None,
|
||||||
sock: Optional[socket] = None,
|
sock: Optional[socket] = None,
|
||||||
protocol: Optional[Type[Protocol]] = None,
|
protocol: Type[Protocol] = None,
|
||||||
backlog: int = 100,
|
backlog: int = 100,
|
||||||
access_log: Optional[bool] = None,
|
access_log: Optional[bool] = None,
|
||||||
unix: Optional[str] = None,
|
unix: Optional[str] = None,
|
||||||
return_asyncio_server: bool = False,
|
return_asyncio_server: bool = False,
|
||||||
asyncio_server_kwargs: Optional[Dict[str, Any]] = None,
|
asyncio_server_kwargs: Dict[str, Any] = None,
|
||||||
noisy_exceptions: Optional[bool] = None,
|
noisy_exceptions: Optional[bool] = None,
|
||||||
) -> Optional[AsyncioServer]:
|
) -> Optional[AsyncioServer]:
|
||||||
"""
|
"""
|
||||||
@@ -482,7 +481,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
sock: Optional[socket] = None,
|
sock: Optional[socket] = None,
|
||||||
unix: Optional[str] = None,
|
unix: Optional[str] = None,
|
||||||
workers: int = 1,
|
workers: int = 1,
|
||||||
loop: Optional[AbstractEventLoop] = None,
|
loop: AbstractEventLoop = None,
|
||||||
protocol: Type[Protocol] = HttpProtocol,
|
protocol: Type[Protocol] = HttpProtocol,
|
||||||
backlog: int = 100,
|
backlog: int = 100,
|
||||||
register_sys_signals: bool = True,
|
register_sys_signals: bool = True,
|
||||||
@@ -693,34 +692,14 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
def should_auto_reload(cls) -> bool:
|
def should_auto_reload(cls) -> bool:
|
||||||
return any(app.state.auto_reload for app in cls._app_registry.values())
|
return any(app.state.auto_reload for app in cls._app_registry.values())
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def _get_startup_method(cls) -> str:
|
|
||||||
return (
|
|
||||||
cls.start_method
|
|
||||||
if not isinstance(cls.start_method, Default)
|
|
||||||
else "spawn"
|
|
||||||
)
|
|
||||||
|
|
||||||
@classmethod
|
|
||||||
def _set_startup_method(cls) -> None:
|
|
||||||
if cls.START_METHOD_SET and not cls.test_mode:
|
|
||||||
return
|
|
||||||
|
|
||||||
method = cls._get_startup_method()
|
|
||||||
set_start_method(method, force=cls.test_mode)
|
|
||||||
cls.START_METHOD_SET = True
|
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def _get_context(cls) -> BaseContext:
|
def _get_context(cls) -> BaseContext:
|
||||||
method = cls._get_startup_method()
|
method = (
|
||||||
logger.debug("Creating multiprocessing context using '%s'", method)
|
"spawn"
|
||||||
actual = get_start_method()
|
if "linux" not in sys.platform or cls.should_auto_reload()
|
||||||
if method != actual:
|
else "fork"
|
||||||
raise RuntimeError(
|
|
||||||
f"Start method '{method}' was requested, but '{actual}' "
|
|
||||||
"was actually set."
|
|
||||||
)
|
)
|
||||||
return get_context()
|
return get_context(method)
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def serve(
|
def serve(
|
||||||
@@ -730,7 +709,6 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
app_loader: Optional[AppLoader] = None,
|
app_loader: Optional[AppLoader] = None,
|
||||||
factory: Optional[Callable[[], Sanic]] = None,
|
factory: Optional[Callable[[], Sanic]] = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
cls._set_startup_method()
|
|
||||||
os.environ["SANIC_MOTD_OUTPUT"] = "true"
|
os.environ["SANIC_MOTD_OUTPUT"] = "true"
|
||||||
apps = list(cls._app_registry.values())
|
apps = list(cls._app_registry.values())
|
||||||
if factory:
|
if factory:
|
||||||
@@ -786,7 +764,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
]
|
]
|
||||||
primary_server_info.settings["run_multiple"] = True
|
primary_server_info.settings["run_multiple"] = True
|
||||||
monitor_sub, monitor_pub = Pipe(True)
|
monitor_sub, monitor_pub = Pipe(True)
|
||||||
worker_state: Mapping[str, Any] = sync_manager.dict()
|
worker_state: Dict[str, Any] = sync_manager.dict()
|
||||||
kwargs: Dict[str, Any] = {
|
kwargs: Dict[str, Any] = {
|
||||||
**primary_server_info.settings,
|
**primary_server_info.settings,
|
||||||
"monitor_publisher": monitor_pub,
|
"monitor_publisher": monitor_pub,
|
||||||
@@ -828,7 +806,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
ssl = kwargs.get("ssl")
|
ssl = kwargs.get("ssl")
|
||||||
|
|
||||||
if isinstance(ssl, SanicSSLContext):
|
if isinstance(ssl, SanicSSLContext):
|
||||||
kwargs["ssl"] = ssl.sanic
|
kwargs["ssl"] = kwargs["ssl"].sanic
|
||||||
|
|
||||||
manager = WorkerManager(
|
manager = WorkerManager(
|
||||||
primary.state.workers,
|
primary.state.workers,
|
||||||
@@ -837,12 +815,13 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
cls._get_context(),
|
cls._get_context(),
|
||||||
(monitor_pub, monitor_sub),
|
(monitor_pub, monitor_sub),
|
||||||
worker_state,
|
worker_state,
|
||||||
|
cast(RestartOrder, primary.config.RESTART_ORDER),
|
||||||
)
|
)
|
||||||
if cls.should_auto_reload():
|
if cls.should_auto_reload():
|
||||||
reload_dirs: Set[Path] = primary.state.reload_dirs.union(
|
reload_dirs: Set[Path] = primary.state.reload_dirs.union(
|
||||||
*(app.state.reload_dirs for app in apps)
|
*(app.state.reload_dirs for app in apps)
|
||||||
)
|
)
|
||||||
reloader = Reloader(monitor_pub, 0, reload_dirs, app_loader)
|
reloader = Reloader(monitor_pub, 1.0, reload_dirs, app_loader)
|
||||||
manager.manage("Reloader", reloader, {}, transient=False)
|
manager.manage("Reloader", reloader, {}, transient=False)
|
||||||
|
|
||||||
inspector = None
|
inspector = None
|
||||||
@@ -858,15 +837,12 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
"packages": [sanic_version, *packages],
|
"packages": [sanic_version, *packages],
|
||||||
"extra": extra,
|
"extra": extra,
|
||||||
}
|
}
|
||||||
inspector = primary.inspector_class(
|
inspector = Inspector(
|
||||||
monitor_pub,
|
monitor_pub,
|
||||||
app_info,
|
app_info,
|
||||||
worker_state,
|
worker_state,
|
||||||
primary.config.INSPECTOR_HOST,
|
primary.config.INSPECTOR_HOST,
|
||||||
primary.config.INSPECTOR_PORT,
|
primary.config.INSPECTOR_PORT,
|
||||||
primary.config.INSPECTOR_API_KEY,
|
|
||||||
primary.config.INSPECTOR_TLS_KEY,
|
|
||||||
primary.config.INSPECTOR_TLS_CERT,
|
|
||||||
)
|
)
|
||||||
manager.manage("Inspector", inspector, {}, transient=False)
|
manager.manage("Inspector", inspector, {}, transient=False)
|
||||||
|
|
||||||
@@ -892,44 +868,21 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
app.router.reset()
|
app.router.reset()
|
||||||
app.signal_router.reset()
|
app.signal_router.reset()
|
||||||
|
|
||||||
|
sync_manager.shutdown()
|
||||||
for sock in socks:
|
for sock in socks:
|
||||||
try:
|
|
||||||
sock.shutdown(SHUT_RDWR)
|
sock.shutdown(SHUT_RDWR)
|
||||||
except OSError:
|
|
||||||
...
|
|
||||||
sock.close()
|
sock.close()
|
||||||
socks = []
|
socks = []
|
||||||
trigger_events(main_stop, loop, primary)
|
trigger_events(main_stop, loop, primary)
|
||||||
loop.close()
|
loop.close()
|
||||||
cls._cleanup_env_vars()
|
cls._cleanup_env_vars()
|
||||||
cls._cleanup_apps()
|
cls._cleanup_apps()
|
||||||
|
|
||||||
from time import sleep
|
|
||||||
|
|
||||||
limit = 100
|
|
||||||
while cls._get_process_states(worker_state):
|
|
||||||
sleep(0.1)
|
|
||||||
limit -= 1
|
|
||||||
if limit <= 0:
|
|
||||||
error_logger.warning(
|
|
||||||
"Worker shutdown timed out. "
|
|
||||||
"Some processes may still be running."
|
|
||||||
)
|
|
||||||
break
|
|
||||||
sync_manager.shutdown()
|
|
||||||
unix = kwargs.get("unix")
|
unix = kwargs.get("unix")
|
||||||
if unix:
|
if unix:
|
||||||
remove_unix_socket(unix)
|
remove_unix_socket(unix)
|
||||||
logger.info("Goodbye.")
|
|
||||||
if exit_code:
|
if exit_code:
|
||||||
os._exit(exit_code)
|
os._exit(exit_code)
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _get_process_states(worker_state) -> List[str]:
|
|
||||||
return [
|
|
||||||
state for s in worker_state.values() if (state := s.get("state"))
|
|
||||||
]
|
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def serve_single(cls, primary: Optional[Sanic] = None) -> None:
|
def serve_single(cls, primary: Optional[Sanic] = None) -> None:
|
||||||
os.environ["SANIC_MOTD_OUTPUT"] = "true"
|
os.environ["SANIC_MOTD_OUTPUT"] = "true"
|
||||||
@@ -993,6 +946,76 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
cls._cleanup_env_vars()
|
cls._cleanup_env_vars()
|
||||||
cls._cleanup_apps()
|
cls._cleanup_apps()
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def serve_legacy(cls, primary: Optional[Sanic] = None) -> None:
|
||||||
|
apps = list(cls._app_registry.values())
|
||||||
|
|
||||||
|
if not primary:
|
||||||
|
try:
|
||||||
|
primary = apps[0]
|
||||||
|
except IndexError:
|
||||||
|
raise RuntimeError("Did not find any applications.")
|
||||||
|
|
||||||
|
reloader_start = primary.listeners.get("reload_process_start")
|
||||||
|
reloader_stop = primary.listeners.get("reload_process_stop")
|
||||||
|
# We want to run auto_reload if ANY of the applications have it enabled
|
||||||
|
if (
|
||||||
|
cls.should_auto_reload()
|
||||||
|
and os.environ.get("SANIC_SERVER_RUNNING") != "true"
|
||||||
|
): # no cov
|
||||||
|
loop = new_event_loop()
|
||||||
|
trigger_events(reloader_start, loop, primary)
|
||||||
|
reload_dirs: Set[Path] = primary.state.reload_dirs.union(
|
||||||
|
*(app.state.reload_dirs for app in apps)
|
||||||
|
)
|
||||||
|
watchdog(1.0, reload_dirs)
|
||||||
|
trigger_events(reloader_stop, loop, primary)
|
||||||
|
return
|
||||||
|
|
||||||
|
# This exists primarily for unit testing
|
||||||
|
if not primary.state.server_info: # no cov
|
||||||
|
for app in apps:
|
||||||
|
app.state.server_info.clear()
|
||||||
|
return
|
||||||
|
|
||||||
|
primary_server_info = primary.state.server_info[0]
|
||||||
|
primary.before_server_start(partial(primary._start_servers, apps=apps))
|
||||||
|
|
||||||
|
deprecation(
|
||||||
|
f"{Colors.YELLOW}Running {Colors.SANIC}Sanic {Colors.YELLOW}w/ "
|
||||||
|
f"LEGACY manager.{Colors.END} Support for will be dropped in "
|
||||||
|
"version 23.3.",
|
||||||
|
23.3,
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
primary_server_info.stage = ServerStage.SERVING
|
||||||
|
|
||||||
|
if primary.state.workers > 1 and os.name != "posix": # no cov
|
||||||
|
logger.warning(
|
||||||
|
f"Multiprocessing is currently not supported on {os.name},"
|
||||||
|
" using workers=1 instead"
|
||||||
|
)
|
||||||
|
primary.state.workers = 1
|
||||||
|
if primary.state.workers == 1:
|
||||||
|
serve_single(primary_server_info.settings)
|
||||||
|
elif primary.state.workers == 0:
|
||||||
|
raise RuntimeError("Cannot serve with no workers")
|
||||||
|
else:
|
||||||
|
serve_multiple(
|
||||||
|
primary_server_info.settings, primary.state.workers
|
||||||
|
)
|
||||||
|
except BaseException:
|
||||||
|
error_logger.exception(
|
||||||
|
"Experienced exception while trying to serve"
|
||||||
|
)
|
||||||
|
raise
|
||||||
|
finally:
|
||||||
|
primary_server_info.stage = ServerStage.STOPPED
|
||||||
|
logger.info("Server Stopped")
|
||||||
|
|
||||||
|
cls._cleanup_env_vars()
|
||||||
|
cls._cleanup_apps()
|
||||||
|
|
||||||
async def _start_servers(
|
async def _start_servers(
|
||||||
self,
|
self,
|
||||||
primary: Sanic,
|
primary: Sanic,
|
||||||
@@ -1079,6 +1102,7 @@ class StartupMixin(metaclass=SanicMeta):
|
|||||||
app: StartupMixin,
|
app: StartupMixin,
|
||||||
server_info: ApplicationServerInfo,
|
server_info: ApplicationServerInfo,
|
||||||
) -> None: # no cov
|
) -> None: # no cov
|
||||||
|
|
||||||
try:
|
try:
|
||||||
# We should never get to this point without a server
|
# We should never get to this point without a server
|
||||||
# This is primarily to keep mypy happy
|
# This is primarily to keep mypy happy
|
||||||
|
|||||||
@@ -1,346 +0,0 @@
|
|||||||
from email.utils import formatdate
|
|
||||||
from functools import partial, wraps
|
|
||||||
from mimetypes import guess_type
|
|
||||||
from os import PathLike, path
|
|
||||||
from pathlib import Path, PurePath
|
|
||||||
from typing import Optional, Sequence, Set, Union
|
|
||||||
from urllib.parse import unquote
|
|
||||||
|
|
||||||
from sanic_routing.route import Route
|
|
||||||
|
|
||||||
from sanic.base.meta import SanicMeta
|
|
||||||
from sanic.compat import stat_async
|
|
||||||
from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE
|
|
||||||
from sanic.exceptions import FileNotFound, HeaderNotFound, RangeNotSatisfiable
|
|
||||||
from sanic.handlers import ContentRangeHandler
|
|
||||||
from sanic.handlers.directory import DirectoryHandler
|
|
||||||
from sanic.log import error_logger
|
|
||||||
from sanic.mixins.base import BaseMixin
|
|
||||||
from sanic.models.futures import FutureStatic
|
|
||||||
from sanic.request import Request
|
|
||||||
from sanic.response import HTTPResponse, file, file_stream, validate_file
|
|
||||||
|
|
||||||
|
|
||||||
class StaticMixin(BaseMixin, metaclass=SanicMeta):
|
|
||||||
def __init__(self, *args, **kwargs) -> None:
|
|
||||||
self._future_statics: Set[FutureStatic] = set()
|
|
||||||
|
|
||||||
def _apply_static(self, static: FutureStatic) -> Route:
|
|
||||||
raise NotImplementedError # noqa
|
|
||||||
|
|
||||||
def static(
|
|
||||||
self,
|
|
||||||
uri: str,
|
|
||||||
file_or_directory: Union[PathLike, str],
|
|
||||||
pattern: str = r"/?.+",
|
|
||||||
use_modified_since: bool = True,
|
|
||||||
use_content_range: bool = False,
|
|
||||||
stream_large_files: Union[bool, int] = False,
|
|
||||||
name: str = "static",
|
|
||||||
host: Optional[str] = None,
|
|
||||||
strict_slashes: Optional[bool] = None,
|
|
||||||
content_type: Optional[str] = None,
|
|
||||||
apply: bool = True,
|
|
||||||
resource_type: Optional[str] = None,
|
|
||||||
index: Optional[Union[str, Sequence[str]]] = None,
|
|
||||||
directory_view: bool = False,
|
|
||||||
directory_handler: Optional[DirectoryHandler] = None,
|
|
||||||
):
|
|
||||||
"""
|
|
||||||
Register a root to serve files from. The input can either be a
|
|
||||||
file or a directory. This method will enable an easy and simple way
|
|
||||||
to setup the :class:`Route` necessary to serve the static files.
|
|
||||||
|
|
||||||
:param uri: URL path to be used for serving static content
|
|
||||||
:param file_or_directory: Path for the Static file/directory with
|
|
||||||
static files
|
|
||||||
:param pattern: Regex Pattern identifying the valid static files
|
|
||||||
:param use_modified_since: If true, send file modified time, and return
|
|
||||||
not modified if the browser's matches the server's
|
|
||||||
:param use_content_range: If true, process header for range requests
|
|
||||||
and sends the file part that is requested
|
|
||||||
:param stream_large_files: If true, use the
|
|
||||||
:func:`StreamingHTTPResponse.file_stream` handler rather
|
|
||||||
than the :func:`HTTPResponse.file` handler to send the file.
|
|
||||||
If this is an integer, this represents the threshold size to
|
|
||||||
switch to :func:`StreamingHTTPResponse.file_stream`
|
|
||||||
:param name: user defined name used for url_for
|
|
||||||
:param host: Host IP or FQDN for the service to use
|
|
||||||
:param strict_slashes: Instruct :class:`Sanic` to check if the request
|
|
||||||
URLs need to terminate with a */*
|
|
||||||
:param content_type: user defined content type for header
|
|
||||||
:param apply: If true, will register the route immediately
|
|
||||||
:param resource_type: Explicitly declare a resource to be a "
|
|
||||||
file" or a "dir"
|
|
||||||
:param index: When exposing against a directory, index is the name that
|
|
||||||
will be served as the default file. When multiple files names are
|
|
||||||
passed, then they will be tried in order.
|
|
||||||
:param directory_view: Whether to fallback to showing the directory
|
|
||||||
viewer when exposing a directory
|
|
||||||
:param directory_handler: An instance of :class:`DirectoryHandler`
|
|
||||||
that can be used for explicitly controlling and subclassing the
|
|
||||||
behavior of the default directory handler
|
|
||||||
:return: routes registered on the router
|
|
||||||
:rtype: List[sanic.router.Route]
|
|
||||||
"""
|
|
||||||
|
|
||||||
name = self._generate_name(name)
|
|
||||||
|
|
||||||
if strict_slashes is None and self.strict_slashes is not None:
|
|
||||||
strict_slashes = self.strict_slashes
|
|
||||||
|
|
||||||
if not isinstance(file_or_directory, (str, bytes, PurePath)):
|
|
||||||
raise ValueError(
|
|
||||||
f"Static route must be a valid path, not {file_or_directory}"
|
|
||||||
)
|
|
||||||
|
|
||||||
try:
|
|
||||||
file_or_directory = Path(file_or_directory).resolve()
|
|
||||||
except TypeError:
|
|
||||||
raise TypeError(
|
|
||||||
"Static file or directory must be a path-like object or string"
|
|
||||||
)
|
|
||||||
|
|
||||||
if directory_handler and (directory_view or index):
|
|
||||||
raise ValueError(
|
|
||||||
"When explicitly setting directory_handler, you cannot "
|
|
||||||
"set either directory_view or index. Instead, pass "
|
|
||||||
"these arguments to your DirectoryHandler instance."
|
|
||||||
)
|
|
||||||
|
|
||||||
if not directory_handler:
|
|
||||||
directory_handler = DirectoryHandler(
|
|
||||||
uri=uri,
|
|
||||||
directory=file_or_directory,
|
|
||||||
directory_view=directory_view,
|
|
||||||
index=index,
|
|
||||||
)
|
|
||||||
|
|
||||||
static = FutureStatic(
|
|
||||||
uri,
|
|
||||||
file_or_directory,
|
|
||||||
pattern,
|
|
||||||
use_modified_since,
|
|
||||||
use_content_range,
|
|
||||||
stream_large_files,
|
|
||||||
name,
|
|
||||||
host,
|
|
||||||
strict_slashes,
|
|
||||||
content_type,
|
|
||||||
resource_type,
|
|
||||||
directory_handler,
|
|
||||||
)
|
|
||||||
self._future_statics.add(static)
|
|
||||||
|
|
||||||
if apply:
|
|
||||||
self._apply_static(static)
|
|
||||||
|
|
||||||
|
|
||||||
class StaticHandleMixin(metaclass=SanicMeta):
|
|
||||||
def _apply_static(self, static: FutureStatic) -> Route:
|
|
||||||
return self._register_static(static)
|
|
||||||
|
|
||||||
def _register_static(
|
|
||||||
self,
|
|
||||||
static: FutureStatic,
|
|
||||||
):
|
|
||||||
# TODO: Though sanic is not a file server, I feel like we should
|
|
||||||
# at least make a good effort here. Modified-since is nice, but
|
|
||||||
# we could also look into etags, expires, and caching
|
|
||||||
"""
|
|
||||||
Register a static directory handler with Sanic by adding a route to the
|
|
||||||
router and registering a handler.
|
|
||||||
"""
|
|
||||||
|
|
||||||
if isinstance(static.file_or_directory, bytes):
|
|
||||||
file_or_directory = static.file_or_directory.decode("utf-8")
|
|
||||||
elif isinstance(static.file_or_directory, PurePath):
|
|
||||||
file_or_directory = str(static.file_or_directory)
|
|
||||||
elif not isinstance(static.file_or_directory, str):
|
|
||||||
raise ValueError("Invalid file path string.")
|
|
||||||
else:
|
|
||||||
file_or_directory = static.file_or_directory
|
|
||||||
|
|
||||||
uri = static.uri
|
|
||||||
name = static.name
|
|
||||||
# If we're not trying to match a file directly,
|
|
||||||
# serve from the folder
|
|
||||||
if not static.resource_type:
|
|
||||||
if not path.isfile(file_or_directory):
|
|
||||||
uri = uri.rstrip("/")
|
|
||||||
uri += "/<__file_uri__:path>"
|
|
||||||
elif static.resource_type == "dir":
|
|
||||||
if path.isfile(file_or_directory):
|
|
||||||
raise TypeError(
|
|
||||||
"Resource type improperly identified as directory. "
|
|
||||||
f"'{file_or_directory}'"
|
|
||||||
)
|
|
||||||
uri = uri.rstrip("/")
|
|
||||||
uri += "/<__file_uri__:path>"
|
|
||||||
elif static.resource_type == "file" and not path.isfile(
|
|
||||||
file_or_directory
|
|
||||||
):
|
|
||||||
raise TypeError(
|
|
||||||
"Resource type improperly identified as file. "
|
|
||||||
f"'{file_or_directory}'"
|
|
||||||
)
|
|
||||||
elif static.resource_type != "file":
|
|
||||||
raise ValueError(
|
|
||||||
"The resource_type should be set to 'file' or 'dir'"
|
|
||||||
)
|
|
||||||
|
|
||||||
# special prefix for static files
|
|
||||||
# if not static.name.startswith("_static_"):
|
|
||||||
# name = f"_static_{static.name}"
|
|
||||||
|
|
||||||
_handler = wraps(self._static_request_handler)(
|
|
||||||
partial(
|
|
||||||
self._static_request_handler,
|
|
||||||
file_or_directory=file_or_directory,
|
|
||||||
use_modified_since=static.use_modified_since,
|
|
||||||
use_content_range=static.use_content_range,
|
|
||||||
stream_large_files=static.stream_large_files,
|
|
||||||
content_type=static.content_type,
|
|
||||||
directory_handler=static.directory_handler,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
route, _ = self.route( # type: ignore
|
|
||||||
uri=uri,
|
|
||||||
methods=["GET", "HEAD"],
|
|
||||||
name=name,
|
|
||||||
host=static.host,
|
|
||||||
strict_slashes=static.strict_slashes,
|
|
||||||
static=True,
|
|
||||||
)(_handler)
|
|
||||||
|
|
||||||
return route
|
|
||||||
|
|
||||||
async def _static_request_handler(
|
|
||||||
self,
|
|
||||||
request: Request,
|
|
||||||
*,
|
|
||||||
file_or_directory: PathLike,
|
|
||||||
use_modified_since: bool,
|
|
||||||
use_content_range: bool,
|
|
||||||
stream_large_files: Union[bool, int],
|
|
||||||
directory_handler: DirectoryHandler,
|
|
||||||
content_type: Optional[str] = None,
|
|
||||||
__file_uri__: Optional[str] = None,
|
|
||||||
):
|
|
||||||
not_found = FileNotFound(
|
|
||||||
"File not found",
|
|
||||||
path=file_or_directory,
|
|
||||||
relative_url=__file_uri__,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Merge served directory and requested file if provided
|
|
||||||
file_path = await self._get_file_path(
|
|
||||||
file_or_directory, __file_uri__, not_found
|
|
||||||
)
|
|
||||||
|
|
||||||
try:
|
|
||||||
headers = {}
|
|
||||||
# Check if the client has been sent this file before
|
|
||||||
# and it has not been modified since
|
|
||||||
stats = None
|
|
||||||
if use_modified_since:
|
|
||||||
stats = await stat_async(file_path)
|
|
||||||
modified_since = stats.st_mtime
|
|
||||||
response = await validate_file(request.headers, modified_since)
|
|
||||||
if response:
|
|
||||||
return response
|
|
||||||
headers["Last-Modified"] = formatdate(
|
|
||||||
modified_since, usegmt=True
|
|
||||||
)
|
|
||||||
_range = None
|
|
||||||
if use_content_range:
|
|
||||||
_range = None
|
|
||||||
if not stats:
|
|
||||||
stats = await stat_async(file_path)
|
|
||||||
headers["Accept-Ranges"] = "bytes"
|
|
||||||
headers["Content-Length"] = str(stats.st_size)
|
|
||||||
if request.method != "HEAD":
|
|
||||||
try:
|
|
||||||
_range = ContentRangeHandler(request, stats)
|
|
||||||
except HeaderNotFound:
|
|
||||||
pass
|
|
||||||
else:
|
|
||||||
del headers["Content-Length"]
|
|
||||||
headers.update(_range.headers)
|
|
||||||
|
|
||||||
if "content-type" not in headers:
|
|
||||||
content_type = (
|
|
||||||
content_type
|
|
||||||
or guess_type(file_path)[0]
|
|
||||||
or DEFAULT_HTTP_CONTENT_TYPE
|
|
||||||
)
|
|
||||||
|
|
||||||
if "charset=" not in content_type and (
|
|
||||||
content_type.startswith("text/")
|
|
||||||
or content_type == "application/javascript"
|
|
||||||
):
|
|
||||||
content_type += "; charset=utf-8"
|
|
||||||
|
|
||||||
headers["Content-Type"] = content_type
|
|
||||||
|
|
||||||
if request.method == "HEAD":
|
|
||||||
return HTTPResponse(headers=headers)
|
|
||||||
else:
|
|
||||||
if stream_large_files:
|
|
||||||
if isinstance(stream_large_files, bool):
|
|
||||||
threshold = 1024 * 1024
|
|
||||||
else:
|
|
||||||
threshold = stream_large_files
|
|
||||||
|
|
||||||
if not stats:
|
|
||||||
stats = await stat_async(file_path)
|
|
||||||
if stats.st_size >= threshold:
|
|
||||||
return await file_stream(
|
|
||||||
file_path, headers=headers, _range=_range
|
|
||||||
)
|
|
||||||
return await file(file_path, headers=headers, _range=_range)
|
|
||||||
except (IsADirectoryError, PermissionError):
|
|
||||||
return await directory_handler.handle(request, request.path)
|
|
||||||
except RangeNotSatisfiable:
|
|
||||||
raise
|
|
||||||
except FileNotFoundError:
|
|
||||||
raise not_found
|
|
||||||
except Exception:
|
|
||||||
error_logger.exception(
|
|
||||||
"Exception in static request handler: "
|
|
||||||
f"path={file_or_directory}, "
|
|
||||||
f"relative_url={__file_uri__}"
|
|
||||||
)
|
|
||||||
raise
|
|
||||||
|
|
||||||
async def _get_file_path(self, file_or_directory, __file_uri__, not_found):
|
|
||||||
file_path_raw = Path(unquote(file_or_directory))
|
|
||||||
root_path = file_path = file_path_raw.resolve()
|
|
||||||
|
|
||||||
if __file_uri__:
|
|
||||||
# Strip all / that in the beginning of the URL to help prevent
|
|
||||||
# python from herping a derp and treating the uri as an
|
|
||||||
# absolute path
|
|
||||||
unquoted_file_uri = unquote(__file_uri__).lstrip("/")
|
|
||||||
file_path_raw = Path(file_or_directory, unquoted_file_uri)
|
|
||||||
file_path = file_path_raw.resolve()
|
|
||||||
if (
|
|
||||||
file_path < root_path and not file_path_raw.is_symlink()
|
|
||||||
) or ".." in file_path_raw.parts:
|
|
||||||
error_logger.exception(
|
|
||||||
f"File not found: path={file_or_directory}, "
|
|
||||||
f"relative_url={__file_uri__}"
|
|
||||||
)
|
|
||||||
raise not_found
|
|
||||||
|
|
||||||
try:
|
|
||||||
file_path.relative_to(root_path)
|
|
||||||
except ValueError:
|
|
||||||
if not file_path_raw.is_symlink():
|
|
||||||
error_logger.exception(
|
|
||||||
f"File not found: path={file_or_directory}, "
|
|
||||||
f"relative_url={__file_uri__}"
|
|
||||||
)
|
|
||||||
raise not_found
|
|
||||||
return file_path
|
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
import asyncio
|
import asyncio
|
||||||
|
import sys
|
||||||
|
|
||||||
from typing import Any, Awaitable, Callable, MutableMapping, Optional, Union
|
from typing import Any, Awaitable, Callable, MutableMapping, Optional, Union
|
||||||
|
|
||||||
@@ -15,10 +16,20 @@ ASGIReceive = Callable[[], Awaitable[ASGIMessage]]
|
|||||||
|
|
||||||
class MockProtocol: # no cov
|
class MockProtocol: # no cov
|
||||||
def __init__(self, transport: "MockTransport", loop):
|
def __init__(self, transport: "MockTransport", loop):
|
||||||
|
# This should be refactored when < 3.8 support is dropped
|
||||||
self.transport = transport
|
self.transport = transport
|
||||||
|
# Fixup for 3.8+; Sanic still supports 3.7 where loop is required
|
||||||
|
loop = loop if sys.version_info[:2] < (3, 8) else None
|
||||||
|
# Optional in 3.9, necessary in 3.10 because the parameter "loop"
|
||||||
|
# was completely removed
|
||||||
|
if not loop:
|
||||||
self._not_paused = asyncio.Event()
|
self._not_paused = asyncio.Event()
|
||||||
self._not_paused.set()
|
self._not_paused.set()
|
||||||
self._complete = asyncio.Event()
|
self._complete = asyncio.Event()
|
||||||
|
else:
|
||||||
|
self._not_paused = asyncio.Event(loop=loop)
|
||||||
|
self._not_paused.set()
|
||||||
|
self._complete = asyncio.Event(loop=loop)
|
||||||
|
|
||||||
def pause_writing(self) -> None:
|
def pause_writing(self) -> None:
|
||||||
self._not_paused.clear()
|
self._not_paused.clear()
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
from pathlib import Path
|
from pathlib import PurePath
|
||||||
from typing import Dict, Iterable, List, NamedTuple, Optional, Union
|
from typing import Dict, Iterable, List, NamedTuple, Optional, Union
|
||||||
|
|
||||||
from sanic.handlers.directory import DirectoryHandler
|
|
||||||
from sanic.models.handler_types import (
|
from sanic.models.handler_types import (
|
||||||
ErrorMiddlewareType,
|
ErrorMiddlewareType,
|
||||||
ListenerType,
|
ListenerType,
|
||||||
@@ -47,17 +46,16 @@ class FutureException(NamedTuple):
|
|||||||
|
|
||||||
class FutureStatic(NamedTuple):
|
class FutureStatic(NamedTuple):
|
||||||
uri: str
|
uri: str
|
||||||
file_or_directory: Path
|
file_or_directory: Union[str, bytes, PurePath]
|
||||||
pattern: str
|
pattern: str
|
||||||
use_modified_since: bool
|
use_modified_since: bool
|
||||||
use_content_range: bool
|
use_content_range: bool
|
||||||
stream_large_files: Union[bool, int]
|
stream_large_files: bool
|
||||||
name: str
|
name: str
|
||||||
host: Optional[str]
|
host: Optional[str]
|
||||||
strict_slashes: Optional[bool]
|
strict_slashes: Optional[bool]
|
||||||
content_type: Optional[str]
|
content_type: Optional[bool]
|
||||||
resource_type: Optional[str]
|
resource_type: Optional[str]
|
||||||
directory_handler: DirectoryHandler
|
|
||||||
|
|
||||||
|
|
||||||
class FutureSignal(NamedTuple):
|
class FutureSignal(NamedTuple):
|
||||||
|
|||||||
@@ -3,12 +3,11 @@ from typing import Any, Callable, Coroutine, Optional, TypeVar, Union
|
|||||||
|
|
||||||
import sanic
|
import sanic
|
||||||
|
|
||||||
from sanic import request
|
from sanic.request import Request
|
||||||
from sanic.response import BaseHTTPResponse, HTTPResponse
|
from sanic.response import BaseHTTPResponse, HTTPResponse
|
||||||
|
|
||||||
|
|
||||||
Sanic = TypeVar("Sanic", bound="sanic.Sanic")
|
Sanic = TypeVar("Sanic", bound="sanic.Sanic")
|
||||||
Request = TypeVar("Request", bound="request.Request")
|
|
||||||
|
|
||||||
MiddlewareResponse = Union[
|
MiddlewareResponse = Union[
|
||||||
Optional[HTTPResponse], Coroutine[Any, Any, Optional[HTTPResponse]]
|
Optional[HTTPResponse], Coroutine[Any, Any, Optional[HTTPResponse]]
|
||||||
|
|||||||
@@ -1,70 +0,0 @@
|
|||||||
from abc import ABC, abstractmethod
|
|
||||||
|
|
||||||
from html5tagger import HTML, Builder, Document
|
|
||||||
|
|
||||||
from sanic import __version__ as VERSION
|
|
||||||
from sanic.application.logo import SVG_LOGO_SIMPLE
|
|
||||||
from sanic.pages.css import CSS
|
|
||||||
|
|
||||||
|
|
||||||
class BasePage(ABC, metaclass=CSS): # no cov
|
|
||||||
TITLE = "Sanic"
|
|
||||||
HEADING = None
|
|
||||||
CSS: str
|
|
||||||
doc: Builder
|
|
||||||
|
|
||||||
def __init__(self, debug: bool = True) -> None:
|
|
||||||
self.debug = debug
|
|
||||||
|
|
||||||
@property
|
|
||||||
def style(self) -> str:
|
|
||||||
return self.CSS
|
|
||||||
|
|
||||||
def render(self) -> str:
|
|
||||||
self.doc = Document(self.TITLE, lang="en", id="sanic")
|
|
||||||
self._head()
|
|
||||||
self._body()
|
|
||||||
self._foot()
|
|
||||||
return str(self.doc)
|
|
||||||
|
|
||||||
def _head(self) -> None:
|
|
||||||
self.doc.style(HTML(self.style))
|
|
||||||
with self.doc.header:
|
|
||||||
self.doc.div(self.HEADING or self.TITLE)
|
|
||||||
|
|
||||||
def _foot(self) -> None:
|
|
||||||
with self.doc.footer:
|
|
||||||
self.doc.div("powered by")
|
|
||||||
with self.doc.div:
|
|
||||||
self._sanic_logo()
|
|
||||||
if self.debug:
|
|
||||||
self.doc.div(f"Version {VERSION}")
|
|
||||||
with self.doc.div:
|
|
||||||
for idx, (title, href) in enumerate(
|
|
||||||
(
|
|
||||||
("Docs", "https://sanic.dev"),
|
|
||||||
("Help", "https://sanic.dev/en/help.html"),
|
|
||||||
("GitHub", "https://github.com/sanic-org/sanic"),
|
|
||||||
)
|
|
||||||
):
|
|
||||||
if idx > 0:
|
|
||||||
self.doc(" | ")
|
|
||||||
self.doc.a(
|
|
||||||
title,
|
|
||||||
href=href,
|
|
||||||
target="_blank",
|
|
||||||
referrerpolicy="no-referrer",
|
|
||||||
)
|
|
||||||
self.doc.div("DEBUG mode")
|
|
||||||
|
|
||||||
@abstractmethod
|
|
||||||
def _body(self) -> None:
|
|
||||||
...
|
|
||||||
|
|
||||||
def _sanic_logo(self) -> None:
|
|
||||||
self.doc.a(
|
|
||||||
HTML(SVG_LOGO_SIMPLE),
|
|
||||||
href="https://sanic.dev",
|
|
||||||
target="_blank",
|
|
||||||
referrerpolicy="no-referrer",
|
|
||||||
)
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
from abc import ABCMeta
|
|
||||||
from pathlib import Path
|
|
||||||
from typing import Optional
|
|
||||||
|
|
||||||
|
|
||||||
CURRENT_DIR = Path(__file__).parent
|
|
||||||
|
|
||||||
|
|
||||||
def _extract_style(maybe_style: Optional[str], name: str) -> str:
|
|
||||||
if maybe_style is not None:
|
|
||||||
maybe_path = Path(maybe_style)
|
|
||||||
if maybe_path.exists():
|
|
||||||
return maybe_path.read_text(encoding="UTF-8")
|
|
||||||
return maybe_style
|
|
||||||
maybe_path = CURRENT_DIR / "styles" / f"{name}.css"
|
|
||||||
if maybe_path.exists():
|
|
||||||
return maybe_path.read_text(encoding="UTF-8")
|
|
||||||
return ""
|
|
||||||
|
|
||||||
|
|
||||||
class CSS(ABCMeta):
|
|
||||||
"""Cascade stylesheets, i.e. combine all ancestor styles"""
|
|
||||||
|
|
||||||
def __new__(cls, name, bases, attrs):
|
|
||||||
Page = super().__new__(cls, name, bases, attrs)
|
|
||||||
# Use a locally defined STYLE or the one from styles directory
|
|
||||||
Page.STYLE = _extract_style(attrs.get("STYLE_FILE"), name)
|
|
||||||
Page.STYLE += attrs.get("STYLE_APPEND", "")
|
|
||||||
# Combine with all ancestor styles
|
|
||||||
Page.CSS = "".join(
|
|
||||||
Class.STYLE
|
|
||||||
for Class in reversed(Page.__mro__)
|
|
||||||
if type(Class) is CSS
|
|
||||||
)
|
|
||||||
return Page
|
|
||||||
@@ -1,66 +0,0 @@
|
|||||||
import sys
|
|
||||||
|
|
||||||
from typing import Dict, Iterable
|
|
||||||
|
|
||||||
from html5tagger import E
|
|
||||||
|
|
||||||
from .base import BasePage
|
|
||||||
|
|
||||||
|
|
||||||
if sys.version_info < (3, 8): # no cov
|
|
||||||
FileInfo = Dict
|
|
||||||
|
|
||||||
else:
|
|
||||||
from typing import TypedDict
|
|
||||||
|
|
||||||
class FileInfo(TypedDict):
|
|
||||||
icon: str
|
|
||||||
file_name: str
|
|
||||||
file_access: str
|
|
||||||
file_size: str
|
|
||||||
|
|
||||||
|
|
||||||
class DirectoryPage(BasePage): # no cov
|
|
||||||
TITLE = "Directory Viewer"
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self, files: Iterable[FileInfo], url: str, debug: bool
|
|
||||||
) -> None:
|
|
||||||
super().__init__(debug)
|
|
||||||
self.files = files
|
|
||||||
self.url = url
|
|
||||||
|
|
||||||
def _body(self) -> None:
|
|
||||||
with self.doc.main:
|
|
||||||
self._headline()
|
|
||||||
files = list(self.files)
|
|
||||||
if files:
|
|
||||||
self._file_table(files)
|
|
||||||
else:
|
|
||||||
self.doc.p("The folder is empty.")
|
|
||||||
|
|
||||||
def _headline(self):
|
|
||||||
"""Implement a heading with the current path, combined with
|
|
||||||
breadcrumb links"""
|
|
||||||
with self.doc.h1(id="breadcrumbs"):
|
|
||||||
p = self.url.split("/")[:-1]
|
|
||||||
|
|
||||||
for i, part in enumerate(p):
|
|
||||||
path = "/".join(p[: i + 1]) + "/"
|
|
||||||
with self.doc.a(href=path):
|
|
||||||
self.doc.span(part, class_="dir").span("/", class_="sep")
|
|
||||||
|
|
||||||
def _file_table(self, files: Iterable[FileInfo]):
|
|
||||||
with self.doc.table(class_="autoindex container"):
|
|
||||||
for f in files:
|
|
||||||
self._file_row(**f)
|
|
||||||
|
|
||||||
def _file_row(
|
|
||||||
self,
|
|
||||||
icon: str,
|
|
||||||
file_name: str,
|
|
||||||
file_access: str,
|
|
||||||
file_size: str,
|
|
||||||
):
|
|
||||||
first = E.span(icon, class_="icon").a(file_name, href=file_name)
|
|
||||||
self.doc.tr.td(first).td(file_size).td(file_access)
|
|
||||||
@@ -1,109 +0,0 @@
|
|||||||
from typing import Any, Mapping
|
|
||||||
|
|
||||||
import tracerite.html
|
|
||||||
|
|
||||||
from html5tagger import E
|
|
||||||
from tracerite import html_traceback, inspector
|
|
||||||
|
|
||||||
from sanic.request import Request
|
|
||||||
|
|
||||||
from .base import BasePage
|
|
||||||
|
|
||||||
|
|
||||||
# Avoid showing the request in the traceback variable inspectors
|
|
||||||
inspector.blacklist_types += (Request,)
|
|
||||||
|
|
||||||
ENDUSER_TEXT = """\
|
|
||||||
We're sorry, but it looks like something went wrong. Please try refreshing \
|
|
||||||
the page or navigating back to the homepage. If the issue persists, our \
|
|
||||||
technical team is working to resolve it as soon as possible. We apologize \
|
|
||||||
for the inconvenience and appreciate your patience.\
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
|
||||||
class ErrorPage(BasePage):
|
|
||||||
STYLE_APPEND = tracerite.html.style
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self,
|
|
||||||
debug: bool,
|
|
||||||
title: str,
|
|
||||||
text: str,
|
|
||||||
request: Request,
|
|
||||||
exc: Exception,
|
|
||||||
) -> None:
|
|
||||||
super().__init__(debug)
|
|
||||||
name = request.app.name.replace("_", " ").strip()
|
|
||||||
if name.islower():
|
|
||||||
name = name.title()
|
|
||||||
self.TITLE = f"Application {name} cannot handle your request"
|
|
||||||
self.HEADING = E("Application ").strong(name)(
|
|
||||||
" cannot handle your request"
|
|
||||||
)
|
|
||||||
self.title = title
|
|
||||||
self.text = text
|
|
||||||
self.request = request
|
|
||||||
self.exc = exc
|
|
||||||
self.details_open = not getattr(exc, "quiet", False)
|
|
||||||
|
|
||||||
def _head(self) -> None:
|
|
||||||
self.doc._script(tracerite.html.javascript)
|
|
||||||
super()._head()
|
|
||||||
|
|
||||||
def _body(self) -> None:
|
|
||||||
debug = self.request.app.debug
|
|
||||||
route_name = self.request.name or "[route not found]"
|
|
||||||
with self.doc.main:
|
|
||||||
self.doc.h1(f"⚠️ {self.title}").p(self.text)
|
|
||||||
# Show context details if available on the exception
|
|
||||||
context = getattr(self.exc, "context", None)
|
|
||||||
if context:
|
|
||||||
self._key_value_table(
|
|
||||||
"Issue context", "exception-context", context
|
|
||||||
)
|
|
||||||
|
|
||||||
if not debug:
|
|
||||||
with self.doc.div(id="enduser"):
|
|
||||||
self.doc.p(ENDUSER_TEXT).p.a("Front Page", href="/")
|
|
||||||
return
|
|
||||||
# Show additional details in debug mode,
|
|
||||||
# open by default for 500 errors
|
|
||||||
with self.doc.details(open=self.details_open, class_="smalltext"):
|
|
||||||
# Show extra details if available on the exception
|
|
||||||
extra = getattr(self.exc, "extra", None)
|
|
||||||
if extra:
|
|
||||||
self._key_value_table(
|
|
||||||
"Issue extra data", "exception-extra", extra
|
|
||||||
)
|
|
||||||
|
|
||||||
self.doc.summary(
|
|
||||||
"Details for developers (Sanic debug mode only)"
|
|
||||||
)
|
|
||||||
if self.exc:
|
|
||||||
with self.doc.div(class_="exception-wrapper"):
|
|
||||||
self.doc.h2(f"Exception in {route_name}:")
|
|
||||||
self.doc(
|
|
||||||
html_traceback(self.exc, include_js_css=False)
|
|
||||||
)
|
|
||||||
|
|
||||||
self._key_value_table(
|
|
||||||
f"{self.request.method} {self.request.path}",
|
|
||||||
"request-headers",
|
|
||||||
self.request.headers,
|
|
||||||
)
|
|
||||||
|
|
||||||
def _key_value_table(
|
|
||||||
self, title: str, table_id: str, data: Mapping[str, Any]
|
|
||||||
) -> None:
|
|
||||||
with self.doc.div(class_="key-value-display"):
|
|
||||||
self.doc.h2(title)
|
|
||||||
with self.doc.dl(id=table_id, class_="key-value-table smalltext"):
|
|
||||||
for key, value in data.items():
|
|
||||||
# Reading values may cause a new exception, so suppress it
|
|
||||||
try:
|
|
||||||
value = str(value)
|
|
||||||
except Exception:
|
|
||||||
value = E.em("Unable to display value")
|
|
||||||
self.doc.dt.span(key, class_="nobr key").span(": ").dd(
|
|
||||||
value
|
|
||||||
)
|
|
||||||
@@ -1,146 +0,0 @@
|
|||||||
/** BasePage **/
|
|
||||||
|
|
||||||
:root {
|
|
||||||
--sanic: #ff0d68;
|
|
||||||
--sanic-yellow: #FFE900;
|
|
||||||
--sanic-background: #efeced;
|
|
||||||
--sanic-text: #121010;
|
|
||||||
--sanic-text-lighter: #756169;
|
|
||||||
--sanic-link: #ff0d68;
|
|
||||||
--sanic-block-background: #f7f4f6;
|
|
||||||
--sanic-block-text: #000;
|
|
||||||
--sanic-block-alt-text: #6b6468;
|
|
||||||
--sanic-header-background: #272325;
|
|
||||||
--sanic-header-border: #fff;
|
|
||||||
--sanic-header-text: #fff;
|
|
||||||
--sanic-highlight-background: var(--sanic-yellow);
|
|
||||||
--sanic-highlight-text: var(--sanic-text);
|
|
||||||
--sanic-tab-background: #f7f4f6;
|
|
||||||
--sanic-tab-shadow: #f7f6f6;
|
|
||||||
--sanic-tab-text: #222021;
|
|
||||||
--sanic-tracerite-var: var(--sanic-text);
|
|
||||||
--sanic-tracerite-val: #ff0d68;
|
|
||||||
--sanic-tracerite-type: #6d6a6b;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
@media (prefers-color-scheme: dark) {
|
|
||||||
:root {
|
|
||||||
--sanic-text: #f7f4f6;
|
|
||||||
--sanic-background: #121010;
|
|
||||||
--sanic-block-background: #0f0d0e;
|
|
||||||
--sanic-block-text: #f7f4f6;
|
|
||||||
--sanic-header-background: #030203;
|
|
||||||
--sanic-header-border: #000;
|
|
||||||
--sanic-highlight-text: var(--sanic-background);
|
|
||||||
--sanic-tab-background: #292728;
|
|
||||||
--sanic-tab-shadow: #0f0d0e;
|
|
||||||
--sanic-tab-text: #aea7ab;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
html {
|
|
||||||
font: 16px sans-serif;
|
|
||||||
background: var(--sanic-background);
|
|
||||||
color: var(--sanic-text);
|
|
||||||
scrollbar-gutter: stable;
|
|
||||||
overflow: hidden auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
margin: 0;
|
|
||||||
font-size: 1.25rem;
|
|
||||||
line-height: 125%;
|
|
||||||
}
|
|
||||||
|
|
||||||
body>* {
|
|
||||||
padding: 1rem 2vw;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media (max-width: 1000px) {
|
|
||||||
body>* {
|
|
||||||
padding: 0.5rem 1.5vw;
|
|
||||||
}
|
|
||||||
|
|
||||||
html {
|
|
||||||
/* Scale everything by rem of 6px-16px by viewport width */
|
|
||||||
font-size: calc(6px + 10 * 100vw / 1000);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
main {
|
|
||||||
/* Make sure the footer is closer to bottom */
|
|
||||||
min-height: 70vh;
|
|
||||||
/* Generous padding for readability */
|
|
||||||
padding: 1rem 2.5rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
.smalltext {
|
|
||||||
font-size: 1.0rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
.container {
|
|
||||||
min-width: 600px;
|
|
||||||
max-width: 1600px;
|
|
||||||
}
|
|
||||||
|
|
||||||
header {
|
|
||||||
background: var(--sanic-header-background);
|
|
||||||
color: var(--sanic-header-text);
|
|
||||||
border-bottom: 1px solid var(--sanic-header-border);
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
footer {
|
|
||||||
text-align: center;
|
|
||||||
display: flex;
|
|
||||||
flex-direction: column;
|
|
||||||
font-size: 0.8rem;
|
|
||||||
margin: 2rem;
|
|
||||||
line-height: 1.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 {
|
|
||||||
text-align: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
a {
|
|
||||||
text-decoration: none;
|
|
||||||
color: var(--sanic-link);
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover,
|
|
||||||
a:focus {
|
|
||||||
text-decoration: underline;
|
|
||||||
outline: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
span.icon {
|
|
||||||
margin-right: 1rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
#logo-simple {
|
|
||||||
height: 1.75rem;
|
|
||||||
padding: 0 0.25rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
@media (prefers-color-scheme: dark) {
|
|
||||||
#logo-simple path:last-child {
|
|
||||||
fill: #e1e1e1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#sanic pre,
|
|
||||||
#sanic code {
|
|
||||||
font-family: "Fira Code",
|
|
||||||
"Source Code Pro",
|
|
||||||
Menlo,
|
|
||||||
Meslo,
|
|
||||||
Monaco,
|
|
||||||
Consolas,
|
|
||||||
Lucida Console,
|
|
||||||
monospace;
|
|
||||||
font-size: 0.8rem;
|
|
||||||
}
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
/** DirectoryPage **/
|
|
||||||
#breadcrumbs>a:hover {
|
|
||||||
text-decoration: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
#breadcrumbs>a .dir {
|
|
||||||
padding: 0 0.25em;
|
|
||||||
}
|
|
||||||
|
|
||||||
#breadcrumbs>a:first-child:hover::before,
|
|
||||||
#breadcrumbs>a .dir:hover {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
|
|
||||||
#breadcrumbs>a:first-child::before {
|
|
||||||
content: "🏠";
|
|
||||||
}
|
|
||||||
|
|
||||||
#breadcrumbs>a:last-child {
|
|
||||||
color: #ff0d68;
|
|
||||||
}
|
|
||||||
|
|
||||||
main a {
|
|
||||||
color: inherit;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.autoindex {
|
|
||||||
width: 100%;
|
|
||||||
font-family: monospace;
|
|
||||||
font-size: 1.25rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.autoindex tr {
|
|
||||||
display: flex;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.autoindex tr:hover {
|
|
||||||
background-color: #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.autoindex td {
|
|
||||||
margin: 0 0.5rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.autoindex td:first-child {
|
|
||||||
flex: 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.autoindex td:nth-child(2) {
|
|
||||||
text-align: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.autoindex td:last-child {
|
|
||||||
text-align: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
@media (prefers-color-scheme: dark) {
|
|
||||||
table.autoindex tr:hover {
|
|
||||||
background-color: #222;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,108 +0,0 @@
|
|||||||
/** ErrorPage **/
|
|
||||||
#enduser {
|
|
||||||
max-width: 30em;
|
|
||||||
margin: 5em auto 5em auto;
|
|
||||||
text-align: justify;
|
|
||||||
/*text-justify: both;*/
|
|
||||||
}
|
|
||||||
|
|
||||||
#enduser a {
|
|
||||||
color: var(--sanic-blue);
|
|
||||||
}
|
|
||||||
|
|
||||||
#enduser p:last-child {
|
|
||||||
text-align: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
summary {
|
|
||||||
margin-top: 3em;
|
|
||||||
color: var(--sanic-text-lighter);
|
|
||||||
cursor: pointer;
|
|
||||||
}
|
|
||||||
|
|
||||||
.tracerite {
|
|
||||||
--tracerite-var: var(--sanic-tracerite-var);
|
|
||||||
--tracerite-val: var(--sanic-tracerite-val);
|
|
||||||
--tracerite-type: var(--sanic-tracerite-type);
|
|
||||||
--tracerite-exception: var(--sanic);
|
|
||||||
--tracerite-highlight: var(--sanic-yellow);
|
|
||||||
--tracerite-tab: var(--sanic-tab-background);
|
|
||||||
--tracerite-tab-text: var(--sanic-tab-text);
|
|
||||||
}
|
|
||||||
|
|
||||||
.tracerite>h3 {
|
|
||||||
margin: 0.5rem 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
#sanic .tracerite .traceback-labels button {
|
|
||||||
font-size: 0.8rem;
|
|
||||||
line-height: 120%;
|
|
||||||
background: var(--tracerite-tab);
|
|
||||||
color: var(--tracerite-tab-text);
|
|
||||||
transition: 0.3s;
|
|
||||||
cursor: pointer;
|
|
||||||
}
|
|
||||||
|
|
||||||
.tracerite .traceback-labels {
|
|
||||||
padding-top: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.tracerite .traceback-labels button:hover {
|
|
||||||
filter: contrast(150%) brightness(120%) drop-shadow(0 -0 2px var(--sanic-tab-shadow));
|
|
||||||
}
|
|
||||||
|
|
||||||
#sanic .tracerite .tracerite-tooltip::before {
|
|
||||||
bottom: 1.75em;
|
|
||||||
}
|
|
||||||
|
|
||||||
#sanic .tracerite .traceback-details mark span {
|
|
||||||
background: var(--sanic-highlight-background);
|
|
||||||
color: var(--sanic-highlight-text);
|
|
||||||
}
|
|
||||||
|
|
||||||
header {
|
|
||||||
background: var(--sanic-header-background);
|
|
||||||
}
|
|
||||||
|
|
||||||
h2 {
|
|
||||||
font-size: 1.3rem;
|
|
||||||
color: var(--sanic-text);
|
|
||||||
}
|
|
||||||
|
|
||||||
.key-value-display,
|
|
||||||
.exception-wrapper {
|
|
||||||
padding: 0.5rem;
|
|
||||||
margin-top: 1rem;
|
|
||||||
}
|
|
||||||
|
|
||||||
.key-value-display {
|
|
||||||
background-color: var(--sanic-block-background);
|
|
||||||
color: var(--sanic-block-text);
|
|
||||||
}
|
|
||||||
|
|
||||||
.key-value-display h2 {
|
|
||||||
margin-bottom: 0.2em;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.key-value-table {
|
|
||||||
width: 100%;
|
|
||||||
margin: 0;
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: 1fr 5fr;
|
|
||||||
grid-gap: .3em;
|
|
||||||
white-space: pre-wrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.key-value-table * {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.key-value-table dt {
|
|
||||||
color: var(--sanic-block-alt-text);
|
|
||||||
word-break: break-word;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.key-value-table dd {
|
|
||||||
/* Better breaking for cookies header and such */
|
|
||||||
word-break: break-all;
|
|
||||||
}
|
|
||||||
@@ -2,22 +2,19 @@ from __future__ import annotations
|
|||||||
|
|
||||||
from contextvars import ContextVar
|
from contextvars import ContextVar
|
||||||
from inspect import isawaitable
|
from inspect import isawaitable
|
||||||
from types import SimpleNamespace
|
|
||||||
from typing import (
|
from typing import (
|
||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
Any,
|
Any,
|
||||||
DefaultDict,
|
DefaultDict,
|
||||||
Dict,
|
Dict,
|
||||||
Generic,
|
|
||||||
List,
|
List,
|
||||||
|
NamedTuple,
|
||||||
Optional,
|
Optional,
|
||||||
Tuple,
|
Tuple,
|
||||||
Union,
|
Union,
|
||||||
cast,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
from sanic_routing.route import Route
|
from sanic_routing.route import Route
|
||||||
from typing_extensions import TypeVar
|
|
||||||
|
|
||||||
from sanic.http.constants import HTTP # type: ignore
|
from sanic.http.constants import HTTP # type: ignore
|
||||||
from sanic.http.stream import Stream
|
from sanic.http.stream import Stream
|
||||||
@@ -26,14 +23,16 @@ from sanic.models.http_types import Credentials
|
|||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from sanic.app import Sanic
|
|
||||||
from sanic.config import Config
|
|
||||||
from sanic.server import ConnInfo
|
from sanic.server import ConnInfo
|
||||||
|
from sanic.app import Sanic
|
||||||
|
|
||||||
|
import email.utils
|
||||||
import uuid
|
import uuid
|
||||||
|
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
from urllib.parse import parse_qs, parse_qsl, urlunparse
|
from http.cookies import SimpleCookie
|
||||||
|
from types import SimpleNamespace
|
||||||
|
from urllib.parse import parse_qs, parse_qsl, unquote, urlunparse
|
||||||
|
|
||||||
from httptools import parse_url
|
from httptools import parse_url
|
||||||
from httptools.parser.errors import HttpParserInvalidURLError
|
from httptools.parser.errors import HttpParserInvalidURLError
|
||||||
@@ -45,10 +44,9 @@ from sanic.constants import (
|
|||||||
IDEMPOTENT_HTTP_METHODS,
|
IDEMPOTENT_HTTP_METHODS,
|
||||||
SAFE_HTTP_METHODS,
|
SAFE_HTTP_METHODS,
|
||||||
)
|
)
|
||||||
from sanic.cookies.request import CookieRequestParameters, parse_cookie
|
|
||||||
from sanic.exceptions import BadRequest, BadURL, ServerError
|
from sanic.exceptions import BadRequest, BadURL, ServerError
|
||||||
from sanic.headers import (
|
from sanic.headers import (
|
||||||
AcceptList,
|
AcceptContainer,
|
||||||
Options,
|
Options,
|
||||||
parse_accept,
|
parse_accept,
|
||||||
parse_content_header,
|
parse_content_header,
|
||||||
@@ -58,34 +56,37 @@ from sanic.headers import (
|
|||||||
parse_xforwarded,
|
parse_xforwarded,
|
||||||
)
|
)
|
||||||
from sanic.http import Stage
|
from sanic.http import Stage
|
||||||
from sanic.log import error_logger
|
from sanic.log import deprecation, error_logger, logger
|
||||||
from sanic.models.protocol_types import TransportProtocol
|
from sanic.models.protocol_types import TransportProtocol
|
||||||
from sanic.response import BaseHTTPResponse, HTTPResponse
|
from sanic.response import BaseHTTPResponse, HTTPResponse
|
||||||
|
|
||||||
from .form import parse_multipart_form
|
|
||||||
from .parameters import RequestParameters
|
|
||||||
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from ujson import loads as json_loads # type: ignore
|
from ujson import loads as json_loads # type: ignore
|
||||||
except ImportError:
|
except ImportError:
|
||||||
from json import loads as json_loads # type: ignore
|
from json import loads as json_loads # type: ignore
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
|
||||||
# The default argument of TypeVar is proposed to be added in Python 3.13
|
class RequestParameters(dict):
|
||||||
# by PEP 696 (https://www.python.org/dev/peps/pep-0696/).
|
"""
|
||||||
# Therefore, we use typing_extensions.TypeVar for compatibility.
|
Hosts a dict with lists as values where get returns the first
|
||||||
# For more information, see:
|
value of the list and getlist returns the whole shebang
|
||||||
# https://discuss.python.org/t/pep-696-type-defaults-for-typevarlikes
|
"""
|
||||||
sanic_type = TypeVar(
|
|
||||||
"sanic_type", bound=Sanic, default=Sanic[Config, SimpleNamespace]
|
def get(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
|
||||||
)
|
"""Return the first value, either the default or actual"""
|
||||||
else:
|
return super().get(name, [default])[0]
|
||||||
sanic_type = TypeVar("sanic_type")
|
|
||||||
ctx_type = TypeVar("ctx_type")
|
def getlist(
|
||||||
|
self, name: str, default: Optional[Any] = None
|
||||||
|
) -> Optional[Any]:
|
||||||
|
"""
|
||||||
|
Return the entire list
|
||||||
|
"""
|
||||||
|
return super().get(name, default)
|
||||||
|
|
||||||
|
|
||||||
class Request(Generic[sanic_type, ctx_type]):
|
class Request:
|
||||||
"""
|
"""
|
||||||
Properties of an HTTP request such as URL, headers, etc.
|
Properties of an HTTP request such as URL, headers, etc.
|
||||||
"""
|
"""
|
||||||
@@ -96,7 +97,6 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
__slots__ = (
|
__slots__ = (
|
||||||
"__weakref__",
|
"__weakref__",
|
||||||
"_cookies",
|
"_cookies",
|
||||||
"_ctx",
|
|
||||||
"_id",
|
"_id",
|
||||||
"_ip",
|
"_ip",
|
||||||
"_parsed_url",
|
"_parsed_url",
|
||||||
@@ -113,12 +113,12 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
"app",
|
"app",
|
||||||
"body",
|
"body",
|
||||||
"conn_info",
|
"conn_info",
|
||||||
|
"ctx",
|
||||||
"head",
|
"head",
|
||||||
"headers",
|
"headers",
|
||||||
"method",
|
"method",
|
||||||
"parsed_accept",
|
"parsed_accept",
|
||||||
"parsed_args",
|
"parsed_args",
|
||||||
"parsed_cookies",
|
|
||||||
"parsed_credentials",
|
"parsed_credentials",
|
||||||
"parsed_files",
|
"parsed_files",
|
||||||
"parsed_form",
|
"parsed_form",
|
||||||
@@ -141,16 +141,16 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
version: str,
|
version: str,
|
||||||
method: str,
|
method: str,
|
||||||
transport: TransportProtocol,
|
transport: TransportProtocol,
|
||||||
app: sanic_type,
|
app: Sanic,
|
||||||
head: bytes = b"",
|
head: bytes = b"",
|
||||||
stream_id: int = 0,
|
stream_id: int = 0,
|
||||||
):
|
):
|
||||||
|
|
||||||
self.raw_url = url_bytes
|
self.raw_url = url_bytes
|
||||||
try:
|
try:
|
||||||
self._parsed_url = parse_url(url_bytes)
|
self._parsed_url = parse_url(url_bytes)
|
||||||
except HttpParserInvalidURLError:
|
except HttpParserInvalidURLError:
|
||||||
url = url_bytes.decode(errors="backslashreplace")
|
raise BadURL(f"Bad URL: {url_bytes.decode()}")
|
||||||
raise BadURL(f"Bad URL: {url}")
|
|
||||||
self._id: Optional[Union[uuid.UUID, str, int]] = None
|
self._id: Optional[Union[uuid.UUID, str, int]] = None
|
||||||
self._name: Optional[str] = None
|
self._name: Optional[str] = None
|
||||||
self._stream_id = stream_id
|
self._stream_id = stream_id
|
||||||
@@ -165,26 +165,26 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
# Init but do not inhale
|
# Init but do not inhale
|
||||||
self.body = b""
|
self.body = b""
|
||||||
self.conn_info: Optional[ConnInfo] = None
|
self.conn_info: Optional[ConnInfo] = None
|
||||||
self._ctx: Optional[ctx_type] = None
|
self.ctx = SimpleNamespace()
|
||||||
self.parsed_accept: Optional[AcceptList] = None
|
self.parsed_forwarded: Optional[Options] = None
|
||||||
|
self.parsed_accept: Optional[AcceptContainer] = None
|
||||||
|
self.parsed_credentials: Optional[Credentials] = None
|
||||||
|
self.parsed_json = None
|
||||||
|
self.parsed_form: Optional[RequestParameters] = None
|
||||||
|
self.parsed_files: Optional[RequestParameters] = None
|
||||||
|
self.parsed_token: Optional[str] = None
|
||||||
self.parsed_args: DefaultDict[
|
self.parsed_args: DefaultDict[
|
||||||
Tuple[bool, bool, str, str], RequestParameters
|
Tuple[bool, bool, str, str], RequestParameters
|
||||||
] = defaultdict(RequestParameters)
|
] = defaultdict(RequestParameters)
|
||||||
self.parsed_cookies: Optional[RequestParameters] = None
|
|
||||||
self.parsed_credentials: Optional[Credentials] = None
|
|
||||||
self.parsed_files: Optional[RequestParameters] = None
|
|
||||||
self.parsed_form: Optional[RequestParameters] = None
|
|
||||||
self.parsed_forwarded: Optional[Options] = None
|
|
||||||
self.parsed_json = None
|
|
||||||
self.parsed_not_grouped_args: DefaultDict[
|
self.parsed_not_grouped_args: DefaultDict[
|
||||||
Tuple[bool, bool, str, str], List[Tuple[str, str]]
|
Tuple[bool, bool, str, str], List[Tuple[str, str]]
|
||||||
] = defaultdict(list)
|
] = defaultdict(list)
|
||||||
self.parsed_token: Optional[str] = None
|
|
||||||
self._request_middleware_started = False
|
self._request_middleware_started = False
|
||||||
self._response_middleware_started = False
|
self._response_middleware_started = False
|
||||||
self.responded: bool = False
|
self.responded: bool = False
|
||||||
self.route: Optional[Route] = None
|
self.route: Optional[Route] = None
|
||||||
self.stream: Optional[Stream] = None
|
self.stream: Optional[Stream] = None
|
||||||
|
self._cookies: Optional[Dict[str, str]] = None
|
||||||
self._match_info: Dict[str, Any] = {}
|
self._match_info: Dict[str, Any] = {}
|
||||||
self._protocol = None
|
self._protocol = None
|
||||||
|
|
||||||
@@ -192,10 +192,6 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
class_name = self.__class__.__name__
|
class_name = self.__class__.__name__
|
||||||
return f"<{class_name}: {self.method} {self.path}>"
|
return f"<{class_name}: {self.method} {self.path}>"
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def make_context() -> ctx_type:
|
|
||||||
return cast(ctx_type, SimpleNamespace())
|
|
||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def get_current(cls) -> Request:
|
def get_current(cls) -> Request:
|
||||||
"""
|
"""
|
||||||
@@ -226,13 +222,14 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
return uuid.uuid4()
|
return uuid.uuid4()
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def ctx(self) -> ctx_type:
|
def request_middleware_started(self):
|
||||||
"""
|
deprecation(
|
||||||
:return: The current request context
|
"Request.request_middleware_started has been deprecated and will"
|
||||||
"""
|
"be removed. You should set a flag on the request context using"
|
||||||
if not self._ctx:
|
"either middleware or signals if you need this feature.",
|
||||||
self._ctx = self.make_context()
|
23.3,
|
||||||
return self._ctx
|
)
|
||||||
|
return self._request_middleware_started
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def stream_id(self):
|
def stream_id(self):
|
||||||
@@ -502,17 +499,14 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
return self.parsed_json
|
return self.parsed_json
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def accept(self) -> AcceptList:
|
def accept(self) -> AcceptContainer:
|
||||||
"""Accepted response content types.
|
"""
|
||||||
|
|
||||||
A convenience handler for easier RFC-compliant matching of MIME types,
|
|
||||||
parsed as a list that can match wildcards and includes */* by default.
|
|
||||||
|
|
||||||
:return: The ``Accept`` header parsed
|
:return: The ``Accept`` header parsed
|
||||||
:rtype: AcceptList
|
:rtype: AcceptContainer
|
||||||
"""
|
"""
|
||||||
if self.parsed_accept is None:
|
if self.parsed_accept is None:
|
||||||
self.parsed_accept = parse_accept(self.headers.get("accept"))
|
accept_header = self.headers.getone("accept", "")
|
||||||
|
self.parsed_accept = parse_accept(accept_header)
|
||||||
return self.parsed_accept
|
return self.parsed_accept
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@@ -734,21 +728,24 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
default values.
|
default values.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def get_cookies(self) -> RequestParameters:
|
|
||||||
cookie = self.headers.getone("cookie", "")
|
|
||||||
self.parsed_cookies = CookieRequestParameters(parse_cookie(cookie))
|
|
||||||
return self.parsed_cookies
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def cookies(self) -> RequestParameters:
|
def cookies(self) -> Dict[str, str]:
|
||||||
"""
|
"""
|
||||||
:return: Incoming cookies on the request
|
:return: Incoming cookies on the request
|
||||||
:rtype: Dict[str, str]
|
:rtype: Dict[str, str]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
if self.parsed_cookies is None:
|
if self._cookies is None:
|
||||||
self.get_cookies()
|
cookie = self.headers.getone("cookie", None)
|
||||||
return cast(CookieRequestParameters, self.parsed_cookies)
|
if cookie is not None:
|
||||||
|
cookies: SimpleCookie = SimpleCookie()
|
||||||
|
cookies.load(cookie)
|
||||||
|
self._cookies = {
|
||||||
|
name: cookie.value for name, cookie in cookies.items()
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
self._cookies = {}
|
||||||
|
return self._cookies
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def content_type(self) -> str:
|
def content_type(self) -> str:
|
||||||
@@ -838,31 +835,19 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
@property
|
@property
|
||||||
def remote_addr(self) -> str:
|
def remote_addr(self) -> str:
|
||||||
"""
|
"""
|
||||||
Client IP address, if available from proxy.
|
Client IP address, if available.
|
||||||
|
1. proxied remote address `self.forwarded['for']`
|
||||||
|
2. local remote address `self.ip`
|
||||||
|
|
||||||
:return: IPv4, bracketed IPv6, UNIX socket name or arbitrary string
|
:return: IPv4, bracketed IPv6, UNIX socket name or arbitrary string
|
||||||
:rtype: str
|
:rtype: str
|
||||||
"""
|
"""
|
||||||
if not hasattr(self, "_remote_addr"):
|
if not hasattr(self, "_remote_addr"):
|
||||||
self._remote_addr = str(self.forwarded.get("for", ""))
|
self._remote_addr = str(
|
||||||
|
self.forwarded.get("for", "")
|
||||||
|
) # or self.ip
|
||||||
return self._remote_addr
|
return self._remote_addr
|
||||||
|
|
||||||
@property
|
|
||||||
def client_ip(self) -> str:
|
|
||||||
"""
|
|
||||||
Client IP address.
|
|
||||||
1. proxied remote address `self.forwarded['for']`
|
|
||||||
2. local peer address `self.ip`
|
|
||||||
|
|
||||||
New in Sanic 23.6. Prefer this over `remote_addr` for determining the
|
|
||||||
client address regardless of whether the service runs behind a proxy
|
|
||||||
or not (proxy deployment needs separate configuration).
|
|
||||||
|
|
||||||
:return: IPv4, bracketed IPv6, UNIX socket name or arbitrary string
|
|
||||||
:rtype: str
|
|
||||||
"""
|
|
||||||
return self.remote_addr or self.ip
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def scheme(self) -> str:
|
def scheme(self) -> str:
|
||||||
"""
|
"""
|
||||||
@@ -1038,3 +1023,91 @@ class Request(Generic[sanic_type, ctx_type]):
|
|||||||
:rtype: bool
|
:rtype: bool
|
||||||
"""
|
"""
|
||||||
return self.method in CACHEABLE_HTTP_METHODS
|
return self.method in CACHEABLE_HTTP_METHODS
|
||||||
|
|
||||||
|
|
||||||
|
class File(NamedTuple):
|
||||||
|
"""
|
||||||
|
Model for defining a file. It is a ``namedtuple``, therefore you can
|
||||||
|
iterate over the object, or access the parameters by name.
|
||||||
|
|
||||||
|
:param type: The mimetype, defaults to text/plain
|
||||||
|
:param body: Bytes of the file
|
||||||
|
:param name: The filename
|
||||||
|
"""
|
||||||
|
|
||||||
|
type: str
|
||||||
|
body: bytes
|
||||||
|
name: str
|
||||||
|
|
||||||
|
|
||||||
|
def parse_multipart_form(body, boundary):
|
||||||
|
"""
|
||||||
|
Parse a request body and returns fields and files
|
||||||
|
|
||||||
|
:param body: bytes request body
|
||||||
|
:param boundary: bytes multipart boundary
|
||||||
|
:return: fields (RequestParameters), files (RequestParameters)
|
||||||
|
"""
|
||||||
|
files = RequestParameters()
|
||||||
|
fields = RequestParameters()
|
||||||
|
|
||||||
|
form_parts = body.split(boundary)
|
||||||
|
for form_part in form_parts[1:-1]:
|
||||||
|
file_name = None
|
||||||
|
content_type = "text/plain"
|
||||||
|
content_charset = "utf-8"
|
||||||
|
field_name = None
|
||||||
|
line_index = 2
|
||||||
|
line_end_index = 0
|
||||||
|
while not line_end_index == -1:
|
||||||
|
line_end_index = form_part.find(b"\r\n", line_index)
|
||||||
|
form_line = form_part[line_index:line_end_index].decode("utf-8")
|
||||||
|
line_index = line_end_index + 2
|
||||||
|
|
||||||
|
if not form_line:
|
||||||
|
break
|
||||||
|
|
||||||
|
colon_index = form_line.index(":")
|
||||||
|
idx = colon_index + 2
|
||||||
|
form_header_field = form_line[0:colon_index].lower()
|
||||||
|
form_header_value, form_parameters = parse_content_header(
|
||||||
|
form_line[idx:]
|
||||||
|
)
|
||||||
|
|
||||||
|
if form_header_field == "content-disposition":
|
||||||
|
field_name = form_parameters.get("name")
|
||||||
|
file_name = form_parameters.get("filename")
|
||||||
|
|
||||||
|
# non-ASCII filenames in RFC2231, "filename*" format
|
||||||
|
if file_name is None and form_parameters.get("filename*"):
|
||||||
|
encoding, _, value = email.utils.decode_rfc2231(
|
||||||
|
form_parameters["filename*"]
|
||||||
|
)
|
||||||
|
file_name = unquote(value, encoding=encoding)
|
||||||
|
elif form_header_field == "content-type":
|
||||||
|
content_type = form_header_value
|
||||||
|
content_charset = form_parameters.get("charset", "utf-8")
|
||||||
|
|
||||||
|
if field_name:
|
||||||
|
post_data = form_part[line_index:-4]
|
||||||
|
if file_name is None:
|
||||||
|
value = post_data.decode(content_charset)
|
||||||
|
if field_name in fields:
|
||||||
|
fields[field_name].append(value)
|
||||||
|
else:
|
||||||
|
fields[field_name] = [value]
|
||||||
|
else:
|
||||||
|
form_file = File(
|
||||||
|
type=content_type, name=file_name, body=post_data
|
||||||
|
)
|
||||||
|
if field_name in files:
|
||||||
|
files[field_name].append(form_file)
|
||||||
|
else:
|
||||||
|
files[field_name] = [form_file]
|
||||||
|
else:
|
||||||
|
logger.debug(
|
||||||
|
"Form-data field does not have a 'name' parameter "
|
||||||
|
"in the Content-Disposition header"
|
||||||
|
)
|
||||||
|
|
||||||
|
return fields, files
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
from .form import File, parse_multipart_form
|
|
||||||
from .parameters import RequestParameters
|
|
||||||
from .types import Request
|
|
||||||
|
|
||||||
|
|
||||||
__all__ = (
|
|
||||||
"File",
|
|
||||||
"parse_multipart_form",
|
|
||||||
"Request",
|
|
||||||
"RequestParameters",
|
|
||||||
)
|
|
||||||
@@ -1,110 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
import email.utils
|
|
||||||
import unicodedata
|
|
||||||
|
|
||||||
from typing import NamedTuple
|
|
||||||
from urllib.parse import unquote
|
|
||||||
|
|
||||||
from sanic.headers import parse_content_header
|
|
||||||
from sanic.log import logger
|
|
||||||
|
|
||||||
from .parameters import RequestParameters
|
|
||||||
|
|
||||||
|
|
||||||
class File(NamedTuple):
|
|
||||||
"""
|
|
||||||
Model for defining a file. It is a ``namedtuple``, therefore you can
|
|
||||||
iterate over the object, or access the parameters by name.
|
|
||||||
|
|
||||||
:param type: The mimetype, defaults to text/plain
|
|
||||||
:param body: Bytes of the file
|
|
||||||
:param name: The filename
|
|
||||||
"""
|
|
||||||
|
|
||||||
type: str
|
|
||||||
body: bytes
|
|
||||||
name: str
|
|
||||||
|
|
||||||
|
|
||||||
def parse_multipart_form(body, boundary):
|
|
||||||
"""
|
|
||||||
Parse a request body and returns fields and files
|
|
||||||
|
|
||||||
:param body: bytes request body
|
|
||||||
:param boundary: bytes multipart boundary
|
|
||||||
:return: fields (RequestParameters), files (RequestParameters)
|
|
||||||
"""
|
|
||||||
files = {}
|
|
||||||
fields = {}
|
|
||||||
|
|
||||||
form_parts = body.split(boundary)
|
|
||||||
for form_part in form_parts[1:-1]:
|
|
||||||
file_name = None
|
|
||||||
content_type = "text/plain"
|
|
||||||
content_charset = "utf-8"
|
|
||||||
field_name = None
|
|
||||||
line_index = 2
|
|
||||||
line_end_index = 0
|
|
||||||
while not line_end_index == -1:
|
|
||||||
line_end_index = form_part.find(b"\r\n", line_index)
|
|
||||||
form_line = form_part[line_index:line_end_index].decode("utf-8")
|
|
||||||
line_index = line_end_index + 2
|
|
||||||
|
|
||||||
if not form_line:
|
|
||||||
break
|
|
||||||
|
|
||||||
colon_index = form_line.index(":")
|
|
||||||
idx = colon_index + 2
|
|
||||||
form_header_field = form_line[0:colon_index].lower()
|
|
||||||
form_header_value, form_parameters = parse_content_header(
|
|
||||||
form_line[idx:]
|
|
||||||
)
|
|
||||||
|
|
||||||
if form_header_field == "content-disposition":
|
|
||||||
field_name = form_parameters.get("name")
|
|
||||||
file_name = form_parameters.get("filename")
|
|
||||||
|
|
||||||
# non-ASCII filenames in RFC2231, "filename*" format
|
|
||||||
if file_name is None and form_parameters.get("filename*"):
|
|
||||||
encoding, _, value = email.utils.decode_rfc2231(
|
|
||||||
form_parameters["filename*"]
|
|
||||||
)
|
|
||||||
file_name = unquote(value, encoding=encoding)
|
|
||||||
|
|
||||||
# Normalize to NFC (Apple MacOS/iOS send NFD)
|
|
||||||
# Notes:
|
|
||||||
# - No effect for Windows, Linux or Android clients which
|
|
||||||
# already send NFC
|
|
||||||
# - Python open() is tricky (creates files in NFC no matter
|
|
||||||
# which form you use)
|
|
||||||
if file_name is not None:
|
|
||||||
file_name = unicodedata.normalize("NFC", file_name)
|
|
||||||
|
|
||||||
elif form_header_field == "content-type":
|
|
||||||
content_type = form_header_value
|
|
||||||
content_charset = form_parameters.get("charset", "utf-8")
|
|
||||||
|
|
||||||
if field_name:
|
|
||||||
post_data = form_part[line_index:-4]
|
|
||||||
if file_name is None:
|
|
||||||
value = post_data.decode(content_charset)
|
|
||||||
if field_name in fields:
|
|
||||||
fields[field_name].append(value)
|
|
||||||
else:
|
|
||||||
fields[field_name] = [value]
|
|
||||||
else:
|
|
||||||
form_file = File(
|
|
||||||
type=content_type, name=file_name, body=post_data
|
|
||||||
)
|
|
||||||
if field_name in files:
|
|
||||||
files[field_name].append(form_file)
|
|
||||||
else:
|
|
||||||
files[field_name] = [form_file]
|
|
||||||
else:
|
|
||||||
logger.debug(
|
|
||||||
"Form-data field does not have a 'name' parameter "
|
|
||||||
"in the Content-Disposition header"
|
|
||||||
)
|
|
||||||
|
|
||||||
return RequestParameters(fields), RequestParameters(files)
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
from __future__ import annotations
|
|
||||||
|
|
||||||
from typing import Any, Optional
|
|
||||||
|
|
||||||
|
|
||||||
class RequestParameters(dict):
|
|
||||||
"""
|
|
||||||
Hosts a dict with lists as values where get returns the first
|
|
||||||
value of the list and getlist returns the whole shebang
|
|
||||||
"""
|
|
||||||
|
|
||||||
def get(self, name: str, default: Optional[Any] = None) -> Optional[Any]:
|
|
||||||
"""Return the first value, either the default or actual"""
|
|
||||||
return super().get(name, [default])[0]
|
|
||||||
|
|
||||||
def getlist(
|
|
||||||
self, name: str, default: Optional[Any] = None
|
|
||||||
) -> Optional[Any]:
|
|
||||||
"""
|
|
||||||
Return the entire list
|
|
||||||
"""
|
|
||||||
return super().get(name, default)
|
|
||||||
@@ -148,26 +148,7 @@ async def validate_file(
|
|||||||
last_modified = datetime.fromtimestamp(
|
last_modified = datetime.fromtimestamp(
|
||||||
float(last_modified), tz=timezone.utc
|
float(last_modified), tz=timezone.utc
|
||||||
).replace(microsecond=0)
|
).replace(microsecond=0)
|
||||||
|
if last_modified <= if_modified_since:
|
||||||
if (
|
|
||||||
last_modified.utcoffset() is None
|
|
||||||
and if_modified_since.utcoffset() is not None
|
|
||||||
):
|
|
||||||
logger.warning(
|
|
||||||
"Cannot compare tz-aware and tz-naive datetimes. To avoid "
|
|
||||||
"this conflict Sanic is converting last_modified to UTC."
|
|
||||||
)
|
|
||||||
last_modified.replace(tzinfo=timezone.utc)
|
|
||||||
elif (
|
|
||||||
last_modified.utcoffset() is not None
|
|
||||||
and if_modified_since.utcoffset() is None
|
|
||||||
):
|
|
||||||
logger.warning(
|
|
||||||
"Cannot compare tz-aware and tz-naive datetimes. To avoid "
|
|
||||||
"this conflict Sanic is converting if_modified_since to UTC."
|
|
||||||
)
|
|
||||||
if_modified_since.replace(tzinfo=timezone.utc)
|
|
||||||
if last_modified.timestamp() <= if_modified_since.timestamp():
|
|
||||||
return HTTPResponse(status=304)
|
return HTTPResponse(status=304)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
from datetime import datetime
|
|
||||||
from functools import partial
|
from functools import partial
|
||||||
from typing import (
|
from typing import (
|
||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
@@ -18,7 +17,6 @@ from typing import (
|
|||||||
|
|
||||||
from sanic.compat import Header
|
from sanic.compat import Header
|
||||||
from sanic.cookies import CookieJar
|
from sanic.cookies import CookieJar
|
||||||
from sanic.cookies.response import Cookie, SameSite
|
|
||||||
from sanic.exceptions import SanicException, ServerError
|
from sanic.exceptions import SanicException, ServerError
|
||||||
from sanic.helpers import (
|
from sanic.helpers import (
|
||||||
Default,
|
Default,
|
||||||
@@ -38,9 +36,7 @@ else:
|
|||||||
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from ujson import dumps as ujson_dumps
|
from ujson import dumps as json_dumps
|
||||||
|
|
||||||
json_dumps = partial(ujson_dumps, escape_forward_slashes=False)
|
|
||||||
except ImportError:
|
except ImportError:
|
||||||
# This is done in order to ensure that the JSON response is
|
# This is done in order to ensure that the JSON response is
|
||||||
# kept consistent across both ujson and inbuilt json usage.
|
# kept consistent across both ujson and inbuilt json usage.
|
||||||
@@ -162,117 +158,6 @@ class BaseHTTPResponse:
|
|||||||
end_stream=end_stream or False,
|
end_stream=end_stream or False,
|
||||||
)
|
)
|
||||||
|
|
||||||
def add_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
value: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
secure: bool = True,
|
|
||||||
max_age: Optional[int] = None,
|
|
||||||
expires: Optional[datetime] = None,
|
|
||||||
httponly: bool = False,
|
|
||||||
samesite: Optional[SameSite] = "Lax",
|
|
||||||
partitioned: bool = False,
|
|
||||||
comment: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> Cookie:
|
|
||||||
"""
|
|
||||||
Add a cookie to the CookieJar
|
|
||||||
|
|
||||||
:param key: Key of the cookie
|
|
||||||
:type key: str
|
|
||||||
:param value: Value of the cookie
|
|
||||||
:type value: str
|
|
||||||
:param path: Path of the cookie, defaults to None
|
|
||||||
:type path: Optional[str], optional
|
|
||||||
:param domain: Domain of the cookie, defaults to None
|
|
||||||
:type domain: Optional[str], optional
|
|
||||||
:param secure: Whether to set it as a secure cookie, defaults to True
|
|
||||||
:type secure: bool
|
|
||||||
:param max_age: Max age of the cookie in seconds; if set to 0 a
|
|
||||||
browser should delete it, defaults to None
|
|
||||||
:type max_age: Optional[int], optional
|
|
||||||
:param expires: When the cookie expires; if set to None browsers
|
|
||||||
should set it as a session cookie, defaults to None
|
|
||||||
:type expires: Optional[datetime], optional
|
|
||||||
:param httponly: Whether to set it as HTTP only, defaults to False
|
|
||||||
:type httponly: bool
|
|
||||||
:param samesite: How to set the samesite property, should be
|
|
||||||
strict, lax or none (case insensitive), defaults to Lax
|
|
||||||
:type samesite: Optional[SameSite], optional
|
|
||||||
:param partitioned: Whether to set it as partitioned, defaults to False
|
|
||||||
:type partitioned: bool
|
|
||||||
:param comment: A cookie comment, defaults to None
|
|
||||||
:type comment: Optional[str], optional
|
|
||||||
:param host_prefix: Whether to add __Host- as a prefix to the key.
|
|
||||||
This requires that path="/", domain=None, and secure=True,
|
|
||||||
defaults to False
|
|
||||||
:type host_prefix: bool
|
|
||||||
:param secure_prefix: Whether to add __Secure- as a prefix to the key.
|
|
||||||
This requires that secure=True, defaults to False
|
|
||||||
:type secure_prefix: bool
|
|
||||||
:return: The instance of the created cookie
|
|
||||||
:rtype: Cookie
|
|
||||||
"""
|
|
||||||
return self.cookies.add_cookie(
|
|
||||||
key=key,
|
|
||||||
value=value,
|
|
||||||
path=path,
|
|
||||||
domain=domain,
|
|
||||||
secure=secure,
|
|
||||||
max_age=max_age,
|
|
||||||
expires=expires,
|
|
||||||
httponly=httponly,
|
|
||||||
samesite=samesite,
|
|
||||||
partitioned=partitioned,
|
|
||||||
comment=comment,
|
|
||||||
host_prefix=host_prefix,
|
|
||||||
secure_prefix=secure_prefix,
|
|
||||||
)
|
|
||||||
|
|
||||||
def delete_cookie(
|
|
||||||
self,
|
|
||||||
key: str,
|
|
||||||
*,
|
|
||||||
path: str = "/",
|
|
||||||
domain: Optional[str] = None,
|
|
||||||
host_prefix: bool = False,
|
|
||||||
secure_prefix: bool = False,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
Delete a cookie
|
|
||||||
|
|
||||||
This will effectively set it as Max-Age: 0, which a browser should
|
|
||||||
interpret it to mean: "delete the cookie".
|
|
||||||
|
|
||||||
Since it is a browser/client implementation, your results may vary
|
|
||||||
depending upon which client is being used.
|
|
||||||
|
|
||||||
:param key: The key to be deleted
|
|
||||||
:type key: str
|
|
||||||
:param path: Path of the cookie, defaults to None
|
|
||||||
:type path: Optional[str], optional
|
|
||||||
:param domain: Domain of the cookie, defaults to None
|
|
||||||
:type domain: Optional[str], optional
|
|
||||||
:param host_prefix: Whether to add __Host- as a prefix to the key.
|
|
||||||
This requires that path="/", domain=None, and secure=True,
|
|
||||||
defaults to False
|
|
||||||
:type host_prefix: bool
|
|
||||||
:param secure_prefix: Whether to add __Secure- as a prefix to the key.
|
|
||||||
This requires that secure=True, defaults to False
|
|
||||||
:type secure_prefix: bool
|
|
||||||
"""
|
|
||||||
self.cookies.delete_cookie(
|
|
||||||
key=key,
|
|
||||||
path=path,
|
|
||||||
domain=domain,
|
|
||||||
host_prefix=host_prefix,
|
|
||||||
secure_prefix=secure_prefix,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class HTTPResponse(BaseHTTPResponse):
|
class HTTPResponse(BaseHTTPResponse):
|
||||||
"""
|
"""
|
||||||
@@ -347,7 +232,7 @@ class JSONResponse(HTTPResponse):
|
|||||||
body: Optional[Any] = None,
|
body: Optional[Any] = None,
|
||||||
status: int = 200,
|
status: int = 200,
|
||||||
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
||||||
content_type: str = "application/json",
|
content_type: Optional[str] = None,
|
||||||
dumps: Optional[Callable[..., str]] = None,
|
dumps: Optional[Callable[..., str]] = None,
|
||||||
**kwargs: Any,
|
**kwargs: Any,
|
||||||
):
|
):
|
||||||
@@ -522,10 +407,6 @@ class ResponseStream:
|
|||||||
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
headers: Optional[Union[Header, Dict[str, str]]] = None,
|
||||||
content_type: Optional[str] = None,
|
content_type: Optional[str] = None,
|
||||||
):
|
):
|
||||||
if headers is None:
|
|
||||||
headers = Header()
|
|
||||||
elif not isinstance(headers, Header):
|
|
||||||
headers = Header(headers)
|
|
||||||
self.streaming_fn = streaming_fn
|
self.streaming_fn = streaming_fn
|
||||||
self.status = status
|
self.status = status
|
||||||
self.headers = headers or Header()
|
self.headers = headers or Header()
|
||||||
|
|||||||
@@ -39,15 +39,13 @@ class Router(BaseRouter):
|
|||||||
extra={"host": host} if host else None,
|
extra={"host": host} if host else None,
|
||||||
)
|
)
|
||||||
except RoutingNotFound as e:
|
except RoutingNotFound as e:
|
||||||
raise NotFound(f"Requested URL {e.path} not found") from None
|
raise NotFound("Requested URL {} not found".format(e.path))
|
||||||
except NoMethod as e:
|
except NoMethod as e:
|
||||||
raise MethodNotAllowed(
|
raise MethodNotAllowed(
|
||||||
f"Method {method} not allowed for URL {path}",
|
"Method {} not allowed for URL {}".format(method, path),
|
||||||
method=method,
|
method=method,
|
||||||
allowed_methods=tuple(e.allowed_methods)
|
allowed_methods=e.allowed_methods,
|
||||||
if e.allowed_methods
|
)
|
||||||
else None,
|
|
||||||
) from None
|
|
||||||
|
|
||||||
@lru_cache(maxsize=ROUTER_CACHE_SIZE)
|
@lru_cache(maxsize=ROUTER_CACHE_SIZE)
|
||||||
def get( # type: ignore
|
def get( # type: ignore
|
||||||
@@ -63,7 +61,6 @@ class Router(BaseRouter):
|
|||||||
correct response
|
correct response
|
||||||
:rtype: Tuple[ Route, RouteHandler, Dict[str, Any]]
|
:rtype: Tuple[ Route, RouteHandler, Dict[str, Any]]
|
||||||
"""
|
"""
|
||||||
__tracebackhide__ = True
|
|
||||||
return self._get(path, method, host)
|
return self._get(path, method, host)
|
||||||
|
|
||||||
def add( # type: ignore
|
def add( # type: ignore
|
||||||
@@ -75,12 +72,11 @@ class Router(BaseRouter):
|
|||||||
strict_slashes: bool = False,
|
strict_slashes: bool = False,
|
||||||
stream: bool = False,
|
stream: bool = False,
|
||||||
ignore_body: bool = False,
|
ignore_body: bool = False,
|
||||||
version: Optional[Union[str, float, int]] = None,
|
version: Union[str, float, int] = None,
|
||||||
name: Optional[str] = None,
|
name: Optional[str] = None,
|
||||||
unquote: bool = False,
|
unquote: bool = False,
|
||||||
static: bool = False,
|
static: bool = False,
|
||||||
version_prefix: str = "/v",
|
version_prefix: str = "/v",
|
||||||
overwrite: bool = False,
|
|
||||||
error_format: Optional[str] = None,
|
error_format: Optional[str] = None,
|
||||||
) -> Union[Route, List[Route]]:
|
) -> Union[Route, List[Route]]:
|
||||||
"""
|
"""
|
||||||
@@ -123,7 +119,6 @@ class Router(BaseRouter):
|
|||||||
name=name,
|
name=name,
|
||||||
strict=strict_slashes,
|
strict=strict_slashes,
|
||||||
unquote=unquote,
|
unquote=unquote,
|
||||||
overwrite=overwrite,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
if isinstance(host, str):
|
if isinstance(host, str):
|
||||||
@@ -137,16 +132,7 @@ class Router(BaseRouter):
|
|||||||
if host:
|
if host:
|
||||||
params.update({"requirements": {"host": host}})
|
params.update({"requirements": {"host": host}})
|
||||||
|
|
||||||
ident = name
|
|
||||||
if len(hosts) > 1:
|
|
||||||
ident = (
|
|
||||||
f"{name}_{host.replace('.', '_')}"
|
|
||||||
if name
|
|
||||||
else "__unnamed__"
|
|
||||||
)
|
|
||||||
|
|
||||||
route = super().add(**params) # type: ignore
|
route = super().add(**params) # type: ignore
|
||||||
route.extra.ident = ident
|
|
||||||
route.extra.ignore_body = ignore_body
|
route.extra.ignore_body = ignore_body
|
||||||
route.extra.stream = stream
|
route.extra.stream = stream
|
||||||
route.extra.hosts = hosts
|
route.extra.hosts = hosts
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ from sanic.models.server_types import ConnInfo, Signal
|
|||||||
from sanic.server.async_server import AsyncioServer
|
from sanic.server.async_server import AsyncioServer
|
||||||
from sanic.server.loop import try_use_uvloop
|
from sanic.server.loop import try_use_uvloop
|
||||||
from sanic.server.protocols.http_protocol import HttpProtocol
|
from sanic.server.protocols.http_protocol import HttpProtocol
|
||||||
from sanic.server.runners import serve
|
from sanic.server.runners import serve, serve_multiple, serve_single
|
||||||
|
|
||||||
|
|
||||||
__all__ = (
|
__all__ = (
|
||||||
@@ -11,5 +11,7 @@ __all__ = (
|
|||||||
"HttpProtocol",
|
"HttpProtocol",
|
||||||
"Signal",
|
"Signal",
|
||||||
"serve",
|
"serve",
|
||||||
|
"serve_multiple",
|
||||||
|
"serve_single",
|
||||||
"try_use_uvloop",
|
"try_use_uvloop",
|
||||||
)
|
)
|
||||||
|
|||||||
124
sanic/server/legacy.py
Normal file
124
sanic/server/legacy.py
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
import itertools
|
||||||
|
import os
|
||||||
|
import signal
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from time import sleep
|
||||||
|
|
||||||
|
|
||||||
|
def _iter_module_files():
|
||||||
|
"""This iterates over all relevant Python files.
|
||||||
|
It goes through all
|
||||||
|
loaded files from modules, all files in folders of already loaded modules
|
||||||
|
as well as all files reachable through a package.
|
||||||
|
"""
|
||||||
|
# The list call is necessary on Python 3 in case the module
|
||||||
|
# dictionary modifies during iteration.
|
||||||
|
for module in list(sys.modules.values()):
|
||||||
|
if module is None:
|
||||||
|
continue
|
||||||
|
filename = getattr(module, "__file__", None)
|
||||||
|
if filename:
|
||||||
|
old = None
|
||||||
|
while not os.path.isfile(filename):
|
||||||
|
old = filename
|
||||||
|
filename = os.path.dirname(filename)
|
||||||
|
if filename == old:
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
if filename[-4:] in (".pyc", ".pyo"):
|
||||||
|
filename = filename[:-1]
|
||||||
|
yield filename
|
||||||
|
|
||||||
|
|
||||||
|
def _get_args_for_reloading():
|
||||||
|
"""Returns the executable."""
|
||||||
|
main_module = sys.modules["__main__"]
|
||||||
|
mod_spec = getattr(main_module, "__spec__", None)
|
||||||
|
if sys.argv[0] in ("", "-c"):
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Autoreloader cannot work with argv[0]={sys.argv[0]!r}"
|
||||||
|
)
|
||||||
|
if mod_spec:
|
||||||
|
# Parent exe was launched as a module rather than a script
|
||||||
|
return [sys.executable, "-m", mod_spec.name] + sys.argv[1:]
|
||||||
|
return [sys.executable] + sys.argv
|
||||||
|
|
||||||
|
|
||||||
|
def restart_with_reloader(changed=None):
|
||||||
|
"""Create a new process and a subprocess in it with the same arguments as
|
||||||
|
this one.
|
||||||
|
"""
|
||||||
|
reloaded = ",".join(changed) if changed else ""
|
||||||
|
return subprocess.Popen( # nosec B603
|
||||||
|
_get_args_for_reloading(),
|
||||||
|
env={
|
||||||
|
**os.environ,
|
||||||
|
"SANIC_SERVER_RUNNING": "true",
|
||||||
|
"SANIC_RELOADER_PROCESS": "true",
|
||||||
|
"SANIC_RELOADED_FILES": reloaded,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _check_file(filename, mtimes):
|
||||||
|
need_reload = False
|
||||||
|
|
||||||
|
mtime = os.stat(filename).st_mtime
|
||||||
|
old_time = mtimes.get(filename)
|
||||||
|
if old_time is None:
|
||||||
|
mtimes[filename] = mtime
|
||||||
|
elif mtime > old_time:
|
||||||
|
mtimes[filename] = mtime
|
||||||
|
need_reload = True
|
||||||
|
|
||||||
|
return need_reload
|
||||||
|
|
||||||
|
|
||||||
|
def watchdog(sleep_interval, reload_dirs):
|
||||||
|
"""Watch project files, restart worker process if a change happened.
|
||||||
|
:param sleep_interval: interval in second.
|
||||||
|
:return: Nothing
|
||||||
|
"""
|
||||||
|
|
||||||
|
def interrupt_self(*args):
|
||||||
|
raise KeyboardInterrupt
|
||||||
|
|
||||||
|
mtimes = {}
|
||||||
|
signal.signal(signal.SIGTERM, interrupt_self)
|
||||||
|
if os.name == "nt":
|
||||||
|
signal.signal(signal.SIGBREAK, interrupt_self)
|
||||||
|
|
||||||
|
worker_process = restart_with_reloader()
|
||||||
|
|
||||||
|
try:
|
||||||
|
while True:
|
||||||
|
|
||||||
|
changed = set()
|
||||||
|
for filename in itertools.chain(
|
||||||
|
_iter_module_files(),
|
||||||
|
*(d.glob("**/*") for d in reload_dirs),
|
||||||
|
):
|
||||||
|
try:
|
||||||
|
if _check_file(filename, mtimes):
|
||||||
|
path = (
|
||||||
|
filename
|
||||||
|
if isinstance(filename, str)
|
||||||
|
else filename.resolve()
|
||||||
|
)
|
||||||
|
changed.add(str(path))
|
||||||
|
except OSError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
if changed:
|
||||||
|
worker_process.terminate()
|
||||||
|
worker_process.wait()
|
||||||
|
worker_process = restart_with_reloader(changed)
|
||||||
|
|
||||||
|
sleep(sleep_interval)
|
||||||
|
except KeyboardInterrupt:
|
||||||
|
pass
|
||||||
|
finally:
|
||||||
|
worker_process.terminate()
|
||||||
|
worker_process.wait()
|
||||||
@@ -1,11 +1,11 @@
|
|||||||
import asyncio
|
import asyncio
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
|
from distutils.util import strtobool
|
||||||
from os import getenv
|
from os import getenv
|
||||||
|
|
||||||
from sanic.compat import OS_IS_WINDOWS
|
from sanic.compat import OS_IS_WINDOWS
|
||||||
from sanic.log import error_logger
|
from sanic.log import error_logger
|
||||||
from sanic.utils import str_to_bool
|
|
||||||
|
|
||||||
|
|
||||||
def try_use_uvloop() -> None:
|
def try_use_uvloop() -> None:
|
||||||
@@ -35,7 +35,7 @@ def try_use_uvloop() -> None:
|
|||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
uvloop_install_removed = str_to_bool(getenv("SANIC_NO_UVLOOP", "no"))
|
uvloop_install_removed = strtobool(getenv("SANIC_NO_UVLOOP", "no"))
|
||||||
if uvloop_install_removed:
|
if uvloop_install_removed:
|
||||||
error_logger.info(
|
error_logger.info(
|
||||||
"You are requesting to run Sanic using uvloop, but the "
|
"You are requesting to run Sanic using uvloop, but the "
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user