Compare commits
	
		
			10 Commits
		
	
	
		
			middleware
			...
			fix-2388-s
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
|   | 0a84b6cfdb | ||
|   | 2750f0f82a | ||
|   | 0f5de2ef2c | ||
|   | aef131af90 | ||
|   | 6e40292974 | ||
|   | db92c1fedd | ||
|   | bbffdcbd68 | ||
|   | 768d0e09b5 | ||
|   | 9d04f24298 | ||
|   | 6f18c82879 | 
							
								
								
									
										2
									
								
								.black.toml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										2
									
								
								.black.toml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,2 @@ | |||||||
|  | [tool.black] | ||||||
|  | line-length = 79 | ||||||
							
								
								
									
										11
									
								
								.coveragerc
									
									
									
									
									
								
							
							
						
						
									
										11
									
								
								.coveragerc
									
									
									
									
									
								
							| @@ -4,8 +4,8 @@ source = sanic | |||||||
| omit = | omit = | ||||||
|     site-packages |     site-packages | ||||||
|     sanic/__main__.py |     sanic/__main__.py | ||||||
|     sanic/server/legacy.py |  | ||||||
|     sanic/compat.py |     sanic/compat.py | ||||||
|  |     sanic/reloader_helpers.py | ||||||
|     sanic/simple.py |     sanic/simple.py | ||||||
|     sanic/utils.py |     sanic/utils.py | ||||||
|     sanic/cli |     sanic/cli | ||||||
| @@ -20,5 +20,12 @@ exclude_lines = | |||||||
|     noqa |     noqa | ||||||
|     NOQA |     NOQA | ||||||
|     pragma: no cover |     pragma: no cover | ||||||
|     TYPE_CHECKING | omit = | ||||||
|  |     site-packages | ||||||
|  |     sanic/__main__.py | ||||||
|  |     sanic/compat.py | ||||||
|  |     sanic/reloader_helpers.py | ||||||
|  |     sanic/simple.py | ||||||
|  |     sanic/utils.py | ||||||
|  |     sanic/cli | ||||||
| skip_empty = True | skip_empty = True | ||||||
|   | |||||||
							
								
								
									
										14
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										14
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,27 +1,25 @@ | |||||||
| --- | --- | ||||||
| name: Bug report | name: Bug report | ||||||
| about: Create a report to help us improve | about: Create a report to help us improve | ||||||
| labels: ["bug"] |  | ||||||
|  |  | ||||||
| --- | --- | ||||||
|  |  | ||||||
| **Describe the bug** | **Describe the bug** | ||||||
| <!-- A clear and concise description of what the bug is, make sure to paste any exceptions and tracebacks. --> | A clear and concise description of what the bug is, make sure to paste any exceptions and tracebacks. | ||||||
|  |  | ||||||
|  |  | ||||||
| **Code snippet** | **Code snippet** | ||||||
| <!-- Relevant source code, make sure to remove what is not necessary. --> | Relevant source code, make sure to remove what is not necessary. | ||||||
|  |  | ||||||
|  |  | ||||||
| **Expected behavior** | **Expected behavior** | ||||||
| <!-- A clear and concise description of what you expected to happen. --> | A clear and concise description of what you expected to happen. | ||||||
|  |  | ||||||
|  |  | ||||||
| **Environment (please complete the following information):** | **Environment (please complete the following information):** | ||||||
| <!-- Please provide the information below. Instead, you can copy and paste the message that Sanic shows on startup. If you do, please remember to format it with ``` --> |  - OS: [e.g. iOS] | ||||||
|  - OS:  |  - Version [e.g. 0.8.3] | ||||||
|  - Sanic Version: |  | ||||||
|  |  | ||||||
|  |  | ||||||
| **Additional context** | **Additional context** | ||||||
| <!-- Add any other context about the problem here. --> | Add any other context about the problem here. | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							| @@ -3,6 +3,3 @@ contact_links: | |||||||
|   - name: Questions and Help |   - name: Questions and Help | ||||||
|     url: https://community.sanicframework.org/c/questions-and-help |     url: https://community.sanicframework.org/c/questions-and-help | ||||||
|     about: Do you need help with Sanic? Ask your questions here. |     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. |  | ||||||
|   | |||||||
							
								
								
									
										7
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										7
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,17 +1,16 @@ | |||||||
| --- | --- | ||||||
| name: Feature request | name: Feature request | ||||||
| about: Suggest an idea for Sanic | about: Suggest an idea for Sanic | ||||||
| labels: ["feature request"] |  | ||||||
|  |  | ||||||
| --- | --- | ||||||
|  |  | ||||||
| **Is your feature request related to a problem? Please describe.** | **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 [...] --> | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||||||
|  |  | ||||||
|  |  | ||||||
| **Describe the solution you'd like** | **Describe the solution you'd like** | ||||||
| <!-- A clear and concise description of what you want to happen. --> | A clear and concise description of what you want to happen. | ||||||
|  |  | ||||||
|  |  | ||||||
| **Additional context** | **Additional context** | ||||||
| <!-- Add any other context or sample code about the feature request here. --> | Add any other context or sample code about the feature request here. | ||||||
|   | |||||||
| @@ -313,10 +313,8 @@ Version 21.3.0 | |||||||
|     `#2074 <https://github.com/sanic-org/sanic/pull/2074>`_ |     `#2074 <https://github.com/sanic-org/sanic/pull/2074>`_ | ||||||
|     Performance adjustments in ``handle_request_`` |     Performance adjustments in ``handle_request_`` | ||||||
|  |  | ||||||
| Version 20.12.3 🔷 | Version 20.12.3 | ||||||
| ------------------ | --------------- | ||||||
|  |  | ||||||
| `Current LTS version` |  | ||||||
|  |  | ||||||
| **Bugfixes** | **Bugfixes** | ||||||
|  |  | ||||||
| @@ -350,8 +348,8 @@ Version 19.12.5 | |||||||
|     `#2027 <https://github.com/sanic-org/sanic/pull/2027>`_ |     `#2027 <https://github.com/sanic-org/sanic/pull/2027>`_ | ||||||
|     Remove old chardet requirement, add in hard multidict requirement |     Remove old chardet requirement, add in hard multidict requirement | ||||||
|  |  | ||||||
| Version 20.12.0 🔹 | Version 20.12.0 | ||||||
| ----------------- | --------------- | ||||||
|  |  | ||||||
| **Features** | **Features** | ||||||
|  |  | ||||||
| @@ -359,6 +357,11 @@ Version 20.12.0 🔹 | |||||||
|     `#1993 <https://github.com/sanic-org/sanic/pull/1993>`_ |     `#1993 <https://github.com/sanic-org/sanic/pull/1993>`_ | ||||||
|     Add disable app registry |     Add disable app registry | ||||||
|  |  | ||||||
|  | Version 20.12.0 | ||||||
|  | --------------- | ||||||
|  |  | ||||||
|  | **Features** | ||||||
|  |  | ||||||
|   * |   * | ||||||
|     `#1945 <https://github.com/sanic-org/sanic/pull/1945>`_ |     `#1945 <https://github.com/sanic-org/sanic/pull/1945>`_ | ||||||
|     Static route more verbose if file not found |     Static route more verbose if file not found | ||||||
|   | |||||||
| @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. | |||||||
| ## Enforcement | ## Enforcement | ||||||
| 
 | 
 | ||||||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||||||
| reported by contacting the project team at adam@sanicframework.org. All | reported by contacting the project team at sanic-maintainers@googlegroups.com. All | ||||||
| complaints will be reviewed and investigated and will result in a response that | 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 | is deemed necessary and appropriate to the circumstances. The project team is | ||||||
| obligated to maintain confidentiality with regard to the reporter of an incident. | 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 | .. code-block:: bash | ||||||
|  |  | ||||||
|    tox -e py37 -v -- tests/test_config.py |    tox -e py36 -v -- tests/test_config.py | ||||||
|    # or |    # or | ||||||
|    tox -e py310 -v -- tests/test_config.py |    tox -e py37 -v -- tests/test_config.py | ||||||
|  |  | ||||||
| Run lint checks | Run lint checks | ||||||
| --------------- | --------------- | ||||||
| @@ -140,7 +140,6 @@ To maintain the code consistency, Sanic uses following tools. | |||||||
| #. `isort <https://github.com/timothycrosley/isort>`_ | #. `isort <https://github.com/timothycrosley/isort>`_ | ||||||
| #. `black <https://github.com/python/black>`_ | #. `black <https://github.com/python/black>`_ | ||||||
| #. `flake8 <https://github.com/PyCQA/flake8>`_ | #. `flake8 <https://github.com/PyCQA/flake8>`_ | ||||||
| #. `slotscheck <https://github.com/ariebovenberg/slotscheck>`_ |  | ||||||
|  |  | ||||||
| isort | isort | ||||||
| ***** | ***** | ||||||
| @@ -168,13 +167,7 @@ flake8 | |||||||
| #. pycodestyle | #. pycodestyle | ||||||
| #. Ned Batchelder's McCabe script | #. Ned Batchelder's McCabe script | ||||||
|  |  | ||||||
| slotscheck | ``isort``\ , ``black`` and ``flake8`` checks are performed during ``tox`` lint checks. | ||||||
| ********** |  | ||||||
|  |  | ||||||
| ``slotscheck`` ensures that there are no problems with ``__slots__`` |  | ||||||
| (e.g. overlaps, or missing slots in base classes). |  | ||||||
|  |  | ||||||
| ``isort``\ , ``black``\ , ``flake8`` and ``slotscheck`` checks are performed during ``tox`` lint checks. |  | ||||||
|  |  | ||||||
| The **easiest** way to make your code conform is to run the following before committing. | 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 | 	isort -rc sanic tests | ||||||
| else | else | ||||||
| 	$(info Sorting Imports) | 	$(info Sorting Imports) | ||||||
| 	isort -rc sanic tests | 	isort -rc sanic tests  --profile=black | ||||||
| endif | endif | ||||||
| endif | endif | ||||||
|  |  | ||||||
| black: | black: | ||||||
| 	black sanic tests | 	black --config ./.black.toml sanic tests | ||||||
|  |  | ||||||
| isort: | isort: | ||||||
| 	isort sanic tests | 	isort sanic tests --profile=black | ||||||
|  |  | ||||||
| pretty: black isort | pretty: black isort | ||||||
|  |  | ||||||
|   | |||||||
| @@ -114,7 +114,7 @@ Hello World Example | |||||||
|     from sanic import Sanic |     from sanic import Sanic | ||||||
|     from sanic.response import json |     from sanic.response import json | ||||||
|  |  | ||||||
|     app = Sanic("my-hello-world-app") |     app = Sanic("My Hello, world app") | ||||||
|  |  | ||||||
|     @app.route('/') |     @app.route('/') | ||||||
|     async def test(request): |     async def test(request): | ||||||
|   | |||||||
							
								
								
									
										51
									
								
								SECURITY.md
									
									
									
									
									
								
							
							
						
						
									
										51
									
								
								SECURITY.md
									
									
									
									
									
								
							| @@ -4,40 +4,31 @@ | |||||||
|  |  | ||||||
| Sanic releases long term support release once a year in December. LTS releases receive bug and security updates for **24 months**. Interim releases throughout the year occur every three months, and are supported until the subsequent interim release. | Sanic releases long term support release once a year in December. LTS releases receive bug and security updates for **24 months**. Interim releases throughout the year occur every three months, and are supported until the subsequent interim release. | ||||||
|  |  | ||||||
|  | | Version | LTS           | Supported          | | ||||||
|  | | ------- | ------------- | ------------------ | | ||||||
|  | | 20.12   | until 2022-12 | :heavy_check_mark: | | ||||||
|  | | 20.9    |               | :x:                | | ||||||
|  | | 20.6    |               | :x:                | | ||||||
|  | | 20.3    |               | :x:                | | ||||||
|  | | 19.12   | until 2021-12 | :white_check_mark: | | ||||||
|  | | 19.9    |               | :x:                | | ||||||
|  | | 19.6    |               | :x:                | | ||||||
|  | | 19.3    |               | :x:                | | ||||||
|  | | 18.12   |               | :x:                | | ||||||
|  | | 0.8.3   |               | :x:                | | ||||||
|  | | 0.7.0   |               | :x:                | | ||||||
|  | | 0.6.0   |               | :x:                | | ||||||
|  | | 0.5.4   |               | :x:                | | ||||||
|  | | 0.4.1   |               | :x:                | | ||||||
|  | | 0.3.1   |               | :x:                | | ||||||
|  | | 0.2.0   |               | :x:                | | ||||||
|  | | 0.1.9   |               | :x:                | | ||||||
|  |  | ||||||
| | Version | LTS           | Supported               | | :white_check_mark: = security/bug fixes | ||||||
| | ------- | ------------- | ----------------------- | | :heavy_check_mark: = full support | ||||||
| | 22.6    |               | :white_check_mark:      | |  | ||||||
| | 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   |               | :x:                     | |  | ||||||
| | 19.9    |               | :x:                     | |  | ||||||
| | 19.6    |               | :x:                     | |  | ||||||
| | 19.3    |               | :x:                     | |  | ||||||
| | 18.12   |               | :x:                     | |  | ||||||
| | 0.8.3   |               | :x:                     | |  | ||||||
| | 0.7.0   |               | :x:                     | |  | ||||||
| | 0.6.0   |               | :x:                     | |  | ||||||
| | 0.5.4   |               | :x:                     | |  | ||||||
| | 0.4.1   |               | :x:                     | |  | ||||||
| | 0.3.1   |               | :x:                     | |  | ||||||
| | 0.2.0   |               | :x:                     | |  | ||||||
| | 0.1.9   |               | :x:                     | |  | ||||||
|  |  | ||||||
| :ballot_box_with_check: = security/bug fixes  |  | ||||||
| :white_check_mark: = full support |  | ||||||
|  |  | ||||||
| ## Reporting a Vulnerability | ## 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. | 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. | This will help to not publicize the issue until the team can address it and resolve it. | ||||||
|   | |||||||
| @@ -4,7 +4,6 @@ coverage: | |||||||
|       default: |       default: | ||||||
|         target: auto |         target: auto | ||||||
|         threshold: 0.75 |         threshold: 0.75 | ||||||
|         informational: true |  | ||||||
|     project: |     project: | ||||||
|       default: |       default: | ||||||
|         target: auto |         target: auto | ||||||
| @@ -15,6 +14,7 @@ codecov: | |||||||
| ignore: | ignore: | ||||||
|   - "sanic/__main__.py" |   - "sanic/__main__.py" | ||||||
|   - "sanic/compat.py" |   - "sanic/compat.py" | ||||||
|  |   - "sanic/reloader_helpers.py" | ||||||
|   - "sanic/simple.py" |   - "sanic/simple.py" | ||||||
|   - "sanic/utils.py" |   - "sanic/utils.py" | ||||||
|   - "sanic/cli" |   - "sanic/cli" | ||||||
|   | |||||||
| @@ -24,11 +24,7 @@ import sanic | |||||||
|  |  | ||||||
| # -- General configuration ------------------------------------------------ | # -- General configuration ------------------------------------------------ | ||||||
|  |  | ||||||
| extensions = [ | extensions = ["sphinx.ext.autodoc", "m2r2"] | ||||||
|     "sphinx.ext.autodoc", |  | ||||||
|     "m2r2", |  | ||||||
|     "enum_tools.autoenum", |  | ||||||
| ] |  | ||||||
|  |  | ||||||
| templates_path = ["_templates"] | templates_path = ["_templates"] | ||||||
|  |  | ||||||
|   | |||||||
| @@ -9,7 +9,7 @@ API | |||||||
| === | === | ||||||
|  |  | ||||||
| .. toctree:: | .. toctree:: | ||||||
|    :maxdepth: 3 |    :maxdepth: 2 | ||||||
|  |  | ||||||
|    👥 User Guide <https://sanicframework.org/guide/> |    👥 User Guide <https://sanicframework.org/guide/> | ||||||
|    sanic/api_reference |    sanic/api_reference | ||||||
|   | |||||||
| @@ -15,19 +15,3 @@ sanic.config | |||||||
| .. automodule:: sanic.config | .. automodule:: sanic.config | ||||||
|     :members: |     :members: | ||||||
|     :show-inheritance: |     :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,14 +17,6 @@ sanic.handlers | |||||||
|     :show-inheritance: |     :show-inheritance: | ||||||
|  |  | ||||||
|  |  | ||||||
| sanic.headers |  | ||||||
| -------------- |  | ||||||
|  |  | ||||||
| .. automodule:: sanic.headers |  | ||||||
|     :members: |  | ||||||
|     :show-inheritance: |  | ||||||
|  |  | ||||||
|  |  | ||||||
| sanic.request | sanic.request | ||||||
| ------------- | ------------- | ||||||
|  |  | ||||||
|   | |||||||
| @@ -16,3 +16,10 @@ sanic.server | |||||||
|     :members: |     :members: | ||||||
|     :show-inheritance: |     :show-inheritance: | ||||||
|  |  | ||||||
|  |  | ||||||
|  | sanic.worker | ||||||
|  | ------------ | ||||||
|  |  | ||||||
|  | .. automodule:: sanic.worker | ||||||
|  |     :members: | ||||||
|  |     :show-inheritance: | ||||||
|   | |||||||
| @@ -1,8 +1,6 @@ | |||||||
| 📜 Changelog | 📜 Changelog | ||||||
| ============ | ============ | ||||||
|  |  | ||||||
| .. mdinclude:: ./releases/22/22.6.md |  | ||||||
| .. mdinclude:: ./releases/22/22.3.md |  | ||||||
| .. mdinclude:: ./releases/21/21.12.md | .. mdinclude:: ./releases/21/21.12.md | ||||||
| .. mdinclude:: ./releases/21/21.9.md | .. mdinclude:: ./releases/21/21.9.md | ||||||
| .. include:: ../../CHANGELOG.rst | .. include:: ../../CHANGELOG.rst | ||||||
|   | |||||||
| @@ -1,12 +1,10 @@ | |||||||
| ## Version 21.12.1 🔷 | ## Version 21.12.1 | ||||||
|  |  | ||||||
| _Current LTS version_ |  | ||||||
|  |  | ||||||
| - [#2349](https://github.com/sanic-org/sanic/pull/2349) Only display MOTD on startup | - [#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 | - [#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 | - [#2355](https://github.com/sanic-org/sanic/pull/2355) Add config.update support for all config values | ||||||
|  |  | ||||||
| ## Version 21.12.0 🔹 | ## Version 21.12.0 | ||||||
|  |  | ||||||
| ### Features | ### Features | ||||||
| - [#2260](https://github.com/sanic-org/sanic/pull/2260) Allow early Blueprint registrations to still apply later added objects | - [#2260](https://github.com/sanic-org/sanic/pull/2260) Allow early Blueprint registrations to still apply later added objects | ||||||
|   | |||||||
| @@ -1,52 +0,0 @@ | |||||||
| ## Version 22.3.0 |  | ||||||
|  |  | ||||||
| ### Features |  | ||||||
| - [#2347](https://github.com/sanic-org/sanic/pull/2347) API for multi-application server |  | ||||||
|     - 🚨 *BREAKING CHANGE*: The old `sanic.worker.GunicornWorker` has been **removed**. To run Sanic with `gunicorn`, you should use it thru `uvicorn` [as described in their docs](https://www.uvicorn.org/#running-with-gunicorn). |  | ||||||
|     - 🧁 *SIDE EFFECT*: Named background tasks are now supported, even in Python 3.7 |  | ||||||
| - [#2357](https://github.com/sanic-org/sanic/pull/2357) Parse `Authorization` header as `Request.credentials` |  | ||||||
| - [#2361](https://github.com/sanic-org/sanic/pull/2361) Add config option to skip `Touchup` step in application startup |  | ||||||
| - [#2372](https://github.com/sanic-org/sanic/pull/2372) Updates to CLI help messaging |  | ||||||
| - [#2382](https://github.com/sanic-org/sanic/pull/2382) Downgrade warnings to backwater debug messages  |  | ||||||
| - [#2396](https://github.com/sanic-org/sanic/pull/2396) Allow for `multidict` v0.6 |  | ||||||
| - [#2401](https://github.com/sanic-org/sanic/pull/2401) Upgrade CLI catching for alternative application run types |  | ||||||
| - [#2402](https://github.com/sanic-org/sanic/pull/2402) Conditionally inject CLI arguments into factory |  | ||||||
| - [#2413](https://github.com/sanic-org/sanic/pull/2413) Add new start and stop event listeners to reloader process |  | ||||||
| - [#2414](https://github.com/sanic-org/sanic/pull/2414) Remove loop as required listener arg |  | ||||||
| - [#2415](https://github.com/sanic-org/sanic/pull/2415) Better exception for bad URL parsing |  | ||||||
| - [sanic-routing#47](https://github.com/sanic-org/sanic-routing/pull/47) Add a new extention parameter type: `<file:ext>`, `<file:ext=jpg>`, `<file:ext=jpg|png|gif|svg>`, `<file=int:ext>`, `<file=int:ext=jpg|png|gif|svg>`, `<file=float:ext=tar.gz>` |  | ||||||
|     - 👶 *BETA FEATURE*: This feature will not work with `path` type matching, and is being released as a beta feature only. |  | ||||||
| - [sanic-routing#57](https://github.com/sanic-org/sanic-routing/pull/57) Change `register_pattern` to accept a `str` or `Pattern` |  | ||||||
| - [sanic-routing#58](https://github.com/sanic-org/sanic-routing/pull/58) Default matching on non-empty strings only, and new `strorempty` pattern type |  | ||||||
|     - 🚨 *BREAKING CHANGE*: Previously a route with a dynamic string parameter (`/<foo>` or `/<foo:str>`) would match on any string, including empty strings. It will now **only** match a non-empty string. To retain the old behavior, you should use the new parameter type: `/<foo:strorempty>`. |  | ||||||
|  |  | ||||||
| ### Bugfixes |  | ||||||
| - [#2373](https://github.com/sanic-org/sanic/pull/2373) Remove `error_logger` on websockets |  | ||||||
| - [#2381](https://github.com/sanic-org/sanic/pull/2381) Fix newly assigned `None` in task registry |  | ||||||
| - [sanic-routing#52](https://github.com/sanic-org/sanic-routing/pull/52) Add type casting to regex route matching |  | ||||||
| - [sanic-routing#60](https://github.com/sanic-org/sanic-routing/pull/60) Add requirements check on regex routes (this resolves, for example, multiple static directories with differing `host` values) |  | ||||||
|  |  | ||||||
| ### Deprecations and Removals |  | ||||||
| - [#2362](https://github.com/sanic-org/sanic/pull/2362) 22.3 Deprecations and changes |  | ||||||
|     1. `debug=True` and `--debug` do _NOT_ automatically run `auto_reload` |  | ||||||
|     2. Default error render is with plain text (browsers still get HTML by default because `auto` looks at headers) |  | ||||||
|     3. `config` is required for `ErrorHandler.finalize` |  | ||||||
|     4. `ErrorHandler.lookup` requires two positional args |  | ||||||
|     5. Unused websocket protocol args removed |  | ||||||
| - [#2344](https://github.com/sanic-org/sanic/pull/2344) Deprecate loading of lowercase environment variables |  | ||||||
|  |  | ||||||
| ### Developer infrastructure |  | ||||||
| - [#2363](https://github.com/sanic-org/sanic/pull/2363) Revert code coverage back to Codecov |  | ||||||
| - [#2405](https://github.com/sanic-org/sanic/pull/2405) Upgrade tests for `sanic-routing` changes |  | ||||||
| - [sanic-testing#35](https://github.com/sanic-org/sanic-testing/pull/35) Allow for httpx v0.22 |  | ||||||
|  |  | ||||||
| ### Improved Documentation |  | ||||||
| - [#2350](https://github.com/sanic-org/sanic/pull/2350) Fix link in README for ASGI |  | ||||||
| - [#2398](https://github.com/sanic-org/sanic/pull/2398) Document middleware on_request and on_response |  | ||||||
| - [#2409](https://github.com/sanic-org/sanic/pull/2409) Add missing documentation for `Request.respond` |  | ||||||
|  |  | ||||||
| ### Miscellaneous |  | ||||||
| - [#2376](https://github.com/sanic-org/sanic/pull/2376) Fix typing for `ListenerMixin.listener` |  | ||||||
| - [#2383](https://github.com/sanic-org/sanic/pull/2383) Clear deprecation warning in `asyncio.wait` |  | ||||||
| - [#2387](https://github.com/sanic-org/sanic/pull/2387) Cleanup `__slots__` implementations |  | ||||||
| - [#2390](https://github.com/sanic-org/sanic/pull/2390) Clear deprecation warning in `asyncio.get_event_loop` |  | ||||||
| @@ -1,43 +0,0 @@ | |||||||
| ## Version 22.6.0 🔶 |  | ||||||
|  |  | ||||||
| _Current version_ |  | ||||||
|  |  | ||||||
| ### 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 |  | ||||||
|  |  | ||||||
| @@ -4,7 +4,6 @@ from sanic import Sanic, response | |||||||
|  |  | ||||||
|  |  | ||||||
| app = Sanic("DelayedResponseApp", strict_slashes=True) | app = Sanic("DelayedResponseApp", strict_slashes=True) | ||||||
| app.config.AUTO_EXTEND = False |  | ||||||
|  |  | ||||||
|  |  | ||||||
| @app.get("/") | @app.get("/") | ||||||
| @@ -12,7 +11,7 @@ async def handler(request): | |||||||
|     return response.redirect("/sleep/3") |     return response.redirect("/sleep/3") | ||||||
|  |  | ||||||
|  |  | ||||||
| @app.get("/sleep/<t:float>") | @app.get("/sleep/<t:number>") | ||||||
| async def handler2(request, t=0.3): | async def handler2(request, t=0.3): | ||||||
|     await sleep(t) |     await sleep(t) | ||||||
|     return response.text(f"Slept {t:.1f} seconds.\n") |     return response.text(f"Slept {t:.1f} seconds.\n") | ||||||
|   | |||||||
| @@ -6,5 +6,5 @@ data = "" | |||||||
| for i in range(1, 250000): | for i in range(1, 250000): | ||||||
|     data += str(i) |     data += str(i) | ||||||
|  |  | ||||||
| r = requests.post('http://0.0.0.0:8000/stream', data=data) | r = requests.post("http://0.0.0.0:8000/stream", data=data) | ||||||
| print(r.text) | print(r.text) | ||||||
|   | |||||||
| @@ -1,3 +1,6 @@ | |||||||
|  | import os | ||||||
|  | import socket | ||||||
|  |  | ||||||
| from sanic import Sanic, response | from sanic import Sanic, response | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -10,4 +13,13 @@ async def test(request): | |||||||
|  |  | ||||||
|  |  | ||||||
| if __name__ == "__main__": | if __name__ == "__main__": | ||||||
|     app.run(unix="./uds_socket") |     server_address = "./uds_socket" | ||||||
|  |     # Make sure the socket does not already exist | ||||||
|  |     try: | ||||||
|  |         os.unlink(server_address) | ||||||
|  |     except OSError: | ||||||
|  |         if os.path.exists(server_address): | ||||||
|  |             raise | ||||||
|  |     sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) | ||||||
|  |     sock.bind(server_address) | ||||||
|  |     app.run(sock=sock) | ||||||
|   | |||||||
| @@ -1,26 +1,3 @@ | |||||||
| [build-system] | [build-system] | ||||||
| requires = ["setuptools<60.0", "wheel"] | requires = ["setuptools<60.0", "wheel"] | ||||||
| build-backend = "setuptools.build_meta" | 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,16 +3,7 @@ from sanic.app import Sanic | |||||||
| from sanic.blueprints import Blueprint | from sanic.blueprints import Blueprint | ||||||
| from sanic.constants import HTTPMethod | from sanic.constants import HTTPMethod | ||||||
| from sanic.request import Request | from sanic.request import Request | ||||||
| from sanic.response import ( | from sanic.response import HTTPResponse, html, json, text | ||||||
|     HTTPResponse, |  | ||||||
|     empty, |  | ||||||
|     file, |  | ||||||
|     html, |  | ||||||
|     json, |  | ||||||
|     redirect, |  | ||||||
|     text, |  | ||||||
| ) |  | ||||||
| from sanic.server.websockets.impl import WebsocketImplProtocol as Websocket |  | ||||||
|  |  | ||||||
|  |  | ||||||
| __all__ = ( | __all__ = ( | ||||||
| @@ -22,11 +13,7 @@ __all__ = ( | |||||||
|     "HTTPMethod", |     "HTTPMethod", | ||||||
|     "HTTPResponse", |     "HTTPResponse", | ||||||
|     "Request", |     "Request", | ||||||
|     "Websocket", |  | ||||||
|     "empty", |  | ||||||
|     "file", |  | ||||||
|     "html", |     "html", | ||||||
|     "json", |     "json", | ||||||
|     "redirect", |  | ||||||
|     "text", |     "text", | ||||||
| ) | ) | ||||||
|   | |||||||
| @@ -6,10 +6,10 @@ if OS_IS_WINDOWS: | |||||||
|     enable_windows_color_support() |     enable_windows_color_support() | ||||||
|  |  | ||||||
|  |  | ||||||
| def main(args=None): | def main(): | ||||||
|     cli = SanicCLI() |     cli = SanicCLI() | ||||||
|     cli.attach() |     cli.attach() | ||||||
|     cli.run(args) |     cli.run() | ||||||
|  |  | ||||||
|  |  | ||||||
| if __name__ == "__main__": | if __name__ == "__main__": | ||||||
|   | |||||||
| @@ -1 +1 @@ | |||||||
| __version__ = "22.9.1" | __version__ = "22.3.0.dev1" | ||||||
|   | |||||||
							
								
								
									
										582
									
								
								sanic/app.py
									
									
									
									
									
								
							
							
						
						
									
										582
									
								
								sanic/app.py
									
									
									
									
									
								
							| @@ -11,6 +11,7 @@ from asyncio import ( | |||||||
|     CancelledError, |     CancelledError, | ||||||
|     Task, |     Task, | ||||||
|     ensure_future, |     ensure_future, | ||||||
|  |     get_event_loop, | ||||||
|     get_running_loop, |     get_running_loop, | ||||||
|     wait_for, |     wait_for, | ||||||
| ) | ) | ||||||
| @@ -19,8 +20,8 @@ from collections import defaultdict, deque | |||||||
| from contextlib import suppress | from contextlib import suppress | ||||||
| from functools import partial | from functools import partial | ||||||
| from inspect import isawaitable | from inspect import isawaitable | ||||||
| from os import environ |  | ||||||
| from socket import socket | from socket import socket | ||||||
|  | from traceback import format_exc | ||||||
| from types import SimpleNamespace | from types import SimpleNamespace | ||||||
| from typing import ( | from typing import ( | ||||||
|     TYPE_CHECKING, |     TYPE_CHECKING, | ||||||
| @@ -41,9 +42,13 @@ from typing import ( | |||||||
|     Union, |     Union, | ||||||
| ) | ) | ||||||
| from urllib.parse import urlencode, urlunparse | from urllib.parse import urlencode, urlunparse | ||||||
|  | from warnings import filterwarnings | ||||||
|  |  | ||||||
| from sanic_routing.exceptions import FinalizationError, NotFound | from sanic_routing.exceptions import (  # type: ignore | ||||||
| from sanic_routing.route import Route |     FinalizationError, | ||||||
|  |     NotFound, | ||||||
|  | ) | ||||||
|  | from sanic_routing.route import Route  # type: ignore | ||||||
|  |  | ||||||
| from sanic.application.ext import setup_ext | from sanic.application.ext import setup_ext | ||||||
| from sanic.application.state import ApplicationState, Mode, ServerStage | from sanic.application.state import ApplicationState, Mode, ServerStage | ||||||
| @@ -53,9 +58,13 @@ from sanic.blueprint_group import BlueprintGroup | |||||||
| from sanic.blueprints import Blueprint | from sanic.blueprints import Blueprint | ||||||
| from sanic.compat import OS_IS_WINDOWS, enable_windows_color_support | from sanic.compat import OS_IS_WINDOWS, enable_windows_color_support | ||||||
| from sanic.config import SANIC_PREFIX, Config | from sanic.config import SANIC_PREFIX, Config | ||||||
| from sanic.exceptions import BadRequest, SanicException, URLBuildError | from sanic.exceptions import ( | ||||||
|  |     InvalidUsage, | ||||||
|  |     SanicException, | ||||||
|  |     ServerError, | ||||||
|  |     URLBuildError, | ||||||
|  | ) | ||||||
| from sanic.handlers import ErrorHandler | from sanic.handlers import ErrorHandler | ||||||
| from sanic.helpers import _default |  | ||||||
| from sanic.http import Stage | from sanic.http import Stage | ||||||
| from sanic.log import ( | from sanic.log import ( | ||||||
|     LOGGING_CONFIG_DEFAULTS, |     LOGGING_CONFIG_DEFAULTS, | ||||||
| @@ -64,7 +73,7 @@ from sanic.log import ( | |||||||
|     logger, |     logger, | ||||||
| ) | ) | ||||||
| from sanic.mixins.listeners import ListenerEvent | from sanic.mixins.listeners import ListenerEvent | ||||||
| from sanic.mixins.startup import StartupMixin | from sanic.mixins.runner import RunnerMixin | ||||||
| from sanic.models.futures import ( | from sanic.models.futures import ( | ||||||
|     FutureException, |     FutureException, | ||||||
|     FutureListener, |     FutureListener, | ||||||
| @@ -77,29 +86,28 @@ from sanic.models.futures import ( | |||||||
| from sanic.models.handler_types import ListenerType, MiddlewareType | from sanic.models.handler_types import ListenerType, MiddlewareType | ||||||
| from sanic.models.handler_types import Sanic as SanicVar | from sanic.models.handler_types import Sanic as SanicVar | ||||||
| from sanic.request import Request | from sanic.request import Request | ||||||
| from sanic.response import BaseHTTPResponse | from sanic.response import BaseHTTPResponse, HTTPResponse, ResponseStream | ||||||
| from sanic.router import Router | from sanic.router import Router | ||||||
| from sanic.server.websockets.impl import ConnectionClosed | from sanic.server.websockets.impl import ConnectionClosed | ||||||
| from sanic.signals import Signal, SignalRouter | from sanic.signals import Signal, SignalRouter | ||||||
| from sanic.touchup import TouchUp, TouchUpMeta | from sanic.touchup import TouchUp, TouchUpMeta | ||||||
| from sanic.types.shared_ctx import SharedContext |  | ||||||
| from sanic.worker.inspector import Inspector |  | ||||||
| from sanic.worker.manager import WorkerManager |  | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     try: |     try: | ||||||
|         from sanic_ext import Extend  # type: ignore |         from sanic_ext import Extend  # type: ignore | ||||||
|         from sanic_ext.extensions.base import Extension  # type: ignore |         from sanic_ext.extensions.base import Extension  # type: ignore | ||||||
|     except ImportError: |     except ImportError: | ||||||
|         Extend = TypeVar("Extend", Type)  # type: ignore |         Extend = TypeVar("Extend")  # type: ignore | ||||||
|  |  | ||||||
|  |  | ||||||
| if OS_IS_WINDOWS:  # no cov | if OS_IS_WINDOWS:  # no cov | ||||||
|     enable_windows_color_support() |     enable_windows_color_support() | ||||||
|  |  | ||||||
|  | filterwarnings("once", category=DeprecationWarning) | ||||||
|  |  | ||||||
| class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): |  | ||||||
|  | class Sanic(BaseSanic, RunnerMixin, metaclass=TouchUpMeta): | ||||||
|     """ |     """ | ||||||
|     The main application instance |     The main application instance | ||||||
|     """ |     """ | ||||||
| @@ -123,8 +131,6 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         "_future_routes", |         "_future_routes", | ||||||
|         "_future_signals", |         "_future_signals", | ||||||
|         "_future_statics", |         "_future_statics", | ||||||
|         "_inspector", |  | ||||||
|         "_manager", |  | ||||||
|         "_state", |         "_state", | ||||||
|         "_task_registry", |         "_task_registry", | ||||||
|         "_test_client", |         "_test_client", | ||||||
| @@ -136,14 +142,13 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         "error_handler", |         "error_handler", | ||||||
|         "go_fast", |         "go_fast", | ||||||
|         "listeners", |         "listeners", | ||||||
|         "multiplexer", |         "name", | ||||||
|         "named_request_middleware", |         "named_request_middleware", | ||||||
|         "named_response_middleware", |         "named_response_middleware", | ||||||
|         "request_class", |         "request_class", | ||||||
|         "request_middleware", |         "request_middleware", | ||||||
|         "response_middleware", |         "response_middleware", | ||||||
|         "router", |         "router", | ||||||
|         "shared_ctx", |  | ||||||
|         "signal_router", |         "signal_router", | ||||||
|         "sock", |         "sock", | ||||||
|         "strict_slashes", |         "strict_slashes", | ||||||
| @@ -168,11 +173,11 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         strict_slashes: bool = False, |         strict_slashes: bool = False, | ||||||
|         log_config: Optional[Dict[str, Any]] = None, |         log_config: Optional[Dict[str, Any]] = None, | ||||||
|         configure_logging: bool = True, |         configure_logging: bool = True, | ||||||
|  |         register: Optional[bool] = None, | ||||||
|         dumps: Optional[Callable[..., AnyStr]] = None, |         dumps: Optional[Callable[..., AnyStr]] = None, | ||||||
|         loads: Optional[Callable[..., Any]] = None, |  | ||||||
|         inspector: bool = False, |  | ||||||
|     ) -> None: |     ) -> None: | ||||||
|         super().__init__(name=name) |         super().__init__(name=name) | ||||||
|  |  | ||||||
|         # logging |         # logging | ||||||
|         if configure_logging: |         if configure_logging: | ||||||
|             dict_config = log_config or LOGGING_CONFIG_DEFAULTS |             dict_config = log_config or LOGGING_CONFIG_DEFAULTS | ||||||
| @@ -186,16 +191,12 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|  |  | ||||||
|         # First setup config |         # First setup config | ||||||
|         self.config: Config = config or Config(env_prefix=env_prefix) |         self.config: Config = config or Config(env_prefix=env_prefix) | ||||||
|         if inspector: |  | ||||||
|             self.config.INSPECTOR = inspector |  | ||||||
|  |  | ||||||
|         # Then we can do the rest |         # Then we can do the rest | ||||||
|         self._asgi_client: Any = None |         self._asgi_client: Any = None | ||||||
|         self._blueprint_order: List[Blueprint] = [] |         self._blueprint_order: List[Blueprint] = [] | ||||||
|         self._delayed_tasks: List[str] = [] |         self._delayed_tasks: List[str] = [] | ||||||
|         self._future_registry: FutureRegistry = FutureRegistry() |         self._future_registry: FutureRegistry = FutureRegistry() | ||||||
|         self._inspector: Optional[Inspector] = None |  | ||||||
|         self._manager: Optional[WorkerManager] = None |  | ||||||
|         self._state: ApplicationState = ApplicationState(app=self) |         self._state: ApplicationState = ApplicationState(app=self) | ||||||
|         self._task_registry: Dict[str, Task] = {} |         self._task_registry: Dict[str, Task] = {} | ||||||
|         self._test_client: Any = None |         self._test_client: Any = None | ||||||
| @@ -213,7 +214,6 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         self.request_middleware: Deque[MiddlewareType] = deque() |         self.request_middleware: Deque[MiddlewareType] = deque() | ||||||
|         self.response_middleware: Deque[MiddlewareType] = deque() |         self.response_middleware: Deque[MiddlewareType] = deque() | ||||||
|         self.router: Router = router or Router() |         self.router: Router = router or Router() | ||||||
|         self.shared_ctx: SharedContext = SharedContext() |  | ||||||
|         self.signal_router: SignalRouter = signal_router or SignalRouter() |         self.signal_router: SignalRouter = signal_router or SignalRouter() | ||||||
|         self.sock: Optional[socket] = None |         self.sock: Optional[socket] = None | ||||||
|         self.strict_slashes: bool = strict_slashes |         self.strict_slashes: bool = strict_slashes | ||||||
| @@ -222,14 +222,23 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|  |  | ||||||
|         # Register alternative method names |         # Register alternative method names | ||||||
|         self.go_fast = self.run |         self.go_fast = self.run | ||||||
|  |  | ||||||
|  |         if register is not None: | ||||||
|  |             deprecation( | ||||||
|  |                 "The register argument is deprecated and will stop working " | ||||||
|  |                 "in v22.6. After v22.6 all apps will be added to the Sanic " | ||||||
|  |                 "app registry.", | ||||||
|  |                 22.6, | ||||||
|  |             ) | ||||||
|  |             self.config.REGISTER = register | ||||||
|  |         if self.config.REGISTER: | ||||||
|  |             self.__class__.register_app(self) | ||||||
|  |  | ||||||
|         self.router.ctx.app = self |         self.router.ctx.app = self | ||||||
|         self.signal_router.ctx.app = self |         self.signal_router.ctx.app = self | ||||||
|         self.__class__.register_app(self) |  | ||||||
|  |  | ||||||
|         if dumps: |         if dumps: | ||||||
|             BaseHTTPResponse._dumps = dumps  # type: ignore |             BaseHTTPResponse._dumps = dumps  # type: ignore | ||||||
|         if loads: |  | ||||||
|             Request._loads = loads  # type: ignore |  | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def loop(self): |     def loop(self): | ||||||
| @@ -245,13 +254,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|                 "Loop can only be retrieved after the app has started " |                 "Loop can only be retrieved after the app has started " | ||||||
|                 "running. Not supported with `create_server` function" |                 "running. Not supported with `create_server` function" | ||||||
|             ) |             ) | ||||||
|         try: |         return get_event_loop() | ||||||
|             return get_running_loop() |  | ||||||
|         except RuntimeError:  # no cov |  | ||||||
|             if sys.version_info > (3, 10): |  | ||||||
|                 return asyncio.get_event_loop_policy().get_event_loop() |  | ||||||
|             else: |  | ||||||
|                 return asyncio.get_event_loop() |  | ||||||
|  |  | ||||||
|     # -------------------------------------------------------------------- # |     # -------------------------------------------------------------------- # | ||||||
|     # Registration |     # Registration | ||||||
| @@ -274,7 +277,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|             valid = ", ".join( |             valid = ", ".join( | ||||||
|                 map(lambda x: x.lower(), ListenerEvent.__members__.keys()) |                 map(lambda x: x.lower(), ListenerEvent.__members__.keys()) | ||||||
|             ) |             ) | ||||||
|             raise BadRequest(f"Invalid event: {event}. Use one of: {valid}") |             raise InvalidUsage(f"Invalid event: {event}. Use one of: {valid}") | ||||||
|  |  | ||||||
|         if "." in _event: |         if "." in _event: | ||||||
|             self.signal(_event.value)( |             self.signal(_event.value)( | ||||||
| @@ -462,7 +465,9 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|  |  | ||||||
|     def blueprint( |     def blueprint( | ||||||
|         self, |         self, | ||||||
|         blueprint: Union[Blueprint, Iterable[Blueprint], BlueprintGroup], |         blueprint: Union[ | ||||||
|  |             Blueprint, List[Blueprint], Tuple[Blueprint], BlueprintGroup | ||||||
|  |         ], | ||||||
|         **options: Any, |         **options: Any, | ||||||
|     ): |     ): | ||||||
|         """Register a blueprint on the application. |         """Register a blueprint on the application. | ||||||
| @@ -471,7 +476,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         :param options: option dictionary with blueprint defaults |         :param options: option dictionary with blueprint defaults | ||||||
|         :return: Nothing |         :return: Nothing | ||||||
|         """ |         """ | ||||||
|         if isinstance(blueprint, (Iterable, BlueprintGroup)): |         if isinstance(blueprint, (list, tuple, BlueprintGroup)): | ||||||
|             for item in blueprint: |             for item in blueprint: | ||||||
|                 params = {**options} |                 params = {**options} | ||||||
|                 if isinstance(blueprint, BlueprintGroup): |                 if isinstance(blueprint, BlueprintGroup): | ||||||
| @@ -703,15 +708,267 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|     # -------------------------------------------------------------------- # |     # -------------------------------------------------------------------- # | ||||||
|  |  | ||||||
|     async def handle_exception( |     async def handle_exception( | ||||||
|         self, |         self, request: Request, exception: BaseException | ||||||
|         request: Request, |  | ||||||
|         exception: BaseException, |  | ||||||
|         run_middleware: bool = True, |  | ||||||
|     ):  # no cov |     ):  # no cov | ||||||
|         raise NotImplementedError |         """ | ||||||
|  |         A handler that catches specific exceptions and outputs a response. | ||||||
|  |  | ||||||
|  |         :param request: The current request object | ||||||
|  |         :param exception: The exception that was raised | ||||||
|  |         :raises ServerError: response 500 | ||||||
|  |         """ | ||||||
|  |         await self.dispatch( | ||||||
|  |             "http.lifecycle.exception", | ||||||
|  |             inline=True, | ||||||
|  |             context={"request": request, "exception": exception}, | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |         if ( | ||||||
|  |             request.stream is not None | ||||||
|  |             and request.stream.stage is not Stage.HANDLER | ||||||
|  |         ): | ||||||
|  |             error_logger.exception(exception, exc_info=True) | ||||||
|  |             logger.error( | ||||||
|  |                 "The error response will not be sent to the client for " | ||||||
|  |                 f'the following exception:"{exception}". A previous response ' | ||||||
|  |                 "has at least partially been sent." | ||||||
|  |             ) | ||||||
|  |  | ||||||
|  |             # ----------------- deprecated ----------------- | ||||||
|  |             handler = self.error_handler._lookup( | ||||||
|  |                 exception, request.name if request else None | ||||||
|  |             ) | ||||||
|  |             if handler: | ||||||
|  |                 deprecation( | ||||||
|  |                     "An error occurred while handling the request after at " | ||||||
|  |                     "least some part of the response was sent to the client. " | ||||||
|  |                     "Therefore, the response from your custom exception " | ||||||
|  |                     f"handler {handler.__name__} will not be sent to the " | ||||||
|  |                     "client. Beginning in v22.6, Sanic will stop executing " | ||||||
|  |                     "custom exception handlers in this scenario. Exception " | ||||||
|  |                     "handlers should only be used to generate the exception " | ||||||
|  |                     "responses. If you would like to perform any other " | ||||||
|  |                     "action on a raised exception, please consider using a " | ||||||
|  |                     "signal handler like " | ||||||
|  |                     '`@app.signal("http.lifecycle.exception")`\n' | ||||||
|  |                     "For further information, please see the docs: " | ||||||
|  |                     "https://sanicframework.org/en/guide/advanced/" | ||||||
|  |                     "signals.html", | ||||||
|  |                     22.6, | ||||||
|  |                 ) | ||||||
|  |                 try: | ||||||
|  |                     response = self.error_handler.response(request, exception) | ||||||
|  |                     if isawaitable(response): | ||||||
|  |                         response = await response | ||||||
|  |                 except BaseException as e: | ||||||
|  |                     logger.error("An error occurred in the exception handler.") | ||||||
|  |                     error_logger.exception(e) | ||||||
|  |             # ---------------------------------------------- | ||||||
|  |  | ||||||
|  |             return | ||||||
|  |  | ||||||
|  |         # -------------------------------------------- # | ||||||
|  |         # Request Middleware | ||||||
|  |         # -------------------------------------------- # | ||||||
|  |         response = await self._run_request_middleware( | ||||||
|  |             request, request_name=None | ||||||
|  |         ) | ||||||
|  |         # No middleware results | ||||||
|  |         if not response: | ||||||
|  |             try: | ||||||
|  |                 response = self.error_handler.response(request, exception) | ||||||
|  |                 if isawaitable(response): | ||||||
|  |                     response = await response | ||||||
|  |             except Exception as e: | ||||||
|  |                 if isinstance(e, SanicException): | ||||||
|  |                     response = self.error_handler.default(request, e) | ||||||
|  |                 elif self.debug: | ||||||
|  |                     response = HTTPResponse( | ||||||
|  |                         ( | ||||||
|  |                             f"Error while handling error: {e}\n" | ||||||
|  |                             f"Stack: {format_exc()}" | ||||||
|  |                         ), | ||||||
|  |                         status=500, | ||||||
|  |                     ) | ||||||
|  |                 else: | ||||||
|  |                     response = HTTPResponse( | ||||||
|  |                         "An error occurred while handling an error", status=500 | ||||||
|  |                     ) | ||||||
|  |         if response is not None: | ||||||
|  |             try: | ||||||
|  |                 request.reset_response() | ||||||
|  |                 response = await request.respond(response) | ||||||
|  |             except BaseException: | ||||||
|  |                 # Skip response middleware | ||||||
|  |                 if request.stream: | ||||||
|  |                     request.stream.respond(response) | ||||||
|  |                 await response.send(end_stream=True) | ||||||
|  |                 raise | ||||||
|  |         else: | ||||||
|  |             if request.stream: | ||||||
|  |                 response = request.stream.response | ||||||
|  |  | ||||||
|  |         # Marked for cleanup and DRY with handle_request/handle_exception | ||||||
|  |         # when ResponseStream is no longer supporder | ||||||
|  |         if isinstance(response, BaseHTTPResponse): | ||||||
|  |             await self.dispatch( | ||||||
|  |                 "http.lifecycle.response", | ||||||
|  |                 inline=True, | ||||||
|  |                 context={ | ||||||
|  |                     "request": request, | ||||||
|  |                     "response": response, | ||||||
|  |                 }, | ||||||
|  |             ) | ||||||
|  |             await response.send(end_stream=True) | ||||||
|  |         elif isinstance(response, ResponseStream): | ||||||
|  |             resp = await response(request) | ||||||
|  |             await self.dispatch( | ||||||
|  |                 "http.lifecycle.response", | ||||||
|  |                 inline=True, | ||||||
|  |                 context={ | ||||||
|  |                     "request": request, | ||||||
|  |                     "response": resp, | ||||||
|  |                 }, | ||||||
|  |             ) | ||||||
|  |             await response.eof() | ||||||
|  |         else: | ||||||
|  |             raise ServerError( | ||||||
|  |                 f"Invalid response type {response!r} (need HTTPResponse)" | ||||||
|  |             ) | ||||||
|  |  | ||||||
|     async def handle_request(self, request: Request):  # no cov |     async def handle_request(self, request: Request):  # no cov | ||||||
|         raise NotImplementedError |         """Take a request from the HTTP Server and return a response object | ||||||
|  |         to be sent back The HTTP Server only expects a response object, so | ||||||
|  |         exception handling must be done here | ||||||
|  |  | ||||||
|  |         :param request: HTTP Request object | ||||||
|  |         :return: Nothing | ||||||
|  |         """ | ||||||
|  |         await self.dispatch( | ||||||
|  |             "http.lifecycle.handle", | ||||||
|  |             inline=True, | ||||||
|  |             context={"request": request}, | ||||||
|  |         ) | ||||||
|  |  | ||||||
|  |         # Define `response` var here to remove warnings about | ||||||
|  |         # allocation before assignment below. | ||||||
|  |         response = None | ||||||
|  |         try: | ||||||
|  |  | ||||||
|  |             await self.dispatch( | ||||||
|  |                 "http.routing.before", | ||||||
|  |                 inline=True, | ||||||
|  |                 context={"request": request}, | ||||||
|  |             ) | ||||||
|  |             # Fetch handler from router | ||||||
|  |             route, handler, kwargs = self.router.get( | ||||||
|  |                 request.path, | ||||||
|  |                 request.method, | ||||||
|  |                 request.headers.getone("host", None), | ||||||
|  |             ) | ||||||
|  |  | ||||||
|  |             request._match_info = {**kwargs} | ||||||
|  |             request.route = route | ||||||
|  |  | ||||||
|  |             await self.dispatch( | ||||||
|  |                 "http.routing.after", | ||||||
|  |                 inline=True, | ||||||
|  |                 context={ | ||||||
|  |                     "request": request, | ||||||
|  |                     "route": route, | ||||||
|  |                     "kwargs": kwargs, | ||||||
|  |                     "handler": handler, | ||||||
|  |                 }, | ||||||
|  |             ) | ||||||
|  |  | ||||||
|  |             if ( | ||||||
|  |                 request.stream | ||||||
|  |                 and request.stream.request_body | ||||||
|  |                 and not route.ctx.ignore_body | ||||||
|  |             ): | ||||||
|  |  | ||||||
|  |                 if hasattr(handler, "is_stream"): | ||||||
|  |                     # Streaming handler: lift the size limit | ||||||
|  |                     request.stream.request_max_size = float("inf") | ||||||
|  |                 else: | ||||||
|  |                     # Non-streaming handler: preload body | ||||||
|  |                     await request.receive_body() | ||||||
|  |  | ||||||
|  |             # -------------------------------------------- # | ||||||
|  |             # Request Middleware | ||||||
|  |             # -------------------------------------------- # | ||||||
|  |             response = await self._run_request_middleware( | ||||||
|  |                 request, request_name=route.name | ||||||
|  |             ) | ||||||
|  |  | ||||||
|  |             # No middleware results | ||||||
|  |             if not response: | ||||||
|  |                 # -------------------------------------------- # | ||||||
|  |                 # Execute Handler | ||||||
|  |                 # -------------------------------------------- # | ||||||
|  |  | ||||||
|  |                 if handler is None: | ||||||
|  |                     raise ServerError( | ||||||
|  |                         ( | ||||||
|  |                             "'None' was returned while requesting a " | ||||||
|  |                             "handler from the router" | ||||||
|  |                         ) | ||||||
|  |                     ) | ||||||
|  |  | ||||||
|  |                 # Run response handler | ||||||
|  |                 response = handler(request, **request.match_info) | ||||||
|  |                 if isawaitable(response): | ||||||
|  |                     response = await response | ||||||
|  |  | ||||||
|  |             if request.responded: | ||||||
|  |                 if response is not None: | ||||||
|  |                     error_logger.error( | ||||||
|  |                         "The response object returned by the route handler " | ||||||
|  |                         "will not be sent to client. The request has already " | ||||||
|  |                         "been responded to." | ||||||
|  |                     ) | ||||||
|  |                 if request.stream is not None: | ||||||
|  |                     response = request.stream.response | ||||||
|  |             elif response is not None: | ||||||
|  |                 response = await request.respond(response) | ||||||
|  |             elif not hasattr(handler, "is_websocket"): | ||||||
|  |                 response = request.stream.response  # type: ignore | ||||||
|  |  | ||||||
|  |             # Marked for cleanup and DRY with handle_request/handle_exception | ||||||
|  |             # when ResponseStream is no longer supporder | ||||||
|  |             if isinstance(response, BaseHTTPResponse): | ||||||
|  |                 await self.dispatch( | ||||||
|  |                     "http.lifecycle.response", | ||||||
|  |                     inline=True, | ||||||
|  |                     context={ | ||||||
|  |                         "request": request, | ||||||
|  |                         "response": response, | ||||||
|  |                     }, | ||||||
|  |                 ) | ||||||
|  |                 await response.send(end_stream=True) | ||||||
|  |             elif isinstance(response, ResponseStream): | ||||||
|  |                 resp = await response(request) | ||||||
|  |                 await self.dispatch( | ||||||
|  |                     "http.lifecycle.response", | ||||||
|  |                     inline=True, | ||||||
|  |                     context={ | ||||||
|  |                         "request": request, | ||||||
|  |                         "response": resp, | ||||||
|  |                     }, | ||||||
|  |                 ) | ||||||
|  |                 await response.eof() | ||||||
|  |             else: | ||||||
|  |                 if not hasattr(handler, "is_websocket"): | ||||||
|  |                     raise ServerError( | ||||||
|  |                         f"Invalid response type {response!r} " | ||||||
|  |                         "(need HTTPResponse)" | ||||||
|  |                     ) | ||||||
|  |  | ||||||
|  |         except CancelledError: | ||||||
|  |             raise | ||||||
|  |         except Exception as e: | ||||||
|  |             # Response Generation Failed | ||||||
|  |             await self.handle_exception(request, e) | ||||||
|  |  | ||||||
|     async def _websocket_handler( |     async def _websocket_handler( | ||||||
|         self, handler, request, *args, subprotocols=None, **kwargs |         self, handler, request, *args, subprotocols=None, **kwargs | ||||||
| @@ -731,10 +988,10 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         cancelled = False |         cancelled = False | ||||||
|         try: |         try: | ||||||
|             await fut |             await fut | ||||||
|         except (CancelledError, ConnectionClosed): |  | ||||||
|             cancelled = True |  | ||||||
|         except Exception as e: |         except Exception as e: | ||||||
|             self.error_handler.log(request, e) |             self.error_handler.log(request, e) | ||||||
|  |         except (CancelledError, ConnectionClosed): | ||||||
|  |             cancelled = True | ||||||
|         finally: |         finally: | ||||||
|             self.websocket_tasks.remove(fut) |             self.websocket_tasks.remove(fut) | ||||||
|             if cancelled: |             if cancelled: | ||||||
| @@ -761,7 +1018,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|     def asgi_client(self):  # noqa |     def asgi_client(self):  # noqa | ||||||
|         """ |         """ | ||||||
|         A testing client that uses ASGI to reach into the application to |         A testing client that uses ASGI to reach into the application to | ||||||
|         execute handlers. |         execute hanlers. | ||||||
|  |  | ||||||
|         :return: testing client |         :return: testing client | ||||||
|         :rtype: :class:`SanicASGITestClient` |         :rtype: :class:`SanicASGITestClient` | ||||||
| @@ -780,72 +1037,86 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|     # -------------------------------------------------------------------- # |     # -------------------------------------------------------------------- # | ||||||
|  |  | ||||||
|     async def _run_request_middleware( |     async def _run_request_middleware( | ||||||
|         self, request, middleware_collection |         self, request, request_name=None | ||||||
|     ):  # no cov |     ):  # no cov | ||||||
|         request._request_middleware_started = True |         # The if improves speed.  I don't know why | ||||||
|  |         named_middleware = self.named_request_middleware.get( | ||||||
|  |             request_name, deque() | ||||||
|  |         ) | ||||||
|  |         applicable_middleware = self.request_middleware + named_middleware | ||||||
|  |  | ||||||
|         for middleware in middleware_collection: |         # request.request_middleware_started is meant as a stop-gap solution | ||||||
|             await self.dispatch( |         # until RFC 1630 is adopted | ||||||
|                 "http.middleware.before", |         if applicable_middleware and not request.request_middleware_started: | ||||||
|                 inline=True, |             request.request_middleware_started = True | ||||||
|                 context={ |  | ||||||
|                     "request": request, |  | ||||||
|                     "response": None, |  | ||||||
|                 }, |  | ||||||
|                 condition={"attach_to": "request"}, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|             response = middleware(request) |             for middleware in applicable_middleware: | ||||||
|             if isawaitable(response): |                 await self.dispatch( | ||||||
|                 response = await response |                     "http.middleware.before", | ||||||
|  |                     inline=True, | ||||||
|  |                     context={ | ||||||
|  |                         "request": request, | ||||||
|  |                         "response": None, | ||||||
|  |                     }, | ||||||
|  |                     condition={"attach_to": "request"}, | ||||||
|  |                 ) | ||||||
|  |  | ||||||
|             await self.dispatch( |                 response = middleware(request) | ||||||
|                 "http.middleware.after", |                 if isawaitable(response): | ||||||
|                 inline=True, |                     response = await response | ||||||
|                 context={ |  | ||||||
|                     "request": request, |  | ||||||
|                     "response": None, |  | ||||||
|                 }, |  | ||||||
|                 condition={"attach_to": "request"}, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|             if response: |                 await self.dispatch( | ||||||
|                 return response |                     "http.middleware.after", | ||||||
|  |                     inline=True, | ||||||
|  |                     context={ | ||||||
|  |                         "request": request, | ||||||
|  |                         "response": None, | ||||||
|  |                     }, | ||||||
|  |                     condition={"attach_to": "request"}, | ||||||
|  |                 ) | ||||||
|  |  | ||||||
|  |                 if response: | ||||||
|  |                     return response | ||||||
|         return None |         return None | ||||||
|  |  | ||||||
|     async def _run_response_middleware( |     async def _run_response_middleware( | ||||||
|         self, request, response, middleware_collection |         self, request, response, request_name=None | ||||||
|     ):  # no cov |     ):  # no cov | ||||||
|         for middleware in middleware_collection: |         named_middleware = self.named_response_middleware.get( | ||||||
|             await self.dispatch( |             request_name, deque() | ||||||
|                 "http.middleware.before", |         ) | ||||||
|                 inline=True, |         applicable_middleware = self.response_middleware + named_middleware | ||||||
|                 context={ |         if applicable_middleware: | ||||||
|                     "request": request, |             for middleware in applicable_middleware: | ||||||
|                     "response": response, |                 await self.dispatch( | ||||||
|                 }, |                     "http.middleware.before", | ||||||
|                 condition={"attach_to": "response"}, |                     inline=True, | ||||||
|             ) |                     context={ | ||||||
|  |                         "request": request, | ||||||
|  |                         "response": response, | ||||||
|  |                     }, | ||||||
|  |                     condition={"attach_to": "response"}, | ||||||
|  |                 ) | ||||||
|  |  | ||||||
|             _response = middleware(request, response) |                 _response = middleware(request, response) | ||||||
|             if isawaitable(_response): |                 if isawaitable(_response): | ||||||
|                 _response = await _response |                     _response = await _response | ||||||
|  |  | ||||||
|             await self.dispatch( |                 await self.dispatch( | ||||||
|                 "http.middleware.after", |                     "http.middleware.after", | ||||||
|                 inline=True, |                     inline=True, | ||||||
|                 context={ |                     context={ | ||||||
|                     "request": request, |                         "request": request, | ||||||
|                     "response": _response if _response else response, |                         "response": _response if _response else response, | ||||||
|                 }, |                     }, | ||||||
|                 condition={"attach_to": "response"}, |                     condition={"attach_to": "response"}, | ||||||
|             ) |                 ) | ||||||
|  |  | ||||||
|             if _response: |                 if _response: | ||||||
|                 response = _response |                     response = _response | ||||||
|                 if isinstance(response, BaseHTTPResponse): |                     if isinstance(response, BaseHTTPResponse): | ||||||
|                     response = request.stream.respond(response) |                         response = request.stream.respond(response) | ||||||
|                 break |                     break | ||||||
|         return response |         return response | ||||||
|  |  | ||||||
|     def _build_endpoint_name(self, *parts): |     def _build_endpoint_name(self, *parts): | ||||||
| @@ -861,10 +1132,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|     async def _listener( |     async def _listener( | ||||||
|         app: Sanic, loop: AbstractEventLoop, listener: ListenerType |         app: Sanic, loop: AbstractEventLoop, listener: ListenerType | ||||||
|     ): |     ): | ||||||
|         try: |         maybe_coro = listener(app, loop) | ||||||
|             maybe_coro = listener(app)  # type: ignore |  | ||||||
|         except TypeError: |  | ||||||
|             maybe_coro = listener(app, loop)  # type: ignore |  | ||||||
|         if maybe_coro and isawaitable(maybe_coro): |         if maybe_coro and isawaitable(maybe_coro): | ||||||
|             await maybe_coro |             await maybe_coro | ||||||
|  |  | ||||||
| @@ -932,7 +1200,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         *, |         *, | ||||||
|         name: Optional[str] = None, |         name: Optional[str] = None, | ||||||
|         register: bool = True, |         register: bool = True, | ||||||
|     ) -> Optional[Task[Any]]: |     ) -> Optional[Task]: | ||||||
|         """ |         """ | ||||||
|         Schedule a task to run later, after the loop has started. |         Schedule a task to run later, after the loop has started. | ||||||
|         Different from asyncio.ensure_future in that it does not |         Different from asyncio.ensure_future in that it does not | ||||||
| @@ -942,7 +1210,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         `See user guide re: background tasks |         `See user guide re: background tasks | ||||||
|         <https://sanicframework.org/guide/basics/tasks.html#background-tasks>`__ |         <https://sanicframework.org/guide/basics/tasks.html#background-tasks>`__ | ||||||
|  |  | ||||||
|         :param task: future, coroutine or awaitable |         :param task: future, couroutine or awaitable | ||||||
|         """ |         """ | ||||||
|         try: |         try: | ||||||
|             loop = self.loop  # Will raise SanicError if loop is not started |             loop = self.loop  # Will raise SanicError if loop is not started | ||||||
| @@ -1000,9 +1268,10 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|                 ... |                 ... | ||||||
|  |  | ||||||
|     def purge_tasks(self): |     def purge_tasks(self): | ||||||
|         for key, task in self._task_registry.items(): |         for task in self.tasks: | ||||||
|             if task.done() or task.cancelled(): |             if task.done() or task.cancelled(): | ||||||
|                 self._task_registry[key] = None |                 name = task.get_name() | ||||||
|  |                 self._task_registry[name] = None | ||||||
|  |  | ||||||
|         self._task_registry = { |         self._task_registry = { | ||||||
|             k: v for k, v in self._task_registry.items() if v is not None |             k: v for k, v in self._task_registry.items() if v is not None | ||||||
| @@ -1063,7 +1332,7 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         self.config.update_config(config) |         self.config.update_config(config) | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def asgi(self) -> bool: |     def asgi(self): | ||||||
|         return self.state.asgi |         return self.state.asgi | ||||||
|  |  | ||||||
|     @asgi.setter |     @asgi.setter | ||||||
| @@ -1093,13 +1362,9 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|     @auto_reload.setter |     @auto_reload.setter | ||||||
|     def auto_reload(self, value: bool): |     def auto_reload(self, value: bool): | ||||||
|         self.config.AUTO_RELOAD = value |         self.config.AUTO_RELOAD = value | ||||||
|         self.state.auto_reload = value |  | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def state(self) -> ApplicationState:  # type: ignore |     def state(self): | ||||||
|         """ |  | ||||||
|         :return: The application state |  | ||||||
|         """ |  | ||||||
|         return self._state |         return self._state | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
| @@ -1211,18 +1476,6 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|  |  | ||||||
|         cls._app_registry[name] = app |         cls._app_registry[name] = app | ||||||
|  |  | ||||||
|     @classmethod |  | ||||||
|     def unregister_app(cls, app: "Sanic") -> None: |  | ||||||
|         """ |  | ||||||
|         Unregister a Sanic instance |  | ||||||
|         """ |  | ||||||
|         if not isinstance(app, cls): |  | ||||||
|             raise SanicException("Registered app must be an instance of Sanic") |  | ||||||
|  |  | ||||||
|         name = app.name |  | ||||||
|         if name in cls._app_registry: |  | ||||||
|             del cls._app_registry[name] |  | ||||||
|  |  | ||||||
|     @classmethod |     @classmethod | ||||||
|     def get_app( |     def get_app( | ||||||
|         cls, name: Optional[str] = None, *, force_create: bool = False |         cls, name: Optional[str] = None, *, force_create: bool = False | ||||||
| @@ -1242,8 +1495,6 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         try: |         try: | ||||||
|             return cls._app_registry[name] |             return cls._app_registry[name] | ||||||
|         except KeyError: |         except KeyError: | ||||||
|             if name == "__main__": |  | ||||||
|                 return cls.get_app("__mp_main__", force_create=force_create) |  | ||||||
|             if force_create: |             if force_create: | ||||||
|                 return cls(name) |                 return cls(name) | ||||||
|             raise SanicException(f'Sanic app name "{name}" not found.') |             raise SanicException(f'Sanic app name "{name}" not found.') | ||||||
| @@ -1258,10 +1509,8 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         except FinalizationError as e: |         except FinalizationError as e: | ||||||
|             if not Sanic.test_mode: |             if not Sanic.test_mode: | ||||||
|                 raise e |                 raise e | ||||||
|         self.finalize_middleware() |  | ||||||
|  |  | ||||||
|     def signalize(self, allow_fail_builtin=True): |     def signalize(self): | ||||||
|         self.signal_router.allow_fail_builtin = allow_fail_builtin |  | ||||||
|         try: |         try: | ||||||
|             self.signal_router.finalize() |             self.signal_router.finalize() | ||||||
|         except FinalizationError as e: |         except FinalizationError as e: | ||||||
| @@ -1276,27 +1525,10 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         if hasattr(self, "_ext"): |         if hasattr(self, "_ext"): | ||||||
|             self.ext._display() |             self.ext._display() | ||||||
|  |  | ||||||
|         if self.state.is_debug and self.config.TOUCHUP is not True: |  | ||||||
|             self.config.TOUCHUP = False |  | ||||||
|         elif self.config.TOUCHUP is _default: |  | ||||||
|             self.config.TOUCHUP = True |  | ||||||
|  |  | ||||||
|         # Setup routers |         # Setup routers | ||||||
|         self.signalize(self.config.TOUCHUP) |         self.signalize() | ||||||
|         self.finalize() |         self.finalize() | ||||||
|  |  | ||||||
|         route_names = [route.name for route in self.router.routes] |  | ||||||
|         duplicates = { |  | ||||||
|             name for name in route_names if route_names.count(name) > 1 |  | ||||||
|         } |  | ||||||
|         if duplicates: |  | ||||||
|             names = ", ".join(duplicates) |  | ||||||
|             deprecation( |  | ||||||
|                 f"Duplicate route names detected: {names}. In the future, " |  | ||||||
|                 "Sanic will enforce uniqueness in route naming.", |  | ||||||
|                 23.3, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|         # TODO: Replace in v22.6 to check against apps in app registry |         # TODO: Replace in v22.6 to check against apps in app registry | ||||||
|         if ( |         if ( | ||||||
|             self.__class__._uvloop_setting is not None |             self.__class__._uvloop_setting is not None | ||||||
| @@ -1313,14 +1545,11 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|         if self.state.primary: |         if self.state.primary: | ||||||
|             # TODO: |             # TODO: | ||||||
|             # - Raise warning if secondary apps have error handler config |             # - Raise warning if secondary apps have error handler config | ||||||
|             if self.config.TOUCHUP: |             ErrorHandler.finalize(self.error_handler, config=self.config) | ||||||
|                 TouchUp.run(self) |             TouchUp.run(self) | ||||||
|  |  | ||||||
|         self.state.is_started = True |         self.state.is_started = True | ||||||
|  |  | ||||||
|         if hasattr(self, "multiplexer"): |  | ||||||
|             self.multiplexer.ack() |  | ||||||
|  |  | ||||||
|     async def _server_event( |     async def _server_event( | ||||||
|         self, |         self, | ||||||
|         concern: str, |         concern: str, | ||||||
| @@ -1333,9 +1562,8 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|             "shutdown", |             "shutdown", | ||||||
|         ): |         ): | ||||||
|             raise SanicException(f"Invalid server event: {event}") |             raise SanicException(f"Invalid server event: {event}") | ||||||
|         logger.debug( |         if self.state.verbosity >= 1: | ||||||
|             f"Triggering server events: {event}", extra={"verbosity": 1} |             logger.debug(f"Triggering server events: {event}") | ||||||
|         ) |  | ||||||
|         reverse = concern == "shutdown" |         reverse = concern == "shutdown" | ||||||
|         if loop is None: |         if loop is None: | ||||||
|             loop = self.loop |             loop = self.loop | ||||||
| @@ -1349,43 +1577,3 @@ class Sanic(BaseSanic, StartupMixin, metaclass=TouchUpMeta): | |||||||
|                 "loop": loop, |                 "loop": loop, | ||||||
|             }, |             }, | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     # -------------------------------------------------------------------- # |  | ||||||
|     # Process Management |  | ||||||
|     # -------------------------------------------------------------------- # |  | ||||||
|  |  | ||||||
|     def refresh( |  | ||||||
|         self, |  | ||||||
|         passthru: Optional[Dict[str, Any]] = None, |  | ||||||
|     ): |  | ||||||
|         registered = self.__class__.get_app(self.name) |  | ||||||
|         if self is not registered: |  | ||||||
|             if not registered.state.server_info: |  | ||||||
|                 registered.state.server_info = self.state.server_info |  | ||||||
|             self = registered |  | ||||||
|         if passthru: |  | ||||||
|             for attr, info in passthru.items(): |  | ||||||
|                 if isinstance(info, dict): |  | ||||||
|                     for key, value in info.items(): |  | ||||||
|                         setattr(getattr(self, attr), key, value) |  | ||||||
|                 else: |  | ||||||
|                     setattr(self, attr, info) |  | ||||||
|         if hasattr(self, "multiplexer"): |  | ||||||
|             self.shared_ctx.lock() |  | ||||||
|         return self |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def inspector(self): |  | ||||||
|         if environ.get("SANIC_WORKER_PROCESS") or not self._inspector: |  | ||||||
|             raise SanicException( |  | ||||||
|                 "Can only access the inspector from the main process" |  | ||||||
|             ) |  | ||||||
|         return self._inspector |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def manager(self): |  | ||||||
|         if environ.get("SANIC_WORKER_PROCESS") or not self._manager: |  | ||||||
|             raise SanicException( |  | ||||||
|                 "Can only access the manager from the main process" |  | ||||||
|             ) |  | ||||||
|         return self._manager |  | ||||||
|   | |||||||
| @@ -1,32 +0,0 @@ | |||||||
| 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() |  | ||||||
| @@ -5,7 +5,7 @@ from importlib import import_module | |||||||
| from typing import TYPE_CHECKING | from typing import TYPE_CHECKING | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic import Sanic |     from sanic import Sanic | ||||||
|  |  | ||||||
|     try: |     try: | ||||||
| @@ -22,7 +22,7 @@ def setup_ext(app: Sanic, *, fail: bool = False, **kwargs): | |||||||
|     with suppress(ModuleNotFoundError): |     with suppress(ModuleNotFoundError): | ||||||
|         sanic_ext = import_module("sanic_ext") |         sanic_ext = import_module("sanic_ext") | ||||||
|  |  | ||||||
|     if not sanic_ext:  # no cov |     if not sanic_ext: | ||||||
|         if fail: |         if fail: | ||||||
|             raise RuntimeError( |             raise RuntimeError( | ||||||
|                 "Sanic Extensions is not installed. You can add it to your " |                 "Sanic Extensions is not installed. You can add it to your " | ||||||
|   | |||||||
| @@ -3,8 +3,6 @@ import sys | |||||||
|  |  | ||||||
| from os import environ | from os import environ | ||||||
|  |  | ||||||
| from sanic.compat import is_atty |  | ||||||
|  |  | ||||||
|  |  | ||||||
| BASE_LOGO = """ | BASE_LOGO = """ | ||||||
|  |  | ||||||
| @@ -46,7 +44,7 @@ ansi_pattern = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])") | |||||||
| def get_logo(full=False, coffee=False): | def get_logo(full=False, coffee=False): | ||||||
|     logo = ( |     logo = ( | ||||||
|         (FULL_COLOR_LOGO if full else (COFFEE_LOGO if coffee else COLOR_LOGO)) |         (FULL_COLOR_LOGO if full else (COFFEE_LOGO if coffee else COLOR_LOGO)) | ||||||
|         if is_atty() |         if sys.stdout.isatty() | ||||||
|         else BASE_LOGO |         else BASE_LOGO | ||||||
|     ) |     ) | ||||||
|  |  | ||||||
|   | |||||||
| @@ -1,10 +1,11 @@ | |||||||
|  | import sys | ||||||
|  |  | ||||||
| from abc import ABC, abstractmethod | from abc import ABC, abstractmethod | ||||||
| from shutil import get_terminal_size | from shutil import get_terminal_size | ||||||
| from textwrap import indent, wrap | from textwrap import indent, wrap | ||||||
| from typing import Dict, Optional | from typing import Dict, Optional | ||||||
|  |  | ||||||
| from sanic import __version__ | from sanic import __version__ | ||||||
| from sanic.compat import is_atty |  | ||||||
| from sanic.log import logger | from sanic.log import logger | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -35,7 +36,7 @@ class MOTD(ABC): | |||||||
|         data: Dict[str, str], |         data: Dict[str, str], | ||||||
|         extra: Dict[str, str], |         extra: Dict[str, str], | ||||||
|     ) -> None: |     ) -> None: | ||||||
|         motd_class = MOTDTTY if is_atty() else MOTDBasic |         motd_class = MOTDTTY if sys.stdout.isatty() else MOTDBasic | ||||||
|         motd_class(logo, serve_location, data, extra).display() |         motd_class(logo, serve_location, data, extra).display() | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -80,23 +81,20 @@ class MOTDTTY(MOTD): | |||||||
|         ) |         ) | ||||||
|         self.display_length = self.key_width + self.value_width + 2 |         self.display_length = self.key_width + self.value_width + 2 | ||||||
|  |  | ||||||
|     def display(self, version=True, action="Goin' Fast", out=None): |     def display(self): | ||||||
|         if not out: |         version = f"Sanic v{__version__}".center(self.centering_length) | ||||||
|             out = logger.info |  | ||||||
|         header = "Sanic" |  | ||||||
|         if version: |  | ||||||
|             header += f" v{__version__}" |  | ||||||
|         header = header.center(self.centering_length) |  | ||||||
|         running = ( |         running = ( | ||||||
|             f"{action} @ {self.serve_location}" if self.serve_location else "" |             f"Goin' Fast @ {self.serve_location}" | ||||||
|  |             if self.serve_location | ||||||
|  |             else "" | ||||||
|         ).center(self.centering_length) |         ).center(self.centering_length) | ||||||
|         length = len(header) + 2 - self.logo_line_length |         length = len(version) + 2 - self.logo_line_length | ||||||
|         first_filler = "─" * (self.logo_line_length - 1) |         first_filler = "─" * (self.logo_line_length - 1) | ||||||
|         second_filler = "─" * length |         second_filler = "─" * length | ||||||
|         display_filler = "─" * (self.display_length + 2) |         display_filler = "─" * (self.display_length + 2) | ||||||
|         lines = [ |         lines = [ | ||||||
|             f"\n┌{first_filler}─{second_filler}┐", |             f"\n┌{first_filler}─{second_filler}┐", | ||||||
|             f"│ {header} │", |             f"│ {version} │", | ||||||
|             f"│ {running} │", |             f"│ {running} │", | ||||||
|             f"├{first_filler}┬{second_filler}┤", |             f"├{first_filler}┬{second_filler}┤", | ||||||
|         ] |         ] | ||||||
| @@ -110,7 +108,7 @@ class MOTDTTY(MOTD): | |||||||
|         self._render_fill(lines) |         self._render_fill(lines) | ||||||
|  |  | ||||||
|         lines.append(f"└{first_filler}┴{second_filler}┘\n") |         lines.append(f"└{first_filler}┴{second_filler}┘\n") | ||||||
|         out(indent("\n".join(lines), "  ")) |         logger.info(indent("\n".join(lines), "  ")) | ||||||
|  |  | ||||||
|     def _render_data(self, lines, data, start): |     def _render_data(self, lines, data, start): | ||||||
|         offset = 0 |         offset = 0 | ||||||
|   | |||||||
| @@ -1,86 +0,0 @@ | |||||||
| 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,20 +3,42 @@ from __future__ import annotations | |||||||
| import logging | import logging | ||||||
|  |  | ||||||
| from dataclasses import dataclass, field | from dataclasses import dataclass, field | ||||||
|  | from enum import Enum, IntEnum, auto | ||||||
| from pathlib import Path | from pathlib import Path | ||||||
| from socket import socket | from socket import socket | ||||||
| from ssl import SSLContext | from ssl import SSLContext | ||||||
| from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Union | from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Union | ||||||
|  |  | ||||||
| from sanic.application.constants import Mode, Server, ServerStage | from sanic.log import logger | ||||||
| from sanic.log import VerbosityFilter, logger |  | ||||||
| from sanic.server.async_server import AsyncioServer | from sanic.server.async_server import AsyncioServer | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic import Sanic |     from sanic import Sanic | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class StrEnum(str, Enum): | ||||||
|  |     def _generate_next_value_(name: str, *args) -> str:  # type: ignore | ||||||
|  |         return name.lower() | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Server(StrEnum): | ||||||
|  |     SANIC = auto() | ||||||
|  |     ASGI = auto() | ||||||
|  |     GUNICORN = auto() | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class Mode(StrEnum): | ||||||
|  |     PRODUCTION = auto() | ||||||
|  |     DEBUG = auto() | ||||||
|  |  | ||||||
|  |  | ||||||
|  | class ServerStage(IntEnum): | ||||||
|  |     STOPPED = auto() | ||||||
|  |     PARTIAL = auto() | ||||||
|  |     SERVING = auto() | ||||||
|  |  | ||||||
|  |  | ||||||
| @dataclass | @dataclass | ||||||
| class ApplicationServerInfo: | class ApplicationServerInfo: | ||||||
|     settings: Dict[str, Any] |     settings: Dict[str, Any] | ||||||
| @@ -69,9 +91,6 @@ class ApplicationState: | |||||||
|         if getattr(self.app, "configure_logging", False) and self.app.debug: |         if getattr(self.app, "configure_logging", False) and self.app.debug: | ||||||
|             logger.setLevel(logging.DEBUG) |             logger.setLevel(logging.DEBUG) | ||||||
|  |  | ||||||
|     def set_verbosity(self, value: int): |  | ||||||
|         VerbosityFilter.verbosity = value |  | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def is_debug(self): |     def is_debug(self): | ||||||
|         return self.mode is Mode.DEBUG |         return self.mode is Mode.DEBUG | ||||||
|   | |||||||
| @@ -7,7 +7,6 @@ from urllib.parse import quote | |||||||
|  |  | ||||||
| from sanic.compat import Header | from sanic.compat import Header | ||||||
| from sanic.exceptions import ServerError | from sanic.exceptions import ServerError | ||||||
| from sanic.handlers import RequestManager |  | ||||||
| from sanic.helpers import _default | from sanic.helpers import _default | ||||||
| from sanic.http import Stage | from sanic.http import Stage | ||||||
| from sanic.log import logger | from sanic.log import logger | ||||||
| @@ -18,7 +17,7 @@ from sanic.server import ConnInfo | |||||||
| from sanic.server.websockets.connection import WebSocketConnection | from sanic.server.websockets.connection import WebSocketConnection | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic import Sanic |     from sanic import Sanic | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -26,28 +25,27 @@ class Lifespan: | |||||||
|     def __init__(self, asgi_app: ASGIApp) -> None: |     def __init__(self, asgi_app: ASGIApp) -> None: | ||||||
|         self.asgi_app = asgi_app |         self.asgi_app = asgi_app | ||||||
|  |  | ||||||
|         if ( |         if self.asgi_app.sanic_app.state.verbosity > 0: | ||||||
|             "server.init.before" |             if ( | ||||||
|             in self.asgi_app.sanic_app.signal_router.name_index |                 "server.init.before" | ||||||
|         ): |                 in self.asgi_app.sanic_app.signal_router.name_index | ||||||
|             logger.debug( |             ): | ||||||
|                 'You have set a listener for "before_server_start" ' |                 logger.debug( | ||||||
|                 "in ASGI mode. " |                     'You have set a listener for "before_server_start" ' | ||||||
|                 "It will be executed as early as possible, but not before " |                     "in ASGI mode. " | ||||||
|                 "the ASGI server is started.", |                     "It will be executed as early as possible, but not before " | ||||||
|                 extra={"verbosity": 1}, |                     "the ASGI server is started." | ||||||
|             ) |                 ) | ||||||
|         if ( |             if ( | ||||||
|             "server.shutdown.after" |                 "server.shutdown.after" | ||||||
|             in self.asgi_app.sanic_app.signal_router.name_index |                 in self.asgi_app.sanic_app.signal_router.name_index | ||||||
|         ): |             ): | ||||||
|             logger.debug( |                 logger.debug( | ||||||
|                 'You have set a listener for "after_server_stop" ' |                     'You have set a listener for "after_server_stop" ' | ||||||
|                 "in ASGI mode. " |                     "in ASGI mode. " | ||||||
|                 "It will be executed as late as possible, but not after " |                     "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: |     async def startup(self) -> None: | ||||||
|         """ |         """ | ||||||
| @@ -165,13 +163,6 @@ class ASGIApp: | |||||||
|             instance.request_body = True |             instance.request_body = True | ||||||
|             instance.request.conn_info = ConnInfo(instance.transport) |             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 |         return instance | ||||||
|  |  | ||||||
|     async def read(self) -> Optional[bytes]: |     async def read(self) -> Optional[bytes]: | ||||||
| @@ -231,9 +222,8 @@ class ASGIApp: | |||||||
|         """ |         """ | ||||||
|         Handle the incoming request. |         Handle the incoming request. | ||||||
|         """ |         """ | ||||||
|         manager = RequestManager.create(self.request) |  | ||||||
|         try: |         try: | ||||||
|             self.stage = Stage.HANDLER |             self.stage = Stage.HANDLER | ||||||
|             await manager.handle() |             await self.sanic_app.handle_request(self.request) | ||||||
|         except Exception as e: |         except Exception as e: | ||||||
|             await manager.error(e) |             await self.sanic_app.handle_exception(self.request, e) | ||||||
|   | |||||||
| @@ -5,7 +5,7 @@ from functools import partial | |||||||
| from typing import TYPE_CHECKING, List, Optional, Union | from typing import TYPE_CHECKING, List, Optional, Union | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic.blueprints import Blueprint |     from sanic.blueprints import Blueprint | ||||||
|  |  | ||||||
|  |  | ||||||
|   | |||||||
| @@ -21,8 +21,8 @@ from typing import ( | |||||||
|     Union, |     Union, | ||||||
| ) | ) | ||||||
|  |  | ||||||
| from sanic_routing.exceptions import NotFound | from sanic_routing.exceptions import NotFound  # type: ignore | ||||||
| from sanic_routing.route import Route | from sanic_routing.route import Route  # type: ignore | ||||||
|  |  | ||||||
| from sanic.base.root import BaseSanic | from sanic.base.root import BaseSanic | ||||||
| from sanic.blueprint_group import BlueprintGroup | from sanic.blueprint_group import BlueprintGroup | ||||||
| @@ -36,7 +36,7 @@ from sanic.models.handler_types import ( | |||||||
| ) | ) | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic import Sanic |     from sanic import Sanic | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -308,7 +308,7 @@ class Blueprint(BaseSanic): | |||||||
|             # prefixed properly in the router |             # prefixed properly in the router | ||||||
|             future.handler.__blueprintname__ = self.name |             future.handler.__blueprintname__ = self.name | ||||||
|             # Prepend the blueprint URI prefix if available |             # Prepend the blueprint URI prefix if available | ||||||
|             uri = self._setup_uri(future.uri, url_prefix) |             uri = url_prefix + future.uri if url_prefix else future.uri | ||||||
|  |  | ||||||
|             version_prefix = self.version_prefix |             version_prefix = self.version_prefix | ||||||
|             for prefix in ( |             for prefix in ( | ||||||
| @@ -333,7 +333,7 @@ class Blueprint(BaseSanic): | |||||||
|  |  | ||||||
|             apply_route = FutureRoute( |             apply_route = FutureRoute( | ||||||
|                 future.handler, |                 future.handler, | ||||||
|                 uri, |                 uri[1:] if uri.startswith("//") else uri, | ||||||
|                 future.methods, |                 future.methods, | ||||||
|                 host, |                 host, | ||||||
|                 strict_slashes, |                 strict_slashes, | ||||||
| @@ -363,7 +363,7 @@ class Blueprint(BaseSanic): | |||||||
|         # Static Files |         # Static Files | ||||||
|         for future in self._future_statics: |         for future in self._future_statics: | ||||||
|             # Prepend the blueprint URI prefix if available |             # Prepend the blueprint URI prefix if available | ||||||
|             uri = self._setup_uri(future.uri, url_prefix) |             uri = url_prefix + future.uri if url_prefix else future.uri | ||||||
|             apply_route = FutureStatic(uri, *future[1:]) |             apply_route = FutureStatic(uri, *future[1:]) | ||||||
|  |  | ||||||
|             if (self, apply_route) in app._future_registry: |             if (self, apply_route) in app._future_registry: | ||||||
| @@ -456,18 +456,6 @@ class Blueprint(BaseSanic): | |||||||
|                 break |                 break | ||||||
|         return value |         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 |     @staticmethod | ||||||
|     def register_futures( |     def register_futures( | ||||||
|         apps: Set[Sanic], bp: Blueprint, futures: Sequence[Tuple[Any, ...]] |         apps: Set[Sanic], bp: Blueprint, futures: Sequence[Tuple[Any, ...]] | ||||||
|   | |||||||
							
								
								
									
										115
									
								
								sanic/cli/app.py
									
									
									
									
									
								
							
							
						
						
									
										115
									
								
								sanic/cli/app.py
									
									
									
									
									
								
							| @@ -1,10 +1,10 @@ | |||||||
| import logging |  | ||||||
| import os | import os | ||||||
| import shutil | import shutil | ||||||
| import sys | import sys | ||||||
|  |  | ||||||
| from argparse import ArgumentParser, RawTextHelpFormatter | from argparse import ArgumentParser, RawTextHelpFormatter | ||||||
| from functools import partial | from importlib import import_module | ||||||
|  | from pathlib import Path | ||||||
| from textwrap import indent | from textwrap import indent | ||||||
| from typing import Any, List, Union | from typing import Any, List, Union | ||||||
|  |  | ||||||
| @@ -12,8 +12,7 @@ from sanic.app import Sanic | |||||||
| from sanic.application.logo import get_logo | from sanic.application.logo import get_logo | ||||||
| from sanic.cli.arguments import Group | from sanic.cli.arguments import Group | ||||||
| from sanic.log import error_logger | from sanic.log import error_logger | ||||||
| from sanic.worker.inspector import inspect | from sanic.simple import create_simple_server | ||||||
| from sanic.worker.loader import AppLoader |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class SanicArgumentParser(ArgumentParser): | class SanicArgumentParser(ArgumentParser): | ||||||
| @@ -59,73 +58,28 @@ Or, a path to a directory to run as a simple HTTP server: | |||||||
|             os.environ.get("SANIC_RELOADER_PROCESS", "") != "true" |             os.environ.get("SANIC_RELOADER_PROCESS", "") != "true" | ||||||
|         ) |         ) | ||||||
|         self.args: List[Any] = [] |         self.args: List[Any] = [] | ||||||
|         self.groups: List[Group] = [] |  | ||||||
|  |  | ||||||
|     def attach(self): |     def attach(self): | ||||||
|         for group in Group._registry: |         for group in Group._registry: | ||||||
|             instance = group.create(self.parser) |             group.create(self.parser).attach() | ||||||
|             instance.attach() |  | ||||||
|             self.groups.append(instance) |  | ||||||
|  |  | ||||||
|     def run(self, parse_args=None): |     def run(self): | ||||||
|         legacy_version = False |         # This is to provide backwards compat -v to display version | ||||||
|         if not parse_args: |         legacy_version = len(sys.argv) == 2 and sys.argv[-1] == "-v" | ||||||
|             # This is to provide backwards compat -v to display version |         parse_args = ["--version"] if legacy_version else None | ||||||
|             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.args = self.parser.parse_args(args=parse_args) | ||||||
|         self._precheck() |         self._precheck() | ||||||
|         app_loader = AppLoader( |  | ||||||
|             self.args.module, |  | ||||||
|             self.args.factory, |  | ||||||
|             self.args.simple, |  | ||||||
|             self.args, |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|         try: |         try: | ||||||
|             app = self._get_app(app_loader) |             app = self._get_app() | ||||||
|             kwargs = self._build_run_kwargs() |             kwargs = self._build_run_kwargs() | ||||||
|         except ValueError as e: |             app.run(**kwargs) | ||||||
|             error_logger.exception(f"Failed to run app: {e}") |         except ValueError: | ||||||
|         else: |             error_logger.exception("Failed to run app") | ||||||
|             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): |     def _precheck(self): | ||||||
|         # Custom TLS mismatch handling for better diagnostics |         # # Custom TLS mismatch handling for better diagnostics | ||||||
|         if self.main_process and ( |         if self.main_process and ( | ||||||
|             # one of cert/key missing |             # one of cert/key missing | ||||||
|             bool(self.args.cert) != bool(self.args.key) |             bool(self.args.cert) != bool(self.args.key) | ||||||
| @@ -145,27 +99,48 @@ Or, a path to a directory to run as a simple HTTP server: | |||||||
|             ) |             ) | ||||||
|             error_logger.error(message) |             error_logger.error(message) | ||||||
|             sys.exit(1) |             sys.exit(1) | ||||||
|         if self.args.inspect or self.args.inspect_raw: |  | ||||||
|             logging.disable(logging.CRITICAL) |  | ||||||
|  |  | ||||||
|     def _get_app(self, app_loader: AppLoader): |     def _get_app(self): | ||||||
|         try: |         try: | ||||||
|             app = app_loader.load() |             module_path = os.path.abspath(os.getcwd()) | ||||||
|  |             if module_path not in sys.path: | ||||||
|  |                 sys.path.append(module_path) | ||||||
|  |  | ||||||
|  |             if self.args.simple: | ||||||
|  |                 path = Path(self.args.module) | ||||||
|  |                 app = create_simple_server(path) | ||||||
|  |             else: | ||||||
|  |                 delimiter = ":" if ":" in self.args.module else "." | ||||||
|  |                 module_name, app_name = self.args.module.rsplit(delimiter, 1) | ||||||
|  |  | ||||||
|  |                 if app_name.endswith("()"): | ||||||
|  |                     self.args.factory = True | ||||||
|  |                     app_name = app_name[:-2] | ||||||
|  |  | ||||||
|  |                 module = import_module(module_name) | ||||||
|  |                 app = getattr(module, app_name, None) | ||||||
|  |                 if self.args.factory: | ||||||
|  |                     app = app() | ||||||
|  |  | ||||||
|  |                 app_type_name = type(app).__name__ | ||||||
|  |  | ||||||
|  |                 if not isinstance(app, Sanic): | ||||||
|  |                     raise ValueError( | ||||||
|  |                         f"Module is not a Sanic app, it is a {app_type_name}\n" | ||||||
|  |                         f"  Perhaps you meant {self.args.module}.app?" | ||||||
|  |                     ) | ||||||
|         except ImportError as e: |         except ImportError as e: | ||||||
|             if app_loader.module_name.startswith(e.name):  # type: ignore |             if module_name.startswith(e.name): | ||||||
|                 error_logger.error( |                 error_logger.error( | ||||||
|                     f"No module named {e.name} found.\n" |                     f"No module named {e.name} found.\n" | ||||||
|                     "  Example File: project/sanic_server.py -> app\n" |                     "  Example File: project/sanic_server.py -> app\n" | ||||||
|                     "  Example Module: project.sanic_server.app" |                     "  Example Module: project.sanic_server.app" | ||||||
|                 ) |                 ) | ||||||
|                 sys.exit(1) |  | ||||||
|             else: |             else: | ||||||
|                 raise e |                 raise e | ||||||
|         return app |         return app | ||||||
|  |  | ||||||
|     def _build_run_kwargs(self): |     def _build_run_kwargs(self): | ||||||
|         for group in self.groups: |  | ||||||
|             group.prepare(self.args) |  | ||||||
|         ssl: Union[None, dict, str, list] = [] |         ssl: Union[None, dict, str, list] = [] | ||||||
|         if self.args.tlshost: |         if self.args.tlshost: | ||||||
|             ssl.append(None) |             ssl.append(None) | ||||||
| @@ -178,10 +153,8 @@ Or, a path to a directory to run as a simple HTTP server: | |||||||
|         elif len(ssl) == 1 and ssl[0] is not None: |         elif len(ssl) == 1 and ssl[0] is not None: | ||||||
|             # Use only one cert, no TLSSelector. |             # Use only one cert, no TLSSelector. | ||||||
|             ssl = ssl[0] |             ssl = ssl[0] | ||||||
|  |  | ||||||
|         kwargs = { |         kwargs = { | ||||||
|             "access_log": self.args.access_log, |             "access_log": self.args.access_log, | ||||||
|             "coffee": self.args.coffee, |  | ||||||
|             "debug": self.args.debug, |             "debug": self.args.debug, | ||||||
|             "fast": self.args.fast, |             "fast": self.args.fast, | ||||||
|             "host": self.args.host, |             "host": self.args.host, | ||||||
| @@ -192,9 +165,6 @@ Or, a path to a directory to run as a simple HTTP server: | |||||||
|             "unix": self.args.unix, |             "unix": self.args.unix, | ||||||
|             "verbosity": self.args.verbosity or 0, |             "verbosity": self.args.verbosity or 0, | ||||||
|             "workers": self.args.workers, |             "workers": self.args.workers, | ||||||
|             "auto_tls": self.args.auto_tls, |  | ||||||
|             "single_process": self.args.single, |  | ||||||
|             "legacy": self.args.legacy, |  | ||||||
|         } |         } | ||||||
|  |  | ||||||
|         for maybe_arg in ("auto_reload", "dev"): |         for maybe_arg in ("auto_reload", "dev"): | ||||||
| @@ -204,5 +174,4 @@ Or, a path to a directory to run as a simple HTTP server: | |||||||
|         if self.args.path: |         if self.args.path: | ||||||
|             kwargs["auto_reload"] = True |             kwargs["auto_reload"] = True | ||||||
|             kwargs["reload_dir"] = self.args.path |             kwargs["reload_dir"] = self.args.path | ||||||
|  |  | ||||||
|         return kwargs |         return kwargs | ||||||
|   | |||||||
| @@ -3,10 +3,9 @@ from __future__ import annotations | |||||||
| from argparse import ArgumentParser, _ArgumentGroup | from argparse import ArgumentParser, _ArgumentGroup | ||||||
| from typing import List, Optional, Type, Union | from typing import List, Optional, Type, Union | ||||||
|  |  | ||||||
| from sanic_routing import __version__ as __routing_version__ | from sanic_routing import __version__ as __routing_version__  # type: ignore | ||||||
|  |  | ||||||
| from sanic import __version__ | from sanic import __version__ | ||||||
| from sanic.http.constants import HTTP |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class Group: | class Group: | ||||||
| @@ -30,7 +29,7 @@ class Group: | |||||||
|         instance = cls(parser, cls.name) |         instance = cls(parser, cls.name) | ||||||
|         return instance |         return instance | ||||||
|  |  | ||||||
|     def add_bool_arguments(self, *args, nullable=False, **kwargs): |     def add_bool_arguments(self, *args, **kwargs): | ||||||
|         group = self.container.add_mutually_exclusive_group() |         group = self.container.add_mutually_exclusive_group() | ||||||
|         kwargs["help"] = kwargs["help"].capitalize() |         kwargs["help"] = kwargs["help"].capitalize() | ||||||
|         group.add_argument(*args, action="store_true", **kwargs) |         group.add_argument(*args, action="store_true", **kwargs) | ||||||
| @@ -38,12 +37,6 @@ class Group: | |||||||
|         group.add_argument( |         group.add_argument( | ||||||
|             "--no-" + args[0][2:], *args[1:], action="store_false", **kwargs |             "--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): | class GeneralGroup(Group): | ||||||
| @@ -70,8 +63,7 @@ class ApplicationGroup(Group): | |||||||
|     name = "Application" |     name = "Application" | ||||||
|  |  | ||||||
|     def attach(self): |     def attach(self): | ||||||
|         group = self.container.add_mutually_exclusive_group() |         self.container.add_argument( | ||||||
|         group.add_argument( |  | ||||||
|             "--factory", |             "--factory", | ||||||
|             action="store_true", |             action="store_true", | ||||||
|             help=( |             help=( | ||||||
| @@ -79,7 +71,7 @@ class ApplicationGroup(Group): | |||||||
|                 "i.e. a () -> <Sanic app> callable" |                 "i.e. a () -> <Sanic app> callable" | ||||||
|             ), |             ), | ||||||
|         ) |         ) | ||||||
|         group.add_argument( |         self.container.add_argument( | ||||||
|             "-s", |             "-s", | ||||||
|             "--simple", |             "--simple", | ||||||
|             dest="simple", |             dest="simple", | ||||||
| @@ -89,70 +81,6 @@ class ApplicationGroup(Group): | |||||||
|                 "a directory\n(module arg should be a path)" |                 "a directory\n(module arg should be a path)" | ||||||
|             ), |             ), | ||||||
|         ) |         ) | ||||||
|         group.add_argument( |  | ||||||
|             "--inspect", |  | ||||||
|             dest="inspect", |  | ||||||
|             action="store_true", |  | ||||||
|             help=("Inspect the state of a running instance, human readable"), |  | ||||||
|         ) |  | ||||||
|         group.add_argument( |  | ||||||
|             "--inspect-raw", |  | ||||||
|             dest="inspect_raw", |  | ||||||
|             action="store_true", |  | ||||||
|             help=("Inspect the state of a running instance, JSON output"), |  | ||||||
|         ) |  | ||||||
|         group.add_argument( |  | ||||||
|             "--trigger-reload", |  | ||||||
|             dest="trigger", |  | ||||||
|             action="store_const", |  | ||||||
|             const="reload", |  | ||||||
|             help=("Trigger worker processes to reload"), |  | ||||||
|         ) |  | ||||||
|         group.add_argument( |  | ||||||
|             "--trigger-shutdown", |  | ||||||
|             dest="trigger", |  | ||||||
|             action="store_const", |  | ||||||
|             const="shutdown", |  | ||||||
|             help=("Trigger all processes to shutdown"), |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class HTTPVersionGroup(Group): |  | ||||||
|     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): | class SocketGroup(Group): | ||||||
| @@ -164,6 +92,7 @@ class SocketGroup(Group): | |||||||
|             "--host", |             "--host", | ||||||
|             dest="host", |             dest="host", | ||||||
|             type=str, |             type=str, | ||||||
|  |             default="127.0.0.1", | ||||||
|             help="Host address [default 127.0.0.1]", |             help="Host address [default 127.0.0.1]", | ||||||
|         ) |         ) | ||||||
|         self.container.add_argument( |         self.container.add_argument( | ||||||
| @@ -171,6 +100,7 @@ class SocketGroup(Group): | |||||||
|             "--port", |             "--port", | ||||||
|             dest="port", |             dest="port", | ||||||
|             type=int, |             type=int, | ||||||
|  |             default=8000, | ||||||
|             help="Port to serve on [default 8000]", |             help="Port to serve on [default 8000]", | ||||||
|         ) |         ) | ||||||
|         self.container.add_argument( |         self.container.add_argument( | ||||||
| @@ -237,22 +167,8 @@ class WorkerGroup(Group): | |||||||
|             action="store_true", |             action="store_true", | ||||||
|             help="Set the number of workers to max allowed", |             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( |         self.add_bool_arguments( | ||||||
|             "--access-logs", |             "--access-logs", dest="access_log", help="display access logs" | ||||||
|             dest="access_log", |  | ||||||
|             help="display access logs", |  | ||||||
|             default=None, |  | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -264,7 +180,11 @@ class DevelopmentGroup(Group): | |||||||
|             "--debug", |             "--debug", | ||||||
|             dest="debug", |             dest="debug", | ||||||
|             action="store_true", |             action="store_true", | ||||||
|             help="Run the server in debug mode", |             help=( | ||||||
|  |                 "Run the server in DEBUG mode. It includes DEBUG logging,\n" | ||||||
|  |                 "additional context on exceptions, and other settings\n" | ||||||
|  |                 "not-safe for PRODUCTION, but helpful for debugging problems." | ||||||
|  |             ), | ||||||
|         ) |         ) | ||||||
|         self.container.add_argument( |         self.container.add_argument( | ||||||
|             "-r", |             "-r", | ||||||
| @@ -289,16 +209,7 @@ class DevelopmentGroup(Group): | |||||||
|             "--dev", |             "--dev", | ||||||
|             dest="dev", |             dest="dev", | ||||||
|             action="store_true", |             action="store_true", | ||||||
|             help=("debug + auto reload"), |             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)" |  | ||||||
|             ), |  | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -306,12 +217,6 @@ class OutputGroup(Group): | |||||||
|     name = "Output" |     name = "Output" | ||||||
|  |  | ||||||
|     def attach(self): |     def attach(self): | ||||||
|         self.add_bool_arguments( |  | ||||||
|             "--coffee", |  | ||||||
|             dest="coffee", |  | ||||||
|             default=False, |  | ||||||
|             help="Uhm, coffee?", |  | ||||||
|         ) |  | ||||||
|         self.add_bool_arguments( |         self.add_bool_arguments( | ||||||
|             "--motd", |             "--motd", | ||||||
|             dest="motd", |             dest="motd", | ||||||
|   | |||||||
| @@ -1,9 +1,8 @@ | |||||||
| import asyncio | import asyncio | ||||||
| import os | import os | ||||||
| import signal | import signal | ||||||
| import sys |  | ||||||
|  |  | ||||||
| from typing import Awaitable | from sys import argv | ||||||
|  |  | ||||||
| from multidict import CIMultiDict  # type: ignore | from multidict import CIMultiDict  # type: ignore | ||||||
|  |  | ||||||
| @@ -48,12 +47,12 @@ class Header(CIMultiDict): | |||||||
|         return self.getall(key, default=[]) |         return self.getall(key, default=[]) | ||||||
|  |  | ||||||
|  |  | ||||||
| use_trio = sys.argv[0].endswith("hypercorn") and "trio" in sys.argv | use_trio = argv[0].endswith("hypercorn") and "trio" in argv | ||||||
|  |  | ||||||
| if use_trio:  # pragma: no cover | if use_trio:  # pragma: no cover | ||||||
|     import trio  # type: ignore |     import trio  # type: ignore | ||||||
|  |  | ||||||
|     def stat_async(path) -> Awaitable[os.stat_result]: |     def stat_async(path): | ||||||
|         return trio.Path(path).stat() |         return trio.Path(path).stat() | ||||||
|  |  | ||||||
|     open_async = trio.open_file |     open_async = trio.open_file | ||||||
| @@ -73,7 +72,7 @@ def ctrlc_workaround_for_windows(app): | |||||||
|         """Asyncio wakeups to allow receiving SIGINT in Python""" |         """Asyncio wakeups to allow receiving SIGINT in Python""" | ||||||
|         while not die: |         while not die: | ||||||
|             # If someone else stopped the app, just exit |             # If someone else stopped the app, just exit | ||||||
|             if app.state.is_stopping: |             if app.is_stopping: | ||||||
|                 return |                 return | ||||||
|             # Windows Python blocks signal handlers while the event loop is |             # Windows Python blocks signal handlers while the event loop is | ||||||
|             # waiting for I/O. Frequent wakeups keep interrupts flowing. |             # waiting for I/O. Frequent wakeups keep interrupts flowing. | ||||||
| @@ -90,7 +89,3 @@ def ctrlc_workaround_for_windows(app): | |||||||
|     die = False |     die = False | ||||||
|     signal.signal(signal.SIGINT, ctrlc_handler) |     signal.signal(signal.SIGINT, ctrlc_handler) | ||||||
|     app.add_task(stay_active) |     app.add_task(stay_active) | ||||||
|  |  | ||||||
|  |  | ||||||
| def is_atty() -> bool: |  | ||||||
|     return bool(sys.stdout and sys.stdout.isatty()) |  | ||||||
|   | |||||||
| @@ -1,14 +1,10 @@ | |||||||
| from __future__ import annotations | from __future__ import annotations | ||||||
|  |  | ||||||
| import sys |  | ||||||
|  |  | ||||||
| from inspect import getmembers, isclass, isdatadescriptor | from inspect import getmembers, isclass, isdatadescriptor | ||||||
| from os import environ | from os import environ | ||||||
| from pathlib import Path | from pathlib import Path | ||||||
| from typing import Any, Callable, Dict, Optional, Sequence, Union | from typing import Any, Callable, Dict, Optional, Sequence, Union | ||||||
| from warnings import filterwarnings |  | ||||||
|  |  | ||||||
| from sanic.constants import LocalCertCreator |  | ||||||
| from sanic.errorpages import DEFAULT_FORMAT, check_error_format | from sanic.errorpages import DEFAULT_FORMAT, check_error_format | ||||||
| from sanic.helpers import Default, _default | from sanic.helpers import Default, _default | ||||||
| from sanic.http import Http | from sanic.http import Http | ||||||
| @@ -16,55 +12,32 @@ from sanic.log import deprecation, error_logger | |||||||
| from sanic.utils import load_module_from_file_location, str_to_bool | from sanic.utils import load_module_from_file_location, str_to_bool | ||||||
|  |  | ||||||
|  |  | ||||||
| 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_" | SANIC_PREFIX = "SANIC_" | ||||||
|  |  | ||||||
|  |  | ||||||
| DEFAULT_CONFIG = { | DEFAULT_CONFIG = { | ||||||
|     "_FALLBACK_ERROR_FORMAT": _default, |     "_FALLBACK_ERROR_FORMAT": _default, | ||||||
|     "ACCESS_LOG": False, |     "ACCESS_LOG": True, | ||||||
|     "AUTO_EXTEND": True, |     "AUTO_EXTEND": True, | ||||||
|     "AUTO_RELOAD": False, |     "AUTO_RELOAD": False, | ||||||
|     "EVENT_AUTOREGISTER": False, |     "EVENT_AUTOREGISTER": False, | ||||||
|     "DEPRECATION_FILTER": "once", |  | ||||||
|     "FORWARDED_FOR_HEADER": "X-Forwarded-For", |     "FORWARDED_FOR_HEADER": "X-Forwarded-For", | ||||||
|     "FORWARDED_SECRET": None, |     "FORWARDED_SECRET": None, | ||||||
|     "GRACEFUL_SHUTDOWN_TIMEOUT": 15.0,  # 15 sec |     "GRACEFUL_SHUTDOWN_TIMEOUT": 15.0,  # 15 sec | ||||||
|     "INSPECTOR": False, |  | ||||||
|     "INSPECTOR_HOST": "localhost", |  | ||||||
|     "INSPECTOR_PORT": 6457, |  | ||||||
|     "KEEP_ALIVE_TIMEOUT": 5,  # 5 seconds |     "KEEP_ALIVE_TIMEOUT": 5,  # 5 seconds | ||||||
|     "KEEP_ALIVE": True, |     "KEEP_ALIVE": True, | ||||||
|     "LOCAL_CERT_CREATOR": LocalCertCreator.AUTO, |  | ||||||
|     "LOCAL_TLS_KEY": _default, |  | ||||||
|     "LOCAL_TLS_CERT": _default, |  | ||||||
|     "LOCALHOST": "localhost", |  | ||||||
|     "MOTD": True, |     "MOTD": True, | ||||||
|     "MOTD_DISPLAY": {}, |     "MOTD_DISPLAY": {}, | ||||||
|     "NOISY_EXCEPTIONS": False, |     "NOISY_EXCEPTIONS": False, | ||||||
|     "PROXIES_COUNT": None, |     "PROXIES_COUNT": None, | ||||||
|     "REAL_IP_HEADER": None, |     "REAL_IP_HEADER": None, | ||||||
|  |     "REGISTER": True, | ||||||
|     "REQUEST_BUFFER_SIZE": 65536,  # 64 KiB |     "REQUEST_BUFFER_SIZE": 65536,  # 64 KiB | ||||||
|     "REQUEST_MAX_HEADER_SIZE": 8192,  # 8 KiB, but cannot exceed 16384 |     "REQUEST_MAX_HEADER_SIZE": 8192,  # 8 KiB, but cannot exceed 16384 | ||||||
|     "REQUEST_ID_HEADER": "X-Request-ID", |     "REQUEST_ID_HEADER": "X-Request-ID", | ||||||
|     "REQUEST_MAX_SIZE": 100000000,  # 100 megabytes |     "REQUEST_MAX_SIZE": 100000000,  # 100 megabytes | ||||||
|     "REQUEST_TIMEOUT": 60,  # 60 seconds |     "REQUEST_TIMEOUT": 60,  # 60 seconds | ||||||
|     "RESPONSE_TIMEOUT": 60,  # 60 seconds |     "RESPONSE_TIMEOUT": 60,  # 60 seconds | ||||||
|     "TLS_CERT_PASSWORD": "", |  | ||||||
|     "TOUCHUP": _default, |  | ||||||
|     "USE_UVLOOP": _default, |     "USE_UVLOOP": _default, | ||||||
|     "WEBSOCKET_MAX_SIZE": 2**20,  # 1 megabyte |     "WEBSOCKET_MAX_SIZE": 2**20,  # 1 megabyte | ||||||
|     "WEBSOCKET_PING_INTERVAL": 20, |     "WEBSOCKET_PING_INTERVAL": 20, | ||||||
| @@ -90,24 +63,17 @@ class Config(dict, metaclass=DescriptorMeta): | |||||||
|     AUTO_EXTEND: bool |     AUTO_EXTEND: bool | ||||||
|     AUTO_RELOAD: bool |     AUTO_RELOAD: bool | ||||||
|     EVENT_AUTOREGISTER: bool |     EVENT_AUTOREGISTER: bool | ||||||
|     DEPRECATION_FILTER: FilterWarningType |  | ||||||
|     FORWARDED_FOR_HEADER: str |     FORWARDED_FOR_HEADER: str | ||||||
|     FORWARDED_SECRET: Optional[str] |     FORWARDED_SECRET: Optional[str] | ||||||
|     GRACEFUL_SHUTDOWN_TIMEOUT: float |     GRACEFUL_SHUTDOWN_TIMEOUT: float | ||||||
|     INSPECTOR: bool |  | ||||||
|     INSPECTOR_HOST: str |  | ||||||
|     INSPECTOR_PORT: int |  | ||||||
|     KEEP_ALIVE_TIMEOUT: int |     KEEP_ALIVE_TIMEOUT: int | ||||||
|     KEEP_ALIVE: bool |     KEEP_ALIVE: bool | ||||||
|     LOCAL_CERT_CREATOR: Union[str, LocalCertCreator] |     NOISY_EXCEPTIONS: bool | ||||||
|     LOCAL_TLS_KEY: Union[Path, str, Default] |  | ||||||
|     LOCAL_TLS_CERT: Union[Path, str, Default] |  | ||||||
|     LOCALHOST: str |  | ||||||
|     MOTD: bool |     MOTD: bool | ||||||
|     MOTD_DISPLAY: Dict[str, str] |     MOTD_DISPLAY: Dict[str, str] | ||||||
|     NOISY_EXCEPTIONS: bool |  | ||||||
|     PROXIES_COUNT: Optional[int] |     PROXIES_COUNT: Optional[int] | ||||||
|     REAL_IP_HEADER: Optional[str] |     REAL_IP_HEADER: Optional[str] | ||||||
|  |     REGISTER: bool | ||||||
|     REQUEST_BUFFER_SIZE: int |     REQUEST_BUFFER_SIZE: int | ||||||
|     REQUEST_MAX_HEADER_SIZE: int |     REQUEST_MAX_HEADER_SIZE: int | ||||||
|     REQUEST_ID_HEADER: str |     REQUEST_ID_HEADER: str | ||||||
| @@ -115,8 +81,6 @@ class Config(dict, metaclass=DescriptorMeta): | |||||||
|     REQUEST_TIMEOUT: int |     REQUEST_TIMEOUT: int | ||||||
|     RESPONSE_TIMEOUT: int |     RESPONSE_TIMEOUT: int | ||||||
|     SERVER_NAME: str |     SERVER_NAME: str | ||||||
|     TLS_CERT_PASSWORD: str |  | ||||||
|     TOUCHUP: Union[Default, bool] |  | ||||||
|     USE_UVLOOP: Union[Default, bool] |     USE_UVLOOP: Union[Default, bool] | ||||||
|     WEBSOCKET_MAX_SIZE: int |     WEBSOCKET_MAX_SIZE: int | ||||||
|     WEBSOCKET_PING_INTERVAL: int |     WEBSOCKET_PING_INTERVAL: int | ||||||
| @@ -134,6 +98,7 @@ class Config(dict, metaclass=DescriptorMeta): | |||||||
|         super().__init__({**DEFAULT_CONFIG, **defaults}) |         super().__init__({**DEFAULT_CONFIG, **defaults}) | ||||||
|  |  | ||||||
|         self._converters = [str, str_to_bool, float, int] |         self._converters = [str, str_to_bool, float, int] | ||||||
|  |         self._LOGO = "" | ||||||
|  |  | ||||||
|         if converters: |         if converters: | ||||||
|             for converter in converters: |             for converter in converters: | ||||||
| @@ -149,23 +114,22 @@ class Config(dict, metaclass=DescriptorMeta): | |||||||
|             self.load_environment_vars(SANIC_PREFIX) |             self.load_environment_vars(SANIC_PREFIX) | ||||||
|  |  | ||||||
|         self._configure_header_size() |         self._configure_header_size() | ||||||
|         self._configure_warnings() |  | ||||||
|         self._check_error_format() |         self._check_error_format() | ||||||
|         self._init = True |         self._init = True | ||||||
|  |  | ||||||
|     def __getattr__(self, attr: Any): |     def __getattr__(self, attr): | ||||||
|         try: |         try: | ||||||
|             return self[attr] |             return self[attr] | ||||||
|         except KeyError as ke: |         except KeyError as ke: | ||||||
|             raise AttributeError(f"Config has no '{ke.args[0]}'") |             raise AttributeError(f"Config has no '{ke.args[0]}'") | ||||||
|  |  | ||||||
|     def __setattr__(self, attr: str, value: Any) -> None: |     def __setattr__(self, attr, value) -> None: | ||||||
|         self.update({attr: value}) |         self.update({attr: value}) | ||||||
|  |  | ||||||
|     def __setitem__(self, attr: str, value: Any) -> None: |     def __setitem__(self, attr, value) -> None: | ||||||
|         self.update({attr: value}) |         self.update({attr: value}) | ||||||
|  |  | ||||||
|     def update(self, *other: Any, **kwargs: Any) -> None: |     def update(self, *other, **kwargs) -> None: | ||||||
|         kwargs.update({k: v for item in other for k, v in dict(item).items()}) |         kwargs.update({k: v for item in other for k, v in dict(item).items()}) | ||||||
|         setters: Dict[str, Any] = { |         setters: Dict[str, Any] = { | ||||||
|             k: kwargs.pop(k) |             k: kwargs.pop(k) | ||||||
| @@ -191,15 +155,17 @@ class Config(dict, metaclass=DescriptorMeta): | |||||||
|                 "REQUEST_MAX_SIZE", |                 "REQUEST_MAX_SIZE", | ||||||
|             ): |             ): | ||||||
|                 self._configure_header_size() |                 self._configure_header_size() | ||||||
|  |             elif attr == "LOGO": | ||||||
|  |                 self._LOGO = value | ||||||
|  |                 deprecation( | ||||||
|  |                     "Setting the config.LOGO is deprecated and will no longer " | ||||||
|  |                     "be supported starting in v22.6.", | ||||||
|  |                     22.6, | ||||||
|  |                 ) | ||||||
|  |  | ||||||
|         if attr == "LOCAL_CERT_CREATOR" and not isinstance( |     @property | ||||||
|             self.LOCAL_CERT_CREATOR, LocalCertCreator |     def LOGO(self): | ||||||
|         ): |         return self._LOGO | ||||||
|             self.LOCAL_CERT_CREATOR = LocalCertCreator[ |  | ||||||
|                 self.LOCAL_CERT_CREATOR.upper() |  | ||||||
|             ] |  | ||||||
|         elif attr == "DEPRECATION_FILTER": |  | ||||||
|             self._configure_warnings() |  | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def FALLBACK_ERROR_FORMAT(self) -> str: |     def FALLBACK_ERROR_FORMAT(self) -> str: | ||||||
| @@ -227,13 +193,6 @@ class Config(dict, metaclass=DescriptorMeta): | |||||||
|             self.REQUEST_MAX_SIZE, |             self.REQUEST_MAX_SIZE, | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     def _configure_warnings(self): |  | ||||||
|         filterwarnings( |  | ||||||
|             self.DEPRECATION_FILTER, |  | ||||||
|             category=DeprecationWarning, |  | ||||||
|             module=r"sanic.*", |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     def _check_error_format(self, format: Optional[str] = None): |     def _check_error_format(self, format: Optional[str] = None): | ||||||
|         check_error_format(format or self.FALLBACK_ERROR_FORMAT) |         check_error_format(format or self.FALLBACK_ERROR_FORMAT) | ||||||
|  |  | ||||||
|   | |||||||
| @@ -24,25 +24,5 @@ class HTTPMethod(str, Enum): | |||||||
|     DELETE = auto() |     DELETE = auto() | ||||||
|  |  | ||||||
|  |  | ||||||
| class LocalCertCreator(str, Enum): |  | ||||||
|     def _generate_next_value_(name, start, count, last_values): |  | ||||||
|         return name.upper() |  | ||||||
|  |  | ||||||
|     AUTO = auto() |  | ||||||
|     TRUSTME = auto() |  | ||||||
|     MKCERT = auto() |  | ||||||
|  |  | ||||||
|  |  | ||||||
| HTTP_METHODS = tuple(HTTPMethod.__members__.values()) | 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_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 functools import partial | ||||||
| from traceback import extract_tb | from traceback import extract_tb | ||||||
|  |  | ||||||
| from sanic.exceptions import BadRequest, SanicException | from sanic.exceptions import InvalidUsage, SanicException | ||||||
| from sanic.helpers import STATUS_CODES | from sanic.helpers import STATUS_CODES | ||||||
| from sanic.request import Request | from sanic.request import Request | ||||||
| from sanic.response import HTTPResponse, html, json, text | from sanic.response import HTTPResponse, html, json, text | ||||||
| @@ -506,7 +506,7 @@ def exception_response( | |||||||
|                         # $ curl localhost:8000 -d '{"foo": "bar"}' |                         # $ curl localhost:8000 -d '{"foo": "bar"}' | ||||||
|                         # And provide them with JSONRenderer |                         # And provide them with JSONRenderer | ||||||
|                         renderer = JSONRenderer if request.json else base |                         renderer = JSONRenderer if request.json else base | ||||||
|                     except BadRequest: |                     except InvalidUsage: | ||||||
|                         renderer = base |                         renderer = base | ||||||
|             else: |             else: | ||||||
|                 renderer = RENDERERS_BY_CONFIG.get(render_format, renderer) |                 renderer = RENDERERS_BY_CONFIG.get(render_format, renderer) | ||||||
|   | |||||||
| @@ -1,13 +1,8 @@ | |||||||
| from asyncio import CancelledError |  | ||||||
| from typing import Any, Dict, Optional, Union | from typing import Any, Dict, Optional, Union | ||||||
|  |  | ||||||
| from sanic.helpers import STATUS_CODES | from sanic.helpers import STATUS_CODES | ||||||
|  |  | ||||||
|  |  | ||||||
| class RequestCancelled(CancelledError): |  | ||||||
|     quiet = True |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class SanicException(Exception): | class SanicException(Exception): | ||||||
|     message: str = "" |     message: str = "" | ||||||
|  |  | ||||||
| @@ -47,7 +42,7 @@ class NotFound(SanicException): | |||||||
|     quiet = True |     quiet = True | ||||||
|  |  | ||||||
|  |  | ||||||
| class BadRequest(SanicException): | class InvalidUsage(SanicException): | ||||||
|     """ |     """ | ||||||
|     **Status**: 400 Bad Request |     **Status**: 400 Bad Request | ||||||
|     """ |     """ | ||||||
| @@ -56,14 +51,7 @@ class BadRequest(SanicException): | |||||||
|     quiet = True |     quiet = True | ||||||
|  |  | ||||||
|  |  | ||||||
| InvalidUsage = BadRequest | class MethodNotSupported(SanicException): | ||||||
|  |  | ||||||
|  |  | ||||||
| class BadURL(BadRequest): |  | ||||||
|     ... |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class MethodNotAllowed(SanicException): |  | ||||||
|     """ |     """ | ||||||
|     **Status**: 405 Method Not Allowed |     **Status**: 405 Method Not Allowed | ||||||
|     """ |     """ | ||||||
| @@ -76,9 +64,6 @@ class MethodNotAllowed(SanicException): | |||||||
|         self.headers = {"Allow": ", ".join(allowed_methods)} |         self.headers = {"Allow": ", ".join(allowed_methods)} | ||||||
|  |  | ||||||
|  |  | ||||||
| MethodNotSupported = MethodNotAllowed |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class ServerError(SanicException): | class ServerError(SanicException): | ||||||
|     """ |     """ | ||||||
|     **Status**: 500 Internal Server Error |     **Status**: 500 Internal Server Error | ||||||
| @@ -140,19 +125,19 @@ class PayloadTooLarge(SanicException): | |||||||
|     quiet = True |     quiet = True | ||||||
|  |  | ||||||
|  |  | ||||||
| class HeaderNotFound(BadRequest): | class HeaderNotFound(InvalidUsage): | ||||||
|     """ |     """ | ||||||
|     **Status**: 400 Bad Request |     **Status**: 400 Bad Request | ||||||
|     """ |     """ | ||||||
|  |  | ||||||
|  |  | ||||||
| class InvalidHeader(BadRequest): | class InvalidHeader(InvalidUsage): | ||||||
|     """ |     """ | ||||||
|     **Status**: 400 Bad Request |     **Status**: 400 Bad Request | ||||||
|     """ |     """ | ||||||
|  |  | ||||||
|  |  | ||||||
| class RangeNotSatisfiable(SanicException): | class ContentRangeError(SanicException): | ||||||
|     """ |     """ | ||||||
|     **Status**: 416 Range Not Satisfiable |     **Status**: 416 Range Not Satisfiable | ||||||
|     """ |     """ | ||||||
| @@ -165,10 +150,7 @@ class RangeNotSatisfiable(SanicException): | |||||||
|         self.headers = {"Content-Range": f"bytes */{content_range.total}"} |         self.headers = {"Content-Range": f"bytes */{content_range.total}"} | ||||||
|  |  | ||||||
|  |  | ||||||
| ContentRangeError = RangeNotSatisfiable | class HeaderExpectationFailed(SanicException): | ||||||
|  |  | ||||||
|  |  | ||||||
| class ExpectationFailed(SanicException): |  | ||||||
|     """ |     """ | ||||||
|     **Status**: 417 Expectation Failed |     **Status**: 417 Expectation Failed | ||||||
|     """ |     """ | ||||||
| @@ -177,9 +159,6 @@ class ExpectationFailed(SanicException): | |||||||
|     quiet = True |     quiet = True | ||||||
|  |  | ||||||
|  |  | ||||||
| HeaderExpectationFailed = ExpectationFailed |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class Forbidden(SanicException): | class Forbidden(SanicException): | ||||||
|     """ |     """ | ||||||
|     **Status**: 403 Forbidden |     **Status**: 403 Forbidden | ||||||
| @@ -189,7 +168,7 @@ class Forbidden(SanicException): | |||||||
|     quiet = True |     quiet = True | ||||||
|  |  | ||||||
|  |  | ||||||
| class InvalidRangeType(RangeNotSatisfiable): | class InvalidRangeType(ContentRangeError): | ||||||
|     """ |     """ | ||||||
|     **Status**: 416 Range Not Satisfiable |     **Status**: 416 Range Not Satisfiable | ||||||
|     """ |     """ | ||||||
|   | |||||||
| @@ -1,317 +1,24 @@ | |||||||
| from __future__ import annotations | from __future__ import annotations | ||||||
|  |  | ||||||
| from functools import partial | from typing import Dict, List, Optional, Tuple, Type, Union | ||||||
| from inspect import isawaitable |  | ||||||
| from traceback import format_exc |  | ||||||
| from typing import Dict, List, Optional, Tuple, Type |  | ||||||
|  |  | ||||||
| from sanic_routing import Route | from sanic.config import Config | ||||||
|  | from sanic.errorpages import ( | ||||||
| from sanic.errorpages import BaseRenderer, TextRenderer, exception_response |     DEFAULT_FORMAT, | ||||||
|  |     BaseRenderer, | ||||||
|  |     TextRenderer, | ||||||
|  |     exception_response, | ||||||
|  | ) | ||||||
| from sanic.exceptions import ( | from sanic.exceptions import ( | ||||||
|  |     ContentRangeError, | ||||||
|     HeaderNotFound, |     HeaderNotFound, | ||||||
|     InvalidRangeType, |     InvalidRangeType, | ||||||
|     RangeNotSatisfiable, |  | ||||||
|     SanicException, |     SanicException, | ||||||
|     ServerError, |  | ||||||
| ) | ) | ||||||
| from sanic.http.constants import Stage | from sanic.helpers import Default, _default | ||||||
| from sanic.log import deprecation, error_logger, logger | from sanic.log import deprecation, error_logger | ||||||
| from sanic.models.handler_types import RouteHandler | from sanic.models.handler_types import RouteHandler | ||||||
| from sanic.request import Request | from sanic.response import text | ||||||
| from sanic.response import BaseHTTPResponse, HTTPResponse, ResponseStream, text |  | ||||||
| from sanic.touchup import TouchUpMeta |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class RequestHandler: |  | ||||||
|     def __init__(self, func, request_middleware, response_middleware): |  | ||||||
|         self.func = func.func if isinstance(func, RequestHandler) else func |  | ||||||
|         self.request_middleware = request_middleware |  | ||||||
|         self.response_middleware = response_middleware |  | ||||||
|  |  | ||||||
|     def __call__(self, *args, **kwargs): |  | ||||||
|         return self.func(*args, **kwargs) |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class RequestManager(metaclass=TouchUpMeta): |  | ||||||
|     __touchup__ = ( |  | ||||||
|         "cleanup", |  | ||||||
|         "run_request_middleware", |  | ||||||
|         "run_response_middleware", |  | ||||||
|     ) |  | ||||||
|     __slots__ = ( |  | ||||||
|         "handler", |  | ||||||
|         "request_middleware_run", |  | ||||||
|         "request_middleware", |  | ||||||
|         "request", |  | ||||||
|         "response_middleware_run", |  | ||||||
|         "response_middleware", |  | ||||||
|     ) |  | ||||||
|     request: Request |  | ||||||
|  |  | ||||||
|     def __init__(self, request: Request): |  | ||||||
|         self.request_middleware_run = False |  | ||||||
|         self.response_middleware_run = False |  | ||||||
|         self.handler = self._noop |  | ||||||
|         self.set_request(request) |  | ||||||
|  |  | ||||||
|     @classmethod |  | ||||||
|     def create(cls, request: Request) -> RequestManager: |  | ||||||
|         return cls(request) |  | ||||||
|  |  | ||||||
|     def set_request(self, request: Request): |  | ||||||
|         request._manager = self |  | ||||||
|         self.request = request |  | ||||||
|         self.request_middleware = request.app.request_middleware |  | ||||||
|         self.response_middleware = request.app.response_middleware |  | ||||||
|  |  | ||||||
|     async def handle(self): |  | ||||||
|         route = self.resolve_route() |  | ||||||
|  |  | ||||||
|         if self.handler is None: |  | ||||||
|             await self.error( |  | ||||||
|                 ServerError( |  | ||||||
|                     ( |  | ||||||
|                         "'None' was returned while requesting a " |  | ||||||
|                         "handler from the router" |  | ||||||
|                     ) |  | ||||||
|                 ) |  | ||||||
|             ) |  | ||||||
|             return |  | ||||||
|  |  | ||||||
|         if ( |  | ||||||
|             self.request.stream |  | ||||||
|             and self.request.stream.request_body |  | ||||||
|             and not route.ctx.ignore_body |  | ||||||
|         ): |  | ||||||
|             await self.receive_body() |  | ||||||
|  |  | ||||||
|         await self.lifecycle( |  | ||||||
|             partial(self.handler, self.request, **self.request.match_info) |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     async def lifecycle(self, handler, raise_exception: bool = False): |  | ||||||
|         response: Optional[BaseHTTPResponse] = None |  | ||||||
|         if not self.request_middleware_run and self.request_middleware: |  | ||||||
|             response = await self.run( |  | ||||||
|                 self.run_request_middleware, raise_exception |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|         if not response: |  | ||||||
|             # Run response handler |  | ||||||
|             response = await self.run(handler, raise_exception) |  | ||||||
|  |  | ||||||
|         if not self.response_middleware_run and self.response_middleware: |  | ||||||
|             response = await self.run( |  | ||||||
|                 partial(self.run_response_middleware, response), |  | ||||||
|                 raise_exception, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|         await self.cleanup(response) |  | ||||||
|  |  | ||||||
|     async def run( |  | ||||||
|         self, operation, raise_exception: bool = False |  | ||||||
|     ) -> Optional[BaseHTTPResponse]: |  | ||||||
|         try: |  | ||||||
|             response = operation() |  | ||||||
|             if isawaitable(response): |  | ||||||
|                 response = await response |  | ||||||
|         except Exception as e: |  | ||||||
|             if raise_exception: |  | ||||||
|                 raise |  | ||||||
|             response = await self.error(e) |  | ||||||
|         return response |  | ||||||
|  |  | ||||||
|     async def error(self, exception: Exception): |  | ||||||
|         error_handler = self.request.app.error_handler |  | ||||||
|         if ( |  | ||||||
|             self.request.stream is not None |  | ||||||
|             and self.request.stream.stage is not Stage.HANDLER |  | ||||||
|         ): |  | ||||||
|             error_logger.exception(exception, exc_info=True) |  | ||||||
|             logger.error( |  | ||||||
|                 "The error response will not be sent to the client for " |  | ||||||
|                 f'the following exception:"{exception}". A previous response ' |  | ||||||
|                 "has at least partially been sent." |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|             handler = error_handler._lookup( |  | ||||||
|                 exception, self.request.name if self.request else None |  | ||||||
|             ) |  | ||||||
|             if handler: |  | ||||||
|                 logger.warning( |  | ||||||
|                     "An error occurred while handling the request after at " |  | ||||||
|                     "least some part of the response was sent to the client. " |  | ||||||
|                     "The response from your custom exception handler " |  | ||||||
|                     f"{handler.__name__} will not be sent to the client." |  | ||||||
|                     "Exception handlers should only be used to generate the " |  | ||||||
|                     "exception responses. If you would like to perform any " |  | ||||||
|                     "other action on a raised exception, consider using a " |  | ||||||
|                     "signal handler like " |  | ||||||
|                     '`@app.signal("http.lifecycle.exception")`\n' |  | ||||||
|                     "For further information, please see the docs: " |  | ||||||
|                     "https://sanicframework.org/en/guide/advanced/" |  | ||||||
|                     "signals.html", |  | ||||||
|                 ) |  | ||||||
|             return |  | ||||||
|  |  | ||||||
|         try: |  | ||||||
|             await self.lifecycle( |  | ||||||
|                 partial(error_handler.response, self.request, exception), True |  | ||||||
|             ) |  | ||||||
|         except Exception as e: |  | ||||||
|             if isinstance(e, SanicException): |  | ||||||
|                 response = error_handler.default(self.request, e) |  | ||||||
|             elif self.request.app.debug: |  | ||||||
|                 response = HTTPResponse( |  | ||||||
|                     ( |  | ||||||
|                         f"Error while handling error: {e}\n" |  | ||||||
|                         f"Stack: {format_exc()}" |  | ||||||
|                     ), |  | ||||||
|                     status=500, |  | ||||||
|                 ) |  | ||||||
|             else: |  | ||||||
|                 error_logger.exception(e) |  | ||||||
|                 response = HTTPResponse( |  | ||||||
|                     "An error occurred while handling an error", status=500 |  | ||||||
|                 ) |  | ||||||
|             return response |  | ||||||
|         return None |  | ||||||
|  |  | ||||||
|     async def cleanup(self, response: Optional[BaseHTTPResponse]): |  | ||||||
|         if self.request.responded: |  | ||||||
|             if response is not None: |  | ||||||
|                 error_logger.error( |  | ||||||
|                     "The response object returned by the route handler " |  | ||||||
|                     "will not be sent to client. The request has already " |  | ||||||
|                     "been responded to." |  | ||||||
|                 ) |  | ||||||
|             if self.request.stream is not None: |  | ||||||
|                 response = self.request.stream.response |  | ||||||
|         elif response is not None: |  | ||||||
|             self.request.reset_response() |  | ||||||
|             response = await self.request.respond(response)  # type: ignore |  | ||||||
|         elif not hasattr(self.handler, "is_websocket"): |  | ||||||
|             response = self.request.stream.response  # type: ignore |  | ||||||
|  |  | ||||||
|         if isinstance(response, BaseHTTPResponse): |  | ||||||
|             await self.request.app.dispatch( |  | ||||||
|                 "http.lifecycle.response", |  | ||||||
|                 inline=True, |  | ||||||
|                 context={"request": self.request, "response": response}, |  | ||||||
|             ) |  | ||||||
|             await response.send(end_stream=True) |  | ||||||
|         elif isinstance(response, ResponseStream): |  | ||||||
|             await response(self.request)  # type: ignore |  | ||||||
|             await response.eof()  # type: ignore |  | ||||||
|             await self.request.app.dispatch( |  | ||||||
|                 "http.lifecycle.response", |  | ||||||
|                 inline=True, |  | ||||||
|                 context={"request": self.request, "response": response}, |  | ||||||
|             ) |  | ||||||
|         else: |  | ||||||
|             if not hasattr(self.handler, "is_websocket"): |  | ||||||
|                 raise ServerError( |  | ||||||
|                     f"Invalid response type {response!r} " |  | ||||||
|                     "(need HTTPResponse)" |  | ||||||
|                 ) |  | ||||||
|  |  | ||||||
|     async def receive_body(self): |  | ||||||
|         if hasattr(self.handler, "is_stream"): |  | ||||||
|             # Streaming handler: lift the size limit |  | ||||||
|             self.request.stream.request_max_size = float("inf") |  | ||||||
|         else: |  | ||||||
|             # Non-streaming handler: preload body |  | ||||||
|             await self.request.receive_body() |  | ||||||
|  |  | ||||||
|     async def run_request_middleware(self) -> Optional[BaseHTTPResponse]: |  | ||||||
|         self.request._request_middleware_started = True |  | ||||||
|         self.request_middleware_run = True |  | ||||||
|  |  | ||||||
|         for middleware in self.request_middleware: |  | ||||||
|             await self.request.app.dispatch( |  | ||||||
|                 "http.middleware.before", |  | ||||||
|                 inline=True, |  | ||||||
|                 context={"request": self.request, "response": None}, |  | ||||||
|                 condition={"attach_to": "request"}, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|             try: |  | ||||||
|                 response = await self.run(partial(middleware, self.request)) |  | ||||||
|             except Exception: |  | ||||||
|                 error_logger.exception( |  | ||||||
|                     "Exception occurred in one of request middleware handlers" |  | ||||||
|                 ) |  | ||||||
|                 raise |  | ||||||
|  |  | ||||||
|             await self.request.app.dispatch( |  | ||||||
|                 "http.middleware.after", |  | ||||||
|                 inline=True, |  | ||||||
|                 context={"request": self.request, "response": None}, |  | ||||||
|                 condition={"attach_to": "request"}, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|             if response: |  | ||||||
|                 return response |  | ||||||
|         return None |  | ||||||
|  |  | ||||||
|     async def run_response_middleware( |  | ||||||
|         self, response: BaseHTTPResponse |  | ||||||
|     ) -> BaseHTTPResponse: |  | ||||||
|         self.response_middleware_run = True |  | ||||||
|         for middleware in self.response_middleware: |  | ||||||
|             await self.request.app.dispatch( |  | ||||||
|                 "http.middleware.before", |  | ||||||
|                 inline=True, |  | ||||||
|                 context={"request": self.request, "response": None}, |  | ||||||
|                 condition={"attach_to": "request"}, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|             try: |  | ||||||
|                 resp = await self.run( |  | ||||||
|                     partial(middleware, self.request, response), True |  | ||||||
|                 ) |  | ||||||
|             except Exception as e: |  | ||||||
|                 error_logger.exception( |  | ||||||
|                     "Exception occurred in one of response middleware handlers" |  | ||||||
|                 ) |  | ||||||
|                 await self.error(e) |  | ||||||
|                 resp = None |  | ||||||
|  |  | ||||||
|             await self.request.app.dispatch( |  | ||||||
|                 "http.middleware.after", |  | ||||||
|                 inline=True, |  | ||||||
|                 context={"request": self.request, "response": None}, |  | ||||||
|                 condition={"attach_to": "request"}, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|             if resp: |  | ||||||
|                 return resp |  | ||||||
|         return response |  | ||||||
|  |  | ||||||
|     def resolve_route(self) -> Route: |  | ||||||
|         # Fetch handler from router |  | ||||||
|         route, handler, kwargs = self.request.app.router.get( |  | ||||||
|             self.request.path, |  | ||||||
|             self.request.method, |  | ||||||
|             self.request.headers.getone("host", None), |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|         self.request._match_info = {**kwargs} |  | ||||||
|         self.request.route = route |  | ||||||
|         self.handler = handler |  | ||||||
|  |  | ||||||
|         if handler and handler.request_middleware: |  | ||||||
|             self.request_middleware = handler.request_middleware |  | ||||||
|  |  | ||||||
|         if handler and handler.response_middleware: |  | ||||||
|             self.response_middleware = handler.response_middleware |  | ||||||
|  |  | ||||||
|         return route |  | ||||||
|  |  | ||||||
|     @staticmethod |  | ||||||
|     def _noop(_): |  | ||||||
|         ... |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class ErrorHandler: | class ErrorHandler: | ||||||
| @@ -329,47 +36,94 @@ class ErrorHandler: | |||||||
|  |  | ||||||
|     def __init__( |     def __init__( | ||||||
|         self, |         self, | ||||||
|  |         fallback: Union[str, Default] = _default, | ||||||
|         base: Type[BaseRenderer] = TextRenderer, |         base: Type[BaseRenderer] = TextRenderer, | ||||||
|     ): |     ): | ||||||
|         self.cached_handlers: Dict[ |         self.cached_handlers: Dict[ | ||||||
|             Tuple[Type[BaseException], Optional[str]], Optional[RouteHandler] |             Tuple[Type[BaseException], Optional[str]], Optional[RouteHandler] | ||||||
|         ] = {} |         ] = {} | ||||||
|         self.debug = False |         self.debug = False | ||||||
|  |         self._fallback = fallback | ||||||
|         self.base = base |         self.base = base | ||||||
|  |  | ||||||
|     @classmethod |         if fallback is not _default: | ||||||
|     def finalize(cls, *args, **kwargs): |             self._warn_fallback_deprecation() | ||||||
|  |  | ||||||
|  |     @property | ||||||
|  |     def fallback(self):  # no cov | ||||||
|  |         # This is for backwards compat and can be removed in v22.6 | ||||||
|  |         if self._fallback is _default: | ||||||
|  |             return DEFAULT_FORMAT | ||||||
|  |         return self._fallback | ||||||
|  |  | ||||||
|  |     @fallback.setter | ||||||
|  |     def fallback(self, value: str):  # no cov | ||||||
|  |         self._warn_fallback_deprecation() | ||||||
|  |         if not isinstance(value, str): | ||||||
|  |             raise SanicException( | ||||||
|  |                 f"Cannot set error handler fallback to: value={value}" | ||||||
|  |             ) | ||||||
|  |         self._fallback = value | ||||||
|  |  | ||||||
|  |     @staticmethod | ||||||
|  |     def _warn_fallback_deprecation(): | ||||||
|         deprecation( |         deprecation( | ||||||
|             "ErrorHandler.finalize is deprecated and no longer needed. " |             "Setting the ErrorHandler fallback value directly is " | ||||||
|             "Please remove update your code to remove it. ", |             "deprecated and no longer supported. This feature will " | ||||||
|             22.12, |             "be removed in v22.6. Instead, use " | ||||||
|  |             "app.config.FALLBACK_ERROR_FORMAT.", | ||||||
|  |             22.6, | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|  |     @classmethod | ||||||
|  |     def _get_fallback_value(cls, error_handler: ErrorHandler, config: Config): | ||||||
|  |         if error_handler._fallback is not _default: | ||||||
|  |             if config._FALLBACK_ERROR_FORMAT is _default: | ||||||
|  |                 return error_handler.fallback | ||||||
|  |  | ||||||
|  |             error_logger.warning( | ||||||
|  |                 "Conflicting error fallback values were found in the " | ||||||
|  |                 "error handler and in the app.config while handling an " | ||||||
|  |                 "exception. Using the value from app.config." | ||||||
|  |             ) | ||||||
|  |         return config.FALLBACK_ERROR_FORMAT | ||||||
|  |  | ||||||
|  |     @classmethod | ||||||
|  |     def finalize( | ||||||
|  |         cls, | ||||||
|  |         error_handler: ErrorHandler, | ||||||
|  |         config: Config, | ||||||
|  |         fallback: Optional[str] = None, | ||||||
|  |     ): | ||||||
|  |         if fallback: | ||||||
|  |             deprecation( | ||||||
|  |                 "Setting the ErrorHandler fallback value via finalize() " | ||||||
|  |                 "is deprecated and no longer supported. This feature will " | ||||||
|  |                 "be removed in v22.6. Instead, use " | ||||||
|  |                 "app.config.FALLBACK_ERROR_FORMAT.", | ||||||
|  |                 22.6, | ||||||
|  |             ) | ||||||
|  |  | ||||||
|  |         if not fallback: | ||||||
|  |             fallback = config.FALLBACK_ERROR_FORMAT | ||||||
|  |  | ||||||
|  |         if fallback != DEFAULT_FORMAT: | ||||||
|  |             if error_handler._fallback is not _default: | ||||||
|  |                 error_logger.warning( | ||||||
|  |                     f"Setting the fallback value to {fallback}. This changes " | ||||||
|  |                     "the current non-default value " | ||||||
|  |                     f"'{error_handler._fallback}'." | ||||||
|  |                 ) | ||||||
|  |             error_handler._fallback = fallback | ||||||
|  |  | ||||||
|  |         if not isinstance(error_handler, cls): | ||||||
|  |             error_logger.warning( | ||||||
|  |                 f"Error handler is non-conforming: {type(error_handler)}" | ||||||
|  |             ) | ||||||
|  |  | ||||||
|     def _full_lookup(self, exception, route_name: Optional[str] = None): |     def _full_lookup(self, exception, route_name: Optional[str] = None): | ||||||
|         return self.lookup(exception, route_name) |         return self.lookup(exception, route_name) | ||||||
|  |  | ||||||
|     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): |     def add(self, exception, handler, route_names: Optional[List[str]] = None): | ||||||
|         """ |         """ | ||||||
|         Add a new exception handler to an already existing handler object. |         Add a new exception handler to an already existing handler object. | ||||||
| @@ -385,9 +139,9 @@ class ErrorHandler: | |||||||
|         """ |         """ | ||||||
|         if route_names: |         if route_names: | ||||||
|             for route in route_names: |             for route in route_names: | ||||||
|                 self._add((exception, route), handler) |                 self.cached_handlers[(exception, route)] = handler | ||||||
|         else: |         else: | ||||||
|             self._add((exception, None), handler) |             self.cached_handlers[(exception, None)] = handler | ||||||
|  |  | ||||||
|     def lookup(self, exception, route_name: Optional[str] = None): |     def lookup(self, exception, route_name: Optional[str] = None): | ||||||
|         """ |         """ | ||||||
| @@ -483,7 +237,7 @@ class ErrorHandler: | |||||||
|         :return: |         :return: | ||||||
|         """ |         """ | ||||||
|         self.log(request, exception) |         self.log(request, exception) | ||||||
|         fallback = request.app.config.FALLBACK_ERROR_FORMAT |         fallback = ErrorHandler._get_fallback_value(self, request.app.config) | ||||||
|         return exception_response( |         return exception_response( | ||||||
|             request, |             request, | ||||||
|             exception, |             exception, | ||||||
| @@ -542,18 +296,18 @@ class ContentRangeHandler: | |||||||
|         try: |         try: | ||||||
|             self.start = int(start_b) if start_b else None |             self.start = int(start_b) if start_b else None | ||||||
|         except ValueError: |         except ValueError: | ||||||
|             raise RangeNotSatisfiable( |             raise ContentRangeError( | ||||||
|                 "'%s' is invalid for Content Range" % (start_b,), self |                 "'%s' is invalid for Content Range" % (start_b,), self | ||||||
|             ) |             ) | ||||||
|         try: |         try: | ||||||
|             self.end = int(end_b) if end_b else None |             self.end = int(end_b) if end_b else None | ||||||
|         except ValueError: |         except ValueError: | ||||||
|             raise RangeNotSatisfiable( |             raise ContentRangeError( | ||||||
|                 "'%s' is invalid for Content Range" % (end_b,), self |                 "'%s' is invalid for Content Range" % (end_b,), self | ||||||
|             ) |             ) | ||||||
|         if self.end is None: |         if self.end is None: | ||||||
|             if self.start is None: |             if self.start is None: | ||||||
|                 raise RangeNotSatisfiable( |                 raise ContentRangeError( | ||||||
|                     "Invalid for Content Range parameters", self |                     "Invalid for Content Range parameters", self | ||||||
|                 ) |                 ) | ||||||
|             else: |             else: | ||||||
| @@ -565,7 +319,7 @@ class ContentRangeHandler: | |||||||
|                 self.start = self.total - self.end |                 self.start = self.total - self.end | ||||||
|                 self.end = self.total - 1 |                 self.end = self.total - 1 | ||||||
|         if self.start >= self.end: |         if self.start >= self.end: | ||||||
|             raise RangeNotSatisfiable( |             raise ContentRangeError( | ||||||
|                 "Invalid for Content Range parameters", self |                 "Invalid for Content Range parameters", self | ||||||
|             ) |             ) | ||||||
|         self.size = self.end - self.start + 1 |         self.size = self.end - self.start + 1 | ||||||
|   | |||||||
| @@ -3,52 +3,71 @@ from __future__ import annotations | |||||||
| from typing import TYPE_CHECKING, Optional | from typing import TYPE_CHECKING, Optional | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic.request import Request |     from sanic.request import Request | ||||||
|     from sanic.response import BaseHTTPResponse |     from sanic.response import BaseHTTPResponse | ||||||
| 
 | 
 | ||||||
| from asyncio import CancelledError, sleep | from asyncio import CancelledError, sleep | ||||||
|  | from enum import Enum | ||||||
| 
 | 
 | ||||||
| from sanic.compat import Header | from sanic.compat import Header | ||||||
| from sanic.exceptions import ( | from sanic.exceptions import ( | ||||||
|     BadRequest, |     HeaderExpectationFailed, | ||||||
|     ExpectationFailed, |     InvalidUsage, | ||||||
|     PayloadTooLarge, |     PayloadTooLarge, | ||||||
|     RequestCancelled, |  | ||||||
|     ServerError, |     ServerError, | ||||||
|  |     ServiceUnavailable, | ||||||
| ) | ) | ||||||
| from sanic.headers import format_http1_response | from sanic.headers import format_http1_response | ||||||
| from sanic.helpers import has_message_body | 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.log import access_logger, error_logger, logger | ||||||
| from sanic.touchup import TouchUpMeta | 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" | HTTP_CONTINUE = b"HTTP/1.1 100 Continue\r\n\r\n" | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| class Http(Stream, metaclass=TouchUpMeta): | class Http(metaclass=TouchUpMeta): | ||||||
|     """ |     """ | ||||||
|     Internal helper for managing the HTTP/1.1 request/response cycle |     Internal helper for managing the HTTP request/response cycle | ||||||
| 
 | 
 | ||||||
|     :raises ServerError: |     :raises ServerError: | ||||||
|     :raises PayloadTooLarge: |     :raises PayloadTooLarge: | ||||||
|     :raises Exception: |     :raises Exception: | ||||||
|     :raises BadRequest: |     :raises InvalidUsage: | ||||||
|     :raises ExpectationFailed: |     :raises HeaderExpectationFailed: | ||||||
|     :raises RuntimeError: |     :raises RuntimeError: | ||||||
|     :raises ServerError: |     :raises ServerError: | ||||||
|     :raises ServerError: |     :raises ServerError: | ||||||
|     :raises BadRequest: |     :raises InvalidUsage: | ||||||
|     :raises BadRequest: |     :raises InvalidUsage: | ||||||
|     :raises BadRequest: |     :raises InvalidUsage: | ||||||
|     :raises PayloadTooLarge: |     :raises PayloadTooLarge: | ||||||
|     :raises RuntimeError: |     :raises RuntimeError: | ||||||
|     """ |     """ | ||||||
| 
 | 
 | ||||||
|     HEADER_CEILING = 16_384 |     HEADER_CEILING = 16_384 | ||||||
|     HEADER_MAX_SIZE = 0 |     HEADER_MAX_SIZE = 0 | ||||||
|  | 
 | ||||||
|     __touchup__ = ( |     __touchup__ = ( | ||||||
|         "http1_request_header", |         "http1_request_header", | ||||||
|         "http1_response_header", |         "http1_response_header", | ||||||
| @@ -124,8 +143,7 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
| 
 | 
 | ||||||
|                 self.stage = Stage.HANDLER |                 self.stage = Stage.HANDLER | ||||||
|                 self.request.conn_info = self.protocol.conn_info |                 self.request.conn_info = self.protocol.conn_info | ||||||
| 
 |                 await self.protocol.request_handler(self.request) | ||||||
|                 await self.request.manager.handle() |  | ||||||
| 
 | 
 | ||||||
|                 # Handler finished, response should've been sent |                 # Handler finished, response should've been sent | ||||||
|                 if self.stage is Stage.HANDLER and not self.upgrade_websocket: |                 if self.stage is Stage.HANDLER and not self.upgrade_websocket: | ||||||
| @@ -133,7 +151,7 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
| 
 | 
 | ||||||
|                 if self.stage is Stage.RESPONSE: |                 if self.stage is Stage.RESPONSE: | ||||||
|                     await self.response.send(end_stream=True) |                     await self.response.send(end_stream=True) | ||||||
|             except CancelledError as exc: |             except CancelledError: | ||||||
|                 # Write an appropriate response before exiting |                 # Write an appropriate response before exiting | ||||||
|                 if not self.protocol.transport: |                 if not self.protocol.transport: | ||||||
|                     logger.info( |                     logger.info( | ||||||
| @@ -141,11 +159,7 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
|                         "stopped. Transport is closed." |                         "stopped. Transport is closed." | ||||||
|                     ) |                     ) | ||||||
|                     return |                     return | ||||||
|                 e = ( |                 e = self.exception or ServiceUnavailable("Cancelled") | ||||||
|                     RequestCancelled() |  | ||||||
|                     if self.protocol.conn_info.lost |  | ||||||
|                     else (self.exception or exc) |  | ||||||
|                 ) |  | ||||||
|                 self.exception = None |                 self.exception = None | ||||||
|                 self.keep_alive = False |                 self.keep_alive = False | ||||||
|                 await self.error_response(e) |                 await self.error_response(e) | ||||||
| @@ -234,7 +248,7 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
| 
 | 
 | ||||||
|                 headers.append(h) |                 headers.append(h) | ||||||
|         except Exception: |         except Exception: | ||||||
|             raise BadRequest("Bad Request") |             raise InvalidUsage("Bad Request") | ||||||
| 
 | 
 | ||||||
|         headers_instance = Header(headers) |         headers_instance = Header(headers) | ||||||
|         self.upgrade_websocket = ( |         self.upgrade_websocket = ( | ||||||
| @@ -251,8 +265,6 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
|             transport=self.protocol.transport, |             transport=self.protocol.transport, | ||||||
|             app=self.protocol.app, |             app=self.protocol.app, | ||||||
|         ) |         ) | ||||||
|         self.protocol.request_handler.create(request) |  | ||||||
|         self.protocol.request_class._current.set(request) |  | ||||||
|         await self.dispatch( |         await self.dispatch( | ||||||
|             "http.lifecycle.request", |             "http.lifecycle.request", | ||||||
|             inline=True, |             inline=True, | ||||||
| @@ -269,7 +281,7 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
|                 if expect.lower() == "100-continue": |                 if expect.lower() == "100-continue": | ||||||
|                     self.expecting_continue = True |                     self.expecting_continue = True | ||||||
|                 else: |                 else: | ||||||
|                     raise ExpectationFailed(f"Unknown Expect: {expect}") |                     raise HeaderExpectationFailed(f"Unknown Expect: {expect}") | ||||||
| 
 | 
 | ||||||
|             if headers.getone("transfer-encoding", None) == "chunked": |             if headers.getone("transfer-encoding", None) == "chunked": | ||||||
|                 self.request_body = "chunked" |                 self.request_body = "chunked" | ||||||
| @@ -340,12 +352,6 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
|             self.response_func = self.head_response_ignored |             self.response_func = self.head_response_ignored | ||||||
| 
 | 
 | ||||||
|         headers["connection"] = "keep-alive" if self.keep_alive else "close" |         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) |         ret = format_http1_response(status, res.processed_headers) | ||||||
|         if data: |         if data: | ||||||
|             ret += data |             ret += data | ||||||
| @@ -425,11 +431,12 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
| 
 | 
 | ||||||
|         # From request and handler states we can respond, otherwise be silent |         # From request and handler states we can respond, otherwise be silent | ||||||
|         if self.stage is Stage.HANDLER: |         if self.stage is Stage.HANDLER: | ||||||
|  |             app = self.protocol.app | ||||||
|  | 
 | ||||||
|             if self.request is None: |             if self.request is None: | ||||||
|                 self.create_empty_request() |                 self.create_empty_request() | ||||||
|                 self.protocol.request_handler.create(self.request) |  | ||||||
| 
 | 
 | ||||||
|             await self.request.manager.error(exception) |             await app.handle_exception(self.request, exception) | ||||||
| 
 | 
 | ||||||
|     def create_empty_request(self) -> None: |     def create_empty_request(self) -> None: | ||||||
|         """ |         """ | ||||||
| @@ -503,7 +510,7 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
| 
 | 
 | ||||||
|                 if len(buf) > 64: |                 if len(buf) > 64: | ||||||
|                     self.keep_alive = False |                     self.keep_alive = False | ||||||
|                     raise BadRequest("Bad chunked encoding") |                     raise InvalidUsage("Bad chunked encoding") | ||||||
| 
 | 
 | ||||||
|                 await self._receive_more() |                 await self._receive_more() | ||||||
| 
 | 
 | ||||||
| @@ -511,14 +518,14 @@ class Http(Stream, metaclass=TouchUpMeta): | |||||||
|                 size = int(buf[2:pos].split(b";", 1)[0].decode(), 16) |                 size = int(buf[2:pos].split(b";", 1)[0].decode(), 16) | ||||||
|             except Exception: |             except Exception: | ||||||
|                 self.keep_alive = False |                 self.keep_alive = False | ||||||
|                 raise BadRequest("Bad chunked encoding") |                 raise InvalidUsage("Bad chunked encoding") | ||||||
| 
 | 
 | ||||||
|             if size <= 0: |             if size <= 0: | ||||||
|                 self.request_body = None |                 self.request_body = None | ||||||
| 
 | 
 | ||||||
|                 if size < 0: |                 if size < 0: | ||||||
|                     self.keep_alive = False |                     self.keep_alive = False | ||||||
|                     raise BadRequest("Bad chunked encoding") |                     raise InvalidUsage("Bad chunked encoding") | ||||||
| 
 | 
 | ||||||
|                 # Consume CRLF, chunk size 0 and the two CRLF that follow |                 # Consume CRLF, chunk size 0 and the two CRLF that follow | ||||||
|                 pos += 4 |                 pos += 4 | ||||||
| @@ -1,6 +0,0 @@ | |||||||
| from .constants import Stage |  | ||||||
| from .http1 import Http |  | ||||||
| from .http3 import Http3 |  | ||||||
|  |  | ||||||
|  |  | ||||||
| __all__ = ("Http", "Stage", "Http3") |  | ||||||
| @@ -1,29 +0,0 @@ | |||||||
| 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}" |  | ||||||
| @@ -1,406 +0,0 @@ | |||||||
| 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 |  | ||||||
| @@ -1,27 +0,0 @@ | |||||||
| 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") |  | ||||||
| @@ -1,5 +0,0 @@ | |||||||
| from .context import process_to_context |  | ||||||
| from .creators import get_ssl_context |  | ||||||
|  |  | ||||||
|  |  | ||||||
| __all__ = ("get_ssl_context", "process_to_context") |  | ||||||
| @@ -1,286 +0,0 @@ | |||||||
| 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: ___." |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     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 " |  | ||||||
|                 "_____ 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: " |  | ||||||
|                 "_____" |  | ||||||
|             ) 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: " |  | ||||||
|                 "_____" |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|     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 |  | ||||||
							
								
								
									
										29
									
								
								sanic/log.py
									
									
									
									
									
								
							
							
						
						
									
										29
									
								
								sanic/log.py
									
									
									
									
									
								
							| @@ -5,8 +5,6 @@ from enum import Enum | |||||||
| from typing import Any, Dict | from typing import Any, Dict | ||||||
| from warnings import warn | from warnings import warn | ||||||
|  |  | ||||||
| from sanic.compat import is_atty |  | ||||||
|  |  | ||||||
|  |  | ||||||
| LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict(  # no cov | LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict(  # no cov | ||||||
|     version=1, |     version=1, | ||||||
| @@ -57,54 +55,35 @@ LOGGING_CONFIG_DEFAULTS: Dict[str, Any] = dict(  # no cov | |||||||
|         }, |         }, | ||||||
|     }, |     }, | ||||||
| ) | ) | ||||||
| """ |  | ||||||
| Defult logging configuration |  | ||||||
| """ |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class Colors(str, Enum):  # no cov | class Colors(str, Enum):  # no cov | ||||||
|     END = "\033[0m" |     END = "\033[0m" | ||||||
|     BOLD = "\033[1m" |     BLUE = "\033[01;34m" | ||||||
|     BLUE = "\033[34m" |     GREEN = "\033[01;32m" | ||||||
|     GREEN = "\033[32m" |  | ||||||
|     PURPLE = "\033[35m" |  | ||||||
|     RED = "\033[31m" |  | ||||||
|     SANIC = "\033[38;2;255;13;104m" |  | ||||||
|     YELLOW = "\033[01;33m" |     YELLOW = "\033[01;33m" | ||||||
|  |     RED = "\033[01;31m" | ||||||
|  |  | ||||||
|  |  | ||||||
| class VerbosityFilter(logging.Filter): |  | ||||||
|     verbosity: int = 0 |  | ||||||
|  |  | ||||||
|     def filter(self, record: logging.LogRecord) -> bool: |  | ||||||
|         verbosity = getattr(record, "verbosity", 0) |  | ||||||
|         return verbosity <= self.verbosity |  | ||||||
|  |  | ||||||
|  |  | ||||||
| _verbosity_filter = VerbosityFilter() |  | ||||||
|  |  | ||||||
| logger = logging.getLogger("sanic.root")  # no cov | logger = logging.getLogger("sanic.root")  # no cov | ||||||
| """ | """ | ||||||
| General Sanic logger | General Sanic logger | ||||||
| """ | """ | ||||||
| logger.addFilter(_verbosity_filter) |  | ||||||
|  |  | ||||||
| error_logger = logging.getLogger("sanic.error")  # no cov | error_logger = logging.getLogger("sanic.error")  # no cov | ||||||
| """ | """ | ||||||
| Logger used by Sanic for error logging | Logger used by Sanic for error logging | ||||||
| """ | """ | ||||||
| error_logger.addFilter(_verbosity_filter) |  | ||||||
|  |  | ||||||
| access_logger = logging.getLogger("sanic.access")  # no cov | access_logger = logging.getLogger("sanic.access")  # no cov | ||||||
| """ | """ | ||||||
| Logger used by Sanic for access logging | Logger used by Sanic for access logging | ||||||
| """ | """ | ||||||
| access_logger.addFilter(_verbosity_filter) |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def deprecation(message: str, version: float):  # no cov | def deprecation(message: str, version: float):  # no cov | ||||||
|     version_info = f"[DEPRECATION v{version}] " |     version_info = f"[DEPRECATION v{version}] " | ||||||
|     if is_atty(): |     if sys.stdout.isatty(): | ||||||
|         version_info = f"{Colors.RED}{version_info}" |         version_info = f"{Colors.RED}{version_info}" | ||||||
|         message = f"{Colors.YELLOW}{message}{Colors.END}" |         message = f"{Colors.YELLOW}{message}{Colors.END}" | ||||||
|     warn(version_info + message, DeprecationWarning) |     warn(version_info + message, DeprecationWarning) | ||||||
|   | |||||||
| @@ -1,66 +0,0 @@ | |||||||
| from __future__ import annotations |  | ||||||
|  |  | ||||||
| from collections import deque |  | ||||||
| from enum import IntEnum, auto |  | ||||||
| from itertools import count |  | ||||||
| from typing import Deque, Sequence, Union |  | ||||||
|  |  | ||||||
| from sanic.models.handler_types import MiddlewareType |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class MiddlewareLocation(IntEnum): |  | ||||||
|     REQUEST = auto() |  | ||||||
|     RESPONSE = auto() |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class Middleware: |  | ||||||
|     _counter = count() |  | ||||||
|  |  | ||||||
|     __slots__ = ("func", "priority", "location", "definition") |  | ||||||
|  |  | ||||||
|     def __init__( |  | ||||||
|         self, |  | ||||||
|         func: MiddlewareType, |  | ||||||
|         location: MiddlewareLocation = MiddlewareLocation.REQUEST, |  | ||||||
|         priority: int = 0, |  | ||||||
|     ) -> None: |  | ||||||
|         self.func = func |  | ||||||
|         self.priority = priority |  | ||||||
|         self.location = location |  | ||||||
|         self.definition = next(Middleware._counter) |  | ||||||
|  |  | ||||||
|     def __call__(self, *args, **kwargs): |  | ||||||
|         return self.func(*args, **kwargs) |  | ||||||
|  |  | ||||||
|     def __repr__(self) -> str: |  | ||||||
|         name = getattr(self.func, "__name__", str(self.func)) |  | ||||||
|         return ( |  | ||||||
|             f"{self.__class__.__name__}(" |  | ||||||
|             f"func=<function {name}>, " |  | ||||||
|             f"priority={self.priority}, " |  | ||||||
|             f"location={self.location.name})" |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def order(self): |  | ||||||
|         return (self.priority, -self.definition) |  | ||||||
|  |  | ||||||
|     @classmethod |  | ||||||
|     def convert( |  | ||||||
|         cls, |  | ||||||
|         *middleware_collections: Sequence[Union[Middleware, MiddlewareType]], |  | ||||||
|         location: MiddlewareLocation, |  | ||||||
|     ) -> Deque[Middleware]: |  | ||||||
|         return deque( |  | ||||||
|             [ |  | ||||||
|                 middleware |  | ||||||
|                 if isinstance(middleware, Middleware) |  | ||||||
|                 else Middleware(middleware, location) |  | ||||||
|                 for collection in middleware_collections |  | ||||||
|                 for middleware in collection |  | ||||||
|             ] |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     @classmethod |  | ||||||
|     def reset_count(cls): |  | ||||||
|         cls._counter = count() |  | ||||||
| @@ -1,9 +1,8 @@ | |||||||
| from enum import Enum, auto | from enum import Enum, auto | ||||||
| from functools import partial | from functools import partial | ||||||
| from typing import Callable, List, Optional, Union, overload | from typing import List, Optional, Union | ||||||
|  |  | ||||||
| from sanic.base.meta import SanicMeta | from sanic.base.meta import SanicMeta | ||||||
| from sanic.exceptions import BadRequest |  | ||||||
| from sanic.models.futures import FutureListener | from sanic.models.futures import FutureListener | ||||||
| from sanic.models.handler_types import ListenerType, Sanic | from sanic.models.handler_types import ListenerType, Sanic | ||||||
|  |  | ||||||
| @@ -17,12 +16,7 @@ class ListenerEvent(str, Enum): | |||||||
|     BEFORE_SERVER_STOP = "server.shutdown.before" |     BEFORE_SERVER_STOP = "server.shutdown.before" | ||||||
|     AFTER_SERVER_STOP = "server.shutdown.after" |     AFTER_SERVER_STOP = "server.shutdown.after" | ||||||
|     MAIN_PROCESS_START = auto() |     MAIN_PROCESS_START = auto() | ||||||
|     MAIN_PROCESS_READY = auto() |  | ||||||
|     MAIN_PROCESS_STOP = auto() |     MAIN_PROCESS_STOP = auto() | ||||||
|     RELOAD_PROCESS_START = auto() |  | ||||||
|     RELOAD_PROCESS_STOP = auto() |  | ||||||
|     BEFORE_RELOAD_TRIGGER = auto() |  | ||||||
|     AFTER_RELOAD_TRIGGER = auto() |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class ListenerMixin(metaclass=SanicMeta): | class ListenerMixin(metaclass=SanicMeta): | ||||||
| @@ -32,33 +26,12 @@ class ListenerMixin(metaclass=SanicMeta): | |||||||
|     def _apply_listener(self, listener: FutureListener): |     def _apply_listener(self, listener: FutureListener): | ||||||
|         raise NotImplementedError  # noqa |         raise NotImplementedError  # noqa | ||||||
|  |  | ||||||
|     @overload |  | ||||||
|     def listener( |  | ||||||
|         self, |  | ||||||
|         listener_or_event: ListenerType[Sanic], |  | ||||||
|         event_or_none: str, |  | ||||||
|         apply: bool = ..., |  | ||||||
|     ) -> ListenerType[Sanic]: |  | ||||||
|         ... |  | ||||||
|  |  | ||||||
|     @overload |  | ||||||
|     def listener( |  | ||||||
|         self, |  | ||||||
|         listener_or_event: str, |  | ||||||
|         event_or_none: None = ..., |  | ||||||
|         apply: bool = ..., |  | ||||||
|     ) -> Callable[[ListenerType[Sanic]], ListenerType[Sanic]]: |  | ||||||
|         ... |  | ||||||
|  |  | ||||||
|     def listener( |     def listener( | ||||||
|         self, |         self, | ||||||
|         listener_or_event: Union[ListenerType[Sanic], str], |         listener_or_event: Union[ListenerType[Sanic], str], | ||||||
|         event_or_none: Optional[str] = None, |         event_or_none: Optional[str] = None, | ||||||
|         apply: bool = True, |         apply: bool = True, | ||||||
|     ) -> Union[ |     ) -> ListenerType[Sanic]: | ||||||
|         ListenerType[Sanic], |  | ||||||
|         Callable[[ListenerType[Sanic]], ListenerType[Sanic]], |  | ||||||
|     ]: |  | ||||||
|         """ |         """ | ||||||
|         Create a listener from a decorated function. |         Create a listener from a decorated function. | ||||||
|  |  | ||||||
| @@ -76,9 +49,7 @@ class ListenerMixin(metaclass=SanicMeta): | |||||||
|         :param event: event to listen to |         :param event: event to listen to | ||||||
|         """ |         """ | ||||||
|  |  | ||||||
|         def register_listener( |         def register_listener(listener, event): | ||||||
|             listener: ListenerType[Sanic], event: str |  | ||||||
|         ) -> ListenerType[Sanic]: |  | ||||||
|             nonlocal apply |             nonlocal apply | ||||||
|  |  | ||||||
|             future_listener = FutureListener(listener, event) |             future_listener = FutureListener(listener, event) | ||||||
| @@ -88,10 +59,6 @@ class ListenerMixin(metaclass=SanicMeta): | |||||||
|             return listener |             return listener | ||||||
|  |  | ||||||
|         if callable(listener_or_event): |         if callable(listener_or_event): | ||||||
|             if event_or_none is None: |  | ||||||
|                 raise BadRequest( |  | ||||||
|                     "Invalid event registration: Missing event name." |  | ||||||
|                 ) |  | ||||||
|             return register_listener(listener_or_event, event_or_none) |             return register_listener(listener_or_event, event_or_none) | ||||||
|         else: |         else: | ||||||
|             return partial(register_listener, event=listener_or_event) |             return partial(register_listener, event=listener_or_event) | ||||||
| @@ -101,36 +68,11 @@ class ListenerMixin(metaclass=SanicMeta): | |||||||
|     ) -> ListenerType[Sanic]: |     ) -> ListenerType[Sanic]: | ||||||
|         return self.listener(listener, "main_process_start") |         return self.listener(listener, "main_process_start") | ||||||
|  |  | ||||||
|     def main_process_ready( |  | ||||||
|         self, listener: ListenerType[Sanic] |  | ||||||
|     ) -> ListenerType[Sanic]: |  | ||||||
|         return self.listener(listener, "main_process_ready") |  | ||||||
|  |  | ||||||
|     def main_process_stop( |     def main_process_stop( | ||||||
|         self, listener: ListenerType[Sanic] |         self, listener: ListenerType[Sanic] | ||||||
|     ) -> ListenerType[Sanic]: |     ) -> ListenerType[Sanic]: | ||||||
|         return self.listener(listener, "main_process_stop") |         return self.listener(listener, "main_process_stop") | ||||||
|  |  | ||||||
|     def reload_process_start( |  | ||||||
|         self, listener: ListenerType[Sanic] |  | ||||||
|     ) -> ListenerType[Sanic]: |  | ||||||
|         return self.listener(listener, "reload_process_start") |  | ||||||
|  |  | ||||||
|     def reload_process_stop( |  | ||||||
|         self, listener: ListenerType[Sanic] |  | ||||||
|     ) -> ListenerType[Sanic]: |  | ||||||
|         return self.listener(listener, "reload_process_stop") |  | ||||||
|  |  | ||||||
|     def before_reload_trigger( |  | ||||||
|         self, listener: ListenerType[Sanic] |  | ||||||
|     ) -> ListenerType[Sanic]: |  | ||||||
|         return self.listener(listener, "before_reload_trigger") |  | ||||||
|  |  | ||||||
|     def after_reload_trigger( |  | ||||||
|         self, listener: ListenerType[Sanic] |  | ||||||
|     ) -> ListenerType[Sanic]: |  | ||||||
|         return self.listener(listener, "after_reload_trigger") |  | ||||||
|  |  | ||||||
|     def before_server_start( |     def before_server_start( | ||||||
|         self, listener: ListenerType[Sanic] |         self, listener: ListenerType[Sanic] | ||||||
|     ) -> ListenerType[Sanic]: |     ) -> ListenerType[Sanic]: | ||||||
|   | |||||||
| @@ -1,18 +1,11 @@ | |||||||
| from collections import deque |  | ||||||
| from functools import partial | from functools import partial | ||||||
| from operator import attrgetter |  | ||||||
| from typing import List | from typing import List | ||||||
|  |  | ||||||
| from sanic.base.meta import SanicMeta | from sanic.base.meta import SanicMeta | ||||||
| from sanic.handlers import RequestHandler |  | ||||||
| from sanic.middleware import Middleware, MiddlewareLocation |  | ||||||
| from sanic.models.futures import FutureMiddleware | from sanic.models.futures import FutureMiddleware | ||||||
| from sanic.router import Router |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class MiddlewareMixin(metaclass=SanicMeta): | class MiddlewareMixin(metaclass=SanicMeta): | ||||||
|     router: Router |  | ||||||
|  |  | ||||||
|     def __init__(self, *args, **kwargs) -> None: |     def __init__(self, *args, **kwargs) -> None: | ||||||
|         self._future_middleware: List[FutureMiddleware] = [] |         self._future_middleware: List[FutureMiddleware] = [] | ||||||
|  |  | ||||||
| @@ -20,17 +13,12 @@ class MiddlewareMixin(metaclass=SanicMeta): | |||||||
|         raise NotImplementedError  # noqa |         raise NotImplementedError  # noqa | ||||||
|  |  | ||||||
|     def middleware( |     def middleware( | ||||||
|         self, |         self, middleware_or_request, attach_to="request", apply=True | ||||||
|         middleware_or_request, |  | ||||||
|         attach_to="request", |  | ||||||
|         apply=True, |  | ||||||
|         *, |  | ||||||
|         priority=0 |  | ||||||
|     ): |     ): | ||||||
|         """ |         """ | ||||||
|         Decorate and register middleware to be called before a request |         Decorate and register middleware to be called before a request. | ||||||
|         is handled or after a response is created. Can either be called as |         Can either be called as *@app.middleware* or | ||||||
|         *@app.middleware* or *@app.middleware('request')*. |         *@app.middleware('request')* | ||||||
|  |  | ||||||
|         `See user guide re: middleware |         `See user guide re: middleware | ||||||
|         <https://sanicframework.org/guide/basics/middleware.html>`__ |         <https://sanicframework.org/guide/basics/middleware.html>`__ | ||||||
| @@ -42,12 +30,6 @@ class MiddlewareMixin(metaclass=SanicMeta): | |||||||
|         def register_middleware(middleware, attach_to="request"): |         def register_middleware(middleware, attach_to="request"): | ||||||
|             nonlocal apply |             nonlocal apply | ||||||
|  |  | ||||||
|             location = ( |  | ||||||
|                 MiddlewareLocation.REQUEST |  | ||||||
|                 if attach_to == "request" |  | ||||||
|                 else MiddlewareLocation.RESPONSE |  | ||||||
|             ) |  | ||||||
|             middleware = Middleware(middleware, location, priority=priority) |  | ||||||
|             future_middleware = FutureMiddleware(middleware, attach_to) |             future_middleware = FutureMiddleware(middleware, attach_to) | ||||||
|             self._future_middleware.append(future_middleware) |             self._future_middleware.append(future_middleware) | ||||||
|             if apply: |             if apply: | ||||||
| @@ -64,84 +46,14 @@ class MiddlewareMixin(metaclass=SanicMeta): | |||||||
|                 register_middleware, attach_to=middleware_or_request |                 register_middleware, attach_to=middleware_or_request | ||||||
|             ) |             ) | ||||||
|  |  | ||||||
|     def on_request(self, middleware=None, *, priority=0): |     def on_request(self, middleware=None): | ||||||
|         """Register a middleware to be called before a request is handled. |  | ||||||
|  |  | ||||||
|         This is the same as *@app.middleware('request')*. |  | ||||||
|  |  | ||||||
|         :param: middleware: A callable that takes in request. |  | ||||||
|         """ |  | ||||||
|         if callable(middleware): |         if callable(middleware): | ||||||
|             return self.middleware(middleware, "request", priority=priority) |             return self.middleware(middleware, "request") | ||||||
|         else: |         else: | ||||||
|             return partial( |             return partial(self.middleware, attach_to="request") | ||||||
|                 self.middleware, attach_to="request", priority=priority |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|     def on_response(self, middleware=None, *, priority=0): |     def on_response(self, middleware=None): | ||||||
|         """Register a middleware to be called after a response is created. |  | ||||||
|  |  | ||||||
|         This is the same as *@app.middleware('response')*. |  | ||||||
|  |  | ||||||
|         :param: middleware: |  | ||||||
|             A callable that takes in a request and its response. |  | ||||||
|         """ |  | ||||||
|         if callable(middleware): |         if callable(middleware): | ||||||
|             return self.middleware(middleware, "response", priority=priority) |             return self.middleware(middleware, "response") | ||||||
|         else: |         else: | ||||||
|             return partial( |             return partial(self.middleware, attach_to="response") | ||||||
|                 self.middleware, attach_to="response", priority=priority |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|     def finalize_middleware(self): |  | ||||||
|         for route in self.router.routes: |  | ||||||
|             request_middleware = Middleware.convert( |  | ||||||
|                 self.request_middleware, |  | ||||||
|                 self.named_request_middleware.get(route.name, deque()), |  | ||||||
|                 location=MiddlewareLocation.REQUEST, |  | ||||||
|             ) |  | ||||||
|             response_middleware = Middleware.convert( |  | ||||||
|                 self.response_middleware, |  | ||||||
|                 self.named_response_middleware.get(route.name, deque()), |  | ||||||
|                 location=MiddlewareLocation.RESPONSE, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|             route.handler = RequestHandler( |  | ||||||
|                 route.handler, |  | ||||||
|                 deque( |  | ||||||
|                     sorted( |  | ||||||
|                         request_middleware, |  | ||||||
|                         key=attrgetter("order"), |  | ||||||
|                         reverse=True, |  | ||||||
|                     ) |  | ||||||
|                 ), |  | ||||||
|                 deque( |  | ||||||
|                     sorted( |  | ||||||
|                         response_middleware, |  | ||||||
|                         key=attrgetter("order"), |  | ||||||
|                         reverse=True, |  | ||||||
|                     )[::-1] |  | ||||||
|                 ), |  | ||||||
|             ) |  | ||||||
|         request_middleware = Middleware.convert( |  | ||||||
|             self.request_middleware, |  | ||||||
|             location=MiddlewareLocation.REQUEST, |  | ||||||
|         ) |  | ||||||
|         response_middleware = Middleware.convert( |  | ||||||
|             self.response_middleware, |  | ||||||
|             location=MiddlewareLocation.RESPONSE, |  | ||||||
|         ) |  | ||||||
|         self.request_middleware = deque( |  | ||||||
|             sorted( |  | ||||||
|                 request_middleware, |  | ||||||
|                 key=attrgetter("order"), |  | ||||||
|                 reverse=True, |  | ||||||
|             ) |  | ||||||
|         ) |  | ||||||
|         self.response_middleware = deque( |  | ||||||
|             sorted( |  | ||||||
|                 response_middleware, |  | ||||||
|                 key=attrgetter("order"), |  | ||||||
|                 reverse=True, |  | ||||||
|             )[::-1] |  | ||||||
|         ) |  | ||||||
|   | |||||||
| @@ -4,31 +4,27 @@ from functools import partial, wraps | |||||||
| from inspect import getsource, signature | from inspect import getsource, signature | ||||||
| from mimetypes import guess_type | from mimetypes import guess_type | ||||||
| from os import path | from os import path | ||||||
| from pathlib import Path, PurePath | from pathlib import PurePath | ||||||
|  | from re import sub | ||||||
| from textwrap import dedent | from textwrap import dedent | ||||||
| from time import gmtime, strftime | from time import gmtime, strftime | ||||||
| from typing import ( | from typing import Any, Callable, Iterable, List, Optional, Set, Tuple, Union | ||||||
|     Any, |  | ||||||
|     Callable, |  | ||||||
|     Iterable, |  | ||||||
|     List, |  | ||||||
|     Optional, |  | ||||||
|     Set, |  | ||||||
|     Tuple, |  | ||||||
|     Union, |  | ||||||
|     cast, |  | ||||||
| ) |  | ||||||
| from urllib.parse import unquote | from urllib.parse import unquote | ||||||
|  |  | ||||||
| from sanic_routing.route import Route | from sanic_routing.route import Route  # type: ignore | ||||||
|  |  | ||||||
| from sanic.base.meta import SanicMeta | from sanic.base.meta import SanicMeta | ||||||
| from sanic.compat import stat_async | from sanic.compat import stat_async | ||||||
| from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE, HTTP_METHODS | from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE, HTTP_METHODS | ||||||
| from sanic.errorpages import RESPONSE_MAPPING | from sanic.errorpages import RESPONSE_MAPPING | ||||||
| from sanic.exceptions import FileNotFound, HeaderNotFound, RangeNotSatisfiable | from sanic.exceptions import ( | ||||||
|  |     ContentRangeError, | ||||||
|  |     FileNotFound, | ||||||
|  |     HeaderNotFound, | ||||||
|  |     InvalidUsage, | ||||||
|  | ) | ||||||
| from sanic.handlers import ContentRangeHandler | from sanic.handlers import ContentRangeHandler | ||||||
| from sanic.log import error_logger | from sanic.log import deprecation, error_logger | ||||||
| from sanic.models.futures import FutureRoute, FutureStatic | from sanic.models.futures import FutureRoute, FutureStatic | ||||||
| from sanic.models.handler_types import RouteHandler | from sanic.models.handler_types import RouteHandler | ||||||
| from sanic.response import HTTPResponse, file, file_stream | from sanic.response import HTTPResponse, file, file_stream | ||||||
| @@ -225,7 +221,7 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         stream: bool = False, |         stream: bool = False, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ) -> RouteHandler: |     ) -> RouteHandler: | ||||||
|         """A helper method to register class instance or |         """A helper method to register class instance or | ||||||
|         functions as a handler to the application url |         functions as a handler to the application url | ||||||
| @@ -286,8 +282,8 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         ignore_body: bool = True, |         ignore_body: bool = True, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ) -> RouteHandler: |     ) -> RouteWrapper: | ||||||
|         """ |         """ | ||||||
|         Add an API URL under the **GET** *HTTP* method |         Add an API URL under the **GET** *HTTP* method | ||||||
|  |  | ||||||
| @@ -303,20 +299,17 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|             will be appended to the route context (``route.ctx``) |             will be appended to the route context (``route.ctx``) | ||||||
|         :return: Object decorated with :func:`route` method |         :return: Object decorated with :func:`route` method | ||||||
|         """ |         """ | ||||||
|         return cast( |         return self.route( | ||||||
|             RouteHandler, |             uri, | ||||||
|             self.route( |             methods=frozenset({"GET"}), | ||||||
|                 uri, |             host=host, | ||||||
|                 methods=frozenset({"GET"}), |             strict_slashes=strict_slashes, | ||||||
|                 host=host, |             version=version, | ||||||
|                 strict_slashes=strict_slashes, |             name=name, | ||||||
|                 version=version, |             ignore_body=ignore_body, | ||||||
|                 name=name, |             version_prefix=version_prefix, | ||||||
|                 ignore_body=ignore_body, |             error_format=error_format, | ||||||
|                 version_prefix=version_prefix, |             **ctx_kwargs, | ||||||
|                 error_format=error_format, |  | ||||||
|                 **ctx_kwargs, |  | ||||||
|             ), |  | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     def post( |     def post( | ||||||
| @@ -329,8 +322,8 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         name: Optional[str] = None, |         name: Optional[str] = None, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ) -> RouteHandler: |     ) -> RouteWrapper: | ||||||
|         """ |         """ | ||||||
|         Add an API URL under the **POST** *HTTP* method |         Add an API URL under the **POST** *HTTP* method | ||||||
|  |  | ||||||
| @@ -346,20 +339,17 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|             will be appended to the route context (``route.ctx``) |             will be appended to the route context (``route.ctx``) | ||||||
|         :return: Object decorated with :func:`route` method |         :return: Object decorated with :func:`route` method | ||||||
|         """ |         """ | ||||||
|         return cast( |         return self.route( | ||||||
|             RouteHandler, |             uri, | ||||||
|             self.route( |             methods=frozenset({"POST"}), | ||||||
|                 uri, |             host=host, | ||||||
|                 methods=frozenset({"POST"}), |             strict_slashes=strict_slashes, | ||||||
|                 host=host, |             stream=stream, | ||||||
|                 strict_slashes=strict_slashes, |             version=version, | ||||||
|                 stream=stream, |             name=name, | ||||||
|                 version=version, |             version_prefix=version_prefix, | ||||||
|                 name=name, |             error_format=error_format, | ||||||
|                 version_prefix=version_prefix, |             **ctx_kwargs, | ||||||
|                 error_format=error_format, |  | ||||||
|                 **ctx_kwargs, |  | ||||||
|             ), |  | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     def put( |     def put( | ||||||
| @@ -372,8 +362,8 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         name: Optional[str] = None, |         name: Optional[str] = None, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ) -> RouteHandler: |     ) -> RouteWrapper: | ||||||
|         """ |         """ | ||||||
|         Add an API URL under the **PUT** *HTTP* method |         Add an API URL under the **PUT** *HTTP* method | ||||||
|  |  | ||||||
| @@ -389,20 +379,17 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|             will be appended to the route context (``route.ctx``) |             will be appended to the route context (``route.ctx``) | ||||||
|         :return: Object decorated with :func:`route` method |         :return: Object decorated with :func:`route` method | ||||||
|         """ |         """ | ||||||
|         return cast( |         return self.route( | ||||||
|             RouteHandler, |             uri, | ||||||
|             self.route( |             methods=frozenset({"PUT"}), | ||||||
|                 uri, |             host=host, | ||||||
|                 methods=frozenset({"PUT"}), |             strict_slashes=strict_slashes, | ||||||
|                 host=host, |             stream=stream, | ||||||
|                 strict_slashes=strict_slashes, |             version=version, | ||||||
|                 stream=stream, |             name=name, | ||||||
|                 version=version, |             version_prefix=version_prefix, | ||||||
|                 name=name, |             error_format=error_format, | ||||||
|                 version_prefix=version_prefix, |             **ctx_kwargs, | ||||||
|                 error_format=error_format, |  | ||||||
|                 **ctx_kwargs, |  | ||||||
|             ), |  | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     def head( |     def head( | ||||||
| @@ -415,8 +402,8 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         ignore_body: bool = True, |         ignore_body: bool = True, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ) -> RouteHandler: |     ) -> RouteWrapper: | ||||||
|         """ |         """ | ||||||
|         Add an API URL under the **HEAD** *HTTP* method |         Add an API URL under the **HEAD** *HTTP* method | ||||||
|  |  | ||||||
| @@ -440,20 +427,17 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|             will be appended to the route context (``route.ctx``) |             will be appended to the route context (``route.ctx``) | ||||||
|         :return: Object decorated with :func:`route` method |         :return: Object decorated with :func:`route` method | ||||||
|         """ |         """ | ||||||
|         return cast( |         return self.route( | ||||||
|             RouteHandler, |             uri, | ||||||
|             self.route( |             methods=frozenset({"HEAD"}), | ||||||
|                 uri, |             host=host, | ||||||
|                 methods=frozenset({"HEAD"}), |             strict_slashes=strict_slashes, | ||||||
|                 host=host, |             version=version, | ||||||
|                 strict_slashes=strict_slashes, |             name=name, | ||||||
|                 version=version, |             ignore_body=ignore_body, | ||||||
|                 name=name, |             version_prefix=version_prefix, | ||||||
|                 ignore_body=ignore_body, |             error_format=error_format, | ||||||
|                 version_prefix=version_prefix, |             **ctx_kwargs, | ||||||
|                 error_format=error_format, |  | ||||||
|                 **ctx_kwargs, |  | ||||||
|             ), |  | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     def options( |     def options( | ||||||
| @@ -466,8 +450,8 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         ignore_body: bool = True, |         ignore_body: bool = True, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ) -> RouteHandler: |     ) -> RouteWrapper: | ||||||
|         """ |         """ | ||||||
|         Add an API URL under the **OPTIONS** *HTTP* method |         Add an API URL under the **OPTIONS** *HTTP* method | ||||||
|  |  | ||||||
| @@ -491,20 +475,17 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|             will be appended to the route context (``route.ctx``) |             will be appended to the route context (``route.ctx``) | ||||||
|         :return: Object decorated with :func:`route` method |         :return: Object decorated with :func:`route` method | ||||||
|         """ |         """ | ||||||
|         return cast( |         return self.route( | ||||||
|             RouteHandler, |             uri, | ||||||
|             self.route( |             methods=frozenset({"OPTIONS"}), | ||||||
|                 uri, |             host=host, | ||||||
|                 methods=frozenset({"OPTIONS"}), |             strict_slashes=strict_slashes, | ||||||
|                 host=host, |             version=version, | ||||||
|                 strict_slashes=strict_slashes, |             name=name, | ||||||
|                 version=version, |             ignore_body=ignore_body, | ||||||
|                 name=name, |             version_prefix=version_prefix, | ||||||
|                 ignore_body=ignore_body, |             error_format=error_format, | ||||||
|                 version_prefix=version_prefix, |             **ctx_kwargs, | ||||||
|                 error_format=error_format, |  | ||||||
|                 **ctx_kwargs, |  | ||||||
|             ), |  | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     def patch( |     def patch( | ||||||
| @@ -517,8 +498,8 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         name: Optional[str] = None, |         name: Optional[str] = None, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ) -> RouteHandler: |     ) -> RouteWrapper: | ||||||
|         """ |         """ | ||||||
|         Add an API URL under the **PATCH** *HTTP* method |         Add an API URL under the **PATCH** *HTTP* method | ||||||
|  |  | ||||||
| @@ -544,20 +525,17 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|             will be appended to the route context (``route.ctx``) |             will be appended to the route context (``route.ctx``) | ||||||
|         :return: Object decorated with :func:`route` method |         :return: Object decorated with :func:`route` method | ||||||
|         """ |         """ | ||||||
|         return cast( |         return self.route( | ||||||
|             RouteHandler, |             uri, | ||||||
|             self.route( |             methods=frozenset({"PATCH"}), | ||||||
|                 uri, |             host=host, | ||||||
|                 methods=frozenset({"PATCH"}), |             strict_slashes=strict_slashes, | ||||||
|                 host=host, |             stream=stream, | ||||||
|                 strict_slashes=strict_slashes, |             version=version, | ||||||
|                 stream=stream, |             name=name, | ||||||
|                 version=version, |             version_prefix=version_prefix, | ||||||
|                 name=name, |             error_format=error_format, | ||||||
|                 version_prefix=version_prefix, |             **ctx_kwargs, | ||||||
|                 error_format=error_format, |  | ||||||
|                 **ctx_kwargs, |  | ||||||
|             ), |  | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     def delete( |     def delete( | ||||||
| @@ -570,8 +548,8 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         ignore_body: bool = True, |         ignore_body: bool = True, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ) -> RouteHandler: |     ) -> RouteWrapper: | ||||||
|         """ |         """ | ||||||
|         Add an API URL under the **DELETE** *HTTP* method |         Add an API URL under the **DELETE** *HTTP* method | ||||||
|  |  | ||||||
| @@ -587,20 +565,17 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|             will be appended to the route context (``route.ctx``) |             will be appended to the route context (``route.ctx``) | ||||||
|         :return: Object decorated with :func:`route` method |         :return: Object decorated with :func:`route` method | ||||||
|         """ |         """ | ||||||
|         return cast( |         return self.route( | ||||||
|             RouteHandler, |             uri, | ||||||
|             self.route( |             methods=frozenset({"DELETE"}), | ||||||
|                 uri, |             host=host, | ||||||
|                 methods=frozenset({"DELETE"}), |             strict_slashes=strict_slashes, | ||||||
|                 host=host, |             version=version, | ||||||
|                 strict_slashes=strict_slashes, |             name=name, | ||||||
|                 version=version, |             ignore_body=ignore_body, | ||||||
|                 name=name, |             version_prefix=version_prefix, | ||||||
|                 ignore_body=ignore_body, |             error_format=error_format, | ||||||
|                 version_prefix=version_prefix, |             **ctx_kwargs, | ||||||
|                 error_format=error_format, |  | ||||||
|                 **ctx_kwargs, |  | ||||||
|             ), |  | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     def websocket( |     def websocket( | ||||||
| @@ -614,7 +589,7 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         apply: bool = True, |         apply: bool = True, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ): |     ): | ||||||
|         """ |         """ | ||||||
|         Decorate a function to be registered as a websocket route |         Decorate a function to be registered as a websocket route | ||||||
| @@ -658,7 +633,7 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         name: Optional[str] = None, |         name: Optional[str] = None, | ||||||
|         version_prefix: str = "/v", |         version_prefix: str = "/v", | ||||||
|         error_format: Optional[str] = None, |         error_format: Optional[str] = None, | ||||||
|         **ctx_kwargs: Any, |         **ctx_kwargs, | ||||||
|     ): |     ): | ||||||
|         """ |         """ | ||||||
|         A helper method to register a function as a websocket route. |         A helper method to register a function as a websocket route. | ||||||
| @@ -695,18 +670,18 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|  |  | ||||||
|     def static( |     def static( | ||||||
|         self, |         self, | ||||||
|         uri: str, |         uri, | ||||||
|         file_or_directory: Union[str, bytes, PurePath], |         file_or_directory: Union[str, bytes, PurePath], | ||||||
|         pattern: str = r"/?.+", |         pattern=r"/?.+", | ||||||
|         use_modified_since: bool = True, |         use_modified_since=True, | ||||||
|         use_content_range: bool = False, |         use_content_range=False, | ||||||
|         stream_large_files: bool = False, |         stream_large_files=False, | ||||||
|         name: str = "static", |         name="static", | ||||||
|         host: Optional[str] = None, |         host=None, | ||||||
|         strict_slashes: Optional[bool] = None, |         strict_slashes=None, | ||||||
|         content_type: Optional[bool] = None, |         content_type=None, | ||||||
|         apply: bool = True, |         apply=True, | ||||||
|         resource_type: Optional[str] = None, |         resource_type=None, | ||||||
|     ): |     ): | ||||||
|         """ |         """ | ||||||
|         Register a root to serve files from. The input can either be a |         Register a root to serve files from. The input can either be a | ||||||
| @@ -800,40 +775,32 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         content_type=None, |         content_type=None, | ||||||
|         __file_uri__=None, |         __file_uri__=None, | ||||||
|     ): |     ): | ||||||
|  |         # Using this to determine if the URL is trying to break out of the path | ||||||
|  |         # served.  os.path.realpath seems to be very slow | ||||||
|  |         if __file_uri__ and "../" in __file_uri__: | ||||||
|  |             raise InvalidUsage("Invalid URL") | ||||||
|         # Merge served directory and requested file if provided |         # Merge served directory and requested file if provided | ||||||
|         file_path_raw = Path(unquote(file_or_directory)) |         # Strip all / that in the beginning of the URL to help prevent python | ||||||
|         root_path = file_path = file_path_raw.resolve() |         # from herping a derp and treating the uri as an absolute path | ||||||
|         not_found = FileNotFound( |         root_path = file_path = file_or_directory | ||||||
|             "File not found", |  | ||||||
|             path=file_or_directory, |  | ||||||
|             relative_url=__file_uri__, |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|         if __file_uri__: |         if __file_uri__: | ||||||
|             # Strip all / that in the beginning of the URL to help prevent |             file_path = path.join( | ||||||
|             # python from herping a derp and treating the uri as an |                 file_or_directory, sub("^[/]*", "", __file_uri__) | ||||||
|             # absolute path |             ) | ||||||
|             unquoted_file_uri = unquote(__file_uri__).lstrip("/") |  | ||||||
|             file_path_raw = Path(file_or_directory, unquoted_file_uri) |  | ||||||
|             file_path = file_path_raw.resolve() |  | ||||||
|             if ( |  | ||||||
|                 file_path < root_path and not file_path_raw.is_symlink() |  | ||||||
|             ) or ".." in file_path_raw.parts: |  | ||||||
|                 error_logger.exception( |  | ||||||
|                     f"File not found: path={file_or_directory}, " |  | ||||||
|                     f"relative_url={__file_uri__}" |  | ||||||
|                 ) |  | ||||||
|                 raise not_found |  | ||||||
|  |  | ||||||
|         try: |         # URL decode the path sent by the browser otherwise we won't be able to | ||||||
|             file_path.relative_to(root_path) |         # match filenames which got encoded (filenames with spaces etc) | ||||||
|         except ValueError: |         file_path = path.abspath(unquote(file_path)) | ||||||
|             if not file_path_raw.is_symlink(): |         if not file_path.startswith(path.abspath(unquote(root_path))): | ||||||
|                 error_logger.exception( |             error_logger.exception( | ||||||
|                     f"File not found: path={file_or_directory}, " |                 f"File not found: path={file_or_directory}, " | ||||||
|                     f"relative_url={__file_uri__}" |                 f"relative_url={__file_uri__}" | ||||||
|                 ) |             ) | ||||||
|                 raise not_found |             raise FileNotFound( | ||||||
|  |                 "File not found", | ||||||
|  |                 path=file_or_directory, | ||||||
|  |                 relative_url=__file_uri__, | ||||||
|  |             ) | ||||||
|         try: |         try: | ||||||
|             headers = {} |             headers = {} | ||||||
|             # Check if the client has been sent this file before |             # Check if the client has been sent this file before | ||||||
| @@ -898,10 +865,14 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|                             file_path, headers=headers, _range=_range |                             file_path, headers=headers, _range=_range | ||||||
|                         ) |                         ) | ||||||
|                 return await file(file_path, headers=headers, _range=_range) |                 return await file(file_path, headers=headers, _range=_range) | ||||||
|         except RangeNotSatisfiable: |         except ContentRangeError: | ||||||
|             raise |             raise | ||||||
|         except FileNotFoundError: |         except FileNotFoundError: | ||||||
|             raise not_found |             raise FileNotFound( | ||||||
|  |                 "File not found", | ||||||
|  |                 path=file_or_directory, | ||||||
|  |                 relative_url=__file_uri__, | ||||||
|  |             ) | ||||||
|         except Exception: |         except Exception: | ||||||
|             error_logger.exception( |             error_logger.exception( | ||||||
|                 f"Exception in static request handler: " |                 f"Exception in static request handler: " | ||||||
| @@ -958,7 +929,6 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|         # serve from the folder |         # serve from the folder | ||||||
|         if not static.resource_type: |         if not static.resource_type: | ||||||
|             if not path.isfile(file_or_directory): |             if not path.isfile(file_or_directory): | ||||||
|                 uri = uri.rstrip("/") |  | ||||||
|                 uri += "/<__file_uri__:path>" |                 uri += "/<__file_uri__:path>" | ||||||
|         elif static.resource_type == "dir": |         elif static.resource_type == "dir": | ||||||
|             if path.isfile(file_or_directory): |             if path.isfile(file_or_directory): | ||||||
| @@ -966,7 +936,6 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|                     "Resource type improperly identified as directory. " |                     "Resource type improperly identified as directory. " | ||||||
|                     f"'{file_or_directory}'" |                     f"'{file_or_directory}'" | ||||||
|                 ) |                 ) | ||||||
|             uri = uri.rstrip("/") |  | ||||||
|             uri += "/<__file_uri__:path>" |             uri += "/<__file_uri__:path>" | ||||||
|         elif static.resource_type == "file" and not path.isfile( |         elif static.resource_type == "file" and not path.isfile( | ||||||
|             file_or_directory |             file_or_directory | ||||||
| @@ -1025,6 +994,17 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|                 nonlocal types |                 nonlocal types | ||||||
|  |  | ||||||
|                 with suppress(AttributeError): |                 with suppress(AttributeError): | ||||||
|  |                     if node.value.func.id == "stream":  # type: ignore | ||||||
|  |                         deprecation( | ||||||
|  |                             "The sanic.response.stream method has been " | ||||||
|  |                             "deprecated and will be removed in v22.6. Please " | ||||||
|  |                             "upgrade your application to use the new style " | ||||||
|  |                             "streaming pattern. See " | ||||||
|  |                             "https://sanicframework.org/en/guide/advanced/" | ||||||
|  |                             "streaming.html#response-streaming for more " | ||||||
|  |                             "information.", | ||||||
|  |                             22.6, | ||||||
|  |                         ) | ||||||
|                     checks = [node.value.func.id]  # type: ignore |                     checks = [node.value.func.id]  # type: ignore | ||||||
|                     if node.value.keywords:  # type: ignore |                     if node.value.keywords:  # type: ignore | ||||||
|                         checks += [ |                         checks += [ | ||||||
| @@ -1055,7 +1035,7 @@ class RouteMixin(metaclass=SanicMeta): | |||||||
|             raise AttributeError( |             raise AttributeError( | ||||||
|                 "Cannot use restricted route context: " |                 "Cannot use restricted route context: " | ||||||
|                 f"{restricted_arguments}. This limitation is only in place " |                 f"{restricted_arguments}. This limitation is only in place " | ||||||
|                 "until v22.9 when the restricted names will no longer be in" |                 "until v22.3 when the restricted names will no longer be in" | ||||||
|                 "conflict. See https://github.com/sanic-org/sanic/issues/2303 " |                 "conflict. See https://github.com/sanic-org/sanic/issues/2303 " | ||||||
|                 "for more information." |                 "for more information." | ||||||
|             ) |             ) | ||||||
|   | |||||||
| @@ -11,95 +11,47 @@ from asyncio import ( | |||||||
|     all_tasks, |     all_tasks, | ||||||
|     get_event_loop, |     get_event_loop, | ||||||
|     get_running_loop, |     get_running_loop, | ||||||
|     new_event_loop, |  | ||||||
| ) | ) | ||||||
| from contextlib import suppress | from contextlib import suppress | ||||||
| from functools import partial | from functools import partial | ||||||
| from importlib import import_module | from importlib import import_module | ||||||
| from multiprocessing import Manager, Pipe, get_context |  | ||||||
| from multiprocessing.context import BaseContext |  | ||||||
| from pathlib import Path | from pathlib import Path | ||||||
| from socket import socket | from socket import socket | ||||||
| from ssl import SSLContext | from ssl import SSLContext | ||||||
| from typing import ( | from typing import TYPE_CHECKING, Any, Dict, List, Optional, Set, Type, Union | ||||||
|     TYPE_CHECKING, |  | ||||||
|     Any, |  | ||||||
|     Callable, |  | ||||||
|     Dict, |  | ||||||
|     List, |  | ||||||
|     Optional, |  | ||||||
|     Set, |  | ||||||
|     Tuple, |  | ||||||
|     Type, |  | ||||||
|     Union, |  | ||||||
|     cast, |  | ||||||
| ) |  | ||||||
| 
 | 
 | ||||||
|  | from sanic import reloader_helpers | ||||||
| from sanic.application.logo import get_logo | from sanic.application.logo import get_logo | ||||||
| from sanic.application.motd import MOTD | from sanic.application.motd import MOTD | ||||||
| from sanic.application.state import ApplicationServerInfo, Mode, ServerStage | from sanic.application.state import ApplicationServerInfo, Mode, ServerStage | ||||||
| from sanic.base.meta import SanicMeta | from sanic.base.meta import SanicMeta | ||||||
| from sanic.compat import OS_IS_WINDOWS, is_atty | from sanic.compat import OS_IS_WINDOWS | ||||||
| from sanic.helpers import _default | from sanic.helpers import _default | ||||||
| from sanic.http.constants import HTTP | from sanic.log import Colors, error_logger, logger | ||||||
| from sanic.http.tls import get_ssl_context, process_to_context |  | ||||||
| from sanic.http.tls.context import SanicSSLContext |  | ||||||
| from sanic.log import Colors, deprecation, error_logger, logger |  | ||||||
| from sanic.models.handler_types import ListenerType | from sanic.models.handler_types import ListenerType | ||||||
| from sanic.server import Signal as ServerSignal | from sanic.server import Signal as ServerSignal | ||||||
| from sanic.server import try_use_uvloop | from sanic.server import try_use_uvloop | ||||||
| from sanic.server.async_server import AsyncioServer | from sanic.server.async_server import AsyncioServer | ||||||
| from sanic.server.events import trigger_events |  | ||||||
| from sanic.server.legacy import watchdog |  | ||||||
| from sanic.server.loop import try_windows_loop |  | ||||||
| from sanic.server.protocols.http_protocol import HttpProtocol | from sanic.server.protocols.http_protocol import HttpProtocol | ||||||
| from sanic.server.protocols.websocket_protocol import WebSocketProtocol | from sanic.server.protocols.websocket_protocol import WebSocketProtocol | ||||||
| from sanic.server.runners import serve, serve_multiple, serve_single | from sanic.server.runners import serve, serve_multiple, serve_single | ||||||
| from sanic.server.socket import configure_socket, remove_unix_socket | from sanic.tls import process_to_context | ||||||
| from sanic.worker.inspector import Inspector |  | ||||||
| from sanic.worker.loader import AppLoader |  | ||||||
| from sanic.worker.manager import WorkerManager |  | ||||||
| from sanic.worker.multiplexer import WorkerMultiplexer |  | ||||||
| from sanic.worker.reloader import Reloader |  | ||||||
| from sanic.worker.serve import worker_serve |  | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic import Sanic |     from sanic import Sanic | ||||||
|     from sanic.application.state import ApplicationState |     from sanic.application.state import ApplicationState | ||||||
|     from sanic.config import Config |     from sanic.config import Config | ||||||
| 
 | 
 | ||||||
| SANIC_PACKAGES = ("sanic-routing", "sanic-testing", "sanic-ext") | SANIC_PACKAGES = ("sanic-routing", "sanic-testing", "sanic-ext") | ||||||
| 
 | 
 | ||||||
| if sys.version_info < (3, 8):  # no cov |  | ||||||
|     HTTPVersion = Union[HTTP, int] |  | ||||||
| else:  # no cov |  | ||||||
|     from typing import Literal |  | ||||||
| 
 | 
 | ||||||
|     HTTPVersion = Union[HTTP, Literal[1], Literal[3]] | class RunnerMixin(metaclass=SanicMeta): | ||||||
| 
 |  | ||||||
| 
 |  | ||||||
| class StartupMixin(metaclass=SanicMeta): |  | ||||||
|     _app_registry: Dict[str, Sanic] |     _app_registry: Dict[str, Sanic] | ||||||
|     config: Config |     config: Config | ||||||
|     listeners: Dict[str, List[ListenerType[Any]]] |     listeners: Dict[str, List[ListenerType[Any]]] | ||||||
|     state: ApplicationState |     state: ApplicationState | ||||||
|     websocket_enabled: bool |     websocket_enabled: bool | ||||||
|     multiplexer: WorkerMultiplexer |  | ||||||
| 
 |  | ||||||
|     def setup_loop(self): |  | ||||||
|         if not self.asgi: |  | ||||||
|             if self.config.USE_UVLOOP is True or ( |  | ||||||
|                 self.config.USE_UVLOOP is _default and not OS_IS_WINDOWS |  | ||||||
|             ): |  | ||||||
|                 try_use_uvloop() |  | ||||||
|             elif OS_IS_WINDOWS: |  | ||||||
|                 try_windows_loop() |  | ||||||
| 
 |  | ||||||
|     @property |  | ||||||
|     def m(self) -> WorkerMultiplexer: |  | ||||||
|         """Interface for interacting with the worker processes""" |  | ||||||
|         return self.multiplexer |  | ||||||
| 
 | 
 | ||||||
|     def make_coffee(self, *args, **kwargs): |     def make_coffee(self, *args, **kwargs): | ||||||
|         self.state.coffee = True |         self.state.coffee = True | ||||||
| @@ -113,7 +65,6 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         dev: bool = False, |         dev: bool = False, | ||||||
|         debug: bool = False, |         debug: bool = False, | ||||||
|         auto_reload: Optional[bool] = None, |         auto_reload: Optional[bool] = None, | ||||||
|         version: HTTPVersion = HTTP.VERSION_1, |  | ||||||
|         ssl: Union[None, SSLContext, dict, str, list, tuple] = None, |         ssl: Union[None, SSLContext, dict, str, list, tuple] = None, | ||||||
|         sock: Optional[socket] = None, |         sock: Optional[socket] = None, | ||||||
|         workers: int = 1, |         workers: int = 1, | ||||||
| @@ -129,9 +80,6 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         fast: bool = False, |         fast: bool = False, | ||||||
|         verbosity: int = 0, |         verbosity: int = 0, | ||||||
|         motd_display: Optional[Dict[str, str]] = None, |         motd_display: Optional[Dict[str, str]] = None, | ||||||
|         auto_tls: bool = False, |  | ||||||
|         single_process: bool = False, |  | ||||||
|         legacy: bool = False, |  | ||||||
|     ) -> None: |     ) -> None: | ||||||
|         """ |         """ | ||||||
|         Run the HTTP Server and listen until keyboard interrupt or term |         Run the HTTP Server and listen until keyboard interrupt or term | ||||||
| @@ -175,7 +123,6 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|             dev=dev, |             dev=dev, | ||||||
|             debug=debug, |             debug=debug, | ||||||
|             auto_reload=auto_reload, |             auto_reload=auto_reload, | ||||||
|             version=version, |  | ||||||
|             ssl=ssl, |             ssl=ssl, | ||||||
|             sock=sock, |             sock=sock, | ||||||
|             workers=workers, |             workers=workers, | ||||||
| @@ -191,18 +138,9 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|             fast=fast, |             fast=fast, | ||||||
|             verbosity=verbosity, |             verbosity=verbosity, | ||||||
|             motd_display=motd_display, |             motd_display=motd_display, | ||||||
|             auto_tls=auto_tls, |  | ||||||
|             single_process=single_process, |  | ||||||
|             legacy=legacy, |  | ||||||
|         ) |         ) | ||||||
| 
 | 
 | ||||||
|         if single_process: |         self.__class__.serve(primary=self)  # type: ignore | ||||||
|             serve = self.__class__.serve_single |  | ||||||
|         elif legacy: |  | ||||||
|             serve = self.__class__.serve_legacy |  | ||||||
|         else: |  | ||||||
|             serve = self.__class__.serve |  | ||||||
|         serve(primary=self)  # type: ignore |  | ||||||
| 
 | 
 | ||||||
|     def prepare( |     def prepare( | ||||||
|         self, |         self, | ||||||
| @@ -212,7 +150,6 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         dev: bool = False, |         dev: bool = False, | ||||||
|         debug: bool = False, |         debug: bool = False, | ||||||
|         auto_reload: Optional[bool] = None, |         auto_reload: Optional[bool] = None, | ||||||
|         version: HTTPVersion = HTTP.VERSION_1, |  | ||||||
|         ssl: Union[None, SSLContext, dict, str, list, tuple] = None, |         ssl: Union[None, SSLContext, dict, str, list, tuple] = None, | ||||||
|         sock: Optional[socket] = None, |         sock: Optional[socket] = None, | ||||||
|         workers: int = 1, |         workers: int = 1, | ||||||
| @@ -228,25 +165,11 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         fast: bool = False, |         fast: bool = False, | ||||||
|         verbosity: int = 0, |         verbosity: int = 0, | ||||||
|         motd_display: Optional[Dict[str, str]] = None, |         motd_display: Optional[Dict[str, str]] = None, | ||||||
|         coffee: bool = False, |  | ||||||
|         auto_tls: bool = False, |  | ||||||
|         single_process: bool = False, |  | ||||||
|         legacy: bool = False, |  | ||||||
|     ) -> None: |     ) -> None: | ||||||
|         if version == 3 and self.state.server_info: |  | ||||||
|             raise RuntimeError( |  | ||||||
|                 "Serving HTTP/3 instances as a secondary server is " |  | ||||||
|                 "not supported. There can only be a single HTTP/3 worker " |  | ||||||
|                 "and it must be the first instance prepared." |  | ||||||
|             ) |  | ||||||
| 
 |  | ||||||
|         if dev: |         if dev: | ||||||
|             debug = True |             debug = True | ||||||
|             auto_reload = True |             auto_reload = True | ||||||
| 
 | 
 | ||||||
|         if debug and access_log is None: |  | ||||||
|             access_log = True |  | ||||||
| 
 |  | ||||||
|         self.state.verbosity = verbosity |         self.state.verbosity = verbosity | ||||||
|         if not self.state.auto_reload: |         if not self.state.auto_reload: | ||||||
|             self.state.auto_reload = bool(auto_reload) |             self.state.auto_reload = bool(auto_reload) | ||||||
| @@ -254,21 +177,6 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         if fast and workers != 1: |         if fast and workers != 1: | ||||||
|             raise RuntimeError("You cannot use both fast=True and workers=X") |             raise RuntimeError("You cannot use both fast=True and workers=X") | ||||||
| 
 | 
 | ||||||
|         if single_process and (fast or (workers > 1) or auto_reload): |  | ||||||
|             raise RuntimeError( |  | ||||||
|                 "Single process cannot be run with multiple workers " |  | ||||||
|                 "or auto-reload" |  | ||||||
|             ) |  | ||||||
| 
 |  | ||||||
|         if single_process and legacy: |  | ||||||
|             raise RuntimeError("Cannot run single process and legacy mode") |  | ||||||
| 
 |  | ||||||
|         if register_sys_signals is False and not (single_process or legacy): |  | ||||||
|             raise RuntimeError( |  | ||||||
|                 "Cannot run Sanic.serve with register_sys_signals=False. " |  | ||||||
|                 "Use either Sanic.serve_single or Sanic.serve_legacy." |  | ||||||
|             ) |  | ||||||
| 
 |  | ||||||
|         if motd_display: |         if motd_display: | ||||||
|             self.config.MOTD_DISPLAY.update(motd_display) |             self.config.MOTD_DISPLAY.update(motd_display) | ||||||
| 
 | 
 | ||||||
| @@ -292,8 +200,14 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|                 "#asynchronous-support" |                 "#asynchronous-support" | ||||||
|             ) |             ) | ||||||
| 
 | 
 | ||||||
|  |         if ( | ||||||
|  |             self.__class__.should_auto_reload() | ||||||
|  |             and os.environ.get("SANIC_SERVER_RUNNING") != "true" | ||||||
|  |         ):  # no cov | ||||||
|  |             return | ||||||
|  | 
 | ||||||
|         if sock is None: |         if sock is None: | ||||||
|             host, port = self.get_address(host, port, version, auto_tls) |             host, port = host or "127.0.0.1", port or 8000 | ||||||
| 
 | 
 | ||||||
|         if protocol is None: |         if protocol is None: | ||||||
|             protocol = ( |             protocol = ( | ||||||
| @@ -317,14 +231,10 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|             except AttributeError:  # no cov |             except AttributeError:  # no cov | ||||||
|                 workers = os.cpu_count() or 1 |                 workers = os.cpu_count() or 1 | ||||||
| 
 | 
 | ||||||
|         if coffee: |  | ||||||
|             self.state.coffee = True |  | ||||||
| 
 |  | ||||||
|         server_settings = self._helper( |         server_settings = self._helper( | ||||||
|             host=host, |             host=host, | ||||||
|             port=port, |             port=port, | ||||||
|             debug=debug, |             debug=debug, | ||||||
|             version=version, |  | ||||||
|             ssl=ssl, |             ssl=ssl, | ||||||
|             sock=sock, |             sock=sock, | ||||||
|             unix=unix, |             unix=unix, | ||||||
| @@ -332,16 +242,15 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|             protocol=protocol, |             protocol=protocol, | ||||||
|             backlog=backlog, |             backlog=backlog, | ||||||
|             register_sys_signals=register_sys_signals, |             register_sys_signals=register_sys_signals, | ||||||
|             auto_tls=auto_tls, |  | ||||||
|         ) |         ) | ||||||
|         self.state.server_info.append( |         self.state.server_info.append( | ||||||
|             ApplicationServerInfo(settings=server_settings) |             ApplicationServerInfo(settings=server_settings) | ||||||
|         ) |         ) | ||||||
| 
 | 
 | ||||||
|         # if self.config.USE_UVLOOP is True or ( |         if self.config.USE_UVLOOP is True or ( | ||||||
|         #     self.config.USE_UVLOOP is _default and not OS_IS_WINDOWS |             self.config.USE_UVLOOP is _default and not OS_IS_WINDOWS | ||||||
|         # ): |         ): | ||||||
|         #     try_use_uvloop() |             try_use_uvloop() | ||||||
| 
 | 
 | ||||||
|     async def create_server( |     async def create_server( | ||||||
|         self, |         self, | ||||||
| @@ -402,7 +311,7 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         """ |         """ | ||||||
| 
 | 
 | ||||||
|         if sock is None: |         if sock is None: | ||||||
|             host, port = host, port = self.get_address(host, port) |             host, port = host or "127.0.0.1", port or 8000 | ||||||
| 
 | 
 | ||||||
|         if protocol is None: |         if protocol is None: | ||||||
|             protocol = ( |             protocol = ( | ||||||
| @@ -450,29 +359,23 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|             asyncio_server_kwargs=asyncio_server_kwargs, **server_settings |             asyncio_server_kwargs=asyncio_server_kwargs, **server_settings | ||||||
|         ) |         ) | ||||||
| 
 | 
 | ||||||
|     def stop(self, terminate: bool = True, unregister: bool = False): |     def stop(self): | ||||||
|         """ |         """ | ||||||
|         This kills the Sanic |         This kills the Sanic | ||||||
|         """ |         """ | ||||||
|         if terminate and hasattr(self, "multiplexer"): |  | ||||||
|             self.multiplexer.terminate() |  | ||||||
|         if self.state.stage is not ServerStage.STOPPED: |         if self.state.stage is not ServerStage.STOPPED: | ||||||
|             self.shutdown_tasks(timeout=0)  # type: ignore |             self.shutdown_tasks(timeout=0) | ||||||
|             for task in all_tasks(): |             for task in all_tasks(): | ||||||
|                 with suppress(AttributeError): |                 with suppress(AttributeError): | ||||||
|                     if task.get_name() == "RunServer": |                     if task.get_name() == "RunServer": | ||||||
|                         task.cancel() |                         task.cancel() | ||||||
|             get_event_loop().stop() |             get_event_loop().stop() | ||||||
| 
 | 
 | ||||||
|         if unregister: |  | ||||||
|             self.__class__.unregister_app(self)  # type: ignore |  | ||||||
| 
 |  | ||||||
|     def _helper( |     def _helper( | ||||||
|         self, |         self, | ||||||
|         host: Optional[str] = None, |         host: Optional[str] = None, | ||||||
|         port: Optional[int] = None, |         port: Optional[int] = None, | ||||||
|         debug: bool = False, |         debug: bool = False, | ||||||
|         version: HTTPVersion = HTTP.VERSION_1, |  | ||||||
|         ssl: Union[None, SSLContext, dict, str, list, tuple] = None, |         ssl: Union[None, SSLContext, dict, str, list, tuple] = None, | ||||||
|         sock: Optional[socket] = None, |         sock: Optional[socket] = None, | ||||||
|         unix: Optional[str] = None, |         unix: Optional[str] = None, | ||||||
| @@ -482,7 +385,6 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         backlog: int = 100, |         backlog: int = 100, | ||||||
|         register_sys_signals: bool = True, |         register_sys_signals: bool = True, | ||||||
|         run_async: bool = False, |         run_async: bool = False, | ||||||
|         auto_tls: bool = False, |  | ||||||
|     ) -> Dict[str, Any]: |     ) -> Dict[str, Any]: | ||||||
|         """Helper function used by `run` and `create_server`.""" |         """Helper function used by `run` and `create_server`.""" | ||||||
|         if self.config.PROXIES_COUNT and self.config.PROXIES_COUNT < 0: |         if self.config.PROXIES_COUNT and self.config.PROXIES_COUNT < 0: | ||||||
| @@ -492,18 +394,11 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|                 "#proxy-configuration" |                 "#proxy-configuration" | ||||||
|             ) |             ) | ||||||
| 
 | 
 | ||||||
|  |         ssl = process_to_context(ssl) | ||||||
|  | 
 | ||||||
|         if not self.state.is_debug: |         if not self.state.is_debug: | ||||||
|             self.state.mode = Mode.DEBUG if debug else Mode.PRODUCTION |             self.state.mode = Mode.DEBUG if debug else Mode.PRODUCTION | ||||||
| 
 | 
 | ||||||
|         if isinstance(version, int): |  | ||||||
|             version = HTTP(version) |  | ||||||
| 
 |  | ||||||
|         ssl = process_to_context(ssl) |  | ||||||
|         if version is HTTP.VERSION_3 or auto_tls: |  | ||||||
|             if TYPE_CHECKING: |  | ||||||
|                 self = cast(Sanic, self) |  | ||||||
|             ssl = get_ssl_context(self, ssl) |  | ||||||
| 
 |  | ||||||
|         self.state.host = host or "" |         self.state.host = host or "" | ||||||
|         self.state.port = port or 0 |         self.state.port = port or 0 | ||||||
|         self.state.workers = workers |         self.state.workers = workers | ||||||
| @@ -515,7 +410,6 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|             "protocol": protocol, |             "protocol": protocol, | ||||||
|             "host": host, |             "host": host, | ||||||
|             "port": port, |             "port": port, | ||||||
|             "version": version, |  | ||||||
|             "sock": sock, |             "sock": sock, | ||||||
|             "unix": unix, |             "unix": unix, | ||||||
|             "ssl": ssl, |             "ssl": ssl, | ||||||
| @@ -526,13 +420,9 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|             "backlog": backlog, |             "backlog": backlog, | ||||||
|         } |         } | ||||||
| 
 | 
 | ||||||
|         self.motd(server_settings=server_settings) |         self.motd(self.serve_location) | ||||||
| 
 | 
 | ||||||
|         if ( |         if sys.stdout.isatty() and not self.state.is_debug: | ||||||
|             is_atty() |  | ||||||
|             and not self.state.is_debug |  | ||||||
|             and not os.environ.get("SANIC_IGNORE_PRODUCTION_WARNING") |  | ||||||
|         ): |  | ||||||
|             error_logger.warning( |             error_logger.warning( | ||||||
|                 f"{Colors.YELLOW}Sanic is running in PRODUCTION mode. " |                 f"{Colors.YELLOW}Sanic is running in PRODUCTION mode. " | ||||||
|                 "Consider using '--debug' or '--dev' while actively " |                 "Consider using '--debug' or '--dev' while actively " | ||||||
| @@ -556,331 +446,90 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
| 
 | 
 | ||||||
|         return server_settings |         return server_settings | ||||||
| 
 | 
 | ||||||
|     def motd( |     def motd(self, serve_location): | ||||||
|         self, |  | ||||||
|         serve_location: str = "", |  | ||||||
|         server_settings: Optional[Dict[str, Any]] = None, |  | ||||||
|     ): |  | ||||||
|         if ( |  | ||||||
|             os.environ.get("SANIC_WORKER_NAME") |  | ||||||
|             or os.environ.get("SANIC_MOTD_OUTPUT") |  | ||||||
|             or os.environ.get("SANIC_WORKER_PROCESS") |  | ||||||
|             or os.environ.get("SANIC_SERVER_RUNNING") |  | ||||||
|         ): |  | ||||||
|             return |  | ||||||
|         if serve_location: |  | ||||||
|             deprecation( |  | ||||||
|                 "Specifying a serve_location in the MOTD is deprecated and " |  | ||||||
|                 "will be removed.", |  | ||||||
|                 22.9, |  | ||||||
|             ) |  | ||||||
|         else: |  | ||||||
|             serve_location = self.get_server_location(server_settings) |  | ||||||
|         if self.config.MOTD: |         if self.config.MOTD: | ||||||
|             logo = get_logo(coffee=self.state.coffee) |             mode = [f"{self.state.mode},"] | ||||||
|             display, extra = self.get_motd_data(server_settings) |             if self.state.fast: | ||||||
|  |                 mode.append("goin' fast") | ||||||
|  |             if self.state.asgi: | ||||||
|  |                 mode.append("ASGI") | ||||||
|  |             else: | ||||||
|  |                 if self.state.workers == 1: | ||||||
|  |                     mode.append("single worker") | ||||||
|  |                 else: | ||||||
|  |                     mode.append(f"w/ {self.state.workers} workers") | ||||||
|  | 
 | ||||||
|  |             display = { | ||||||
|  |                 "mode": " ".join(mode), | ||||||
|  |                 "server": self.state.server, | ||||||
|  |                 "python": platform.python_version(), | ||||||
|  |                 "platform": platform.platform(), | ||||||
|  |             } | ||||||
|  |             extra = {} | ||||||
|  |             if self.config.AUTO_RELOAD: | ||||||
|  |                 reload_display = "enabled" | ||||||
|  |                 if self.state.reload_dirs: | ||||||
|  |                     reload_display += ", ".join( | ||||||
|  |                         [ | ||||||
|  |                             "", | ||||||
|  |                             *( | ||||||
|  |                                 str(path.absolute()) | ||||||
|  |                                 for path in self.state.reload_dirs | ||||||
|  |                             ), | ||||||
|  |                         ] | ||||||
|  |                     ) | ||||||
|  |                 display["auto-reload"] = reload_display | ||||||
|  | 
 | ||||||
|  |             packages = [] | ||||||
|  |             for package_name in SANIC_PACKAGES: | ||||||
|  |                 module_name = package_name.replace("-", "_") | ||||||
|  |                 try: | ||||||
|  |                     module = import_module(module_name) | ||||||
|  |                     packages.append(f"{package_name}=={module.__version__}") | ||||||
|  |                 except ImportError: | ||||||
|  |                     ... | ||||||
|  | 
 | ||||||
|  |             if packages: | ||||||
|  |                 display["packages"] = ", ".join(packages) | ||||||
|  | 
 | ||||||
|  |             if self.config.MOTD_DISPLAY: | ||||||
|  |                 extra.update(self.config.MOTD_DISPLAY) | ||||||
|  | 
 | ||||||
|  |             logo = ( | ||||||
|  |                 get_logo(coffee=self.state.coffee) | ||||||
|  |                 if self.config.LOGO == "" or self.config.LOGO is True | ||||||
|  |                 else self.config.LOGO | ||||||
|  |             ) | ||||||
| 
 | 
 | ||||||
|             MOTD.output(logo, serve_location, display, extra) |             MOTD.output(logo, serve_location, display, extra) | ||||||
| 
 | 
 | ||||||
|     def get_motd_data( |  | ||||||
|         self, server_settings: Optional[Dict[str, Any]] = None |  | ||||||
|     ) -> Tuple[Dict[str, Any], Dict[str, Any]]: |  | ||||||
|         mode = [f"{self.state.mode},"] |  | ||||||
|         if self.state.fast: |  | ||||||
|             mode.append("goin' fast") |  | ||||||
|         if self.state.asgi: |  | ||||||
|             mode.append("ASGI") |  | ||||||
|         else: |  | ||||||
|             if self.state.workers == 1: |  | ||||||
|                 mode.append("single worker") |  | ||||||
|             else: |  | ||||||
|                 mode.append(f"w/ {self.state.workers} workers") |  | ||||||
| 
 |  | ||||||
|         if server_settings: |  | ||||||
|             server = ", ".join( |  | ||||||
|                 ( |  | ||||||
|                     self.state.server, |  | ||||||
|                     server_settings["version"].display(),  # type: ignore |  | ||||||
|                 ) |  | ||||||
|             ) |  | ||||||
|         else: |  | ||||||
|             server = "ASGI" if self.asgi else "unknown"  # type: ignore |  | ||||||
| 
 |  | ||||||
|         display = { |  | ||||||
|             "mode": " ".join(mode), |  | ||||||
|             "server": server, |  | ||||||
|             "python": platform.python_version(), |  | ||||||
|             "platform": platform.platform(), |  | ||||||
|         } |  | ||||||
|         extra = {} |  | ||||||
|         if self.config.AUTO_RELOAD: |  | ||||||
|             reload_display = "enabled" |  | ||||||
|             if self.state.reload_dirs: |  | ||||||
|                 reload_display += ", ".join( |  | ||||||
|                     [ |  | ||||||
|                         "", |  | ||||||
|                         *( |  | ||||||
|                             str(path.absolute()) |  | ||||||
|                             for path in self.state.reload_dirs |  | ||||||
|                         ), |  | ||||||
|                     ] |  | ||||||
|                 ) |  | ||||||
|             display["auto-reload"] = reload_display |  | ||||||
| 
 |  | ||||||
|         packages = [] |  | ||||||
|         for package_name in SANIC_PACKAGES: |  | ||||||
|             module_name = package_name.replace("-", "_") |  | ||||||
|             try: |  | ||||||
|                 module = import_module(module_name) |  | ||||||
|                 packages.append( |  | ||||||
|                     f"{package_name}=={module.__version__}"  # type: ignore |  | ||||||
|                 ) |  | ||||||
|             except ImportError:  # no cov |  | ||||||
|                 ... |  | ||||||
| 
 |  | ||||||
|         if packages: |  | ||||||
|             display["packages"] = ", ".join(packages) |  | ||||||
| 
 |  | ||||||
|         if self.config.MOTD_DISPLAY: |  | ||||||
|             extra.update(self.config.MOTD_DISPLAY) |  | ||||||
| 
 |  | ||||||
|         return display, extra |  | ||||||
| 
 |  | ||||||
|     @property |     @property | ||||||
|     def serve_location(self) -> str: |     def serve_location(self) -> str: | ||||||
|         try: |  | ||||||
|             server_settings = self.state.server_info[0].settings |  | ||||||
|             return self.get_server_location(server_settings) |  | ||||||
|         except IndexError: |  | ||||||
|             location = "ASGI" if self.asgi else "unknown"  # type: ignore |  | ||||||
|             return f"http://<{location}>" |  | ||||||
| 
 |  | ||||||
|     @staticmethod |  | ||||||
|     def get_server_location( |  | ||||||
|         server_settings: Optional[Dict[str, Any]] = None |  | ||||||
|     ) -> str: |  | ||||||
|         serve_location = "" |         serve_location = "" | ||||||
|         proto = "http" |         proto = "http" | ||||||
|         if not server_settings: |         if self.state.ssl is not None: | ||||||
|             return serve_location |  | ||||||
| 
 |  | ||||||
|         host = server_settings["host"] |  | ||||||
|         port = server_settings["port"] |  | ||||||
| 
 |  | ||||||
|         if server_settings.get("ssl") is not None: |  | ||||||
|             proto = "https" |             proto = "https" | ||||||
|         if server_settings.get("unix"): |         if self.state.unix: | ||||||
|             serve_location = f'{server_settings["unix"]} {proto}://...' |             serve_location = f"{self.state.unix} {proto}://..." | ||||||
|         elif server_settings.get("sock"): |         elif self.state.sock: | ||||||
|             host, port, *_ = server_settings["sock"].getsockname() |             serve_location = f"{self.state.sock.getsockname()} {proto}://..." | ||||||
| 
 |         elif self.state.host and self.state.port: | ||||||
|         if not serve_location and host and port: |  | ||||||
|             # colon(:) is legal for a host only in an ipv6 address |             # colon(:) is legal for a host only in an ipv6 address | ||||||
|             display_host = f"[{host}]" if ":" in host else host |             display_host = ( | ||||||
|             serve_location = f"{proto}://{display_host}:{port}" |                 f"[{self.state.host}]" | ||||||
|  |                 if ":" in self.state.host | ||||||
|  |                 else self.state.host | ||||||
|  |             ) | ||||||
|  |             serve_location = f"{proto}://{display_host}:{self.state.port}" | ||||||
| 
 | 
 | ||||||
|         return serve_location |         return serve_location | ||||||
| 
 | 
 | ||||||
|     @staticmethod |  | ||||||
|     def get_address( |  | ||||||
|         host: Optional[str], |  | ||||||
|         port: Optional[int], |  | ||||||
|         version: HTTPVersion = HTTP.VERSION_1, |  | ||||||
|         auto_tls: bool = False, |  | ||||||
|     ) -> Tuple[str, int]: |  | ||||||
|         host = host or "127.0.0.1" |  | ||||||
|         port = port or (8443 if (version == 3 or auto_tls) else 8000) |  | ||||||
|         return host, port |  | ||||||
| 
 |  | ||||||
|     @classmethod |     @classmethod | ||||||
|     def should_auto_reload(cls) -> bool: |     def should_auto_reload(cls) -> bool: | ||||||
|         return any(app.state.auto_reload for app in cls._app_registry.values()) |         return any(app.state.auto_reload for app in cls._app_registry.values()) | ||||||
| 
 | 
 | ||||||
|     @classmethod |     @classmethod | ||||||
|     def _get_context(cls) -> BaseContext: |     def serve(cls, primary: Optional[Sanic] = None) -> None: | ||||||
|         method = ( |  | ||||||
|             "spawn" |  | ||||||
|             if "linux" not in sys.platform or cls.should_auto_reload() |  | ||||||
|             else "fork" |  | ||||||
|         ) |  | ||||||
|         return get_context(method) |  | ||||||
| 
 |  | ||||||
|     @classmethod |  | ||||||
|     def serve( |  | ||||||
|         cls, |  | ||||||
|         primary: Optional[Sanic] = None, |  | ||||||
|         *, |  | ||||||
|         app_loader: Optional[AppLoader] = None, |  | ||||||
|         factory: Optional[Callable[[], Sanic]] = None, |  | ||||||
|     ) -> None: |  | ||||||
|         os.environ["SANIC_MOTD_OUTPUT"] = "true" |  | ||||||
|         apps = list(cls._app_registry.values()) |  | ||||||
|         if factory: |  | ||||||
|             primary = factory() |  | ||||||
|         else: |  | ||||||
|             if not primary: |  | ||||||
|                 if app_loader: |  | ||||||
|                     primary = app_loader.load() |  | ||||||
|                 if not primary: |  | ||||||
|                     try: |  | ||||||
|                         primary = apps[0] |  | ||||||
|                     except IndexError: |  | ||||||
|                         raise RuntimeError( |  | ||||||
|                             "Did not find any applications." |  | ||||||
|                         ) from None |  | ||||||
| 
 |  | ||||||
|             # This exists primarily for unit testing |  | ||||||
|             if not primary.state.server_info:  # no cov |  | ||||||
|                 for app in apps: |  | ||||||
|                     app.state.server_info.clear() |  | ||||||
|                 return |  | ||||||
| 
 |  | ||||||
|         try: |  | ||||||
|             primary_server_info = primary.state.server_info[0] |  | ||||||
|         except IndexError: |  | ||||||
|             raise RuntimeError( |  | ||||||
|                 f"No server information found for {primary.name}. Perhaps you " |  | ||||||
|                 "need to run app.prepare(...)?\n" |  | ||||||
|                 "See ____ for more information." |  | ||||||
|             ) from None |  | ||||||
| 
 |  | ||||||
|         socks = [] |  | ||||||
|         sync_manager = Manager() |  | ||||||
|         try: |  | ||||||
|             main_start = primary_server_info.settings.pop("main_start", None) |  | ||||||
|             main_stop = primary_server_info.settings.pop("main_stop", None) |  | ||||||
|             app = primary_server_info.settings.pop("app") |  | ||||||
|             app.setup_loop() |  | ||||||
|             loop = new_event_loop() |  | ||||||
|             trigger_events(main_start, loop, primary) |  | ||||||
| 
 |  | ||||||
|             socks = [ |  | ||||||
|                 sock |  | ||||||
|                 for sock in [ |  | ||||||
|                     configure_socket(server_info.settings) |  | ||||||
|                     for app in apps |  | ||||||
|                     for server_info in app.state.server_info |  | ||||||
|                 ] |  | ||||||
|                 if sock |  | ||||||
|             ] |  | ||||||
|             primary_server_info.settings["run_multiple"] = True |  | ||||||
|             monitor_sub, monitor_pub = Pipe(True) |  | ||||||
|             worker_state: Dict[str, Any] = sync_manager.dict() |  | ||||||
|             kwargs: Dict[str, Any] = { |  | ||||||
|                 **primary_server_info.settings, |  | ||||||
|                 "monitor_publisher": monitor_pub, |  | ||||||
|                 "worker_state": worker_state, |  | ||||||
|             } |  | ||||||
| 
 |  | ||||||
|             if not app_loader: |  | ||||||
|                 if factory: |  | ||||||
|                     app_loader = AppLoader(factory=factory) |  | ||||||
|                 else: |  | ||||||
|                     app_loader = AppLoader( |  | ||||||
|                         factory=partial(cls.get_app, app.name)  # type: ignore |  | ||||||
|                     ) |  | ||||||
|             kwargs["app_name"] = app.name |  | ||||||
|             kwargs["app_loader"] = app_loader |  | ||||||
|             kwargs["server_info"] = {} |  | ||||||
|             kwargs["passthru"] = { |  | ||||||
|                 "auto_reload": app.auto_reload, |  | ||||||
|                 "state": { |  | ||||||
|                     "verbosity": app.state.verbosity, |  | ||||||
|                     "mode": app.state.mode, |  | ||||||
|                 }, |  | ||||||
|                 "config": { |  | ||||||
|                     "ACCESS_LOG": app.config.ACCESS_LOG, |  | ||||||
|                     "NOISY_EXCEPTIONS": app.config.NOISY_EXCEPTIONS, |  | ||||||
|                 }, |  | ||||||
|                 "shared_ctx": app.shared_ctx.__dict__, |  | ||||||
|             } |  | ||||||
|             for app in apps: |  | ||||||
|                 kwargs["server_info"][app.name] = [] |  | ||||||
|                 for server_info in app.state.server_info: |  | ||||||
|                     server_info.settings = { |  | ||||||
|                         k: v |  | ||||||
|                         for k, v in server_info.settings.items() |  | ||||||
|                         if k not in ("main_start", "main_stop", "app", "ssl") |  | ||||||
|                     } |  | ||||||
|                     kwargs["server_info"][app.name].append(server_info) |  | ||||||
| 
 |  | ||||||
|             ssl = kwargs.get("ssl") |  | ||||||
| 
 |  | ||||||
|             if isinstance(ssl, SanicSSLContext): |  | ||||||
|                 kwargs["ssl"] = kwargs["ssl"].sanic |  | ||||||
| 
 |  | ||||||
|             manager = WorkerManager( |  | ||||||
|                 primary.state.workers, |  | ||||||
|                 worker_serve, |  | ||||||
|                 kwargs, |  | ||||||
|                 cls._get_context(), |  | ||||||
|                 (monitor_pub, monitor_sub), |  | ||||||
|                 worker_state, |  | ||||||
|             ) |  | ||||||
|             if cls.should_auto_reload(): |  | ||||||
|                 reload_dirs: Set[Path] = primary.state.reload_dirs.union( |  | ||||||
|                     *(app.state.reload_dirs for app in apps) |  | ||||||
|                 ) |  | ||||||
|                 reloader = Reloader(monitor_pub, 1.0, reload_dirs, app_loader) |  | ||||||
|                 manager.manage("Reloader", reloader, {}, transient=False) |  | ||||||
| 
 |  | ||||||
|             inspector = None |  | ||||||
|             if primary.config.INSPECTOR: |  | ||||||
|                 display, extra = primary.get_motd_data() |  | ||||||
|                 packages = [ |  | ||||||
|                     pkg.strip() for pkg in display["packages"].split(",") |  | ||||||
|                 ] |  | ||||||
|                 module = import_module("sanic") |  | ||||||
|                 sanic_version = f"sanic=={module.__version__}"  # type: ignore |  | ||||||
|                 app_info = { |  | ||||||
|                     **display, |  | ||||||
|                     "packages": [sanic_version, *packages], |  | ||||||
|                     "extra": extra, |  | ||||||
|                 } |  | ||||||
|                 inspector = Inspector( |  | ||||||
|                     monitor_pub, |  | ||||||
|                     app_info, |  | ||||||
|                     worker_state, |  | ||||||
|                     primary.config.INSPECTOR_HOST, |  | ||||||
|                     primary.config.INSPECTOR_PORT, |  | ||||||
|                 ) |  | ||||||
|                 manager.manage("Inspector", inspector, {}, transient=False) |  | ||||||
| 
 |  | ||||||
|             primary._inspector = inspector |  | ||||||
|             primary._manager = manager |  | ||||||
| 
 |  | ||||||
|             ready = primary.listeners["main_process_ready"] |  | ||||||
|             trigger_events(ready, loop, primary) |  | ||||||
| 
 |  | ||||||
|             manager.run() |  | ||||||
|         except BaseException: |  | ||||||
|             kwargs = primary_server_info.settings |  | ||||||
|             error_logger.exception( |  | ||||||
|                 "Experienced exception while trying to serve" |  | ||||||
|             ) |  | ||||||
|             raise |  | ||||||
|         finally: |  | ||||||
|             logger.info("Server Stopped") |  | ||||||
|             for app in apps: |  | ||||||
|                 app.state.server_info.clear() |  | ||||||
|                 app.router.reset() |  | ||||||
|                 app.signal_router.reset() |  | ||||||
| 
 |  | ||||||
|             sync_manager.shutdown() |  | ||||||
|             for sock in socks: |  | ||||||
|                 sock.close() |  | ||||||
|             socks = [] |  | ||||||
|             trigger_events(main_stop, loop, primary) |  | ||||||
|             loop.close() |  | ||||||
|             cls._cleanup_env_vars() |  | ||||||
|             cls._cleanup_apps() |  | ||||||
|             unix = kwargs.get("unix") |  | ||||||
|             if unix: |  | ||||||
|                 remove_unix_socket(unix) |  | ||||||
| 
 |  | ||||||
|     @classmethod |  | ||||||
|     def serve_single(cls, primary: Optional[Sanic] = None) -> None: |  | ||||||
|         os.environ["SANIC_MOTD_OUTPUT"] = "true" |  | ||||||
|         apps = list(cls._app_registry.values()) |         apps = list(cls._app_registry.values()) | ||||||
| 
 | 
 | ||||||
|         if not primary: |         if not primary: | ||||||
| @@ -889,83 +538,15 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|             except IndexError: |             except IndexError: | ||||||
|                 raise RuntimeError("Did not find any applications.") |                 raise RuntimeError("Did not find any applications.") | ||||||
| 
 | 
 | ||||||
|         # This exists primarily for unit testing |  | ||||||
|         if not primary.state.server_info:  # no cov |  | ||||||
|             for app in apps: |  | ||||||
|                 app.state.server_info.clear() |  | ||||||
|             return |  | ||||||
| 
 |  | ||||||
|         primary_server_info = primary.state.server_info[0] |  | ||||||
|         primary.before_server_start(partial(primary._start_servers, apps=apps)) |  | ||||||
|         kwargs = { |  | ||||||
|             k: v |  | ||||||
|             for k, v in primary_server_info.settings.items() |  | ||||||
|             if k |  | ||||||
|             not in ( |  | ||||||
|                 "main_start", |  | ||||||
|                 "main_stop", |  | ||||||
|                 "app", |  | ||||||
|             ) |  | ||||||
|         } |  | ||||||
|         kwargs["app_name"] = primary.name |  | ||||||
|         kwargs["app_loader"] = None |  | ||||||
|         sock = configure_socket(kwargs) |  | ||||||
| 
 |  | ||||||
|         kwargs["server_info"] = {} |  | ||||||
|         kwargs["server_info"][primary.name] = [] |  | ||||||
|         for server_info in primary.state.server_info: |  | ||||||
|             server_info.settings = { |  | ||||||
|                 k: v |  | ||||||
|                 for k, v in server_info.settings.items() |  | ||||||
|                 if k not in ("main_start", "main_stop", "app") |  | ||||||
|             } |  | ||||||
|             kwargs["server_info"][primary.name].append(server_info) |  | ||||||
| 
 |  | ||||||
|         try: |  | ||||||
|             worker_serve(monitor_publisher=None, **kwargs) |  | ||||||
|         except BaseException: |  | ||||||
|             error_logger.exception( |  | ||||||
|                 "Experienced exception while trying to serve" |  | ||||||
|             ) |  | ||||||
|             raise |  | ||||||
|         finally: |  | ||||||
|             logger.info("Server Stopped") |  | ||||||
|             for app in apps: |  | ||||||
|                 app.state.server_info.clear() |  | ||||||
|                 app.router.reset() |  | ||||||
|                 app.signal_router.reset() |  | ||||||
| 
 |  | ||||||
|             if sock: |  | ||||||
|                 sock.close() |  | ||||||
| 
 |  | ||||||
|             cls._cleanup_env_vars() |  | ||||||
|             cls._cleanup_apps() |  | ||||||
| 
 |  | ||||||
|     @classmethod |  | ||||||
|     def serve_legacy(cls, primary: Optional[Sanic] = None) -> None: |  | ||||||
|         apps = list(cls._app_registry.values()) |  | ||||||
| 
 |  | ||||||
|         if not primary: |  | ||||||
|             try: |  | ||||||
|                 primary = apps[0] |  | ||||||
|             except IndexError: |  | ||||||
|                 raise RuntimeError("Did not find any applications.") |  | ||||||
| 
 |  | ||||||
|         reloader_start = primary.listeners.get("reload_process_start") |  | ||||||
|         reloader_stop = primary.listeners.get("reload_process_stop") |  | ||||||
|         # We want to run auto_reload if ANY of the applications have it enabled |         # We want to run auto_reload if ANY of the applications have it enabled | ||||||
|         if ( |         if ( | ||||||
|             cls.should_auto_reload() |             cls.should_auto_reload() | ||||||
|             and os.environ.get("SANIC_SERVER_RUNNING") != "true" |             and os.environ.get("SANIC_SERVER_RUNNING") != "true" | ||||||
|         ):  # no cov |         ): | ||||||
|             loop = new_event_loop() |  | ||||||
|             trigger_events(reloader_start, loop, primary) |  | ||||||
|             reload_dirs: Set[Path] = primary.state.reload_dirs.union( |             reload_dirs: Set[Path] = primary.state.reload_dirs.union( | ||||||
|                 *(app.state.reload_dirs for app in apps) |                 *(app.state.reload_dirs for app in apps) | ||||||
|             ) |             ) | ||||||
|             watchdog(1.0, reload_dirs) |             return reloader_helpers.watchdog(1.0, reload_dirs) | ||||||
|             trigger_events(reloader_stop, loop, primary) |  | ||||||
|             return |  | ||||||
| 
 | 
 | ||||||
|         # This exists primarily for unit testing |         # This exists primarily for unit testing | ||||||
|         if not primary.state.server_info:  # no cov |         if not primary.state.server_info:  # no cov | ||||||
| @@ -976,17 +557,11 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         primary_server_info = primary.state.server_info[0] |         primary_server_info = primary.state.server_info[0] | ||||||
|         primary.before_server_start(partial(primary._start_servers, apps=apps)) |         primary.before_server_start(partial(primary._start_servers, apps=apps)) | ||||||
| 
 | 
 | ||||||
|         deprecation( |  | ||||||
|             f"{Colors.YELLOW}Running {Colors.SANIC}Sanic {Colors.YELLOW}w/ " |  | ||||||
|             f"LEGACY manager.{Colors.END} Support for will be dropped in " |  | ||||||
|             "version 23.3.", |  | ||||||
|             23.3, |  | ||||||
|         ) |  | ||||||
|         try: |         try: | ||||||
|             primary_server_info.stage = ServerStage.SERVING |             primary_server_info.stage = ServerStage.SERVING | ||||||
| 
 | 
 | ||||||
|             if primary.state.workers > 1 and os.name != "posix":  # no cov |             if primary.state.workers > 1 and os.name != "posix":  # no cov | ||||||
|                 logger.warning( |                 logger.warn( | ||||||
|                     f"Multiprocessing is currently not supported on {os.name}," |                     f"Multiprocessing is currently not supported on {os.name}," | ||||||
|                     " using workers=1 instead" |                     " using workers=1 instead" | ||||||
|                 ) |                 ) | ||||||
| @@ -1007,9 +582,10 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         finally: |         finally: | ||||||
|             primary_server_info.stage = ServerStage.STOPPED |             primary_server_info.stage = ServerStage.STOPPED | ||||||
|         logger.info("Server Stopped") |         logger.info("Server Stopped") | ||||||
| 
 |         for app in apps: | ||||||
|         cls._cleanup_env_vars() |             app.state.server_info.clear() | ||||||
|         cls._cleanup_apps() |             app.router.reset() | ||||||
|  |             app.signal_router.reset() | ||||||
| 
 | 
 | ||||||
|     async def _start_servers( |     async def _start_servers( | ||||||
|         self, |         self, | ||||||
| @@ -1031,7 +607,7 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|                     f"{app.state.workers} worker(s), which will be ignored " |                     f"{app.state.workers} worker(s), which will be ignored " | ||||||
|                     "in favor of the primary application." |                     "in favor of the primary application." | ||||||
|                 ) |                 ) | ||||||
|                 if is_atty(): |                 if sys.stdout.isatty(): | ||||||
|                     message = "".join( |                     message = "".join( | ||||||
|                         [ |                         [ | ||||||
|                             Colors.YELLOW, |                             Colors.YELLOW, | ||||||
| @@ -1047,7 +623,7 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|                         *server_info.settings.pop("main_start", []), |                         *server_info.settings.pop("main_start", []), | ||||||
|                         *server_info.settings.pop("main_stop", []), |                         *server_info.settings.pop("main_stop", []), | ||||||
|                     ] |                     ] | ||||||
|                     if handlers:  # no cov |                     if handlers: | ||||||
|                         error_logger.warning( |                         error_logger.warning( | ||||||
|                             f"Sanic found {len(handlers)} listener(s) on " |                             f"Sanic found {len(handlers)} listener(s) on " | ||||||
|                             "secondary applications attached to the main " |                             "secondary applications attached to the main " | ||||||
| @@ -1060,22 +636,19 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|                     if not server_info.settings["loop"]: |                     if not server_info.settings["loop"]: | ||||||
|                         server_info.settings["loop"] = get_running_loop() |                         server_info.settings["loop"] = get_running_loop() | ||||||
| 
 | 
 | ||||||
|                     serve_args: Dict[str, Any] = { |  | ||||||
|                         **server_info.settings, |  | ||||||
|                         "run_async": True, |  | ||||||
|                         "reuse_port": bool(primary.state.workers - 1), |  | ||||||
|                     } |  | ||||||
|                     if "app" not in serve_args: |  | ||||||
|                         serve_args["app"] = app |  | ||||||
|                     try: |                     try: | ||||||
|                         server_info.server = await serve(**serve_args) |                         server_info.server = await serve( | ||||||
|  |                             **server_info.settings, | ||||||
|  |                             run_async=True, | ||||||
|  |                             reuse_port=bool(primary.state.workers - 1), | ||||||
|  |                         ) | ||||||
|                     except OSError as e:  # no cov |                     except OSError as e:  # no cov | ||||||
|                         first_message = ( |                         first_message = ( | ||||||
|                             "An OSError was detected on startup. " |                             "An OSError was detected on startup. " | ||||||
|                             "The encountered error was: " |                             "The encountered error was: " | ||||||
|                         ) |                         ) | ||||||
|                         second_message = str(e) |                         second_message = str(e) | ||||||
|                         if is_atty(): |                         if sys.stdout.isatty(): | ||||||
|                             message_parts = [ |                             message_parts = [ | ||||||
|                                 Colors.YELLOW, |                                 Colors.YELLOW, | ||||||
|                                 first_message, |                                 first_message, | ||||||
| @@ -1094,9 +667,9 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
| 
 | 
 | ||||||
|     async def _run_server( |     async def _run_server( | ||||||
|         self, |         self, | ||||||
|         app: StartupMixin, |         app: RunnerMixin, | ||||||
|         server_info: ApplicationServerInfo, |         server_info: ApplicationServerInfo, | ||||||
|     ) -> None:  # no cov |     ) -> None: | ||||||
| 
 | 
 | ||||||
|         try: |         try: | ||||||
|             # We should never get to this point without a server |             # We should never get to this point without a server | ||||||
| @@ -1120,26 +693,3 @@ class StartupMixin(metaclass=SanicMeta): | |||||||
|         finally: |         finally: | ||||||
|             server_info.stage = ServerStage.STOPPED |             server_info.stage = ServerStage.STOPPED | ||||||
|             server_info.server = None |             server_info.server = None | ||||||
| 
 |  | ||||||
|     @staticmethod |  | ||||||
|     def _cleanup_env_vars(): |  | ||||||
|         variables = ( |  | ||||||
|             "SANIC_RELOADER_PROCESS", |  | ||||||
|             "SANIC_IGNORE_PRODUCTION_WARNING", |  | ||||||
|             "SANIC_WORKER_NAME", |  | ||||||
|             "SANIC_MOTD_OUTPUT", |  | ||||||
|             "SANIC_WORKER_PROCESS", |  | ||||||
|             "SANIC_SERVER_RUNNING", |  | ||||||
|         ) |  | ||||||
|         for var in variables: |  | ||||||
|             try: |  | ||||||
|                 del os.environ[var] |  | ||||||
|             except KeyError: |  | ||||||
|                 ... |  | ||||||
| 
 |  | ||||||
|     @classmethod |  | ||||||
|     def _cleanup_apps(cls): |  | ||||||
|         for app in cls._app_registry.values(): |  | ||||||
|             app.state.server_info.clear() |  | ||||||
|             app.router.reset() |  | ||||||
|             app.signal_router.reset() |  | ||||||
| @@ -3,8 +3,7 @@ import sys | |||||||
|  |  | ||||||
| from typing import Any, Awaitable, Callable, MutableMapping, Optional, Union | from typing import Any, Awaitable, Callable, MutableMapping, Optional, Union | ||||||
|  |  | ||||||
| from sanic.exceptions import BadRequest | from sanic.exceptions import InvalidUsage | ||||||
| from sanic.models.protocol_types import TransportProtocol |  | ||||||
| from sanic.server.websockets.connection import WebSocketConnection | from sanic.server.websockets.connection import WebSocketConnection | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -57,7 +56,7 @@ class MockProtocol:  # no cov | |||||||
|         await self._not_paused.wait() |         await self._not_paused.wait() | ||||||
|  |  | ||||||
|  |  | ||||||
| class MockTransport(TransportProtocol):  # no cov | class MockTransport:  # no cov | ||||||
|     _protocol: Optional[MockProtocol] |     _protocol: Optional[MockProtocol] | ||||||
|  |  | ||||||
|     def __init__( |     def __init__( | ||||||
| @@ -69,25 +68,23 @@ class MockTransport(TransportProtocol):  # no cov | |||||||
|         self._protocol = None |         self._protocol = None | ||||||
|         self.loop = None |         self.loop = None | ||||||
|  |  | ||||||
|     def get_protocol(self) -> MockProtocol:  # type: ignore |     def get_protocol(self) -> MockProtocol: | ||||||
|         if not self._protocol: |         if not self._protocol: | ||||||
|             self._protocol = MockProtocol(self, self.loop) |             self._protocol = MockProtocol(self, self.loop) | ||||||
|         return self._protocol |         return self._protocol | ||||||
|  |  | ||||||
|     def get_extra_info( |     def get_extra_info(self, info: str) -> Union[str, bool, None]: | ||||||
|         self, info: str, default=None |  | ||||||
|     ) -> Optional[Union[str, bool]]: |  | ||||||
|         if info == "peername": |         if info == "peername": | ||||||
|             return self.scope.get("client") |             return self.scope.get("client") | ||||||
|         elif info == "sslcontext": |         elif info == "sslcontext": | ||||||
|             return self.scope.get("scheme") in ["https", "wss"] |             return self.scope.get("scheme") in ["https", "wss"] | ||||||
|         return default |         return None | ||||||
|  |  | ||||||
|     def get_websocket_connection(self) -> WebSocketConnection: |     def get_websocket_connection(self) -> WebSocketConnection: | ||||||
|         try: |         try: | ||||||
|             return self._websocket_connection |             return self._websocket_connection | ||||||
|         except AttributeError: |         except AttributeError: | ||||||
|             raise BadRequest("Improper websocket connection.") |             raise InvalidUsage("Improper websocket connection.") | ||||||
|  |  | ||||||
|     def create_websocket_connection( |     def create_websocket_connection( | ||||||
|         self, send: ASGISend, receive: ASGIReceive |         self, send: ASGISend, receive: ASGIReceive | ||||||
|   | |||||||
| @@ -1,13 +1,11 @@ | |||||||
| from asyncio.events import AbstractEventLoop | from asyncio.events import AbstractEventLoop | ||||||
| from typing import Any, Callable, Coroutine, Optional, TypeVar, Union | from typing import Any, Callable, Coroutine, Optional, TypeVar, Union | ||||||
|  |  | ||||||
| import sanic |  | ||||||
|  |  | ||||||
| from sanic.request import Request | from sanic.request import Request | ||||||
| from sanic.response import BaseHTTPResponse, HTTPResponse | from sanic.response import BaseHTTPResponse, HTTPResponse | ||||||
|  |  | ||||||
|  |  | ||||||
| Sanic = TypeVar("Sanic", bound="sanic.Sanic") | Sanic = TypeVar("Sanic") | ||||||
|  |  | ||||||
| MiddlewareResponse = Union[ | MiddlewareResponse = Union[ | ||||||
|     Optional[HTTPResponse], Coroutine[Any, Any, Optional[HTTPResponse]] |     Optional[HTTPResponse], Coroutine[Any, Any, Optional[HTTPResponse]] | ||||||
| @@ -20,9 +18,8 @@ ErrorMiddlewareType = Callable[ | |||||||
|     [Request, BaseException], Optional[Coroutine[Any, Any, None]] |     [Request, BaseException], Optional[Coroutine[Any, Any, None]] | ||||||
| ] | ] | ||||||
| MiddlewareType = Union[RequestMiddlewareType, ResponseMiddlewareType] | MiddlewareType = Union[RequestMiddlewareType, ResponseMiddlewareType] | ||||||
| ListenerType = Union[ | ListenerType = Callable[ | ||||||
|     Callable[[Sanic], Optional[Coroutine[Any, Any, None]]], |     [Sanic, AbstractEventLoop], Optional[Coroutine[Any, Any, None]] | ||||||
|     Callable[[Sanic, AbstractEventLoop], Optional[Coroutine[Any, Any, None]]], |  | ||||||
| ] | ] | ||||||
| RouteHandler = Callable[..., Coroutine[Any, Any, Optional[HTTPResponse]]] | RouteHandler = Callable[..., Coroutine[Any, Any, Optional[HTTPResponse]]] | ||||||
| SignalHandler = Callable[..., Coroutine[Any, Any, None]] | SignalHandler = Callable[..., Coroutine[Any, Any, None]] | ||||||
|   | |||||||
| @@ -1,22 +1,28 @@ | |||||||
| from __future__ import annotations |  | ||||||
|  |  | ||||||
| import sys | import sys | ||||||
|  |  | ||||||
| from asyncio import BaseTransport | from typing import Any, AnyStr, TypeVar, Union | ||||||
| from typing import TYPE_CHECKING, Any, AnyStr |  | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: |  | ||||||
|     from sanic.models.asgi import ASGIScope |  | ||||||
|  |  | ||||||
|  |  | ||||||
| if sys.version_info < (3, 8): | if sys.version_info < (3, 8): | ||||||
|  |     from asyncio import BaseTransport | ||||||
|  |  | ||||||
|  |     # from sanic.models.asgi import MockTransport | ||||||
|  |     MockTransport = TypeVar("MockTransport") | ||||||
|  |  | ||||||
|  |     TransportProtocol = Union[MockTransport, BaseTransport] | ||||||
|     Range = Any |     Range = Any | ||||||
|     HTMLProtocol = Any |     HTMLProtocol = Any | ||||||
| else: | else: | ||||||
|     # Protocol is a 3.8+ feature |     # Protocol is a 3.8+ feature | ||||||
|     from typing import Protocol |     from typing import Protocol | ||||||
|  |  | ||||||
|  |     class TransportProtocol(Protocol): | ||||||
|  |         def get_protocol(self): | ||||||
|  |             ... | ||||||
|  |  | ||||||
|  |         def get_extra_info(self, info: str) -> Union[str, bool, None]: | ||||||
|  |             ... | ||||||
|  |  | ||||||
|     class HTMLProtocol(Protocol): |     class HTMLProtocol(Protocol): | ||||||
|         def __html__(self) -> AnyStr: |         def __html__(self) -> AnyStr: | ||||||
|             ... |             ... | ||||||
| @@ -36,8 +42,3 @@ else: | |||||||
|  |  | ||||||
|         def total(self) -> int: |         def total(self) -> int: | ||||||
|             ... |             ... | ||||||
|  |  | ||||||
|  |  | ||||||
| class TransportProtocol(BaseTransport): |  | ||||||
|     scope: ASGIScope |  | ||||||
|     __slots__ = () |  | ||||||
|   | |||||||
| @@ -1,8 +1,8 @@ | |||||||
| from __future__ import annotations | from __future__ import annotations | ||||||
|  |  | ||||||
| from ssl import SSLContext, SSLObject | from ssl import SSLObject | ||||||
| from types import SimpleNamespace | from types import SimpleNamespace | ||||||
| from typing import Any, Dict, List, Optional | from typing import Any, Dict, Optional | ||||||
|  |  | ||||||
| from sanic.models.protocol_types import TransportProtocol | from sanic.models.protocol_types import TransportProtocol | ||||||
|  |  | ||||||
| @@ -21,7 +21,6 @@ class ConnInfo: | |||||||
|         "client", |         "client", | ||||||
|         "client_ip", |         "client_ip", | ||||||
|         "ctx", |         "ctx", | ||||||
|         "lost", |  | ||||||
|         "peername", |         "peername", | ||||||
|         "server_port", |         "server_port", | ||||||
|         "server", |         "server", | ||||||
| @@ -29,12 +28,10 @@ class ConnInfo: | |||||||
|         "sockname", |         "sockname", | ||||||
|         "ssl", |         "ssl", | ||||||
|         "cert", |         "cert", | ||||||
|         "network_paths", |  | ||||||
|     ) |     ) | ||||||
|  |  | ||||||
|     def __init__(self, transport: TransportProtocol, unix=None): |     def __init__(self, transport: TransportProtocol, unix=None): | ||||||
|         self.ctx = SimpleNamespace() |         self.ctx = SimpleNamespace() | ||||||
|         self.lost = False |  | ||||||
|         self.peername = None |         self.peername = None | ||||||
|         self.server = self.client = "" |         self.server = self.client = "" | ||||||
|         self.server_port = self.client_port = 0 |         self.server_port = self.client_port = 0 | ||||||
| @@ -43,22 +40,17 @@ class ConnInfo: | |||||||
|         self.ssl = False |         self.ssl = False | ||||||
|         self.server_name = "" |         self.server_name = "" | ||||||
|         self.cert: Dict[str, Any] = {} |         self.cert: Dict[str, Any] = {} | ||||||
|         self.network_paths: List[Any] = [] |  | ||||||
|         sslobj: Optional[SSLObject] = transport.get_extra_info( |         sslobj: Optional[SSLObject] = transport.get_extra_info( | ||||||
|             "ssl_object" |             "ssl_object" | ||||||
|         )  # type: ignore |         )  # type: ignore | ||||||
|         sslctx: Optional[SSLContext] = transport.get_extra_info( |  | ||||||
|             "ssl_context" |  | ||||||
|         )  # type: ignore |  | ||||||
|         if sslobj: |         if sslobj: | ||||||
|             self.ssl = True |             self.ssl = True | ||||||
|             self.server_name = getattr(sslobj, "sanic_server_name", None) or "" |             self.server_name = getattr(sslobj, "sanic_server_name", None) or "" | ||||||
|             self.cert = dict(getattr(sslobj.context, "sanic", {})) |             self.cert = dict(getattr(sslobj.context, "sanic", {})) | ||||||
|         if sslctx and not self.cert: |  | ||||||
|             self.cert = dict(getattr(sslctx, "sanic", {})) |  | ||||||
|         if isinstance(addr, str):  # UNIX socket |         if isinstance(addr, str):  # UNIX socket | ||||||
|             self.server = unix or addr |             self.server = unix or addr | ||||||
|             return |             return | ||||||
|  |  | ||||||
|         # IPv4 (ip, port) or IPv6 (ip, port, flowinfo, scopeid) |         # IPv4 (ip, port) or IPv6 (ip, port, flowinfo, scopeid) | ||||||
|         if isinstance(addr, tuple): |         if isinstance(addr, tuple): | ||||||
|             self.server = addr[0] if len(addr) == 2 else f"[{addr[0]}]" |             self.server = addr[0] if len(addr) == 2 else f"[{addr[0]}]" | ||||||
| @@ -67,9 +59,6 @@ class ConnInfo: | |||||||
|             if addr[1] != (443 if self.ssl else 80): |             if addr[1] != (443 if self.ssl else 80): | ||||||
|                 self.server = f"{self.server}:{addr[1]}" |                 self.server = f"{self.server}:{addr[1]}" | ||||||
|         self.peername = addr = transport.get_extra_info("peername") |         self.peername = addr = transport.get_extra_info("peername") | ||||||
|         self.network_paths = transport.get_extra_info(  # type: ignore |  | ||||||
|             "network_paths" |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|         if isinstance(addr, tuple): |         if isinstance(addr, tuple): | ||||||
|             self.client = addr[0] if len(addr) == 2 else f"[{addr[0]}]" |             self.client = addr[0] if len(addr) == 2 else f"[{addr[0]}]" | ||||||
|   | |||||||
| @@ -9,6 +9,7 @@ from time import sleep | |||||||
| 
 | 
 | ||||||
| def _iter_module_files(): | def _iter_module_files(): | ||||||
|     """This iterates over all relevant Python files. |     """This iterates over all relevant Python files. | ||||||
|  | 
 | ||||||
|     It goes through all |     It goes through all | ||||||
|     loaded files from modules, all files in folders of already loaded modules |     loaded files from modules, all files in folders of already loaded modules | ||||||
|     as well as all files reachable through a package. |     as well as all files reachable through a package. | ||||||
| @@ -51,7 +52,7 @@ def restart_with_reloader(changed=None): | |||||||
|     this one. |     this one. | ||||||
|     """ |     """ | ||||||
|     reloaded = ",".join(changed) if changed else "" |     reloaded = ",".join(changed) if changed else "" | ||||||
|     return subprocess.Popen(  # nosec B603 |     return subprocess.Popen( | ||||||
|         _get_args_for_reloading(), |         _get_args_for_reloading(), | ||||||
|         env={ |         env={ | ||||||
|             **os.environ, |             **os.environ, | ||||||
| @@ -78,6 +79,7 @@ def _check_file(filename, mtimes): | |||||||
| 
 | 
 | ||||||
| def watchdog(sleep_interval, reload_dirs): | def watchdog(sleep_interval, reload_dirs): | ||||||
|     """Watch project files, restart worker process if a change happened. |     """Watch project files, restart worker process if a change happened. | ||||||
|  | 
 | ||||||
|     :param sleep_interval: interval in second. |     :param sleep_interval: interval in second. | ||||||
|     :return: Nothing |     :return: Nothing | ||||||
|     """ |     """ | ||||||
							
								
								
									
										394
									
								
								sanic/request.py
									
									
									
									
									
								
							
							
						
						
									
										394
									
								
								sanic/request.py
									
									
									
									
									
								
							| @@ -1,8 +1,5 @@ | |||||||
| from __future__ import annotations | from __future__ import annotations | ||||||
|  |  | ||||||
| from contextvars import ContextVar |  | ||||||
| from functools import partial |  | ||||||
| from inspect import isawaitable |  | ||||||
| from typing import ( | from typing import ( | ||||||
|     TYPE_CHECKING, |     TYPE_CHECKING, | ||||||
|     Any, |     Any, | ||||||
| @@ -15,16 +12,12 @@ from typing import ( | |||||||
|     Union, |     Union, | ||||||
| ) | ) | ||||||
|  |  | ||||||
| from sanic_routing.route import Route | from sanic_routing.route import Route  # type: ignore | ||||||
|  |  | ||||||
| from sanic.http.constants import HTTP  # type: ignore |  | ||||||
| from sanic.http.stream import Stream |  | ||||||
| from sanic.models.asgi import ASGIScope |  | ||||||
| from sanic.models.http_types import Credentials | from sanic.models.http_types import Credentials | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic.handlers import RequestManager |  | ||||||
|     from sanic.server import ConnInfo |     from sanic.server import ConnInfo | ||||||
|     from sanic.app import Sanic |     from sanic.app import Sanic | ||||||
|  |  | ||||||
| @@ -36,17 +29,11 @@ from http.cookies import SimpleCookie | |||||||
| from types import SimpleNamespace | from types import SimpleNamespace | ||||||
| from urllib.parse import parse_qs, parse_qsl, unquote, urlunparse | from urllib.parse import parse_qs, parse_qsl, unquote, urlunparse | ||||||
|  |  | ||||||
| from httptools import parse_url | from httptools import parse_url  # type: ignore | ||||||
| from httptools.parser.errors import HttpParserInvalidURLError |  | ||||||
|  |  | ||||||
| from sanic.compat import Header | from sanic.compat import CancelledErrors, Header | ||||||
| from sanic.constants import ( | from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE | ||||||
|     CACHEABLE_HTTP_METHODS, | from sanic.exceptions import InvalidUsage, ServerError | ||||||
|     DEFAULT_HTTP_CONTENT_TYPE, |  | ||||||
|     IDEMPOTENT_HTTP_METHODS, |  | ||||||
|     SAFE_HTTP_METHODS, |  | ||||||
| ) |  | ||||||
| from sanic.exceptions import BadRequest, BadURL, ServerError |  | ||||||
| from sanic.headers import ( | from sanic.headers import ( | ||||||
|     AcceptContainer, |     AcceptContainer, | ||||||
|     Options, |     Options, | ||||||
| @@ -57,8 +44,8 @@ from sanic.headers import ( | |||||||
|     parse_host, |     parse_host, | ||||||
|     parse_xforwarded, |     parse_xforwarded, | ||||||
| ) | ) | ||||||
| from sanic.http import Stage | from sanic.http import Http, Stage | ||||||
| from sanic.log import deprecation, error_logger, logger | from sanic.log import error_logger, logger | ||||||
| from sanic.models.protocol_types import TransportProtocol | from sanic.models.protocol_types import TransportProtocol | ||||||
| from sanic.response import BaseHTTPResponse, HTTPResponse | from sanic.response import BaseHTTPResponse, HTTPResponse | ||||||
|  |  | ||||||
| @@ -93,23 +80,16 @@ class Request: | |||||||
|     Properties of an HTTP request such as URL, headers, etc. |     Properties of an HTTP request such as URL, headers, etc. | ||||||
|     """ |     """ | ||||||
|  |  | ||||||
|     _current: ContextVar[Request] = ContextVar("request") |  | ||||||
|     _loads = json_loads |  | ||||||
|  |  | ||||||
|     __slots__ = ( |     __slots__ = ( | ||||||
|         "__weakref__", |         "__weakref__", | ||||||
|         "_cookies", |         "_cookies", | ||||||
|         "_id", |         "_id", | ||||||
|         "_ip", |         "_ip", | ||||||
|         "_manager", |  | ||||||
|         "_parsed_url", |         "_parsed_url", | ||||||
|         "_port", |         "_port", | ||||||
|         "_protocol", |         "_protocol", | ||||||
|         "_remote_addr", |         "_remote_addr", | ||||||
|         "_request_middleware_started", |  | ||||||
|         "_scheme", |  | ||||||
|         "_socket", |         "_socket", | ||||||
|         "_stream_id", |  | ||||||
|         "_match_info", |         "_match_info", | ||||||
|         "_name", |         "_name", | ||||||
|         "app", |         "app", | ||||||
| @@ -130,6 +110,7 @@ class Request: | |||||||
|         "parsed_token", |         "parsed_token", | ||||||
|         "raw_url", |         "raw_url", | ||||||
|         "responded", |         "responded", | ||||||
|  |         "request_middleware_started", | ||||||
|         "route", |         "route", | ||||||
|         "stream", |         "stream", | ||||||
|         "transport", |         "transport", | ||||||
| @@ -145,17 +126,13 @@ class Request: | |||||||
|         transport: TransportProtocol, |         transport: TransportProtocol, | ||||||
|         app: Sanic, |         app: Sanic, | ||||||
|         head: bytes = b"", |         head: bytes = b"", | ||||||
|         stream_id: int = 0, |  | ||||||
|     ): |     ): | ||||||
|  |  | ||||||
|         self.raw_url = url_bytes |         self.raw_url = url_bytes | ||||||
|         try: |         # TODO: Content-Encoding detection | ||||||
|             self._parsed_url = parse_url(url_bytes) |         self._parsed_url = parse_url(url_bytes) | ||||||
|         except HttpParserInvalidURLError: |  | ||||||
|             raise BadURL(f"Bad URL: {url_bytes.decode()}") |  | ||||||
|         self._id: Optional[Union[uuid.UUID, str, int]] = None |         self._id: Optional[Union[uuid.UUID, str, int]] = None | ||||||
|         self._name: Optional[str] = None |         self._name: Optional[str] = None | ||||||
|         self._stream_id = stream_id |  | ||||||
|         self.app = app |         self.app = app | ||||||
|  |  | ||||||
|         self.headers = Header(headers) |         self.headers = Header(headers) | ||||||
| @@ -172,8 +149,8 @@ class Request: | |||||||
|         self.parsed_accept: Optional[AcceptContainer] = None |         self.parsed_accept: Optional[AcceptContainer] = None | ||||||
|         self.parsed_credentials: Optional[Credentials] = None |         self.parsed_credentials: Optional[Credentials] = None | ||||||
|         self.parsed_json = None |         self.parsed_json = None | ||||||
|         self.parsed_form: Optional[RequestParameters] = None |         self.parsed_form = None | ||||||
|         self.parsed_files: Optional[RequestParameters] = None |         self.parsed_files = None | ||||||
|         self.parsed_token: Optional[str] = None |         self.parsed_token: Optional[str] = None | ||||||
|         self.parsed_args: DefaultDict[ |         self.parsed_args: DefaultDict[ | ||||||
|             Tuple[bool, bool, str, str], RequestParameters |             Tuple[bool, bool, str, str], RequestParameters | ||||||
| @@ -181,76 +158,22 @@ class Request: | |||||||
|         self.parsed_not_grouped_args: DefaultDict[ |         self.parsed_not_grouped_args: DefaultDict[ | ||||||
|             Tuple[bool, bool, str, str], List[Tuple[str, str]] |             Tuple[bool, bool, str, str], List[Tuple[str, str]] | ||||||
|         ] = defaultdict(list) |         ] = defaultdict(list) | ||||||
|         self._request_middleware_started = False |         self.request_middleware_started = False | ||||||
|         self.responded: bool = False |  | ||||||
|         self.route: Optional[Route] = None |  | ||||||
|         self.stream: Optional[Stream] = None |  | ||||||
|         self._manager: Optional[RequestManager] = None |  | ||||||
|         self._cookies: Optional[Dict[str, str]] = None |         self._cookies: Optional[Dict[str, str]] = None | ||||||
|         self._match_info: Dict[str, Any] = {} |         self._match_info: Dict[str, Any] = {} | ||||||
|  |         self.stream: Optional[Http] = None | ||||||
|  |         self.route: Optional[Route] = None | ||||||
|         self._protocol = None |         self._protocol = None | ||||||
|  |         self.responded: bool = False | ||||||
|  |  | ||||||
|     def __repr__(self): |     def __repr__(self): | ||||||
|         class_name = self.__class__.__name__ |         class_name = self.__class__.__name__ | ||||||
|         return f"<{class_name}: {self.method} {self.path}>" |         return f"<{class_name}: {self.method} {self.path}>" | ||||||
|  |  | ||||||
|     @classmethod |  | ||||||
|     def get_current(cls) -> Request: |  | ||||||
|         """ |  | ||||||
|         Retrieve the current request object |  | ||||||
|  |  | ||||||
|         This implements `Context Variables |  | ||||||
|         <https://docs.python.org/3/library/contextvars.html>`_ |  | ||||||
|         to allow for accessing the current request from anywhere. |  | ||||||
|  |  | ||||||
|         Raises :exc:`sanic.exceptions.ServerError` if it is outside of |  | ||||||
|         a request lifecycle. |  | ||||||
|  |  | ||||||
|         .. code-block:: python |  | ||||||
|  |  | ||||||
|             from sanic import Request |  | ||||||
|  |  | ||||||
|             current_request = Request.get_current() |  | ||||||
|  |  | ||||||
|         :return: the current :class:`sanic.request.Request` |  | ||||||
|         """ |  | ||||||
|         request = cls._current.get(None) |  | ||||||
|         if not request: |  | ||||||
|             raise ServerError("No current request") |  | ||||||
|         return request |  | ||||||
|  |  | ||||||
|     @classmethod |     @classmethod | ||||||
|     def generate_id(*_): |     def generate_id(*_): | ||||||
|         return uuid.uuid4() |         return uuid.uuid4() | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def request_middleware_started(self): |  | ||||||
|         deprecation( |  | ||||||
|             "Request.request_middleware_started has been deprecated and will" |  | ||||||
|             "be removed. You should set a flag on the request context using" |  | ||||||
|             "either middleware or signals if you need this feature.", |  | ||||||
|             22.3, |  | ||||||
|         ) |  | ||||||
|         return self._request_middleware_started |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def stream_id(self): |  | ||||||
|         """ |  | ||||||
|         Access the HTTP/3 stream ID. |  | ||||||
|  |  | ||||||
|         Raises :exc:`sanic.exceptions.ServerError` if it is not an |  | ||||||
|         HTTP/3 request. |  | ||||||
|         """ |  | ||||||
|         if self.protocol.version is not HTTP.VERSION_3: |  | ||||||
|             raise ServerError( |  | ||||||
|                 "Stream ID is only a property of a HTTP/3 request" |  | ||||||
|             ) |  | ||||||
|         return self._stream_id |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def manager(self): |  | ||||||
|         return self._manager |  | ||||||
|  |  | ||||||
|     def reset_response(self): |     def reset_response(self): | ||||||
|         try: |         try: | ||||||
|             if ( |             if ( | ||||||
| @@ -274,53 +197,6 @@ class Request: | |||||||
|         headers: Optional[Union[Header, Dict[str, str]]] = None, |         headers: Optional[Union[Header, Dict[str, str]]] = None, | ||||||
|         content_type: Optional[str] = None, |         content_type: Optional[str] = None, | ||||||
|     ): |     ): | ||||||
|         """Respond to the request without returning. |  | ||||||
|  |  | ||||||
|         This method can only be called once, as you can only respond once. |  | ||||||
|         If no ``response`` argument is passed, one will be created from the |  | ||||||
|         ``status``, ``headers`` and ``content_type`` arguments. |  | ||||||
|  |  | ||||||
|         **The first typical usecase** is if you wish to respond to the |  | ||||||
|         request without returning from the handler: |  | ||||||
|  |  | ||||||
|         .. code-block:: python |  | ||||||
|  |  | ||||||
|             @app.get("/") |  | ||||||
|             async def handler(request: Request): |  | ||||||
|                 data = ...  # Process something |  | ||||||
|  |  | ||||||
|                 json_response = json({"data": data}) |  | ||||||
|                 await request.respond(json_response) |  | ||||||
|  |  | ||||||
|                 # You are now free to continue executing other code |  | ||||||
|                 ... |  | ||||||
|  |  | ||||||
|             @app.on_response |  | ||||||
|             async def add_header(_, response: HTTPResponse): |  | ||||||
|                 # Middlewares still get executed as expected |  | ||||||
|                 response.headers["one"] = "two" |  | ||||||
|  |  | ||||||
|         **The second possible usecase** is for when you want to directly |  | ||||||
|         respond to the request: |  | ||||||
|  |  | ||||||
|         .. code-block:: python |  | ||||||
|  |  | ||||||
|             response = await request.respond(content_type="text/csv") |  | ||||||
|             await response.send("foo,") |  | ||||||
|             await response.send("bar") |  | ||||||
|  |  | ||||||
|             # You can control the completion of the response by calling |  | ||||||
|             # the 'eof()' method: |  | ||||||
|             await response.eof() |  | ||||||
|  |  | ||||||
|         :param response: response instance to send |  | ||||||
|         :param status: status code to return in the response |  | ||||||
|         :param headers: headers to return in the response |  | ||||||
|         :param content_type: Content-Type header of the response |  | ||||||
|         :return: final response being sent (may be different from the |  | ||||||
|             ``response`` parameter because of middlewares) which can be |  | ||||||
|             used to manually send data |  | ||||||
|         """ |  | ||||||
|         try: |         try: | ||||||
|             if self.stream is not None and self.stream.response: |             if self.stream is not None and self.stream.response: | ||||||
|                 raise ServerError("Second respond call is not allowed.") |                 raise ServerError("Second respond call is not allowed.") | ||||||
| @@ -337,17 +213,16 @@ class Request: | |||||||
|         # Connect the response |         # Connect the response | ||||||
|         if isinstance(response, BaseHTTPResponse) and self.stream: |         if isinstance(response, BaseHTTPResponse) and self.stream: | ||||||
|             response = self.stream.respond(response) |             response = self.stream.respond(response) | ||||||
|  |  | ||||||
|             if isawaitable(response): |  | ||||||
|                 response = await response  # type: ignore |  | ||||||
|         # Run response middleware |         # Run response middleware | ||||||
|         if ( |         try: | ||||||
|             self._manager |             response = await self.app._run_response_middleware( | ||||||
|             and not self._manager.response_middleware_run |                 self, response, request_name=self.name | ||||||
|             and self._manager.response_middleware |             ) | ||||||
|         ): |         except CancelledErrors: | ||||||
|             response = await self._manager.run( |             raise | ||||||
|                 partial(self._manager.run_response_middleware, response) |         except Exception: | ||||||
|  |             error_logger.exception( | ||||||
|  |                 "Exception occurred in one of response middleware handlers" | ||||||
|             ) |             ) | ||||||
|         self.responded = True |         self.responded = True | ||||||
|         return response |         return response | ||||||
| @@ -365,19 +240,7 @@ class Request: | |||||||
|             self.body = b"".join([data async for data in self.stream]) |             self.body = b"".join([data async for data in self.stream]) | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def name(self) -> Optional[str]: |     def name(self): | ||||||
|         """ |  | ||||||
|         The route name |  | ||||||
|  |  | ||||||
|         In the following pattern: |  | ||||||
|  |  | ||||||
|         .. code-block:: |  | ||||||
|  |  | ||||||
|             <AppName>.[<BlueprintName>.]<HandlerName> |  | ||||||
|  |  | ||||||
|         :return: Route name |  | ||||||
|         :rtype: Optional[str] |  | ||||||
|         """ |  | ||||||
|         if self._name: |         if self._name: | ||||||
|             return self._name |             return self._name | ||||||
|         elif self.route: |         elif self.route: | ||||||
| @@ -385,47 +248,26 @@ class Request: | |||||||
|         return None |         return None | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def endpoint(self) -> Optional[str]: |     def endpoint(self): | ||||||
|         """ |  | ||||||
|         :return: Alias of :attr:`sanic.request.Request.name` |  | ||||||
|         :rtype: Optional[str] |  | ||||||
|         """ |  | ||||||
|         return self.name |         return self.name | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def uri_template(self) -> Optional[str]: |     def uri_template(self): | ||||||
|         """ |         return f"/{self.route.path}" | ||||||
|         :return: The defined URI template |  | ||||||
|         :rtype: Optional[str] |  | ||||||
|         """ |  | ||||||
|         if self.route: |  | ||||||
|             return f"/{self.route.path}" |  | ||||||
|         return None |  | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def protocol(self): |     def protocol(self): | ||||||
|         """ |  | ||||||
|         :return: The HTTP protocol instance |  | ||||||
|         """ |  | ||||||
|         if not self._protocol: |         if not self._protocol: | ||||||
|             self._protocol = self.transport.get_protocol() |             self._protocol = self.transport.get_protocol() | ||||||
|         return self._protocol |         return self._protocol | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def raw_headers(self) -> bytes: |     def raw_headers(self): | ||||||
|         """ |  | ||||||
|         :return: The unparsed HTTP headers |  | ||||||
|         :rtype: bytes |  | ||||||
|         """ |  | ||||||
|         _, headers = self.head.split(b"\r\n", 1) |         _, headers = self.head.split(b"\r\n", 1) | ||||||
|         return bytes(headers) |         return bytes(headers) | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def request_line(self) -> bytes: |     def request_line(self): | ||||||
|         """ |  | ||||||
|         :return: The first line of a HTTP request |  | ||||||
|         :rtype: bytes |  | ||||||
|         """ |  | ||||||
|         reqline, _ = self.head.split(b"\r\n", 1) |         reqline, _ = self.head.split(b"\r\n", 1) | ||||||
|         return bytes(reqline) |         return bytes(reqline) | ||||||
|  |  | ||||||
| @@ -474,35 +316,24 @@ class Request: | |||||||
|         return self._id  # type: ignore |         return self._id  # type: ignore | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def json(self) -> Any: |     def json(self): | ||||||
|         """ |  | ||||||
|         :return: The request body parsed as JSON |  | ||||||
|         :rtype: Any |  | ||||||
|         """ |  | ||||||
|         if self.parsed_json is None: |         if self.parsed_json is None: | ||||||
|             self.load_json() |             self.load_json() | ||||||
|  |  | ||||||
|         return self.parsed_json |         return self.parsed_json | ||||||
|  |  | ||||||
|     def load_json(self, loads=None): |     def load_json(self, loads=json_loads): | ||||||
|         try: |         try: | ||||||
|             if not loads: |  | ||||||
|                 loads = self.__class__._loads |  | ||||||
|  |  | ||||||
|             self.parsed_json = loads(self.body) |             self.parsed_json = loads(self.body) | ||||||
|         except Exception: |         except Exception: | ||||||
|             if not self.body: |             if not self.body: | ||||||
|                 return None |                 return None | ||||||
|             raise BadRequest("Failed when parsing body as json") |             raise InvalidUsage("Failed when parsing body as json") | ||||||
|  |  | ||||||
|         return self.parsed_json |         return self.parsed_json | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def accept(self) -> AcceptContainer: |     def accept(self) -> AcceptContainer: | ||||||
|         """ |  | ||||||
|         :return: The ``Accept`` header parsed |  | ||||||
|         :rtype: AcceptContainer |  | ||||||
|         """ |  | ||||||
|         if self.parsed_accept is None: |         if self.parsed_accept is None: | ||||||
|             accept_header = self.headers.getone("accept", "") |             accept_header = self.headers.getone("accept", "") | ||||||
|             self.parsed_accept = parse_accept(accept_header) |             self.parsed_accept = parse_accept(accept_header) | ||||||
| @@ -545,60 +376,33 @@ class Request: | |||||||
|                 pass |                 pass | ||||||
|         return self.parsed_credentials |         return self.parsed_credentials | ||||||
|  |  | ||||||
|     def get_form( |  | ||||||
|         self, keep_blank_values: bool = False |  | ||||||
|     ) -> Optional[RequestParameters]: |  | ||||||
|         """ |  | ||||||
|         Method to extract and parse the form data from a request. |  | ||||||
|  |  | ||||||
|         :param keep_blank_values: |  | ||||||
|             Whether to discard blank values from the form data |  | ||||||
|         :type keep_blank_values: bool |  | ||||||
|         :return: the parsed form data |  | ||||||
|         :rtype: Optional[RequestParameters] |  | ||||||
|         """ |  | ||||||
|         self.parsed_form = RequestParameters() |  | ||||||
|         self.parsed_files = RequestParameters() |  | ||||||
|         content_type = self.headers.getone( |  | ||||||
|             "content-type", DEFAULT_HTTP_CONTENT_TYPE |  | ||||||
|         ) |  | ||||||
|         content_type, parameters = parse_content_header(content_type) |  | ||||||
|         try: |  | ||||||
|             if content_type == "application/x-www-form-urlencoded": |  | ||||||
|                 self.parsed_form = RequestParameters( |  | ||||||
|                     parse_qs( |  | ||||||
|                         self.body.decode("utf-8"), |  | ||||||
|                         keep_blank_values=keep_blank_values, |  | ||||||
|                     ) |  | ||||||
|                 ) |  | ||||||
|             elif content_type == "multipart/form-data": |  | ||||||
|                 # TODO: Stream this instead of reading to/from memory |  | ||||||
|                 boundary = parameters["boundary"].encode(  # type: ignore |  | ||||||
|                     "utf-8" |  | ||||||
|                 )  # type: ignore |  | ||||||
|                 self.parsed_form, self.parsed_files = parse_multipart_form( |  | ||||||
|                     self.body, boundary |  | ||||||
|                 ) |  | ||||||
|         except Exception: |  | ||||||
|             error_logger.exception("Failed when parsing form") |  | ||||||
|  |  | ||||||
|         return self.parsed_form |  | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def form(self): |     def form(self): | ||||||
|         """ |  | ||||||
|         :return: The request body parsed as form data |  | ||||||
|         """ |  | ||||||
|         if self.parsed_form is None: |         if self.parsed_form is None: | ||||||
|             self.get_form() |             self.parsed_form = RequestParameters() | ||||||
|  |             self.parsed_files = RequestParameters() | ||||||
|  |             content_type = self.headers.getone( | ||||||
|  |                 "content-type", DEFAULT_HTTP_CONTENT_TYPE | ||||||
|  |             ) | ||||||
|  |             content_type, parameters = parse_content_header(content_type) | ||||||
|  |             try: | ||||||
|  |                 if content_type == "application/x-www-form-urlencoded": | ||||||
|  |                     self.parsed_form = RequestParameters( | ||||||
|  |                         parse_qs(self.body.decode("utf-8")) | ||||||
|  |                     ) | ||||||
|  |                 elif content_type == "multipart/form-data": | ||||||
|  |                     # TODO: Stream this instead of reading to/from memory | ||||||
|  |                     boundary = parameters["boundary"].encode("utf-8") | ||||||
|  |                     self.parsed_form, self.parsed_files = parse_multipart_form( | ||||||
|  |                         self.body, boundary | ||||||
|  |                     ) | ||||||
|  |             except Exception: | ||||||
|  |                 error_logger.exception("Failed when parsing form") | ||||||
|  |  | ||||||
|         return self.parsed_form |         return self.parsed_form | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def files(self): |     def files(self): | ||||||
|         """ |  | ||||||
|         :return: The request body parsed as uploaded files |  | ||||||
|         """ |  | ||||||
|         if self.parsed_files is None: |         if self.parsed_files is None: | ||||||
|             self.form  # compute form to get files |             self.form  # compute form to get files | ||||||
|  |  | ||||||
| @@ -612,8 +416,8 @@ class Request: | |||||||
|         errors: str = "replace", |         errors: str = "replace", | ||||||
|     ) -> RequestParameters: |     ) -> RequestParameters: | ||||||
|         """ |         """ | ||||||
|         Method to parse ``query_string`` using ``urllib.parse.parse_qs``. |         Method to parse `query_string` using `urllib.parse.parse_qs`. | ||||||
|         This methods is used by ``args`` property. |         This methods is used by `args` property. | ||||||
|         Can be used directly if you need to change default parameters. |         Can be used directly if you need to change default parameters. | ||||||
|  |  | ||||||
|         :param keep_blank_values: |         :param keep_blank_values: | ||||||
| @@ -662,10 +466,6 @@ class Request: | |||||||
|         ] |         ] | ||||||
|  |  | ||||||
|     args = property(get_args) |     args = property(get_args) | ||||||
|     """ |  | ||||||
|     Convenience property to access :meth:`Request.get_args` with |  | ||||||
|     default values. |  | ||||||
|     """ |  | ||||||
|  |  | ||||||
|     def get_query_args( |     def get_query_args( | ||||||
|         self, |         self, | ||||||
| @@ -785,9 +585,6 @@ class Request: | |||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def socket(self): |     def socket(self): | ||||||
|         """ |  | ||||||
|         :return: Information about the connected socket if available |  | ||||||
|         """ |  | ||||||
|         return self.conn_info.peername if self.conn_info else (None, None) |         return self.conn_info.peername if self.conn_info else (None, None) | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
| @@ -798,13 +595,6 @@ class Request: | |||||||
|         """ |         """ | ||||||
|         return self._parsed_url.path.decode("utf-8") |         return self._parsed_url.path.decode("utf-8") | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def network_paths(self): |  | ||||||
|         """ |  | ||||||
|         Access the network paths if available |  | ||||||
|         """ |  | ||||||
|         return self.conn_info.network_paths |  | ||||||
|  |  | ||||||
|     # Proxy properties (using SERVER_NAME/forwarded/request/transport info) |     # Proxy properties (using SERVER_NAME/forwarded/request/transport info) | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
| @@ -858,25 +648,23 @@ class Request: | |||||||
|         :return: http|https|ws|wss or arbitrary value given by the headers. |         :return: http|https|ws|wss or arbitrary value given by the headers. | ||||||
|         :rtype: str |         :rtype: str | ||||||
|         """ |         """ | ||||||
|         if not hasattr(self, "_scheme"): |         if "//" in self.app.config.get("SERVER_NAME", ""): | ||||||
|             if "//" in self.app.config.get("SERVER_NAME", ""): |             return self.app.config.SERVER_NAME.split("//")[0] | ||||||
|                 return self.app.config.SERVER_NAME.split("//")[0] |         if "proto" in self.forwarded: | ||||||
|             if "proto" in self.forwarded: |             return str(self.forwarded["proto"]) | ||||||
|                 return str(self.forwarded["proto"]) |  | ||||||
|  |  | ||||||
|             if ( |         if ( | ||||||
|                 self.app.websocket_enabled |             self.app.websocket_enabled | ||||||
|                 and self.headers.getone("upgrade", "").lower() == "websocket" |             and self.headers.getone("upgrade", "").lower() == "websocket" | ||||||
|             ): |         ): | ||||||
|                 scheme = "ws" |             scheme = "ws" | ||||||
|             else: |         else: | ||||||
|                 scheme = "http" |             scheme = "http" | ||||||
|  |  | ||||||
|             if self.transport.get_extra_info("sslcontext"): |         if self.transport.get_extra_info("sslcontext"): | ||||||
|                 scheme += "s" |             scheme += "s" | ||||||
|             self._scheme = scheme |  | ||||||
|  |  | ||||||
|         return self._scheme |         return scheme | ||||||
|  |  | ||||||
|     @property |     @property | ||||||
|     def host(self) -> str: |     def host(self) -> str: | ||||||
| @@ -981,48 +769,6 @@ class Request: | |||||||
|             view_name, _external=True, _scheme=scheme, _server=netloc, **kwargs |             view_name, _external=True, _scheme=scheme, _server=netloc, **kwargs | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def scope(self) -> ASGIScope: |  | ||||||
|         """ |  | ||||||
|         :return: The ASGI scope of the request. |  | ||||||
|                  If the app isn't an ASGI app, then raises an exception. |  | ||||||
|         :rtype: Optional[ASGIScope] |  | ||||||
|         """ |  | ||||||
|         if not self.app.asgi: |  | ||||||
|             raise NotImplementedError( |  | ||||||
|                 "App isn't running in ASGI mode. " |  | ||||||
|                 "Scope is only available for ASGI apps." |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|         return self.transport.scope |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def is_safe(self) -> bool: |  | ||||||
|         """ |  | ||||||
|         :return: Whether the HTTP method is safe. |  | ||||||
|             See https://datatracker.ietf.org/doc/html/rfc7231#section-4.2.1 |  | ||||||
|         :rtype: bool |  | ||||||
|         """ |  | ||||||
|         return self.method in SAFE_HTTP_METHODS |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def is_idempotent(self) -> bool: |  | ||||||
|         """ |  | ||||||
|         :return: Whether the HTTP method is iempotent. |  | ||||||
|             See https://datatracker.ietf.org/doc/html/rfc7231#section-4.2.2 |  | ||||||
|         :rtype: bool |  | ||||||
|         """ |  | ||||||
|         return self.method in IDEMPOTENT_HTTP_METHODS |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def is_cacheable(self) -> bool: |  | ||||||
|         """ |  | ||||||
|         :return: Whether the HTTP method is cacheable. |  | ||||||
|             See https://datatracker.ietf.org/doc/html/rfc7231#section-4.2.3 |  | ||||||
|         :rtype: bool |  | ||||||
|         """ |  | ||||||
|         return self.method in CACHEABLE_HTTP_METHODS |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class File(NamedTuple): | class File(NamedTuple): | ||||||
|     """ |     """ | ||||||
|   | |||||||
| @@ -1,12 +1,9 @@ | |||||||
| from __future__ import annotations | from __future__ import annotations | ||||||
|  |  | ||||||
| from datetime import datetime, timezone |  | ||||||
| from email.utils import formatdate, parsedate_to_datetime |  | ||||||
| from functools import partial | from functools import partial | ||||||
| from mimetypes import guess_type | from mimetypes import guess_type | ||||||
| from os import path | from os import path | ||||||
| from pathlib import PurePath | from pathlib import PurePath | ||||||
| from time import time |  | ||||||
| from typing import ( | from typing import ( | ||||||
|     TYPE_CHECKING, |     TYPE_CHECKING, | ||||||
|     Any, |     Any, | ||||||
| @@ -22,24 +19,17 @@ from typing import ( | |||||||
| ) | ) | ||||||
| from urllib.parse import quote_plus | from urllib.parse import quote_plus | ||||||
|  |  | ||||||
| from sanic.compat import Header, open_async, stat_async | from sanic.compat import Header, open_async | ||||||
| from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE | from sanic.constants import DEFAULT_HTTP_CONTENT_TYPE | ||||||
| from sanic.cookies import CookieJar | from sanic.cookies import CookieJar | ||||||
| from sanic.exceptions import SanicException, ServerError | from sanic.exceptions import SanicException, ServerError | ||||||
| from sanic.helpers import ( | from sanic.helpers import has_message_body, remove_entity_headers | ||||||
|     Default, |  | ||||||
|     _default, |  | ||||||
|     has_message_body, |  | ||||||
|     remove_entity_headers, |  | ||||||
| ) |  | ||||||
| from sanic.http import Http | from sanic.http import Http | ||||||
| from sanic.log import logger |  | ||||||
| from sanic.models.protocol_types import HTMLProtocol, Range | from sanic.models.protocol_types import HTMLProtocol, Range | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING: | ||||||
|     from sanic.asgi import ASGIApp |     from sanic.asgi import ASGIApp | ||||||
|     from sanic.http.http3 import HTTPReceiver |  | ||||||
|     from sanic.request import Request |     from sanic.request import Request | ||||||
| else: | else: | ||||||
|     Request = TypeVar("Request") |     Request = TypeVar("Request") | ||||||
| @@ -60,31 +50,17 @@ class BaseHTTPResponse: | |||||||
|     The base class for all HTTP Responses |     The base class for all HTTP Responses | ||||||
|     """ |     """ | ||||||
|  |  | ||||||
|     __slots__ = ( |  | ||||||
|         "asgi", |  | ||||||
|         "body", |  | ||||||
|         "content_type", |  | ||||||
|         "stream", |  | ||||||
|         "status", |  | ||||||
|         "headers", |  | ||||||
|         "_cookies", |  | ||||||
|     ) |  | ||||||
|  |  | ||||||
|     _dumps = json_dumps |     _dumps = json_dumps | ||||||
|  |  | ||||||
|     def __init__(self): |     def __init__(self): | ||||||
|         self.asgi: bool = False |         self.asgi: bool = False | ||||||
|         self.body: Optional[bytes] = None |         self.body: Optional[bytes] = None | ||||||
|         self.content_type: Optional[str] = None |         self.content_type: Optional[str] = None | ||||||
|         self.stream: Optional[Union[Http, ASGIApp, HTTPReceiver]] = None |         self.stream: Optional[Union[Http, ASGIApp]] = None | ||||||
|         self.status: int = None |         self.status: int = None | ||||||
|         self.headers = Header({}) |         self.headers = Header({}) | ||||||
|         self._cookies: Optional[CookieJar] = None |         self._cookies: Optional[CookieJar] = None | ||||||
|  |  | ||||||
|     def __repr__(self): |  | ||||||
|         class_name = self.__class__.__name__ |  | ||||||
|         return f"<{class_name}: {self.status} {self.content_type}>" |  | ||||||
|  |  | ||||||
|     def _encode_body(self, data: Optional[AnyStr]): |     def _encode_body(self, data: Optional[AnyStr]): | ||||||
|         if data is None: |         if data is None: | ||||||
|             return b"" |             return b"" | ||||||
| @@ -163,10 +139,7 @@ class BaseHTTPResponse: | |||||||
|             if hasattr(data, "encode") |             if hasattr(data, "encode") | ||||||
|             else data or b"" |             else data or b"" | ||||||
|         ) |         ) | ||||||
|         await self.stream.send( |         await self.stream.send(data, end_stream=end_stream) | ||||||
|             data,  # type: ignore |  | ||||||
|             end_stream=end_stream or False, |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class HTTPResponse(BaseHTTPResponse): | class HTTPResponse(BaseHTTPResponse): | ||||||
| @@ -183,7 +156,7 @@ class HTTPResponse(BaseHTTPResponse): | |||||||
|     :type content_type: Optional[str] |     :type content_type: Optional[str] | ||||||
|     """ |     """ | ||||||
|  |  | ||||||
|     __slots__ = () |     __slots__ = ("body", "status", "content_type", "headers", "_cookies") | ||||||
|  |  | ||||||
|     def __init__( |     def __init__( | ||||||
|         self, |         self, | ||||||
| @@ -211,7 +184,7 @@ class HTTPResponse(BaseHTTPResponse): | |||||||
|  |  | ||||||
|  |  | ||||||
| def empty( | def empty( | ||||||
|     status: int = 204, headers: Optional[Dict[str, str]] = None |     status=204, headers: Optional[Dict[str, str]] = None | ||||||
| ) -> HTTPResponse: | ) -> HTTPResponse: | ||||||
|     """ |     """ | ||||||
|     Returns an empty response to the client. |     Returns an empty response to the client. | ||||||
| @@ -228,7 +201,7 @@ def json( | |||||||
|     headers: Optional[Dict[str, str]] = None, |     headers: Optional[Dict[str, str]] = None, | ||||||
|     content_type: str = "application/json", |     content_type: str = "application/json", | ||||||
|     dumps: Optional[Callable[..., str]] = None, |     dumps: Optional[Callable[..., str]] = None, | ||||||
|     **kwargs: Any, |     **kwargs, | ||||||
| ) -> HTTPResponse: | ) -> HTTPResponse: | ||||||
|     """ |     """ | ||||||
|     Returns response object with body in json format. |     Returns response object with body in json format. | ||||||
| @@ -320,101 +293,27 @@ def html( | |||||||
|     ) |     ) | ||||||
|  |  | ||||||
|  |  | ||||||
| async def validate_file( |  | ||||||
|     request_headers: Header, last_modified: Union[datetime, float, int] |  | ||||||
| ): |  | ||||||
|     try: |  | ||||||
|         if_modified_since = request_headers.getone("If-Modified-Since") |  | ||||||
|     except KeyError: |  | ||||||
|         return |  | ||||||
|     try: |  | ||||||
|         if_modified_since = parsedate_to_datetime(if_modified_since) |  | ||||||
|     except (TypeError, ValueError): |  | ||||||
|         logger.warning( |  | ||||||
|             "Ignorning invalid If-Modified-Since header received: " "'%s'", |  | ||||||
|             if_modified_since, |  | ||||||
|         ) |  | ||||||
|         return |  | ||||||
|     if not isinstance(last_modified, datetime): |  | ||||||
|         last_modified = datetime.fromtimestamp( |  | ||||||
|             float(last_modified), tz=timezone.utc |  | ||||||
|         ).replace(microsecond=0) |  | ||||||
|     if last_modified <= if_modified_since: |  | ||||||
|         return HTTPResponse(status=304) |  | ||||||
|  |  | ||||||
|  |  | ||||||
| async def file( | async def file( | ||||||
|     location: Union[str, PurePath], |     location: Union[str, PurePath], | ||||||
|     status: int = 200, |     status: int = 200, | ||||||
|     request_headers: Optional[Header] = None, |  | ||||||
|     validate_when_requested: bool = True, |  | ||||||
|     mime_type: Optional[str] = None, |     mime_type: Optional[str] = None, | ||||||
|     headers: Optional[Dict[str, str]] = None, |     headers: Optional[Dict[str, str]] = None, | ||||||
|     filename: Optional[str] = None, |     filename: Optional[str] = None, | ||||||
|     last_modified: Optional[Union[datetime, float, int, Default]] = _default, |  | ||||||
|     max_age: Optional[Union[float, int]] = None, |  | ||||||
|     no_store: Optional[bool] = None, |  | ||||||
|     _range: Optional[Range] = None, |     _range: Optional[Range] = None, | ||||||
| ) -> HTTPResponse: | ) -> HTTPResponse: | ||||||
|     """Return a response object with file data. |     """Return a response object with file data. | ||||||
|     :param status: HTTP response code. Won't enforce the passed in |  | ||||||
|         status if only a part of the content will be sent (206) |  | ||||||
|         or file is being validated (304). |  | ||||||
|     :param request_headers: The request headers. |  | ||||||
|     :param validate_when_requested: If True, will validate the |  | ||||||
|         file when requested. |  | ||||||
|     :param location: Location of file on system. |     :param location: Location of file on system. | ||||||
|     :param mime_type: Specific mime_type. |     :param mime_type: Specific mime_type. | ||||||
|     :param headers: Custom Headers. |     :param headers: Custom Headers. | ||||||
|     :param filename: Override filename. |     :param filename: Override filename. | ||||||
|     :param last_modified: The last modified date and time of the file. |  | ||||||
|     :param max_age: Max age for cache control. |  | ||||||
|     :param no_store: Any cache should not store this response. |  | ||||||
|     :param _range: |     :param _range: | ||||||
|     """ |     """ | ||||||
|  |  | ||||||
|     if isinstance(last_modified, datetime): |  | ||||||
|         last_modified = last_modified.replace(microsecond=0).timestamp() |  | ||||||
|     elif isinstance(last_modified, Default): |  | ||||||
|         stat = await stat_async(location) |  | ||||||
|         last_modified = stat.st_mtime |  | ||||||
|  |  | ||||||
|     if ( |  | ||||||
|         validate_when_requested |  | ||||||
|         and request_headers is not None |  | ||||||
|         and last_modified |  | ||||||
|     ): |  | ||||||
|         response = await validate_file(request_headers, last_modified) |  | ||||||
|         if response: |  | ||||||
|             return response |  | ||||||
|  |  | ||||||
|     headers = headers or {} |     headers = headers or {} | ||||||
|     if last_modified: |  | ||||||
|         headers.setdefault( |  | ||||||
|             "Last-Modified", formatdate(last_modified, usegmt=True) |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     if filename: |     if filename: | ||||||
|         headers.setdefault( |         headers.setdefault( | ||||||
|             "Content-Disposition", f'attachment; filename="{filename}"' |             "Content-Disposition", f'attachment; filename="{filename}"' | ||||||
|         ) |         ) | ||||||
|  |  | ||||||
|     if no_store: |  | ||||||
|         cache_control = "no-store" |  | ||||||
|     elif max_age: |  | ||||||
|         cache_control = f"public, max-age={max_age}" |  | ||||||
|         headers.setdefault( |  | ||||||
|             "expires", |  | ||||||
|             formatdate( |  | ||||||
|                 time() + max_age, |  | ||||||
|                 usegmt=True, |  | ||||||
|             ), |  | ||||||
|         ) |  | ||||||
|     else: |  | ||||||
|         cache_control = "no-cache" |  | ||||||
|  |  | ||||||
|     headers.setdefault("cache-control", cache_control) |  | ||||||
|  |  | ||||||
|     filename = filename or path.split(location)[-1] |     filename = filename or path.split(location)[-1] | ||||||
|  |  | ||||||
|     async with await open_async(location, mode="rb") as f: |     async with await open_async(location, mode="rb") as f: | ||||||
| @@ -468,7 +367,8 @@ def redirect( | |||||||
| class ResponseStream: | class ResponseStream: | ||||||
|     """ |     """ | ||||||
|     ResponseStream is a compat layer to bridge the gap after the deprecation |     ResponseStream is a compat layer to bridge the gap after the deprecation | ||||||
|     of StreamingHTTPResponse. It will be removed when: |     of StreamingHTTPResponse. In v22.6 it will be removed when: | ||||||
|  |     - stream is removed | ||||||
|     - file_stream is moved to new style streaming |     - file_stream is moved to new style streaming | ||||||
|     - file and file_stream are combined into a single API |     - file and file_stream are combined into a single API | ||||||
|     """ |     """ | ||||||
| @@ -596,3 +496,38 @@ async def file_stream( | |||||||
|         headers=headers, |         headers=headers, | ||||||
|         content_type=mime_type, |         content_type=mime_type, | ||||||
|     ) |     ) | ||||||
|  |  | ||||||
|  |  | ||||||
|  | def stream( | ||||||
|  |     streaming_fn: Callable[ | ||||||
|  |         [Union[BaseHTTPResponse, ResponseStream]], Coroutine[Any, Any, None] | ||||||
|  |     ], | ||||||
|  |     status: int = 200, | ||||||
|  |     headers: Optional[Dict[str, str]] = None, | ||||||
|  |     content_type: str = "text/plain; charset=utf-8", | ||||||
|  | ) -> ResponseStream: | ||||||
|  |     """Accepts a coroutine `streaming_fn` which can be used to | ||||||
|  |     write chunks to a streaming response. Returns a `ResponseStream`. | ||||||
|  |  | ||||||
|  |     Example usage:: | ||||||
|  |  | ||||||
|  |         @app.route("/") | ||||||
|  |         async def index(request): | ||||||
|  |             async def streaming_fn(response): | ||||||
|  |                 await response.write('foo') | ||||||
|  |                 await response.write('bar') | ||||||
|  |  | ||||||
|  |             return stream(streaming_fn, content_type='text/plain') | ||||||
|  |  | ||||||
|  |     :param streaming_fn: A coroutine accepts a response and | ||||||
|  |         writes content to that response. | ||||||
|  |     :param status: HTTP status. | ||||||
|  |     :param content_type: Specific content_type. | ||||||
|  |     :param headers: Custom Headers. | ||||||
|  |     """ | ||||||
|  |     return ResponseStream( | ||||||
|  |         streaming_fn, | ||||||
|  |         headers=headers, | ||||||
|  |         content_type=content_type, | ||||||
|  |         status=status, | ||||||
|  |     ) | ||||||
|   | |||||||
| @@ -5,15 +5,16 @@ from inspect import signature | |||||||
| from typing import Any, Dict, Iterable, List, Optional, Tuple, Union | from typing import Any, Dict, Iterable, List, Optional, Tuple, Union | ||||||
| from uuid import UUID | from uuid import UUID | ||||||
|  |  | ||||||
| from sanic_routing import BaseRouter | from sanic_routing import BaseRouter  # type: ignore | ||||||
| from sanic_routing.exceptions import NoMethod | from sanic_routing.exceptions import NoMethod  # type: ignore | ||||||
| from sanic_routing.exceptions import NotFound as RoutingNotFound | from sanic_routing.exceptions import ( | ||||||
| from sanic_routing.route import Route |     NotFound as RoutingNotFound,  # type: ignore | ||||||
|  | ) | ||||||
|  | from sanic_routing.route import Route  # type: ignore | ||||||
|  |  | ||||||
| from sanic.constants import HTTP_METHODS | from sanic.constants import HTTP_METHODS | ||||||
| from sanic.errorpages import check_error_format | from sanic.errorpages import check_error_format | ||||||
| from sanic.exceptions import MethodNotAllowed, NotFound, SanicException | from sanic.exceptions import MethodNotSupported, NotFound, SanicException | ||||||
| from sanic.handlers import RequestHandler |  | ||||||
| from sanic.models.handler_types import RouteHandler | from sanic.models.handler_types import RouteHandler | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -32,11 +33,9 @@ class Router(BaseRouter): | |||||||
|  |  | ||||||
|     def _get( |     def _get( | ||||||
|         self, path: str, method: str, host: Optional[str] |         self, path: str, method: str, host: Optional[str] | ||||||
|     ) -> Tuple[Route, RequestHandler, Dict[str, Any]]: |     ) -> Tuple[Route, RouteHandler, Dict[str, Any]]: | ||||||
|         try: |         try: | ||||||
|             # We know this will always be RequestHandler, so we can ignore |             return self.resolve( | ||||||
|             # typing issue here |  | ||||||
|             return self.resolve(  # type: ignore |  | ||||||
|                 path=path, |                 path=path, | ||||||
|                 method=method, |                 method=method, | ||||||
|                 extra={"host": host} if host else None, |                 extra={"host": host} if host else None, | ||||||
| @@ -44,7 +43,7 @@ class Router(BaseRouter): | |||||||
|         except RoutingNotFound as e: |         except RoutingNotFound as e: | ||||||
|             raise NotFound("Requested URL {} not found".format(e.path)) |             raise NotFound("Requested URL {} not found".format(e.path)) | ||||||
|         except NoMethod as e: |         except NoMethod as e: | ||||||
|             raise MethodNotAllowed( |             raise MethodNotSupported( | ||||||
|                 "Method {} not allowed for URL {}".format(method, path), |                 "Method {} not allowed for URL {}".format(method, path), | ||||||
|                 method=method, |                 method=method, | ||||||
|                 allowed_methods=e.allowed_methods, |                 allowed_methods=e.allowed_methods, | ||||||
| @@ -53,7 +52,7 @@ class Router(BaseRouter): | |||||||
|     @lru_cache(maxsize=ROUTER_CACHE_SIZE) |     @lru_cache(maxsize=ROUTER_CACHE_SIZE) | ||||||
|     def get(  # type: ignore |     def get(  # type: ignore | ||||||
|         self, path: str, method: str, host: Optional[str] |         self, path: str, method: str, host: Optional[str] | ||||||
|     ) -> Tuple[Route, RequestHandler, Dict[str, Any]]: |     ) -> Tuple[Route, RouteHandler, Dict[str, Any]]: | ||||||
|         """ |         """ | ||||||
|         Retrieve a `Route` object containing the details about how to handle |         Retrieve a `Route` object containing the details about how to handle | ||||||
|         a response for a given request |         a response for a given request | ||||||
| @@ -62,7 +61,7 @@ class Router(BaseRouter): | |||||||
|         :type request: Request |         :type request: Request | ||||||
|         :return: details needed for handling the request and returning the |         :return: details needed for handling the request and returning the | ||||||
|             correct response |             correct response | ||||||
|         :rtype: Tuple[ Route, RequestHandler, Dict[str, Any]] |         :rtype: Tuple[ Route, RouteHandler, Dict[str, Any]] | ||||||
|         """ |         """ | ||||||
|         return self._get(path, method, host) |         return self._get(path, method, host) | ||||||
|  |  | ||||||
| @@ -117,7 +116,7 @@ class Router(BaseRouter): | |||||||
|  |  | ||||||
|         params = dict( |         params = dict( | ||||||
|             path=uri, |             path=uri, | ||||||
|             handler=RequestHandler(handler, [], []), |             handler=handler, | ||||||
|             methods=frozenset(map(str, methods)) if methods else None, |             methods=frozenset(map(str, methods)) if methods else None, | ||||||
|             name=name, |             name=name, | ||||||
|             strict=strict_slashes, |             strict=strict_slashes, | ||||||
|   | |||||||
| @@ -5,6 +5,7 @@ import asyncio | |||||||
| from typing import TYPE_CHECKING | from typing import TYPE_CHECKING | ||||||
|  |  | ||||||
| from sanic.exceptions import SanicException | from sanic.exceptions import SanicException | ||||||
|  | from sanic.log import deprecation | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING: | ||||||
| @@ -34,6 +35,15 @@ class AsyncioServer: | |||||||
|         self.serve_coro = serve_coro |         self.serve_coro = serve_coro | ||||||
|         self.server = None |         self.server = None | ||||||
|  |  | ||||||
|  |     @property | ||||||
|  |     def init(self): | ||||||
|  |         deprecation( | ||||||
|  |             "AsyncioServer.init has been deprecated and will be removed " | ||||||
|  |             "in v22.6. Use Sanic.state.is_started instead.", | ||||||
|  |             22.6, | ||||||
|  |         ) | ||||||
|  |         return self.app.state.is_started | ||||||
|  |  | ||||||
|     def startup(self): |     def startup(self): | ||||||
|         """ |         """ | ||||||
|         Trigger "before_server_start" events |         Trigger "before_server_start" events | ||||||
|   | |||||||
| @@ -1,18 +1,8 @@ | |||||||
| from __future__ import annotations |  | ||||||
|  |  | ||||||
| from inspect import isawaitable | from inspect import isawaitable | ||||||
| from typing import TYPE_CHECKING, Any, Callable, Iterable, Optional | from typing import Any, Callable, Iterable, Optional | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | def trigger_events(events: Optional[Iterable[Callable[..., Any]]], loop): | ||||||
|     from sanic import Sanic |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def trigger_events( |  | ||||||
|     events: Optional[Iterable[Callable[..., Any]]], |  | ||||||
|     loop, |  | ||||||
|     app: Optional[Sanic] = None, |  | ||||||
| ): |  | ||||||
|     """ |     """ | ||||||
|     Trigger event callbacks (functions or async) |     Trigger event callbacks (functions or async) | ||||||
|  |  | ||||||
| @@ -21,9 +11,6 @@ def trigger_events( | |||||||
|     """ |     """ | ||||||
|     if events: |     if events: | ||||||
|         for event in events: |         for event in events: | ||||||
|             try: |             result = event(loop) | ||||||
|                 result = event() if not app else event(app) |  | ||||||
|             except TypeError: |  | ||||||
|                 result = event(loop) if not app else event(app, loop) |  | ||||||
|             if isawaitable(result): |             if isawaitable(result): | ||||||
|                 loop.run_until_complete(result) |                 loop.run_until_complete(result) | ||||||
|   | |||||||
| @@ -1,13 +1,26 @@ | |||||||
| import asyncio | import asyncio | ||||||
| import sys |  | ||||||
|  |  | ||||||
| from distutils.util import strtobool |  | ||||||
| from os import getenv | from os import getenv | ||||||
|  |  | ||||||
| from sanic.compat import OS_IS_WINDOWS | from sanic.compat import OS_IS_WINDOWS | ||||||
| from sanic.log import error_logger | from sanic.log import error_logger | ||||||
|  |  | ||||||
|  |  | ||||||
|  | def strtobool(query: str) -> bool: | ||||||
|  |     """ | ||||||
|  |     reimplement strtobool per PEP 632 and python 3.12 deprecation | ||||||
|  |  | ||||||
|  |     True values are y, yes, t, true, on and 1; false values are n, no, f, | ||||||
|  |     false, off and 0. Raises ValueError if val is anything else. | ||||||
|  |     """ | ||||||
|  |     if query.lower() in ["y", "yes", "t", "true", "on", "1"]: | ||||||
|  |         return True | ||||||
|  |     elif query.lower() in ["n", "no", "f", "false", "off", "0"]: | ||||||
|  |         return False | ||||||
|  |     else: | ||||||
|  |         raise ValueError(f"String value {query} cannot be converted to bool") | ||||||
|  |  | ||||||
|  |  | ||||||
| def try_use_uvloop() -> None: | def try_use_uvloop() -> None: | ||||||
|     """ |     """ | ||||||
|     Use uvloop instead of the default asyncio loop. |     Use uvloop instead of the default asyncio loop. | ||||||
| @@ -48,19 +61,3 @@ def try_use_uvloop() -> None: | |||||||
|  |  | ||||||
|     if not isinstance(asyncio.get_event_loop_policy(), uvloop.EventLoopPolicy): |     if not isinstance(asyncio.get_event_loop_policy(), uvloop.EventLoopPolicy): | ||||||
|         asyncio.set_event_loop_policy(uvloop.EventLoopPolicy()) |         asyncio.set_event_loop_policy(uvloop.EventLoopPolicy()) | ||||||
|  |  | ||||||
|  |  | ||||||
| def try_windows_loop(): |  | ||||||
|     if not OS_IS_WINDOWS: |  | ||||||
|         error_logger.warning( |  | ||||||
|             "You are trying to use an event loop policy that is not " |  | ||||||
|             "compatible with your system. You can simply let Sanic handle " |  | ||||||
|             "selecting the best loop for you. Sanic will now continue to run " |  | ||||||
|             "using the default event loop." |  | ||||||
|         ) |  | ||||||
|         return |  | ||||||
|  |  | ||||||
|     if sys.version_info >= (3, 8) and not isinstance( |  | ||||||
|         asyncio.get_event_loop_policy(), asyncio.WindowsSelectorEventLoopPolicy |  | ||||||
|     ): |  | ||||||
|         asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) |  | ||||||
|   | |||||||
| @@ -2,14 +2,13 @@ from __future__ import annotations | |||||||
|  |  | ||||||
| from typing import TYPE_CHECKING, Optional | from typing import TYPE_CHECKING, Optional | ||||||
|  |  | ||||||
| from sanic.exceptions import RequestCancelled |  | ||||||
|  |  | ||||||
|  | if TYPE_CHECKING:  # no cov | ||||||
| if TYPE_CHECKING: |  | ||||||
|     from sanic.app import Sanic |     from sanic.app import Sanic | ||||||
|  |  | ||||||
| import asyncio | import asyncio | ||||||
|  |  | ||||||
|  | from asyncio import CancelledError | ||||||
| from asyncio.transports import Transport | from asyncio.transports import Transport | ||||||
| from time import monotonic as current_time | from time import monotonic as current_time | ||||||
|  |  | ||||||
| @@ -70,7 +69,7 @@ class SanicProtocol(asyncio.Protocol): | |||||||
|         """ |         """ | ||||||
|         await self._can_write.wait() |         await self._can_write.wait() | ||||||
|         if self.transport.is_closing(): |         if self.transport.is_closing(): | ||||||
|             raise RequestCancelled |             raise CancelledError | ||||||
|         self.transport.write(data) |         self.transport.write(data) | ||||||
|         self._time = current_time() |         self._time = current_time() | ||||||
|  |  | ||||||
| @@ -121,7 +120,6 @@ class SanicProtocol(asyncio.Protocol): | |||||||
|         try: |         try: | ||||||
|             self.connections.discard(self) |             self.connections.discard(self) | ||||||
|             self.resume_writing() |             self.resume_writing() | ||||||
|             self.conn_info.lost = True |  | ||||||
|             if self._task: |             if self._task: | ||||||
|                 self._task.cancel() |                 self._task.cancel() | ||||||
|         except BaseException: |         except BaseException: | ||||||
|   | |||||||
| @@ -2,94 +2,33 @@ from __future__ import annotations | |||||||
|  |  | ||||||
| from typing import TYPE_CHECKING, Optional | from typing import TYPE_CHECKING, Optional | ||||||
|  |  | ||||||
| from sanic.handlers import RequestManager |  | ||||||
| from sanic.http.constants import HTTP |  | ||||||
| from sanic.http.http3 import Http3 |  | ||||||
| from sanic.touchup.meta import TouchUpMeta | from sanic.touchup.meta import TouchUpMeta | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic.app import Sanic |     from sanic.app import Sanic | ||||||
|  |  | ||||||
| import sys |  | ||||||
|  |  | ||||||
| from asyncio import CancelledError | from asyncio import CancelledError | ||||||
| from time import monotonic as current_time | from time import monotonic as current_time | ||||||
|  |  | ||||||
| from sanic.exceptions import ( | from sanic.exceptions import RequestTimeout, ServiceUnavailable | ||||||
|     RequestCancelled, |  | ||||||
|     RequestTimeout, |  | ||||||
|     ServiceUnavailable, |  | ||||||
| ) |  | ||||||
| from sanic.http import Http, Stage | from sanic.http import Http, Stage | ||||||
| from sanic.log import Colors, error_logger, logger | from sanic.log import error_logger, logger | ||||||
| from sanic.models.server_types import ConnInfo | from sanic.models.server_types import ConnInfo | ||||||
| from sanic.request import Request | from sanic.request import Request | ||||||
| from sanic.server.protocols.base_protocol import SanicProtocol | from sanic.server.protocols.base_protocol import SanicProtocol | ||||||
|  |  | ||||||
|  |  | ||||||
| ConnectionProtocol = type("ConnectionProtocol", (), {}) | class HttpProtocol(SanicProtocol, metaclass=TouchUpMeta): | ||||||
| try: |  | ||||||
|     from aioquic.asyncio import QuicConnectionProtocol |  | ||||||
|     from aioquic.h3.connection import H3_ALPN, H3Connection |  | ||||||
|     from aioquic.quic.events import ( |  | ||||||
|         DatagramFrameReceived, |  | ||||||
|         ProtocolNegotiated, |  | ||||||
|         QuicEvent, |  | ||||||
|     ) |  | ||||||
|  |  | ||||||
|     ConnectionProtocol = QuicConnectionProtocol |  | ||||||
| except ModuleNotFoundError:  # no cov |  | ||||||
|     ... |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class HttpProtocolMixin: |  | ||||||
|     __slots__ = () |  | ||||||
|     __version__: HTTP |  | ||||||
|  |  | ||||||
|     def _setup_connection(self, *args, **kwargs): |  | ||||||
|         self._http = self.HTTP_CLASS(self, *args, **kwargs) |  | ||||||
|         self._time = current_time() |  | ||||||
|         try: |  | ||||||
|             self.check_timeouts() |  | ||||||
|         except AttributeError: |  | ||||||
|             ... |  | ||||||
|  |  | ||||||
|     def _setup(self): |  | ||||||
|         self.request: Optional[Request] = None |  | ||||||
|         self.access_log = self.app.config.ACCESS_LOG |  | ||||||
|         self.request_handler = RequestManager |  | ||||||
|         self.error_handler = self.app.error_handler |  | ||||||
|         self.request_timeout = self.app.config.REQUEST_TIMEOUT |  | ||||||
|         self.response_timeout = self.app.config.RESPONSE_TIMEOUT |  | ||||||
|         self.keep_alive_timeout = self.app.config.KEEP_ALIVE_TIMEOUT |  | ||||||
|         self.request_max_size = self.app.config.REQUEST_MAX_SIZE |  | ||||||
|         self.request_class = self.app.request_class or Request |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def http(self): |  | ||||||
|         if not hasattr(self, "_http"): |  | ||||||
|             return None |  | ||||||
|         return self._http |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def version(self): |  | ||||||
|         return self.__class__.__version__ |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class HttpProtocol(HttpProtocolMixin, SanicProtocol, metaclass=TouchUpMeta): |  | ||||||
|     """ |     """ | ||||||
|     This class provides implements the HTTP 1.1 protocol on top of our |     This class provides implements the HTTP 1.1 protocol on top of our | ||||||
|     Sanic Server transport |     Sanic Server transport | ||||||
|     """ |     """ | ||||||
|  |  | ||||||
|     HTTP_CLASS = Http |  | ||||||
|  |  | ||||||
|     __touchup__ = ( |     __touchup__ = ( | ||||||
|         "send", |         "send", | ||||||
|         "connection_task", |         "connection_task", | ||||||
|     ) |     ) | ||||||
|     __version__ = HTTP.VERSION_1 |  | ||||||
|     __slots__ = ( |     __slots__ = ( | ||||||
|         # request params |         # request params | ||||||
|         "request", |         "request", | ||||||
| @@ -131,12 +70,25 @@ class HttpProtocol(HttpProtocolMixin, SanicProtocol, metaclass=TouchUpMeta): | |||||||
|             unix=unix, |             unix=unix, | ||||||
|         ) |         ) | ||||||
|         self.url = None |         self.url = None | ||||||
|  |         self.request: Optional[Request] = None | ||||||
|  |         self.access_log = self.app.config.ACCESS_LOG | ||||||
|  |         self.request_handler = self.app.handle_request | ||||||
|  |         self.error_handler = self.app.error_handler | ||||||
|  |         self.request_timeout = self.app.config.REQUEST_TIMEOUT | ||||||
|  |         self.response_timeout = self.app.config.RESPONSE_TIMEOUT | ||||||
|  |         self.keep_alive_timeout = self.app.config.KEEP_ALIVE_TIMEOUT | ||||||
|  |         self.request_max_size = self.app.config.REQUEST_MAX_SIZE | ||||||
|  |         self.request_class = self.app.request_class or Request | ||||||
|         self.state = state if state else {} |         self.state = state if state else {} | ||||||
|         self._setup() |  | ||||||
|         if "requests_count" not in self.state: |         if "requests_count" not in self.state: | ||||||
|             self.state["requests_count"] = 0 |             self.state["requests_count"] = 0 | ||||||
|         self._exception = None |         self._exception = None | ||||||
|  |  | ||||||
|  |     def _setup_connection(self): | ||||||
|  |         self._http = Http(self) | ||||||
|  |         self._time = current_time() | ||||||
|  |         self.check_timeouts() | ||||||
|  |  | ||||||
|     async def connection_task(self):  # no cov |     async def connection_task(self):  # no cov | ||||||
|         """ |         """ | ||||||
|         Run a HTTP connection. |         Run a HTTP connection. | ||||||
| @@ -217,10 +169,7 @@ class HttpProtocol(HttpProtocolMixin, SanicProtocol, metaclass=TouchUpMeta): | |||||||
|                 ) |                 ) | ||||||
|                 self.loop.call_later(max(0.1, interval), self.check_timeouts) |                 self.loop.call_later(max(0.1, interval), self.check_timeouts) | ||||||
|                 return |                 return | ||||||
|             cancel_msg_args = () |             self._task.cancel() | ||||||
|             if sys.version_info >= (3, 9): |  | ||||||
|                 cancel_msg_args = ("Cancel connection task with a timeout",) |  | ||||||
|             self._task.cancel(*cancel_msg_args) |  | ||||||
|         except Exception: |         except Exception: | ||||||
|             error_logger.exception("protocol.check_timeouts") |             error_logger.exception("protocol.check_timeouts") | ||||||
|  |  | ||||||
| @@ -230,7 +179,7 @@ class HttpProtocol(HttpProtocolMixin, SanicProtocol, metaclass=TouchUpMeta): | |||||||
|         """ |         """ | ||||||
|         await self._can_write.wait() |         await self._can_write.wait() | ||||||
|         if self.transport.is_closing(): |         if self.transport.is_closing(): | ||||||
|             raise RequestCancelled |             raise CancelledError | ||||||
|         await self.app.dispatch( |         await self.app.dispatch( | ||||||
|             "http.lifecycle.send", |             "http.lifecycle.send", | ||||||
|             inline=True, |             inline=True, | ||||||
| @@ -270,6 +219,7 @@ class HttpProtocol(HttpProtocolMixin, SanicProtocol, metaclass=TouchUpMeta): | |||||||
|             error_logger.exception("protocol.connect_made") |             error_logger.exception("protocol.connect_made") | ||||||
|  |  | ||||||
|     def data_received(self, data: bytes): |     def data_received(self, data: bytes): | ||||||
|  |  | ||||||
|         try: |         try: | ||||||
|             self._time = current_time() |             self._time = current_time() | ||||||
|             if not data: |             if not data: | ||||||
| @@ -286,39 +236,3 @@ class HttpProtocol(HttpProtocolMixin, SanicProtocol, metaclass=TouchUpMeta): | |||||||
|                 self._data_received.set() |                 self._data_received.set() | ||||||
|         except Exception: |         except Exception: | ||||||
|             error_logger.exception("protocol.data_received") |             error_logger.exception("protocol.data_received") | ||||||
|  |  | ||||||
|  |  | ||||||
| class Http3Protocol(HttpProtocolMixin, ConnectionProtocol):  # type: ignore |  | ||||||
|     HTTP_CLASS = Http3 |  | ||||||
|     __version__ = HTTP.VERSION_3 |  | ||||||
|  |  | ||||||
|     def __init__(self, *args, app: Sanic, **kwargs) -> None: |  | ||||||
|         self.app = app |  | ||||||
|         super().__init__(*args, **kwargs) |  | ||||||
|         self._setup() |  | ||||||
|         self._connection: Optional[H3Connection] = None |  | ||||||
|  |  | ||||||
|     def quic_event_received(self, event: QuicEvent) -> None: |  | ||||||
|         logger.debug( |  | ||||||
|             f"{Colors.BLUE}[quic_event_received]: " |  | ||||||
|             f"{Colors.PURPLE}{event}{Colors.END}", |  | ||||||
|             extra={"verbosity": 2}, |  | ||||||
|         ) |  | ||||||
|         if isinstance(event, ProtocolNegotiated): |  | ||||||
|             self._setup_connection(transmit=self.transmit) |  | ||||||
|             if event.alpn_protocol in H3_ALPN: |  | ||||||
|                 self._connection = H3Connection( |  | ||||||
|                     self._quic, enable_webtransport=True |  | ||||||
|                 ) |  | ||||||
|         elif isinstance(event, DatagramFrameReceived): |  | ||||||
|             if event.data == b"quack": |  | ||||||
|                 self._quic.send_datagram_frame(b"quack-ack") |  | ||||||
|  |  | ||||||
|         #  pass event to the HTTP layer |  | ||||||
|         if self._connection is not None: |  | ||||||
|             for http_event in self._connection.handle_event(event): |  | ||||||
|                 self._http.http_event_received(http_event) |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def connection(self) -> Optional[H3Connection]: |  | ||||||
|         return self._connection |  | ||||||
|   | |||||||
| @@ -5,13 +5,13 @@ from websockets.server import ServerConnection | |||||||
| from websockets.typing import Subprotocol | from websockets.typing import Subprotocol | ||||||
|  |  | ||||||
| from sanic.exceptions import ServerError | from sanic.exceptions import ServerError | ||||||
| from sanic.log import logger | from sanic.log import error_logger | ||||||
| from sanic.server import HttpProtocol | from sanic.server import HttpProtocol | ||||||
|  |  | ||||||
| from ..websockets.impl import WebsocketImplProtocol | from ..websockets.impl import WebsocketImplProtocol | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from websockets import http11 |     from websockets import http11 | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -104,7 +104,7 @@ class WebSocketProtocol(HttpProtocol): | |||||||
|                 max_size=self.websocket_max_size, |                 max_size=self.websocket_max_size, | ||||||
|                 subprotocols=subprotocols, |                 subprotocols=subprotocols, | ||||||
|                 state=OPEN, |                 state=OPEN, | ||||||
|                 logger=logger, |                 logger=error_logger, | ||||||
|             ) |             ) | ||||||
|             resp: "http11.Response" = ws_conn.accept(request) |             resp: "http11.Response" = ws_conn.accept(request) | ||||||
|         except Exception: |         except Exception: | ||||||
|   | |||||||
| @@ -6,9 +6,6 @@ from ssl import SSLContext | |||||||
| from typing import TYPE_CHECKING, Dict, Optional, Type, Union | from typing import TYPE_CHECKING, Dict, Optional, Type, Union | ||||||
|  |  | ||||||
| from sanic.config import Config | from sanic.config import Config | ||||||
| from sanic.exceptions import ServerError |  | ||||||
| from sanic.http.constants import HTTP |  | ||||||
| from sanic.http.tls import get_ssl_context |  | ||||||
| from sanic.server.events import trigger_events | from sanic.server.events import trigger_events | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -26,11 +23,10 @@ from signal import signal as signal_func | |||||||
|  |  | ||||||
| from sanic.application.ext import setup_ext | from sanic.application.ext import setup_ext | ||||||
| from sanic.compat import OS_IS_WINDOWS, ctrlc_workaround_for_windows | from sanic.compat import OS_IS_WINDOWS, ctrlc_workaround_for_windows | ||||||
| from sanic.http.http3 import SessionTicketStore, get_config |  | ||||||
| from sanic.log import error_logger, logger | from sanic.log import error_logger, logger | ||||||
| from sanic.models.server_types import Signal | from sanic.models.server_types import Signal | ||||||
| from sanic.server.async_server import AsyncioServer | from sanic.server.async_server import AsyncioServer | ||||||
| from sanic.server.protocols.http_protocol import Http3Protocol, HttpProtocol | from sanic.server.protocols.http_protocol import HttpProtocol | ||||||
| from sanic.server.socket import ( | from sanic.server.socket import ( | ||||||
|     bind_socket, |     bind_socket, | ||||||
|     bind_unix_socket, |     bind_unix_socket, | ||||||
| @@ -38,14 +34,6 @@ from sanic.server.socket import ( | |||||||
| ) | ) | ||||||
|  |  | ||||||
|  |  | ||||||
| try: |  | ||||||
|     from aioquic.asyncio import serve as quic_serve |  | ||||||
|  |  | ||||||
|     HTTP3_AVAILABLE = True |  | ||||||
| except ModuleNotFoundError:  # no cov |  | ||||||
|     HTTP3_AVAILABLE = False |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def serve( | def serve( | ||||||
|     host, |     host, | ||||||
|     port, |     port, | ||||||
| @@ -64,7 +52,6 @@ def serve( | |||||||
|     signal=Signal(), |     signal=Signal(), | ||||||
|     state=None, |     state=None, | ||||||
|     asyncio_server_kwargs=None, |     asyncio_server_kwargs=None, | ||||||
|     version=HTTP.VERSION_1, |  | ||||||
| ): | ): | ||||||
|     """Start asynchronous HTTP Server on an individual process. |     """Start asynchronous HTTP Server on an individual process. | ||||||
|  |  | ||||||
| @@ -101,90 +88,6 @@ def serve( | |||||||
|  |  | ||||||
|     app.asgi = False |     app.asgi = False | ||||||
|  |  | ||||||
|     if version is HTTP.VERSION_3: |  | ||||||
|         return _serve_http_3(host, port, app, loop, ssl) |  | ||||||
|     return _serve_http_1( |  | ||||||
|         host, |  | ||||||
|         port, |  | ||||||
|         app, |  | ||||||
|         ssl, |  | ||||||
|         sock, |  | ||||||
|         unix, |  | ||||||
|         reuse_port, |  | ||||||
|         loop, |  | ||||||
|         protocol, |  | ||||||
|         backlog, |  | ||||||
|         register_sys_signals, |  | ||||||
|         run_multiple, |  | ||||||
|         run_async, |  | ||||||
|         connections, |  | ||||||
|         signal, |  | ||||||
|         state, |  | ||||||
|         asyncio_server_kwargs, |  | ||||||
|     ) |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def _setup_system_signals( |  | ||||||
|     app: Sanic, |  | ||||||
|     run_multiple: bool, |  | ||||||
|     register_sys_signals: bool, |  | ||||||
|     loop: asyncio.AbstractEventLoop, |  | ||||||
| ) -> None:  # no cov |  | ||||||
|     # Ignore SIGINT when run_multiple |  | ||||||
|     if run_multiple: |  | ||||||
|         signal_func(SIGINT, SIG_IGN) |  | ||||||
|         os.environ["SANIC_WORKER_PROCESS"] = "true" |  | ||||||
|  |  | ||||||
|     # Register signals for graceful termination |  | ||||||
|     if register_sys_signals: |  | ||||||
|         if OS_IS_WINDOWS: |  | ||||||
|             ctrlc_workaround_for_windows(app) |  | ||||||
|         else: |  | ||||||
|             for _signal in [SIGTERM] if run_multiple else [SIGINT, SIGTERM]: |  | ||||||
|                 loop.add_signal_handler( |  | ||||||
|                     _signal, partial(app.stop, terminate=False) |  | ||||||
|                 ) |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def _run_server_forever(loop, before_stop, after_stop, cleanup, unix): |  | ||||||
|     pid = os.getpid() |  | ||||||
|     try: |  | ||||||
|         logger.info("Starting worker [%s]", pid) |  | ||||||
|         loop.run_forever() |  | ||||||
|     except KeyboardInterrupt: |  | ||||||
|         pass |  | ||||||
|     finally: |  | ||||||
|         logger.info("Stopping worker [%s]", pid) |  | ||||||
|  |  | ||||||
|         loop.run_until_complete(before_stop()) |  | ||||||
|  |  | ||||||
|         if cleanup: |  | ||||||
|             cleanup() |  | ||||||
|  |  | ||||||
|         loop.run_until_complete(after_stop()) |  | ||||||
|         remove_unix_socket(unix) |  | ||||||
|         loop.close() |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def _serve_http_1( |  | ||||||
|     host, |  | ||||||
|     port, |  | ||||||
|     app, |  | ||||||
|     ssl, |  | ||||||
|     sock, |  | ||||||
|     unix, |  | ||||||
|     reuse_port, |  | ||||||
|     loop, |  | ||||||
|     protocol, |  | ||||||
|     backlog, |  | ||||||
|     register_sys_signals, |  | ||||||
|     run_multiple, |  | ||||||
|     run_async, |  | ||||||
|     connections, |  | ||||||
|     signal, |  | ||||||
|     state, |  | ||||||
|     asyncio_server_kwargs, |  | ||||||
| ): |  | ||||||
|     connections = connections if connections is not None else set() |     connections = connections if connections is not None else set() | ||||||
|     protocol_kwargs = _build_protocol_kwargs(protocol, app.config) |     protocol_kwargs = _build_protocol_kwargs(protocol, app.config) | ||||||
|     server = partial( |     server = partial( | ||||||
| @@ -200,12 +103,8 @@ def _serve_http_1( | |||||||
|     asyncio_server_kwargs = ( |     asyncio_server_kwargs = ( | ||||||
|         asyncio_server_kwargs if asyncio_server_kwargs else {} |         asyncio_server_kwargs if asyncio_server_kwargs else {} | ||||||
|     ) |     ) | ||||||
|     if OS_IS_WINDOWS: |  | ||||||
|         pid = os.getpid() |  | ||||||
|         sock = sock.share(pid) |  | ||||||
|         sock = socket.fromshare(sock) |  | ||||||
|     # UNIX sockets are always bound by us (to preserve semantics between modes) |     # UNIX sockets are always bound by us (to preserve semantics between modes) | ||||||
|     elif unix: |     if unix: | ||||||
|         sock = bind_unix_socket(unix, backlog=backlog) |         sock = bind_unix_socket(unix, backlog=backlog) | ||||||
|     server_coroutine = loop.create_server( |     server_coroutine = loop.create_server( | ||||||
|         server, |         server, | ||||||
| @@ -236,7 +135,30 @@ def _serve_http_1( | |||||||
|         error_logger.exception("Unable to start server", exc_info=True) |         error_logger.exception("Unable to start server", exc_info=True) | ||||||
|         return |         return | ||||||
|  |  | ||||||
|     def _cleanup(): |     # Ignore SIGINT when run_multiple | ||||||
|  |     if run_multiple: | ||||||
|  |         signal_func(SIGINT, SIG_IGN) | ||||||
|  |         os.environ["SANIC_WORKER_PROCESS"] = "true" | ||||||
|  |  | ||||||
|  |     # Register signals for graceful termination | ||||||
|  |     if register_sys_signals: | ||||||
|  |         if OS_IS_WINDOWS: | ||||||
|  |             ctrlc_workaround_for_windows(app) | ||||||
|  |         else: | ||||||
|  |             for _signal in [SIGTERM] if run_multiple else [SIGINT, SIGTERM]: | ||||||
|  |                 loop.add_signal_handler(_signal, app.stop) | ||||||
|  |  | ||||||
|  |     loop.run_until_complete(app._server_event("init", "after")) | ||||||
|  |     pid = os.getpid() | ||||||
|  |     try: | ||||||
|  |         logger.info("Starting worker [%s]", pid) | ||||||
|  |         loop.run_forever() | ||||||
|  |     finally: | ||||||
|  |         logger.info("Stopping worker [%s]", pid) | ||||||
|  |  | ||||||
|  |         # Run the on_stop function if provided | ||||||
|  |         loop.run_until_complete(app._server_event("shutdown", "before")) | ||||||
|  |  | ||||||
|         # Wait for event loop to finish and all connections to drain |         # Wait for event loop to finish and all connections to drain | ||||||
|         http_server.close() |         http_server.close() | ||||||
|         loop.run_until_complete(http_server.wait_closed()) |         loop.run_until_complete(http_server.wait_closed()) | ||||||
| @@ -266,55 +188,8 @@ def _serve_http_1( | |||||||
|                 conn.websocket.fail_connection(code=1001) |                 conn.websocket.fail_connection(code=1001) | ||||||
|             else: |             else: | ||||||
|                 conn.abort() |                 conn.abort() | ||||||
|  |         loop.run_until_complete(app._server_event("shutdown", "after")) | ||||||
|     _setup_system_signals(app, run_multiple, register_sys_signals, loop) |         remove_unix_socket(unix) | ||||||
|     loop.run_until_complete(app._server_event("init", "after")) |  | ||||||
|     _run_server_forever( |  | ||||||
|         loop, |  | ||||||
|         partial(app._server_event, "shutdown", "before"), |  | ||||||
|         partial(app._server_event, "shutdown", "after"), |  | ||||||
|         _cleanup, |  | ||||||
|         unix, |  | ||||||
|     ) |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def _serve_http_3( |  | ||||||
|     host, |  | ||||||
|     port, |  | ||||||
|     app, |  | ||||||
|     loop, |  | ||||||
|     ssl, |  | ||||||
|     register_sys_signals: bool = True, |  | ||||||
|     run_multiple: bool = False, |  | ||||||
| ): |  | ||||||
|     if not HTTP3_AVAILABLE: |  | ||||||
|         raise ServerError( |  | ||||||
|             "Cannot run HTTP/3 server without aioquic installed. " |  | ||||||
|         ) |  | ||||||
|     protocol = partial(Http3Protocol, app=app) |  | ||||||
|     ticket_store = SessionTicketStore() |  | ||||||
|     ssl_context = get_ssl_context(app, ssl) |  | ||||||
|     config = get_config(app, ssl_context) |  | ||||||
|     coro = quic_serve( |  | ||||||
|         host, |  | ||||||
|         port, |  | ||||||
|         configuration=config, |  | ||||||
|         create_protocol=protocol, |  | ||||||
|         session_ticket_fetcher=ticket_store.pop, |  | ||||||
|         session_ticket_handler=ticket_store.add, |  | ||||||
|     ) |  | ||||||
|     server = AsyncioServer(app, loop, coro, []) |  | ||||||
|     loop.run_until_complete(server.startup()) |  | ||||||
|     loop.run_until_complete(server.before_start()) |  | ||||||
|     loop.run_until_complete(server) |  | ||||||
|     _setup_system_signals(app, run_multiple, register_sys_signals, loop) |  | ||||||
|     loop.run_until_complete(server.after_start()) |  | ||||||
|  |  | ||||||
|     # TODO: Create connection cleanup and graceful shutdown |  | ||||||
|     cleanup = None |  | ||||||
|     _run_server_forever( |  | ||||||
|         loop, server.before_stop, server.after_stop, cleanup, None |  | ||||||
|     ) |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def serve_single(server_settings): | def serve_single(server_settings): | ||||||
|   | |||||||
| @@ -6,10 +6,7 @@ import socket | |||||||
| import stat | import stat | ||||||
|  |  | ||||||
| from ipaddress import ip_address | from ipaddress import ip_address | ||||||
| from typing import Any, Dict, Optional | from typing import Optional | ||||||
|  |  | ||||||
| from sanic.exceptions import ServerError |  | ||||||
| from sanic.http.constants import HTTP |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def bind_socket(host: str, port: int, *, backlog=100) -> socket.socket: | def bind_socket(host: str, port: int, *, backlog=100) -> socket.socket: | ||||||
| @@ -19,8 +16,6 @@ def bind_socket(host: str, port: int, *, backlog=100) -> socket.socket: | |||||||
|     :param backlog: Maximum number of connections to queue |     :param backlog: Maximum number of connections to queue | ||||||
|     :return: socket.socket object |     :return: socket.socket object | ||||||
|     """ |     """ | ||||||
|     location = (host, port) |  | ||||||
|     # socket.share, socket.fromshare |  | ||||||
|     try:  # IP address: family must be specified for IPv6 at least |     try:  # IP address: family must be specified for IPv6 at least | ||||||
|         ip = ip_address(host) |         ip = ip_address(host) | ||||||
|         host = str(ip) |         host = str(ip) | ||||||
| @@ -30,9 +25,8 @@ def bind_socket(host: str, port: int, *, backlog=100) -> socket.socket: | |||||||
|     except ValueError:  # Hostname, may become AF_INET or AF_INET6 |     except ValueError:  # Hostname, may become AF_INET or AF_INET6 | ||||||
|         sock = socket.socket() |         sock = socket.socket() | ||||||
|     sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) |     sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) | ||||||
|     sock.bind(location) |     sock.bind((host, port)) | ||||||
|     sock.listen(backlog) |     sock.listen(backlog) | ||||||
|     sock.set_inheritable(True) |  | ||||||
|     return sock |     return sock | ||||||
|  |  | ||||||
|  |  | ||||||
| @@ -42,7 +36,7 @@ def bind_unix_socket(path: str, *, mode=0o666, backlog=100) -> socket.socket: | |||||||
|     :param backlog: Maximum number of connections to queue |     :param backlog: Maximum number of connections to queue | ||||||
|     :return: socket.socket object |     :return: socket.socket object | ||||||
|     """ |     """ | ||||||
|  |     """Open or atomically replace existing socket with zero downtime.""" | ||||||
|     # Sanitise and pre-verify socket path |     # Sanitise and pre-verify socket path | ||||||
|     path = os.path.abspath(path) |     path = os.path.abspath(path) | ||||||
|     folder = os.path.dirname(path) |     folder = os.path.dirname(path) | ||||||
| @@ -91,37 +85,3 @@ def remove_unix_socket(path: Optional[str]) -> None: | |||||||
|                     os.unlink(path) |                     os.unlink(path) | ||||||
|     except FileNotFoundError: |     except FileNotFoundError: | ||||||
|         pass |         pass | ||||||
|  |  | ||||||
|  |  | ||||||
| def configure_socket( |  | ||||||
|     server_settings: Dict[str, Any] |  | ||||||
| ) -> Optional[socket.SocketType]: |  | ||||||
|     # Create a listening socket or use the one in settings |  | ||||||
|     if server_settings.get("version") is HTTP.VERSION_3: |  | ||||||
|         return None |  | ||||||
|     sock = server_settings.get("sock") |  | ||||||
|     unix = server_settings["unix"] |  | ||||||
|     backlog = server_settings["backlog"] |  | ||||||
|     if unix: |  | ||||||
|         sock = bind_unix_socket(unix, backlog=backlog) |  | ||||||
|         server_settings["unix"] = unix |  | ||||||
|     if sock is None: |  | ||||||
|         try: |  | ||||||
|             sock = bind_socket( |  | ||||||
|                 server_settings["host"], |  | ||||||
|                 server_settings["port"], |  | ||||||
|                 backlog=backlog, |  | ||||||
|             ) |  | ||||||
|         except OSError as e:  # no cov |  | ||||||
|             raise ServerError( |  | ||||||
|                 f"Sanic server could not start: {e}.\n" |  | ||||||
|                 "This may have happened if you are running Sanic in the " |  | ||||||
|                 "global scope and not inside of a " |  | ||||||
|                 '`if __name__ == "__main__"` block. See more information: ' |  | ||||||
|                 "____." |  | ||||||
|             ) from e |  | ||||||
|         sock.set_inheritable(True) |  | ||||||
|         server_settings["sock"] = sock |  | ||||||
|         server_settings["host"] = None |  | ||||||
|         server_settings["port"] = None |  | ||||||
|     return sock |  | ||||||
|   | |||||||
| @@ -9,7 +9,7 @@ from websockets.typing import Data | |||||||
| from sanic.exceptions import ServerError | from sanic.exceptions import ServerError | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from .impl import WebsocketImplProtocol |     from .impl import WebsocketImplProtocol | ||||||
|  |  | ||||||
| UTF8Decoder = codecs.getincrementaldecoder("utf-8") | UTF8Decoder = codecs.getincrementaldecoder("utf-8") | ||||||
| @@ -37,7 +37,7 @@ class WebsocketFrameAssembler: | |||||||
|         "get_id", |         "get_id", | ||||||
|         "put_id", |         "put_id", | ||||||
|     ) |     ) | ||||||
|     if TYPE_CHECKING: |     if TYPE_CHECKING:  # no cov | ||||||
|         protocol: "WebsocketImplProtocol" |         protocol: "WebsocketImplProtocol" | ||||||
|         read_mutex: asyncio.Lock |         read_mutex: asyncio.Lock | ||||||
|         write_mutex: asyncio.Lock |         write_mutex: asyncio.Lock | ||||||
|   | |||||||
| @@ -252,7 +252,7 @@ class WebsocketImplProtocol: | |||||||
|  |  | ||||||
|     def _force_disconnect(self) -> bool: |     def _force_disconnect(self) -> bool: | ||||||
|         """ |         """ | ||||||
|         Internal method used by end_connection and fail_connection |         Internal methdod used by end_connection and fail_connection | ||||||
|         only when the graceful auto-closer cannot be used |         only when the graceful auto-closer cannot be used | ||||||
|         """ |         """ | ||||||
|         if self.auto_closer_task and not self.auto_closer_task.done(): |         if self.auto_closer_task and not self.auto_closer_task.done(): | ||||||
|   | |||||||
| @@ -6,9 +6,9 @@ from enum import Enum | |||||||
| from inspect import isawaitable | from inspect import isawaitable | ||||||
| from typing import Any, Dict, List, Optional, Tuple, Union, cast | from typing import Any, Dict, List, Optional, Tuple, Union, cast | ||||||
|  |  | ||||||
| from sanic_routing import BaseRouter, Route, RouteGroup | from sanic_routing import BaseRouter, Route, RouteGroup  # type: ignore | ||||||
| from sanic_routing.exceptions import NotFound | from sanic_routing.exceptions import NotFound  # type: ignore | ||||||
| from sanic_routing.utils import path_to_parts | from sanic_routing.utils import path_to_parts  # type: ignore | ||||||
|  |  | ||||||
| from sanic.exceptions import InvalidSignal | from sanic.exceptions import InvalidSignal | ||||||
| from sanic.log import error_logger, logger | from sanic.log import error_logger, logger | ||||||
| @@ -30,8 +30,6 @@ class Event(Enum): | |||||||
|     HTTP_LIFECYCLE_RESPONSE = "http.lifecycle.response" |     HTTP_LIFECYCLE_RESPONSE = "http.lifecycle.response" | ||||||
|     HTTP_ROUTING_AFTER = "http.routing.after" |     HTTP_ROUTING_AFTER = "http.routing.after" | ||||||
|     HTTP_ROUTING_BEFORE = "http.routing.before" |     HTTP_ROUTING_BEFORE = "http.routing.before" | ||||||
|     HTTP_HANDLER_AFTER = "http.handler.after" |  | ||||||
|     HTTP_HANDLER_BEFORE = "http.handler.before" |  | ||||||
|     HTTP_LIFECYCLE_SEND = "http.lifecycle.send" |     HTTP_LIFECYCLE_SEND = "http.lifecycle.send" | ||||||
|     HTTP_MIDDLEWARE_AFTER = "http.middleware.after" |     HTTP_MIDDLEWARE_AFTER = "http.middleware.after" | ||||||
|     HTTP_MIDDLEWARE_BEFORE = "http.middleware.before" |     HTTP_MIDDLEWARE_BEFORE = "http.middleware.before" | ||||||
| @@ -55,8 +53,6 @@ RESERVED_NAMESPACES = { | |||||||
|         Event.HTTP_LIFECYCLE_RESPONSE.value, |         Event.HTTP_LIFECYCLE_RESPONSE.value, | ||||||
|         Event.HTTP_ROUTING_AFTER.value, |         Event.HTTP_ROUTING_AFTER.value, | ||||||
|         Event.HTTP_ROUTING_BEFORE.value, |         Event.HTTP_ROUTING_BEFORE.value, | ||||||
|         Event.HTTP_HANDLER_AFTER.value, |  | ||||||
|         Event.HTTP_HANDLER_BEFORE.value, |  | ||||||
|         Event.HTTP_LIFECYCLE_SEND.value, |         Event.HTTP_LIFECYCLE_SEND.value, | ||||||
|         Event.HTTP_MIDDLEWARE_AFTER.value, |         Event.HTTP_MIDDLEWARE_AFTER.value, | ||||||
|         Event.HTTP_MIDDLEWARE_BEFORE.value, |         Event.HTTP_MIDDLEWARE_BEFORE.value, | ||||||
| @@ -84,7 +80,6 @@ class SignalRouter(BaseRouter): | |||||||
|             group_class=SignalGroup, |             group_class=SignalGroup, | ||||||
|             stacking=True, |             stacking=True, | ||||||
|         ) |         ) | ||||||
|         self.allow_fail_builtin = True |  | ||||||
|         self.ctx.loop = None |         self.ctx.loop = None | ||||||
|  |  | ||||||
|     def get(  # type: ignore |     def get(  # type: ignore | ||||||
| @@ -134,8 +129,7 @@ class SignalRouter(BaseRouter): | |||||||
|         try: |         try: | ||||||
|             group, handlers, params = self.get(event, condition=condition) |             group, handlers, params = self.get(event, condition=condition) | ||||||
|         except NotFound as e: |         except NotFound as e: | ||||||
|             is_reserved = event.split(".", 1)[0] in RESERVED_NAMESPACES |             if fail_not_found: | ||||||
|             if fail_not_found and (not is_reserved or self.allow_fail_builtin): |  | ||||||
|                 raise e |                 raise e | ||||||
|             else: |             else: | ||||||
|                 if self.ctx.app.debug and self.ctx.app.state.verbosity >= 1: |                 if self.ctx.app.debug and self.ctx.app.state.verbosity >= 1: | ||||||
| @@ -154,13 +148,13 @@ class SignalRouter(BaseRouter): | |||||||
|         try: |         try: | ||||||
|             for signal in signals: |             for signal in signals: | ||||||
|                 params.pop("__trigger__", None) |                 params.pop("__trigger__", None) | ||||||
|                 requirements = getattr( |  | ||||||
|                     signal.handler, "__requirements__", None |  | ||||||
|                 ) |  | ||||||
|                 if ( |                 if ( | ||||||
|                     (condition is None and signal.ctx.exclusive is False) |                     (condition is None and signal.ctx.exclusive is False) | ||||||
|                     or (condition is None and not requirements) |                     or ( | ||||||
|                     or (condition == requirements) |                         condition is None | ||||||
|  |                         and not signal.handler.__requirements__ | ||||||
|  |                     ) | ||||||
|  |                     or (condition == signal.handler.__requirements__) | ||||||
|                 ) and (signal.ctx.trigger or event == signal.ctx.definition): |                 ) and (signal.ctx.trigger or event == signal.ctx.definition): | ||||||
|                     maybe_coroutine = signal.handler(**params) |                     maybe_coroutine = signal.handler(**params) | ||||||
|                     if isawaitable(maybe_coroutine): |                     if isawaitable(maybe_coroutine): | ||||||
| @@ -191,7 +185,7 @@ class SignalRouter(BaseRouter): | |||||||
|             fail_not_found=fail_not_found and inline, |             fail_not_found=fail_not_found and inline, | ||||||
|             reverse=reverse, |             reverse=reverse, | ||||||
|         ) |         ) | ||||||
|         logger.debug(f"Dispatching signal: {event}", extra={"verbosity": 1}) |         logger.debug(f"Dispatching signal: {event}") | ||||||
|  |  | ||||||
|         if inline: |         if inline: | ||||||
|             return await dispatch |             return await dispatch | ||||||
|   | |||||||
| @@ -1,9 +1,7 @@ | |||||||
| from __future__ import annotations |  | ||||||
| 
 |  | ||||||
| import os | import os | ||||||
| import ssl | import ssl | ||||||
| 
 | 
 | ||||||
| from typing import Any, Dict, Iterable, Optional, Union | from typing import Iterable, Optional, Union | ||||||
| 
 | 
 | ||||||
| from sanic.log import logger | from sanic.log import logger | ||||||
| 
 | 
 | ||||||
| @@ -79,6 +77,65 @@ def load_cert_dir(p: str) -> ssl.SSLContext: | |||||||
|     return CertSimple(certfile, keyfile) |     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): | def find_cert(self: CertSelector, server_name: str): | ||||||
|     """Find the first certificate that matches the given SNI. |     """Find the first certificate that matches the given SNI. | ||||||
| 
 | 
 | ||||||
| @@ -137,73 +194,3 @@ def server_name_callback( | |||||||
| ) -> None: | ) -> None: | ||||||
|     """Store the received SNI as sslobj.sanic_server_name.""" |     """Store the received SNI as sslobj.sanic_server_name.""" | ||||||
|     sslobj.sanic_server_name = server_name  # type: ignore |     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)}") |  | ||||||
| @@ -1,4 +1,3 @@ | |||||||
| from .altsvc import AltSvcCheck  # noqa |  | ||||||
| from .base import BaseScheme | from .base import BaseScheme | ||||||
| from .ode import OptionalDispatchEvent  # noqa | from .ode import OptionalDispatchEvent  # noqa | ||||||
|  |  | ||||||
|   | |||||||
| @@ -1,56 +0,0 @@ | |||||||
| from __future__ import annotations |  | ||||||
|  |  | ||||||
| from ast import Assign, Constant, NodeTransformer, Subscript |  | ||||||
| from typing import TYPE_CHECKING, Any, List |  | ||||||
|  |  | ||||||
| from sanic.http.constants import HTTP |  | ||||||
|  |  | ||||||
| from .base import BaseScheme |  | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: |  | ||||||
|     from sanic import Sanic |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class AltSvcCheck(BaseScheme): |  | ||||||
|     ident = "ALTSVC" |  | ||||||
|  |  | ||||||
|     def visitors(self) -> List[NodeTransformer]: |  | ||||||
|         return [RemoveAltSvc(self.app, self.app.state.verbosity)] |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class RemoveAltSvc(NodeTransformer): |  | ||||||
|     def __init__(self, app: Sanic, verbosity: int = 0) -> None: |  | ||||||
|         self._app = app |  | ||||||
|         self._verbosity = verbosity |  | ||||||
|         self._versions = { |  | ||||||
|             info.settings["version"] for info in app.state.server_info |  | ||||||
|         } |  | ||||||
|  |  | ||||||
|     def visit_Assign(self, node: Assign) -> Any: |  | ||||||
|         if any(self._matches(target) for target in node.targets): |  | ||||||
|             if self._should_remove(): |  | ||||||
|                 return None |  | ||||||
|             assert isinstance(node.value, Constant) |  | ||||||
|             node.value.value = self.value() |  | ||||||
|         return node |  | ||||||
|  |  | ||||||
|     def _should_remove(self) -> bool: |  | ||||||
|         return len(self._versions) == 1 |  | ||||||
|  |  | ||||||
|     @staticmethod |  | ||||||
|     def _matches(node) -> bool: |  | ||||||
|         return ( |  | ||||||
|             isinstance(node, Subscript) |  | ||||||
|             and isinstance(node.slice, Constant) |  | ||||||
|             and node.slice.value == "alt-svc" |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     def value(self): |  | ||||||
|         values = [] |  | ||||||
|         for info in self._app.state.server_info: |  | ||||||
|             port = info.settings["port"] |  | ||||||
|             version = info.settings["version"] |  | ||||||
|             if version is HTTP.VERSION_3: |  | ||||||
|                 values.append(f'h3=":{port}"') |  | ||||||
|         return ", ".join(values) |  | ||||||
| @@ -1,8 +1,5 @@ | |||||||
| from abc import ABC, abstractmethod | from abc import ABC, abstractmethod | ||||||
| from ast import NodeTransformer, parse | from typing import Set, Type | ||||||
| from inspect import getsource |  | ||||||
| from textwrap import dedent |  | ||||||
| from typing import Any, Dict, List, Set, Type |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class BaseScheme(ABC): | class BaseScheme(ABC): | ||||||
| @@ -13,26 +10,11 @@ class BaseScheme(ABC): | |||||||
|         self.app = app |         self.app = app | ||||||
|  |  | ||||||
|     @abstractmethod |     @abstractmethod | ||||||
|     def visitors(self) -> List[NodeTransformer]: |     def run(self, method, module_globals) -> None: | ||||||
|         ... |         ... | ||||||
|  |  | ||||||
|     def __init_subclass__(cls): |     def __init_subclass__(cls): | ||||||
|         BaseScheme._registry.add(cls) |         BaseScheme._registry.add(cls) | ||||||
|  |  | ||||||
|     def __call__(self): |     def __call__(self, method, module_globals): | ||||||
|         return self.visitors() |         return self.run(method, module_globals) | ||||||
|  |  | ||||||
|     @classmethod |  | ||||||
|     def build(cls, method, module_globals, app): |  | ||||||
|         raw_source = getsource(method) |  | ||||||
|         src = dedent(raw_source) |  | ||||||
|         node = parse(src) |  | ||||||
|  |  | ||||||
|         for scheme in cls._registry: |  | ||||||
|             for visitor in scheme(app)(): |  | ||||||
|                 node = visitor.visit(node) |  | ||||||
|  |  | ||||||
|         compiled_src = compile(node, method.__name__, "exec") |  | ||||||
|         exec_locals: Dict[str, Any] = {} |  | ||||||
|         exec(compiled_src, module_globals, exec_locals)  # nosec |  | ||||||
|         return exec_locals[method.__name__] |  | ||||||
|   | |||||||
| @@ -1,5 +1,7 @@ | |||||||
| from ast import Attribute, Await, Expr, NodeTransformer | from ast import Attribute, Await, Dict, Expr, NodeTransformer, parse | ||||||
| from typing import Any, List | from inspect import getsource | ||||||
|  | from textwrap import dedent | ||||||
|  | from typing import Any | ||||||
|  |  | ||||||
| from sanic.log import logger | from sanic.log import logger | ||||||
|  |  | ||||||
| @@ -18,8 +20,18 @@ class OptionalDispatchEvent(BaseScheme): | |||||||
|             signal.name for signal in app.signal_router.routes |             signal.name for signal in app.signal_router.routes | ||||||
|         ] |         ] | ||||||
|  |  | ||||||
|     def visitors(self) -> List[NodeTransformer]: |     def run(self, method, module_globals): | ||||||
|         return [RemoveDispatch(self._registered_events)] |         raw_source = getsource(method) | ||||||
|  |         src = dedent(raw_source) | ||||||
|  |         tree = parse(src) | ||||||
|  |         node = RemoveDispatch( | ||||||
|  |             self._registered_events, self.app.state.verbosity | ||||||
|  |         ).visit(tree) | ||||||
|  |         compiled_src = compile(node, method.__name__, "exec") | ||||||
|  |         exec_locals: Dict[str, Any] = {} | ||||||
|  |         exec(compiled_src, module_globals, exec_locals)  # nosec | ||||||
|  |  | ||||||
|  |         return exec_locals[method.__name__] | ||||||
|  |  | ||||||
|     def _sync_events(self): |     def _sync_events(self): | ||||||
|         all_events = set() |         all_events = set() | ||||||
| @@ -52,8 +64,9 @@ class OptionalDispatchEvent(BaseScheme): | |||||||
|  |  | ||||||
|  |  | ||||||
| class RemoveDispatch(NodeTransformer): | class RemoveDispatch(NodeTransformer): | ||||||
|     def __init__(self, registered_events) -> None: |     def __init__(self, registered_events, verbosity: int = 0) -> None: | ||||||
|         self._registered_events = registered_events |         self._registered_events = registered_events | ||||||
|  |         self._verbosity = verbosity | ||||||
|  |  | ||||||
|     def visit_Expr(self, node: Expr) -> Any: |     def visit_Expr(self, node: Expr) -> Any: | ||||||
|         call = node.value |         call = node.value | ||||||
| @@ -70,10 +83,8 @@ class RemoveDispatch(NodeTransformer): | |||||||
|             if hasattr(event, "s"): |             if hasattr(event, "s"): | ||||||
|                 event_name = getattr(event, "value", event.s) |                 event_name = getattr(event, "value", event.s) | ||||||
|                 if self._not_registered(event_name): |                 if self._not_registered(event_name): | ||||||
|                     logger.debug( |                     if self._verbosity >= 2: | ||||||
|                         f"Disabling event: {event_name}", |                         logger.debug(f"Disabling event: {event_name}") | ||||||
|                         extra={"verbosity": 2}, |  | ||||||
|                     ) |  | ||||||
|                     return None |                     return None | ||||||
|         return node |         return node | ||||||
|  |  | ||||||
|   | |||||||
| @@ -21,8 +21,10 @@ class TouchUp: | |||||||
|  |  | ||||||
|             module = getmodule(target) |             module = getmodule(target) | ||||||
|             module_globals = dict(getmembers(module)) |             module_globals = dict(getmembers(module)) | ||||||
|             modified = BaseScheme.build(method, module_globals, app) |  | ||||||
|             setattr(target, method_name, modified) |             for scheme in BaseScheme._registry: | ||||||
|  |                 modified = scheme(app)(method, module_globals) | ||||||
|  |                 setattr(target, method_name, modified) | ||||||
|  |  | ||||||
|             target.__touched__ = True |             target.__touched__ = True | ||||||
|  |  | ||||||
|   | |||||||
| @@ -1,55 +0,0 @@ | |||||||
| import os |  | ||||||
|  |  | ||||||
| from types import SimpleNamespace |  | ||||||
| from typing import Any, Iterable |  | ||||||
|  |  | ||||||
| from sanic.log import Colors, error_logger |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class SharedContext(SimpleNamespace): |  | ||||||
|     SAFE = ("_lock",) |  | ||||||
|  |  | ||||||
|     def __init__(self, **kwargs: Any) -> None: |  | ||||||
|         super().__init__(**kwargs) |  | ||||||
|         self._lock = False |  | ||||||
|  |  | ||||||
|     def __setattr__(self, name: str, value: Any) -> None: |  | ||||||
|         if self.is_locked: |  | ||||||
|             raise RuntimeError( |  | ||||||
|                 f"Cannot set {name} on locked SharedContext object" |  | ||||||
|             ) |  | ||||||
|         if not os.environ.get("SANIC_WORKER_NAME"): |  | ||||||
|             to_check: Iterable[Any] |  | ||||||
|             if not isinstance(value, (tuple, frozenset)): |  | ||||||
|                 to_check = [value] |  | ||||||
|             else: |  | ||||||
|                 to_check = value |  | ||||||
|             for item in to_check: |  | ||||||
|                 self._check(name, item) |  | ||||||
|         super().__setattr__(name, value) |  | ||||||
|  |  | ||||||
|     def _check(self, name: str, value: Any) -> None: |  | ||||||
|         if name in self.SAFE: |  | ||||||
|             return |  | ||||||
|         try: |  | ||||||
|             module = value.__module__ |  | ||||||
|         except AttributeError: |  | ||||||
|             module = "" |  | ||||||
|         if not any( |  | ||||||
|             module.startswith(prefix) |  | ||||||
|             for prefix in ("multiprocessing", "ctypes") |  | ||||||
|         ): |  | ||||||
|             error_logger.warning( |  | ||||||
|                 f"{Colors.YELLOW}Unsafe object {Colors.PURPLE}{name} " |  | ||||||
|                 f"{Colors.YELLOW}with type {Colors.PURPLE}{type(value)} " |  | ||||||
|                 f"{Colors.YELLOW}was added to shared_ctx. It may not " |  | ||||||
|                 "not function as intended. Consider using the regular " |  | ||||||
|                 f"ctx. For more information, please see ____.{Colors.END}" |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def is_locked(self) -> bool: |  | ||||||
|         return getattr(self, "_lock", False) |  | ||||||
|  |  | ||||||
|     def lock(self) -> None: |  | ||||||
|         self._lock = True |  | ||||||
| @@ -11,35 +11,18 @@ from sanic.helpers import import_string | |||||||
|  |  | ||||||
|  |  | ||||||
| def str_to_bool(val: str) -> bool: | def str_to_bool(val: str) -> bool: | ||||||
|     """Takes string and tries to turn it into bool as human would do. |     """ | ||||||
|  |     reimplement strtobool per PEP 632 and python 3.12 deprecation | ||||||
|  |  | ||||||
|     If val is in case insensitive ( |     True values are y, yes, t, true, on and 1; false values are n, no, f, | ||||||
|         "y", "yes", "yep", "yup", "t", |     false, off and 0. Raises ValueError if val is anything else. | ||||||
|         "true", "on", "enable", "enabled", "1" |     """ | ||||||
|     ) returns True. |     if val.lower() in ["y", "yes", "t", "true", "on", "1"]: | ||||||
|     If val is in case insensitive ( |  | ||||||
|         "n", "no", "f", "false", "off", "disable", "disabled", "0" |  | ||||||
|     ) returns False. |  | ||||||
|     Else Raise ValueError.""" |  | ||||||
|  |  | ||||||
|     val = val.lower() |  | ||||||
|     if val in { |  | ||||||
|         "y", |  | ||||||
|         "yes", |  | ||||||
|         "yep", |  | ||||||
|         "yup", |  | ||||||
|         "t", |  | ||||||
|         "true", |  | ||||||
|         "on", |  | ||||||
|         "enable", |  | ||||||
|         "enabled", |  | ||||||
|         "1", |  | ||||||
|     }: |  | ||||||
|         return True |         return True | ||||||
|     elif val in {"n", "no", "f", "false", "off", "disable", "disabled", "0"}: |     elif val.lower() in ["n", "no", "f", "false", "off", "0"]: | ||||||
|         return False |         return False | ||||||
|     else: |     else: | ||||||
|         raise ValueError(f"Invalid truth value {val}") |         raise ValueError(f"String value {val} cannot be converted to bool") | ||||||
|  |  | ||||||
|  |  | ||||||
| def load_module_from_file_location( | def load_module_from_file_location( | ||||||
|   | |||||||
| @@ -13,7 +13,7 @@ from typing import ( | |||||||
| from sanic.models.handler_types import RouteHandler | from sanic.models.handler_types import RouteHandler | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: | if TYPE_CHECKING:  # no cov | ||||||
|     from sanic import Sanic |     from sanic import Sanic | ||||||
|     from sanic.blueprints import Blueprint |     from sanic.blueprints import Blueprint | ||||||
|  |  | ||||||
|   | |||||||
| @@ -1,141 +0,0 @@ | |||||||
| import sys |  | ||||||
|  |  | ||||||
| from datetime import datetime |  | ||||||
| from multiprocessing.connection import Connection |  | ||||||
| from signal import SIGINT, SIGTERM |  | ||||||
| from signal import signal as signal_func |  | ||||||
| from socket import AF_INET, SOCK_STREAM, socket, timeout |  | ||||||
| from textwrap import indent |  | ||||||
| from typing import Any, Dict |  | ||||||
|  |  | ||||||
| from sanic.application.logo import get_logo |  | ||||||
| from sanic.application.motd import MOTDTTY |  | ||||||
| from sanic.log import Colors, error_logger, logger |  | ||||||
| from sanic.server.socket import configure_socket |  | ||||||
|  |  | ||||||
|  |  | ||||||
| try:  # no cov |  | ||||||
|     from ujson import dumps, loads |  | ||||||
| except ModuleNotFoundError:  # no cov |  | ||||||
|     from json import dumps, loads  # type: ignore |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class Inspector: |  | ||||||
|     def __init__( |  | ||||||
|         self, |  | ||||||
|         publisher: Connection, |  | ||||||
|         app_info: Dict[str, Any], |  | ||||||
|         worker_state: Dict[str, Any], |  | ||||||
|         host: str, |  | ||||||
|         port: int, |  | ||||||
|     ): |  | ||||||
|         self._publisher = publisher |  | ||||||
|         self.run = True |  | ||||||
|         self.app_info = app_info |  | ||||||
|         self.worker_state = worker_state |  | ||||||
|         self.host = host |  | ||||||
|         self.port = port |  | ||||||
|  |  | ||||||
|     def __call__(self) -> None: |  | ||||||
|         sock = configure_socket( |  | ||||||
|             {"host": self.host, "port": self.port, "unix": None, "backlog": 1} |  | ||||||
|         ) |  | ||||||
|         assert sock |  | ||||||
|         signal_func(SIGINT, self.stop) |  | ||||||
|         signal_func(SIGTERM, self.stop) |  | ||||||
|  |  | ||||||
|         logger.info(f"Inspector started on: {sock.getsockname()}") |  | ||||||
|         sock.settimeout(0.5) |  | ||||||
|         try: |  | ||||||
|             while self.run: |  | ||||||
|                 try: |  | ||||||
|                     conn, _ = sock.accept() |  | ||||||
|                 except timeout: |  | ||||||
|                     continue |  | ||||||
|                 else: |  | ||||||
|                     action = conn.recv(64) |  | ||||||
|                     if action == b"reload": |  | ||||||
|                         conn.send(b"\n") |  | ||||||
|                         self.reload() |  | ||||||
|                     elif action == b"shutdown": |  | ||||||
|                         conn.send(b"\n") |  | ||||||
|                         self.shutdown() |  | ||||||
|                     else: |  | ||||||
|                         data = dumps(self.state_to_json()) |  | ||||||
|                         conn.send(data.encode()) |  | ||||||
|                         conn.close() |  | ||||||
|         finally: |  | ||||||
|             logger.debug("Inspector closing") |  | ||||||
|             sock.close() |  | ||||||
|  |  | ||||||
|     def stop(self, *_): |  | ||||||
|         self.run = False |  | ||||||
|  |  | ||||||
|     def state_to_json(self): |  | ||||||
|         output = {"info": self.app_info} |  | ||||||
|         output["workers"] = self._make_safe(dict(self.worker_state)) |  | ||||||
|         return output |  | ||||||
|  |  | ||||||
|     def reload(self): |  | ||||||
|         message = "__ALL_PROCESSES__:" |  | ||||||
|         self._publisher.send(message) |  | ||||||
|  |  | ||||||
|     def shutdown(self): |  | ||||||
|         message = "__TERMINATE__" |  | ||||||
|         self._publisher.send(message) |  | ||||||
|  |  | ||||||
|     def _make_safe(self, obj: Dict[str, Any]) -> Dict[str, Any]: |  | ||||||
|         for key, value in obj.items(): |  | ||||||
|             if isinstance(value, dict): |  | ||||||
|                 obj[key] = self._make_safe(value) |  | ||||||
|             elif isinstance(value, datetime): |  | ||||||
|                 obj[key] = value.isoformat() |  | ||||||
|         return obj |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def inspect(host: str, port: int, action: str): |  | ||||||
|     out = sys.stdout.write |  | ||||||
|     with socket(AF_INET, SOCK_STREAM) as sock: |  | ||||||
|         try: |  | ||||||
|             sock.connect((host, port)) |  | ||||||
|         except ConnectionRefusedError: |  | ||||||
|             error_logger.error( |  | ||||||
|                 f"{Colors.RED}Could not connect to inspector at: " |  | ||||||
|                 f"{Colors.YELLOW}{(host, port)}{Colors.END}\n" |  | ||||||
|                 "Either the application is not running, or it did not start " |  | ||||||
|                 "an inspector instance." |  | ||||||
|             ) |  | ||||||
|             sock.close() |  | ||||||
|             sys.exit(1) |  | ||||||
|         sock.sendall(action.encode()) |  | ||||||
|         data = sock.recv(4096) |  | ||||||
|     if action == "raw": |  | ||||||
|         out(data.decode()) |  | ||||||
|     elif action == "pretty": |  | ||||||
|         loaded = loads(data) |  | ||||||
|         display = loaded.pop("info") |  | ||||||
|         extra = display.pop("extra", {}) |  | ||||||
|         display["packages"] = ", ".join(display["packages"]) |  | ||||||
|         MOTDTTY(get_logo(), f"{host}:{port}", display, extra).display( |  | ||||||
|             version=False, |  | ||||||
|             action="Inspecting", |  | ||||||
|             out=out, |  | ||||||
|         ) |  | ||||||
|         for name, info in loaded["workers"].items(): |  | ||||||
|             info = "\n".join( |  | ||||||
|                 f"\t{key}: {Colors.BLUE}{value}{Colors.END}" |  | ||||||
|                 for key, value in info.items() |  | ||||||
|             ) |  | ||||||
|             out( |  | ||||||
|                 "\n" |  | ||||||
|                 + indent( |  | ||||||
|                     "\n".join( |  | ||||||
|                         [ |  | ||||||
|                             f"{Colors.BOLD}{Colors.SANIC}{name}{Colors.END}", |  | ||||||
|                             info, |  | ||||||
|                         ] |  | ||||||
|                     ), |  | ||||||
|                     "  ", |  | ||||||
|                 ) |  | ||||||
|                 + "\n" |  | ||||||
|             ) |  | ||||||
| @@ -1,126 +0,0 @@ | |||||||
| from __future__ import annotations |  | ||||||
|  |  | ||||||
| import os |  | ||||||
| import sys |  | ||||||
|  |  | ||||||
| from importlib import import_module |  | ||||||
| from pathlib import Path |  | ||||||
| from typing import ( |  | ||||||
|     TYPE_CHECKING, |  | ||||||
|     Any, |  | ||||||
|     Callable, |  | ||||||
|     Dict, |  | ||||||
|     Optional, |  | ||||||
|     Type, |  | ||||||
|     Union, |  | ||||||
|     cast, |  | ||||||
| ) |  | ||||||
|  |  | ||||||
| from sanic.http.tls.creators import CertCreator, MkcertCreator, TrustmeCreator |  | ||||||
|  |  | ||||||
|  |  | ||||||
| if TYPE_CHECKING: |  | ||||||
|     from sanic import Sanic as SanicApp |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class AppLoader: |  | ||||||
|     def __init__( |  | ||||||
|         self, |  | ||||||
|         module_input: str = "", |  | ||||||
|         as_factory: bool = False, |  | ||||||
|         as_simple: bool = False, |  | ||||||
|         args: Any = None, |  | ||||||
|         factory: Optional[Callable[[], SanicApp]] = None, |  | ||||||
|     ) -> None: |  | ||||||
|         self.module_input = module_input |  | ||||||
|         self.module_name = "" |  | ||||||
|         self.app_name = "" |  | ||||||
|         self.as_factory = as_factory |  | ||||||
|         self.as_simple = as_simple |  | ||||||
|         self.args = args |  | ||||||
|         self.factory = factory |  | ||||||
|         self.cwd = os.getcwd() |  | ||||||
|  |  | ||||||
|         if module_input: |  | ||||||
|             delimiter = ":" if ":" in module_input else "." |  | ||||||
|             if module_input.count(delimiter): |  | ||||||
|                 module_name, app_name = module_input.rsplit(delimiter, 1) |  | ||||||
|                 self.module_name = module_name |  | ||||||
|                 self.app_name = app_name |  | ||||||
|                 if self.app_name.endswith("()"): |  | ||||||
|                     self.as_factory = True |  | ||||||
|                     self.app_name = self.app_name[:-2] |  | ||||||
|  |  | ||||||
|     def load(self) -> SanicApp: |  | ||||||
|         module_path = os.path.abspath(self.cwd) |  | ||||||
|         if module_path not in sys.path: |  | ||||||
|             sys.path.append(module_path) |  | ||||||
|  |  | ||||||
|         if self.factory: |  | ||||||
|             return self.factory() |  | ||||||
|         else: |  | ||||||
|             from sanic.app import Sanic |  | ||||||
|             from sanic.simple import create_simple_server |  | ||||||
|  |  | ||||||
|             if self.as_simple: |  | ||||||
|                 path = Path(self.module_input) |  | ||||||
|                 app = create_simple_server(path) |  | ||||||
|             else: |  | ||||||
|                 if self.module_name == "" and os.path.isdir(self.module_input): |  | ||||||
|                     raise ValueError( |  | ||||||
|                         "App not found.\n" |  | ||||||
|                         "   Please use --simple if you are passing a " |  | ||||||
|                         "directory to sanic.\n" |  | ||||||
|                         f"   eg. sanic {self.module_input} --simple" |  | ||||||
|                     ) |  | ||||||
|  |  | ||||||
|                 module = import_module(self.module_name) |  | ||||||
|                 app = getattr(module, self.app_name, None) |  | ||||||
|                 if self.as_factory: |  | ||||||
|                     try: |  | ||||||
|                         app = app(self.args) |  | ||||||
|                     except TypeError: |  | ||||||
|                         app = app() |  | ||||||
|  |  | ||||||
|                 app_type_name = type(app).__name__ |  | ||||||
|  |  | ||||||
|                 if ( |  | ||||||
|                     not isinstance(app, Sanic) |  | ||||||
|                     and self.args |  | ||||||
|                     and hasattr(self.args, "module") |  | ||||||
|                 ): |  | ||||||
|                     if callable(app): |  | ||||||
|                         solution = f"sanic {self.args.module} --factory" |  | ||||||
|                         raise ValueError( |  | ||||||
|                             "Module is not a Sanic app, it is a " |  | ||||||
|                             f"{app_type_name}\n" |  | ||||||
|                             "  If this callable returns a " |  | ||||||
|                             f"Sanic instance try: \n{solution}" |  | ||||||
|                         ) |  | ||||||
|  |  | ||||||
|                     raise ValueError( |  | ||||||
|                         f"Module is not a Sanic app, it is a {app_type_name}\n" |  | ||||||
|                         f"  Perhaps you meant {self.args.module}:app?" |  | ||||||
|                     ) |  | ||||||
|         return app |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class CertLoader: |  | ||||||
|     _creator_class: Type[CertCreator] |  | ||||||
|  |  | ||||||
|     def __init__(self, ssl_data: Dict[str, Union[str, os.PathLike]]): |  | ||||||
|         creator_name = ssl_data.get("creator") |  | ||||||
|         if creator_name not in ("mkcert", "trustme"): |  | ||||||
|             raise RuntimeError(f"Unknown certificate creator: {creator_name}") |  | ||||||
|         elif creator_name == "mkcert": |  | ||||||
|             self._creator_class = MkcertCreator |  | ||||||
|         elif creator_name == "trustme": |  | ||||||
|             self._creator_class = TrustmeCreator |  | ||||||
|  |  | ||||||
|         self._key = ssl_data["key"] |  | ||||||
|         self._cert = ssl_data["cert"] |  | ||||||
|         self._localhost = cast(str, ssl_data["localhost"]) |  | ||||||
|  |  | ||||||
|     def load(self, app: SanicApp): |  | ||||||
|         creator = self._creator_class(app, self._key, self._cert) |  | ||||||
|         return creator.generate_cert(self._localhost) |  | ||||||
| @@ -1,181 +0,0 @@ | |||||||
| import os |  | ||||||
| import sys |  | ||||||
|  |  | ||||||
| from signal import SIGINT, SIGTERM, Signals |  | ||||||
| from signal import signal as signal_func |  | ||||||
| from time import sleep |  | ||||||
| from typing import List, Optional |  | ||||||
|  |  | ||||||
| from sanic.compat import OS_IS_WINDOWS |  | ||||||
| from sanic.log import error_logger, logger |  | ||||||
| from sanic.worker.process import ProcessState, Worker, WorkerProcess |  | ||||||
|  |  | ||||||
|  |  | ||||||
| if not OS_IS_WINDOWS: |  | ||||||
|     from signal import SIGKILL |  | ||||||
| else: |  | ||||||
|     SIGKILL = SIGINT |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class WorkerManager: |  | ||||||
|     THRESHOLD = 50 |  | ||||||
|  |  | ||||||
|     def __init__( |  | ||||||
|         self, |  | ||||||
|         number: int, |  | ||||||
|         serve, |  | ||||||
|         server_settings, |  | ||||||
|         context, |  | ||||||
|         monitor_pubsub, |  | ||||||
|         worker_state, |  | ||||||
|     ): |  | ||||||
|         self.num_server = number |  | ||||||
|         self.context = context |  | ||||||
|         self.transient: List[Worker] = [] |  | ||||||
|         self.durable: List[Worker] = [] |  | ||||||
|         self.monitor_publisher, self.monitor_subscriber = monitor_pubsub |  | ||||||
|         self.worker_state = worker_state |  | ||||||
|         self.worker_state["Sanic-Main"] = {"pid": self.pid} |  | ||||||
|         self.terminated = False |  | ||||||
|  |  | ||||||
|         if number == 0: |  | ||||||
|             raise RuntimeError("Cannot serve with no workers") |  | ||||||
|  |  | ||||||
|         for i in range(number): |  | ||||||
|             self.manage( |  | ||||||
|                 f"{WorkerProcess.SERVER_LABEL}-{i}", |  | ||||||
|                 serve, |  | ||||||
|                 server_settings, |  | ||||||
|                 transient=True, |  | ||||||
|             ) |  | ||||||
|  |  | ||||||
|         signal_func(SIGINT, self.shutdown_signal) |  | ||||||
|         signal_func(SIGTERM, self.shutdown_signal) |  | ||||||
|  |  | ||||||
|     def manage(self, ident, func, kwargs, transient=False): |  | ||||||
|         container = self.transient if transient else self.durable |  | ||||||
|         container.append( |  | ||||||
|             Worker(ident, func, kwargs, self.context, self.worker_state) |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     def run(self): |  | ||||||
|         self.start() |  | ||||||
|         self.monitor() |  | ||||||
|         self.join() |  | ||||||
|         self.terminate() |  | ||||||
|         # self.kill() |  | ||||||
|  |  | ||||||
|     def start(self): |  | ||||||
|         for process in self.processes: |  | ||||||
|             process.start() |  | ||||||
|  |  | ||||||
|     def join(self): |  | ||||||
|         logger.debug("Joining processes", extra={"verbosity": 1}) |  | ||||||
|         joined = set() |  | ||||||
|         for process in self.processes: |  | ||||||
|             logger.debug( |  | ||||||
|                 f"Found {process.pid} - {process.state.name}", |  | ||||||
|                 extra={"verbosity": 1}, |  | ||||||
|             ) |  | ||||||
|             if process.state < ProcessState.JOINED: |  | ||||||
|                 logger.debug(f"Joining {process.pid}", extra={"verbosity": 1}) |  | ||||||
|                 joined.add(process.pid) |  | ||||||
|                 process.join() |  | ||||||
|         if joined: |  | ||||||
|             self.join() |  | ||||||
|  |  | ||||||
|     def terminate(self): |  | ||||||
|         if not self.terminated: |  | ||||||
|             for process in self.processes: |  | ||||||
|                 process.terminate() |  | ||||||
|         self.terminated = True |  | ||||||
|  |  | ||||||
|     def restart(self, process_names: Optional[List[str]] = None, **kwargs): |  | ||||||
|         for process in self.transient_processes: |  | ||||||
|             if not process_names or process.name in process_names: |  | ||||||
|                 process.restart(**kwargs) |  | ||||||
|  |  | ||||||
|     def monitor(self): |  | ||||||
|         self.wait_for_ack() |  | ||||||
|         while True: |  | ||||||
|             try: |  | ||||||
|                 if self.monitor_subscriber.poll(0.1): |  | ||||||
|                     message = self.monitor_subscriber.recv() |  | ||||||
|                     logger.debug( |  | ||||||
|                         f"Monitor message: {message}", extra={"verbosity": 2} |  | ||||||
|                     ) |  | ||||||
|                     if not message: |  | ||||||
|                         break |  | ||||||
|                     elif message == "__TERMINATE__": |  | ||||||
|                         self.shutdown() |  | ||||||
|                         break |  | ||||||
|                     split_message = message.split(":", 1) |  | ||||||
|                     processes = split_message[0] |  | ||||||
|                     reloaded_files = ( |  | ||||||
|                         split_message[1] if len(split_message) > 1 else None |  | ||||||
|                     ) |  | ||||||
|                     process_names = [ |  | ||||||
|                         name.strip() for name in processes.split(",") |  | ||||||
|                     ] |  | ||||||
|                     if "__ALL_PROCESSES__" in process_names: |  | ||||||
|                         process_names = None |  | ||||||
|                     self.restart( |  | ||||||
|                         process_names=process_names, |  | ||||||
|                         reloaded_files=reloaded_files, |  | ||||||
|                     ) |  | ||||||
|             except InterruptedError: |  | ||||||
|                 if not OS_IS_WINDOWS: |  | ||||||
|                     raise |  | ||||||
|                 break |  | ||||||
|  |  | ||||||
|     def wait_for_ack(self):  # no cov |  | ||||||
|         misses = 0 |  | ||||||
|         while not self._all_workers_ack(): |  | ||||||
|             sleep(0.1) |  | ||||||
|             misses += 1 |  | ||||||
|             if misses > self.THRESHOLD: |  | ||||||
|                 error_logger.error("Not all workers are ack. Shutting down.") |  | ||||||
|                 self.kill() |  | ||||||
|                 sys.exit(1) |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def workers(self): |  | ||||||
|         return self.transient + self.durable |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def processes(self): |  | ||||||
|         for worker in self.workers: |  | ||||||
|             for process in worker.processes: |  | ||||||
|                 yield process |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def transient_processes(self): |  | ||||||
|         for worker in self.transient: |  | ||||||
|             for process in worker.processes: |  | ||||||
|                 yield process |  | ||||||
|  |  | ||||||
|     def kill(self): |  | ||||||
|         for process in self.processes: |  | ||||||
|             os.kill(process.pid, SIGKILL) |  | ||||||
|  |  | ||||||
|     def shutdown_signal(self, signal, frame): |  | ||||||
|         logger.info("Received signal %s. Shutting down.", Signals(signal).name) |  | ||||||
|         self.monitor_publisher.send(None) |  | ||||||
|         self.shutdown() |  | ||||||
|  |  | ||||||
|     def shutdown(self): |  | ||||||
|         for process in self.processes: |  | ||||||
|             if process.is_alive(): |  | ||||||
|                 process.terminate() |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def pid(self): |  | ||||||
|         return os.getpid() |  | ||||||
|  |  | ||||||
|     def _all_workers_ack(self): |  | ||||||
|         acked = [ |  | ||||||
|             worker_state.get("state") == ProcessState.ACKED.name |  | ||||||
|             for worker_state in self.worker_state.values() |  | ||||||
|             if worker_state.get("server") |  | ||||||
|         ] |  | ||||||
|         return all(acked) and len(acked) == self.num_server |  | ||||||
| @@ -1,48 +0,0 @@ | |||||||
| from multiprocessing.connection import Connection |  | ||||||
| from os import environ, getpid |  | ||||||
| from typing import Any, Dict |  | ||||||
|  |  | ||||||
| from sanic.worker.process import ProcessState |  | ||||||
| from sanic.worker.state import WorkerState |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class WorkerMultiplexer: |  | ||||||
|     def __init__( |  | ||||||
|         self, |  | ||||||
|         monitor_publisher: Connection, |  | ||||||
|         worker_state: Dict[str, Any], |  | ||||||
|     ): |  | ||||||
|         self._monitor_publisher = monitor_publisher |  | ||||||
|         self._state = WorkerState(worker_state, self.name) |  | ||||||
|  |  | ||||||
|     def ack(self): |  | ||||||
|         self._state._state[self.name] = { |  | ||||||
|             **self._state._state[self.name], |  | ||||||
|             "state": ProcessState.ACKED.name, |  | ||||||
|         } |  | ||||||
|  |  | ||||||
|     def restart(self, name: str = ""): |  | ||||||
|         if not name: |  | ||||||
|             name = self.name |  | ||||||
|         self._monitor_publisher.send(name) |  | ||||||
|  |  | ||||||
|     reload = restart  # no cov |  | ||||||
|  |  | ||||||
|     def terminate(self): |  | ||||||
|         self._monitor_publisher.send("__TERMINATE__") |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def pid(self) -> int: |  | ||||||
|         return getpid() |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def name(self) -> str: |  | ||||||
|         return environ.get("SANIC_WORKER_NAME", "") |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def state(self): |  | ||||||
|         return self._state |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def workers(self) -> Dict[str, Any]: |  | ||||||
|         return self.state.full() |  | ||||||
| @@ -1,161 +0,0 @@ | |||||||
| import os |  | ||||||
|  |  | ||||||
| from datetime import datetime, timezone |  | ||||||
| from enum import IntEnum, auto |  | ||||||
| from multiprocessing.context import BaseContext |  | ||||||
| from signal import SIGINT |  | ||||||
| from typing import Any, Dict, Set |  | ||||||
|  |  | ||||||
| from sanic.log import Colors, logger |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def get_now(): |  | ||||||
|     now = datetime.now(tz=timezone.utc) |  | ||||||
|     return now |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class ProcessState(IntEnum): |  | ||||||
|     IDLE = auto() |  | ||||||
|     STARTED = auto() |  | ||||||
|     ACKED = auto() |  | ||||||
|     JOINED = auto() |  | ||||||
|     TERMINATED = auto() |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class WorkerProcess: |  | ||||||
|     SERVER_LABEL = "Server" |  | ||||||
|  |  | ||||||
|     def __init__(self, factory, name, target, kwargs, worker_state): |  | ||||||
|         self.state = ProcessState.IDLE |  | ||||||
|         self.factory = factory |  | ||||||
|         self.name = name |  | ||||||
|         self.target = target |  | ||||||
|         self.kwargs = kwargs |  | ||||||
|         self.worker_state = worker_state |  | ||||||
|         if self.name not in self.worker_state: |  | ||||||
|             self.worker_state[self.name] = { |  | ||||||
|                 "server": self.SERVER_LABEL in self.name |  | ||||||
|             } |  | ||||||
|         self.spawn() |  | ||||||
|  |  | ||||||
|     def set_state(self, state: ProcessState, force=False): |  | ||||||
|         if not force and state < self.state: |  | ||||||
|             raise Exception("...") |  | ||||||
|         self.state = state |  | ||||||
|         self.worker_state[self.name] = { |  | ||||||
|             **self.worker_state[self.name], |  | ||||||
|             "state": self.state.name, |  | ||||||
|         } |  | ||||||
|  |  | ||||||
|     def start(self): |  | ||||||
|         os.environ["SANIC_WORKER_NAME"] = self.name |  | ||||||
|         logger.debug( |  | ||||||
|             f"{Colors.BLUE}Starting a process: {Colors.BOLD}" |  | ||||||
|             f"{Colors.SANIC}%s{Colors.END}", |  | ||||||
|             self.name, |  | ||||||
|         ) |  | ||||||
|         self.set_state(ProcessState.STARTED) |  | ||||||
|         self._process.start() |  | ||||||
|         if not self.worker_state[self.name].get("starts"): |  | ||||||
|             self.worker_state[self.name] = { |  | ||||||
|                 **self.worker_state[self.name], |  | ||||||
|                 "pid": self.pid, |  | ||||||
|                 "start_at": get_now(), |  | ||||||
|                 "starts": 1, |  | ||||||
|             } |  | ||||||
|         del os.environ["SANIC_WORKER_NAME"] |  | ||||||
|  |  | ||||||
|     def join(self): |  | ||||||
|         self.set_state(ProcessState.JOINED) |  | ||||||
|         self._process.join() |  | ||||||
|  |  | ||||||
|     def terminate(self): |  | ||||||
|         if self.state is not ProcessState.TERMINATED: |  | ||||||
|             logger.debug( |  | ||||||
|                 f"{Colors.BLUE}Terminating a process: " |  | ||||||
|                 f"{Colors.BOLD}{Colors.SANIC}" |  | ||||||
|                 f"%s {Colors.BLUE}[%s]{Colors.END}", |  | ||||||
|                 self.name, |  | ||||||
|                 self.pid, |  | ||||||
|             ) |  | ||||||
|             self.set_state(ProcessState.TERMINATED, force=True) |  | ||||||
|             try: |  | ||||||
|                 # self._process.terminate() |  | ||||||
|                 os.kill(self.pid, SIGINT) |  | ||||||
|                 del self.worker_state[self.name] |  | ||||||
|             except (KeyError, AttributeError, ProcessLookupError): |  | ||||||
|                 ... |  | ||||||
|  |  | ||||||
|     def restart(self, **kwargs): |  | ||||||
|         logger.debug( |  | ||||||
|             f"{Colors.BLUE}Restarting a process: {Colors.BOLD}{Colors.SANIC}" |  | ||||||
|             f"%s {Colors.BLUE}[%s]{Colors.END}", |  | ||||||
|             self.name, |  | ||||||
|             self.pid, |  | ||||||
|         ) |  | ||||||
|         self._process.terminate() |  | ||||||
|         self.set_state(ProcessState.IDLE, force=True) |  | ||||||
|         self.kwargs.update( |  | ||||||
|             {"config": {k.upper(): v for k, v in kwargs.items()}} |  | ||||||
|         ) |  | ||||||
|         try: |  | ||||||
|             self.spawn() |  | ||||||
|             self.start() |  | ||||||
|         except AttributeError: |  | ||||||
|             raise RuntimeError("Restart failed") |  | ||||||
|  |  | ||||||
|         self.worker_state[self.name] = { |  | ||||||
|             **self.worker_state[self.name], |  | ||||||
|             "pid": self.pid, |  | ||||||
|             "starts": self.worker_state[self.name]["starts"] + 1, |  | ||||||
|             "restart_at": get_now(), |  | ||||||
|         } |  | ||||||
|  |  | ||||||
|     def is_alive(self): |  | ||||||
|         try: |  | ||||||
|             return self._process.is_alive() |  | ||||||
|         except AssertionError: |  | ||||||
|             return False |  | ||||||
|  |  | ||||||
|     def spawn(self): |  | ||||||
|         if self.state is not ProcessState.IDLE: |  | ||||||
|             raise Exception("Cannot spawn a worker process until it is idle.") |  | ||||||
|         self._process = self.factory( |  | ||||||
|             name=self.name, |  | ||||||
|             target=self.target, |  | ||||||
|             kwargs=self.kwargs, |  | ||||||
|             daemon=True, |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     @property |  | ||||||
|     def pid(self): |  | ||||||
|         return self._process.pid |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class Worker: |  | ||||||
|     def __init__( |  | ||||||
|         self, |  | ||||||
|         ident: str, |  | ||||||
|         serve, |  | ||||||
|         server_settings, |  | ||||||
|         context: BaseContext, |  | ||||||
|         worker_state: Dict[str, Any], |  | ||||||
|     ): |  | ||||||
|         self.ident = ident |  | ||||||
|         self.context = context |  | ||||||
|         self.serve = serve |  | ||||||
|         self.server_settings = server_settings |  | ||||||
|         self.worker_state = worker_state |  | ||||||
|         self.processes: Set[WorkerProcess] = set() |  | ||||||
|         self.create_process() |  | ||||||
|  |  | ||||||
|     def create_process(self) -> WorkerProcess: |  | ||||||
|         process = WorkerProcess( |  | ||||||
|             factory=self.context.Process, |  | ||||||
|             name=f"Sanic-{self.ident}-{len(self.processes)}", |  | ||||||
|             target=self.serve, |  | ||||||
|             kwargs={**self.server_settings}, |  | ||||||
|             worker_state=self.worker_state, |  | ||||||
|         ) |  | ||||||
|         self.processes.add(process) |  | ||||||
|         return process |  | ||||||
| @@ -1,119 +0,0 @@ | |||||||
| from __future__ import annotations |  | ||||||
|  |  | ||||||
| import os |  | ||||||
| import sys |  | ||||||
|  |  | ||||||
| from asyncio import new_event_loop |  | ||||||
| from itertools import chain |  | ||||||
| from multiprocessing.connection import Connection |  | ||||||
| from pathlib import Path |  | ||||||
| from signal import SIGINT, SIGTERM |  | ||||||
| from signal import signal as signal_func |  | ||||||
| from typing import Dict, Set |  | ||||||
|  |  | ||||||
| from sanic.server.events import trigger_events |  | ||||||
| from sanic.worker.loader import AppLoader |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class Reloader: |  | ||||||
|     def __init__( |  | ||||||
|         self, |  | ||||||
|         publisher: Connection, |  | ||||||
|         interval: float, |  | ||||||
|         reload_dirs: Set[Path], |  | ||||||
|         app_loader: AppLoader, |  | ||||||
|     ): |  | ||||||
|         self._publisher = publisher |  | ||||||
|         self.interval = interval |  | ||||||
|         self.reload_dirs = reload_dirs |  | ||||||
|         self.run = True |  | ||||||
|         self.app_loader = app_loader |  | ||||||
|  |  | ||||||
|     def __call__(self) -> None: |  | ||||||
|         app = self.app_loader.load() |  | ||||||
|         signal_func(SIGINT, self.stop) |  | ||||||
|         signal_func(SIGTERM, self.stop) |  | ||||||
|         mtimes: Dict[str, float] = {} |  | ||||||
|  |  | ||||||
|         reloader_start = app.listeners.get("reload_process_start") |  | ||||||
|         reloader_stop = app.listeners.get("reload_process_stop") |  | ||||||
|         before_trigger = app.listeners.get("before_reload_trigger") |  | ||||||
|         after_trigger = app.listeners.get("after_reload_trigger") |  | ||||||
|         loop = new_event_loop() |  | ||||||
|         if reloader_start: |  | ||||||
|             trigger_events(reloader_start, loop, app) |  | ||||||
|  |  | ||||||
|         while self.run: |  | ||||||
|             changed = set() |  | ||||||
|             for filename in self.files(): |  | ||||||
|                 try: |  | ||||||
|                     if self.check_file(filename, mtimes): |  | ||||||
|                         path = ( |  | ||||||
|                             filename |  | ||||||
|                             if isinstance(filename, str) |  | ||||||
|                             else filename.resolve() |  | ||||||
|                         ) |  | ||||||
|                         changed.add(str(path)) |  | ||||||
|                 except OSError: |  | ||||||
|                     continue |  | ||||||
|             if changed: |  | ||||||
|                 if before_trigger: |  | ||||||
|                     trigger_events(before_trigger, loop, app) |  | ||||||
|                 self.reload(",".join(changed) if changed else "unknown") |  | ||||||
|                 if after_trigger: |  | ||||||
|                     trigger_events(after_trigger, loop, app) |  | ||||||
|         else: |  | ||||||
|             if reloader_stop: |  | ||||||
|                 trigger_events(reloader_stop, loop, app) |  | ||||||
|  |  | ||||||
|     def stop(self, *_): |  | ||||||
|         self.run = False |  | ||||||
|  |  | ||||||
|     def reload(self, reloaded_files): |  | ||||||
|         message = f"__ALL_PROCESSES__:{reloaded_files}" |  | ||||||
|         self._publisher.send(message) |  | ||||||
|  |  | ||||||
|     def files(self): |  | ||||||
|         return chain( |  | ||||||
|             self.python_files(), |  | ||||||
|             *(d.glob("**/*") for d in self.reload_dirs), |  | ||||||
|         ) |  | ||||||
|  |  | ||||||
|     def python_files(self):  # no cov |  | ||||||
|         """This iterates over all relevant Python files. |  | ||||||
|  |  | ||||||
|         It goes through all |  | ||||||
|         loaded files from modules, all files in folders of already loaded |  | ||||||
|         modules as well as all files reachable through a package. |  | ||||||
|         """ |  | ||||||
|         # The list call is necessary on Python 3 in case the module |  | ||||||
|         # dictionary modifies during iteration. |  | ||||||
|         for module in list(sys.modules.values()): |  | ||||||
|             if module is None: |  | ||||||
|                 continue |  | ||||||
|             filename = getattr(module, "__file__", None) |  | ||||||
|             if filename: |  | ||||||
|                 old = None |  | ||||||
|                 while not os.path.isfile(filename): |  | ||||||
|                     old = filename |  | ||||||
|                     filename = os.path.dirname(filename) |  | ||||||
|                     if filename == old: |  | ||||||
|                         break |  | ||||||
|                 else: |  | ||||||
|                     if filename[-4:] in (".pyc", ".pyo"): |  | ||||||
|                         filename = filename[:-1] |  | ||||||
|                     yield filename |  | ||||||
|  |  | ||||||
|     @staticmethod |  | ||||||
|     def check_file(filename, mtimes) -> bool: |  | ||||||
|         need_reload = False |  | ||||||
|  |  | ||||||
|         mtime = os.stat(filename).st_mtime |  | ||||||
|         old_time = mtimes.get(filename) |  | ||||||
|         if old_time is None: |  | ||||||
|             mtimes[filename] = mtime |  | ||||||
|         elif mtime > old_time: |  | ||||||
|             mtimes[filename] = mtime |  | ||||||
|             need_reload = True |  | ||||||
|  |  | ||||||
|         return need_reload |  | ||||||
| @@ -1,124 +0,0 @@ | |||||||
| import asyncio |  | ||||||
| import os |  | ||||||
| import socket |  | ||||||
|  |  | ||||||
| from functools import partial |  | ||||||
| from multiprocessing.connection import Connection |  | ||||||
| from ssl import SSLContext |  | ||||||
| from typing import Any, Dict, List, Optional, Type, Union |  | ||||||
|  |  | ||||||
| from sanic.application.constants import ServerStage |  | ||||||
| from sanic.application.state import ApplicationServerInfo |  | ||||||
| from sanic.http.constants import HTTP |  | ||||||
| from sanic.models.server_types import Signal |  | ||||||
| from sanic.server.protocols.http_protocol import HttpProtocol |  | ||||||
| from sanic.server.runners import _serve_http_1, _serve_http_3 |  | ||||||
| from sanic.worker.loader import AppLoader, CertLoader |  | ||||||
| from sanic.worker.multiplexer import WorkerMultiplexer |  | ||||||
|  |  | ||||||
|  |  | ||||||
| def worker_serve( |  | ||||||
|     host, |  | ||||||
|     port, |  | ||||||
|     app_name: str, |  | ||||||
|     monitor_publisher: Optional[Connection], |  | ||||||
|     app_loader: AppLoader, |  | ||||||
|     worker_state: Optional[Dict[str, Any]] = None, |  | ||||||
|     server_info: Optional[Dict[str, List[ApplicationServerInfo]]] = None, |  | ||||||
|     ssl: Optional[ |  | ||||||
|         Union[SSLContext, Dict[str, Union[str, os.PathLike]]] |  | ||||||
|     ] = None, |  | ||||||
|     sock: Optional[socket.socket] = None, |  | ||||||
|     unix: Optional[str] = None, |  | ||||||
|     reuse_port: bool = False, |  | ||||||
|     loop=None, |  | ||||||
|     protocol: Type[asyncio.Protocol] = HttpProtocol, |  | ||||||
|     backlog: int = 100, |  | ||||||
|     register_sys_signals: bool = True, |  | ||||||
|     run_multiple: bool = False, |  | ||||||
|     run_async: bool = False, |  | ||||||
|     connections=None, |  | ||||||
|     signal=Signal(), |  | ||||||
|     state=None, |  | ||||||
|     asyncio_server_kwargs=None, |  | ||||||
|     version=HTTP.VERSION_1, |  | ||||||
|     config=None, |  | ||||||
|     passthru: Optional[Dict[str, Any]] = None, |  | ||||||
| ): |  | ||||||
|     from sanic import Sanic |  | ||||||
|  |  | ||||||
|     if app_loader: |  | ||||||
|         app = app_loader.load() |  | ||||||
|     else: |  | ||||||
|         app = Sanic.get_app(app_name) |  | ||||||
|  |  | ||||||
|     app.refresh(passthru) |  | ||||||
|     app.setup_loop() |  | ||||||
|  |  | ||||||
|     loop = asyncio.new_event_loop() |  | ||||||
|     asyncio.set_event_loop(loop) |  | ||||||
|  |  | ||||||
|     # Hydrate server info if needed |  | ||||||
|     if server_info: |  | ||||||
|         for app_name, server_info_objects in server_info.items(): |  | ||||||
|             a = Sanic.get_app(app_name) |  | ||||||
|             if not a.state.server_info: |  | ||||||
|                 a.state.server_info = [] |  | ||||||
|                 for info in server_info_objects: |  | ||||||
|                     if not info.settings.get("app"): |  | ||||||
|                         info.settings["app"] = a |  | ||||||
|                     a.state.server_info.append(info) |  | ||||||
|  |  | ||||||
|     if isinstance(ssl, dict): |  | ||||||
|         cert_loader = CertLoader(ssl) |  | ||||||
|         ssl = cert_loader.load(app) |  | ||||||
|         for info in app.state.server_info: |  | ||||||
|             info.settings["ssl"] = ssl |  | ||||||
|  |  | ||||||
|     # When in a worker process, do some init |  | ||||||
|     if os.environ.get("SANIC_WORKER_NAME"): |  | ||||||
|         # Hydrate apps with any passed server info |  | ||||||
|  |  | ||||||
|         if monitor_publisher is None: |  | ||||||
|             raise RuntimeError("No restart publisher found in worker process") |  | ||||||
|         if worker_state is None: |  | ||||||
|             raise RuntimeError("No worker state found in worker process") |  | ||||||
|  |  | ||||||
|         # Run secondary servers |  | ||||||
|         apps = list(Sanic._app_registry.values()) |  | ||||||
|         app.before_server_start(partial(app._start_servers, apps=apps)) |  | ||||||
|         for a in apps: |  | ||||||
|             a.multiplexer = WorkerMultiplexer(monitor_publisher, worker_state) |  | ||||||
|  |  | ||||||
|     if app.debug: |  | ||||||
|         loop.set_debug(app.debug) |  | ||||||
|  |  | ||||||
|     app.asgi = False |  | ||||||
|  |  | ||||||
|     if app.state.server_info: |  | ||||||
|         primary_server_info = app.state.server_info[0] |  | ||||||
|         primary_server_info.stage = ServerStage.SERVING |  | ||||||
|     if config: |  | ||||||
|         app.update_config(config) |  | ||||||
|  |  | ||||||
|     if version is HTTP.VERSION_3: |  | ||||||
|         return _serve_http_3(host, port, app, loop, ssl) |  | ||||||
|     return _serve_http_1( |  | ||||||
|         host, |  | ||||||
|         port, |  | ||||||
|         app, |  | ||||||
|         ssl, |  | ||||||
|         sock, |  | ||||||
|         unix, |  | ||||||
|         reuse_port, |  | ||||||
|         loop, |  | ||||||
|         protocol, |  | ||||||
|         backlog, |  | ||||||
|         register_sys_signals, |  | ||||||
|         run_multiple, |  | ||||||
|         run_async, |  | ||||||
|         connections, |  | ||||||
|         signal, |  | ||||||
|         state, |  | ||||||
|         asyncio_server_kwargs, |  | ||||||
|     ) |  | ||||||
| @@ -1,85 +0,0 @@ | |||||||
| from collections.abc import Mapping |  | ||||||
| from typing import Any, Dict, ItemsView, Iterator, KeysView, List |  | ||||||
| from typing import Mapping as MappingType |  | ||||||
| from typing import ValuesView |  | ||||||
|  |  | ||||||
|  |  | ||||||
| dict |  | ||||||
|  |  | ||||||
|  |  | ||||||
| class WorkerState(Mapping): |  | ||||||
|     RESTRICTED = ( |  | ||||||
|         "health", |  | ||||||
|         "pid", |  | ||||||
|         "requests", |  | ||||||
|         "restart_at", |  | ||||||
|         "server", |  | ||||||
|         "start_at", |  | ||||||
|         "starts", |  | ||||||
|         "state", |  | ||||||
|     ) |  | ||||||
|  |  | ||||||
|     def __init__(self, state: Dict[str, Any], current: str) -> None: |  | ||||||
|         self._name = current |  | ||||||
|         self._state = state |  | ||||||
|  |  | ||||||
|     def __getitem__(self, key: str) -> Any: |  | ||||||
|         return self._state[self._name][key] |  | ||||||
|  |  | ||||||
|     def __setitem__(self, key: str, value: Any) -> None: |  | ||||||
|         if key in self.RESTRICTED: |  | ||||||
|             self._write_error([key]) |  | ||||||
|         self._state[self._name] = { |  | ||||||
|             **self._state[self._name], |  | ||||||
|             key: value, |  | ||||||
|         } |  | ||||||
|  |  | ||||||
|     def __delitem__(self, key: str) -> None: |  | ||||||
|         if key in self.RESTRICTED: |  | ||||||
|             self._write_error([key]) |  | ||||||
|         self._state[self._name] = { |  | ||||||
|             k: v for k, v in self._state[self._name].items() if k != key |  | ||||||
|         } |  | ||||||
|  |  | ||||||
|     def __iter__(self) -> Iterator[Any]: |  | ||||||
|         return iter(self._state[self._name]) |  | ||||||
|  |  | ||||||
|     def __len__(self) -> int: |  | ||||||
|         return len(self._state[self._name]) |  | ||||||
|  |  | ||||||
|     def __repr__(self) -> str: |  | ||||||
|         return repr(self._state[self._name]) |  | ||||||
|  |  | ||||||
|     def __eq__(self, other: object) -> bool: |  | ||||||
|         return self._state[self._name] == other |  | ||||||
|  |  | ||||||
|     def keys(self) -> KeysView[str]: |  | ||||||
|         return self._state[self._name].keys() |  | ||||||
|  |  | ||||||
|     def values(self) -> ValuesView[Any]: |  | ||||||
|         return self._state[self._name].values() |  | ||||||
|  |  | ||||||
|     def items(self) -> ItemsView[str, Any]: |  | ||||||
|         return self._state[self._name].items() |  | ||||||
|  |  | ||||||
|     def update(self, mapping: MappingType[str, Any]) -> None: |  | ||||||
|         if any(k in self.RESTRICTED for k in mapping.keys()): |  | ||||||
|             self._write_error( |  | ||||||
|                 [k for k in mapping.keys() if k in self.RESTRICTED] |  | ||||||
|             ) |  | ||||||
|         self._state[self._name] = { |  | ||||||
|             **self._state[self._name], |  | ||||||
|             **mapping, |  | ||||||
|         } |  | ||||||
|  |  | ||||||
|     def pop(self) -> None: |  | ||||||
|         raise NotImplementedError |  | ||||||
|  |  | ||||||
|     def full(self) -> Dict[str, Any]: |  | ||||||
|         return dict(self._state) |  | ||||||
|  |  | ||||||
|     def _write_error(self, keys: List[str]) -> None: |  | ||||||
|         raise LookupError( |  | ||||||
|             f"Cannot set restricted key{'s' if len(keys) > 1 else ''} on " |  | ||||||
|             f"WorkerState: {', '.join(keys)}" |  | ||||||
|         ) |  | ||||||
							
								
								
									
										11
									
								
								setup.cfg
									
									
									
									
									
								
							
							
						
						
									
										11
									
								
								setup.cfg
									
									
									
									
									
								
							| @@ -1,2 +1,13 @@ | |||||||
| [flake8] | [flake8] | ||||||
| ignore = E203, W503 | ignore = E203, W503 | ||||||
|  |  | ||||||
|  | [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 | ||||||
|   | |||||||
							
								
								
									
										37
									
								
								setup.py
									
									
									
									
									
								
							
							
						
						
									
										37
									
								
								setup.py
									
									
									
									
									
								
							| @@ -6,8 +6,6 @@ import os | |||||||
| import re | import re | ||||||
| import sys | import sys | ||||||
|  |  | ||||||
| from distutils.util import strtobool |  | ||||||
|  |  | ||||||
| from setuptools import find_packages, setup | from setuptools import find_packages, setup | ||||||
| from setuptools.command.test import test as TestCommand | from setuptools.command.test import test as TestCommand | ||||||
|  |  | ||||||
| @@ -61,7 +59,7 @@ setup_kwargs = { | |||||||
|         "Build fast. Run fast." |         "Build fast. Run fast." | ||||||
|     ), |     ), | ||||||
|     "long_description": long_description, |     "long_description": long_description, | ||||||
|     "packages": find_packages(exclude=("tests", "tests.*")), |     "packages": find_packages(include=[]), | ||||||
|     "package_data": {"sanic": ["py.typed"]}, |     "package_data": {"sanic": ["py.typed"]}, | ||||||
|     "platforms": "any", |     "platforms": "any", | ||||||
|     "python_requires": ">=3.7", |     "python_requires": ">=3.7", | ||||||
| @@ -84,21 +82,24 @@ ujson = "ujson>=1.35" + env_dependency | |||||||
| uvloop = "uvloop>=0.5.3" + env_dependency | uvloop = "uvloop>=0.5.3" + env_dependency | ||||||
| types_ujson = "types-ujson" + env_dependency | types_ujson = "types-ujson" + env_dependency | ||||||
| requirements = [ | requirements = [ | ||||||
|     "sanic-routing>=22.8.0", |     "sanic-routing~=0.7", | ||||||
|     "httptools>=0.0.10", |     "httptools>=0.0.10", | ||||||
|     uvloop, |     uvloop, | ||||||
|     ujson, |     ujson, | ||||||
|     "aiofiles>=0.6.0", |     "aiofiles>=0.6.0", | ||||||
|     "websockets>=10.0", |     "websockets>=10.0", | ||||||
|     "multidict>=5.0,<7.0", |     "multidict>=5.0,<6.0", | ||||||
| ] | ] | ||||||
|  |  | ||||||
| tests_require = [ | tests_require = [ | ||||||
|     "sanic-testing>=22.9.0b1", |     "sanic-testing>=0.7.0", | ||||||
|     "pytest", |     "pytest==6.2.5", | ||||||
|     "coverage", |     "coverage==5.3", | ||||||
|  |     "gunicorn==20.0.4", | ||||||
|  |     "pytest-cov", | ||||||
|     "beautifulsoup4", |     "beautifulsoup4", | ||||||
|     "pytest-sanic", |     "pytest-sanic", | ||||||
|  |     "pytest-sugar", | ||||||
|     "pytest-benchmark", |     "pytest-benchmark", | ||||||
|     "chardet==3.*", |     "chardet==3.*", | ||||||
|     "flake8", |     "flake8", | ||||||
| @@ -109,7 +110,6 @@ tests_require = [ | |||||||
|     "docutils", |     "docutils", | ||||||
|     "pygments", |     "pygments", | ||||||
|     "uvicorn<0.15.0", |     "uvicorn<0.15.0", | ||||||
|     "slotscheck>=0.8.0,<1", |  | ||||||
|     types_ujson, |     types_ujson, | ||||||
| ] | ] | ||||||
|  |  | ||||||
| @@ -119,7 +119,6 @@ docs_require = [ | |||||||
|     "docutils", |     "docutils", | ||||||
|     "pygments", |     "pygments", | ||||||
|     "m2r2", |     "m2r2", | ||||||
|     "enum-tools[sphinx]", |  | ||||||
|     "mistune<2.0.0", |     "mistune<2.0.0", | ||||||
| ] | ] | ||||||
|  |  | ||||||
| @@ -131,6 +130,23 @@ dev_require = tests_require + [ | |||||||
|  |  | ||||||
| all_require = list(set(dev_require + docs_require)) | all_require = list(set(dev_require + docs_require)) | ||||||
|  |  | ||||||
|  | # trying to self-refernce this from within sanic prior to install is | ||||||
|  | # problematic | ||||||
|  | def strtobool(val: str) -> bool: | ||||||
|  |     """ | ||||||
|  |     reimplement strtobool per PEP 632 and python 3.12 deprecation | ||||||
|  |  | ||||||
|  |     True values are y, yes, t, true, on and 1; false values are n, no, f, | ||||||
|  |     false, off and 0. Raises ValueError if val is anything else. | ||||||
|  |     """ | ||||||
|  |     if val.lower() in ["y", "yes", "t", "true", "on", "1"]: | ||||||
|  |         return True | ||||||
|  |     elif val.lower() in ["n", "no", "f", "false", "off", "0"]: | ||||||
|  |         return False | ||||||
|  |     else: | ||||||
|  |         raise ValueError(f"String value {val} cannot be converted to bool") | ||||||
|  |  | ||||||
|  |  | ||||||
| if strtobool(os.environ.get("SANIC_NO_UJSON", "no")): | if strtobool(os.environ.get("SANIC_NO_UJSON", "no")): | ||||||
|     print("Installing without uJSON") |     print("Installing without uJSON") | ||||||
|     requirements.remove(ujson) |     requirements.remove(ujson) | ||||||
| @@ -147,7 +163,6 @@ extras_require = { | |||||||
|     "docs": docs_require, |     "docs": docs_require, | ||||||
|     "all": all_require, |     "all": all_require, | ||||||
|     "ext": ["sanic-ext"], |     "ext": ["sanic-ext"], | ||||||
|     "http3": ["aioquic"], |  | ||||||
| } | } | ||||||
|  |  | ||||||
| setup_kwargs["install_requires"] = requirements | setup_kwargs["install_requires"] = requirements | ||||||
|   | |||||||
| @@ -25,10 +25,6 @@ class AsyncMock(Mock): | |||||||
|     def __await__(self): |     def __await__(self): | ||||||
|         return self().__await__() |         return self().__await__() | ||||||
|  |  | ||||||
|     def reset_mock(self, *args, **kwargs): |  | ||||||
|         super().reset_mock(*args, **kwargs) |  | ||||||
|         self.await_count = 0 |  | ||||||
|  |  | ||||||
|     def assert_awaited_once(self): |     def assert_awaited_once(self): | ||||||
|         if not self.await_count == 1: |         if not self.await_count == 1: | ||||||
|             msg = ( |             msg = ( | ||||||
| @@ -36,13 +32,3 @@ class AsyncMock(Mock): | |||||||
|                 f" Awaited {self.await_count} times." |                 f" Awaited {self.await_count} times." | ||||||
|             ) |             ) | ||||||
|             raise AssertionError(msg) |             raise AssertionError(msg) | ||||||
|  |  | ||||||
|     def assert_awaited_once_with(self, *args, **kwargs): |  | ||||||
|         if not self.await_count == 1: |  | ||||||
|             msg = ( |  | ||||||
|                 f"Expected to have been awaited once." |  | ||||||
|                 f" Awaited {self.await_count} times." |  | ||||||
|             ) |  | ||||||
|             raise AssertionError(msg) |  | ||||||
|         self.assert_awaited_once() |  | ||||||
|         return self.assert_called_with(*args, **kwargs) |  | ||||||
|   | |||||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user