Compare commits
	
		
			133 Commits
		
	
	
		
			pre-regist
			...
			monitor-re
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|   | f83553be9e | ||
|   | 0c3527b8b2 | ||
|   | 232bbce1e0 | ||
|   | f034a31d29 | ||
|   | 3536c0af27 | ||
|   | 0e7ee94574 | ||
|   | 4e4e2b036b | ||
|   | 92e7463721 | ||
|   | 7f682cea02 | ||
|   | ae1669cd8f | ||
|   | 8e720365c2 | ||
|   | 3c4c136090 | ||
|   | d4041161c7 | ||
|   | f32437bf13 | ||
|   | 0909e94527 | ||
|   | aef2673c38 | ||
|   | 4c14910d5b | ||
|   | beae35f921 | ||
|   | ad4e526c77 | ||
|   | 4422d0c34d | ||
|   | ad9183d21d | ||
|   | d70636ba2e | ||
|   | da23f85675 | ||
|   | 3f4663b9f8 | ||
|   | 65d7447cf6 | ||
|   | 5369291c27 | ||
|   | 1c4925edf7 | ||
|   | 6b9edfd05c | ||
|   | 97f33f42df | ||
|   | 15a588a90c | ||
|   | 82421e7efc | ||
|   | f891995b48 | ||
|   | 5052321801 | ||
|   | 23ce4eaaa4 | ||
|   | 23a430c4ad | ||
|   | ec158ffa69 | ||
|   | 6e32270036 | ||
|   | 43ba381e7b | ||
|   | 16503319e5 | ||
|   | 389363ab71 | ||
|   | 7f894c45b3 | ||
|   | 4726cf1910 | ||
|   | d352a4155e | ||
|   | e5010286b4 | ||
|   | 358498db96 | ||
|   | e4999401ab | ||
|   | c8df0aa2cb | ||
|   | 5fb207176b | ||
|   | a12b560478 | ||
|   | 753ee992a6 | ||
|   | 09089b1bd3 | ||
|   | 7ddbe5e844 | ||
|   | ab5a7038af | ||
|   | 4f3c780dc3 | ||
|   | 71f7765a4c | ||
|   | 0392d1dcfc | ||
|   | 7827b1b41d | ||
|   | 8e9342e188 | ||
|   | 2f6f2bfa76 | ||
|   | dee09d7fff | ||
|   | 9cf38a0a83 | ||
|   | 3def3d3569 | ||
|   | e100a14fd4 | ||
|   | 2fa28f1711 | ||
|   | 9d415e4ec6 | ||
|   | 312ab298fd | ||
|   | 2fc21ad576 | ||
|   | 8f6c87c3d6 | ||
|   | 4429e76532 | ||
|   | e4be70bae8 | ||
|   | 13d5a44278 | ||
|   | aba333bfb6 | ||
|   | b59da498cc | ||
|   | 70382f21ba | ||
|   | 0e1bf89fad | ||
|   | 6c48c8b3ba | ||
|   | d1c5e8003b | ||
|   | ce926a34f2 | ||
|   | a744041e38 | ||
|   | 2f90a85df1 | ||
|   | a411bc06e3 | ||
|   | 1668e1532f | ||
|   | b87982769f | ||
|   | 65b53a5f3f | ||
|   | 49789b7841 | ||
|   | c249004c30 | ||
|   | 4ee2e57ec8 | ||
|   | 86ae5f981c | ||
|   | 2bfa65e0de | ||
|   | 293278bb08 | ||
|   | 5d683c6ea4 | ||
|   | 78b6723149 | ||
|   | 3a6cc7389c | ||
|   | cc97287f8e | ||
|   | 00218aa9f2 | ||
|   | 874718db94 | ||
|   | bb4474897f | ||
|   | 0cb342aef4 | ||
|   | 030987480c | ||
|   | f6fdc80b40 | ||
|   | 361c242473 | ||
|   | 32962d1e1c | ||
|   | 6e0a6871b5 | ||
|   | 0030425c8c | ||
|   | c9dbc8ed26 | ||
|   | 44b108b564 | ||
|   | 2a8e91052f | ||
|   | 0c9df02e66 | ||
|   | 7523e87937 | ||
|   | d4fb44e986 | ||
|   | 68b654d981 | ||
|   | 88bc6d8966 | ||
|   | ac388d644b | ||
|   | bb517ddcca | ||
|   | b8d991420b | ||
|   | 4a416e177a | ||
|   | 8dfa49b648 | ||
|   | 8b0eaa097c | ||
|   | 101151b419 | ||
|   | 4669036f45 | ||
|   | 9bf9067c99 | ||
|   | a7bc8b56ba | ||
|   | 371985d129 | ||
|   | 3eae00898d | ||
|   | dc3ccba527 | ||
|   | b91ffed010 | ||
|   | 8c07e388cd | ||
|   | 98ce4bdeb2 | ||
|   | 4659069350 | ||
|   | 080d41627a | ||
|   | d799c5f03c | ||
|   | abe062b371 | ||
|   | b5a00ac1ca | 
| @@ -1,2 +0,0 @@ | ||||
| [tool.black] | ||||
| line-length = 79 | ||||
| @@ -1,28 +0,0 @@ | ||||
| exclude_patterns: | ||||
|   - "sanic/__main__.py" | ||||
|   - "sanic/application/logo.py" | ||||
|   - "sanic/application/motd.py" | ||||
|   - "sanic/reloader_helpers.py" | ||||
|   - "sanic/simple.py" | ||||
|   - "sanic/utils.py" | ||||
|   - ".github/" | ||||
|   - "changelogs/" | ||||
|   - "docker/" | ||||
|   - "docs/" | ||||
|   - "examples/" | ||||
|   - "scripts/" | ||||
|   - "tests/" | ||||
| checks: | ||||
|   argument-count: | ||||
|     enabled: false | ||||
|   file-lines: | ||||
|     config: | ||||
|       threshold: 1000 | ||||
|   method-count: | ||||
|     config: | ||||
|       threshold: 40 | ||||
|   complex-logic: | ||||
|     enabled: false | ||||
|   method-complexity: | ||||
|     config: | ||||
|       threshold: 10 | ||||
| @@ -3,13 +3,12 @@ branch = True | ||||
| source = sanic | ||||
| omit = | ||||
|     site-packages | ||||
|     sanic/application/logo.py | ||||
|     sanic/application/motd.py | ||||
|     sanic/cli | ||||
|     sanic/__main__.py | ||||
|     sanic/reloader_helpers.py | ||||
|     sanic/server/legacy.py | ||||
|     sanic/compat.py | ||||
|     sanic/simple.py | ||||
|     sanic/utils.py | ||||
|     sanic/cli | ||||
|  | ||||
| [html] | ||||
| directory = coverage | ||||
| @@ -21,3 +20,5 @@ exclude_lines = | ||||
|     noqa | ||||
|     NOQA | ||||
|     pragma: no cover | ||||
|     TYPE_CHECKING | ||||
| skip_empty = True | ||||
|   | ||||
							
								
								
									
										66
									
								
								.github/ISSUE_TEMPLATE/bug-report.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										66
									
								
								.github/ISSUE_TEMPLATE/bug-report.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,66 @@ | ||||
| name: 🐞 Bug report | ||||
| description: Create a report to help us improve | ||||
| labels: ["bug", "triage"] | ||||
| body: | ||||
|   - type: checkboxes | ||||
|     id: existing | ||||
|     attributes: | ||||
|       label: Is there an existing issue for this? | ||||
|       description: Please search to see if an issue already exists for the bug you encountered. | ||||
|       options: | ||||
|       - label: I have searched the existing issues | ||||
|         required: true | ||||
|   - type: textarea | ||||
|     id: description | ||||
|     attributes: | ||||
|       label: Describe the bug | ||||
|       description: A clear and concise description of what the bug is, make sure to paste any exceptions and tracebacks using markdown code-block syntax to make it easier to read. | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: textarea | ||||
|     id: code | ||||
|     attributes: | ||||
|       label: Code snippet | ||||
|       description: Relevant source code, make sure to remove what is not necessary. | ||||
|     validations: | ||||
|       required: false | ||||
|   - type: textarea | ||||
|     id: expected | ||||
|     attributes: | ||||
|       label: Expected Behavior | ||||
|       description: A concise description of what you expected to happen. | ||||
|     validations: | ||||
|       required: false | ||||
|   - type: dropdown | ||||
|     id: running | ||||
|     attributes: | ||||
|       label: How do you run Sanic? | ||||
|       options: | ||||
|         - Sanic CLI | ||||
|         - As a module | ||||
|         - As a script (`app.run` or `Sanic.serve`) | ||||
|         - ASGI | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: input | ||||
|     id: os | ||||
|     attributes: | ||||
|       label: Operating System | ||||
|       description: What OS? | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: input | ||||
|     id: version | ||||
|     attributes: | ||||
|       label: Sanic Version | ||||
|       description: Check startup logs or try `sanic --version` | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: textarea | ||||
|     id: additional | ||||
|     attributes: | ||||
|       label: Additional context | ||||
|       description: Add any other context about the problem here. | ||||
|     validations: | ||||
|       required: false | ||||
|  | ||||
							
								
								
									
										25
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										25
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,25 +0,0 @@ | ||||
| --- | ||||
| name: Bug report | ||||
| about: Create a report to help us improve | ||||
|  | ||||
| --- | ||||
|  | ||||
| **Describe the bug** | ||||
| A clear and concise description of what the bug is, make sure to paste any exceptions and tracebacks. | ||||
|  | ||||
|  | ||||
| **Code snippet** | ||||
| Relevant source code, make sure to remove what is not necessary. | ||||
|  | ||||
|  | ||||
| **Expected behavior** | ||||
| A clear and concise description of what you expected to happen. | ||||
|  | ||||
|  | ||||
| **Environment (please complete the following information):** | ||||
|  - OS: [e.g. iOS] | ||||
|  - Version [e.g. 0.8.3] | ||||
|  | ||||
|  | ||||
| **Additional context** | ||||
| Add any other context about the problem here. | ||||
							
								
								
									
										5
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,5 +1,8 @@ | ||||
| blank_issues_enabled: true | ||||
| blank_issues_enabled: false | ||||
| contact_links: | ||||
|   - name: Questions and Help | ||||
|     url: https://community.sanicframework.org/c/questions-and-help | ||||
|     about: Do you need help with Sanic? Ask your questions here. | ||||
|   - name: Discussion and Support | ||||
|     url: https://discord.gg/FARQzAEMAA | ||||
|     about: For live discussion and support, checkout the Sanic Discord server. | ||||
|   | ||||
							
								
								
									
										34
									
								
								.github/ISSUE_TEMPLATE/feature-request.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								.github/ISSUE_TEMPLATE/feature-request.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,34 @@ | ||||
| name: 🌟 Feature request | ||||
| description: Suggest an enhancement for Sanic | ||||
| labels: ["feature request"] | ||||
| body: | ||||
|   - type: checkboxes | ||||
|     id: existing | ||||
|     attributes: | ||||
|       label: Is there an existing issue for this? | ||||
|       description: Please search to see if an issue already exists for the enhancement you are proposing. | ||||
|       options: | ||||
|       - label: I have searched the existing issues | ||||
|         required: true | ||||
|   - type: textarea | ||||
|     id: description | ||||
|     attributes: | ||||
|       label: Is your feature request related to a problem? Please describe. | ||||
|       description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||||
|     validations: | ||||
|       required: false | ||||
|   - type: textarea | ||||
|     id: code | ||||
|     attributes: | ||||
|       label: Describe the solution you'd like | ||||
|       description: A clear and concise description of what you want to happen. | ||||
|     validations: | ||||
|       required: true | ||||
|   - type: textarea | ||||
|     id: additional | ||||
|     attributes: | ||||
|       label: Additional context | ||||
|       description: Add any other context about the problem here. | ||||
|     validations: | ||||
|       required: false | ||||
|  | ||||
							
								
								
									
										16
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										16
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,16 +0,0 @@ | ||||
| --- | ||||
| name: Feature request | ||||
| about: Suggest an idea for Sanic | ||||
|  | ||||
| --- | ||||
|  | ||||
| **Is your feature request related to a problem? Please describe.** | ||||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||||
|  | ||||
|  | ||||
| **Describe the solution you'd like** | ||||
| A clear and concise description of what you want to happen. | ||||
|  | ||||
|  | ||||
| **Additional context** | ||||
| Add any other context or sample code about the feature request here. | ||||
							
								
								
									
										8
									
								
								.github/workflows/codeql-analysis.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/workflows/codeql-analysis.yml
									
									
									
									
										vendored
									
									
								
							| @@ -2,9 +2,13 @@ name: "CodeQL" | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: [ main ] | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|   pull_request: | ||||
|     branches: [ main ] | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|   schedule: | ||||
|     - cron: '25 16 * * 0' | ||||
|   | ||||
							
								
								
									
										18
									
								
								.github/workflows/coverage.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										18
									
								
								.github/workflows/coverage.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,13 +3,15 @@ on: | ||||
|   push: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     tags: | ||||
|       - "!*" # Do not execute on tags | ||||
|   pull_request: | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
| jobs: | ||||
|   test: | ||||
|     if: github.event.pull_request.draft == false | ||||
|     runs-on: ${{ matrix.os }} | ||||
|     strategy: | ||||
|       matrix: | ||||
| @@ -19,7 +21,6 @@ jobs: | ||||
|  | ||||
|     steps: | ||||
|       - uses: actions/checkout@v2 | ||||
|  | ||||
|       - uses: actions/setup-python@v1 | ||||
|         with: | ||||
|           python-version: ${{ matrix.python-version }} | ||||
| @@ -28,9 +29,10 @@ jobs: | ||||
|         run: | | ||||
|           python -m pip install --upgrade pip | ||||
|           pip install tox | ||||
|       - uses: paambaati/codeclimate-action@v2.5.3 | ||||
|         if: always() | ||||
|         env: | ||||
|           CC_TEST_REPORTER_ID: ${{ secrets.CODECLIMATE }} | ||||
|       - name: Run coverage | ||||
|         run: tox -e coverage | ||||
|         continue-on-error: true | ||||
|       - uses: codecov/codecov-action@v2 | ||||
|         with: | ||||
|           coverageCommand: tox -e coverage | ||||
|           files: ./coverage.xml | ||||
|           fail_ci_if_error: false | ||||
|   | ||||
							
								
								
									
										1
									
								
								.github/workflows/pr-bandit.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/pr-bandit.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,7 @@ on: | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|  | ||||
| jobs: | ||||
|   | ||||
							
								
								
									
										1
									
								
								.github/workflows/pr-docs.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/pr-docs.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,7 @@ on: | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|  | ||||
| jobs: | ||||
|   | ||||
							
								
								
									
										1
									
								
								.github/workflows/pr-linter.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/pr-linter.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,7 @@ on: | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|  | ||||
| jobs: | ||||
|   | ||||
							
								
								
									
										1
									
								
								.github/workflows/pr-python310.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/pr-python310.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,7 @@ on: | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|  | ||||
| jobs: | ||||
|   | ||||
							
								
								
									
										1
									
								
								.github/workflows/pr-python37.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/pr-python37.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,7 @@ on: | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|  | ||||
| jobs: | ||||
|   | ||||
							
								
								
									
										1
									
								
								.github/workflows/pr-python38.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/pr-python38.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,7 @@ on: | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|  | ||||
| jobs: | ||||
|   | ||||
							
								
								
									
										1
									
								
								.github/workflows/pr-python39.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/pr-python39.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,7 @@ on: | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|  | ||||
| jobs: | ||||
|   | ||||
							
								
								
									
										3
									
								
								.github/workflows/pr-type-check.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.github/workflows/pr-type-check.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,7 @@ on: | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|  | ||||
| jobs: | ||||
| @@ -15,7 +16,7 @@ jobs: | ||||
|       matrix: | ||||
|         os: [ubuntu-latest] | ||||
|         config: | ||||
|           - { python-version: 3.7, tox-env: type-checking} | ||||
|           # - { python-version: 3.7, tox-env: type-checking} | ||||
|           - { python-version: 3.8, tox-env: type-checking} | ||||
|           - { python-version: 3.9, tox-env: type-checking} | ||||
|           - { python-version: "3.10", tox-env: type-checking} | ||||
|   | ||||
							
								
								
									
										1
									
								
								.github/workflows/pr-windows.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/workflows/pr-windows.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,7 @@ on: | ||||
|   pull_request: | ||||
|     branches: | ||||
|       - main | ||||
|       - "*LTS" | ||||
|     types: [opened, synchronize, reopened, ready_for_review] | ||||
|  | ||||
| jobs: | ||||
|   | ||||
							
								
								
									
										205
									
								
								CHANGELOG.rst
									
									
									
									
									
								
							
							
						
						
									
										205
									
								
								CHANGELOG.rst
									
									
									
									
									
								
							| @@ -1,12 +1,12 @@ | ||||
| .. note:: | ||||
|  | ||||
|   From v21.9, CHANGELOG files are maintained in ``./docs/sanic/releases`` | ||||
|   CHANGELOG files are maintained in ``./docs/sanic/releases``. To view the full CHANGELOG, please visit https://sanic.readthedocs.io/en/stable/sanic/changelog.html. | ||||
|  | ||||
|  | ||||
| Version 21.6.1 | ||||
| -------------- | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * `#2178 <https://github.com/sanic-org/sanic/pull/2178>`_ | ||||
|     Update sanic-routing to allow for better splitting of complex URI templates | ||||
| @@ -20,8 +20,7 @@ Bugfixes | ||||
| Version 21.6.0 | ||||
| -------------- | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
|   * `#2094 <https://github.com/sanic-org/sanic/pull/2094>`_ | ||||
|     Add ``response.eof()`` method for closing a stream in a handler | ||||
| @@ -68,8 +67,7 @@ Features | ||||
|   * `#2170 <https://github.com/sanic-org/sanic/pull/2170>`_ | ||||
|     Additional methods for attaching ``HTTPMethodView`` | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * `#2091 <https://github.com/sanic-org/sanic/pull/2091>`_ | ||||
|     Fix ``UserWarning`` in ASGI mode for missing ``__slots__`` | ||||
| @@ -85,8 +83,7 @@ Bugfixes | ||||
|     Fix issue where Blueprint exception handlers do not consistently route to proper handler | ||||
|  | ||||
|  | ||||
| Deprecations and Removals | ||||
| ************************* | ||||
| **Deprecations and Removals** | ||||
|  | ||||
|   * `#2156 <https://github.com/sanic-org/sanic/pull/2156>`_ | ||||
|     Remove config value ``REQUEST_BUFFER_QUEUE_SIZE`` | ||||
| @@ -95,14 +92,12 @@ Deprecations and Removals | ||||
|   * `#2172 <https://github.com/sanic-org/sanic/pull/2170>`_ | ||||
|     Deprecate StreamingHTTPResponse | ||||
|  | ||||
| Developer infrastructure | ||||
| ************************ | ||||
| **Developer infrastructure** | ||||
|  | ||||
|   * `#2149 <https://github.com/sanic-org/sanic/pull/2149>`_ | ||||
|     Remove Travis CI in favor of GitHub Actions | ||||
|  | ||||
| Improved Documentation | ||||
| ********************** | ||||
| **Improved Documentation** | ||||
|  | ||||
|   * `#2164 <https://github.com/sanic-org/sanic/pull/2164>`_ | ||||
|     Fix typo in documentation | ||||
| @@ -112,8 +107,7 @@ Improved Documentation | ||||
| Version 21.3.2 | ||||
| -------------- | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * `#2081 <https://github.com/sanic-org/sanic/pull/2081>`_ | ||||
|     Disable response timeout on websocket connections | ||||
| @@ -124,8 +118,7 @@ Bugfixes | ||||
| Version 21.3.1 | ||||
| -------------- | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * `#2076 <https://github.com/sanic-org/sanic/pull/2076>`_ | ||||
|     Static files inside subfolders are not accessible (404) | ||||
| @@ -135,8 +128,7 @@ Version 21.3.0 | ||||
|  | ||||
| `Release Notes <https://sanicframework.org/en/guide/release-notes/v21.3.html>`_ | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
|   * | ||||
|     `#1876 <https://github.com/sanic-org/sanic/pull/1876>`_ | ||||
| @@ -189,8 +181,7 @@ Features | ||||
|     `#2063 <https://github.com/sanic-org/sanic/pull/2063>`_ | ||||
|     App and connection level context objects | ||||
|  | ||||
| Bugfixes and issues resolved | ||||
| **************************** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * Resolve `#1420 <https://github.com/sanic-org/sanic/pull/1420>`_ | ||||
|     ``url_for`` where ``strict_slashes`` are on for a path ending in ``/`` | ||||
| @@ -220,8 +211,7 @@ Bugfixes and issues resolved | ||||
|     `#2001 <https://github.com/sanic-org/sanic/pull/2001>`_ | ||||
|     Raise ValueError when cookie max-age is not an integer | ||||
|  | ||||
| Deprecations and Removals | ||||
| ************************* | ||||
| **Deprecations and Removals** | ||||
|  | ||||
|   * | ||||
|     `#2007 <https://github.com/sanic-org/sanic/pull/2007>`_ | ||||
| @@ -240,8 +230,7 @@ Deprecations and Removals | ||||
|   * ``Request.endpoint`` deprecated in favor of ``Request.name`` | ||||
|   * handler type name prefixes removed (static, websocket, etc) | ||||
|  | ||||
| Developer infrastructure | ||||
| ************************ | ||||
| **Developer infrastructure** | ||||
|  | ||||
|   * | ||||
|     `#1995 <https://github.com/sanic-org/sanic/pull/1995>`_ | ||||
| @@ -259,8 +248,7 @@ Developer infrastructure | ||||
|     `#2049 <https://github.com/sanic-org/sanic/pull/2049>`_ | ||||
|     Updated setup.py to use ``find_packages`` | ||||
|  | ||||
| Improved Documentation | ||||
| ********************** | ||||
| **Improved Documentation** | ||||
|  | ||||
|   * | ||||
|     `#1218 <https://github.com/sanic-org/sanic/pull/1218>`_ | ||||
| @@ -282,8 +270,7 @@ Improved Documentation | ||||
|     `#2052 <https://github.com/sanic-org/sanic/pull/2052>`_ | ||||
|     Fix some examples and docs | ||||
|  | ||||
| Miscellaneous | ||||
| ************* | ||||
| **Miscellaneous** | ||||
|  | ||||
|   * ``Request.route`` property | ||||
|   * Better websocket subprotocols support | ||||
| @@ -326,11 +313,12 @@ Miscellaneous | ||||
|     `#2074 <https://github.com/sanic-org/sanic/pull/2074>`_ | ||||
|     Performance adjustments in ``handle_request_`` | ||||
|  | ||||
| Version 20.12.3 | ||||
| --------------- | ||||
| Version 20.12.3 🔷 | ||||
| ------------------ | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| `Current LTS version` | ||||
|  | ||||
| **Bugfixes** | ||||
|  | ||||
|   * | ||||
|     `#2021 <https://github.com/sanic-org/sanic/pull/2021>`_ | ||||
| @@ -339,8 +327,7 @@ Bugfixes | ||||
| Version 20.12.2 | ||||
| --------------- | ||||
|  | ||||
| Dependencies | ||||
| ************ | ||||
| **Dependencies** | ||||
|  | ||||
|   * | ||||
|     `#2026 <https://github.com/sanic-org/sanic/pull/2026>`_ | ||||
| @@ -353,8 +340,7 @@ Dependencies | ||||
| Version 19.12.5 | ||||
| --------------- | ||||
|  | ||||
| Dependencies | ||||
| ************ | ||||
| **Dependencies** | ||||
|  | ||||
|   * | ||||
|     `#2025 <https://github.com/sanic-org/sanic/pull/2025>`_ | ||||
| @@ -364,22 +350,15 @@ Dependencies | ||||
|     `#2027 <https://github.com/sanic-org/sanic/pull/2027>`_ | ||||
|     Remove old chardet requirement, add in hard multidict requirement | ||||
|  | ||||
| Version 20.12.0 | ||||
| --------------- | ||||
| Version 20.12.0 🔹 | ||||
| ----------------- | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
|   * | ||||
|     `#1993 <https://github.com/sanic-org/sanic/pull/1993>`_ | ||||
|     Add disable app registry | ||||
|  | ||||
| Version 20.12.0 | ||||
| --------------- | ||||
|  | ||||
| Features | ||||
| ******** | ||||
|  | ||||
|   * | ||||
|     `#1945 <https://github.com/sanic-org/sanic/pull/1945>`_ | ||||
|     Static route more verbose if file not found | ||||
| @@ -416,22 +395,19 @@ Features | ||||
|     `#1979 <https://github.com/sanic-org/sanic/pull/1979>`_ | ||||
|     Add app registry and Sanic class level app retrieval | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * | ||||
|     `#1965 <https://github.com/sanic-org/sanic/pull/1965>`_ | ||||
|     Fix Chunked Transport-Encoding in ASGI streaming response | ||||
|  | ||||
| Deprecations and Removals | ||||
| ************************* | ||||
| **Deprecations and Removals** | ||||
|  | ||||
|   * | ||||
|     `#1981 <https://github.com/sanic-org/sanic/pull/1981>`_ | ||||
|     Cleanup and remove deprecated code | ||||
|  | ||||
| Developer infrastructure | ||||
| ************************ | ||||
| **Developer infrastructure** | ||||
|  | ||||
|   * | ||||
|     `#1956 <https://github.com/sanic-org/sanic/pull/1956>`_ | ||||
| @@ -445,8 +421,7 @@ Developer infrastructure | ||||
|     `#1986 <https://github.com/sanic-org/sanic/pull/1986>`_ | ||||
|     Update tox requirements | ||||
|  | ||||
| Improved Documentation | ||||
| ********************** | ||||
| **Improved Documentation** | ||||
|  | ||||
|   * | ||||
|     `#1951 <https://github.com/sanic-org/sanic/pull/1951>`_ | ||||
| @@ -464,8 +439,7 @@ Improved Documentation | ||||
| Version 20.9.1 | ||||
| --------------- | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * | ||||
|     `#1954 <https://github.com/sanic-org/sanic/pull/1954>`_ | ||||
| @@ -478,8 +452,7 @@ Bugfixes | ||||
| Version 19.12.3 | ||||
| --------------- | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * | ||||
|     `#1959 <https://github.com/sanic-org/sanic/pull/1959>`_ | ||||
| @@ -490,8 +463,7 @@ Version 20.9.0 | ||||
| --------------- | ||||
|  | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
|   * | ||||
|     `#1887 <https://github.com/sanic-org/sanic/pull/1887>`_ | ||||
| @@ -518,22 +490,19 @@ Features | ||||
|     `#1937 <https://github.com/sanic-org/sanic/pull/1937>`_ | ||||
|     Added auto, text, and json fallback error handlers (in v21.3, the default will change form html to auto) | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * | ||||
|     `#1897 <https://github.com/sanic-org/sanic/pull/1897>`_ | ||||
|     Resolves exception from unread bytes in stream | ||||
|  | ||||
| Deprecations and Removals | ||||
| ************************* | ||||
| **Deprecations and Removals** | ||||
|  | ||||
|   * | ||||
|     `#1903 <https://github.com/sanic-org/sanic/pull/1903>`_ | ||||
|     config.from_envar, config.from_pyfile, and config.from_object are deprecated and set to be removed in v21.3 | ||||
|  | ||||
| Developer infrastructure | ||||
| ************************ | ||||
| **Developer infrastructure** | ||||
|  | ||||
|   * | ||||
|     `#1890 <https://github.com/sanic-org/sanic/pull/1890>`_, | ||||
| @@ -548,8 +517,7 @@ Developer infrastructure | ||||
|     `#1924 <https://github.com/sanic-org/sanic/pull/1924>`_ | ||||
|     Adding --strict-markers for pytest | ||||
|  | ||||
| Improved Documentation | ||||
| ********************** | ||||
| **Improved Documentation** | ||||
|  | ||||
|   * | ||||
|     `#1922 <https://github.com/sanic-org/sanic/pull/1922>`_ | ||||
| @@ -559,8 +527,7 @@ Improved Documentation | ||||
| Version 20.6.3 | ||||
| --------------- | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * | ||||
|     `#1884 <https://github.com/sanic-org/sanic/pull/1884>`_ | ||||
| @@ -570,8 +537,7 @@ Bugfixes | ||||
| Version 20.6.2 | ||||
| --------------- | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
|   * | ||||
|     `#1641 <https://github.com/sanic-org/sanic/pull/1641>`_ | ||||
| @@ -581,8 +547,7 @@ Features | ||||
| Version 20.6.1 | ||||
| --------------- | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
|   * | ||||
|     `#1760 <https://github.com/sanic-org/sanic/pull/1760>`_ | ||||
| @@ -596,8 +561,7 @@ Features | ||||
|     `#1880 <https://github.com/sanic-org/sanic/pull/1880>`_ | ||||
|     Add handler names for websockets for url_for usage | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * | ||||
|     `#1776 <https://github.com/sanic-org/sanic/pull/1776>`_ | ||||
| @@ -619,15 +583,13 @@ Bugfixes | ||||
|     `#1853 <https://github.com/sanic-org/sanic/pull/1853>`_ | ||||
|     Fix pickle error when attempting to pickle an application which contains websocket routes | ||||
|  | ||||
| Deprecations and Removals | ||||
| ************************* | ||||
| **Deprecations and Removals** | ||||
|  | ||||
|   * | ||||
|     `#1739 <https://github.com/sanic-org/sanic/pull/1739>`_ | ||||
|     Deprecate body_bytes to merge into body | ||||
|  | ||||
| Developer infrastructure | ||||
| ************************ | ||||
| **Developer infrastructure** | ||||
|  | ||||
|   * | ||||
|     `#1852 <https://github.com/sanic-org/sanic/pull/1852>`_ | ||||
| @@ -642,8 +604,7 @@ Developer infrastructure | ||||
|     Wrap run()'s "protocol" type annotation in Optional[] | ||||
|  | ||||
|  | ||||
| Improved Documentation | ||||
| ********************** | ||||
| **Improved Documentation** | ||||
|  | ||||
|   * | ||||
|     `#1846 <https://github.com/sanic-org/sanic/pull/1846>`_ | ||||
| @@ -663,8 +624,7 @@ Version 20.6.0 | ||||
| Version 20.3.0 | ||||
| --------------- | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
|   * | ||||
|     `#1762 <https://github.com/sanic-org/sanic/pull/1762>`_ | ||||
| @@ -695,8 +655,7 @@ Features | ||||
|     `#1820 <https://github.com/sanic-org/sanic/pull/1820>`_ | ||||
|     Do not set content-type and content-length headers in exceptions | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * | ||||
|     `#1748 <https://github.com/sanic-org/sanic/pull/1748>`_ | ||||
| @@ -714,8 +673,7 @@ Bugfixes | ||||
|     `#1808 <https://github.com/sanic-org/sanic/pull/1808>`_ | ||||
|      Fix Ctrl+C and tests on Windows | ||||
|  | ||||
| Deprecations and Removals | ||||
| ************************* | ||||
| **Deprecations and Removals** | ||||
|  | ||||
|   * | ||||
|     `#1800 <https://github.com/sanic-org/sanic/pull/1800>`_ | ||||
| @@ -733,8 +691,7 @@ Deprecations and Removals | ||||
|     `#1818 <https://github.com/sanic-org/sanic/pull/1818>`_ | ||||
|     Complete deprecation of ``app.remove_route`` and ``request.raw_args`` | ||||
|  | ||||
| Dependencies | ||||
| ************ | ||||
| **Dependencies** | ||||
|  | ||||
|   * | ||||
|     `#1794 <https://github.com/sanic-org/sanic/pull/1794>`_ | ||||
| @@ -744,15 +701,13 @@ Dependencies | ||||
|     `#1806 <https://github.com/sanic-org/sanic/pull/1806>`_ | ||||
|     Import ``ASGIDispatch`` from top-level ``httpx`` (from third-party deprecation) | ||||
|  | ||||
| Developer infrastructure | ||||
| ************************ | ||||
| **Developer infrastructure** | ||||
|  | ||||
|   * | ||||
|     `#1833 <https://github.com/sanic-org/sanic/pull/1833>`_ | ||||
|     Resolve broken documentation builds | ||||
|  | ||||
| Improved Documentation | ||||
| ********************** | ||||
| **Improved Documentation** | ||||
|  | ||||
|   * | ||||
|     `#1755 <https://github.com/sanic-org/sanic/pull/1755>`_ | ||||
| @@ -794,8 +749,7 @@ Improved Documentation | ||||
| Version 19.12.0 | ||||
| --------------- | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
| - Fix blueprint middleware application | ||||
|  | ||||
| @@ -814,8 +768,7 @@ Bugfixes | ||||
|   due to an `AttributeError`. This fix makes the availability of `SERVER_NAME` on our `app.config` an optional behavior. (`#1707 <https://github.com/sanic-org/sanic/issues/1707>`__) | ||||
|  | ||||
|  | ||||
| Improved Documentation | ||||
| ********************** | ||||
| **Improved Documentation** | ||||
|  | ||||
| - Move docs from MD to RST | ||||
|  | ||||
| @@ -829,8 +782,7 @@ Improved Documentation | ||||
| Version 19.6.3 | ||||
| -------------- | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
| - Enable Towncrier Support | ||||
|  | ||||
| @@ -838,8 +790,7 @@ Features | ||||
|   of generating and managing change logs as part of each of pull requests. (`#1631 <https://github.com/sanic-org/sanic/issues/1631>`__) | ||||
|  | ||||
|  | ||||
| Improved Documentation | ||||
| ********************** | ||||
| **Improved Documentation** | ||||
|  | ||||
| - Documentation infrastructure changes | ||||
|  | ||||
| @@ -852,8 +803,7 @@ Improved Documentation | ||||
| Version 19.6.2 | ||||
| -------------- | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
|   * | ||||
|     `#1562 <https://github.com/sanic-org/sanic/pull/1562>`_ | ||||
| @@ -869,8 +819,7 @@ Features | ||||
|     Add Configure support from object string | ||||
|  | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|   * | ||||
|     `#1587 <https://github.com/sanic-org/sanic/pull/1587>`_ | ||||
| @@ -888,8 +837,7 @@ Bugfixes | ||||
|     `#1594 <https://github.com/sanic-org/sanic/pull/1594>`_ | ||||
|     Strict Slashes behavior fix | ||||
|  | ||||
| Deprecations and Removals | ||||
| ************************* | ||||
| **Deprecations and Removals** | ||||
|  | ||||
|   * | ||||
|     `#1544 <https://github.com/sanic-org/sanic/pull/1544>`_ | ||||
| @@ -913,8 +861,7 @@ Deprecations and Removals | ||||
| Version 19.3 | ||||
| ------------ | ||||
|  | ||||
| Features | ||||
| ******** | ||||
| **Features** | ||||
|  | ||||
|   * | ||||
|     `#1497 <https://github.com/sanic-org/sanic/pull/1497>`_ | ||||
| @@ -982,8 +929,7 @@ Features | ||||
|  | ||||
|     This is a breaking change. | ||||
|  | ||||
| Bugfixes | ||||
| ******** | ||||
| **Bugfixes** | ||||
|  | ||||
|  | ||||
|   * | ||||
| @@ -1019,8 +965,7 @@ Bugfixes | ||||
|     This allows the access log to be disabled for example when running via | ||||
|     gunicorn. | ||||
|  | ||||
| Developer infrastructure | ||||
| ************************ | ||||
| **Developer infrastructure** | ||||
|  | ||||
|   * `#1529 <https://github.com/sanic-org/sanic/pull/1529>`_ Update project PyPI credentials | ||||
|   * `#1515 <https://github.com/sanic-org/sanic/pull/1515>`_ fix linter issue causing travis build failures (fix #1514) | ||||
| @@ -1028,8 +973,7 @@ Developer infrastructure | ||||
|   * `#1478 <https://github.com/sanic-org/sanic/pull/1478>`_ Upgrade setuptools version and use native docutils in doc build | ||||
|   * `#1464 <https://github.com/sanic-org/sanic/pull/1464>`_ Upgrade pytest, and fix caplog unit tests | ||||
|  | ||||
| Improved Documentation | ||||
| ********************** | ||||
| **Improved Documentation** | ||||
|  | ||||
|   * `#1516 <https://github.com/sanic-org/sanic/pull/1516>`_ Fix typo at the exception documentation | ||||
|   * `#1510 <https://github.com/sanic-org/sanic/pull/1510>`_ fix typo in Asyncio example | ||||
| @@ -1096,15 +1040,13 @@ Version 18.12 | ||||
| Version 0.8 | ||||
| ----------- | ||||
|  | ||||
| 0.8.3 | ||||
| ***** | ||||
| **0.8.3** | ||||
|  | ||||
| * Changes: | ||||
|  | ||||
|   * Ownership changed to org 'sanic-org' | ||||
|  | ||||
| 0.8.0 | ||||
| ***** | ||||
| **0.8.0** | ||||
|  | ||||
| * Changes: | ||||
|  | ||||
| @@ -1184,19 +1126,16 @@ Version 0.1 | ||||
| ----------- | ||||
|  | ||||
|  | ||||
| 0.1.7 | ||||
| ***** | ||||
| **0.1.7** | ||||
|  | ||||
|   * Reversed static url and directory arguments to meet spec | ||||
|  | ||||
| 0.1.6 | ||||
| ***** | ||||
| **0.1.6** | ||||
|  | ||||
|   * Static files | ||||
|   * Lazy Cookie Loading | ||||
|  | ||||
| 0.1.5 | ||||
| ***** | ||||
| **0.1.5** | ||||
|  | ||||
|   * Cookies | ||||
|   * Blueprint listeners and ordering | ||||
| @@ -1204,23 +1143,19 @@ Version 0.1 | ||||
|   * Fix: Incomplete file reads on medium+ sized post requests | ||||
|   * Breaking: after_start and before_stop now pass sanic as their first argument | ||||
|  | ||||
| 0.1.4 | ||||
| ***** | ||||
| **0.1.4** | ||||
|  | ||||
|   * Multiprocessing | ||||
|  | ||||
| 0.1.3 | ||||
| ***** | ||||
| **0.1.3** | ||||
|  | ||||
|   * Blueprint support | ||||
|   * Faster Response processing | ||||
|  | ||||
| 0.1.1 - 0.1.2 | ||||
| ************* | ||||
| **0.1.1 - 0.1.2** | ||||
|  | ||||
|   * Struggling to update pypi via CI | ||||
|  | ||||
| 0.1.0 | ||||
| ***** | ||||
| **0.1.0** | ||||
|  | ||||
|   * Released to public | ||||
|   | ||||
| @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. | ||||
| ## Enforcement | ||||
| 
 | ||||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||||
| reported by contacting the project team at sanic-maintainers@googlegroups.com. All | ||||
| reported by contacting the project team at adam@sanicframework.org. All | ||||
| complaints will be reviewed and investigated and will result in a response that | ||||
| is deemed necessary and appropriate to the circumstances. The project team is | ||||
| obligated to maintain confidentiality with regard to the reporter of an incident. | ||||
| @@ -71,9 +71,9 @@ To execute only unittests, run ``tox`` with environment like so: | ||||
|  | ||||
| .. code-block:: bash | ||||
|  | ||||
|    tox -e py36 -v -- tests/test_config.py | ||||
|    # or | ||||
|    tox -e py37 -v -- tests/test_config.py | ||||
|    # or | ||||
|    tox -e py310 -v -- tests/test_config.py | ||||
|  | ||||
| Run lint checks | ||||
| --------------- | ||||
| @@ -140,6 +140,7 @@ To maintain the code consistency, Sanic uses following tools. | ||||
| #. `isort <https://github.com/timothycrosley/isort>`_ | ||||
| #. `black <https://github.com/python/black>`_ | ||||
| #. `flake8 <https://github.com/PyCQA/flake8>`_ | ||||
| #. `slotscheck <https://github.com/ariebovenberg/slotscheck>`_ | ||||
|  | ||||
| isort | ||||
| ***** | ||||
| @@ -167,7 +168,13 @@ flake8 | ||||
| #. pycodestyle | ||||
| #. Ned Batchelder's McCabe script | ||||
|  | ||||
| ``isort``\ , ``black`` and ``flake8`` checks are performed during ``tox`` lint checks. | ||||
| slotscheck | ||||
| ********** | ||||
|  | ||||
| ``slotscheck`` ensures that there are no problems with ``__slots__`` | ||||
| (e.g. overlaps, or missing slots in base classes). | ||||
|  | ||||
| ``isort``\ , ``black``\ , ``flake8`` and ``slotscheck`` checks are performed during ``tox`` lint checks. | ||||
|  | ||||
| The **easiest** way to make your code conform is to run the following before committing. | ||||
|  | ||||
|   | ||||
							
								
								
									
										6
									
								
								Makefile
									
									
									
									
									
								
							
							
						
						
									
										6
									
								
								Makefile
									
									
									
									
									
								
							| @@ -66,15 +66,15 @@ ifdef include_tests | ||||
| 	isort -rc sanic tests | ||||
| else | ||||
| 	$(info Sorting Imports) | ||||
| 	isort -rc sanic tests  --profile=black | ||||
| 	isort -rc sanic tests | ||||
| endif | ||||
| endif | ||||
|  | ||||
| black: | ||||
| 	black --config ./.black.toml sanic tests | ||||
| 	black sanic tests | ||||
|  | ||||
| isort: | ||||
| 	isort sanic tests --profile=black | ||||
| 	isort sanic tests | ||||
|  | ||||
| pretty: black isort | ||||
|  | ||||
|   | ||||
							
								
								
									
										11
									
								
								README.rst
									
									
									
									
									
								
							
							
						
						
									
										11
									
								
								README.rst
									
									
									
									
									
								
							| @@ -11,7 +11,7 @@ Sanic | Build fast. Run fast. | ||||
|     :stub-columns: 1 | ||||
|  | ||||
|     * - Build | ||||
|       - | |Py39Test| |Py38Test| |Py37Test| | ||||
|       - | |Py310Test| |Py39Test| |Py38Test| |Py37Test| | ||||
|     * - Docs | ||||
|       - | |UserGuide| |Documentation| | ||||
|     * - Package | ||||
| @@ -27,6 +27,8 @@ Sanic | Build fast. Run fast. | ||||
|    :target: https://community.sanicframework.org/ | ||||
| .. |Discord| image:: https://img.shields.io/discord/812221182594121728?logo=discord | ||||
|    :target: https://discord.gg/FARQzAEMAA | ||||
| .. |Py310Test| image:: https://github.com/sanic-org/sanic/actions/workflows/pr-python310.yml/badge.svg?branch=main | ||||
|    :target: https://github.com/sanic-org/sanic/actions/workflows/pr-python310.yml | ||||
| .. |Py39Test| image:: https://github.com/sanic-org/sanic/actions/workflows/pr-python39.yml/badge.svg?branch=main | ||||
|    :target: https://github.com/sanic-org/sanic/actions/workflows/pr-python39.yml | ||||
| .. |Py38Test| image:: https://github.com/sanic-org/sanic/actions/workflows/pr-python38.yml/badge.svg?branch=main | ||||
| @@ -64,7 +66,7 @@ Sanic | Build fast. Run fast. | ||||
|  | ||||
| Sanic is a **Python 3.7+** web server and web framework that's written to go fast. It allows the usage of the ``async/await`` syntax added in Python 3.5, which makes your code non-blocking and speedy. | ||||
|  | ||||
| Sanic is also ASGI compliant, so you can deploy it with an `alternative ASGI webserver <https://sanic.readthedocs.io/en/latest/sanic/deploying.html#running-via-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>`_. | ||||
|  | ||||
| `Source code on GitHub <https://github.com/sanic-org/sanic/>`_ | `Help and discussion board <https://community.sanicframework.org/>`_ | `User Guide <https://sanicframework.org>`_ | `Chat on Discord <https://discord.gg/FARQzAEMAA>`_ | ||||
|  | ||||
| @@ -100,9 +102,6 @@ Installation | ||||
|   If you are running on a clean install of Fedora 28 or above, please make sure you have the ``redhat-rpm-config`` package installed in case if you want to | ||||
|   use ``sanic`` with ``ujson`` dependency. | ||||
|  | ||||
| .. note:: | ||||
|  | ||||
|   Windows support is currently "experimental" and on a best-effort basis. Multiple workers are also not currently supported on Windows (see `Issue #1517 <https://github.com/sanic-org/sanic/issues/1517>`_), but setting ``workers=1`` should launch the server successfully. | ||||
|  | ||||
| Hello World Example | ||||
| ------------------- | ||||
| @@ -112,7 +111,7 @@ Hello World Example | ||||
|     from sanic import Sanic | ||||
|     from sanic.response import json | ||||
|  | ||||
|     app = Sanic("My Hello, world app") | ||||
|     app = Sanic("my-hello-world-app") | ||||
|  | ||||
|     @app.route('/') | ||||
|     async def test(request): | ||||
|   | ||||
							
								
								
									
										20
									
								
								SECURITY.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								SECURITY.md
									
									
									
									
									
								
							| @@ -4,13 +4,21 @@ | ||||
|  | ||||
| Sanic releases long term support release once a year in December. LTS releases receive bug and security updates for **24 months**. Interim releases throughout the year occur every three months, and are supported until the subsequent interim release. | ||||
|  | ||||
|  | ||||
| | Version | LTS           | Supported               | | ||||
| | ------- | ------------- | ------------------ | | ||||
| | 20.12   | until 2022-12 | :heavy_check_mark: | | ||||
| | ------- | ------------- | ----------------------- | | ||||
| | 22.9    |               | :white_check_mark:      | | ||||
| | 22.6    |               | :x:                     | | ||||
| | 22.3    |               | :x:                     | | ||||
| | 21.12   | until 2023-12 | :white_check_mark:      | | ||||
| | 21.9    |               | :x:                     | | ||||
| | 21.6    |               | :x:                     | | ||||
| | 21.3    |               | :x:                     | | ||||
| | 20.12   | until 2022-12 | :ballot_box_with_check: | | ||||
| | 20.9    |               | :x:                     | | ||||
| | 20.6    |               | :x:                     | | ||||
| | 20.3    |               | :x:                     | | ||||
| | 19.12   | until 2021-12 | :white_check_mark: | | ||||
| | 19.12   |               | :x:                     | | ||||
| | 19.9    |               | :x:                     | | ||||
| | 19.6    |               | :x:                     | | ||||
| | 19.3    |               | :x:                     | | ||||
| @@ -24,11 +32,13 @@ Sanic releases long term support release once a year in December. LTS releases r | ||||
| | 0.2.0   |               | :x:                     | | ||||
| | 0.1.9   |               | :x:                     | | ||||
|  | ||||
| :white_check_mark: = security/bug fixes | ||||
| :heavy_check_mark: = full support | ||||
| :ballot_box_with_check: = security/bug fixes  | ||||
| :white_check_mark: = full support | ||||
|  | ||||
| ## Reporting a Vulnerability | ||||
|  | ||||
| If you discover a security vulnerability, we ask that you **do not** create an issue on GitHub. Instead, please [send a message to the core-devs](https://community.sanicframework.org/g/core-devs) on the community forums. Once logged in, you can send a message to the core-devs by clicking the message button. | ||||
|  | ||||
| Alternatively, you can send a private message to Adam Hopkins on Discord. Find him on the [Sanic discord server](https://discord.gg/FARQzAEMAA). | ||||
|  | ||||
| This will help to not publicize the issue until the team can address it and resolve it. | ||||
|   | ||||
							
								
								
									
										27
									
								
								codecov.yml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								codecov.yml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,27 @@ | ||||
| coverage: | ||||
|   status: | ||||
|     patch: | ||||
|       default: | ||||
|         target: auto | ||||
|         threshold: 0.75 | ||||
|         informational: true | ||||
|     project: | ||||
|       default: | ||||
|         target: auto | ||||
|         threshold: 0.5 | ||||
|   precision: 3 | ||||
| codecov: | ||||
|   require_ci_to_pass: false | ||||
| ignore: | ||||
|   - "sanic/__main__.py" | ||||
|   - "sanic/compat.py" | ||||
|   - "sanic/simple.py" | ||||
|   - "sanic/utils.py" | ||||
|   - "sanic/cli" | ||||
|   - ".github/" | ||||
|   - "changelogs/" | ||||
|   - "docker/" | ||||
|   - "docs/" | ||||
|   - "examples/" | ||||
|   - "scripts/" | ||||
|   - "tests/" | ||||
							
								
								
									
										9
									
								
								docs/_static/custom.css
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										9
									
								
								docs/_static/custom.css
									
									
									
									
										vendored
									
									
								
							| @@ -2,3 +2,12 @@ | ||||
| .wy-nav-top { | ||||
|   background: #444444; | ||||
| } | ||||
|  | ||||
| #changelog section { | ||||
|   padding-left: 3rem; | ||||
| } | ||||
|  | ||||
| #changelog section h2, | ||||
| #changelog section h3 { | ||||
|   margin-left: -3rem; | ||||
| } | ||||
|   | ||||
| @@ -24,7 +24,11 @@ import sanic | ||||
|  | ||||
| # -- General configuration ------------------------------------------------ | ||||
|  | ||||
| extensions = ["sphinx.ext.autodoc", "m2r2"] | ||||
| extensions = [ | ||||
|     "sphinx.ext.autodoc", | ||||
|     "m2r2", | ||||
|     "enum_tools.autoenum", | ||||
| ] | ||||
|  | ||||
| templates_path = ["_templates"] | ||||
|  | ||||
|   | ||||
| @@ -9,7 +9,7 @@ API | ||||
| === | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|    :maxdepth: 3 | ||||
|  | ||||
|    👥 User Guide <https://sanicframework.org/guide/> | ||||
|    sanic/api_reference | ||||
|   | ||||
| @@ -15,3 +15,19 @@ sanic.config | ||||
| .. automodule:: sanic.config | ||||
|     :members: | ||||
|     :show-inheritance: | ||||
|  | ||||
| sanic.application.constants | ||||
| --------------------------- | ||||
|  | ||||
| .. automodule:: sanic.application.constants | ||||
|     :exclude-members: StrEnum | ||||
|     :members: | ||||
|     :show-inheritance: | ||||
|     :inherited-members: | ||||
|  | ||||
| sanic.application.state | ||||
| ----------------------- | ||||
|  | ||||
| .. automodule:: sanic.application.state | ||||
|     :members: | ||||
|     :show-inheritance: | ||||
|   | ||||
| @@ -17,6 +17,14 @@ sanic.handlers | ||||
|     :show-inheritance: | ||||
|  | ||||
|  | ||||
| sanic.headers | ||||
| -------------- | ||||
|  | ||||
| .. automodule:: sanic.headers | ||||
|     :members: | ||||
|     :show-inheritance: | ||||
|  | ||||
|  | ||||
| sanic.request | ||||
| ------------- | ||||
|  | ||||
| @@ -38,10 +46,3 @@ sanic.views | ||||
| .. automodule:: sanic.views | ||||
|     :members: | ||||
|     :show-inheritance: | ||||
|  | ||||
| sanic.websocket | ||||
| --------------- | ||||
|  | ||||
| .. automodule:: sanic.websocket | ||||
|     :members: | ||||
|     :show-inheritance: | ||||
|   | ||||
| @@ -16,10 +16,3 @@ sanic.server | ||||
|     :members: | ||||
|     :show-inheritance: | ||||
|  | ||||
|  | ||||
| sanic.worker | ||||
| ------------ | ||||
|  | ||||
| .. automodule:: sanic.worker | ||||
|     :members: | ||||
|     :show-inheritance: | ||||
|   | ||||
| @@ -1,6 +1,9 @@ | ||||
| 📜 Changelog | ||||
| ============ | ||||
|  | ||||
| .. mdinclude:: ./releases/21.9.md | ||||
|  | ||||
| .. mdinclude:: ./releases/22/22.9.md | ||||
| .. mdinclude:: ./releases/22/22.6.md | ||||
| .. mdinclude:: ./releases/22/22.3.md | ||||
| .. mdinclude:: ./releases/21/21.12.md | ||||
| .. mdinclude:: ./releases/21/21.9.md | ||||
| .. include:: ../../CHANGELOG.rst | ||||
|   | ||||
							
								
								
									
										66
									
								
								docs/sanic/releases/21/21.12.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										66
									
								
								docs/sanic/releases/21/21.12.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,66 @@ | ||||
| ## Version 21.12.1 🔷 | ||||
|  | ||||
| _Current LTS version_ | ||||
|  | ||||
| - [#2349](https://github.com/sanic-org/sanic/pull/2349) Only display MOTD on startup | ||||
| - [#2354](https://github.com/sanic-org/sanic/pull/2354) Ignore name argument in Python 3.7 | ||||
| - [#2355](https://github.com/sanic-org/sanic/pull/2355) Add config.update support for all config values | ||||
|  | ||||
| ## Version 21.12.0 🔹 | ||||
|  | ||||
| ### Features | ||||
| - [#2260](https://github.com/sanic-org/sanic/pull/2260) Allow early Blueprint registrations to still apply later added objects | ||||
| - [#2262](https://github.com/sanic-org/sanic/pull/2262) Noisy exceptions - force logging of all exceptions | ||||
| - [#2264](https://github.com/sanic-org/sanic/pull/2264) Optional `uvloop` by configuration | ||||
| - [#2270](https://github.com/sanic-org/sanic/pull/2270) Vhost support using multiple TLS certificates | ||||
| - [#2277](https://github.com/sanic-org/sanic/pull/2277) Change signal routing for increased consistency | ||||
|     - *BREAKING CHANGE*: If you were manually routing signals there is a breaking change. The signal router's `get` is no longer 100% determinative. There is now an additional step to loop thru the returned signals for proper matching on the requirements. If signals are being dispatched using `app.dispatch` or `bp.dispatch`, there is no change. | ||||
| - [#2290](https://github.com/sanic-org/sanic/pull/2290) Add contextual exceptions | ||||
| - [#2291](https://github.com/sanic-org/sanic/pull/2291) Increase join concat performance  | ||||
| - [#2295](https://github.com/sanic-org/sanic/pull/2295), [#2316](https://github.com/sanic-org/sanic/pull/2316), [#2331](https://github.com/sanic-org/sanic/pull/2331) Restructure of CLI and application state with new displays and more command parity with `app.run` | ||||
| - [#2302](https://github.com/sanic-org/sanic/pull/2302) Add route context at definition time | ||||
| - [#2304](https://github.com/sanic-org/sanic/pull/2304) Named tasks and new API for managing background tasks | ||||
| - [#2307](https://github.com/sanic-org/sanic/pull/2307) On app auto-reload, provide insight of changed files | ||||
| - [#2308](https://github.com/sanic-org/sanic/pull/2308) Auto extend application with [Sanic Extensions](https://sanicframework.org/en/plugins/sanic-ext/getting-started.html) if it is installed, and provide first class support for accessing the extensions | ||||
| - [#2309](https://github.com/sanic-org/sanic/pull/2309) Builtin signals changed to `Enum` | ||||
| - [#2313](https://github.com/sanic-org/sanic/pull/2313) Support additional config implementation use case | ||||
| - [#2321](https://github.com/sanic-org/sanic/pull/2321) Refactor environment variable hydration logic | ||||
| - [#2327](https://github.com/sanic-org/sanic/pull/2327) Prevent sending multiple or mixed responses on a single request | ||||
| - [#2330](https://github.com/sanic-org/sanic/pull/2330) Custom type casting on environment variables | ||||
| - [#2332](https://github.com/sanic-org/sanic/pull/2332) Make all deprecation notices consistent | ||||
| - [#2335](https://github.com/sanic-org/sanic/pull/2335) Allow underscore to start instance names | ||||
|  | ||||
| ### Bugfixes | ||||
| - [#2273](https://github.com/sanic-org/sanic/pull/2273) Replace assignation by typing for `websocket_handshake` | ||||
| - [#2285](https://github.com/sanic-org/sanic/pull/2285) Fix IPv6 display in startup logs | ||||
| - [#2299](https://github.com/sanic-org/sanic/pull/2299) Dispatch `http.lifecyle.response` from exception handler | ||||
|  | ||||
| ### Deprecations and Removals | ||||
| - [#2306](https://github.com/sanic-org/sanic/pull/2306) Removal of deprecated items | ||||
|     - `Sanic` and `Blueprint` may no longer have arbitrary properties attached to them | ||||
|     - `Sanic` and `Blueprint` forced to have compliant names | ||||
|         - alphanumeric + `_` + `-` | ||||
|         - must start with letter or `_` | ||||
|     - `load_env` keyword argument of `Sanic` | ||||
|     - `sanic.exceptions.abort` | ||||
|     - `sanic.views.CompositionView` | ||||
|     - `sanic.response.StreamingHTTPResponse` | ||||
|         - *NOTE:* the `stream()` response method (where you pass a callable streaming function) has been deprecated and will be removed in v22.6. You should upgrade all streaming responses to the new style: https://sanicframework.org/en/guide/advanced/streaming.html#response-streaming | ||||
| - [#2320](https://github.com/sanic-org/sanic/pull/2320) Remove app instance from Config for error handler setting | ||||
|  | ||||
| ### Developer infrastructure | ||||
| - [#2251](https://github.com/sanic-org/sanic/pull/2251) Change dev install command | ||||
| - [#2286](https://github.com/sanic-org/sanic/pull/2286) Change codeclimate complexity threshold from 5 to 10 | ||||
| - [#2287](https://github.com/sanic-org/sanic/pull/2287) Update host test function names so they are not overwritten | ||||
| - [#2292](https://github.com/sanic-org/sanic/pull/2292) Fail CI on error | ||||
| - [#2311](https://github.com/sanic-org/sanic/pull/2311), [#2324](https://github.com/sanic-org/sanic/pull/2324) Do not run tests for draft PRs | ||||
| - [#2336](https://github.com/sanic-org/sanic/pull/2336) Remove paths from coverage checks | ||||
| - [#2338](https://github.com/sanic-org/sanic/pull/2338) Cleanup ports on tests | ||||
|  | ||||
| ### Improved Documentation | ||||
| - [#2269](https://github.com/sanic-org/sanic/pull/2269), [#2329](https://github.com/sanic-org/sanic/pull/2329), [#2333](https://github.com/sanic-org/sanic/pull/2333) Cleanup typos and fix language | ||||
|  | ||||
| ### Miscellaneous | ||||
| - [#2257](https://github.com/sanic-org/sanic/pull/2257), [#2294](https://github.com/sanic-org/sanic/pull/2294), [#2341](https://github.com/sanic-org/sanic/pull/2341) Add Python 3.10 support | ||||
| - [#2279](https://github.com/sanic-org/sanic/pull/2279), [#2317](https://github.com/sanic-org/sanic/pull/2317), [#2322](https://github.com/sanic-org/sanic/pull/2322) Add/correct missing type annotations | ||||
| - [#2305](https://github.com/sanic-org/sanic/pull/2305) Fix examples to use modern implementations | ||||
| @@ -1,4 +1,14 @@ | ||||
| ## Version 21.9 | ||||
| ## Version 21.9.3 | ||||
| *Rerelease of v21.9.2 with some cleanup* | ||||
| 
 | ||||
| ## Version 21.9.2 | ||||
| - [#2268](https://github.com/sanic-org/sanic/pull/2268) Make HTTP connections start in IDLE stage, avoiding delays and error messages | ||||
| - [#2310](https://github.com/sanic-org/sanic/pull/2310) More consistent config setting with post-FALLBACK_ERROR_FORMAT apply | ||||
| 
 | ||||
| ## Version 21.9.1 | ||||
| - [#2259](https://github.com/sanic-org/sanic/pull/2259) Allow non-conforming ErrorHandlers | ||||
| 
 | ||||
| ## Version 21.9.0 | ||||
| 
 | ||||
| ### Features | ||||
| - [#2158](https://github.com/sanic-org/sanic/pull/2158), [#2248](https://github.com/sanic-org/sanic/pull/2248) Complete overhaul of I/O to websockets | ||||
							
								
								
									
										52
									
								
								docs/sanic/releases/22/22.3.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										52
									
								
								docs/sanic/releases/22/22.3.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,52 @@ | ||||
| ## Version 22.3.0 | ||||
|  | ||||
| ### Features | ||||
| - [#2347](https://github.com/sanic-org/sanic/pull/2347) API for multi-application server | ||||
|     - 🚨 *BREAKING CHANGE*: The old `sanic.worker.GunicornWorker` has been **removed**. To run Sanic with `gunicorn`, you should use it thru `uvicorn` [as described in their docs](https://www.uvicorn.org/#running-with-gunicorn). | ||||
|     - 🧁 *SIDE EFFECT*: Named background tasks are now supported, even in Python 3.7 | ||||
| - [#2357](https://github.com/sanic-org/sanic/pull/2357) Parse `Authorization` header as `Request.credentials` | ||||
| - [#2361](https://github.com/sanic-org/sanic/pull/2361) Add config option to skip `Touchup` step in application startup | ||||
| - [#2372](https://github.com/sanic-org/sanic/pull/2372) Updates to CLI help messaging | ||||
| - [#2382](https://github.com/sanic-org/sanic/pull/2382) Downgrade warnings to backwater debug messages  | ||||
| - [#2396](https://github.com/sanic-org/sanic/pull/2396) Allow for `multidict` v0.6 | ||||
| - [#2401](https://github.com/sanic-org/sanic/pull/2401) Upgrade CLI catching for alternative application run types | ||||
| - [#2402](https://github.com/sanic-org/sanic/pull/2402) Conditionally inject CLI arguments into factory | ||||
| - [#2413](https://github.com/sanic-org/sanic/pull/2413) Add new start and stop event listeners to reloader process | ||||
| - [#2414](https://github.com/sanic-org/sanic/pull/2414) Remove loop as required listener arg | ||||
| - [#2415](https://github.com/sanic-org/sanic/pull/2415) Better exception for bad URL parsing | ||||
| - [sanic-routing#47](https://github.com/sanic-org/sanic-routing/pull/47) Add a new extention parameter type: `<file:ext>`, `<file:ext=jpg>`, `<file:ext=jpg|png|gif|svg>`, `<file=int:ext>`, `<file=int:ext=jpg|png|gif|svg>`, `<file=float:ext=tar.gz>` | ||||
|     - 👶 *BETA FEATURE*: This feature will not work with `path` type matching, and is being released as a beta feature only. | ||||
| - [sanic-routing#57](https://github.com/sanic-org/sanic-routing/pull/57) Change `register_pattern` to accept a `str` or `Pattern` | ||||
| - [sanic-routing#58](https://github.com/sanic-org/sanic-routing/pull/58) Default matching on non-empty strings only, and new `strorempty` pattern type | ||||
|     - 🚨 *BREAKING CHANGE*: Previously a route with a dynamic string parameter (`/<foo>` or `/<foo:str>`) would match on any string, including empty strings. It will now **only** match a non-empty string. To retain the old behavior, you should use the new parameter type: `/<foo:strorempty>`. | ||||
|  | ||||
| ### Bugfixes | ||||
| - [#2373](https://github.com/sanic-org/sanic/pull/2373) Remove `error_logger` on websockets | ||||
| - [#2381](https://github.com/sanic-org/sanic/pull/2381) Fix newly assigned `None` in task registry | ||||
| - [sanic-routing#52](https://github.com/sanic-org/sanic-routing/pull/52) Add type casting to regex route matching | ||||
| - [sanic-routing#60](https://github.com/sanic-org/sanic-routing/pull/60) Add requirements check on regex routes (this resolves, for example, multiple static directories with differing `host` values) | ||||
|  | ||||
| ### Deprecations and Removals | ||||
| - [#2362](https://github.com/sanic-org/sanic/pull/2362) 22.3 Deprecations and changes | ||||
|     1. `debug=True` and `--debug` do _NOT_ automatically run `auto_reload` | ||||
|     2. Default error render is with plain text (browsers still get HTML by default because `auto` looks at headers) | ||||
|     3. `config` is required for `ErrorHandler.finalize` | ||||
|     4. `ErrorHandler.lookup` requires two positional args | ||||
|     5. Unused websocket protocol args removed | ||||
| - [#2344](https://github.com/sanic-org/sanic/pull/2344) Deprecate loading of lowercase environment variables | ||||
|  | ||||
| ### Developer infrastructure | ||||
| - [#2363](https://github.com/sanic-org/sanic/pull/2363) Revert code coverage back to Codecov | ||||
| - [#2405](https://github.com/sanic-org/sanic/pull/2405) Upgrade tests for `sanic-routing` changes | ||||
| - [sanic-testing#35](https://github.com/sanic-org/sanic-testing/pull/35) Allow for httpx v0.22 | ||||
|  | ||||
| ### Improved Documentation | ||||
| - [#2350](https://github.com/sanic-org/sanic/pull/2350) Fix link in README for ASGI | ||||
| - [#2398](https://github.com/sanic-org/sanic/pull/2398) Document middleware on_request and on_response | ||||
| - [#2409](https://github.com/sanic-org/sanic/pull/2409) Add missing documentation for `Request.respond` | ||||
|  | ||||
| ### Miscellaneous | ||||
| - [#2376](https://github.com/sanic-org/sanic/pull/2376) Fix typing for `ListenerMixin.listener` | ||||
| - [#2383](https://github.com/sanic-org/sanic/pull/2383) Clear deprecation warning in `asyncio.wait` | ||||
| - [#2387](https://github.com/sanic-org/sanic/pull/2387) Cleanup `__slots__` implementations | ||||
| - [#2390](https://github.com/sanic-org/sanic/pull/2390) Clear deprecation warning in `asyncio.get_event_loop` | ||||
							
								
								
									
										54
									
								
								docs/sanic/releases/22/22.6.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										54
									
								
								docs/sanic/releases/22/22.6.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,54 @@ | ||||
| ## Version 22.6.2 | ||||
|  | ||||
| ### Bugfixes | ||||
|  | ||||
| - [#2522](https://github.com/sanic-org/sanic/pull/2522) Always show server location in ASGI | ||||
|  | ||||
| ## Version 22.6.1 | ||||
|  | ||||
| ### Bugfixes | ||||
|  | ||||
| - [#2477](https://github.com/sanic-org/sanic/pull/2477) Sanic static directory fails when folder name ends with ".." | ||||
|  | ||||
|  | ||||
| ## Version 22.6.0 | ||||
|  | ||||
| ### Features | ||||
| - [#2378](https://github.com/sanic-org/sanic/pull/2378) Introduce HTTP/3 and autogeneration of TLS certificates in `DEBUG` mode | ||||
|     - 👶 *EARLY RELEASE FEATURE*: Serving Sanic over HTTP/3 is an early release feature. It does not yet fully cover the HTTP/3 spec, but instead aims for feature parity with Sanic's existing HTTP/1.1 server. Websockets, WebTransport, push responses are examples of some features not yet implemented. | ||||
|     - 📦 *EXTRA REQUIREMENT*: Not all HTTP clients are capable of interfacing with HTTP/3 servers. You may need to install a [HTTP/3 capable client](https://curl.se/docs/http3.html). | ||||
|     - 📦 *EXTRA REQUIREMENT*: In order to use TLS autogeneration, you must install either [mkcert](https://github.com/FiloSottile/mkcert) or [trustme](https://github.com/python-trio/trustme). | ||||
| - [#2416](https://github.com/sanic-org/sanic/pull/2416) Add message to `task.cancel` | ||||
| - [#2420](https://github.com/sanic-org/sanic/pull/2420) Add exception aliases for more consistent naming with standard HTTP response types (`BadRequest`, `MethodNotAllowed`, `RangeNotSatisfiable`) | ||||
| - [#2432](https://github.com/sanic-org/sanic/pull/2432) Expose ASGI `scope` as a property on the `Request` object | ||||
| - [#2438](https://github.com/sanic-org/sanic/pull/2438) Easier access to websocket class for annotation: `from sanic import Websocket` | ||||
| - [#2439](https://github.com/sanic-org/sanic/pull/2439) New API for reading form values with options: `Request.get_form`  | ||||
| - [#2445](https://github.com/sanic-org/sanic/pull/2445) Add custom `loads` function | ||||
| - [#2447](https://github.com/sanic-org/sanic/pull/2447), [#2486](https://github.com/sanic-org/sanic/pull/2486) Improved API to support setting cache control headers | ||||
| - [#2453](https://github.com/sanic-org/sanic/pull/2453) Move verbosity filtering to logger | ||||
| - [#2475](https://github.com/sanic-org/sanic/pull/2475) Expose getter for current request using `Request.get_current()` | ||||
|  | ||||
| ### Bugfixes | ||||
| - [#2448](https://github.com/sanic-org/sanic/pull/2448) Fix to allow running with `pythonw.exe` or places where there is no `sys.stdout` | ||||
| - [#2451](https://github.com/sanic-org/sanic/pull/2451) Trigger `http.lifecycle.request` signal in ASGI mode | ||||
| - [#2455](https://github.com/sanic-org/sanic/pull/2455) Resolve typing of stacked route definitions | ||||
| - [#2463](https://github.com/sanic-org/sanic/pull/2463) Properly catch websocket CancelledError in websocket handler in Python 3.7 | ||||
|  | ||||
| ### Deprecations and Removals | ||||
| - [#2487](https://github.com/sanic-org/sanic/pull/2487) v22.6 deprecations and changes | ||||
|     1. Optional application registry | ||||
|     1. Execution of custom handlers after some part of response was sent | ||||
|     1. Configuring fallback handlers on the `ErrorHandler` | ||||
|     1. Custom `LOGO` setting | ||||
|     1. `sanic.response.stream` | ||||
|     1. `AsyncioServer.init` | ||||
|  | ||||
| ### Developer infrastructure | ||||
| - [#2449](https://github.com/sanic-org/sanic/pull/2449) Clean up `black` and `isort` config | ||||
| - [#2479](https://github.com/sanic-org/sanic/pull/2479) Fix some flappy tests | ||||
|  | ||||
| ### Improved Documentation | ||||
| - [#2461](https://github.com/sanic-org/sanic/pull/2461) Update example to match current application naming standards | ||||
| - [#2466](https://github.com/sanic-org/sanic/pull/2466) Better type annotation for `Extend` | ||||
| - [#2485](https://github.com/sanic-org/sanic/pull/2485) Improved help messages in CLI | ||||
|  | ||||
							
								
								
									
										47
									
								
								docs/sanic/releases/22/22.9.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										47
									
								
								docs/sanic/releases/22/22.9.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,47 @@ | ||||
| ## Version 22.9.0 🔶 | ||||
|  | ||||
| _Current version_ | ||||
|  | ||||
| ### Features | ||||
|  | ||||
| - [#2445](https://github.com/sanic-org/sanic/pull/2445) Add custom loads function  | ||||
| - [#2490](https://github.com/sanic-org/sanic/pull/2490) Make `WebsocketImplProtocol` async iterable | ||||
| - [#2499](https://github.com/sanic-org/sanic/pull/2499) Sanic Server WorkerManager refactor | ||||
| - [#2506](https://github.com/sanic-org/sanic/pull/2506) Use `pathlib` for path resolution (for static file serving) | ||||
| - [#2508](https://github.com/sanic-org/sanic/pull/2508) Use `path.parts` instead of `match` (for static file serving) | ||||
| - [#2513](https://github.com/sanic-org/sanic/pull/2513) Better request cancel handling | ||||
| - [#2516](https://github.com/sanic-org/sanic/pull/2516) Add request properties for HTTP method info: | ||||
|     - `request.is_safe` | ||||
|     - `request.is_idempotent` | ||||
|     - `request.is_cacheable` | ||||
|     - *See* [MDN docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) *for more information about when these apply* | ||||
| - [#2522](https://github.com/sanic-org/sanic/pull/2522) Always show server location in ASGI | ||||
| - [#2526](https://github.com/sanic-org/sanic/pull/2526) Cache control support for static files for returning 304 when appropriate | ||||
| - [#2533](https://github.com/sanic-org/sanic/pull/2533) Refactor `_static_request_handler` | ||||
| - [#2540](https://github.com/sanic-org/sanic/pull/2540) Add signals before and after handler execution | ||||
|     - `http.handler.before` | ||||
|     - `http.handler.after` | ||||
| - [#2542](https://github.com/sanic-org/sanic/pull/2542) Add *[redacted]* to CLI :) | ||||
| - [#2546](https://github.com/sanic-org/sanic/pull/2546) Add deprecation warning filter | ||||
| - [#2550](https://github.com/sanic-org/sanic/pull/2550) Middleware priority and performance enhancements | ||||
|  | ||||
| ### Bugfixes | ||||
|  | ||||
| - [#2495](https://github.com/sanic-org/sanic/pull/2495) Prevent directory traversion with static files | ||||
| - [#2515](https://github.com/sanic-org/sanic/pull/2515) Do not apply double slash to paths in certain static dirs in Blueprints | ||||
|  | ||||
| ### Deprecations and Removals | ||||
|  | ||||
| - [#2525](https://github.com/sanic-org/sanic/pull/2525) Warn on duplicate route names, will be prevented outright in v23.3 | ||||
| - [#2537](https://github.com/sanic-org/sanic/pull/2537) Raise warning and deprecation notice on duplicate exceptions, will be prevented outright in v23.3 | ||||
|  | ||||
| ### Developer infrastructure | ||||
|  | ||||
| - [#2504](https://github.com/sanic-org/sanic/pull/2504) Cleanup test suite | ||||
| - [#2505](https://github.com/sanic-org/sanic/pull/2505) Replace Unsupported Python Version Number from the Contributing Doc | ||||
| - [#2530](https://github.com/sanic-org/sanic/pull/2530) Do not include tests folder in installed package resolver | ||||
|  | ||||
| ### Improved Documentation | ||||
|  | ||||
| - [#2502](https://github.com/sanic-org/sanic/pull/2502) Fix a few typos | ||||
| - [#2517](https://github.com/sanic-org/sanic/pull/2517) [#2536](https://github.com/sanic-org/sanic/pull/2536) Add some type hints | ||||
| @@ -5,7 +5,7 @@ import asyncio | ||||
| from sanic import Sanic | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| async def notify_server_started_after_five_seconds(): | ||||
|   | ||||
| @@ -4,7 +4,7 @@ from sanic import Sanic | ||||
| from sanic.response import text | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.middleware("request") | ||||
|   | ||||
| @@ -6,7 +6,7 @@ from sanic import Sanic | ||||
| from sanic.response import json | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| def check_request_for_authorization_status(request): | ||||
|   | ||||
| @@ -8,9 +8,9 @@ are added. And blueprint response middleware are executed in _reverse_ order. | ||||
| On a valid request, it should print "1 2 3 6 5 4" to terminal | ||||
| """ | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
| bp = Blueprint("bp_" + __name__) | ||||
| bp = Blueprint("bp_example") | ||||
|  | ||||
|  | ||||
| @bp.on_request | ||||
|   | ||||
| @@ -2,10 +2,10 @@ from sanic import Blueprint, Sanic | ||||
| from sanic.response import file, json | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| blueprint = Blueprint("name", url_prefix="/my_blueprint") | ||||
| blueprint2 = Blueprint("name2", url_prefix="/my_blueprint2") | ||||
| blueprint3 = Blueprint("name3", url_prefix="/my_blueprint3") | ||||
| app = Sanic("Example") | ||||
| blueprint = Blueprint("bp_example", url_prefix="/my_blueprint") | ||||
| blueprint2 = Blueprint("bp_example2", url_prefix="/my_blueprint2") | ||||
| blueprint3 = Blueprint("bp_example3", url_prefix="/my_blueprint3") | ||||
|  | ||||
|  | ||||
| @blueprint.route("/foo") | ||||
|   | ||||
| @@ -3,7 +3,8 @@ from asyncio import sleep | ||||
| from sanic import Sanic, response | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__, strict_slashes=True) | ||||
| app = Sanic("DelayedResponseApp", strict_slashes=True) | ||||
| app.config.AUTO_EXTEND = False | ||||
|  | ||||
|  | ||||
| @app.get("/") | ||||
| @@ -11,7 +12,7 @@ async def handler(request): | ||||
|     return response.redirect("/sleep/3") | ||||
|  | ||||
|  | ||||
| @app.get("/sleep/<t:number>") | ||||
| @app.get("/sleep/<t:float>") | ||||
| async def handler2(request, t=0.3): | ||||
|     await sleep(t) | ||||
|     return response.text(f"Slept {t:.1f} seconds.\n") | ||||
|   | ||||
| @@ -41,7 +41,7 @@ from sanic import Sanic | ||||
|  | ||||
|  | ||||
| handler = CustomHandler() | ||||
| app = Sanic(__name__, error_handler=handler) | ||||
| app = Sanic("Example", error_handler=handler) | ||||
|  | ||||
|  | ||||
| @app.route("/") | ||||
|   | ||||
| @@ -1,7 +1,7 @@ | ||||
| from sanic import Sanic | ||||
| from sanic import response | ||||
| from sanic import Sanic, response | ||||
|  | ||||
| app = Sanic(__name__) | ||||
|  | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route("/") | ||||
| @@ -9,5 +9,5 @@ async def test(request): | ||||
|     return response.json({"test": True}) | ||||
|  | ||||
|  | ||||
| if __name__ == '__main__': | ||||
| if __name__ == "__main__": | ||||
|     app.run(host="0.0.0.0", port=8000) | ||||
|   | ||||
| @@ -6,7 +6,7 @@ from sanic import Sanic | ||||
| from sanic.response import json | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
| sem = None | ||||
|  | ||||
|   | ||||
| @@ -44,7 +44,7 @@ LOG_SETTINGS = { | ||||
| } | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__, log_config=LOG_SETTINGS) | ||||
| app = Sanic("Example", log_config=LOG_SETTINGS) | ||||
|  | ||||
|  | ||||
| @app.on_request | ||||
|   | ||||
| @@ -43,7 +43,7 @@ logdna = logging.getLogger(__name__) | ||||
| logdna.setLevel(logging.INFO) | ||||
| logdna.addHandler(logdna_handler) | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.middleware | ||||
|   | ||||
| @@ -2,27 +2,29 @@ | ||||
| Modify header or status in response | ||||
| """ | ||||
|  | ||||
| from sanic import Sanic | ||||
| from sanic import response | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| from sanic import Sanic, response | ||||
|  | ||||
|  | ||||
| @app.route('/') | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route("/") | ||||
| def handle_request(request): | ||||
|     return response.json( | ||||
|         {'message': 'Hello world!'}, | ||||
|         headers={'X-Served-By': 'sanic'}, | ||||
|         status=200 | ||||
|         {"message": "Hello world!"}, | ||||
|         headers={"X-Served-By": "sanic"}, | ||||
|         status=200, | ||||
|     ) | ||||
|  | ||||
|  | ||||
| @app.route('/unauthorized') | ||||
| @app.route("/unauthorized") | ||||
| def handle_request(request): | ||||
|     return response.json( | ||||
|         {'message': 'You are not authorized'}, | ||||
|         headers={'X-Served-By': 'sanic'}, | ||||
|         status=404 | ||||
|         {"message": "You are not authorized"}, | ||||
|         headers={"X-Served-By": "sanic"}, | ||||
|         status=404, | ||||
|     ) | ||||
|  | ||||
| app.run(host="0.0.0.0", port=8000, debug=True) | ||||
|  | ||||
| if __name__ == "__main__": | ||||
|     app.run(host="0.0.0.0", port=8000, debug=True) | ||||
|   | ||||
| @@ -32,7 +32,7 @@ def test_port(worker_id): | ||||
|  | ||||
| @pytest.fixture(scope="session") | ||||
| def app(): | ||||
|     app = Sanic() | ||||
|     app = Sanic("Example") | ||||
|  | ||||
|     @app.route("/") | ||||
|     async def index(request): | ||||
|   | ||||
| @@ -8,7 +8,6 @@ from sanic.handlers import ErrorHandler | ||||
|  | ||||
|  | ||||
| class RaygunExceptionReporter(ErrorHandler): | ||||
|  | ||||
|     def __init__(self, raygun_api_key=None): | ||||
|         super().__init__() | ||||
|         if raygun_api_key is None: | ||||
| @@ -22,16 +21,13 @@ class RaygunExceptionReporter(ErrorHandler): | ||||
|  | ||||
|  | ||||
| raygun_error_reporter = RaygunExceptionReporter() | ||||
| app = Sanic(__name__, error_handler=raygun_error_reporter) | ||||
| app = Sanic("Example", error_handler=raygun_error_reporter) | ||||
|  | ||||
|  | ||||
| @app.route("/raise") | ||||
| async def test(request): | ||||
|     raise SanicException('You Broke It!') | ||||
|     raise SanicException("You Broke It!") | ||||
|  | ||||
|  | ||||
| if __name__ == '__main__': | ||||
|     app.run( | ||||
|         host="0.0.0.0", | ||||
|         port=getenv("PORT", 8080) | ||||
|     ) | ||||
| if __name__ == "__main__": | ||||
|     app.run(host="0.0.0.0", port=getenv("PORT", 8080)) | ||||
|   | ||||
| @@ -1,18 +1,18 @@ | ||||
| from sanic import Sanic | ||||
| from sanic import response | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| from sanic import Sanic, response | ||||
|  | ||||
|  | ||||
| @app.route('/') | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route("/") | ||||
| def handle_request(request): | ||||
|     return response.redirect('/redirect') | ||||
|     return response.redirect("/redirect") | ||||
|  | ||||
|  | ||||
| @app.route('/redirect') | ||||
| @app.route("/redirect") | ||||
| async def test(request): | ||||
|     return response.json({"Redirected": True}) | ||||
|  | ||||
|  | ||||
| if __name__ == '__main__': | ||||
| if __name__ == "__main__": | ||||
|     app.run(host="0.0.0.0", port=8000) | ||||
| @@ -1,65 +1,63 @@ | ||||
| from sanic import Sanic | ||||
| from sanic.views import CompositionView | ||||
| from sanic.views import HTTPMethodView | ||||
| from sanic.views import stream as stream_decorator | ||||
| from sanic.blueprints import Blueprint | ||||
| from sanic.response import stream, text | ||||
| from sanic.views import HTTPMethodView | ||||
| from sanic.views import stream as stream_decorator | ||||
|  | ||||
| bp = Blueprint('blueprint_request_stream') | ||||
| app = Sanic('request_stream') | ||||
|  | ||||
| bp = Blueprint("bp_example") | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| class SimpleView(HTTPMethodView): | ||||
|  | ||||
|     @stream_decorator | ||||
|     async def post(self, request): | ||||
|         result = '' | ||||
|         result = "" | ||||
|         while True: | ||||
|             body = await request.stream.get() | ||||
|             if body is None: | ||||
|                 break | ||||
|             result += body.decode('utf-8') | ||||
|             result += body.decode("utf-8") | ||||
|         return text(result) | ||||
|  | ||||
|  | ||||
| @app.post('/stream', stream=True) | ||||
| @app.post("/stream", stream=True) | ||||
| async def handler(request): | ||||
|     async def streaming(response): | ||||
|         while True: | ||||
|             body = await request.stream.get() | ||||
|             if body is None: | ||||
|                 break | ||||
|             body = body.decode('utf-8').replace('1', 'A') | ||||
|             body = body.decode("utf-8").replace("1", "A") | ||||
|             await response.write(body) | ||||
|  | ||||
|     return stream(streaming) | ||||
|  | ||||
|  | ||||
| @bp.put('/bp_stream', stream=True) | ||||
| @bp.put("/bp_stream", stream=True) | ||||
| async def bp_handler(request): | ||||
|     result = '' | ||||
|     result = "" | ||||
|     while True: | ||||
|         body = await request.stream.get() | ||||
|         if body is None: | ||||
|             break | ||||
|         result += body.decode('utf-8').replace('1', 'A') | ||||
|         result += body.decode("utf-8").replace("1", "A") | ||||
|     return text(result) | ||||
|  | ||||
|  | ||||
| async def post_handler(request): | ||||
|     result = '' | ||||
|     result = "" | ||||
|     while True: | ||||
|         body = await request.stream.get() | ||||
|         if body is None: | ||||
|             break | ||||
|         result += body.decode('utf-8') | ||||
|         result += body.decode("utf-8") | ||||
|     return text(result) | ||||
|  | ||||
|  | ||||
| app.blueprint(bp) | ||||
| app.add_route(SimpleView.as_view(), '/method_view') | ||||
| view = CompositionView() | ||||
| view.add(['POST'], post_handler, stream=True) | ||||
| app.add_route(view, '/composition_view') | ||||
| app.add_route(SimpleView.as_view(), "/method_view") | ||||
|  | ||||
|  | ||||
| if __name__ == '__main__': | ||||
|     app.run(host='0.0.0.0', port=8000) | ||||
| if __name__ == "__main__": | ||||
|     app.run(host="0.0.0.0", port=8000) | ||||
|   | ||||
| @@ -1,21 +1,23 @@ | ||||
| import asyncio | ||||
| from sanic import Sanic | ||||
| from sanic import response | ||||
|  | ||||
| from sanic import Sanic, response | ||||
| from sanic.config import Config | ||||
| from sanic.exceptions import RequestTimeout | ||||
|  | ||||
|  | ||||
| Config.REQUEST_TIMEOUT = 1 | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route('/') | ||||
| @app.route("/") | ||||
| async def test(request): | ||||
|     await asyncio.sleep(3) | ||||
|     return response.text('Hello, world!') | ||||
|     return response.text("Hello, world!") | ||||
|  | ||||
|  | ||||
| @app.exception(RequestTimeout) | ||||
| def timeout(request, exception): | ||||
|     return response.text('RequestTimeout from error_handler.', 408) | ||||
|     return response.text("RequestTimeout from error_handler.", 408) | ||||
|  | ||||
| app.run(host='0.0.0.0', port=8000) | ||||
|  | ||||
| app.run(host="0.0.0.0", port=8000) | ||||
|   | ||||
| @@ -1,21 +1,22 @@ | ||||
| from os import getenv | ||||
|  | ||||
| import rollbar | ||||
|  | ||||
| from sanic.handlers import ErrorHandler | ||||
| from sanic import Sanic | ||||
| from sanic.exceptions import SanicException | ||||
| from os import getenv | ||||
| from sanic.handlers import ErrorHandler | ||||
|  | ||||
|  | ||||
| rollbar.init(getenv("ROLLBAR_API_KEY")) | ||||
|  | ||||
|  | ||||
| class RollbarExceptionHandler(ErrorHandler): | ||||
|  | ||||
|     def default(self, request, exception): | ||||
|         rollbar.report_message(str(exception)) | ||||
|         return super().default(request, exception) | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__, error_handler=RollbarExceptionHandler()) | ||||
| app = Sanic("Example", error_handler=RollbarExceptionHandler()) | ||||
|  | ||||
|  | ||||
| @app.route("/raise") | ||||
| @@ -24,7 +25,4 @@ def create_error(request): | ||||
|  | ||||
|  | ||||
| if __name__ == "__main__": | ||||
|     app.run( | ||||
|         host="0.0.0.0", | ||||
|         port=getenv("PORT", 8080) | ||||
|     ) | ||||
|     app.run(host="0.0.0.0", port=getenv("PORT", 8080)) | ||||
|   | ||||
| @@ -11,7 +11,7 @@ from pathlib import Path | ||||
| from sanic import Sanic, response | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route("/text") | ||||
|   | ||||
| @@ -5,7 +5,7 @@ import uvloop | ||||
| from sanic import Sanic, response | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route("/") | ||||
|   | ||||
| @@ -8,7 +8,7 @@ from sanic import Sanic, response | ||||
| from sanic.server import AsyncioServer | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.before_server_start | ||||
|   | ||||
| @@ -6,20 +6,19 @@ from sentry_sdk.integrations.sanic import SanicIntegration | ||||
| from sanic import Sanic | ||||
| from sanic.response import json | ||||
|  | ||||
|  | ||||
| sentry_init( | ||||
|     dsn=getenv("SENTRY_DSN"), | ||||
|     integrations=[SanicIntegration()], | ||||
| ) | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| # noinspection PyUnusedLocal | ||||
| @app.route("/working") | ||||
| async def working_path(request): | ||||
|     return json({ | ||||
|         "response": "Working API Response" | ||||
|     }) | ||||
|     return json({"response": "Working API Response"}) | ||||
|  | ||||
|  | ||||
| # noinspection PyUnusedLocal | ||||
| @@ -28,8 +27,5 @@ async def raise_error(request): | ||||
|     raise Exception("Testing Sentry Integration") | ||||
|  | ||||
|  | ||||
| if __name__ == '__main__': | ||||
|     app.run( | ||||
|         host="0.0.0.0", | ||||
|         port=getenv("PORT", 8080) | ||||
|     ) | ||||
| if __name__ == "__main__": | ||||
|     app.run(host="0.0.0.0", port=getenv("PORT", 8080)) | ||||
|   | ||||
| @@ -1,6 +1,6 @@ | ||||
| from sanic import Sanic | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
| app.static("/", "./static") | ||||
|   | ||||
| @@ -1,13 +1,14 @@ | ||||
| from sanic import Sanic | ||||
| from sanic import response as res | ||||
|  | ||||
| app = Sanic(__name__) | ||||
|  | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route("/") | ||||
| async def test(req): | ||||
|     return res.text("I\'m a teapot", status=418) | ||||
|     return res.text("I'm a teapot", status=418) | ||||
|  | ||||
|  | ||||
| if __name__ == '__main__': | ||||
| if __name__ == "__main__": | ||||
|     app.run(host="0.0.0.0", port=8000) | ||||
|   | ||||
| @@ -5,7 +5,7 @@ from sanic.exceptions import ServerError | ||||
| from sanic.log import logger as log | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route("/") | ||||
|   | ||||
| @@ -1,10 +1,7 @@ | ||||
| import os | ||||
| import socket | ||||
|  | ||||
| from sanic import Sanic, response | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route("/test") | ||||
| @@ -13,13 +10,4 @@ async def test(request): | ||||
|  | ||||
|  | ||||
| if __name__ == "__main__": | ||||
|     server_address = "./uds_socket" | ||||
|     # Make sure the socket does not already exist | ||||
|     try: | ||||
|         os.unlink(server_address) | ||||
|     except OSError: | ||||
|         if os.path.exists(server_address): | ||||
|             raise | ||||
|     sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) | ||||
|     sock.bind(server_address) | ||||
|     app.run(sock=sock) | ||||
|     app.run(unix="./uds_socket") | ||||
|   | ||||
| @@ -1,7 +1,7 @@ | ||||
| from sanic import Sanic, response | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| @app.route("/") | ||||
|   | ||||
| @@ -8,7 +8,7 @@ from sanic.blueprints import Blueprint | ||||
| # curl -H "Host: bp.example.com" localhost:8000/question | ||||
| # curl -H "Host: bp.example.com" localhost:8000/answer | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
| bp = Blueprint("bp", host="bp.example.com") | ||||
|  | ||||
|  | ||||
|   | ||||
| @@ -2,7 +2,7 @@ from sanic import Sanic | ||||
| from sanic.response import redirect | ||||
|  | ||||
|  | ||||
| app = Sanic(__name__) | ||||
| app = Sanic("Example") | ||||
|  | ||||
|  | ||||
| app.static("index.html", "websocket.html") | ||||
|   | ||||
| @@ -1,3 +1,26 @@ | ||||
| [build-system] | ||||
| requires = ["setuptools", "wheel"] | ||||
| requires = ["setuptools<60.0", "wheel"] | ||||
| build-backend = "setuptools.build_meta" | ||||
|  | ||||
| [tool.black] | ||||
| line-length = 79 | ||||
|  | ||||
| [tool.isort] | ||||
| atomic = true | ||||
| default_section = "THIRDPARTY" | ||||
| include_trailing_comma = true | ||||
| known_first_party = "sanic" | ||||
| known_third_party = "pytest" | ||||
| line_length = 79 | ||||
| lines_after_imports = 2 | ||||
| lines_between_types = 1 | ||||
| multi_line_output = 3 | ||||
| profile = "black" | ||||
|  | ||||
| [[tool.mypy.overrides]] | ||||
| module = [ | ||||
|     "httptools.*", | ||||
|     "trustme.*", | ||||
|     "sanic_routing.*", | ||||
| ] | ||||
| ignore_missing_imports = true | ||||
|   | ||||
| @@ -3,7 +3,16 @@ from sanic.app import Sanic | ||||
| from sanic.blueprints import Blueprint | ||||
| from sanic.constants import HTTPMethod | ||||
| from sanic.request import Request | ||||
| from sanic.response import HTTPResponse, html, json, text | ||||
| from sanic.response import ( | ||||
|     HTTPResponse, | ||||
|     empty, | ||||
|     file, | ||||
|     html, | ||||
|     json, | ||||
|     redirect, | ||||
|     text, | ||||
| ) | ||||
| from sanic.server.websockets.impl import WebsocketImplProtocol as Websocket | ||||
|  | ||||
|  | ||||
| __all__ = ( | ||||
| @@ -13,7 +22,11 @@ __all__ = ( | ||||
|     "HTTPMethod", | ||||
|     "HTTPResponse", | ||||
|     "Request", | ||||
|     "Websocket", | ||||
|     "empty", | ||||
|     "file", | ||||
|     "html", | ||||
|     "json", | ||||
|     "redirect", | ||||
|     "text", | ||||
| ) | ||||
|   | ||||
| @@ -6,10 +6,10 @@ if OS_IS_WINDOWS: | ||||
|     enable_windows_color_support() | ||||
|  | ||||
|  | ||||
| def main(): | ||||
| def main(args=None): | ||||
|     cli = SanicCLI() | ||||
|     cli.attach() | ||||
|     cli.run() | ||||
|     cli.run(args) | ||||
|  | ||||
|  | ||||
| if __name__ == "__main__": | ||||
|   | ||||
| @@ -1 +1 @@ | ||||
| __version__ = "21.12.0dev" | ||||
| __version__ = "22.12.0a0" | ||||
|   | ||||
							
								
								
									
										1112
									
								
								sanic/app.py
									
									
									
									
									
								
							
							
						
						
									
										1112
									
								
								sanic/app.py
									
									
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										32
									
								
								sanic/application/constants.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								sanic/application/constants.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,32 @@ | ||||
| from enum import Enum, IntEnum, auto | ||||
|  | ||||
|  | ||||
| class StrEnum(str, Enum):  # no cov | ||||
|     def _generate_next_value_(name: str, *args) -> str:  # type: ignore | ||||
|         return name.lower() | ||||
|  | ||||
|     def __eq__(self, value: object) -> bool: | ||||
|         value = str(value).upper() | ||||
|         return super().__eq__(value) | ||||
|  | ||||
|     def __hash__(self) -> int: | ||||
|         return hash(self.value) | ||||
|  | ||||
|     def __str__(self) -> str: | ||||
|         return self.value | ||||
|  | ||||
|  | ||||
| class Server(StrEnum): | ||||
|     SANIC = auto() | ||||
|     ASGI = auto() | ||||
|  | ||||
|  | ||||
| class Mode(StrEnum): | ||||
|     PRODUCTION = auto() | ||||
|     DEBUG = auto() | ||||
|  | ||||
|  | ||||
| class ServerStage(IntEnum): | ||||
|     STOPPED = auto() | ||||
|     PARTIAL = auto() | ||||
|     SERVING = auto() | ||||
							
								
								
									
										34
									
								
								sanic/application/ext.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								sanic/application/ext.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,34 @@ | ||||
| from __future__ import annotations | ||||
|  | ||||
| from contextlib import suppress | ||||
| from importlib import import_module | ||||
| from typing import TYPE_CHECKING | ||||
|  | ||||
|  | ||||
| if TYPE_CHECKING: | ||||
|     from sanic import Sanic | ||||
|  | ||||
|  | ||||
| def setup_ext(app: Sanic, *, fail: bool = False, **kwargs): | ||||
|     if not app.config.AUTO_EXTEND: | ||||
|         return | ||||
|  | ||||
|     sanic_ext = None | ||||
|     with suppress(ModuleNotFoundError): | ||||
|         sanic_ext = import_module("sanic_ext") | ||||
|  | ||||
|     if not sanic_ext:  # no cov | ||||
|         if fail: | ||||
|             raise RuntimeError( | ||||
|                 "Sanic Extensions is not installed. You can add it to your " | ||||
|                 "environment using:\n$ pip install sanic[ext]\nor\n$ pip " | ||||
|                 "install sanic-ext" | ||||
|             ) | ||||
|  | ||||
|         return | ||||
|  | ||||
|     if not getattr(app, "_ext", None): | ||||
|         Ext = getattr(sanic_ext, "Extend") | ||||
|         app._ext = Ext(app, **kwargs) | ||||
|  | ||||
|         return app.ext | ||||
| @@ -3,6 +3,8 @@ import sys | ||||
|  | ||||
| from os import environ | ||||
|  | ||||
| from sanic.compat import is_atty | ||||
|  | ||||
|  | ||||
| BASE_LOGO = """ | ||||
|  | ||||
| @@ -44,7 +46,7 @@ ansi_pattern = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])") | ||||
| def get_logo(full=False, coffee=False): | ||||
|     logo = ( | ||||
|         (FULL_COLOR_LOGO if full else (COFFEE_LOGO if coffee else COLOR_LOGO)) | ||||
|         if sys.stdout.isatty() | ||||
|         if is_atty() | ||||
|         else BASE_LOGO | ||||
|     ) | ||||
|  | ||||
|   | ||||
| @@ -1,11 +1,10 @@ | ||||
| import sys | ||||
|  | ||||
| from abc import ABC, abstractmethod | ||||
| from shutil import get_terminal_size | ||||
| from textwrap import indent, wrap | ||||
| from typing import Dict, Optional | ||||
|  | ||||
| from sanic import __version__ | ||||
| from sanic.compat import is_atty | ||||
| from sanic.log import logger | ||||
|  | ||||
|  | ||||
| @@ -36,14 +35,11 @@ class MOTD(ABC): | ||||
|         data: Dict[str, str], | ||||
|         extra: Dict[str, str], | ||||
|     ) -> None: | ||||
|         motd_class = MOTDTTY if sys.stdout.isatty() else MOTDBasic | ||||
|         motd_class = MOTDTTY if is_atty() else MOTDBasic | ||||
|         motd_class(logo, serve_location, data, extra).display() | ||||
|  | ||||
|  | ||||
| class MOTDBasic(MOTD): | ||||
|     def __init__(self, *args, **kwargs) -> None: | ||||
|         super().__init__(*args, **kwargs) | ||||
|  | ||||
|     def display(self): | ||||
|         if self.logo: | ||||
|             logger.debug(self.logo) | ||||
| @@ -84,20 +80,23 @@ class MOTDTTY(MOTD): | ||||
|         ) | ||||
|         self.display_length = self.key_width + self.value_width + 2 | ||||
|  | ||||
|     def display(self): | ||||
|         version = f"Sanic v{__version__}".center(self.centering_length) | ||||
|     def display(self, version=True, action="Goin' Fast", out=None): | ||||
|         if not out: | ||||
|             out = logger.info | ||||
|         header = "Sanic" | ||||
|         if version: | ||||
|             header += f" v{__version__}" | ||||
|         header = header.center(self.centering_length) | ||||
|         running = ( | ||||
|             f"Goin' Fast @ {self.serve_location}" | ||||
|             if self.serve_location | ||||
|             else "" | ||||
|             f"{action} @ {self.serve_location}" if self.serve_location else "" | ||||
|         ).center(self.centering_length) | ||||
|         length = len(version) + 2 - self.logo_line_length | ||||
|         length = len(header) + 2 - self.logo_line_length | ||||
|         first_filler = "─" * (self.logo_line_length - 1) | ||||
|         second_filler = "─" * length | ||||
|         display_filler = "─" * (self.display_length + 2) | ||||
|         lines = [ | ||||
|             f"\n┌{first_filler}─{second_filler}┐", | ||||
|             f"│ {version} │", | ||||
|             f"│ {header} │", | ||||
|             f"│ {running} │", | ||||
|             f"├{first_filler}┬{second_filler}┤", | ||||
|         ] | ||||
| @@ -111,7 +110,7 @@ class MOTDTTY(MOTD): | ||||
|         self._render_fill(lines) | ||||
|  | ||||
|         lines.append(f"└{first_filler}┴{second_filler}┘\n") | ||||
|         logger.info(indent("\n".join(lines), "  ")) | ||||
|         out(indent("\n".join(lines), "  ")) | ||||
|  | ||||
|     def _render_data(self, lines, data, start): | ||||
|         offset = 0 | ||||
|   | ||||
							
								
								
									
										86
									
								
								sanic/application/spinner.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										86
									
								
								sanic/application/spinner.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,86 @@ | ||||
| import os | ||||
| import sys | ||||
| import time | ||||
|  | ||||
| from contextlib import contextmanager | ||||
| from queue import Queue | ||||
| from threading import Thread | ||||
|  | ||||
|  | ||||
| if os.name == "nt":  # noqa | ||||
|     import ctypes  # noqa | ||||
|  | ||||
|     class _CursorInfo(ctypes.Structure): | ||||
|         _fields_ = [("size", ctypes.c_int), ("visible", ctypes.c_byte)] | ||||
|  | ||||
|  | ||||
| class Spinner:  # noqa | ||||
|     def __init__(self, message: str) -> None: | ||||
|         self.message = message | ||||
|         self.queue: Queue[int] = Queue() | ||||
|         self.spinner = self.cursor() | ||||
|         self.thread = Thread(target=self.run) | ||||
|  | ||||
|     def start(self): | ||||
|         self.queue.put(1) | ||||
|         self.thread.start() | ||||
|         self.hide() | ||||
|  | ||||
|     def run(self): | ||||
|         while self.queue.get(): | ||||
|             output = f"\r{self.message} [{next(self.spinner)}]" | ||||
|             sys.stdout.write(output) | ||||
|             sys.stdout.flush() | ||||
|             time.sleep(0.1) | ||||
|             self.queue.put(1) | ||||
|  | ||||
|     def stop(self): | ||||
|         self.queue.put(0) | ||||
|         self.thread.join() | ||||
|         self.show() | ||||
|  | ||||
|     @staticmethod | ||||
|     def cursor(): | ||||
|         while True: | ||||
|             for cursor in "|/-\\": | ||||
|                 yield cursor | ||||
|  | ||||
|     @staticmethod | ||||
|     def hide(): | ||||
|         if os.name == "nt": | ||||
|             ci = _CursorInfo() | ||||
|             handle = ctypes.windll.kernel32.GetStdHandle(-11) | ||||
|             ctypes.windll.kernel32.GetConsoleCursorInfo( | ||||
|                 handle, ctypes.byref(ci) | ||||
|             ) | ||||
|             ci.visible = False | ||||
|             ctypes.windll.kernel32.SetConsoleCursorInfo( | ||||
|                 handle, ctypes.byref(ci) | ||||
|             ) | ||||
|         elif os.name == "posix": | ||||
|             sys.stdout.write("\033[?25l") | ||||
|             sys.stdout.flush() | ||||
|  | ||||
|     @staticmethod | ||||
|     def show(): | ||||
|         if os.name == "nt": | ||||
|             ci = _CursorInfo() | ||||
|             handle = ctypes.windll.kernel32.GetStdHandle(-11) | ||||
|             ctypes.windll.kernel32.GetConsoleCursorInfo( | ||||
|                 handle, ctypes.byref(ci) | ||||
|             ) | ||||
|             ci.visible = True | ||||
|             ctypes.windll.kernel32.SetConsoleCursorInfo( | ||||
|                 handle, ctypes.byref(ci) | ||||
|             ) | ||||
|         elif os.name == "posix": | ||||
|             sys.stdout.write("\033[?25h") | ||||
|             sys.stdout.flush() | ||||
|  | ||||
|  | ||||
| @contextmanager | ||||
| def loading(message: str = "Loading"):  # noqa | ||||
|     spinner = Spinner(message) | ||||
|     spinner.start() | ||||
|     yield | ||||
|     spinner.stop() | ||||
| @@ -3,31 +3,25 @@ from __future__ import annotations | ||||
| import logging | ||||
|  | ||||
| from dataclasses import dataclass, field | ||||
| from enum import Enum, auto | ||||
| from pathlib import Path | ||||
| from typing import TYPE_CHECKING, Any, Set, Union | ||||
| from socket import socket | ||||
| from ssl import SSLContext | ||||
| from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Union | ||||
|  | ||||
| from sanic.log import logger | ||||
| from sanic.application.constants import Mode, Server, ServerStage | ||||
| from sanic.log import VerbosityFilter, logger | ||||
| from sanic.server.async_server import AsyncioServer | ||||
|  | ||||
|  | ||||
| if TYPE_CHECKING: | ||||
|     from sanic import Sanic | ||||
|  | ||||
|  | ||||
| class StrEnum(str, Enum): | ||||
|     def _generate_next_value_(name: str, *args) -> str:  # type: ignore | ||||
|         return name.lower() | ||||
|  | ||||
|  | ||||
| class Server(StrEnum): | ||||
|     SANIC = auto() | ||||
|     ASGI = auto() | ||||
|     GUNICORN = auto() | ||||
|  | ||||
|  | ||||
| class Mode(StrEnum): | ||||
|     PRODUCTION = auto() | ||||
|     DEBUG = auto() | ||||
| @dataclass | ||||
| class ApplicationServerInfo: | ||||
|     settings: Dict[str, Any] | ||||
|     stage: ServerStage = field(default=ServerStage.STOPPED) | ||||
|     server: Optional[AsyncioServer] = field(default=None) | ||||
|  | ||||
|  | ||||
| @dataclass | ||||
| @@ -37,15 +31,21 @@ class ApplicationState: | ||||
|     coffee: bool = field(default=False) | ||||
|     fast: bool = field(default=False) | ||||
|     host: str = field(default="") | ||||
|     mode: Mode = field(default=Mode.PRODUCTION) | ||||
|     port: int = field(default=0) | ||||
|     ssl: Optional[SSLContext] = field(default=None) | ||||
|     sock: Optional[socket] = field(default=None) | ||||
|     unix: Optional[str] = field(default=None) | ||||
|     mode: Mode = field(default=Mode.PRODUCTION) | ||||
|     reload_dirs: Set[Path] = field(default_factory=set) | ||||
|     auto_reload: bool = field(default=False) | ||||
|     server: Server = field(default=Server.SANIC) | ||||
|     is_running: bool = field(default=False) | ||||
|     is_started: bool = field(default=False) | ||||
|     is_stopping: bool = field(default=False) | ||||
|     verbosity: int = field(default=0) | ||||
|     workers: int = field(default=0) | ||||
|     primary: bool = field(default=True) | ||||
|     server_info: List[ApplicationServerInfo] = field(default_factory=list) | ||||
|  | ||||
|     # This property relates to the ApplicationState instance and should | ||||
|     # not be changed except in the __post_init__ method | ||||
| @@ -69,6 +69,23 @@ class ApplicationState: | ||||
|         if getattr(self.app, "configure_logging", False) and self.app.debug: | ||||
|             logger.setLevel(logging.DEBUG) | ||||
|  | ||||
|     def set_verbosity(self, value: int): | ||||
|         VerbosityFilter.verbosity = value | ||||
|  | ||||
|     @property | ||||
|     def is_debug(self): | ||||
|         return self.mode is Mode.DEBUG | ||||
|  | ||||
|     @property | ||||
|     def stage(self) -> ServerStage: | ||||
|         if not self.server_info: | ||||
|             return ServerStage.STOPPED | ||||
|  | ||||
|         if all(info.stage is ServerStage.SERVING for info in self.server_info): | ||||
|             return ServerStage.SERVING | ||||
|         elif any( | ||||
|             info.stage is ServerStage.SERVING for info in self.server_info | ||||
|         ): | ||||
|             return ServerStage.PARTIAL | ||||
|  | ||||
|         return ServerStage.STOPPED | ||||
|   | ||||
| @@ -1,13 +1,15 @@ | ||||
| from __future__ import annotations | ||||
|  | ||||
| import warnings | ||||
|  | ||||
| from typing import Optional | ||||
| from typing import TYPE_CHECKING, Optional | ||||
| from urllib.parse import quote | ||||
|  | ||||
| import sanic.app  # noqa | ||||
|  | ||||
| from sanic.compat import Header | ||||
| from sanic.exceptions import ServerError | ||||
| from sanic.helpers import Default | ||||
| from sanic.http import Stage | ||||
| from sanic.log import logger | ||||
| from sanic.models.asgi import ASGIReceive, ASGIScope, ASGISend, MockTransport | ||||
| from sanic.request import Request | ||||
| from sanic.response import BaseHTTPResponse | ||||
| @@ -15,29 +17,35 @@ from sanic.server import ConnInfo | ||||
| from sanic.server.websockets.connection import WebSocketConnection | ||||
|  | ||||
|  | ||||
| if TYPE_CHECKING: | ||||
|     from sanic import Sanic | ||||
|  | ||||
|  | ||||
| class Lifespan: | ||||
|     def __init__(self, asgi_app: "ASGIApp") -> None: | ||||
|     def __init__(self, asgi_app: ASGIApp) -> None: | ||||
|         self.asgi_app = asgi_app | ||||
|  | ||||
|         if ( | ||||
|             "server.init.before" | ||||
|             in self.asgi_app.sanic_app.signal_router.name_index | ||||
|         ): | ||||
|             warnings.warn( | ||||
|             logger.debug( | ||||
|                 'You have set a listener for "before_server_start" ' | ||||
|                 "in ASGI mode. " | ||||
|                 "It will be executed as early as possible, but not before " | ||||
|                 "the ASGI server is started." | ||||
|                 "the ASGI server is started.", | ||||
|                 extra={"verbosity": 1}, | ||||
|             ) | ||||
|         if ( | ||||
|             "server.shutdown.after" | ||||
|             in self.asgi_app.sanic_app.signal_router.name_index | ||||
|         ): | ||||
|             warnings.warn( | ||||
|             logger.debug( | ||||
|                 'You have set a listener for "after_server_stop" ' | ||||
|                 "in ASGI mode. " | ||||
|                 "It will be executed as late as possible, but not after " | ||||
|                 "the ASGI server is stopped." | ||||
|                 "the ASGI server is stopped.", | ||||
|                 extra={"verbosity": 1}, | ||||
|             ) | ||||
|  | ||||
|     async def startup(self) -> None: | ||||
| @@ -53,6 +61,13 @@ class Lifespan: | ||||
|         await self.asgi_app.sanic_app._server_event("init", "before") | ||||
|         await self.asgi_app.sanic_app._server_event("init", "after") | ||||
|  | ||||
|         if not isinstance(self.asgi_app.sanic_app.config.USE_UVLOOP, Default): | ||||
|             warnings.warn( | ||||
|                 "You have set the USE_UVLOOP configuration option, but Sanic " | ||||
|                 "cannot control the event loop when running in ASGI mode." | ||||
|                 "This option will be ignored." | ||||
|             ) | ||||
|  | ||||
|     async def shutdown(self) -> None: | ||||
|         """ | ||||
|         Gather the listeners to fire on server stop. | ||||
| @@ -80,7 +95,7 @@ class Lifespan: | ||||
|  | ||||
|  | ||||
| class ASGIApp: | ||||
|     sanic_app: "sanic.app.Sanic" | ||||
|     sanic_app: Sanic | ||||
|     request: Request | ||||
|     transport: MockTransport | ||||
|     lifespan: Lifespan | ||||
| @@ -149,6 +164,13 @@ class ASGIApp: | ||||
|             instance.request_body = True | ||||
|             instance.request.conn_info = ConnInfo(instance.transport) | ||||
|  | ||||
|             await sanic_app.dispatch( | ||||
|                 "http.lifecycle.request", | ||||
|                 inline=True, | ||||
|                 context={"request": instance.request}, | ||||
|                 fail_not_found=False, | ||||
|             ) | ||||
|  | ||||
|         return instance | ||||
|  | ||||
|     async def read(self) -> Optional[bytes]: | ||||
| @@ -212,4 +234,7 @@ class ASGIApp: | ||||
|             self.stage = Stage.HANDLER | ||||
|             await self.sanic_app.handle_request(self.request) | ||||
|         except Exception as e: | ||||
|             try: | ||||
|                 await self.sanic_app.handle_exception(self.request, e) | ||||
|             except Exception as exc: | ||||
|                 await self.sanic_app.handle_exception(self.request, exc, False) | ||||
|   | ||||
							
								
								
									
										0
									
								
								sanic/base/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								sanic/base/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
								
								
									
										6
									
								
								sanic/base/meta.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								sanic/base/meta.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,6 @@ | ||||
| class SanicMeta(type): | ||||
|     @classmethod | ||||
|     def __prepare__(metaclass, name, bases, **kwds): | ||||
|         cls = super().__prepare__(metaclass, name, bases, **kwds) | ||||
|         cls["__slots__"] = () | ||||
|         return cls | ||||
| @@ -1,8 +1,8 @@ | ||||
| import re | ||||
| 
 | ||||
| from typing import Any, Tuple | ||||
| from warnings import warn | ||||
| from typing import Any | ||||
| 
 | ||||
| from sanic.base.meta import SanicMeta | ||||
| from sanic.exceptions import SanicException | ||||
| from sanic.mixins.exceptions import ExceptionMixin | ||||
| from sanic.mixins.listeners import ListenerMixin | ||||
| @@ -20,8 +20,9 @@ class BaseSanic( | ||||
|     ListenerMixin, | ||||
|     ExceptionMixin, | ||||
|     SignalMixin, | ||||
|     metaclass=SanicMeta, | ||||
| ): | ||||
|     __fake_slots__: Tuple[str, ...] | ||||
|     __slots__ = ("name",) | ||||
| 
 | ||||
|     def __init__(self, name: str = None, *args: Any, **kwargs: Any) -> None: | ||||
|         class_name = self.__class__.__name__ | ||||
| @@ -33,11 +34,10 @@ class BaseSanic( | ||||
|             ) | ||||
| 
 | ||||
|         if not VALID_NAME.match(name): | ||||
|             warn( | ||||
|                 f"{class_name} instance named '{name}' uses a format that is" | ||||
|                 f"deprecated. Starting in version 21.12, {class_name} objects " | ||||
|                 "must be named only using alphanumeric characters, _, or -.", | ||||
|                 DeprecationWarning, | ||||
|             raise SanicException( | ||||
|                 f"{class_name} instance named '{name}' uses an invalid " | ||||
|                 "format. Names must begin with a character and may only " | ||||
|                 "contain alphanumeric characters, _, or -." | ||||
|             ) | ||||
| 
 | ||||
|         self.name = name | ||||
| @@ -52,15 +52,12 @@ class BaseSanic( | ||||
|         return f'{self.__class__.__name__}(name="{self.name}")' | ||||
| 
 | ||||
|     def __setattr__(self, name: str, value: Any) -> None: | ||||
|         # This is a temporary compat layer so we can raise a warning until | ||||
|         # setting attributes on the app instance can be removed and deprecated | ||||
|         # with a proper implementation of __slots__ | ||||
|         if name not in self.__fake_slots__: | ||||
|             warn( | ||||
|                 f"Setting variables on {self.__class__.__name__} instances is " | ||||
|                 "deprecated and will be removed in version 21.12. You should " | ||||
|                 f"change your {self.__class__.__name__} instance to use " | ||||
|                 f"instance.ctx.{name} instead.", | ||||
|                 DeprecationWarning, | ||||
|             ) | ||||
|         try: | ||||
|             super().__setattr__(name, value) | ||||
|         except AttributeError as e: | ||||
|             raise AttributeError( | ||||
|                 f"Setting variables on {self.__class__.__name__} instances is " | ||||
|                 "not allowed. You should change your " | ||||
|                 f"{self.__class__.__name__} instance to use " | ||||
|                 f"instance.ctx.{name} instead.", | ||||
|             ) from e | ||||
| @@ -21,10 +21,10 @@ from typing import ( | ||||
|     Union, | ||||
| ) | ||||
|  | ||||
| from sanic_routing.exceptions import NotFound  # type: ignore | ||||
| from sanic_routing.route import Route  # type: ignore | ||||
| from sanic_routing.exceptions import NotFound | ||||
| from sanic_routing.route import Route | ||||
|  | ||||
| from sanic.base import BaseSanic | ||||
| from sanic.base.root import BaseSanic | ||||
| from sanic.blueprint_group import BlueprintGroup | ||||
| from sanic.exceptions import SanicException | ||||
| from sanic.helpers import Default, _default | ||||
| @@ -37,7 +37,7 @@ from sanic.models.handler_types import ( | ||||
|  | ||||
|  | ||||
| if TYPE_CHECKING: | ||||
|     from sanic import Sanic  # noqa | ||||
|     from sanic import Sanic | ||||
|  | ||||
|  | ||||
| def lazy(func, as_decorator=True): | ||||
| @@ -85,7 +85,7 @@ class Blueprint(BaseSanic): | ||||
|         trailing */* | ||||
|     """ | ||||
|  | ||||
|     __fake_slots__ = ( | ||||
|     __slots__ = ( | ||||
|         "_apps", | ||||
|         "_future_routes", | ||||
|         "_future_statics", | ||||
| @@ -98,7 +98,6 @@ class Blueprint(BaseSanic): | ||||
|         "host", | ||||
|         "listeners", | ||||
|         "middlewares", | ||||
|         "name", | ||||
|         "routes", | ||||
|         "statics", | ||||
|         "strict_slashes", | ||||
| @@ -107,7 +106,6 @@ class Blueprint(BaseSanic): | ||||
|         "version_prefix", | ||||
|         "websocket_routes", | ||||
|     ) | ||||
|     __pre_registry__: Dict[Union[str, Default], Any] = defaultdict(list) | ||||
|  | ||||
|     def __init__( | ||||
|         self, | ||||
| @@ -310,7 +308,7 @@ class Blueprint(BaseSanic): | ||||
|             # prefixed properly in the router | ||||
|             future.handler.__blueprintname__ = self.name | ||||
|             # Prepend the blueprint URI prefix if available | ||||
|             uri = url_prefix + future.uri if url_prefix else future.uri | ||||
|             uri = self._setup_uri(future.uri, url_prefix) | ||||
|  | ||||
|             version_prefix = self.version_prefix | ||||
|             for prefix in ( | ||||
| @@ -335,7 +333,7 @@ class Blueprint(BaseSanic): | ||||
|  | ||||
|             apply_route = FutureRoute( | ||||
|                 future.handler, | ||||
|                 uri[1:] if uri.startswith("//") else uri, | ||||
|                 uri, | ||||
|                 future.methods, | ||||
|                 host, | ||||
|                 strict_slashes, | ||||
| @@ -349,6 +347,7 @@ class Blueprint(BaseSanic): | ||||
|                 future.static, | ||||
|                 version_prefix, | ||||
|                 error_format, | ||||
|                 future.route_context, | ||||
|             ) | ||||
|  | ||||
|             if (self, apply_route) in app._future_registry: | ||||
| @@ -364,7 +363,7 @@ class Blueprint(BaseSanic): | ||||
|         # Static Files | ||||
|         for future in self._future_statics: | ||||
|             # Prepend the blueprint URI prefix if available | ||||
|             uri = url_prefix + future.uri if url_prefix else future.uri | ||||
|             uri = self._setup_uri(future.uri, url_prefix) | ||||
|             apply_route = FutureStatic(uri, *future[1:]) | ||||
|  | ||||
|             if (self, apply_route) in app._future_registry: | ||||
| @@ -401,12 +400,13 @@ class Blueprint(BaseSanic): | ||||
|         for future in self._future_signals: | ||||
|             if (self, future) in app._future_registry: | ||||
|                 continue | ||||
|             future.condition.update({"blueprint": self.name}) | ||||
|             app._apply_signal(future) | ||||
|             future.condition.update({"__blueprint__": self.name}) | ||||
|             # Force exclusive to be False | ||||
|             app._apply_signal(tuple((*future[:-1], False))) | ||||
|  | ||||
|         self.routes += [route for route in routes if isinstance(route, Route)] | ||||
|         self.websocket_routes += [ | ||||
|             route for route in self.routes if route.ctx.websocket | ||||
|             route for route in self.routes if route.extra.websocket | ||||
|         ] | ||||
|         self.middlewares += middleware | ||||
|         self.exceptions += exception_handlers | ||||
| @@ -427,7 +427,7 @@ class Blueprint(BaseSanic): | ||||
|  | ||||
|     async def dispatch(self, *args, **kwargs): | ||||
|         condition = kwargs.pop("condition", {}) | ||||
|         condition.update({"blueprint": self.name}) | ||||
|         condition.update({"__blueprint__": self.name}) | ||||
|         kwargs["condition"] = condition | ||||
|         await asyncio.gather( | ||||
|             *[app.dispatch(*args, **kwargs) for app in self.apps] | ||||
| @@ -456,36 +456,21 @@ class Blueprint(BaseSanic): | ||||
|                 break | ||||
|         return value | ||||
|  | ||||
|     @staticmethod | ||||
|     def _setup_uri(base: str, prefix: Optional[str]): | ||||
|         uri = base | ||||
|         if prefix: | ||||
|             uri = prefix | ||||
|             if base.startswith("/") and prefix.endswith("/"): | ||||
|                 uri += base[1:] | ||||
|             else: | ||||
|                 uri += base | ||||
|  | ||||
|         return uri[1:] if uri.startswith("//") else uri | ||||
|  | ||||
|     @staticmethod | ||||
|     def register_futures( | ||||
|         apps: Set[Sanic], bp: Blueprint, futures: Sequence[Tuple[Any, ...]] | ||||
|     ): | ||||
|         for app in apps: | ||||
|             app._future_registry.update(set((bp, item) for item in futures)) | ||||
|  | ||||
|     def pre_register( | ||||
|         self, | ||||
|         name: Union[str, Default], | ||||
|         url_prefix: Optional[str] = None, | ||||
|         host: Optional[Union[List[str], str]] = None, | ||||
|         version: Optional[Union[int, str, float]] = None, | ||||
|         strict_slashes: Optional[bool] = None, | ||||
|         version_prefix: Union[str, Default] = _default, | ||||
|     ) -> None: | ||||
|         if not hasattr(self.ctx, "_prereg"): | ||||
|             self.ctx._prereg = [] | ||||
|         self.ctx._prereg.append(name) | ||||
|         self.__class__.__pre_registry__[name].append( | ||||
|             { | ||||
|                 k: v | ||||
|                 for k, v in { | ||||
|                     "bp": self, | ||||
|                     "url_prefix": url_prefix, | ||||
|                     "host": host, | ||||
|                     "version": version, | ||||
|                     "strict_slashes": strict_slashes, | ||||
|                     "version_prefix": version_prefix, | ||||
|                 }.items() | ||||
|                 if v is not None and v is not _default | ||||
|             } | ||||
|         ) | ||||
|   | ||||
							
								
								
									
										148
									
								
								sanic/cli/app.py
									
									
									
									
									
								
							
							
						
						
									
										148
									
								
								sanic/cli/app.py
									
									
									
									
									
								
							| @@ -1,20 +1,19 @@ | ||||
| import logging | ||||
| import os | ||||
| import shutil | ||||
| import sys | ||||
|  | ||||
| from argparse import ArgumentParser, RawTextHelpFormatter | ||||
| from importlib import import_module | ||||
| from pathlib import Path | ||||
| from functools import partial | ||||
| from textwrap import indent | ||||
| from typing import Any, List, Union | ||||
|  | ||||
| from sanic.app import Sanic | ||||
| from sanic.application.logo import get_logo | ||||
| from sanic.blueprints import Blueprint | ||||
| from sanic.cli.arguments import Group | ||||
| from sanic.helpers import _default | ||||
| from sanic.log import error_logger | ||||
| from sanic.simple import create_simple_server | ||||
| from sanic.worker.inspector import inspect | ||||
| from sanic.worker.loader import AppLoader | ||||
|  | ||||
|  | ||||
| class SanicArgumentParser(ArgumentParser): | ||||
| @@ -22,7 +21,6 @@ class SanicArgumentParser(ArgumentParser): | ||||
|  | ||||
|  | ||||
| class SanicCLI: | ||||
|     DEFAULT_APP_NAME = "SANIC" | ||||
|     DESCRIPTION = indent( | ||||
|         f""" | ||||
| {get_logo(True)} | ||||
| @@ -61,35 +59,73 @@ Or, a path to a directory to run as a simple HTTP server: | ||||
|             os.environ.get("SANIC_RELOADER_PROCESS", "") != "true" | ||||
|         ) | ||||
|         self.args: List[Any] = [] | ||||
|         self.groups: List[Group] = [] | ||||
|  | ||||
|     def attach(self): | ||||
|         for group in Group._registry: | ||||
|             group.create(self.parser).attach() | ||||
|             instance = group.create(self.parser) | ||||
|             instance.attach() | ||||
|             self.groups.append(instance) | ||||
|  | ||||
|     def run(self): | ||||
|     def run(self, parse_args=None): | ||||
|         legacy_version = False | ||||
|         if not parse_args: | ||||
|             # This is to provide backwards compat -v to display version | ||||
|             legacy_version = len(sys.argv) == 2 and sys.argv[-1] == "-v" | ||||
|             parse_args = ["--version"] if legacy_version else None | ||||
|         elif parse_args == ["-v"]: | ||||
|             parse_args = ["--version"] | ||||
|  | ||||
|         if not legacy_version: | ||||
|             parsed, unknown = self.parser.parse_known_args(args=parse_args) | ||||
|             if unknown and parsed.factory: | ||||
|                 for arg in unknown: | ||||
|                     if arg.startswith("--"): | ||||
|                         self.parser.add_argument(arg.split("=")[0]) | ||||
|  | ||||
|         self.args = self.parser.parse_args(args=parse_args) | ||||
|         self._precheck() | ||||
|  | ||||
|         try: | ||||
|             app = self._get_app() | ||||
|             kwargs = self._build_run_kwargs() | ||||
|             app.run(**kwargs) | ||||
|         except ValueError: | ||||
|             error_logger.exception("Failed to run app") | ||||
|  | ||||
|     def _precheck(self): | ||||
|         if self.args.debug and self.main_process: | ||||
|             error_logger.warning( | ||||
|                 "Starting in v22.3, --debug will no " | ||||
|                 "longer automatically run the auto-reloader.\n  Switch to " | ||||
|                 "--dev to continue using that functionality." | ||||
|         app_loader = AppLoader( | ||||
|             self.args.module, | ||||
|             self.args.factory, | ||||
|             self.args.simple, | ||||
|             self.args, | ||||
|         ) | ||||
|  | ||||
|         # # Custom TLS mismatch handling for better diagnostics | ||||
|         try: | ||||
|             app = self._get_app(app_loader) | ||||
|             kwargs = self._build_run_kwargs() | ||||
|         except ValueError as 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: | ||||
|                 for http_version in self.args.http: | ||||
|                     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: | ||||
|                 serve = Sanic.serve_single | ||||
|             elif self.args.legacy: | ||||
|                 serve = Sanic.serve_legacy | ||||
|             else: | ||||
|                 serve = partial(Sanic.serve, app_loader=app_loader) | ||||
|             serve(app) | ||||
|  | ||||
|     def _precheck(self): | ||||
|         # Custom TLS mismatch handling for better diagnostics | ||||
|         if self.main_process and ( | ||||
|             # one of cert/key missing | ||||
|             bool(self.args.cert) != bool(self.args.key) | ||||
| @@ -109,58 +145,27 @@ Or, a path to a directory to run as a simple HTTP server: | ||||
|             ) | ||||
|             error_logger.error(message) | ||||
|             sys.exit(1) | ||||
|         if self.args.inspect or self.args.inspect_raw: | ||||
|             logging.disable(logging.CRITICAL) | ||||
|  | ||||
|     def _get_app(self): | ||||
|     def _get_app(self, app_loader: AppLoader): | ||||
|         try: | ||||
|             module_path = os.path.abspath(os.getcwd()) | ||||
|             if module_path not in sys.path: | ||||
|                 sys.path.append(module_path) | ||||
|  | ||||
|             if self.args.simple: | ||||
|                 path = Path(self.args.module) | ||||
|                 app = create_simple_server(path) | ||||
|             else: | ||||
|                 delimiter = ":" if ":" in self.args.module else "." | ||||
|                 module_name, app_name = self.args.module.rsplit(delimiter, 1) | ||||
|  | ||||
|                 if app_name.endswith("()"): | ||||
|                     self.args.factory = True | ||||
|                     app_name = app_name[:-2] | ||||
|  | ||||
|                 module = import_module(module_name) | ||||
|                 app = getattr(module, app_name, None) | ||||
|                 if self.args.factory: | ||||
|                     app = app() | ||||
|  | ||||
|                 app_type_name = type(app).__name__ | ||||
|  | ||||
|                 if isinstance(app, Blueprint): | ||||
|                     bp = app | ||||
|                     name = ( | ||||
|                         bp.ctx._prereg[0] | ||||
|                         if hasattr(bp.ctx, "_prereg") | ||||
|                         else _default | ||||
|                     ) | ||||
|                     if name is _default: | ||||
|                         name = self.DEFAULT_APP_NAME | ||||
|                     app = Sanic(name) | ||||
|                 elif not isinstance(app, Sanic): | ||||
|                     raise ValueError( | ||||
|                         f"Module is not a Sanic app, it is a {app_type_name}\n" | ||||
|                         f"  Perhaps you meant {self.args.module}.app?" | ||||
|                     ) | ||||
|             app = app_loader.load() | ||||
|         except ImportError as e: | ||||
|             if module_name.startswith(e.name): | ||||
|             if app_loader.module_name.startswith(e.name):  # type: ignore | ||||
|                 error_logger.error( | ||||
|                     f"No module named {e.name} found.\n" | ||||
|                     "  Example File: project/sanic_server.py -> app\n" | ||||
|                     "  Example Module: project.sanic_server.app" | ||||
|                 ) | ||||
|                 sys.exit(1) | ||||
|             else: | ||||
|                 raise e | ||||
|         return app | ||||
|  | ||||
|     def _build_run_kwargs(self): | ||||
|         for group in self.groups: | ||||
|             group.prepare(self.args) | ||||
|         ssl: Union[None, dict, str, list] = [] | ||||
|         if self.args.tlshost: | ||||
|             ssl.append(None) | ||||
| @@ -173,8 +178,10 @@ Or, a path to a directory to run as a simple HTTP server: | ||||
|         elif len(ssl) == 1 and ssl[0] is not None: | ||||
|             # Use only one cert, no TLSSelector. | ||||
|             ssl = ssl[0] | ||||
|  | ||||
|         kwargs = { | ||||
|             "access_log": self.args.access_log, | ||||
|             "coffee": self.args.coffee, | ||||
|             "debug": self.args.debug, | ||||
|             "fast": self.args.fast, | ||||
|             "host": self.args.host, | ||||
| @@ -185,18 +192,17 @@ Or, a path to a directory to run as a simple HTTP server: | ||||
|             "unix": self.args.unix, | ||||
|             "verbosity": self.args.verbosity or 0, | ||||
|             "workers": self.args.workers, | ||||
|             "auto_tls": self.args.auto_tls, | ||||
|             "single_process": self.args.single, | ||||
|             "legacy": self.args.legacy, | ||||
|         } | ||||
|  | ||||
|         if self.args.auto_reload: | ||||
|             kwargs["auto_reload"] = True | ||||
|         for maybe_arg in ("auto_reload", "dev"): | ||||
|             if getattr(self.args, maybe_arg, False): | ||||
|                 kwargs[maybe_arg] = True | ||||
|  | ||||
|         if self.args.path: | ||||
|             if self.args.auto_reload or self.args.debug: | ||||
|             kwargs["auto_reload"] = True | ||||
|             kwargs["reload_dir"] = self.args.path | ||||
|             else: | ||||
|                 error_logger.warning( | ||||
|                     "Ignoring '--reload-dir' since auto reloading was not " | ||||
|                     "enabled. If you would like to watch directories for " | ||||
|                     "changes, consider using --debug or --auto-reload." | ||||
|                 ) | ||||
|  | ||||
|         return kwargs | ||||
|   | ||||
| @@ -3,9 +3,10 @@ from __future__ import annotations | ||||
| from argparse import ArgumentParser, _ArgumentGroup | ||||
| from typing import List, Optional, Type, Union | ||||
|  | ||||
| from sanic_routing import __version__ as __routing_version__  # type: ignore | ||||
| from sanic_routing import __version__ as __routing_version__ | ||||
|  | ||||
| from sanic import __version__ | ||||
| from sanic.http.constants import HTTP | ||||
|  | ||||
|  | ||||
| class Group: | ||||
| @@ -29,7 +30,7 @@ class Group: | ||||
|         instance = cls(parser, cls.name) | ||||
|         return instance | ||||
|  | ||||
|     def add_bool_arguments(self, *args, **kwargs): | ||||
|     def add_bool_arguments(self, *args, nullable=False, **kwargs): | ||||
|         group = self.container.add_mutually_exclusive_group() | ||||
|         kwargs["help"] = kwargs["help"].capitalize() | ||||
|         group.add_argument(*args, action="store_true", **kwargs) | ||||
| @@ -37,6 +38,12 @@ class Group: | ||||
|         group.add_argument( | ||||
|             "--no-" + args[0][2:], *args[1:], action="store_false", **kwargs | ||||
|         ) | ||||
|         if nullable: | ||||
|             params = {args[0][2:].replace("-", "_"): None} | ||||
|             group.set_defaults(**params) | ||||
|  | ||||
|     def prepare(self, args) -> None: | ||||
|         ... | ||||
|  | ||||
|  | ||||
| class GeneralGroup(Group): | ||||
| @@ -63,7 +70,8 @@ class ApplicationGroup(Group): | ||||
|     name = "Application" | ||||
|  | ||||
|     def attach(self): | ||||
|         self.container.add_argument( | ||||
|         group = self.container.add_mutually_exclusive_group() | ||||
|         group.add_argument( | ||||
|             "--factory", | ||||
|             action="store_true", | ||||
|             help=( | ||||
| @@ -71,7 +79,7 @@ class ApplicationGroup(Group): | ||||
|                 "i.e. a () -> <Sanic app> callable" | ||||
|             ), | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
|         group.add_argument( | ||||
|             "-s", | ||||
|             "--simple", | ||||
|             dest="simple", | ||||
| @@ -81,6 +89,70 @@ class ApplicationGroup(Group): | ||||
|                 "a directory\n(module arg should be a path)" | ||||
|             ), | ||||
|         ) | ||||
|         group.add_argument( | ||||
|             "--inspect", | ||||
|             dest="inspect", | ||||
|             action="store_true", | ||||
|             help=("Inspect the state of a running instance, human readable"), | ||||
|         ) | ||||
|         group.add_argument( | ||||
|             "--inspect-raw", | ||||
|             dest="inspect_raw", | ||||
|             action="store_true", | ||||
|             help=("Inspect the state of a running instance, JSON output"), | ||||
|         ) | ||||
|         group.add_argument( | ||||
|             "--trigger-reload", | ||||
|             dest="trigger", | ||||
|             action="store_const", | ||||
|             const="reload", | ||||
|             help=("Trigger worker processes to reload"), | ||||
|         ) | ||||
|         group.add_argument( | ||||
|             "--trigger-shutdown", | ||||
|             dest="trigger", | ||||
|             action="store_const", | ||||
|             const="shutdown", | ||||
|             help=("Trigger all processes to shutdown"), | ||||
|         ) | ||||
|  | ||||
|  | ||||
| class HTTPVersionGroup(Group): | ||||
|     name = "HTTP version" | ||||
|  | ||||
|     def attach(self): | ||||
|         http_values = [http.value for http in HTTP.__members__.values()] | ||||
|  | ||||
|         self.container.add_argument( | ||||
|             "--http", | ||||
|             dest="http", | ||||
|             action="append", | ||||
|             choices=http_values, | ||||
|             type=int, | ||||
|             help=( | ||||
|                 "Which HTTP version to use: HTTP/1.1 or HTTP/3. Value should\n" | ||||
|                 "be either 1, or 3. [default 1]" | ||||
|             ), | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
|             "-1", | ||||
|             dest="http", | ||||
|             action="append_const", | ||||
|             const=1, | ||||
|             help=("Run Sanic server using HTTP/1.1"), | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
|             "-3", | ||||
|             dest="http", | ||||
|             action="append_const", | ||||
|             const=3, | ||||
|             help=("Run Sanic server using HTTP/3"), | ||||
|         ) | ||||
|  | ||||
|     def prepare(self, args): | ||||
|         if not args.http: | ||||
|             args.http = [1] | ||||
|         args.http = tuple(sorted(set(map(HTTP, args.http)), reverse=True)) | ||||
|  | ||||
|  | ||||
| class SocketGroup(Group): | ||||
| @@ -92,7 +164,6 @@ class SocketGroup(Group): | ||||
|             "--host", | ||||
|             dest="host", | ||||
|             type=str, | ||||
|             default="127.0.0.1", | ||||
|             help="Host address [default 127.0.0.1]", | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
| @@ -100,7 +171,6 @@ class SocketGroup(Group): | ||||
|             "--port", | ||||
|             dest="port", | ||||
|             type=int, | ||||
|             default=8000, | ||||
|             help="Port to serve on [default 8000]", | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
| @@ -167,8 +237,22 @@ class WorkerGroup(Group): | ||||
|             action="store_true", | ||||
|             help="Set the number of workers to max allowed", | ||||
|         ) | ||||
|         group.add_argument( | ||||
|             "--single-process", | ||||
|             dest="single", | ||||
|             action="store_true", | ||||
|             help="Do not use multiprocessing, run server in a single process", | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
|             "--legacy", | ||||
|             action="store_true", | ||||
|             help="Use the legacy server manager", | ||||
|         ) | ||||
|         self.add_bool_arguments( | ||||
|             "--access-logs", dest="access_log", help="display access logs" | ||||
|             "--access-logs", | ||||
|             dest="access_log", | ||||
|             help="display access logs", | ||||
|             default=None, | ||||
|         ) | ||||
|  | ||||
|  | ||||
| @@ -182,18 +266,6 @@ class DevelopmentGroup(Group): | ||||
|             action="store_true", | ||||
|             help="Run the server in debug mode", | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
|             "-d", | ||||
|             "--dev", | ||||
|             dest="debug", | ||||
|             action="store_true", | ||||
|             help=( | ||||
|                 "Currently is an alias for --debug. But starting in v22.3, \n" | ||||
|                 "--debug will no longer automatically trigger auto_restart. \n" | ||||
|                 "However, --dev will continue, effectively making it the \n" | ||||
|                 "same as debug + auto_reload." | ||||
|             ), | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
|             "-r", | ||||
|             "--reload", | ||||
| @@ -212,12 +284,34 @@ class DevelopmentGroup(Group): | ||||
|             action="append", | ||||
|             help="Extra directories to watch and reload on changes", | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
|             "-d", | ||||
|             "--dev", | ||||
|             dest="dev", | ||||
|             action="store_true", | ||||
|             help=("debug + auto reload"), | ||||
|         ) | ||||
|         self.container.add_argument( | ||||
|             "--auto-tls", | ||||
|             dest="auto_tls", | ||||
|             action="store_true", | ||||
|             help=( | ||||
|                 "Create a temporary TLS certificate for local development " | ||||
|                 "(requires mkcert or trustme)" | ||||
|             ), | ||||
|         ) | ||||
|  | ||||
|  | ||||
| class OutputGroup(Group): | ||||
|     name = "Output" | ||||
|  | ||||
|     def attach(self): | ||||
|         self.add_bool_arguments( | ||||
|             "--coffee", | ||||
|             dest="coffee", | ||||
|             default=False, | ||||
|             help="Uhm, coffee?", | ||||
|         ) | ||||
|         self.add_bool_arguments( | ||||
|             "--motd", | ||||
|             dest="motd", | ||||
|   | ||||
| @@ -1,13 +1,48 @@ | ||||
| import asyncio | ||||
| import os | ||||
| import signal | ||||
| import sys | ||||
|  | ||||
| from sys import argv | ||||
| from enum import Enum | ||||
| from typing import Awaitable | ||||
|  | ||||
| from multidict import CIMultiDict  # type: ignore | ||||
|  | ||||
|  | ||||
| OS_IS_WINDOWS = os.name == "nt" | ||||
| UVLOOP_INSTALLED = False | ||||
|  | ||||
| try: | ||||
|     import uvloop  # type: ignore # noqa | ||||
|  | ||||
|     UVLOOP_INSTALLED = True | ||||
| except ImportError: | ||||
|     pass | ||||
|  | ||||
|  | ||||
| # 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: | ||||
|     from enum import StrEnum  # type: ignore # noqa | ||||
|  | ||||
|  | ||||
| class UpperStrEnum(StrEnum): | ||||
|     def _generate_next_value_(name, start, count, last_values): | ||||
|         return name.upper() | ||||
|  | ||||
|     def __eq__(self, value: object) -> bool: | ||||
|         value = str(value).upper() | ||||
|         return super().__eq__(value) | ||||
|  | ||||
|     def __hash__(self) -> int: | ||||
|         return hash(self.value) | ||||
|  | ||||
|     def __str__(self) -> str: | ||||
|         return self.value | ||||
|  | ||||
|  | ||||
| def enable_windows_color_support(): | ||||
| @@ -39,12 +74,12 @@ class Header(CIMultiDict): | ||||
|         return self.getall(key, default=[]) | ||||
|  | ||||
|  | ||||
| use_trio = argv[0].endswith("hypercorn") and "trio" in argv | ||||
| use_trio = sys.argv[0].endswith("hypercorn") and "trio" in sys.argv | ||||
|  | ||||
| if use_trio:  # pragma: no cover | ||||
|     import trio  # type: ignore | ||||
|  | ||||
|     def stat_async(path): | ||||
|     def stat_async(path) -> Awaitable[os.stat_result]: | ||||
|         return trio.Path(path).stat() | ||||
|  | ||||
|     open_async = trio.open_file | ||||
| @@ -64,7 +99,7 @@ def ctrlc_workaround_for_windows(app): | ||||
|         """Asyncio wakeups to allow receiving SIGINT in Python""" | ||||
|         while not die: | ||||
|             # If someone else stopped the app, just exit | ||||
|             if app.is_stopping: | ||||
|             if app.state.is_stopping: | ||||
|                 return | ||||
|             # Windows Python blocks signal handlers while the event loop is | ||||
|             # waiting for I/O. Frequent wakeups keep interrupts flowing. | ||||
| @@ -81,3 +116,7 @@ def ctrlc_workaround_for_windows(app): | ||||
|     die = False | ||||
|     signal.signal(signal.SIGINT, ctrlc_handler) | ||||
|     app.add_task(stay_active) | ||||
|  | ||||
|  | ||||
| def is_atty() -> bool: | ||||
|     return bool(sys.stdout and sys.stdout.isatty()) | ||||
|   | ||||
							
								
								
									
										223
									
								
								sanic/config.py
									
									
									
									
									
								
							
							
						
						
									
										223
									
								
								sanic/config.py
									
									
									
									
									
								
							| @@ -1,74 +1,121 @@ | ||||
| from __future__ import annotations | ||||
|  | ||||
| from inspect import isclass | ||||
| import sys | ||||
|  | ||||
| from inspect import getmembers, isclass, isdatadescriptor | ||||
| from os import environ | ||||
| from pathlib import Path | ||||
| from typing import TYPE_CHECKING, Any, Dict, Optional, Union | ||||
| from warnings import warn | ||||
| from typing import Any, Callable, Dict, Optional, Sequence, Union | ||||
| from warnings import filterwarnings | ||||
|  | ||||
| from sanic.errorpages import check_error_format | ||||
| from sanic.constants import LocalCertCreator, RestartOrder | ||||
| from sanic.errorpages import DEFAULT_FORMAT, check_error_format | ||||
| from sanic.helpers import Default, _default | ||||
| from sanic.http import Http | ||||
| from sanic.log import error_logger | ||||
| from sanic.utils import load_module_from_file_location, str_to_bool | ||||
|  | ||||
|  | ||||
| if TYPE_CHECKING:  # no cov | ||||
|     from sanic import Sanic | ||||
| if sys.version_info >= (3, 8): | ||||
|     from typing import Literal | ||||
|  | ||||
|     FilterWarningType = Union[ | ||||
|         Literal["default"], | ||||
|         Literal["error"], | ||||
|         Literal["ignore"], | ||||
|         Literal["always"], | ||||
|         Literal["module"], | ||||
|         Literal["once"], | ||||
|     ] | ||||
| else: | ||||
|     FilterWarningType = str | ||||
|  | ||||
| SANIC_PREFIX = "SANIC_" | ||||
|  | ||||
|  | ||||
| DEFAULT_CONFIG = { | ||||
|     "ACCESS_LOG": True, | ||||
|     "_FALLBACK_ERROR_FORMAT": _default, | ||||
|     "ACCESS_LOG": False, | ||||
|     "AUTO_EXTEND": True, | ||||
|     "AUTO_RELOAD": False, | ||||
|     "EVENT_AUTOREGISTER": False, | ||||
|     "FALLBACK_ERROR_FORMAT": "auto", | ||||
|     "DEPRECATION_FILTER": "once", | ||||
|     "FORWARDED_FOR_HEADER": "X-Forwarded-For", | ||||
|     "FORWARDED_SECRET": None, | ||||
|     "GRACEFUL_SHUTDOWN_TIMEOUT": 15.0,  # 15 sec | ||||
|     "INSPECTOR": False, | ||||
|     "INSPECTOR_HOST": "localhost", | ||||
|     "INSPECTOR_PORT": 6457, | ||||
|     "KEEP_ALIVE_TIMEOUT": 5,  # 5 seconds | ||||
|     "KEEP_ALIVE": True, | ||||
|     "LOCAL_CERT_CREATOR": LocalCertCreator.AUTO, | ||||
|     "LOCAL_TLS_KEY": _default, | ||||
|     "LOCAL_TLS_CERT": _default, | ||||
|     "LOCALHOST": "localhost", | ||||
|     "MOTD": True, | ||||
|     "MOTD_DISPLAY": {}, | ||||
|     "NOISY_EXCEPTIONS": False, | ||||
|     "PROXIES_COUNT": None, | ||||
|     "REAL_IP_HEADER": None, | ||||
|     "REGISTER": True, | ||||
|     "REQUEST_BUFFER_SIZE": 65536,  # 64 KiB | ||||
|     "REQUEST_MAX_HEADER_SIZE": 8192,  # 8 KiB, but cannot exceed 16384 | ||||
|     "REQUEST_ID_HEADER": "X-Request-ID", | ||||
|     "REQUEST_MAX_SIZE": 100000000,  # 100 megabytes | ||||
|     "REQUEST_TIMEOUT": 60,  # 60 seconds | ||||
|     "RESPONSE_TIMEOUT": 60,  # 60 seconds | ||||
|     "WEBSOCKET_MAX_SIZE": 2 ** 20,  # 1 megabyte | ||||
|     "RESTART_ORDER": RestartOrder.SHUTDOWN_FIRST, | ||||
|     "TLS_CERT_PASSWORD": "", | ||||
|     "TOUCHUP": _default, | ||||
|     "USE_UVLOOP": _default, | ||||
|     "WEBSOCKET_MAX_SIZE": 2**20,  # 1 megabyte | ||||
|     "WEBSOCKET_PING_INTERVAL": 20, | ||||
|     "WEBSOCKET_PING_TIMEOUT": 20, | ||||
| } | ||||
|  | ||||
|  | ||||
| class Config(dict): | ||||
| class DescriptorMeta(type): | ||||
|     def __init__(cls, *_): | ||||
|         cls.__setters__ = {name for name, _ in getmembers(cls, cls._is_setter)} | ||||
|  | ||||
|     @staticmethod | ||||
|     def _is_setter(member: object): | ||||
|         return isdatadescriptor(member) and hasattr(member, "setter") | ||||
|  | ||||
|  | ||||
| class Config(dict, metaclass=DescriptorMeta): | ||||
|     ACCESS_LOG: bool | ||||
|     AUTO_EXTEND: bool | ||||
|     AUTO_RELOAD: bool | ||||
|     EVENT_AUTOREGISTER: bool | ||||
|     FALLBACK_ERROR_FORMAT: str | ||||
|     DEPRECATION_FILTER: FilterWarningType | ||||
|     FORWARDED_FOR_HEADER: str | ||||
|     FORWARDED_SECRET: Optional[str] | ||||
|     GRACEFUL_SHUTDOWN_TIMEOUT: float | ||||
|     INSPECTOR: bool | ||||
|     INSPECTOR_HOST: str | ||||
|     INSPECTOR_PORT: int | ||||
|     KEEP_ALIVE_TIMEOUT: int | ||||
|     KEEP_ALIVE: bool | ||||
|     NOISY_EXCEPTIONS: bool | ||||
|     LOCAL_CERT_CREATOR: Union[str, LocalCertCreator] | ||||
|     LOCAL_TLS_KEY: Union[Path, str, Default] | ||||
|     LOCAL_TLS_CERT: Union[Path, str, Default] | ||||
|     LOCALHOST: str | ||||
|     MOTD: bool | ||||
|     MOTD_DISPLAY: Dict[str, str] | ||||
|     NOISY_EXCEPTIONS: bool | ||||
|     PROXIES_COUNT: Optional[int] | ||||
|     REAL_IP_HEADER: Optional[str] | ||||
|     REGISTER: bool | ||||
|     REQUEST_BUFFER_SIZE: int | ||||
|     REQUEST_MAX_HEADER_SIZE: int | ||||
|     REQUEST_ID_HEADER: str | ||||
|     REQUEST_MAX_SIZE: int | ||||
|     REQUEST_TIMEOUT: int | ||||
|     RESPONSE_TIMEOUT: int | ||||
|     RESTART_ORDER: Union[str, RestartOrder] | ||||
|     SERVER_NAME: str | ||||
|     TLS_CERT_PASSWORD: str | ||||
|     TOUCHUP: Union[Default, bool] | ||||
|     USE_UVLOOP: Union[Default, bool] | ||||
|     WEBSOCKET_MAX_SIZE: int | ||||
|     WEBSOCKET_PING_INTERVAL: int | ||||
|     WEBSOCKET_PING_TIMEOUT: int | ||||
| @@ -76,17 +123,20 @@ class Config(dict): | ||||
|     def __init__( | ||||
|         self, | ||||
|         defaults: Dict[str, Union[str, bool, int, float, None]] = None, | ||||
|         load_env: Optional[Union[bool, str]] = True, | ||||
|         env_prefix: Optional[str] = SANIC_PREFIX, | ||||
|         keep_alive: Optional[bool] = None, | ||||
|         *, | ||||
|         app: Optional[Sanic] = None, | ||||
|         converters: Optional[Sequence[Callable[[str], Any]]] = None, | ||||
|     ): | ||||
|         defaults = defaults or {} | ||||
|         super().__init__({**DEFAULT_CONFIG, **defaults}) | ||||
|         self._configure_warnings() | ||||
|  | ||||
|         self._app = app | ||||
|         self._LOGO = "" | ||||
|         self._converters = [str, str_to_bool, float, int] | ||||
|  | ||||
|         if converters: | ||||
|             for converter in converters: | ||||
|                 self.register_type(converter) | ||||
|  | ||||
|         if keep_alive is not None: | ||||
|             self.KEEP_ALIVE = keep_alive | ||||
| @@ -94,15 +144,6 @@ class Config(dict): | ||||
|         if env_prefix != SANIC_PREFIX: | ||||
|             if env_prefix: | ||||
|                 self.load_environment_vars(env_prefix) | ||||
|         elif load_env is not True: | ||||
|             if load_env: | ||||
|                 self.load_environment_vars(prefix=load_env) | ||||
|             warn( | ||||
|                 "Use of load_env is deprecated and will be removed in " | ||||
|                 "21.12. Modify the configuration prefix by passing " | ||||
|                 "env_prefix instead.", | ||||
|                 DeprecationWarning, | ||||
|             ) | ||||
|         else: | ||||
|             self.load_environment_vars(SANIC_PREFIX) | ||||
|  | ||||
| @@ -110,22 +151,34 @@ class Config(dict): | ||||
|         self._check_error_format() | ||||
|         self._init = True | ||||
|  | ||||
|     def __getattr__(self, attr): | ||||
|     def __getattr__(self, attr: Any): | ||||
|         try: | ||||
|             return self[attr] | ||||
|         except KeyError as ke: | ||||
|             raise AttributeError(f"Config has no '{ke.args[0]}'") | ||||
|  | ||||
|     def __setattr__(self, attr, value) -> None: | ||||
|     def __setattr__(self, attr: str, value: Any) -> None: | ||||
|         self.update({attr: value}) | ||||
|  | ||||
|     def __setitem__(self, attr, value) -> None: | ||||
|     def __setitem__(self, attr: str, value: Any) -> None: | ||||
|         self.update({attr: value}) | ||||
|  | ||||
|     def update(self, *other, **kwargs) -> None: | ||||
|         other_mapping = {k: v for item in other for k, v in dict(item).items()} | ||||
|         super().update(*other, **kwargs) | ||||
|         for attr, value in {**other_mapping, **kwargs}.items(): | ||||
|     def update(self, *other: Any, **kwargs: Any) -> None: | ||||
|         kwargs.update({k: v for item in other for k, v in dict(item).items()}) | ||||
|         setters: Dict[str, Any] = { | ||||
|             k: kwargs.pop(k) | ||||
|             for k in {**kwargs}.keys() | ||||
|             if k in self.__class__.__setters__ | ||||
|         } | ||||
|  | ||||
|         for key, value in setters.items(): | ||||
|             try: | ||||
|                 super().__setattr__(key, value) | ||||
|             except AttributeError: | ||||
|                 ... | ||||
|  | ||||
|         super().update(**kwargs) | ||||
|         for attr, value in {**setters, **kwargs}.items(): | ||||
|             self._post_set(attr, value) | ||||
|  | ||||
|     def _post_set(self, attr, value) -> None: | ||||
| @@ -136,31 +189,38 @@ class Config(dict): | ||||
|                 "REQUEST_MAX_SIZE", | ||||
|             ): | ||||
|                 self._configure_header_size() | ||||
|             elif attr == "FALLBACK_ERROR_FORMAT": | ||||
|                 self._check_error_format() | ||||
|                 if self.app and value != self.app.error_handler.fallback: | ||||
|                     if self.app.error_handler.fallback != "auto": | ||||
|                         warn( | ||||
|                             "Overriding non-default ErrorHandler fallback " | ||||
|                             "value. Changing from " | ||||
|                             f"{self.app.error_handler.fallback} to {value}." | ||||
|                         ) | ||||
|                     self.app.error_handler.fallback = value | ||||
|             elif attr == "LOGO": | ||||
|                 self._LOGO = value | ||||
|                 warn( | ||||
|                     "Setting the config.LOGO is deprecated and will no longer " | ||||
|                     "be supported starting in v22.6.", | ||||
|                     DeprecationWarning, | ||||
|                 ) | ||||
|  | ||||
|         if attr == "LOCAL_CERT_CREATOR" and not isinstance( | ||||
|             self.LOCAL_CERT_CREATOR, LocalCertCreator | ||||
|         ): | ||||
|             self.LOCAL_CERT_CREATOR = LocalCertCreator[ | ||||
|                 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": | ||||
|             self._configure_warnings() | ||||
|  | ||||
|     @property | ||||
|     def app(self): | ||||
|         return self._app | ||||
|     def FALLBACK_ERROR_FORMAT(self) -> str: | ||||
|         if isinstance(self._FALLBACK_ERROR_FORMAT, Default): | ||||
|             return DEFAULT_FORMAT | ||||
|         return self._FALLBACK_ERROR_FORMAT | ||||
|  | ||||
|     @property | ||||
|     def LOGO(self): | ||||
|         return self._LOGO | ||||
|     @FALLBACK_ERROR_FORMAT.setter | ||||
|     def FALLBACK_ERROR_FORMAT(self, value): | ||||
|         self._check_error_format(value) | ||||
|         if ( | ||||
|             not isinstance(self._FALLBACK_ERROR_FORMAT, Default) | ||||
|             and value != self._FALLBACK_ERROR_FORMAT | ||||
|         ): | ||||
|             error_logger.warning( | ||||
|                 "Setting config.FALLBACK_ERROR_FORMAT on an already " | ||||
|                 "configured value may have unintended consequences." | ||||
|             ) | ||||
|         self._FALLBACK_ERROR_FORMAT = value | ||||
|  | ||||
|     def _configure_header_size(self): | ||||
|         Http.set_header_max_size( | ||||
| @@ -169,14 +229,23 @@ class Config(dict): | ||||
|             self.REQUEST_MAX_SIZE, | ||||
|         ) | ||||
|  | ||||
|     def _check_error_format(self): | ||||
|         check_error_format(self.FALLBACK_ERROR_FORMAT) | ||||
|     def _configure_warnings(self): | ||||
|         filterwarnings( | ||||
|             self.DEPRECATION_FILTER, | ||||
|             category=DeprecationWarning, | ||||
|             module=r"sanic.*", | ||||
|         ) | ||||
|  | ||||
|     def _check_error_format(self, format: Optional[str] = None): | ||||
|         check_error_format(format or self.FALLBACK_ERROR_FORMAT) | ||||
|  | ||||
|     def load_environment_vars(self, prefix=SANIC_PREFIX): | ||||
|         """ | ||||
|         Looks for prefixed environment variables and applies them to the | ||||
|         configuration if present. This is called automatically when Sanic | ||||
|         starts up to load environment variables into config. | ||||
|         starts up to load environment variables into config. Environment | ||||
|         variables should start with the defined prefix and should only | ||||
|         contain uppercase letters. | ||||
|  | ||||
|         It will automatically hydrate the following types: | ||||
|  | ||||
| @@ -184,15 +253,31 @@ class Config(dict): | ||||
|         - ``float`` | ||||
|         - ``bool`` | ||||
|  | ||||
|         Anything else will be imported as a ``str``. | ||||
|         Anything else will be imported as a ``str``. If you would like to add | ||||
|         additional types to this list, you can use | ||||
|         :meth:`sanic.config.Config.register_type`. Just make sure that they | ||||
|         are registered before you instantiate your application. | ||||
|  | ||||
|         .. code-block:: python | ||||
|  | ||||
|             class Foo: | ||||
|                 def __init__(self, name) -> None: | ||||
|                     self.name = name | ||||
|  | ||||
|  | ||||
|             config = Config(converters=[Foo]) | ||||
|             app = Sanic(__name__, config=config) | ||||
|  | ||||
|         `See user guide re: config | ||||
|         <https://sanicframework.org/guide/deployment/configuration.html>`__ | ||||
|         """ | ||||
|         for key, value in environ.items(): | ||||
|             if not key.startswith(prefix): | ||||
|             if not key.startswith(prefix) or not key.isupper(): | ||||
|                 continue | ||||
|  | ||||
|             _, config_key = key.split(prefix, 1) | ||||
|  | ||||
|             for converter in (int, float, str_to_bool, str): | ||||
|             for converter in reversed(self._converters): | ||||
|                 try: | ||||
|                     self[config_key] = converter(value) | ||||
|                     break | ||||
| @@ -267,3 +352,17 @@ class Config(dict): | ||||
|         self.update(config) | ||||
|  | ||||
|     load = update_config | ||||
|  | ||||
|     def register_type(self, converter: Callable[[str], Any]) -> None: | ||||
|         """ | ||||
|         Allows for adding custom function to cast from a string value to any | ||||
|         other type. The function should raise ValueError if it is not the | ||||
|         correct type. | ||||
|         """ | ||||
|         if converter in self._converters: | ||||
|             error_logger.warning( | ||||
|                 f"Configuration value converter '{converter.__name__}' has " | ||||
|                 "already been registered" | ||||
|             ) | ||||
|             return | ||||
|         self._converters.append(converter) | ||||
|   | ||||
| @@ -1,19 +1,9 @@ | ||||
| from enum import Enum, auto | ||||
| from enum import auto | ||||
|  | ||||
| from sanic.compat import UpperStrEnum | ||||
|  | ||||
|  | ||||
| class HTTPMethod(str, Enum): | ||||
|     def _generate_next_value_(name, start, count, last_values): | ||||
|         return name.upper() | ||||
|  | ||||
|     def __eq__(self, value: object) -> bool: | ||||
|         value = str(value).upper() | ||||
|         return super().__eq__(value) | ||||
|  | ||||
|     def __hash__(self) -> int: | ||||
|         return hash(self.value) | ||||
|  | ||||
|     def __str__(self) -> str: | ||||
|         return self.value | ||||
| class HTTPMethod(UpperStrEnum): | ||||
|  | ||||
|     GET = auto() | ||||
|     POST = auto() | ||||
| @@ -24,5 +14,29 @@ class HTTPMethod(str, Enum): | ||||
|     DELETE = auto() | ||||
|  | ||||
|  | ||||
| class LocalCertCreator(UpperStrEnum): | ||||
|  | ||||
|     AUTO = auto() | ||||
|     TRUSTME = auto() | ||||
|     MKCERT = auto() | ||||
|  | ||||
|  | ||||
| class RestartOrder(UpperStrEnum): | ||||
|  | ||||
|     SHUTDOWN_FIRST = auto() | ||||
|     STARTUP_FIRST = auto() | ||||
|  | ||||
|  | ||||
| HTTP_METHODS = tuple(HTTPMethod.__members__.values()) | ||||
| SAFE_HTTP_METHODS = (HTTPMethod.GET, HTTPMethod.HEAD, HTTPMethod.OPTIONS) | ||||
| IDEMPOTENT_HTTP_METHODS = ( | ||||
|     HTTPMethod.GET, | ||||
|     HTTPMethod.HEAD, | ||||
|     HTTPMethod.PUT, | ||||
|     HTTPMethod.DELETE, | ||||
|     HTTPMethod.OPTIONS, | ||||
| ) | ||||
| CACHEABLE_HTTP_METHODS = (HTTPMethod.GET, HTTPMethod.HEAD) | ||||
| DEFAULT_HTTP_CONTENT_TYPE = "application/octet-stream" | ||||
| DEFAULT_LOCAL_TLS_KEY = "key.pem" | ||||
| DEFAULT_LOCAL_TLS_CERT = "cert.pem" | ||||
|   | ||||
| @@ -19,7 +19,7 @@ import typing as t | ||||
| from functools import partial | ||||
| from traceback import extract_tb | ||||
|  | ||||
| from sanic.exceptions import InvalidUsage, SanicException | ||||
| from sanic.exceptions import BadRequest, SanicException | ||||
| from sanic.helpers import STATUS_CODES | ||||
| from sanic.request import Request | ||||
| from sanic.response import HTTPResponse, html, json, text | ||||
| @@ -34,6 +34,7 @@ except ImportError:  # noqa | ||||
|     from json import dumps | ||||
|  | ||||
|  | ||||
| DEFAULT_FORMAT = "auto" | ||||
| FALLBACK_TEXT = ( | ||||
|     "The server encountered an internal error and " | ||||
|     "cannot complete your request." | ||||
| @@ -447,8 +448,8 @@ def exception_response( | ||||
|             # from the route | ||||
|             if request.route: | ||||
|                 try: | ||||
|                     if request.route.ctx.error_format: | ||||
|                         render_format = request.route.ctx.error_format | ||||
|                     if request.route.extra.error_format: | ||||
|                         render_format = request.route.extra.error_format | ||||
|                 except AttributeError: | ||||
|                     ... | ||||
|  | ||||
| @@ -505,7 +506,7 @@ def exception_response( | ||||
|                         # $ curl localhost:8000 -d '{"foo": "bar"}' | ||||
|                         # And provide them with JSONRenderer | ||||
|                         renderer = JSONRenderer if request.json else base | ||||
|                     except InvalidUsage: | ||||
|                     except BadRequest: | ||||
|                         renderer = base | ||||
|             else: | ||||
|                 renderer = RENDERERS_BY_CONFIG.get(render_format, renderer) | ||||
|   | ||||
| @@ -1,8 +1,17 @@ | ||||
| from asyncio import CancelledError | ||||
| from typing import Any, Dict, Optional, Union | ||||
|  | ||||
| from sanic.helpers import STATUS_CODES | ||||
|  | ||||
|  | ||||
| class RequestCancelled(CancelledError): | ||||
|     quiet = True | ||||
|  | ||||
|  | ||||
| class ServerKilled(Exception): | ||||
|     ... | ||||
|  | ||||
|  | ||||
| class SanicException(Exception): | ||||
|     message: str = "" | ||||
|  | ||||
| @@ -42,7 +51,7 @@ class NotFound(SanicException): | ||||
|     quiet = True | ||||
|  | ||||
|  | ||||
| class InvalidUsage(SanicException): | ||||
| class BadRequest(SanicException): | ||||
|     """ | ||||
|     **Status**: 400 Bad Request | ||||
|     """ | ||||
| @@ -51,7 +60,14 @@ class InvalidUsage(SanicException): | ||||
|     quiet = True | ||||
|  | ||||
|  | ||||
| class MethodNotSupported(SanicException): | ||||
| InvalidUsage = BadRequest | ||||
|  | ||||
|  | ||||
| class BadURL(BadRequest): | ||||
|     ... | ||||
|  | ||||
|  | ||||
| class MethodNotAllowed(SanicException): | ||||
|     """ | ||||
|     **Status**: 405 Method Not Allowed | ||||
|     """ | ||||
| @@ -64,6 +80,9 @@ class MethodNotSupported(SanicException): | ||||
|         self.headers = {"Allow": ", ".join(allowed_methods)} | ||||
|  | ||||
|  | ||||
| MethodNotSupported = MethodNotAllowed | ||||
|  | ||||
|  | ||||
| class ServerError(SanicException): | ||||
|     """ | ||||
|     **Status**: 500 Internal Server Error | ||||
| @@ -125,19 +144,19 @@ class PayloadTooLarge(SanicException): | ||||
|     quiet = True | ||||
|  | ||||
|  | ||||
| class HeaderNotFound(InvalidUsage): | ||||
| class HeaderNotFound(BadRequest): | ||||
|     """ | ||||
|     **Status**: 400 Bad Request | ||||
|     """ | ||||
|  | ||||
|  | ||||
| class InvalidHeader(InvalidUsage): | ||||
| class InvalidHeader(BadRequest): | ||||
|     """ | ||||
|     **Status**: 400 Bad Request | ||||
|     """ | ||||
|  | ||||
|  | ||||
| class ContentRangeError(SanicException): | ||||
| class RangeNotSatisfiable(SanicException): | ||||
|     """ | ||||
|     **Status**: 416 Range Not Satisfiable | ||||
|     """ | ||||
| @@ -150,7 +169,10 @@ class ContentRangeError(SanicException): | ||||
|         self.headers = {"Content-Range": f"bytes */{content_range.total}"} | ||||
|  | ||||
|  | ||||
| class HeaderExpectationFailed(SanicException): | ||||
| ContentRangeError = RangeNotSatisfiable | ||||
|  | ||||
|  | ||||
| class ExpectationFailed(SanicException): | ||||
|     """ | ||||
|     **Status**: 417 Expectation Failed | ||||
|     """ | ||||
| @@ -159,6 +181,9 @@ class HeaderExpectationFailed(SanicException): | ||||
|     quiet = True | ||||
|  | ||||
|  | ||||
| HeaderExpectationFailed = ExpectationFailed | ||||
|  | ||||
|  | ||||
| class Forbidden(SanicException): | ||||
|     """ | ||||
|     **Status**: 403 Forbidden | ||||
| @@ -168,7 +193,7 @@ class Forbidden(SanicException): | ||||
|     quiet = True | ||||
|  | ||||
|  | ||||
| class InvalidRangeType(ContentRangeError): | ||||
| class InvalidRangeType(RangeNotSatisfiable): | ||||
|     """ | ||||
|     **Status**: 416 Range Not Satisfiable | ||||
|     """ | ||||
| @@ -244,25 +269,3 @@ class InvalidSignal(SanicException): | ||||
| class WebsocketClosed(SanicException): | ||||
|     quiet = True | ||||
|     message = "Client has closed the websocket connection" | ||||
|  | ||||
|  | ||||
| def abort(status_code: int, message: Optional[Union[str, bytes]] = None): | ||||
|     """ | ||||
|     Raise an exception based on SanicException. Returns the HTTP response | ||||
|     message appropriate for the given status code, unless provided. | ||||
|  | ||||
|     STATUS_CODES from sanic.helpers for the given status code. | ||||
|  | ||||
|     :param status_code: The HTTP status code to return. | ||||
|     :param message: The HTTP response body. Defaults to the messages in | ||||
|     """ | ||||
|     import warnings | ||||
|  | ||||
|     warnings.warn( | ||||
|         "sanic.exceptions.abort has been marked as deprecated, and will be " | ||||
|         "removed in release 21.12.\n To migrate your code, simply replace " | ||||
|         "abort(status_code, msg) with raise SanicException(msg, status_code), " | ||||
|         "or even better, raise an appropriate SanicException subclass." | ||||
|     ) | ||||
|  | ||||
|     raise SanicException(message=message, status_code=status_code) | ||||
|   | ||||
| @@ -1,14 +1,14 @@ | ||||
| from inspect import signature | ||||
| from typing import Dict, List, Optional, Tuple, Type | ||||
| from warnings import warn | ||||
| from __future__ import annotations | ||||
|  | ||||
| from sanic.errorpages import BaseRenderer, HTMLRenderer, exception_response | ||||
| from typing import Dict, List, Optional, Tuple, Type | ||||
|  | ||||
| from sanic.errorpages import BaseRenderer, TextRenderer, exception_response | ||||
| from sanic.exceptions import ( | ||||
|     ContentRangeError, | ||||
|     HeaderNotFound, | ||||
|     InvalidRangeType, | ||||
|     RangeNotSatisfiable, | ||||
| ) | ||||
| from sanic.log import error_logger | ||||
| from sanic.log import deprecation, error_logger | ||||
| from sanic.models.handler_types import RouteHandler | ||||
| from sanic.response import text | ||||
|  | ||||
| @@ -26,51 +26,48 @@ class ErrorHandler: | ||||
|  | ||||
|     """ | ||||
|  | ||||
|     # Beginning in v22.3, the base renderer will be TextRenderer | ||||
|     def __init__( | ||||
|         self, fallback: str = "auto", base: Type[BaseRenderer] = HTMLRenderer | ||||
|         self, | ||||
|         base: Type[BaseRenderer] = TextRenderer, | ||||
|     ): | ||||
|         self.handlers: List[Tuple[Type[BaseException], RouteHandler]] = [] | ||||
|         self.cached_handlers: Dict[ | ||||
|             Tuple[Type[BaseException], Optional[str]], Optional[RouteHandler] | ||||
|         ] = {} | ||||
|         self.debug = False | ||||
|         self.fallback = fallback | ||||
|         self.base = base | ||||
|  | ||||
|     @classmethod | ||||
|     def finalize(cls, error_handler, fallback: Optional[str] = None): | ||||
|         if ( | ||||
|             fallback | ||||
|             and fallback != "auto" | ||||
|             and error_handler.fallback == "auto" | ||||
|         ): | ||||
|             error_handler.fallback = fallback | ||||
|  | ||||
|         if not isinstance(error_handler, cls): | ||||
|             error_logger.warning( | ||||
|                 f"Error handler is non-conforming: {type(error_handler)}" | ||||
|     def finalize(cls, *args, **kwargs): | ||||
|         deprecation( | ||||
|             "ErrorHandler.finalize is deprecated and no longer needed. " | ||||
|             "Please remove update your code to remove it. ", | ||||
|             22.12, | ||||
|         ) | ||||
|  | ||||
|         sig = signature(error_handler.lookup) | ||||
|         if len(sig.parameters) == 1: | ||||
|             warn( | ||||
|                 "You are using a deprecated error handler. The lookup " | ||||
|                 "method should accept two positional parameters: " | ||||
|                 "(exception, route_name: Optional[str]). " | ||||
|                 "Until you upgrade your ErrorHandler.lookup, Blueprint " | ||||
|                 "specific exceptions will not work properly. Beginning " | ||||
|                 "in v22.3, the legacy style lookup method will not " | ||||
|                 "work at all.", | ||||
|                 DeprecationWarning, | ||||
|             ) | ||||
|             error_handler._lookup = error_handler._legacy_lookup | ||||
|  | ||||
|     def _full_lookup(self, exception, route_name: Optional[str] = None): | ||||
|         return self.lookup(exception, route_name) | ||||
|  | ||||
|     def _legacy_lookup(self, exception, route_name: Optional[str] = None): | ||||
|         return self.lookup(exception) | ||||
|     def _add( | ||||
|         self, | ||||
|         key: Tuple[Type[BaseException], Optional[str]], | ||||
|         handler: RouteHandler, | ||||
|     ) -> None: | ||||
|         if key in self.cached_handlers: | ||||
|             exc, name = key | ||||
|             if name is None: | ||||
|                 name = "__ALL_ROUTES__" | ||||
|  | ||||
|             error_logger.warning( | ||||
|                 f"Duplicate exception handler definition on: route={name} " | ||||
|                 f"and exception={exc}" | ||||
|             ) | ||||
|             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 | ||||
|  | ||||
|     def add(self, exception, handler, route_names: Optional[List[str]] = None): | ||||
|         """ | ||||
| @@ -85,14 +82,11 @@ class ErrorHandler: | ||||
|  | ||||
|         :return: None | ||||
|         """ | ||||
|         # self.handlers is deprecated and will be removed in version 22.3 | ||||
|         self.handlers.append((exception, handler)) | ||||
|  | ||||
|         if route_names: | ||||
|             for route in route_names: | ||||
|                 self.cached_handlers[(exception, route)] = handler | ||||
|                 self._add((exception, route), handler) | ||||
|         else: | ||||
|             self.cached_handlers[(exception, None)] = handler | ||||
|             self._add((exception, None), handler) | ||||
|  | ||||
|     def lookup(self, exception, route_name: Optional[str] = None): | ||||
|         """ | ||||
| @@ -159,7 +153,7 @@ class ErrorHandler: | ||||
|         except Exception: | ||||
|             try: | ||||
|                 url = repr(request.url) | ||||
|             except AttributeError: | ||||
|             except AttributeError:  # no cov | ||||
|                 url = "unknown" | ||||
|             response_message = ( | ||||
|                 "Exception raised in exception handler " '"%s" for uri: %s' | ||||
| @@ -188,12 +182,13 @@ class ErrorHandler: | ||||
|         :return: | ||||
|         """ | ||||
|         self.log(request, exception) | ||||
|         fallback = request.app.config.FALLBACK_ERROR_FORMAT | ||||
|         return exception_response( | ||||
|             request, | ||||
|             exception, | ||||
|             debug=self.debug, | ||||
|             base=self.base, | ||||
|             fallback=self.fallback, | ||||
|             fallback=fallback, | ||||
|         ) | ||||
|  | ||||
|     @staticmethod | ||||
| @@ -203,7 +198,7 @@ class ErrorHandler: | ||||
|         if quiet is False or noisy is True: | ||||
|             try: | ||||
|                 url = repr(request.url) | ||||
|             except AttributeError: | ||||
|             except AttributeError:  # no cov | ||||
|                 url = "unknown" | ||||
|  | ||||
|             error_logger.exception( | ||||
| @@ -246,18 +241,18 @@ class ContentRangeHandler: | ||||
|         try: | ||||
|             self.start = int(start_b) if start_b else None | ||||
|         except ValueError: | ||||
|             raise ContentRangeError( | ||||
|             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 ContentRangeError( | ||||
|             raise RangeNotSatisfiable( | ||||
|                 "'%s' is invalid for Content Range" % (end_b,), self | ||||
|             ) | ||||
|         if self.end is None: | ||||
|             if self.start is None: | ||||
|                 raise ContentRangeError( | ||||
|                 raise RangeNotSatisfiable( | ||||
|                     "Invalid for Content Range parameters", self | ||||
|                 ) | ||||
|             else: | ||||
| @@ -269,7 +264,7 @@ class ContentRangeHandler: | ||||
|                 self.start = self.total - self.end | ||||
|                 self.end = self.total - 1 | ||||
|         if self.start >= self.end: | ||||
|             raise ContentRangeError( | ||||
|             raise RangeNotSatisfiable( | ||||
|                 "Invalid for Content Range parameters", self | ||||
|             ) | ||||
|         self.size = self.end - self.start + 1 | ||||
|   | ||||
| @@ -2,7 +2,7 @@ from __future__ import annotations | ||||
|  | ||||
| import re | ||||
|  | ||||
| from typing import Any, Dict, Iterable, List, Optional, Tuple, Union | ||||
| from typing import Any, Dict, Iterable, List, Optional, Set, Tuple, Union | ||||
| from urllib.parse import unquote | ||||
|  | ||||
| from sanic.exceptions import InvalidHeader | ||||
| @@ -18,7 +18,7 @@ Options = Dict[str, Union[int, str]]  # key=value fields in various headers | ||||
| OptionsIterable = Iterable[Tuple[str, str]]  # May contain duplicate keys | ||||
|  | ||||
| _token, _quoted = r"([\w!#$%&'*+\-.^_`|~]+)", r'"([^"]*)"' | ||||
| _param = re.compile(fr";\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_re = re.compile(_ipv6) | ||||
| @@ -394,3 +394,17 @@ def parse_accept(accept: str) -> AcceptContainer: | ||||
|     return AcceptContainer( | ||||
|         sorted(accept_list, key=_sort_accept_value, reverse=True) | ||||
|     ) | ||||
|  | ||||
|  | ||||
| def parse_credentials( | ||||
|     header: Optional[str], | ||||
|     prefixes: Union[List, Tuple, Set] = None, | ||||
| ) -> Tuple[Optional[str], Optional[str]]: | ||||
|     """Parses any header with the aim to retrieve any credentials from it.""" | ||||
|     if not prefixes or not isinstance(prefixes, (list, tuple, set)): | ||||
|         prefixes = ("Basic", "Bearer", "Token") | ||||
|     if header is not None: | ||||
|         for prefix in prefixes: | ||||
|             if prefix in header: | ||||
|                 return prefix, header.partition(prefix)[-1].strip() | ||||
|     return None, header | ||||
|   | ||||
							
								
								
									
										6
									
								
								sanic/http/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										6
									
								
								sanic/http/__init__.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,6 @@ | ||||
| from .constants import Stage | ||||
| from .http1 import Http | ||||
| from .http3 import Http3 | ||||
|  | ||||
|  | ||||
| __all__ = ("Http", "Stage", "Http3") | ||||
							
								
								
									
										29
									
								
								sanic/http/constants.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								sanic/http/constants.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,29 @@ | ||||
| from enum import Enum, IntEnum | ||||
|  | ||||
|  | ||||
| class Stage(Enum): | ||||
|     """ | ||||
|     Enum for representing the stage of the request/response cycle | ||||
|  | ||||
|     | ``IDLE``  Waiting for request | ||||
|     | ``REQUEST``  Request headers being received | ||||
|     | ``HANDLER``  Headers done, handler running | ||||
|     | ``RESPONSE``  Response headers sent, body in progress | ||||
|     | ``FAILED``  Unrecoverable state (error while sending response) | ||||
|     | | ||||
|     """ | ||||
|  | ||||
|     IDLE = 0  # Waiting for request | ||||
|     REQUEST = 1  # Request headers being received | ||||
|     HANDLER = 3  # Headers done, handler running | ||||
|     RESPONSE = 4  # Response headers sent, body in progress | ||||
|     FAILED = 100  # Unrecoverable state (error while sending response) | ||||
|  | ||||
|  | ||||
| class HTTP(IntEnum): | ||||
|     VERSION_1 = 1 | ||||
|     VERSION_3 = 3 | ||||
|  | ||||
|     def display(self) -> str: | ||||
|         value = 1.1 if self.value == 1 else self.value | ||||
|         return f"HTTP/{value}" | ||||
| @@ -8,66 +8,48 @@ if TYPE_CHECKING: | ||||
|     from sanic.response import BaseHTTPResponse | ||||
| 
 | ||||
| from asyncio import CancelledError, sleep | ||||
| from enum import Enum | ||||
| 
 | ||||
| from sanic.compat import Header | ||||
| from sanic.exceptions import ( | ||||
|     HeaderExpectationFailed, | ||||
|     InvalidUsage, | ||||
|     BadRequest, | ||||
|     ExpectationFailed, | ||||
|     PayloadTooLarge, | ||||
|     RequestCancelled, | ||||
|     ServerError, | ||||
|     ServiceUnavailable, | ||||
| ) | ||||
| from sanic.headers import format_http1_response | ||||
| from sanic.helpers import has_message_body | ||||
| from sanic.http.constants import Stage | ||||
| from sanic.http.stream import Stream | ||||
| from sanic.log import access_logger, error_logger, logger | ||||
| from sanic.touchup import TouchUpMeta | ||||
| 
 | ||||
| 
 | ||||
| class Stage(Enum): | ||||
|     """ | ||||
|     Enum for representing the stage of the request/response cycle | ||||
| 
 | ||||
|     | ``IDLE``  Waiting for request | ||||
|     | ``REQUEST``  Request headers being received | ||||
|     | ``HANDLER``  Headers done, handler running | ||||
|     | ``RESPONSE``  Response headers sent, body in progress | ||||
|     | ``FAILED``  Unrecoverable state (error while sending response) | ||||
|     | | ||||
|     """ | ||||
| 
 | ||||
|     IDLE = 0  # Waiting for request | ||||
|     REQUEST = 1  # Request headers being received | ||||
|     HANDLER = 3  # Headers done, handler running | ||||
|     RESPONSE = 4  # Response headers sent, body in progress | ||||
|     FAILED = 100  # Unrecoverable state (error while sending response) | ||||
| 
 | ||||
| 
 | ||||
| HTTP_CONTINUE = b"HTTP/1.1 100 Continue\r\n\r\n" | ||||
| 
 | ||||
| 
 | ||||
| class Http(metaclass=TouchUpMeta): | ||||
| class Http(Stream, metaclass=TouchUpMeta): | ||||
|     """ | ||||
|     Internal helper for managing the HTTP request/response cycle | ||||
|     Internal helper for managing the HTTP/1.1 request/response cycle | ||||
| 
 | ||||
|     :raises ServerError: | ||||
|     :raises PayloadTooLarge: | ||||
|     :raises Exception: | ||||
|     :raises InvalidUsage: | ||||
|     :raises HeaderExpectationFailed: | ||||
|     :raises BadRequest: | ||||
|     :raises ExpectationFailed: | ||||
|     :raises RuntimeError: | ||||
|     :raises ServerError: | ||||
|     :raises ServerError: | ||||
|     :raises InvalidUsage: | ||||
|     :raises InvalidUsage: | ||||
|     :raises InvalidUsage: | ||||
|     :raises BadRequest: | ||||
|     :raises BadRequest: | ||||
|     :raises BadRequest: | ||||
|     :raises PayloadTooLarge: | ||||
|     :raises RuntimeError: | ||||
|     """ | ||||
| 
 | ||||
|     HEADER_CEILING = 16_384 | ||||
|     HEADER_MAX_SIZE = 0 | ||||
| 
 | ||||
|     __touchup__ = ( | ||||
|         "http1_request_header", | ||||
|         "http1_response_header", | ||||
| @@ -151,7 +133,7 @@ class Http(metaclass=TouchUpMeta): | ||||
| 
 | ||||
|                 if self.stage is Stage.RESPONSE: | ||||
|                     await self.response.send(end_stream=True) | ||||
|             except CancelledError: | ||||
|             except CancelledError as exc: | ||||
|                 # Write an appropriate response before exiting | ||||
|                 if not self.protocol.transport: | ||||
|                     logger.info( | ||||
| @@ -159,7 +141,11 @@ class Http(metaclass=TouchUpMeta): | ||||
|                         "stopped. Transport is closed." | ||||
|                     ) | ||||
|                     return | ||||
|                 e = self.exception or ServiceUnavailable("Cancelled") | ||||
|                 e = ( | ||||
|                     RequestCancelled() | ||||
|                     if self.protocol.conn_info.lost | ||||
|                     else (self.exception or exc) | ||||
|                 ) | ||||
|                 self.exception = None | ||||
|                 self.keep_alive = False | ||||
|                 await self.error_response(e) | ||||
| @@ -248,7 +234,7 @@ class Http(metaclass=TouchUpMeta): | ||||
| 
 | ||||
|                 headers.append(h) | ||||
|         except Exception: | ||||
|             raise InvalidUsage("Bad Request") | ||||
|             raise BadRequest("Bad Request") | ||||
| 
 | ||||
|         headers_instance = Header(headers) | ||||
|         self.upgrade_websocket = ( | ||||
| @@ -265,6 +251,7 @@ class Http(metaclass=TouchUpMeta): | ||||
|             transport=self.protocol.transport, | ||||
|             app=self.protocol.app, | ||||
|         ) | ||||
|         self.protocol.request_class._current.set(request) | ||||
|         await self.dispatch( | ||||
|             "http.lifecycle.request", | ||||
|             inline=True, | ||||
| @@ -281,7 +268,7 @@ class Http(metaclass=TouchUpMeta): | ||||
|                 if expect.lower() == "100-continue": | ||||
|                     self.expecting_continue = True | ||||
|                 else: | ||||
|                     raise HeaderExpectationFailed(f"Unknown Expect: {expect}") | ||||
|                     raise ExpectationFailed(f"Unknown Expect: {expect}") | ||||
| 
 | ||||
|             if headers.getone("transfer-encoding", None) == "chunked": | ||||
|                 self.request_body = "chunked" | ||||
| @@ -352,6 +339,12 @@ class Http(metaclass=TouchUpMeta): | ||||
|             self.response_func = self.head_response_ignored | ||||
| 
 | ||||
|         headers["connection"] = "keep-alive" if self.keep_alive else "close" | ||||
| 
 | ||||
|         # This header may be removed or modified by the AltSvcCheck Touchup | ||||
|         # service. At server start, we either remove this header from ever | ||||
|         # being assigned, or we change the value as required. | ||||
|         headers["alt-svc"] = "" | ||||
| 
 | ||||
|         ret = format_http1_response(status, res.processed_headers) | ||||
|         if data: | ||||
|             ret += data | ||||
| @@ -436,7 +429,13 @@ class Http(metaclass=TouchUpMeta): | ||||
|             if self.request is None: | ||||
|                 self.create_empty_request() | ||||
| 
 | ||||
|             await app.handle_exception(self.request, exception) | ||||
|             request_middleware = not isinstance(exception, ServiceUnavailable) | ||||
|             try: | ||||
|                 await app.handle_exception( | ||||
|                     self.request, exception, request_middleware | ||||
|                 ) | ||||
|             except Exception as e: | ||||
|                 await app.handle_exception(self.request, e, False) | ||||
| 
 | ||||
|     def create_empty_request(self) -> None: | ||||
|         """ | ||||
| @@ -510,7 +509,7 @@ class Http(metaclass=TouchUpMeta): | ||||
| 
 | ||||
|                 if len(buf) > 64: | ||||
|                     self.keep_alive = False | ||||
|                     raise InvalidUsage("Bad chunked encoding") | ||||
|                     raise BadRequest("Bad chunked encoding") | ||||
| 
 | ||||
|                 await self._receive_more() | ||||
| 
 | ||||
| @@ -518,14 +517,14 @@ class Http(metaclass=TouchUpMeta): | ||||
|                 size = int(buf[2:pos].split(b";", 1)[0].decode(), 16) | ||||
|             except Exception: | ||||
|                 self.keep_alive = False | ||||
|                 raise InvalidUsage("Bad chunked encoding") | ||||
|                 raise BadRequest("Bad chunked encoding") | ||||
| 
 | ||||
|             if size <= 0: | ||||
|                 self.request_body = None | ||||
| 
 | ||||
|                 if size < 0: | ||||
|                     self.keep_alive = False | ||||
|                     raise InvalidUsage("Bad chunked encoding") | ||||
|                     raise BadRequest("Bad chunked encoding") | ||||
| 
 | ||||
|                 # Consume CRLF, chunk size 0 and the two CRLF that follow | ||||
|                 pos += 4 | ||||
							
								
								
									
										406
									
								
								sanic/http/http3.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										406
									
								
								sanic/http/http3.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,406 @@ | ||||
| from __future__ import annotations | ||||
|  | ||||
| import asyncio | ||||
|  | ||||
| from abc import ABC, abstractmethod | ||||
| from ssl import SSLContext | ||||
| from typing import ( | ||||
|     TYPE_CHECKING, | ||||
|     Any, | ||||
|     Callable, | ||||
|     Dict, | ||||
|     List, | ||||
|     Optional, | ||||
|     Tuple, | ||||
|     Union, | ||||
|     cast, | ||||
| ) | ||||
|  | ||||
| from sanic.compat import Header | ||||
| from sanic.constants import LocalCertCreator | ||||
| from sanic.exceptions import PayloadTooLarge, SanicException, ServerError | ||||
| from sanic.helpers import has_message_body | ||||
| from sanic.http.constants import Stage | ||||
| from sanic.http.stream import Stream | ||||
| from sanic.http.tls.context import CertSelector, SanicSSLContext | ||||
| from sanic.log import Colors, logger | ||||
| from sanic.models.protocol_types import TransportProtocol | ||||
| from sanic.models.server_types import ConnInfo | ||||
|  | ||||
|  | ||||
| try: | ||||
|     from aioquic.h0.connection import H0_ALPN, H0Connection | ||||
|     from aioquic.h3.connection import H3_ALPN, H3Connection | ||||
|     from aioquic.h3.events import ( | ||||
|         DatagramReceived, | ||||
|         DataReceived, | ||||
|         H3Event, | ||||
|         HeadersReceived, | ||||
|         WebTransportStreamDataReceived, | ||||
|     ) | ||||
|     from aioquic.quic.configuration import QuicConfiguration | ||||
|     from aioquic.tls import SessionTicket | ||||
|  | ||||
|     HTTP3_AVAILABLE = True | ||||
| except ModuleNotFoundError:  # no cov | ||||
|     HTTP3_AVAILABLE = False | ||||
|  | ||||
| if TYPE_CHECKING: | ||||
|     from sanic import Sanic | ||||
|     from sanic.request import Request | ||||
|     from sanic.response import BaseHTTPResponse | ||||
|     from sanic.server.protocols.http_protocol import Http3Protocol | ||||
|  | ||||
|     HttpConnection = Union[H0Connection, H3Connection] | ||||
|  | ||||
|  | ||||
| class HTTP3Transport(TransportProtocol): | ||||
|     __slots__ = ("_protocol",) | ||||
|  | ||||
|     def __init__(self, protocol: Http3Protocol): | ||||
|         self._protocol = protocol | ||||
|  | ||||
|     def get_protocol(self) -> Http3Protocol: | ||||
|         return self._protocol | ||||
|  | ||||
|     def get_extra_info(self, info: str, default: Any = None) -> Any: | ||||
|         if ( | ||||
|             info in ("socket", "sockname", "peername") | ||||
|             and self._protocol._transport | ||||
|         ): | ||||
|             return self._protocol._transport.get_extra_info(info, default) | ||||
|         elif info == "network_paths": | ||||
|             return self._protocol._quic._network_paths | ||||
|         elif info == "ssl_context": | ||||
|             return self._protocol.app.state.ssl | ||||
|         return default | ||||
|  | ||||
|  | ||||
| class Receiver(ABC): | ||||
|     future: asyncio.Future | ||||
|  | ||||
|     def __init__(self, transmit, protocol, request: Request) -> None: | ||||
|         self.transmit = transmit | ||||
|         self.protocol = protocol | ||||
|         self.request = request | ||||
|  | ||||
|     @abstractmethod | ||||
|     async def run(self):  # no cov | ||||
|         ... | ||||
|  | ||||
|  | ||||
| class HTTPReceiver(Receiver, Stream): | ||||
|     stage: Stage | ||||
|     request: Request | ||||
|  | ||||
|     def __init__(self, *args, **kwargs) -> None: | ||||
|         super().__init__(*args, **kwargs) | ||||
|         self.request_body = None | ||||
|         self.stage = Stage.IDLE | ||||
|         self.headers_sent = False | ||||
|         self.response: Optional[BaseHTTPResponse] = None | ||||
|         self.request_max_size = self.protocol.request_max_size | ||||
|         self.request_bytes = 0 | ||||
|  | ||||
|     async def run(self, exception: Optional[Exception] = None): | ||||
|         self.stage = Stage.HANDLER | ||||
|         self.head_only = self.request.method.upper() == "HEAD" | ||||
|  | ||||
|         if exception: | ||||
|             logger.info(  # no cov | ||||
|                 f"{Colors.BLUE}[exception]: " | ||||
|                 f"{Colors.RED}{exception}{Colors.END}", | ||||
|                 exc_info=True, | ||||
|                 extra={"verbosity": 1}, | ||||
|             ) | ||||
|             await self.error_response(exception) | ||||
|         else: | ||||
|             try: | ||||
|                 logger.info(  # no cov | ||||
|                     f"{Colors.BLUE}[request]:{Colors.END} {self.request}", | ||||
|                     extra={"verbosity": 1}, | ||||
|                 ) | ||||
|                 await self.protocol.request_handler(self.request) | ||||
|             except Exception as e:  # no cov | ||||
|                 # This should largely be handled within the request handler. | ||||
|                 # But, just in case... | ||||
|                 await self.run(e) | ||||
|         self.stage = Stage.IDLE | ||||
|  | ||||
|     async def error_response(self, exception: Exception) -> None: | ||||
|         """ | ||||
|         Handle response when exception encountered | ||||
|         """ | ||||
|         # From request and handler states we can respond, otherwise be silent | ||||
|         app = self.protocol.app | ||||
|  | ||||
|         await app.handle_exception(self.request, exception) | ||||
|  | ||||
|     def _prepare_headers( | ||||
|         self, response: BaseHTTPResponse | ||||
|     ) -> List[Tuple[bytes, bytes]]: | ||||
|         size = len(response.body) if response.body else 0 | ||||
|         headers = response.headers | ||||
|         status = response.status | ||||
|  | ||||
|         if not has_message_body(status) and ( | ||||
|             size | ||||
|             or "content-length" in headers | ||||
|             or "transfer-encoding" in headers | ||||
|         ): | ||||
|             headers.pop("content-length", None) | ||||
|             headers.pop("transfer-encoding", None) | ||||
|             logger.warning(  # no cov | ||||
|                 f"Message body set in response on {self.request.path}. " | ||||
|                 f"A {status} response may only have headers, no body." | ||||
|             ) | ||||
|         elif "content-length" not in headers: | ||||
|             if size: | ||||
|                 headers["content-length"] = size | ||||
|             else: | ||||
|                 headers["transfer-encoding"] = "chunked" | ||||
|  | ||||
|         headers = [ | ||||
|             (b":status", str(response.status).encode()), | ||||
|             *response.processed_headers, | ||||
|         ] | ||||
|         return headers | ||||
|  | ||||
|     def send_headers(self) -> None: | ||||
|         logger.debug(  # no cov | ||||
|             f"{Colors.BLUE}[send]: {Colors.GREEN}HEADERS{Colors.END}", | ||||
|             extra={"verbosity": 2}, | ||||
|         ) | ||||
|         if not self.response: | ||||
|             raise RuntimeError("no response") | ||||
|  | ||||
|         response = self.response | ||||
|         headers = self._prepare_headers(response) | ||||
|  | ||||
|         self.protocol.connection.send_headers( | ||||
|             stream_id=self.request.stream_id, | ||||
|             headers=headers, | ||||
|         ) | ||||
|         self.headers_sent = True | ||||
|         self.stage = Stage.RESPONSE | ||||
|  | ||||
|         if self.response.body and not self.head_only: | ||||
|             self._send(self.response.body, False) | ||||
|         elif self.head_only: | ||||
|             self.future.cancel() | ||||
|  | ||||
|     def respond(self, response: BaseHTTPResponse) -> BaseHTTPResponse: | ||||
|         logger.debug(  # no cov | ||||
|             f"{Colors.BLUE}[respond]:{Colors.END} {response}", | ||||
|             extra={"verbosity": 2}, | ||||
|         ) | ||||
|  | ||||
|         if self.stage is not Stage.HANDLER: | ||||
|             self.stage = Stage.FAILED | ||||
|             raise RuntimeError("Response already started") | ||||
|  | ||||
|         # Disconnect any earlier but unused response object | ||||
|         if self.response is not None: | ||||
|             self.response.stream = None | ||||
|  | ||||
|         self.response, response.stream = response, self | ||||
|  | ||||
|         return response | ||||
|  | ||||
|     def receive_body(self, data: bytes) -> None: | ||||
|         self.request_bytes += len(data) | ||||
|         if self.request_bytes > self.request_max_size: | ||||
|             raise PayloadTooLarge("Request body exceeds the size limit") | ||||
|  | ||||
|         self.request.body += data | ||||
|  | ||||
|     async def send(self, data: bytes, end_stream: bool) -> None: | ||||
|         logger.debug(  # no cov | ||||
|             f"{Colors.BLUE}[send]: {Colors.GREEN}data={data.decode()} " | ||||
|             f"end_stream={end_stream}{Colors.END}", | ||||
|             extra={"verbosity": 2}, | ||||
|         ) | ||||
|         self._send(data, end_stream) | ||||
|  | ||||
|     def _send(self, data: bytes, end_stream: bool) -> None: | ||||
|         if not self.headers_sent: | ||||
|             self.send_headers() | ||||
|         if self.stage is not Stage.RESPONSE: | ||||
|             raise ServerError(f"not ready to send: {self.stage}") | ||||
|  | ||||
|         # Chunked | ||||
|         if ( | ||||
|             self.response | ||||
|             and self.response.headers.get("transfer-encoding") == "chunked" | ||||
|         ): | ||||
|             size = len(data) | ||||
|             if end_stream: | ||||
|                 data = ( | ||||
|                     b"%x\r\n%b\r\n0\r\n\r\n" % (size, data) | ||||
|                     if size | ||||
|                     else b"0\r\n\r\n" | ||||
|                 ) | ||||
|             elif size: | ||||
|                 data = b"%x\r\n%b\r\n" % (size, data) | ||||
|  | ||||
|         logger.debug(  # no cov | ||||
|             f"{Colors.BLUE}[transmitting]{Colors.END}", | ||||
|             extra={"verbosity": 2}, | ||||
|         ) | ||||
|         self.protocol.connection.send_data( | ||||
|             stream_id=self.request.stream_id, | ||||
|             data=data, | ||||
|             end_stream=end_stream, | ||||
|         ) | ||||
|         self.transmit() | ||||
|  | ||||
|         if end_stream: | ||||
|             self.stage = Stage.IDLE | ||||
|  | ||||
|  | ||||
| class WebsocketReceiver(Receiver):  # noqa | ||||
|     async def run(self): | ||||
|         ... | ||||
|  | ||||
|  | ||||
| class WebTransportReceiver(Receiver):  # noqa | ||||
|     async def run(self): | ||||
|         ... | ||||
|  | ||||
|  | ||||
| class Http3: | ||||
|     """ | ||||
|     Internal helper for managing the HTTP/3 request/response cycle | ||||
|     """ | ||||
|  | ||||
|     if HTTP3_AVAILABLE: | ||||
|         HANDLER_PROPERTY_MAPPING = { | ||||
|             DataReceived: "stream_id", | ||||
|             HeadersReceived: "stream_id", | ||||
|             DatagramReceived: "flow_id", | ||||
|             WebTransportStreamDataReceived: "session_id", | ||||
|         } | ||||
|  | ||||
|     def __init__( | ||||
|         self, | ||||
|         protocol: Http3Protocol, | ||||
|         transmit: Callable[[], None], | ||||
|     ) -> None: | ||||
|         self.protocol = protocol | ||||
|         self.transmit = transmit | ||||
|         self.receivers: Dict[int, Receiver] = {} | ||||
|  | ||||
|     def http_event_received(self, event: H3Event) -> None: | ||||
|         logger.debug(  # no cov | ||||
|             f"{Colors.BLUE}[http_event_received]: " | ||||
|             f"{Colors.YELLOW}{event}{Colors.END}", | ||||
|             extra={"verbosity": 2}, | ||||
|         ) | ||||
|         receiver, created_new = self.get_or_make_receiver(event) | ||||
|         receiver = cast(HTTPReceiver, receiver) | ||||
|  | ||||
|         if isinstance(event, HeadersReceived) and created_new: | ||||
|             receiver.future = asyncio.ensure_future(receiver.run()) | ||||
|         elif isinstance(event, DataReceived): | ||||
|             try: | ||||
|                 receiver.receive_body(event.data) | ||||
|             except Exception as e: | ||||
|                 receiver.future.cancel() | ||||
|                 receiver.future = asyncio.ensure_future(receiver.run(e)) | ||||
|         else: | ||||
|             ...  # Intentionally here to help out Touchup | ||||
|             logger.debug(  # no cov | ||||
|                 f"{Colors.RED}DOING NOTHING{Colors.END}", | ||||
|                 extra={"verbosity": 2}, | ||||
|             ) | ||||
|  | ||||
|     def get_or_make_receiver(self, event: H3Event) -> Tuple[Receiver, bool]: | ||||
|         if ( | ||||
|             isinstance(event, HeadersReceived) | ||||
|             and event.stream_id not in self.receivers | ||||
|         ): | ||||
|             request = self._make_request(event) | ||||
|             receiver = HTTPReceiver(self.transmit, self.protocol, request) | ||||
|             request.stream = receiver | ||||
|  | ||||
|             self.receivers[event.stream_id] = receiver | ||||
|             return receiver, True | ||||
|         else: | ||||
|             ident = getattr(event, self.HANDLER_PROPERTY_MAPPING[type(event)]) | ||||
|             return self.receivers[ident], False | ||||
|  | ||||
|     def get_receiver_by_stream_id(self, stream_id: int) -> Receiver: | ||||
|         return self.receivers[stream_id] | ||||
|  | ||||
|     def _make_request(self, event: HeadersReceived) -> Request: | ||||
|         headers = Header(((k.decode(), v.decode()) for k, v in event.headers)) | ||||
|         method = headers[":method"] | ||||
|         path = headers[":path"] | ||||
|         scheme = headers.pop(":scheme", "") | ||||
|         authority = headers.pop(":authority", "") | ||||
|  | ||||
|         if authority: | ||||
|             headers["host"] = authority | ||||
|  | ||||
|         transport = HTTP3Transport(self.protocol) | ||||
|         request = self.protocol.request_class( | ||||
|             path.encode(), | ||||
|             headers, | ||||
|             "3", | ||||
|             method, | ||||
|             transport, | ||||
|             self.protocol.app, | ||||
|             b"", | ||||
|         ) | ||||
|         request.conn_info = ConnInfo(transport) | ||||
|         request._stream_id = event.stream_id | ||||
|         request._scheme = scheme | ||||
|  | ||||
|         return request | ||||
|  | ||||
|  | ||||
| class SessionTicketStore: | ||||
|     """ | ||||
|     Simple in-memory store for session tickets. | ||||
|     """ | ||||
|  | ||||
|     def __init__(self) -> None: | ||||
|         self.tickets: Dict[bytes, SessionTicket] = {} | ||||
|  | ||||
|     def add(self, ticket: SessionTicket) -> None: | ||||
|         self.tickets[ticket.ticket] = ticket | ||||
|  | ||||
|     def pop(self, label: bytes) -> Optional[SessionTicket]: | ||||
|         return self.tickets.pop(label, None) | ||||
|  | ||||
|  | ||||
| def get_config( | ||||
|     app: Sanic, ssl: Union[SanicSSLContext, CertSelector, SSLContext] | ||||
| ): | ||||
|     # TODO: | ||||
|     # - proper selection needed if service with multiple certs insted of | ||||
|     #   just taking the first | ||||
|     if isinstance(ssl, CertSelector): | ||||
|         ssl = cast(SanicSSLContext, ssl.sanic_select[0]) | ||||
|     if app.config.LOCAL_CERT_CREATOR is LocalCertCreator.TRUSTME: | ||||
|         raise SanicException( | ||||
|             "Sorry, you cannot currently use trustme as a local certificate " | ||||
|             "generator for an HTTP/3 server. This is not yet supported. You " | ||||
|             "should be able to use mkcert instead. For more information, see: " | ||||
|             "https://github.com/aiortc/aioquic/issues/295." | ||||
|         ) | ||||
|     if not isinstance(ssl, SanicSSLContext): | ||||
|         raise SanicException("SSLContext is not SanicSSLContext") | ||||
|  | ||||
|     config = QuicConfiguration( | ||||
|         alpn_protocols=H3_ALPN + H0_ALPN + ["siduck"], | ||||
|         is_client=False, | ||||
|         max_datagram_frame_size=65536, | ||||
|     ) | ||||
|     password = app.config.TLS_CERT_PASSWORD or None | ||||
|  | ||||
|     config.load_cert_chain( | ||||
|         ssl.sanic["cert"], ssl.sanic["key"], password=password | ||||
|     ) | ||||
|  | ||||
|     return config | ||||
							
								
								
									
										27
									
								
								sanic/http/stream.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								sanic/http/stream.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,27 @@ | ||||
| from __future__ import annotations | ||||
|  | ||||
| from typing import TYPE_CHECKING, Optional, Tuple, Union | ||||
|  | ||||
| from sanic.http.constants import Stage | ||||
|  | ||||
|  | ||||
| if TYPE_CHECKING: | ||||
|     from sanic.response import BaseHTTPResponse | ||||
|     from sanic.server.protocols.http_protocol import HttpProtocol | ||||
|  | ||||
|  | ||||
| class Stream: | ||||
|     stage: Stage | ||||
|     response: Optional[BaseHTTPResponse] | ||||
|     protocol: HttpProtocol | ||||
|     url: Optional[str] | ||||
|     request_body: Optional[bytes] | ||||
|     request_max_size: Union[int, float] | ||||
|  | ||||
|     __touchup__: Tuple[str, ...] = tuple() | ||||
|     __slots__ = () | ||||
|  | ||||
|     def respond( | ||||
|         self, response: BaseHTTPResponse | ||||
|     ) -> BaseHTTPResponse:  # no cov | ||||
|         raise NotImplementedError("Not implemented") | ||||
							
								
								
									
										5
									
								
								sanic/http/tls/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								sanic/http/tls/__init__.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,5 @@ | ||||
| from .context import process_to_context | ||||
| from .creators import get_ssl_context | ||||
|  | ||||
|  | ||||
| __all__ = ("get_ssl_context", "process_to_context") | ||||
| @@ -1,7 +1,9 @@ | ||||
| from __future__ import annotations | ||||
| 
 | ||||
| import os | ||||
| import ssl | ||||
| 
 | ||||
| from typing import Iterable, Optional, Union | ||||
| from typing import Any, Dict, Iterable, Optional, Union | ||||
| 
 | ||||
| from sanic.log import logger | ||||
| 
 | ||||
| @@ -77,65 +79,6 @@ def load_cert_dir(p: str) -> ssl.SSLContext: | ||||
|     return CertSimple(certfile, keyfile) | ||||
| 
 | ||||
| 
 | ||||
| class CertSimple(ssl.SSLContext): | ||||
|     """A wrapper for creating SSLContext with a sanic attribute.""" | ||||
| 
 | ||||
|     def __new__(cls, cert, key, **kw): | ||||
|         # try common aliases, rename to cert/key | ||||
|         certfile = kw["cert"] = kw.pop("certificate", None) or cert | ||||
|         keyfile = kw["key"] = kw.pop("keyfile", None) or key | ||||
|         password = kw.pop("password", None) | ||||
|         if not certfile or not keyfile: | ||||
|             raise ValueError("SSL dict needs filenames for cert and key.") | ||||
|         subject = {} | ||||
|         if "names" not in kw: | ||||
|             cert = ssl._ssl._test_decode_cert(certfile)  # type: ignore | ||||
|             kw["names"] = [ | ||||
|                 name | ||||
|                 for t, name in cert["subjectAltName"] | ||||
|                 if t in ["DNS", "IP Address"] | ||||
|             ] | ||||
|             subject = {k: v for item in cert["subject"] for k, v in item} | ||||
|         self = create_context(certfile, keyfile, password) | ||||
|         self.__class__ = cls | ||||
|         self.sanic = {**subject, **kw} | ||||
|         return self | ||||
| 
 | ||||
|     def __init__(self, cert, key, **kw): | ||||
|         pass  # Do not call super().__init__ because it is already initialized | ||||
| 
 | ||||
| 
 | ||||
| class CertSelector(ssl.SSLContext): | ||||
|     """Automatically select SSL certificate based on the hostname that the | ||||
|     client is trying to access, via SSL SNI. Paths to certificate folders | ||||
|     with privkey.pem and fullchain.pem in them should be provided, and | ||||
|     will be matched in the order given whenever there is a new connection. | ||||
|     """ | ||||
| 
 | ||||
|     def __new__(cls, ctxs): | ||||
|         return super().__new__(cls) | ||||
| 
 | ||||
|     def __init__(self, ctxs: Iterable[Optional[ssl.SSLContext]]): | ||||
|         super().__init__() | ||||
|         self.sni_callback = selector_sni_callback  # type: ignore | ||||
|         self.sanic_select = [] | ||||
|         self.sanic_fallback = None | ||||
|         all_names = [] | ||||
|         for i, ctx in enumerate(ctxs): | ||||
|             if not ctx: | ||||
|                 continue | ||||
|             names = dict(getattr(ctx, "sanic", {})).get("names", []) | ||||
|             all_names += names | ||||
|             self.sanic_select.append(ctx) | ||||
|             if i == 0: | ||||
|                 self.sanic_fallback = ctx | ||||
|         if not all_names: | ||||
|             raise ValueError( | ||||
|                 "No certificates with SubjectAlternativeNames found." | ||||
|             ) | ||||
|         logger.info(f"Certificate vhosts: {', '.join(all_names)}") | ||||
| 
 | ||||
| 
 | ||||
| def find_cert(self: CertSelector, server_name: str): | ||||
|     """Find the first certificate that matches the given SNI. | ||||
| 
 | ||||
| @@ -194,3 +137,73 @@ def server_name_callback( | ||||
| ) -> None: | ||||
|     """Store the received SNI as sslobj.sanic_server_name.""" | ||||
|     sslobj.sanic_server_name = server_name  # type: ignore | ||||
| 
 | ||||
| 
 | ||||
| class SanicSSLContext(ssl.SSLContext): | ||||
|     sanic: Dict[str, os.PathLike] | ||||
| 
 | ||||
|     @classmethod | ||||
|     def create_from_ssl_context(cls, context: ssl.SSLContext): | ||||
|         context.__class__ = cls | ||||
|         return context | ||||
| 
 | ||||
| 
 | ||||
| class CertSimple(SanicSSLContext): | ||||
|     """A wrapper for creating SSLContext with a sanic attribute.""" | ||||
| 
 | ||||
|     sanic: Dict[str, Any] | ||||
| 
 | ||||
|     def __new__(cls, cert, key, **kw): | ||||
|         # try common aliases, rename to cert/key | ||||
|         certfile = kw["cert"] = kw.pop("certificate", None) or cert | ||||
|         keyfile = kw["key"] = kw.pop("keyfile", None) or key | ||||
|         password = kw.pop("password", None) | ||||
|         if not certfile or not keyfile: | ||||
|             raise ValueError("SSL dict needs filenames for cert and key.") | ||||
|         subject = {} | ||||
|         if "names" not in kw: | ||||
|             cert = ssl._ssl._test_decode_cert(certfile)  # type: ignore | ||||
|             kw["names"] = [ | ||||
|                 name | ||||
|                 for t, name in cert["subjectAltName"] | ||||
|                 if t in ["DNS", "IP Address"] | ||||
|             ] | ||||
|             subject = {k: v for item in cert["subject"] for k, v in item} | ||||
|         self = create_context(certfile, keyfile, password) | ||||
|         self.__class__ = cls | ||||
|         self.sanic = {**subject, **kw} | ||||
|         return self | ||||
| 
 | ||||
|     def __init__(self, cert, key, **kw): | ||||
|         pass  # Do not call super().__init__ because it is already initialized | ||||
| 
 | ||||
| 
 | ||||
| class CertSelector(ssl.SSLContext): | ||||
|     """Automatically select SSL certificate based on the hostname that the | ||||
|     client is trying to access, via SSL SNI. Paths to certificate folders | ||||
|     with privkey.pem and fullchain.pem in them should be provided, and | ||||
|     will be matched in the order given whenever there is a new connection. | ||||
|     """ | ||||
| 
 | ||||
|     def __new__(cls, ctxs): | ||||
|         return super().__new__(cls) | ||||
| 
 | ||||
|     def __init__(self, ctxs: Iterable[Optional[ssl.SSLContext]]): | ||||
|         super().__init__() | ||||
|         self.sni_callback = selector_sni_callback  # type: ignore | ||||
|         self.sanic_select = [] | ||||
|         self.sanic_fallback = None | ||||
|         all_names = [] | ||||
|         for i, ctx in enumerate(ctxs): | ||||
|             if not ctx: | ||||
|                 continue | ||||
|             names = dict(getattr(ctx, "sanic", {})).get("names", []) | ||||
|             all_names += names | ||||
|             self.sanic_select.append(ctx) | ||||
|             if i == 0: | ||||
|                 self.sanic_fallback = ctx | ||||
|         if not all_names: | ||||
|             raise ValueError( | ||||
|                 "No certificates with SubjectAlternativeNames found." | ||||
|             ) | ||||
|         logger.info(f"Certificate vhosts: {', '.join(all_names)}") | ||||
							
								
								
									
										290
									
								
								sanic/http/tls/creators.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										290
									
								
								sanic/http/tls/creators.py
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,290 @@ | ||||
| from __future__ import annotations | ||||
|  | ||||
| import ssl | ||||
| import subprocess | ||||
| import sys | ||||
|  | ||||
| from abc import ABC, abstractmethod | ||||
| from contextlib import suppress | ||||
| from pathlib import Path | ||||
| from tempfile import mkdtemp | ||||
| from types import ModuleType | ||||
| from typing import TYPE_CHECKING, Optional, Tuple, Type, Union, cast | ||||
|  | ||||
| from sanic.application.constants import Mode | ||||
| from sanic.application.spinner import loading | ||||
| from sanic.constants import ( | ||||
|     DEFAULT_LOCAL_TLS_CERT, | ||||
|     DEFAULT_LOCAL_TLS_KEY, | ||||
|     LocalCertCreator, | ||||
| ) | ||||
| from sanic.exceptions import SanicException | ||||
| from sanic.helpers import Default | ||||
| from sanic.http.tls.context import CertSimple, SanicSSLContext | ||||
|  | ||||
|  | ||||
| try: | ||||
|     import trustme | ||||
|  | ||||
|     TRUSTME_INSTALLED = True | ||||
| except (ImportError, ModuleNotFoundError): | ||||
|     trustme = ModuleType("trustme") | ||||
|     TRUSTME_INSTALLED = False | ||||
|  | ||||
| if TYPE_CHECKING: | ||||
|     from sanic import Sanic | ||||
|  | ||||
|  | ||||
| # Only allow secure ciphers, notably leaving out AES-CBC mode | ||||
| # OpenSSL chooses ECDSA or RSA depending on the cert in use | ||||
| CIPHERS_TLS12 = [ | ||||
|     "ECDHE-ECDSA-CHACHA20-POLY1305", | ||||
|     "ECDHE-ECDSA-AES256-GCM-SHA384", | ||||
|     "ECDHE-ECDSA-AES128-GCM-SHA256", | ||||
|     "ECDHE-RSA-CHACHA20-POLY1305", | ||||
|     "ECDHE-RSA-AES256-GCM-SHA384", | ||||
|     "ECDHE-RSA-AES128-GCM-SHA256", | ||||
| ] | ||||
|  | ||||
|  | ||||
| def _make_path(maybe_path: Union[Path, str], tmpdir: Optional[Path]) -> Path: | ||||
|     if isinstance(maybe_path, Path): | ||||
|         return maybe_path | ||||
|     else: | ||||
|         path = Path(maybe_path) | ||||
|         if not path.exists(): | ||||
|             if not tmpdir: | ||||
|                 raise RuntimeError("Reached an unknown state. No tmpdir.") | ||||
|             return tmpdir / maybe_path | ||||
|  | ||||
|     return path | ||||
|  | ||||
|  | ||||
| def get_ssl_context( | ||||
|     app: Sanic, ssl: Optional[ssl.SSLContext] | ||||
| ) -> ssl.SSLContext: | ||||
|     if ssl: | ||||
|         return ssl | ||||
|  | ||||
|     if app.state.mode is Mode.PRODUCTION: | ||||
|         raise SanicException( | ||||
|             "Cannot run Sanic as an HTTPS server in PRODUCTION mode " | ||||
|             "without passing a TLS certificate. If you are developing " | ||||
|             "locally, please enable DEVELOPMENT mode and Sanic will " | ||||
|             "generate a localhost TLS certificate. For more information " | ||||
|             "please see: https://sanic.dev/en/guide/deployment/development." | ||||
|             "html#automatic-tls-certificate." | ||||
|         ) | ||||
|  | ||||
|     creator = CertCreator.select( | ||||
|         app, | ||||
|         cast(LocalCertCreator, app.config.LOCAL_CERT_CREATOR), | ||||
|         app.config.LOCAL_TLS_KEY, | ||||
|         app.config.LOCAL_TLS_CERT, | ||||
|     ) | ||||
|     context = creator.generate_cert(app.config.LOCALHOST) | ||||
|     return context | ||||
|  | ||||
|  | ||||
| class CertCreator(ABC): | ||||
|     def __init__(self, app, key, cert) -> None: | ||||
|         self.app = app | ||||
|         self.key = key | ||||
|         self.cert = cert | ||||
|         self.tmpdir = None | ||||
|  | ||||
|         if isinstance(self.key, Default) or isinstance(self.cert, Default): | ||||
|             self.tmpdir = Path(mkdtemp()) | ||||
|  | ||||
|         key = ( | ||||
|             DEFAULT_LOCAL_TLS_KEY | ||||
|             if isinstance(self.key, Default) | ||||
|             else self.key | ||||
|         ) | ||||
|         cert = ( | ||||
|             DEFAULT_LOCAL_TLS_CERT | ||||
|             if isinstance(self.cert, Default) | ||||
|             else self.cert | ||||
|         ) | ||||
|  | ||||
|         self.key_path = _make_path(key, self.tmpdir) | ||||
|         self.cert_path = _make_path(cert, self.tmpdir) | ||||
|  | ||||
|     @abstractmethod | ||||
|     def check_supported(self) -> None:  # no cov | ||||
|         ... | ||||
|  | ||||
|     @abstractmethod | ||||
|     def generate_cert(self, localhost: str) -> ssl.SSLContext:  # no cov | ||||
|         ... | ||||
|  | ||||
|     @classmethod | ||||
|     def select( | ||||
|         cls, | ||||
|         app: Sanic, | ||||
|         cert_creator: LocalCertCreator, | ||||
|         local_tls_key, | ||||
|         local_tls_cert, | ||||
|     ) -> CertCreator: | ||||
|  | ||||
|         creator: Optional[CertCreator] = None | ||||
|  | ||||
|         cert_creator_options: Tuple[ | ||||
|             Tuple[Type[CertCreator], LocalCertCreator], ... | ||||
|         ] = ( | ||||
|             (MkcertCreator, LocalCertCreator.MKCERT), | ||||
|             (TrustmeCreator, LocalCertCreator.TRUSTME), | ||||
|         ) | ||||
|         for creator_class, local_creator in cert_creator_options: | ||||
|             creator = cls._try_select( | ||||
|                 app, | ||||
|                 creator, | ||||
|                 creator_class, | ||||
|                 local_creator, | ||||
|                 cert_creator, | ||||
|                 local_tls_key, | ||||
|                 local_tls_cert, | ||||
|             ) | ||||
|             if creator: | ||||
|                 break | ||||
|  | ||||
|         if not creator: | ||||
|             raise SanicException( | ||||
|                 "Sanic could not find package to create a TLS certificate. " | ||||
|                 "You must have either mkcert or trustme installed. See " | ||||
|                 "https://sanic.dev/en/guide/deployment/development.html" | ||||
|                 "#automatic-tls-certificate for more details." | ||||
|             ) | ||||
|  | ||||
|         return creator | ||||
|  | ||||
|     @staticmethod | ||||
|     def _try_select( | ||||
|         app: Sanic, | ||||
|         creator: Optional[CertCreator], | ||||
|         creator_class: Type[CertCreator], | ||||
|         creator_requirement: LocalCertCreator, | ||||
|         creator_requested: LocalCertCreator, | ||||
|         local_tls_key, | ||||
|         local_tls_cert, | ||||
|     ): | ||||
|         if creator or ( | ||||
|             creator_requested is not LocalCertCreator.AUTO | ||||
|             and creator_requested is not creator_requirement | ||||
|         ): | ||||
|             return creator | ||||
|  | ||||
|         instance = creator_class(app, local_tls_key, local_tls_cert) | ||||
|         try: | ||||
|             instance.check_supported() | ||||
|         except SanicException: | ||||
|             if creator_requested is creator_requirement: | ||||
|                 raise | ||||
|             else: | ||||
|                 return None | ||||
|  | ||||
|         return instance | ||||
|  | ||||
|  | ||||
| class MkcertCreator(CertCreator): | ||||
|     def check_supported(self) -> None: | ||||
|         try: | ||||
|             subprocess.run(  # nosec B603 B607 | ||||
|                 ["mkcert", "-help"], | ||||
|                 check=True, | ||||
|                 stderr=subprocess.DEVNULL, | ||||
|                 stdout=subprocess.DEVNULL, | ||||
|             ) | ||||
|         except Exception as e: | ||||
|             raise SanicException( | ||||
|                 "Sanic is attempting to use mkcert to generate local TLS " | ||||
|                 "certificates since you did not supply a certificate, but " | ||||
|                 "one is required. Sanic cannot proceed since mkcert does not " | ||||
|                 "appear to be installed. Alternatively, you can use trustme. " | ||||
|                 "Please install mkcert, trustme, or supply TLS certificates " | ||||
|                 "to proceed. Installation instructions can be found here: " | ||||
|                 "https://github.com/FiloSottile/mkcert.\n" | ||||
|                 "Find out more information about your options here: " | ||||
|                 "https://sanic.dev/en/guide/deployment/development.html#" | ||||
|                 "automatic-tls-certificate" | ||||
|             ) from e | ||||
|  | ||||
|     def generate_cert(self, localhost: str) -> ssl.SSLContext: | ||||
|         try: | ||||
|             if not self.cert_path.exists(): | ||||
|                 message = "Generating TLS certificate" | ||||
|                 # TODO: Validate input for security | ||||
|                 with loading(message): | ||||
|                     cmd = [ | ||||
|                         "mkcert", | ||||
|                         "-key-file", | ||||
|                         str(self.key_path), | ||||
|                         "-cert-file", | ||||
|                         str(self.cert_path), | ||||
|                         localhost, | ||||
|                     ] | ||||
|                     resp = subprocess.run(  # nosec B603 | ||||
|                         cmd, | ||||
|                         check=True, | ||||
|                         stdout=subprocess.PIPE, | ||||
|                         stderr=subprocess.STDOUT, | ||||
|                         text=True, | ||||
|                     ) | ||||
|                 sys.stdout.write("\r" + " " * (len(message) + 4)) | ||||
|                 sys.stdout.flush() | ||||
|                 sys.stdout.write(resp.stdout) | ||||
|         finally: | ||||
|  | ||||
|             @self.app.main_process_stop | ||||
|             async def cleanup(*_):  # no cov | ||||
|                 if self.tmpdir: | ||||
|                     with suppress(FileNotFoundError): | ||||
|                         self.key_path.unlink() | ||||
|                         self.cert_path.unlink() | ||||
|                     self.tmpdir.rmdir() | ||||
|  | ||||
|         context = CertSimple(self.cert_path, self.key_path) | ||||
|         context.sanic["creator"] = "mkcert" | ||||
|         context.sanic["localhost"] = localhost | ||||
|         SanicSSLContext.create_from_ssl_context(context) | ||||
|  | ||||
|         return context | ||||
|  | ||||
|  | ||||
| class TrustmeCreator(CertCreator): | ||||
|     def check_supported(self) -> None: | ||||
|         if not TRUSTME_INSTALLED: | ||||
|             raise SanicException( | ||||
|                 "Sanic is attempting to use trustme to generate local TLS " | ||||
|                 "certificates since you did not supply a certificate, but " | ||||
|                 "one is required. Sanic cannot proceed since trustme does not " | ||||
|                 "appear to be installed. Alternatively, you can use mkcert. " | ||||
|                 "Please install mkcert, trustme, or supply TLS certificates " | ||||
|                 "to proceed. Installation instructions can be found here: " | ||||
|                 "https://github.com/python-trio/trustme.\n" | ||||
|                 "Find out more information about your options here: " | ||||
|                 "https://sanic.dev/en/guide/deployment/development.html#" | ||||
|                 "automatic-tls-certificate" | ||||
|             ) | ||||
|  | ||||
|     def generate_cert(self, localhost: str) -> ssl.SSLContext: | ||||
|         context = SanicSSLContext.create_from_ssl_context( | ||||
|             ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER) | ||||
|         ) | ||||
|         context.sanic = { | ||||
|             "cert": self.cert_path.absolute(), | ||||
|             "key": self.key_path.absolute(), | ||||
|         } | ||||
|         ca = trustme.CA() | ||||
|         server_cert = ca.issue_cert(localhost) | ||||
|         server_cert.configure_cert(context) | ||||
|         ca.configure_trust(context) | ||||
|  | ||||
|         ca.cert_pem.write_to_path(str(self.cert_path.absolute())) | ||||
|         server_cert.private_key_and_cert_chain_pem.write_to_path( | ||||
|             str(self.key_path.absolute()) | ||||
|         ) | ||||
|         context.sanic["creator"] = "trustme" | ||||
|         context.sanic["localhost"] = localhost | ||||
|  | ||||
|         return context | ||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user