fix issue where request.args.pop removed parameters inconsistently (#2111)

Fix uvloop 1912

.github/stale.yml

@@ -8,6 +8,7 @@ exemptLabels:
   - urgent
   - necessary
   - help wanted
+  - RFC
 # Label to use when marking an issue as stale
 staleLabel: stale
 # Comment to post when marking an issue as stale. Set to `false` to disable

.gitignore

@@ -10,6 +10,7 @@ coverage
 settings.py
 .idea/*
 .cache/*
+.mypy_cache/
 .python-version
 docs/_build/
 docs/_api/

.travis.yml

@@ -7,20 +7,55 @@ matrix:
   include:
     - env: TOX_ENV=py36
       python: 3.6
+      name: "Python 3.6 with Extensions"
     - env: TOX_ENV=py36-no-ext
       python: 3.6
+      name: "Python 3.6 without Extensions"
     - env: TOX_ENV=py37
       python: 3.7
       dist: xenial
       sudo: true
+      name: "Python 3.7 with Extensions"
     - env: TOX_ENV=py37-no-ext
       python: 3.7
       dist: xenial
       sudo: true
+      name: "Python 3.7 without Extensions"
+    - env: TOX_ENV=type-checking
+      python: 3.6
+      name: "Python 3.6 Type checks"
+    - env: TOX_ENV=type-checking
+      python: 3.7
+      name: "Python 3.7 Type checks"
     - env: TOX_ENV=lint
       python: 3.6
+      name: "Python 3.6 Linter checks"
     - env: TOX_ENV=check
       python: 3.6
+      name: "Python 3.6 Package checks"
+    - env: TOX_ENV=security
+      python: 3.7
+      dist: xenial
+      sudo: true
+      name: "Python 3.7 Bandit security scan"
+    - env: TOX_ENV=docs
+      python: 3.7
+      dist: xenial
+      sudo: true
+      name: "Python 3.7 Documentation tests"
+    - env: TOX_ENV=pyNightly
+      python: 'nightly'
+      name: "Python nightly with Extensions"
+    - env: TOX_ENV=pyNightly-no-ext
+      python: 'nightly'
+      name: "Python nightly Extensions"
+  allow_failures:
+    - env: TOX_ENV=pyNightly
+      python: 'nightly'
+      name: "Python nightly with Extensions"
+    - env: TOX_ENV=pyNightly-no-ext
+      python: 'nightly'
+      name: "Python nightly Extensions"
 install:
   - pip install -U tox
   - pip install codecov

CHANGELOG.md

@@ -1,261 +0,0 @@
-Version 19.6
-------------
-19.6.0
-  - Changes:
-    - Remove `aiohttp` dependencey and create new `SanicTestClient` based upon
-    [`requests-async`](https://github.com/encode/requests-async).
-
-  - Deprecation:
-    - Support for Python 3.5
-
-Note: Sanic will not support Python 3.5 from version 19.6 and forward. However,
-version 18.12LTS will have its support period extended thru December 2020, and
-therefore passing Python's official support version 3.5, which is set to expire
-in September 2020.
-
-Version 19.3
--------------
-19.3.1
-  - Changes:
-    - [#1497](https://github.com/huge-success/sanic/pull/1497)
-      Add support for zero-length and RFC 5987 encoded filename for
-      multipart/form-data requests.
-
-    - [#1484](https://github.com/huge-success/sanic/pull/1484)
-      The type of `expires` attribute of `sanic.cookies.Cookie` is now
-      enforced to be of type `datetime`.
-
-    - [#1482](https://github.com/huge-success/sanic/pull/1482)
-      Add support for the `stream` parameter of `sanic.Sanic.add_route()`
-      available to `sanic.Blueprint.add_route()`.
-
-    - [#1481](https://github.com/huge-success/sanic/pull/1481)
-      Accept negative values for route parameters with type `int` or `number`.
-
-    - [#1476](https://github.com/huge-success/sanic/pull/1476)
-      Deprecated the use of `sanic.request.Request.raw_args` - it has a
-      fundamental flaw in which is drops repeated query string parameters.
-      Added `sanic.request.Request.query_args` as a replacement for the
-      original use-case.
-
-    - [#1472](https://github.com/huge-success/sanic/pull/1472)
-      Remove an unwanted `None` check in Request class `repr` implementation.
-      This changes the default `repr` of a Request from `<Request>` to
-      `<Request: None />`
-
-    - [#1470](https://github.com/huge-success/sanic/pull/1470)
-      Added 2 new parameters to `sanic.app.Sanic.create_server`:
-      - `return_asyncio_server` - whether to return an asyncio.Server.
-      - `asyncio_server_kwargs` - kwargs to pass to `loop.create_server` for
-        the event loop that sanic is using.
-
-      This is a breaking change.
-
-    - [#1499](https://github.com/huge-success/sanic/pull/1499)
-      Added a set of test cases that test and benchmark route resolution.
-
-    - [#1457](https://github.com/huge-success/sanic/pull/1457)
-      The type of the `"max-age"` value in a `sanic.cookies.Cookie` is now
-      enforced to be an integer. Non-integer values are replaced with `0`.
-
-    - [#1445](https://github.com/huge-success/sanic/pull/1445)
-      Added the `endpoint` attribute to an incoming `request`, containing the
-      name of the handler function.
-
-    - [#1423](https://github.com/huge-success/sanic/pull/1423)
-      Improved request streaming. `request.stream` is now a bounded-size buffer
-      instead of an unbounded queue. Callers must now call
-      `await request.stream.read()` instead of `await request.stream.get()`
-      to read each portion of the body.
-
-      This is a breaking change.
-
-  - Fixes:
-    - [#1502](https://github.com/huge-success/sanic/pull/1502)
-      Sanic was prefetching `time.time()` and updating it once per second to
-      avoid excessive `time.time()` calls. The implementation was observed to
-      cause memory leaks in some cases. The benefit of the prefetch appeared
-      to negligible, so this has been removed. Fixes
-      [#1500](https://github.com/huge-success/sanic/pull/1500)
-
-    - [#1501](https://github.com/huge-success/sanic/pull/1501)
-      Fix a bug in the auto-reloader when the process was launched as a module
-      i.e. `python -m init0.mod1` where the sanic server is started
-      in `init0/mod1.py` with `debug` enabled and imports another module in
-      `init0`.
-
-    - [#1376](https://github.com/huge-success/sanic/pull/1376)
-      Allow sanic test client to bind to a random port by specifying
-      `port=None` when constructing a `SanicTestClient`
-
-    - [#1399](https://github.com/huge-success/sanic/pull/1399)
-      Added the ability to specify middleware on a blueprint group, so that all
-      routes produced from the blueprints in the group have the middleware
-      applied.
-
-    - [#1442](https://github.com/huge-success/sanic/pull/1442)
-      Allow the the use the `SANIC_ACCESS_LOG` environment variable to
-      enable/disable the access log when not explicitly passed to `app.run()`.
-      This allows the access log to be disabled for example when running via
-      gunicorn.
-
-  - Developer infrastructure:
-    - [#1529](https://github.com/huge-success/sanic/pull/1529) Update project PyPI credentials
-    - [#1515](https://github.com/huge-success/sanic/pull/1515) fix linter issue causing travis build failures (fix #1514)
-    - [#1490](https://github.com/huge-success/sanic/pull/1490) Fix python version in doc build
-    - [#1478](https://github.com/huge-success/sanic/pull/1478) Upgrade setuptools version and use native docutils in doc build
-    - [#1464](https://github.com/huge-success/sanic/pull/1464) Upgrade pytest, and fix caplog unit tests
-
-  - Typos and Documentation:
-    - [#1516](https://github.com/huge-success/sanic/pull/1516) Fix typo at the exception documentation
-    - [#1510](https://github.com/huge-success/sanic/pull/1510) fix typo in Asyncio example
-    - [#1486](https://github.com/huge-success/sanic/pull/1486) Documentation typo
-    - [#1477](https://github.com/huge-success/sanic/pull/1477) Fix grammar in README.md
-    - [#1489](https://github.com/huge-success/sanic/pull/1489) Added "databases" to the extensions list
-    - [#1483](https://github.com/huge-success/sanic/pull/1483) Add sanic-zipkin to extensions list
-    - [#1487](https://github.com/huge-success/sanic/pull/1487) Removed link to deleted repo, Sanic-OAuth, from the extensions list
-    - [#1460](https://github.com/huge-success/sanic/pull/1460) 18.12 changelog
-    - [#1449](https://github.com/huge-success/sanic/pull/1449) Add example of amending request object
-    - [#1446](https://github.com/huge-success/sanic/pull/1446) Update README
-    - [#1444](https://github.com/huge-success/sanic/pull/1444) Update README
-    - [#1443](https://github.com/huge-success/sanic/pull/1443) Update README, including new logo
-    - [#1440](https://github.com/huge-success/sanic/pull/1440) fix minor type and pip install instruction mismatch
-    - [#1424](https://github.com/huge-success/sanic/pull/1424) Documentation Enhancements
-
-Note: 19.3.0 was skipped for packagement purposes and not released on PyPI
-
-Version 18.12
--------------
-18.12.0
-  - Changes:
-    - Improved codebase test coverage from 81% to 91%.
-    - Added stream_large_files and host examples in static_file document
-    - Added methods to append and finish body content on Request (#1379)
-    - Integrated with .appveyor.yml for windows ci support
-    - Added documentation for AF_INET6 and AF_UNIX socket usage
-    - Adopt black/isort for codestyle
-    - Cancel task when connection_lost
-    - Simplify request ip and port retrieval logic
-    - Handle config error in load config file.
-    - Integrate with codecov for CI
-    - Add missed documentation for config section.
-    - Deprecate Handler.log
-    - Pinned httptools requirement to version 0.0.10+
-
-  - Fixes:
-    - Fix `remove_entity_headers` helper function (#1415)
-    - Fix TypeError when use Blueprint.group() to group blueprint with default url_prefix, Use os.path.normpath to avoid invalid url_prefix like api//v1
-    f8a6af1 Rename the `http` module to `helpers` to prevent conflicts with the built-in Python http library (fixes #1323)
-    - Fix unittests on windows
-    - Fix Namespacing of sanic logger
-    - Fix missing quotes in decorator example
-    - Fix redirect with quoted param
-    - Fix doc for latest blueprint code
-    - Fix build of latex documentation relating to markdown lists
-    - Fix loop exception handling in app.py
-    - Fix content length mismatch in windows and other platform
-    - Fix Range header handling for static files (#1402)
-    - Fix the logger and make it work (#1397)
-    - Fix type pikcle->pickle in multiprocessing test
-    - Fix pickling blueprints Change the string passed in the "name" section of the namedtuples in Blueprint to match the name of the Blueprint module attribute name. This allows blueprints to be pickled and unpickled, without errors, which is a requirment of running Sanic in multiprocessing mode in Windows. Added a test for pickling and unpickling blueprints Added a test for pickling and unpickling sanic itself Added a test for enabling multiprocessing on an app with a blueprint (only useful to catch this bug if the tests are run on Windows).
-    - Fix document for logging
-
-Version 0.8
------------
-0.8.3
-  - Changes:
-    - Ownership changed to org 'huge-success'
-
-0.8.0
-  - Changes:
-    - Add Server-Sent Events extension (Innokenty Lebedev)
-    - Graceful handling of request_handler_task cancellation (Ashley Sommer)
-    - Sanitize URL before redirection (aveao)
-    - Add url_bytes to request (johndoe46)
-    - py37 support for travisci (yunstanford)
-    - Auto reloader support for OSX (garyo)
-    - Add UUID route support (Volodymyr Maksymiv)
-    - Add pausable response streams (Ashley Sommer)
-    - Add weakref to request slots (vopankov)
-    - remove ubuntu 12.04 from test fixture due to deprecation (yunstanford)
-    - Allow streaming handlers in add_route (kinware)
-    - use travis_retry for tox (Raphael Deem)
-    - update aiohttp version for test client (yunstanford)
-    - add redirect import for clarity (yingshaoxo)
-    - Update HTTP Entity headers (Arnulfo Solís)
-    - Add register_listener method (Stephan Fitzpatrick)
-    - Remove uvloop/ujson dependencies for Windows (abuckenheimer)
-    - Content-length header on 204/304 responses (Arnulfo Solís)
-    - Extend WebSocketProtocol arguments and add docs (Bob Olde Hampsink, yunstanford)
-    - Update development status from pre-alpha to beta (Maksim Anisenkov)
-    - KeepAlive Timout log level changed to debug (Arnulfo Solís)
-    - Pin pytest to 3.3.2 because of pytest-dev/pytest#3170 (Maksim Aniskenov)
-    - Install Python 3.5 and 3.6 on docker container for tests (Shahin Azad)
-    - Add support for blueprint groups and nesting (Elias Tarhini)
-    - Remove uvloop for windows setup (Aleksandr Kurlov)
-    - Auto Reload (Yaser Amari)
-    - Documentation updates/fixups (multiple contributors)
-
-  - Fixes:
-    - Fix: auto_reload in Linux (Ashley Sommer)
-    - Fix: broken tests for aiohttp >= 3.3.0 (Ashley Sommer)
-    - Fix: disable auto_reload by default on windows (abuckenheimer)
-    - Fix (1143): Turn off access log with gunicorn (hqy)
-    - Fix (1268): Support status code for file response (Cosmo Borsky)
-    - Fix (1266): Add content_type flag to Sanic.static (Cosmo Borsky)
-    - Fix: subprotocols parameter missing from add_websocket_route (ciscorn)
-    - Fix (1242): Responses for CI header (yunstanford)
-    - Fix (1237): add version constraint for websockets (yunstanford)
-    - Fix (1231): memory leak - always release resource (Phillip Xu)
-    - Fix (1221): make request truthy if transport exists (Raphael Deem)
-    - Fix failing tests for aiohttp>=3.1.0 (Ashley Sommer)
-    - Fix try_everything examples (PyManiacGR, kot83)
-    - Fix (1158): default to auto_reload in debug mode (Raphael Deem)
-    - Fix (1136): ErrorHandler.response handler call too restrictive (Julien Castiaux)
-    - Fix: raw requires bytes-like object (cloudship)
-    - Fix (1120): passing a list in to a route decorator's host arg (Timothy Ebiuwhe)
-    - Fix: Bug in multipart/form-data parser (DirkGuijt)
-    - Fix: Exception for missing parameter when value is null (NyanKiyoshi)
-    - Fix: Parameter check (Howie Hu)
-    - Fix (1089): Routing issue with named parameters and different methods (yunstanford)
-    - Fix (1085): Signal handling in multi-worker mode (yunstanford)
-    - Fix: single quote in readme.rst (Cosven)
-    - Fix: method typos (Dmitry Dygalo)
-    - Fix: log_response correct output for ip and port (Wibowo Arindrarto)
-    - Fix (1042): Exception Handling (Raphael Deem)
-    - Fix: Chinese URIs (Howie Hu)
-    - Fix (1079): timeout bug when self.transport is None (Raphael Deem)
-    - Fix (1074): fix strict_slashes when route has slash (Raphael Deem)
-    - Fix (1050): add samesite cookie to cookie keys (Raphael Deem)
-    - Fix (1065): allow add_task after server starts (Raphael Deem)
-    - Fix (1061): double quotes in unauthorized exception (Raphael Deem)
-    - Fix (1062): inject the app in add_task method (Raphael Deem)
-    - Fix: update environment.yml for readthedocs (Eli Uriegas)
-    - Fix: Cancel request task when response timeout is triggered (Jeong YunWon)
-    - Fix (1052): Method not allowed response for RFC7231 compliance (Raphael Deem)
-    - Fix: IPv6 Address and Socket Data Format (Dan Palmer)
-
-Note: Changelog was unmaintained between 0.1 and 0.7
-
-Version 0.1
------------
- - 0.1.7
-  - Reversed static url and directory arguments to meet spec
- - 0.1.6
-  - Static files
-  - Lazy Cookie Loading
- - 0.1.5
-  - Cookies
-  - Blueprint listeners and ordering
-  - Faster Router
-  - Fix: Incomplete file reads on medium+ sized post requests
-  - Breaking: after_start and before_stop now pass sanic as their first argument
- - 0.1.4
-  - Multiprocessing
- - 0.1.3
-  - Blueprint support
-  - Faster Response processing
- - 0.1.1 - 0.1.2
-  - Struggling to update pypi via CI
- - 0.1.0
-  - Released to public

CHANGELOG.rst

@@ -0,0 +1,433 @@
+Version 19.12.0
+===============
+
+Bugfixes
+********
+
+- Fix blueprint middleware application
+
+  Currently, any blueprint middleware registered, irrespective of which blueprint was used to do so, was
+  being applied to all of the routes created by the :code:`@app` and :code:`@blueprint` alike.
+
+  As part of this change, the blueprint based middleware application is enforced based on where they are
+  registered.
+
+  - If you register a middleware via :code:`@blueprint.middleware` then it will apply only to the routes defined by the blueprint.
+  - If you register a middleware via :code:`@blueprint_group.middleware` then it will apply to all blueprint based routes that are part of the group.
+  - If you define a middleware via :code:`@app.middleware` then it will be applied on all available routes (`#37 <https://github.com/huge-success/sanic/issues/37>`__)
+- Fix `url_for` behavior with missing SERVER_NAME
+
+  If the `SERVER_NAME` was missing in the `app.config` entity, the `url_for` on the `request` and  `app` were failing
+  due to an `AttributeError`. This fix makes the availability of `SERVER_NAME` on our `app.config` an optional behavior. (`#1707 <https://github.com/huge-success/sanic/issues/1707>`__)
+
+
+Improved Documentation
+**********************
+
+- Move docs from RST to MD
+
+  Moved all docs from markdown to restructured text like the rest of the docs to unify the scheme and make it easier in
+  the future to update documentation. (`#1691 <https://github.com/huge-success/sanic/issues/1691>`__)
+- Fix documentation for `get` and `getlist` of the `request.args`
+
+  Add additional example for showing the usage of `getlist` and fix the documentation string for `request.args` behavior (`#1704 <https://github.com/huge-success/sanic/issues/1704>`__)
+
+
+Version 19.6.3
+==============
+
+Features
+********
+
+- Enable Towncrier Support
+
+  As part of this feature, `towncrier` is being introduced as a mechanism to partially  automate the process
+  of generating and managing change logs as part of each of pull requests. (`#1631 <https://github.com/huge-success/sanic/issues/1631>`__)
+
+
+Improved Documentation
+**********************
+
+- Documentation infrastructure changes
+
+  - Enable having a single common `CHANGELOG` file for both GitHub page and documentation
+  - Fix Sphinix deprecation warnings
+  - Fix documentation warnings due to invalid `rst` indentation
+  - Enable common contribution guidelines file across GitHub and documentation via `CONTRIBUTING.rst` (`#1631 <https://github.com/huge-success/sanic/issues/1631>`__)
+
+
+Version 19.6.2
+==============
+
+Features
+********
+
+  * 
+    `#1562 <https://github.com/huge-success/sanic/pull/1562>`_
+    Remove ``aiohttp`` dependencey and create new ``SanicTestClient`` based upon
+    `requests-async <https://github.com/encode/requests-async>`_
+
+  * 
+    `#1475 <https://github.com/huge-success/sanic/pull/1475>`_
+    Added ASGI support (Beta)
+
+  * 
+    `#1436 <https://github.com/huge-success/sanic/pull/1436>`_
+    Add Configure support from object string
+
+
+Bugfixes
+********
+
+  * 
+    `#1587 <https://github.com/huge-success/sanic/pull/1587>`_
+    Add missing handle for Expect header.
+
+  * 
+    `#1560 <https://github.com/huge-success/sanic/pull/1560>`_
+    Allow to disable Transfer-Encoding: chunked.
+
+  * 
+    `#1558 <https://github.com/huge-success/sanic/pull/1558>`_
+    Fix graceful shutdown.
+
+  * 
+    `#1594 <https://github.com/huge-success/sanic/pull/1594>`_
+    Strict Slashes behavior fix
+
+Deprecations and Removals
+*************************
+
+  *
+    `#1544 <https://github.com/huge-success/sanic/pull/1544>`_
+    Drop dependency on distutil
+
+  * 
+    `#1562 <https://github.com/huge-success/sanic/pull/1562>`_
+    Drop support for Python 3.5
+
+  * 
+    `#1568 <https://github.com/huge-success/sanic/pull/1568>`_
+    Deprecate route removal.
+
+.. warning::
+    Sanic will not support Python 3.5 from version 19.6 and forward. However,
+    version 18.12LTS will have its support period extended thru December 2020, and
+    therefore passing Python's official support version 3.5, which is set to expire
+    in September 2020.
+
+
+Version 19.3
+============
+
+Features
+********
+
+  * 
+    `#1497 <https://github.com/huge-success/sanic/pull/1497>`_
+    Add support for zero-length and RFC 5987 encoded filename for
+    multipart/form-data requests.
+
+  * 
+    `#1484 <https://github.com/huge-success/sanic/pull/1484>`_
+    The type of ``expires`` attribute of ``sanic.cookies.Cookie`` is now
+    enforced to be of type ``datetime``.
+
+  * 
+    `#1482 <https://github.com/huge-success/sanic/pull/1482>`_
+    Add support for the ``stream`` parameter of ``sanic.Sanic.add_route()``
+    available to ``sanic.Blueprint.add_route()``.
+
+  * 
+    `#1481 <https://github.com/huge-success/sanic/pull/1481>`_
+    Accept negative values for route parameters with type ``int`` or ``number``.
+
+  * 
+    `#1476 <https://github.com/huge-success/sanic/pull/1476>`_
+    Deprecated the use of ``sanic.request.Request.raw_args`` - it has a
+    fundamental flaw in which is drops repeated query string parameters.
+    Added ``sanic.request.Request.query_args`` as a replacement for the
+    original use-case.
+
+  * 
+    `#1472 <https://github.com/huge-success/sanic/pull/1472>`_
+    Remove an unwanted ``None`` check in Request class ``repr`` implementation.
+    This changes the default ``repr`` of a Request from ``<Request>`` to
+    ``<Request: None />``
+
+  * 
+    `#1470 <https://github.com/huge-success/sanic/pull/1470>`_
+    Added 2 new parameters to ``sanic.app.Sanic.create_server``\ :
+
+
+    * ``return_asyncio_server`` - whether to return an asyncio.Server.
+    * ``asyncio_server_kwargs`` - kwargs to pass to ``loop.create_server`` for
+      the event loop that sanic is using.
+
+    This is a breaking change.
+
+  * 
+    `#1499 <https://github.com/huge-success/sanic/pull/1499>`_
+    Added a set of test cases that test and benchmark route resolution.
+
+  * 
+    `#1457 <https://github.com/huge-success/sanic/pull/1457>`_
+    The type of the ``"max-age"`` value in a ``sanic.cookies.Cookie`` is now
+    enforced to be an integer. Non-integer values are replaced with ``0``.
+
+  * 
+    `#1445 <https://github.com/huge-success/sanic/pull/1445>`_
+    Added the ``endpoint`` attribute to an incoming ``request``\ , containing the
+    name of the handler function.
+
+  * 
+    `#1423 <https://github.com/huge-success/sanic/pull/1423>`_
+    Improved request streaming. ``request.stream`` is now a bounded-size buffer
+    instead of an unbounded queue. Callers must now call
+    ``await request.stream.read()`` instead of ``await request.stream.get()``
+    to read each portion of the body.
+
+    This is a breaking change.
+
+Bugfixes
+********
+
+
+  * 
+    `#1502 <https://github.com/huge-success/sanic/pull/1502>`_
+    Sanic was prefetching ``time.time()`` and updating it once per second to
+    avoid excessive ``time.time()`` calls. The implementation was observed to
+    cause memory leaks in some cases. The benefit of the prefetch appeared
+    to negligible, so this has been removed. Fixes
+    `#1500 <https://github.com/huge-success/sanic/pull/1500>`_
+
+  * 
+    `#1501 <https://github.com/huge-success/sanic/pull/1501>`_
+    Fix a bug in the auto-reloader when the process was launched as a module
+    i.e. ``python -m init0.mod1`` where the sanic server is started
+    in ``init0/mod1.py`` with ``debug`` enabled and imports another module in
+    ``init0``.
+
+  * 
+    `#1376 <https://github.com/huge-success/sanic/pull/1376>`_
+    Allow sanic test client to bind to a random port by specifying
+    ``port=None`` when constructing a ``SanicTestClient``
+
+  * 
+    `#1399 <https://github.com/huge-success/sanic/pull/1399>`_
+    Added the ability to specify middleware on a blueprint group, so that all
+    routes produced from the blueprints in the group have the middleware
+    applied.
+
+  * 
+    `#1442 <https://github.com/huge-success/sanic/pull/1442>`_
+    Allow the the use the ``SANIC_ACCESS_LOG`` environment variable to
+    enable/disable the access log when not explicitly passed to ``app.run()``.
+    This allows the access log to be disabled for example when running via
+    gunicorn.
+
+Developer infrastructure
+************************
+
+  * `#1529 <https://github.com/huge-success/sanic/pull/1529>`_ Update project PyPI credentials
+  * `#1515 <https://github.com/huge-success/sanic/pull/1515>`_ fix linter issue causing travis build failures (fix #1514)
+  * `#1490 <https://github.com/huge-success/sanic/pull/1490>`_ Fix python version in doc build
+  * `#1478 <https://github.com/huge-success/sanic/pull/1478>`_ Upgrade setuptools version and use native docutils in doc build
+  * `#1464 <https://github.com/huge-success/sanic/pull/1464>`_ Upgrade pytest, and fix caplog unit tests
+
+Improved Documentation
+**********************
+
+  * `#1516 <https://github.com/huge-success/sanic/pull/1516>`_ Fix typo at the exception documentation
+  * `#1510 <https://github.com/huge-success/sanic/pull/1510>`_ fix typo in Asyncio example
+  * `#1486 <https://github.com/huge-success/sanic/pull/1486>`_ Documentation typo
+  * `#1477 <https://github.com/huge-success/sanic/pull/1477>`_ Fix grammar in README.md
+  * `#1489 <https://github.com/huge-success/sanic/pull/1489>`_ Added "databases" to the extensions list
+  * `#1483 <https://github.com/huge-success/sanic/pull/1483>`_ Add sanic-zipkin to extensions list
+  * `#1487 <https://github.com/huge-success/sanic/pull/1487>`_ Removed link to deleted repo, Sanic-OAuth, from the extensions list
+  * `#1460 <https://github.com/huge-success/sanic/pull/1460>`_ 18.12 changelog
+  * `#1449 <https://github.com/huge-success/sanic/pull/1449>`_ Add example of amending request object
+  * `#1446 <https://github.com/huge-success/sanic/pull/1446>`_ Update README
+  * `#1444 <https://github.com/huge-success/sanic/pull/1444>`_ Update README
+  * `#1443 <https://github.com/huge-success/sanic/pull/1443>`_ Update README, including new logo
+  * `#1440 <https://github.com/huge-success/sanic/pull/1440>`_ fix minor type and pip install instruction mismatch
+  * `#1424 <https://github.com/huge-success/sanic/pull/1424>`_ Documentation Enhancements
+
+Note: 19.3.0 was skipped for packagement purposes and not released on PyPI
+
+Version 18.12
+=============
+
+18.12.0
+*******
+
+* 
+  Changes:
+
+
+  * Improved codebase test coverage from 81% to 91%.
+  * Added stream_large_files and host examples in static_file document
+  * Added methods to append and finish body content on Request (#1379)
+  * Integrated with .appveyor.yml for windows ci support
+  * Added documentation for AF_INET6 and AF_UNIX socket usage
+  * Adopt black/isort for codestyle
+  * Cancel task when connection_lost
+  * Simplify request ip and port retrieval logic
+  * Handle config error in load config file.
+  * Integrate with codecov for CI
+  * Add missed documentation for config section.
+  * Deprecate Handler.log
+  * Pinned httptools requirement to version 0.0.10+
+
+* 
+  Fixes:
+
+
+  * Fix ``remove_entity_headers`` helper function (#1415)
+  * Fix TypeError when use Blueprint.group() to group blueprint with default url_prefix, Use os.path.normpath to avoid invalid url_prefix like api//v1
+    f8a6af1 Rename the ``http`` module to ``helpers`` to prevent conflicts with the built-in Python http library (fixes #1323)
+  * Fix unittests on windows
+  * Fix Namespacing of sanic logger
+  * Fix missing quotes in decorator example
+  * Fix redirect with quoted param
+  * Fix doc for latest blueprint code
+  * Fix build of latex documentation relating to markdown lists
+  * Fix loop exception handling in app.py
+  * Fix content length mismatch in windows and other platform
+  * Fix Range header handling for static files (#1402)
+  * Fix the logger and make it work (#1397)
+  * Fix type pikcle->pickle in multiprocessing test
+  * Fix pickling blueprints Change the string passed in the "name" section of the namedtuples in Blueprint to match the name of the Blueprint module attribute name. This allows blueprints to be pickled and unpickled, without errors, which is a requirment of running Sanic in multiprocessing mode in Windows. Added a test for pickling and unpickling blueprints Added a test for pickling and unpickling sanic itself Added a test for enabling multiprocessing on an app with a blueprint (only useful to catch this bug if the tests are run on Windows).
+  * Fix document for logging
+
+Version 0.8
+===========
+
+0.8.3
+*****
+
+* Changes:
+
+  * Ownership changed to org 'huge-success'
+
+0.8.0
+*****
+
+* Changes:
+
+
+  * Add Server-Sent Events extension (Innokenty Lebedev)
+  * Graceful handling of request_handler_task cancellation (Ashley Sommer)
+  * Sanitize URL before redirection (aveao)
+  * Add url_bytes to request (johndoe46)
+  * py37 support for travisci (yunstanford)
+  * Auto reloader support for OSX (garyo)
+  * Add UUID route support (Volodymyr Maksymiv)
+  * Add pausable response streams (Ashley Sommer)
+  * Add weakref to request slots (vopankov)
+  * remove ubuntu 12.04 from test fixture due to deprecation (yunstanford)
+  * Allow streaming handlers in add_route (kinware)
+  * use travis_retry for tox (Raphael Deem)
+  * update aiohttp version for test client (yunstanford)
+  * add redirect import for clarity (yingshaoxo)
+  * Update HTTP Entity headers (Arnulfo Solís)
+  * Add register_listener method (Stephan Fitzpatrick)
+  * Remove uvloop/ujson dependencies for Windows (abuckenheimer)
+  * Content-length header on 204/304 responses (Arnulfo Solís)
+  * Extend WebSocketProtocol arguments and add docs (Bob Olde Hampsink, yunstanford)
+  * Update development status from pre-alpha to beta (Maksim Anisenkov)
+  * KeepAlive Timout log level changed to debug (Arnulfo Solís)
+  * Pin pytest to 3.3.2 because of pytest-dev/pytest#3170 (Maksim Aniskenov)
+  * Install Python 3.5 and 3.6 on docker container for tests (Shahin Azad)
+  * Add support for blueprint groups and nesting (Elias Tarhini)
+  * Remove uvloop for windows setup (Aleksandr Kurlov)
+  * Auto Reload (Yaser Amari)
+  * Documentation updates/fixups (multiple contributors)
+
+* Fixes:
+
+
+  * Fix: auto_reload in Linux (Ashley Sommer)
+  * Fix: broken tests for aiohttp >= 3.3.0 (Ashley Sommer)
+  * Fix: disable auto_reload by default on windows (abuckenheimer)
+  * Fix (1143): Turn off access log with gunicorn (hqy)
+  * Fix (1268): Support status code for file response (Cosmo Borsky)
+  * Fix (1266): Add content_type flag to Sanic.static (Cosmo Borsky)
+  * Fix: subprotocols parameter missing from add_websocket_route (ciscorn)
+  * Fix (1242): Responses for CI header (yunstanford)
+  * Fix (1237): add version constraint for websockets (yunstanford)
+  * Fix (1231): memory leak - always release resource (Phillip Xu)
+  * Fix (1221): make request truthy if transport exists (Raphael Deem)
+  * Fix failing tests for aiohttp>=3.1.0 (Ashley Sommer)
+  * Fix try_everything examples (PyManiacGR, kot83)
+  * Fix (1158): default to auto_reload in debug mode (Raphael Deem)
+  * Fix (1136): ErrorHandler.response handler call too restrictive (Julien Castiaux)
+  * Fix: raw requires bytes-like object (cloudship)
+  * Fix (1120): passing a list in to a route decorator's host arg (Timothy Ebiuwhe)
+  * Fix: Bug in multipart/form-data parser (DirkGuijt)
+  * Fix: Exception for missing parameter when value is null (NyanKiyoshi)
+  * Fix: Parameter check (Howie Hu)
+  * Fix (1089): Routing issue with named parameters and different methods (yunstanford)
+  * Fix (1085): Signal handling in multi-worker mode (yunstanford)
+  * Fix: single quote in readme.rst (Cosven)
+  * Fix: method typos (Dmitry Dygalo)
+  * Fix: log_response correct output for ip and port (Wibowo Arindrarto)
+  * Fix (1042): Exception Handling (Raphael Deem)
+  * Fix: Chinese URIs (Howie Hu)
+  * Fix (1079): timeout bug when self.transport is None (Raphael Deem)
+  * Fix (1074): fix strict_slashes when route has slash (Raphael Deem)
+  * Fix (1050): add samesite cookie to cookie keys (Raphael Deem)
+  * Fix (1065): allow add_task after server starts (Raphael Deem)
+  * Fix (1061): double quotes in unauthorized exception (Raphael Deem)
+  * Fix (1062): inject the app in add_task method (Raphael Deem)
+  * Fix: update environment.yml for readthedocs (Eli Uriegas)
+  * Fix: Cancel request task when response timeout is triggered (Jeong YunWon)
+  * Fix (1052): Method not allowed response for RFC7231 compliance (Raphael Deem)
+  * Fix: IPv6 Address and Socket Data Format (Dan Palmer)
+
+Note: Changelog was unmaintained between 0.1 and 0.7
+
+Version 0.1
+===========
+
+
+0.1.7
+*****
+
+  * Reversed static url and directory arguments to meet spec
+
+0.1.6
+*****
+
+  * Static files
+  * Lazy Cookie Loading
+
+0.1.5
+*****
+
+  * Cookies
+  * Blueprint listeners and ordering
+  * Faster Router
+  * Fix: Incomplete file reads on medium+ sized post requests
+  * Breaking: after_start and before_stop now pass sanic as their first argument
+
+0.1.4
+*****
+
+  * Multiprocessing
+
+0.1.3
+*****
+
+  * Blueprint support
+  * Faster Response processing
+
+0.1.1 - 0.1.2
+*************
+
+  * Struggling to update pypi via CI
+
+0.1.0
+*****
+
+  * Released to public

CONTRIBUTING.md

@@ -1,141 +0,0 @@
-# Contributing
-
-Thank you for your interest! Sanic is always looking for contributors. If you
-don't feel comfortable contributing code, adding docstrings to the source files
-is very appreciated.
-
-We are committed to providing a friendly, safe and welcoming environment for all,
-regardless of gender, sexual orientation, disability, ethnicity, religion,
-or similar personal characteristic.
-Our [code of conduct](./CONDUCT.md) sets the standards for behavior.
-
-## Installation
-
-To develop on sanic (and mainly to just run the tests) it is highly recommend to
-install from sources.
-
-So assume you have already cloned the repo and are in the working directory with
-a virtual environment already set up, then run:
-
-```bash
-pip3 install -e . ".[dev]"
-```
-
-# Dependency Changes
-
-`Sanic` doesn't use `requirements*.txt` files to manage any kind of dependencies related to it in order to simplify the
-effort required in managing the dependencies. Please make sure you have read and understood the following section of
-the document that explains the way `sanic` manages dependencies inside the `setup.py` file.
-
-| Dependency Type                           | Usage                                                                      | Installation                 |
-| ------------------------------------------| -------------------------------------------------------------------------- | ---------------------------  |
-| requirements                              | Bare minimum dependencies required for sanic to function                   | pip3 install -e .            |
-| tests_require / extras_require['test']    | Dependencies required to run the Unit Tests for `sanic`                    | pip3 install -e '.[test]'    |
-| extras_require['dev']                     | Additional Development requirements to add contributing                    | pip3 install -e '.[dev]'     |
-| extras_require['docs']                    | Dependencies required to enable building and enhancing sanic documentation | pip3 install -e '.[docs]'    |
-
-## Running all tests 
-To run the tests for Sanic it is recommended to use tox like so:
-
-```bash
-tox
-```
-See it's that simple!
-
-`tox.ini` contains different environments. Running `tox` without any arguments will 
-run all unittests, perform lint and other checks. 
-
-## Run unittests : 
-`tox` environment -> `[testenv]`
-
-To execute only unittests, run `tox` with environment like so: 
-
-```bash
-tox -e py36 -v -- tests/test_config.py
-# or 
-tox -e py37 -v -- tests/test_config.py
-```
-
-## Run lint checks : 
-`tox` environment -> `[testenv:lint]`
-
-Permform `flake8`, `black` and `isort` checks.
-```bash
-tox -e lint
-```
-
-## Run other checks : 
-`tox` environment -> `[testenv:check]`
-
-Perform other checks.
-```bash
-tox -e check
-```
-
-# Code Style 
-To maintain the code consistency, Sanic uses following tools. 
-
-1. [isort](https://github.com/timothycrosley/isort)
-2. [black](https://github.com/python/black)
-2. [flake8](https://github.com/PyCQA/flake8)
-
-
-## isort
-`isort` sorts Python imports. It divides imports into three 
-categories sorted each in alphabetical order. 
-  1. built-in
-  2. third-party
-  3. project-specific
-
-## black
-`black` is a Python code formatter.
-
-## flake8
-`flake8` is a Python style guide that wraps following tools into one.
-1. PyFlakes
-2. pycodestyle
-3. Ned Batchelder's McCabe script 
-
-`isort`, `black` and `flake8` checks are performed during `tox` lint checks. 
-
-Refer [tox](https://tox.readthedocs.io/en/latest/index.html) documentation for more details.
-
-## Pull requests!
-
-So the pull request approval rules are pretty simple:
-1. All pull requests must pass unit tests.
-2. All pull requests must be reviewed and approved by at least
-  one current collaborator on the project.
-3. All pull requests must pass flake8 checks.
-4. All pull requests must be consistent with the existing code.
-5. If you decide to remove/change anything from any common interface
-  a deprecation message should accompany it.
-6. If you implement a new feature you should have at least one unit
-  test to accompany it.
-7. An example must be one of the following:
-  * Example of how to use Sanic
-  * Example of how to use Sanic extensions
-  * Example of how to use Sanic and asynchronous library
-
-## Documentation
-
-Sanic's documentation is built
-using [sphinx](http://www.sphinx-doc.org/en/1.5.1/). Guides are written in
-Markdown and can be found in the `docs` folder, while the module reference is
-automatically generated using `sphinx-apidoc`.
-
-To generate the documentation from scratch:
-
-```bash
-sphinx-apidoc -fo docs/_api/ sanic
-sphinx-build -b html docs docs/_build
-```
-
-The HTML documentation will be created in the `docs/_build` folder.
-
-## Warning
-
-One of the main goals of Sanic is speed. Code that lowers the performance of
-Sanic without significant gains in usability, security, or features may not be
-merged. Please don't let this intimidate you! If you have any concerns about an
-idea, open an issue for discussion and help.

CONTRIBUTING.rst

@@ -0,0 +1,252 @@
+
+Contributing
+============
+
+Thank you for your interest! Sanic is always looking for contributors. If you
+don't feel comfortable contributing code, adding docstrings to the source files
+is very appreciated.
+
+We are committed to providing a friendly, safe and welcoming environment for all,
+regardless of gender, sexual orientation, disability, ethnicity, religion,
+or similar personal characteristic.
+Our `code of conduct <./CONDUCT.md>`_ sets the standards for behavior.
+
+Installation
+------------
+
+To develop on sanic (and mainly to just run the tests) it is highly recommend to
+install from sources.
+
+So assume you have already cloned the repo and are in the working directory with
+a virtual environment already set up, then run:
+
+.. code-block:: bash
+
+   pip3 install -e . ".[dev]"
+
+Dependency Changes
+------------------
+
+``Sanic`` doesn't use ``requirements*.txt`` files to manage any kind of dependencies related to it in order to simplify the
+effort required in managing the dependencies. Please make sure you have read and understood the following section of
+the document that explains the way ``sanic`` manages dependencies inside the ``setup.py`` file.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Dependency Type
+     - Usage
+     - Installation
+   * - requirements
+     - Bare minimum dependencies required for sanic to function
+     - ``pip3 install -e .``
+   * - tests_require / extras_require['test']
+     - Dependencies required to run the Unit Tests for ``sanic``
+     - ``pip3 install -e '.[test]'``
+   * - extras_require['dev']
+     - Additional Development requirements to add contributing
+     - ``pip3 install -e '.[dev]'``
+   * - extras_require['docs']
+     - Dependencies required to enable building and enhancing sanic documentation
+     - ``pip3 install -e '.[docs]'``
+
+
+Running all tests
+-----------------
+
+To run the tests for Sanic it is recommended to use tox like so:
+
+.. code-block:: bash
+
+   tox
+
+See it's that simple!
+
+``tox.ini`` contains different environments. Running ``tox`` without any arguments will
+run all unittests, perform lint and other checks.
+
+Run unittests
+-------------
+
+``tox`` environment -> ``[testenv]``
+
+To execute only unittests, run ``tox`` with environment like so:
+
+.. code-block:: bash
+
+   tox -e py36 -v -- tests/test_config.py
+   # or
+   tox -e py37 -v -- tests/test_config.py
+
+Run lint checks
+---------------
+
+``tox`` environment -> ``[testenv:lint]``
+
+Permform ``flake8``\ , ``black`` and ``isort`` checks.
+
+.. code-block:: bash
+
+   tox -e lint
+
+Run other checks
+----------------
+
+``tox`` environment -> ``[testenv:check]``
+
+Perform other checks.
+
+.. code-block:: bash
+
+   tox -e check
+
+Run Static Analysis
+-------------------
+
+``tox`` environment -> ``[testenv:security]``
+
+Perform static analysis security scan
+
+.. code-block:: bash
+
+   tox -e security
+
+Run Documentation sanity check
+------------------------------
+
+``tox`` environment -> ``[testenv:docs]``
+
+Perform sanity check on documentation
+
+.. code-block:: bash
+
+   tox -e docs
+
+
+Code Style
+----------
+
+To maintain the code consistency, Sanic uses following tools.
+
+
+#. `isort <https://github.com/timothycrosley/isort>`_
+#. `black <https://github.com/python/black>`_
+#. `flake8 <https://github.com/PyCQA/flake8>`_
+
+isort
+*****
+
+``isort`` sorts Python imports. It divides imports into three
+categories sorted each in alphabetical order.
+
+
+#. built-in
+#. third-party
+#. project-specific
+
+black
+*****
+
+``black`` is a Python code formatter.
+
+flake8
+******
+
+``flake8`` is a Python style guide that wraps following tools into one.
+
+
+#. PyFlakes
+#. pycodestyle
+#. Ned Batchelder's McCabe script
+
+``isort``\ , ``black`` and ``flake8`` checks are performed during ``tox`` lint checks.
+
+Refer `tox <https://tox.readthedocs.io/en/latest/index.html>`_ documentation for more details.
+
+Pull requests
+-------------
+
+So the pull request approval rules are pretty simple:
+
+#. All pull requests must have a changelog details associated with it.
+#. All pull requests must pass unit tests.
+#. All pull requests must be reviewed and approved by at least one current collaborator on the project.
+#. All pull requests must pass flake8 checks.
+#. All pull requests must be consistent with the existing code.
+#. If you decide to remove/change anything from any common interface a deprecation message should accompany it.
+#. If you implement a new feature you should have at least one unit test to accompany it.
+#. An example must be one of the following:
+
+   * Example of how to use Sanic
+   * Example of how to use Sanic extensions
+   * Example of how to use Sanic and asynchronous library
+
+
+Changelog
+---------
+
+It is mandatory to add documentation for Change log as part of your Pull request when you fix/contribute something
+to the ``sanic`` community. This will enable us in generating better and well defined change logs during the
+release which can aid community users in a great way.
+
+.. note::
+
+    Single line explaining the details of the PR in brief
+
+    Detailed description of what the PR is about and what changes or enhancements are being done.
+    No need to include examples or any other details here. But it is important that you provide
+    enough context here to let user understand what this change is all about and why it is being
+    introduced into the ``sanic`` codebase.
+
+    Make sure you leave an line space after the first line to make sure the document rendering is clean
+
+
+.. list-table::
+   :header-rows: 1
+
+   * - Contribution Type
+     - Changelog file name format
+     - Changelog file location
+   * - Features
+     - <git_issue>.feature.rst
+     - ``changelogs``
+   * - Bugfixes
+     - <git_issue>.bugfix.rst
+     - ``changelogs``
+   * - Improved Documentation
+     - <git_issue>.doc.rst
+     - ``changelogs``
+   * - Deprecations and Removals
+     - <git_issue>.removal.rst
+     - ``changelogs``
+   * - Miscellaneous internal changes
+     - <git_issue>.misc.rst
+     - ``changelogs``
+
+
+Documentation
+-------------
+
+Sanic's documentation is built
+using `sphinx <http://www.sphinx-doc.org/en/1.5.1/>`_. Guides are written in
+Markdown and can be found in the ``docs`` folder, while the module reference is
+automatically generated using ``sphinx-apidoc``.
+
+To generate the documentation from scratch:
+
+.. code-block:: bash
+
+   sphinx-apidoc -fo docs/_api/ sanic
+   sphinx-build -b html docs docs/_build
+
+   # There is a simple make command provided to ease the work required in generating
+   # the documentation
+   make docs
+
+The HTML documentation will be created in the ``docs/_build`` folder.
+
+.. warning::
+   One of the main goals of Sanic is speed. Code that lowers the performance of
+   Sanic without significant gains in usability, security, or features may not be
+   merged. Please don't let this intimidate you! If you have any concerns about an
+   idea, open an issue for discussion and help.

Makefile

@@ -19,6 +19,22 @@ help:
 	@echo "beautify [sort_imports=1] [include_tests=1]"
 	@echo "		Analyze and fix linting issue using black and optionally fix import sort using isort"
 	@echo ""
+	@echo "docs"
+	@echo "		Generate Sanic documentation"
+	@echo ""
+	@echo "clean-docs"
+	@echo "		Clean Sanic documentation"
+	@echo ""
+	@echo "docs-test"
+	@echo "		Test Sanic Documentation for errors"
+	@echo ""
+	@echo "changelog"
+	@echo "		Generate changelog for Sanic to prepare for new release"
+	@echo ""
+	@echo "release"
+	@echo "		Prepare Sanic for a new changes by version bump and changelog"
+	@echo ""
+
 
 clean:
 	find . ! -path "./.eggs/*" -name "*.pyc" -exec rm {} \;
@@ -55,4 +71,25 @@ black:
 	black --config ./.black.toml sanic tests
 
 fix-import: black
-	isort -rc sanic tests
+	isort sanic tests
+
+
+docs-clean:
+	cd docs && make clean
+
+docs: docs-clean
+	cd docs && make html
+
+docs-test: docs-clean
+	cd docs && make dummy
+
+changelog:
+	python scripts/changelog.py
+
+release:
+ifdef version
+	python scripts/release.py --release-version ${version} --generate-changelog
+else
+	python scripts/release.py --generate-changelog
+endif
+

README.rst

@@ -131,7 +131,7 @@ Documentation
 Changelog
 ---------
 
-`Release Changelogs <https://github.com/huge-success/sanic/blob/master/CHANGELOG.md>`_.
+`Release Changelogs <https://github.com/huge-success/sanic/blob/master/CHANGELOG.rst>`_.
 
    
 Questions and Discussion
@@ -142,4 +142,4 @@ Questions and Discussion
 Contribution
 ------------
 
-We are always happy to have new contributions. We have `marked issues good for anyone looking to get started <https://github.com/huge-success/sanic/issues?q=is%3Aopen+is%3Aissue+label%3Abeginner>`_, and welcome `questions on the forums <https://community.sanicframework.org/>`_. Please take a look at our `Contribution guidelines <https://github.com/huge-success/sanic/blob/master/CONTRIBUTING.md>`_.
+We are always happy to have new contributions. We have `marked issues good for anyone looking to get started <https://github.com/huge-success/sanic/issues?q=is%3Aopen+is%3Aissue+label%3Abeginner>`_, and welcome `questions on the forums <https://community.sanicframework.org/>`_. Please take a look at our `Contribution guidelines <https://sanic.readthedocs.io/en/latest/sanic/contributing.html>`_.

changelogs/.gitignore

@@ -0,0 +1,2 @@
+# Except this file
+!.gitignore

docs/conf.py

@@ -10,10 +10,8 @@
 import os
 import sys
 
-# Add support for Markdown documentation using Recommonmark
-from recommonmark.parser import CommonMarkParser
-
 # Add support for auto-doc
+import recommonmark
 from recommonmark.transform import AutoStructify
 
 # Ensure that sanic is present in the path, to allow sphinx-apidoc to
@@ -25,12 +23,11 @@ import sanic
 
 # -- General configuration ------------------------------------------------
 
-extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.asyncio']
+extensions = ['sphinx.ext.autodoc', "recommonmark"]
 
 templates_path = ['_templates']
 
 # Enable support for both Restructured Text and Markdown
-source_parsers = {'.md': CommonMarkParser}
 source_suffix = ['.rst', '.md']
 
 # The master toctree document.
@@ -149,6 +146,6 @@ suppress_warnings = ['image.nonlocal_uri']
 def setup(app):
     app.add_config_value('recommonmark_config', {
         'enable_eval_rst': True,
-        'enable_auto_doc_ref': True,
+        'enable_auto_doc_ref': False,
     }, True)
     app.add_transform(AutoStructify)

docs/index.html

@@ -0,0 +1,468 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.15.2: http://docutils.sourceforge.net/" />
+<title>index.rst</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document">
+
+
+<div class="section" id="sanic">
+<h1>Sanic</h1>
+<p>Sanic is a Python 3.6+ web server and web framework that's written to go fast. It allows the usage of the async/await syntax added in Python 3.5, which makes your code non-blocking and speedy.</p>
+<p>The goal of the project is to provide a simple way to get up and running a highly performant HTTP server that is easy to build, to expand, and ultimately to scale.</p>
+<p>Sanic is developed <a class="reference external" href="https://github.com/channelcat/sanic/">on GitHub</a>. Contributions are welcome!</p>
+<div class="section" id="sanic-aspires-to-be-simple">
+<h2>Sanic aspires to be simple</h2>
+<pre class="code python literal-block">
+<span class="keyword namespace">from</span> <span class="name namespace">sanic</span> <span class="keyword namespace">import</span> <span class="name">Sanic</span>
+<span class="keyword namespace">from</span> <span class="name namespace">sanic.response</span> <span class="keyword namespace">import</span> <span class="name">json</span>
+
+<span class="name">app</span> <span class="operator">=</span> <span class="name">Sanic</span><span class="punctuation">()</span>
+
+<span class="name decorator">&#64;app.route</span><span class="punctuation">(</span><span class="literal string double">&quot;/&quot;</span><span class="punctuation">)</span>
+<span class="name">async</span> <span class="keyword">def</span> <span class="name function">test</span><span class="punctuation">(</span><span class="name">request</span><span class="punctuation">):</span>
+    <span class="keyword">return</span> <span class="name">json</span><span class="punctuation">({</span><span class="literal string double">&quot;hello&quot;</span><span class="punctuation">:</span> <span class="literal string double">&quot;world&quot;</span><span class="punctuation">})</span>
+
+<span class="keyword">if</span> <span class="name variable magic">__name__</span> <span class="operator">==</span> <span class="literal string double">&quot;__main__&quot;</span><span class="punctuation">:</span>
+    <span class="name">app</span><span class="operator">.</span><span class="name">run</span><span class="punctuation">(</span><span class="name">host</span><span class="operator">=</span><span class="literal string double">&quot;0.0.0.0&quot;</span><span class="punctuation">,</span> <span class="name">port</span><span class="operator">=</span><span class="literal number integer">8000</span><span class="punctuation">)</span>
+</pre>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Sanic does not support Python 3.5 from version 19.6 and forward. However, version 18.12LTS is supported thru
+December 2020. Official Python support for version 3.5 is set to expire in September 2020.</p>
+</div>
+</div>
+</div>
+<div class="section" id="guides">
+<h1>Guides</h1>
+<div class="system-message">
+<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">E:/OneDrive/GitHub/sanic/docs/index.rst</tt>, line 6)</p>
+<p>Unknown directive type &quot;toctree&quot;.</p>
+<pre class="literal-block">
+.. toctree::
+   :maxdepth: 2
+
+   sanic/getting_started
+   sanic/config
+   sanic/logging
+   sanic/request_data
+   sanic/response
+   sanic/cookies
+   sanic/routing
+   sanic/blueprints
+   sanic/static_files
+   sanic/versioning
+   sanic/exceptions
+   sanic/middleware
+   sanic/websocket
+   sanic/decorators
+   sanic/streaming
+   sanic/class_based_views
+   sanic/custom_protocol
+   sanic/sockets
+   sanic/ssl
+   sanic/debug_mode
+   sanic/testing
+   sanic/deploying
+   sanic/extensions
+   sanic/examples
+   sanic/changelog
+   sanic/contributing
+   sanic/api_reference
+   sanic/asyncio_python37
+
+
+</pre>
+</div>
+</div>
+<div class="section" id="module-documentation">
+<h1>Module Documentation</h1>
+<div class="system-message">
+<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">E:/OneDrive/GitHub/sanic/docs/index.rst</tt>, line 42)</p>
+<p>Unknown directive type &quot;toctree&quot;.</p>
+<pre class="literal-block">
+.. toctree::
+
+</pre>
+</div>
+<ul>
+<li><p class="first"><a href="#id1"><span class="problematic" id="id2">:ref:`genindex`</span></a></p>
+<div class="system-message" id="id1">
+<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">E:/OneDrive/GitHub/sanic/docs/index.rst</tt>, line 44); <em><a href="#id2">backlink</a></em></p>
+<p>Unknown interpreted text role &quot;ref&quot;.</p>
+</div>
+</li>
+<li><p class="first"><a href="#id3"><span class="problematic" id="id4">:ref:`modindex`</span></a></p>
+<div class="system-message" id="id3">
+<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">E:/OneDrive/GitHub/sanic/docs/index.rst</tt>, line 45); <em><a href="#id4">backlink</a></em></p>
+<p>Unknown interpreted text role &quot;ref&quot;.</p>
+</div>
+</li>
+<li><p class="first"><a href="#id5"><span class="problematic" id="id6">:ref:`search`</span></a></p>
+<div class="system-message" id="id5">
+<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">E:/OneDrive/GitHub/sanic/docs/index.rst</tt>, line 46); <em><a href="#id6">backlink</a></em></p>
+<p>Unknown interpreted text role &quot;ref&quot;.</p>
+</div>
+</li>
+</ul>
+</div>
+</div>
+</body>
+</html>

docs/sanic/blueprints.md

@@ -1,286 +0,0 @@
-# Blueprints
-
-Blueprints are objects that can be used for sub-routing within an application.
-Instead of adding routes to the application instance, blueprints define similar
-methods for adding routes, which are then registered with the application in a
-flexible and pluggable manner.
-
-Blueprints are especially useful for larger applications, where your
-application logic can be broken down into several groups or areas of
-responsibility.
-
-## My First Blueprint
-
-The following shows a very simple blueprint that registers a handler-function at
-the root `/` of your application.
-
-Suppose you save this file as `my_blueprint.py`, which can be imported into your
-main application later.
-
-```python
-from sanic.response import json
-from sanic import Blueprint
-
-bp = Blueprint('my_blueprint')
-
-@bp.route('/')
-async def bp_root(request):
-    return json({'my': 'blueprint'})
-
-```
-
-## Registering blueprints
-
-Blueprints must be registered with the application.
-
-```python
-from sanic import Sanic
-from my_blueprint import bp
-
-app = Sanic(__name__)
-app.blueprint(bp)
-
-app.run(host='0.0.0.0', port=8000, debug=True)
-```
-
-This will add the blueprint to the application and register any routes defined
-by that blueprint. In this example, the registered routes in the `app.router`
-will look like:
-
-```python
-[Route(handler=<function bp_root at 0x7f908382f9d8>, methods=frozenset({'GET'}), pattern=re.compile('^/$'), parameters=[], name='my_blueprint.bp_root', uri='/')]
-```
-
-## Blueprint groups and nesting
-
-Blueprints may also be registered as part of a list or tuple, where the registrar will recursively cycle through any sub-sequences of blueprints and register them accordingly. The `Blueprint.group` method is provided to simplify this process, allowing a 'mock' backend directory structure mimicking what's seen from the front end. Consider this (quite contrived) example:
-
-```
-api/
-├──content/
-│  ├──authors.py
-│  ├──static.py
-│  └──__init__.py
-├──info.py
-└──__init__.py
-app.py
-```
-
-Initialization of this app's blueprint hierarchy could go as follows:
-
-```python
-# api/content/authors.py
-from sanic import Blueprint
-
-authors = Blueprint('content_authors', url_prefix='/authors')
-```
-```python
-# api/content/static.py
-from sanic import Blueprint
-
-static = Blueprint('content_static', url_prefix='/static')
-```
-```python
-# api/content/__init__.py
-from sanic import Blueprint
-
-from .static import static
-from .authors import authors
-
-content = Blueprint.group(static, authors, url_prefix='/content')
-```
-```python
-# api/info.py
-from sanic import Blueprint
-
-info = Blueprint('info', url_prefix='/info')
-```
-```python
-# api/__init__.py
-from sanic import Blueprint
-
-from .content import content
-from .info import info
-
-api = Blueprint.group(content, info, url_prefix='/api')
-```
-
-And registering these blueprints in `app.py` can now be done like so:
-
-```python
-# app.py
-from sanic import Sanic
-
-from .api import api
-
-app = Sanic(__name__)
-
-app.blueprint(api)
-```
-
-## Using Blueprints
-
-Blueprints have almost the same functionality as an application instance.
-
-### WebSocket routes
-
-WebSocket handlers can be registered on a blueprint using the `@bp.websocket`
-decorator or `bp.add_websocket_route` method.
-
-### Blueprint Middleware
-
-Using blueprints allows you to also register middleware globally.
-
-```python
-@bp.middleware
-async def print_on_request(request):
-	print("I am a spy")
-
-@bp.middleware('request')
-async def halt_request(request):
-	return text('I halted the request')
-
-@bp.middleware('response')
-async def halt_response(request, response):
-	return text('I halted the response')
-```
-
-### Blueprint Group Middleware
-Using this middleware will ensure that you can apply a common middleware to all the blueprints that form the
-current blueprint group under consideration.
-
-```python
-bp1 = Blueprint('bp1', url_prefix='/bp1')
-bp2 = Blueprint('bp2', url_prefix='/bp2')
-
-@bp1.middleware('request')
-async def bp1_only_middleware(request):
-    print('applied on Blueprint : bp1 Only')
-
-@bp1.route('/')
-async def bp1_route(request):
-    return text('bp1')
-
-@bp2.route('/<param>')
-async def bp2_route(request, param):
-    return text(param)
-
-group = Blueprint.group(bp1, bp2)
-
-@group.middleware('request')
-async def group_middleware(request):
-    print('common middleware applied for both bp1 and bp2')
-    
-# Register Blueprint group under the app
-app.blueprint(group)
-```
-
-### Exceptions
-
-Exceptions can be applied exclusively to blueprints globally.
-
-```python
-@bp.exception(NotFound)
-def ignore_404s(request, exception):
-	return text("Yep, I totally found the page: {}".format(request.url))
-```
-
-### Static files
-
-Static files can be served globally, under the blueprint prefix.
-
-```python
-
-# suppose bp.name == 'bp'
-
-bp.static('/web/path', '/folder/to/serve')
-# also you can pass name parameter to it for url_for
-bp.static('/web/path', '/folder/to/server', name='uploads')
-app.url_for('static', name='bp.uploads', filename='file.txt') == '/bp/web/path/file.txt'
-
-```
-
-## Start and stop
-
-Blueprints can run functions during the start and stop process of the server.
-If running in multiprocessor mode (more than 1 worker), these are triggered
-after the workers fork.
-
-Available events are:
-
-- `before_server_start`: Executed before the server begins to accept connections
-- `after_server_start`: Executed after the server begins to accept connections
-- `before_server_stop`: Executed before the server stops accepting connections
-- `after_server_stop`: Executed after the server is stopped and all requests are complete
-
-```python
-bp = Blueprint('my_blueprint')
-
-@bp.listener('before_server_start')
-async def setup_connection(app, loop):
-    global database
-    database = mysql.connect(host='127.0.0.1'...)
-
-@bp.listener('after_server_stop')
-async def close_connection(app, loop):
-    await database.close()
-```
-
-## Use-case: API versioning
-
-Blueprints can be very useful for API versioning, where one blueprint may point
-at `/v1/<routes>`, and another pointing at `/v2/<routes>`.
-
-When a blueprint is initialised, it can take an optional `version` argument,
-which will be prepended to all routes defined on the blueprint. This feature
-can be used to implement our API versioning scheme.
-
-```python
-# blueprints.py
-from sanic.response import text
-from sanic import Blueprint
-
-blueprint_v1 = Blueprint('v1', url_prefix='/api', version="v1")
-blueprint_v2 = Blueprint('v2', url_prefix='/api', version="v2")
-
-@blueprint_v1.route('/')
-async def api_v1_root(request):
-    return text('Welcome to version 1 of our documentation')
-
-@blueprint_v2.route('/')
-async def api_v2_root(request):
-    return text('Welcome to version 2 of our documentation')
-```
-
-When we register our blueprints on the app, the routes `/v1/api` and `/v2/api` will now
-point to the individual blueprints, which allows the creation of *sub-sites*
-for each API version.
-
-```python
-# main.py
-from sanic import Sanic
-from blueprints import blueprint_v1, blueprint_v2
-
-app = Sanic(__name__)
-app.blueprint(blueprint_v1)
-app.blueprint(blueprint_v2)
-
-app.run(host='0.0.0.0', port=8000, debug=True)
-```
-
-## URL Building with `url_for`
-
-If you wish to generate a URL for a route inside of a blueprint, remember that the endpoint name
-takes the format `<blueprint_name>.<handler_name>`. For example:
-
-```python
-@blueprint_v1.route('/')
-async def root(request):
-    url = request.app.url_for('v1.post_handler', post_id=5) # --> '/v1/api/post/5'
-    return redirect(url)
-
-
-@blueprint_v1.route('/post/<post_id>')
-async def post_handler(request, post_id):
-    return text('Post {} in Blueprint V1'.format(post_id))
-```

docs/sanic/blueprints.rst

@@ -0,0 +1,301 @@
+Blueprints
+==========
+
+Blueprints are objects that can be used for sub-routing within an application.
+Instead of adding routes to the application instance, blueprints define similar
+methods for adding routes, which are then registered with the application in a
+flexible and pluggable manner.
+
+Blueprints are especially useful for larger applications, where your
+application logic can be broken down into several groups or areas of
+responsibility.
+
+My First Blueprint
+------------------
+
+The following shows a very simple blueprint that registers a handler-function at
+the root `/` of your application.
+
+Suppose you save this file as `my_blueprint.py`, which can be imported into your
+main application later.
+
+.. code-block:: python
+
+    from sanic.response import json
+    from sanic import Blueprint
+
+    bp = Blueprint('my_blueprint')
+
+    @bp.route('/')
+    async def bp_root(request):
+        return json({'my': 'blueprint'})
+
+Registering blueprints
+----------------------
+
+Blueprints must be registered with the application.
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from my_blueprint import bp
+
+    app = Sanic(__name__)
+    app.blueprint(bp)
+
+    app.run(host='0.0.0.0', port=8000, debug=True)
+
+This will add the blueprint to the application and register any routes defined
+by that blueprint. In this example, the registered routes in the `app.router`
+will look like:
+
+.. code-block:: python
+
+    [Route(handler=<function bp_root at 0x7f908382f9d8>, methods=frozenset({'GET'}), pattern=re.compile('^/$'), parameters=[], name='my_blueprint.bp_root', uri='/')]
+
+Blueprint groups and nesting
+----------------------------
+
+Blueprints may also be registered as part of a list or tuple, where the registrar will recursively cycle through any sub-sequences of blueprints and register them accordingly. The `Blueprint.group` method is provided to simplify this process, allowing a 'mock' backend directory structure mimicking what's seen from the front end. Consider this (quite contrived) example:
+
+|    api/
+|    ├──content/
+|    │  ├──authors.py
+|    │  ├──static.py
+|    │  └──__init__.py
+|    ├──info.py
+|    └──__init__.py
+|    app.py
+
+Initialization of this app's blueprint hierarchy could go as follows:
+
+.. code-block:: python
+
+    # api/content/authors.py
+    from sanic import Blueprint
+
+    authors = Blueprint('content_authors', url_prefix='/authors')
+
+.. code-block:: python
+
+    # api/content/static.py
+    from sanic import Blueprint
+
+    static = Blueprint('content_static', url_prefix='/static')
+
+
+.. code-block:: python
+
+    # api/content/__init__.py
+    from sanic import Blueprint
+
+    from .static import static
+    from .authors import authors
+
+    content = Blueprint.group(static, authors, url_prefix='/content')
+
+.. code-block:: python
+
+    # api/info.py
+    from sanic import Blueprint
+
+    info = Blueprint('info', url_prefix='/info')
+
+.. code-block:: python
+
+    # api/__init__.py
+    from sanic import Blueprint
+
+    from .content import content
+    from .info import info
+
+    api = Blueprint.group(content, info, url_prefix='/api')
+
+And registering these blueprints in `app.py` can now be done like so:
+
+.. code-block:: python
+
+    # app.py
+    from sanic import Sanic
+
+    from .api import api
+
+    app = Sanic(__name__)
+
+    app.blueprint(api)
+
+Using Blueprints
+----------------
+
+Blueprints have almost the same functionality as an application instance.
+
+WebSocket routes
+~~~~~~~~~~~~~~~~
+
+WebSocket handlers can be registered on a blueprint using the `@bp.websocket`
+decorator or `bp.add_websocket_route` method.
+
+Blueprint Middleware
+~~~~~~~~~~~~~~~~~~~~
+
+Using blueprints allows you to also register middleware globally.
+
+.. code-block:: python
+
+    @bp.middleware
+    async def print_on_request(request):
+        print("I am a spy")
+
+    @bp.middleware('request')
+    async def halt_request(request):
+        return text('I halted the request')
+
+    @bp.middleware('response')
+    async def halt_response(request, response):
+        return text('I halted the response')
+
+
+Blueprint Group Middleware
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Using this middleware will ensure that you can apply a common middleware to all the blueprints that form the
+current blueprint group under consideration.
+
+.. code-block:: python
+
+    bp1 = Blueprint('bp1', url_prefix='/bp1')
+    bp2 = Blueprint('bp2', url_prefix='/bp2')
+
+    @bp1.middleware('request')
+    async def bp1_only_middleware(request):
+        print('applied on Blueprint : bp1 Only')
+
+    @bp1.route('/')
+    async def bp1_route(request):
+        return text('bp1')
+
+    @bp2.route('/<param>')
+    async def bp2_route(request, param):
+        return text(param)
+
+    group = Blueprint.group(bp1, bp2)
+
+    @group.middleware('request')
+    async def group_middleware(request):
+        print('common middleware applied for both bp1 and bp2')
+
+    # Register Blueprint group under the app
+    app.blueprint(group)
+
+Exceptions
+~~~~~~~~~~
+
+Exceptions can be applied exclusively to blueprints globally.
+
+.. code-block:: python
+
+    @bp.exception(NotFound)
+    def ignore_404s(request, exception):
+        return text("Yep, I totally found the page: {}".format(request.url))
+
+Static files
+~~~~~~~~~~~~
+
+Static files can be served globally, under the blueprint prefix.
+
+.. code-block:: python
+
+    # suppose bp.name == 'bp'
+
+    bp.static('/web/path', '/folder/to/serve')
+    # also you can pass name parameter to it for url_for
+    bp.static('/web/path', '/folder/to/server', name='uploads')
+    app.url_for('static', name='bp.uploads', filename='file.txt') == '/bp/web/path/file.txt'
+
+Start and stop
+--------------
+
+Blueprints can run functions during the start and stop process of the server.
+If running in multiprocessor mode (more than 1 worker), these are triggered
+after the workers fork.
+
+Available events are:
+
+- `before_server_start`: Executed before the server begins to accept connections
+- `after_server_start`: Executed after the server begins to accept connections
+- `before_server_stop`: Executed before the server stops accepting connections
+- `after_server_stop`: Executed after the server is stopped and all requests are complete
+
+.. code-block:: python
+
+    bp = Blueprint('my_blueprint')
+
+    @bp.listener('before_server_start')
+    async def setup_connection(app, loop):
+        global database
+        database = mysql.connect(host='127.0.0.1'...)
+
+    @bp.listener('after_server_stop')
+    async def close_connection(app, loop):
+        await database.close()
+
+Use-case: API versioning
+------------------------
+
+Blueprints can be very useful for API versioning, where one blueprint may point
+at `/v1/<routes>`, and another pointing at `/v2/<routes>`.
+
+When a blueprint is initialised, it can take an optional `version` argument,
+which will be prepended to all routes defined on the blueprint. This feature
+can be used to implement our API versioning scheme.
+
+.. code-block:: python
+
+    # blueprints.py
+    from sanic.response import text
+    from sanic import Blueprint
+
+    blueprint_v1 = Blueprint('v1', url_prefix='/api', version="v1")
+    blueprint_v2 = Blueprint('v2', url_prefix='/api', version="v2")
+
+    @blueprint_v1.route('/')
+    async def api_v1_root(request):
+        return text('Welcome to version 1 of our documentation')
+
+    @blueprint_v2.route('/')
+    async def api_v2_root(request):
+        return text('Welcome to version 2 of our documentation')
+
+When we register our blueprints on the app, the routes `/v1/api` and `/v2/api` will now
+point to the individual blueprints, which allows the creation of *sub-sites*
+for each API version.
+
+.. code-block:: python
+
+    # main.py
+    from sanic import Sanic
+    from blueprints import blueprint_v1, blueprint_v2
+
+    app = Sanic(__name__)
+    app.blueprint(blueprint_v1)
+    app.blueprint(blueprint_v2)
+
+    app.run(host='0.0.0.0', port=8000, debug=True)
+
+URL Building with `url_for`
+---------------------------
+
+If you wish to generate a URL for a route inside of a blueprint, remember that the endpoint name
+takes the format `<blueprint_name>.<handler_name>`. For example:
+
+.. code-block:: python
+
+    @blueprint_v1.route('/')
+    async def root(request):
+        url = request.app.url_for('v1.post_handler', post_id=5) # --> '/v1/api/post/5'
+        return redirect(url)
+
+
+    @blueprint_v1.route('/post/<post_id>')
+    async def post_handler(request, post_id):
+        return text('Post {} in Blueprint V1'.format(post_id))

docs/sanic/changelog.md

@@ -1,261 +0,0 @@
-Version 19.6
-------------
-19.6.0
-  - Changes:
-    - Remove `aiohttp` dependencey and create new `SanicTestClient` based upon
-    [`requests-async`](https://github.com/encode/requests-async).
-
-  - Deprecation:
-    - Support for Python 3.5
-
-Note: Sanic will not support Python 3.5 from version 19.6 and forward. However,
-version 18.12LTS will have its support period extended thru December 2020, and
-therefore passing Python's official support version 3.5, which is set to expire
-in September 2020.
-
-Version 19.3
--------------
-19.3.1
-  - Changes:
-    - [#1497](https://github.com/huge-success/sanic/pull/1497)
-      Add support for zero-length and RFC 5987 encoded filename for
-      multipart/form-data requests.
-
-    - [#1484](https://github.com/huge-success/sanic/pull/1484)
-      The type of `expires` attribute of `sanic.cookies.Cookie` is now
-      enforced to be of type `datetime`.
-
-    - [#1482](https://github.com/huge-success/sanic/pull/1482)
-      Add support for the `stream` parameter of `sanic.Sanic.add_route()`
-      available to `sanic.Blueprint.add_route()`.
-
-    - [#1481](https://github.com/huge-success/sanic/pull/1481)
-      Accept negative values for route parameters with type `int` or `number`.
-
-    - [#1476](https://github.com/huge-success/sanic/pull/1476)
-      Deprecated the use of `sanic.request.Request.raw_args` - it has a
-      fundamental flaw in which is drops repeated query string parameters.
-      Added `sanic.request.Request.query_args` as a replacement for the
-      original use-case.
-
-    - [#1472](https://github.com/huge-success/sanic/pull/1472)
-      Remove an unwanted `None` check in Request class `repr` implementation.
-      This changes the default `repr` of a Request from `<Request>` to
-      `<Request: None />`
-
-    - [#1470](https://github.com/huge-success/sanic/pull/1470)
-      Added 2 new parameters to `sanic.app.Sanic.create_server`:
-      - `return_asyncio_server` - whether to return an asyncio.Server.
-      - `asyncio_server_kwargs` - kwargs to pass to `loop.create_server` for
-        the event loop that sanic is using.
-
-      This is a breaking change.
-
-    - [#1499](https://github.com/huge-success/sanic/pull/1499)
-      Added a set of test cases that test and benchmark route resolution.
-
-    - [#1457](https://github.com/huge-success/sanic/pull/1457)
-      The type of the `"max-age"` value in a `sanic.cookies.Cookie` is now
-      enforced to be an integer. Non-integer values are replaced with `0`.
-
-    - [#1445](https://github.com/huge-success/sanic/pull/1445)
-      Added the `endpoint` attribute to an incoming `request`, containing the
-      name of the handler function.
-
-    - [#1423](https://github.com/huge-success/sanic/pull/1423)
-      Improved request streaming. `request.stream` is now a bounded-size buffer
-      instead of an unbounded queue. Callers must now call
-      `await request.stream.read()` instead of `await request.stream.get()`
-      to read each portion of the body.
-
-      This is a breaking change.
-
-  - Fixes:
-    - [#1502](https://github.com/huge-success/sanic/pull/1502)
-      Sanic was prefetching `time.time()` and updating it once per second to
-      avoid excessive `time.time()` calls. The implementation was observed to
-      cause memory leaks in some cases. The benefit of the prefetch appeared
-      to negligible, so this has been removed. Fixes
-      [#1500](https://github.com/huge-success/sanic/pull/1500)
-
-    - [#1501](https://github.com/huge-success/sanic/pull/1501)
-      Fix a bug in the auto-reloader when the process was launched as a module
-      i.e. `python -m init0.mod1` where the sanic server is started
-      in `init0/mod1.py` with `debug` enabled and imports another module in
-      `init0`.
-
-    - [#1376](https://github.com/huge-success/sanic/pull/1376)
-      Allow sanic test client to bind to a random port by specifying
-      `port=None` when constructing a `SanicTestClient`
-
-    - [#1399](https://github.com/huge-success/sanic/pull/1399)
-      Added the ability to specify middleware on a blueprint group, so that all
-      routes produced from the blueprints in the group have the middleware
-      applied.
-
-    - [#1442](https://github.com/huge-success/sanic/pull/1442)
-      Allow the the use the `SANIC_ACCESS_LOG` environment variable to
-      enable/disable the access log when not explicitly passed to `app.run()`.
-      This allows the access log to be disabled for example when running via
-      gunicorn.
-
-  - Developer infrastructure:
-    - [#1529](https://github.com/huge-success/sanic/pull/1529) Update project PyPI credentials
-    - [#1515](https://github.com/huge-success/sanic/pull/1515) fix linter issue causing travis build failures (fix #1514)
-    - [#1490](https://github.com/huge-success/sanic/pull/1490) Fix python version in doc build
-    - [#1478](https://github.com/huge-success/sanic/pull/1478) Upgrade setuptools version and use native docutils in doc build
-    - [#1464](https://github.com/huge-success/sanic/pull/1464) Upgrade pytest, and fix caplog unit tests
-
-  - Typos and Documentation:
-    - [#1516](https://github.com/huge-success/sanic/pull/1516) Fix typo at the exception documentation
-    - [#1510](https://github.com/huge-success/sanic/pull/1510) fix typo in Asyncio example
-    - [#1486](https://github.com/huge-success/sanic/pull/1486) Documentation typo
-    - [#1477](https://github.com/huge-success/sanic/pull/1477) Fix grammar in README.md
-    - [#1489](https://github.com/huge-success/sanic/pull/1489) Added "databases" to the extensions list
-    - [#1483](https://github.com/huge-success/sanic/pull/1483) Add sanic-zipkin to extensions list
-    - [#1487](https://github.com/huge-success/sanic/pull/1487) Removed link to deleted repo, Sanic-OAuth, from the extensions list
-    - [#1460](https://github.com/huge-success/sanic/pull/1460) 18.12 changelog
-    - [#1449](https://github.com/huge-success/sanic/pull/1449) Add example of amending request object
-    - [#1446](https://github.com/huge-success/sanic/pull/1446) Update README
-    - [#1444](https://github.com/huge-success/sanic/pull/1444) Update README
-    - [#1443](https://github.com/huge-success/sanic/pull/1443) Update README, including new logo
-    - [#1440](https://github.com/huge-success/sanic/pull/1440) fix minor type and pip install instruction mismatch
-    - [#1424](https://github.com/huge-success/sanic/pull/1424) Documentation Enhancements
-
-Note: 19.3.0 was skipped for packagement purposes and not released on PyPI
-
-Version 18.12
--------------
-18.12.0
-  - Changes:
-    - Improved codebase test coverage from 81% to 91%.
-    - Added stream_large_files and host examples in static_file document
-    - Added methods to append and finish body content on Request (#1379)
-    - Integrated with .appveyor.yml for windows ci support
-    - Added documentation for AF_INET6 and AF_UNIX socket usage
-    - Adopt black/isort for codestyle
-    - Cancel task when connection_lost
-    - Simplify request ip and port retrieval logic
-    - Handle config error in load config file.
-    - Integrate with codecov for CI
-    - Add missed documentation for config section.
-    - Deprecate Handler.log
-    - Pinned httptools requirement to version 0.0.10+
-
-  - Fixes:
-    - Fix `remove_entity_headers` helper function (#1415)
-    - Fix TypeError when use Blueprint.group() to group blueprint with default url_prefix, Use os.path.normpath to avoid invalid url_prefix like api//v1
-    f8a6af1 Rename the `http` module to `helpers` to prevent conflicts with the built-in Python http library (fixes #1323)
-    - Fix unittests on windows
-    - Fix Namespacing of sanic logger
-    - Fix missing quotes in decorator example
-    - Fix redirect with quoted param
-    - Fix doc for latest blueprint code
-    - Fix build of latex documentation relating to markdown lists
-    - Fix loop exception handling in app.py
-    - Fix content length mismatch in windows and other platform
-    - Fix Range header handling for static files (#1402)
-    - Fix the logger and make it work (#1397)
-    - Fix type pikcle->pickle in multiprocessing test
-    - Fix pickling blueprints Change the string passed in the "name" section of the namedtuples in Blueprint to match the name of the Blueprint module attribute name. This allows blueprints to be pickled and unpickled, without errors, which is a requirment of running Sanic in multiprocessing mode in Windows. Added a test for pickling and unpickling blueprints Added a test for pickling and unpickling sanic itself Added a test for enabling multiprocessing on an app with a blueprint (only useful to catch this bug if the tests are run on Windows).
-    - Fix document for logging
-
-Version 0.8
------------
-0.8.3
-  - Changes:
-    - Ownership changed to org 'huge-success'
-
-0.8.0
-  - Changes:
-    - Add Server-Sent Events extension (Innokenty Lebedev)
-    - Graceful handling of request_handler_task cancellation (Ashley Sommer)
-    - Sanitize URL before redirection (aveao)
-    - Add url_bytes to request (johndoe46)
-    - py37 support for travisci (yunstanford)
-    - Auto reloader support for OSX (garyo)
-    - Add UUID route support (Volodymyr Maksymiv)
-    - Add pausable response streams (Ashley Sommer)
-    - Add weakref to request slots (vopankov)
-    - remove ubuntu 12.04 from test fixture due to deprecation (yunstanford)
-    - Allow streaming handlers in add_route (kinware)
-    - use travis_retry for tox (Raphael Deem)
-    - update aiohttp version for test client (yunstanford)
-    - add redirect import for clarity (yingshaoxo)
-    - Update HTTP Entity headers (Arnulfo Solís)
-    - Add register_listener method (Stephan Fitzpatrick)
-    - Remove uvloop/ujson dependencies for Windows (abuckenheimer)
-    - Content-length header on 204/304 responses (Arnulfo Solís)
-    - Extend WebSocketProtocol arguments and add docs (Bob Olde Hampsink, yunstanford)
-    - Update development status from pre-alpha to beta (Maksim Anisenkov)
-    - KeepAlive Timout log level changed to debug (Arnulfo Solís)
-    - Pin pytest to 3.3.2 because of pytest-dev/pytest#3170 (Maksim Aniskenov)
-    - Install Python 3.5 and 3.6 on docker container for tests (Shahin Azad)
-    - Add support for blueprint groups and nesting (Elias Tarhini)
-    - Remove uvloop for windows setup (Aleksandr Kurlov)
-    - Auto Reload (Yaser Amari)
-    - Documentation updates/fixups (multiple contributors)
-
-  - Fixes:
-    - Fix: auto_reload in Linux (Ashley Sommer)
-    - Fix: broken tests for aiohttp >= 3.3.0 (Ashley Sommer)
-    - Fix: disable auto_reload by default on windows (abuckenheimer)
-    - Fix (1143): Turn off access log with gunicorn (hqy)
-    - Fix (1268): Support status code for file response (Cosmo Borsky)
-    - Fix (1266): Add content_type flag to Sanic.static (Cosmo Borsky)
-    - Fix: subprotocols parameter missing from add_websocket_route (ciscorn)
-    - Fix (1242): Responses for CI header (yunstanford)
-    - Fix (1237): add version constraint for websockets (yunstanford)
-    - Fix (1231): memory leak - always release resource (Phillip Xu)
-    - Fix (1221): make request truthy if transport exists (Raphael Deem)
-    - Fix failing tests for aiohttp>=3.1.0 (Ashley Sommer)
-    - Fix try_everything examples (PyManiacGR, kot83)
-    - Fix (1158): default to auto_reload in debug mode (Raphael Deem)
-    - Fix (1136): ErrorHandler.response handler call too restrictive (Julien Castiaux)
-    - Fix: raw requires bytes-like object (cloudship)
-    - Fix (1120): passing a list in to a route decorator's host arg (Timothy Ebiuwhe)
-    - Fix: Bug in multipart/form-data parser (DirkGuijt)
-    - Fix: Exception for missing parameter when value is null (NyanKiyoshi)
-    - Fix: Parameter check (Howie Hu)
-    - Fix (1089): Routing issue with named parameters and different methods (yunstanford)
-    - Fix (1085): Signal handling in multi-worker mode (yunstanford)
-    - Fix: single quote in readme.rst (Cosven)
-    - Fix: method typos (Dmitry Dygalo)
-    - Fix: log_response correct output for ip and port (Wibowo Arindrarto)
-    - Fix (1042): Exception Handling (Raphael Deem)
-    - Fix: Chinese URIs (Howie Hu)
-    - Fix (1079): timeout bug when self.transport is None (Raphael Deem)
-    - Fix (1074): fix strict_slashes when route has slash (Raphael Deem)
-    - Fix (1050): add samesite cookie to cookie keys (Raphael Deem)
-    - Fix (1065): allow add_task after server starts (Raphael Deem)
-    - Fix (1061): double quotes in unauthorized exception (Raphael Deem)
-    - Fix (1062): inject the app in add_task method (Raphael Deem)
-    - Fix: update environment.yml for readthedocs (Eli Uriegas)
-    - Fix: Cancel request task when response timeout is triggered (Jeong YunWon)
-    - Fix (1052): Method not allowed response for RFC7231 compliance (Raphael Deem)
-    - Fix: IPv6 Address and Socket Data Format (Dan Palmer)
-
-Note: Changelog was unmaintained between 0.1 and 0.7
-
-Version 0.1
------------
- - 0.1.7
-  - Reversed static url and directory arguments to meet spec
- - 0.1.6
-  - Static files
-  - Lazy Cookie Loading
- - 0.1.5
-  - Cookies
-  - Blueprint listeners and ordering
-  - Faster Router
-  - Fix: Incomplete file reads on medium+ sized post requests
-  - Breaking: after_start and before_stop now pass sanic as their first argument
- - 0.1.4
-  - Multiprocessing
- - 0.1.3
-  - Blueprint support
-  - Faster Response processing
- - 0.1.1 - 0.1.2
-  - Struggling to update pypi via CI
- - 0.1.0
-  - Released to public

docs/sanic/changelog.rst

@@ -0,0 +1,4 @@
+Changelog
+---------
+
+.. include:: ../../CHANGELOG.rst

docs/sanic/class_based_views.md

@@ -1,166 +0,0 @@
-# Class-Based Views
-
-Class-based views are simply classes which implement response behaviour to
-requests. They provide a way to compartmentalise handling of different HTTP
-request types at the same endpoint. Rather than defining and decorating three
-different handler functions, one for each of an endpoint's supported request
-type, the endpoint can be assigned a class-based view.
-
-## Defining views
-
-A class-based view should subclass `HTTPMethodView`. You can then implement
-class methods for every HTTP request type you want to support. If a request is
-received that has no defined method, a `405: Method not allowed` response will
-be generated.
-
-To register a class-based view on an endpoint, the `app.add_route` method is
-used. The first argument should be the defined class with the method `as_view`
-invoked, and the second should be the URL endpoint.
-
-The available methods are `get`, `post`, `put`, `patch`, and `delete`. A class
-using all these methods would look like the following.
-
-```python
-from sanic import Sanic
-from sanic.views import HTTPMethodView
-from sanic.response import text
-
-app = Sanic('some_name')
-
-class SimpleView(HTTPMethodView):
-
-  def get(self, request):
-      return text('I am get method')
-
-  def post(self, request):
-      return text('I am post method')
-
-  def put(self, request):
-      return text('I am put method')
-
-  def patch(self, request):
-      return text('I am patch method')
-
-  def delete(self, request):
-      return text('I am delete method')
-
-app.add_route(SimpleView.as_view(), '/')
-
-```
-
-You can also use `async` syntax.
-
-```python
-from sanic import Sanic
-from sanic.views import HTTPMethodView
-from sanic.response import text
-
-app = Sanic('some_name')
-
-class SimpleAsyncView(HTTPMethodView):
-
-  async def get(self, request):
-      return text('I am async get method')
-
-app.add_route(SimpleAsyncView.as_view(), '/')
-
-```
-
-## URL parameters
-
-If you need any URL parameters, as discussed in the routing guide, include them
-in the method definition.
-
-```python
-class NameView(HTTPMethodView):
-
-  def get(self, request, name):
-    return text('Hello {}'.format(name))
-
-app.add_route(NameView.as_view(), '/<name>')
-```
-
-## Decorators
-
-If you want to add any decorators to the class, you can set the `decorators`
-class variable. These will be applied to the class when `as_view` is called.
-
-```python
-class ViewWithDecorator(HTTPMethodView):
-  decorators = [some_decorator_here]
-
-  def get(self, request, name):
-    return text('Hello I have a decorator')
-
-  def post(self, request, name):
-    return text("Hello I also have a decorator")
-
-app.add_route(ViewWithDecorator.as_view(), '/url')
-```
-
-But if you just want to decorate some functions and not all functions, you can do as follows:
-
-```python
-class ViewWithSomeDecorator(HTTPMethodView):
-
-    @staticmethod
-    @some_decorator_here
-    def get(request, name):
-        return text("Hello I have a decorator")
-
-    def post(self, request, name):
-        return text("Hello I don't have any decorators")
-```
-
-## URL Building
-
-If you wish to build a URL for an HTTPMethodView, remember that the class name will be the endpoint
-that you will pass into `url_for`. For example:
-
-```python
-@app.route('/')
-def index(request):
-    url = app.url_for('SpecialClassView')
-    return redirect(url)
-
-
-class SpecialClassView(HTTPMethodView):
-    def get(self, request):
-        return text('Hello from the Special Class View!')
-
-
-app.add_route(SpecialClassView.as_view(), '/special_class_view')
-```
-
-
-## Using CompositionView
-
-As an alternative to the `HTTPMethodView`, you can use `CompositionView` to
-move handler functions outside of the view class.
-
-Handler functions for each supported HTTP method are defined elsewhere in the
-source, and then added to the view using the `CompositionView.add` method. The
-first parameter is a list of HTTP methods to handle (e.g. `['GET', 'POST']`),
-and the second is the handler function. The following example shows
-`CompositionView` usage with both an external handler function and an inline
-lambda:
-
-```python
-from sanic import Sanic
-from sanic.views import CompositionView
-from sanic.response import text
-
-app = Sanic(__name__)
-
-def get_handler(request):
-    return text('I am a get method')
-
-view = CompositionView()
-view.add(['GET'], get_handler)
-view.add(['POST', 'PUT'], lambda request: text('I am a post/put method'))
-
-# Use the new view to handle requests to the base URL
-app.add_route(view, '/')
-```
-
-Note: currently you cannot build a URL for a CompositionView using `url_for`.

docs/sanic/class_based_views.rst

@@ -0,0 +1,169 @@
+Class-Based Views
+=================
+
+Class-based views are simply classes which implement response behaviour to
+requests. They provide a way to compartmentalise handling of different HTTP
+request types at the same endpoint. Rather than defining and decorating three
+different handler functions, one for each of an endpoint's supported request
+type, the endpoint can be assigned a class-based view.
+
+Defining views
+--------------
+
+A class-based view should subclass `HTTPMethodView`. You can then implement
+class methods for every HTTP request type you want to support. If a request is
+received that has no defined method, a `405: Method not allowed` response will
+be generated.
+
+To register a class-based view on an endpoint, the `app.add_route` method is
+used. The first argument should be the defined class with the method `as_view`
+invoked, and the second should be the URL endpoint.
+
+The available methods are `get`, `post`, `put`, `patch`, and `delete`. A class
+using all these methods would look like the following.
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.views import HTTPMethodView
+    from sanic.response import text
+
+    app = Sanic('some_name')
+
+    class SimpleView(HTTPMethodView):
+
+      def get(self, request):
+          return text('I am get method')
+
+      def post(self, request):
+          return text('I am post method')
+
+      def put(self, request):
+          return text('I am put method')
+
+      def patch(self, request):
+          return text('I am patch method')
+
+      def delete(self, request):
+          return text('I am delete method')
+
+    app.add_route(SimpleView.as_view(), '/')
+
+You can also use `async` syntax.
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.views import HTTPMethodView
+    from sanic.response import text
+
+    app = Sanic('some_name')
+
+    class SimpleAsyncView(HTTPMethodView):
+
+      async def get(self, request):
+          return text('I am async get method')
+
+    app.add_route(SimpleAsyncView.as_view(), '/')
+
+URL parameters
+--------------
+
+If you need any URL parameters, as discussed in the routing guide, include them
+in the method definition.
+
+.. code-block:: python
+
+    class NameView(HTTPMethodView):
+
+      def get(self, request, name):
+        return text('Hello {}'.format(name))
+
+    app.add_route(NameView.as_view(), '/<name>')
+
+Decorators
+----------
+
+If you want to add any decorators to the class, you can set the `decorators`
+class variable. These will be applied to the class when `as_view` is called.
+
+.. code-block:: python
+
+    class ViewWithDecorator(HTTPMethodView):
+      decorators = [some_decorator_here]
+
+      def get(self, request, name):
+        return text('Hello I have a decorator')
+
+      def post(self, request, name):
+        return text("Hello I also have a decorator")
+
+    app.add_route(ViewWithDecorator.as_view(), '/url')
+
+But if you just want to decorate some functions and not all functions, you can do as follows:
+
+.. code-block:: python
+
+    class ViewWithSomeDecorator(HTTPMethodView):
+
+        @staticmethod
+        @some_decorator_here
+        def get(request, name):
+            return text("Hello I have a decorator")
+
+        def post(self, request, name):
+            return text("Hello I don't have any decorators")
+
+URL Building
+------------
+
+If you wish to build a URL for an HTTPMethodView, remember that the class name will be the endpoint
+that you will pass into `url_for`. For example:
+
+.. code-block:: python
+
+    @app.route('/')
+    def index(request):
+        url = app.url_for('SpecialClassView')
+        return redirect(url)
+
+
+    class SpecialClassView(HTTPMethodView):
+        def get(self, request):
+            return text('Hello from the Special Class View!')
+
+
+    app.add_route(SpecialClassView.as_view(), '/special_class_view')
+
+Using CompositionView
+---------------------
+
+As an alternative to the `HTTPMethodView`, you can use `CompositionView` to
+move handler functions outside of the view class.
+
+Handler functions for each supported HTTP method are defined elsewhere in the
+source, and then added to the view using the `CompositionView.add` method. The
+first parameter is a list of HTTP methods to handle (e.g. `['GET', 'POST']`),
+and the second is the handler function. The following example shows
+`CompositionView` usage with both an external handler function and an inline
+lambda:
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.views import CompositionView
+    from sanic.response import text
+
+    app = Sanic(__name__)
+
+    def get_handler(request):
+        return text('I am a get method')
+
+    view = CompositionView()
+    view.add(['GET'], get_handler)
+    view.add(['POST', 'PUT'], lambda request: text('I am a post/put method'))
+
+    # Use the new view to handle requests to the base URL
+    app.add_route(view, '/')
+
+Note: currently you cannot build a URL for a CompositionView using `url_for`.

docs/sanic/config.md

@@ -1,169 +0,0 @@
-# Configuration
-
-Any reasonably complex application will need configuration that is not baked into the actual code. Settings might be different for different environments or installations.
-
-## Basics
-
-Sanic holds the configuration in the `config` attribute of the application object. The configuration object is merely an object that can be modified either using dot-notation or like a dictionary:
-
-```
-app = Sanic('myapp')
-app.config.DB_NAME = 'appdb'
-app.config.DB_USER = 'appuser'
-```
-
-Since the config object actually is a dictionary, you can use its `update` method in order to set several values at once:
-
-```
-db_settings = {
-    'DB_HOST': 'localhost',
-    'DB_NAME': 'appdb',
-    'DB_USER': 'appuser'
-}
-app.config.update(db_settings)
-```
-
-In general the convention is to only have UPPERCASE configuration parameters. The methods described below for loading configuration only look for such uppercase parameters.
-
-## Loading Configuration
-
-There are several ways how to load configuration.
-
-### From Environment Variables
-
-Any variables defined with the `SANIC_` prefix will be applied to the sanic config. For example, setting `SANIC_REQUEST_TIMEOUT` will be loaded by the application automatically and fed into the `REQUEST_TIMEOUT` config variable. You can pass a different prefix to Sanic:
-
-```python
-app = Sanic(load_env='MYAPP_')
-```
-
-Then the above variable would be `MYAPP_REQUEST_TIMEOUT`. If you want to disable loading from environment variables you can set it to `False` instead:
-
-```python
-app = Sanic(load_env=False)
-```
-
-### From an Object
-
-If there are a lot of configuration values and they have sensible defaults it might be helpful to put them into a module:
-
-```
-import myapp.default_settings
-
-app = Sanic('myapp')
-app.config.from_object(myapp.default_settings)
-```
-or also by path to config:
-
-```
-app = Sanic('myapp')
-app.config.from_object('config.path.config.Class')
-```
-
-
-You could use a class or any other object as well.
-
-### From a File
-
-Usually you will want to load configuration from a file that is not part of the distributed application. You can load configuration from a file using `from_pyfile(/path/to/config_file)`. However, that requires the program to know the path to the config file. So instead you can specify the location of the config file in an environment variable and tell Sanic to use that to find the config file:
-
-```
-app = Sanic('myapp')
-app.config.from_envvar('MYAPP_SETTINGS')
-```
-
-Then you can run your application with the `MYAPP_SETTINGS` environment variable set:
-
-```
-$ MYAPP_SETTINGS=/path/to/config_file python3 myapp.py
-INFO: Goin' Fast @ http://0.0.0.0:8000
-```
-
-The config files are regular Python files which are executed in order to load them. This allows you to use arbitrary logic for constructing the right configuration. Only uppercase variables are added to the configuration. Most commonly the configuration consists of simple key value pairs:
-
-```
-# config_file
-DB_HOST = 'localhost'
-DB_NAME = 'appdb'
-DB_USER = 'appuser'
-```
-
-## Builtin Configuration Values
-
-Out of the box there are just a few predefined values which can be overwritten when creating the application.
-
-    | Variable                  | Default           | Description                                                                 |
-    | ------------------------- | ----------------- | --------------------------------------------------------------------------- |
-    | REQUEST_MAX_SIZE          | 100000000         | How big a request may be (bytes)                                            |
-    | REQUEST_BUFFER_QUEUE_SIZE | 100               | Request streaming buffer queue size                                         |
-    | REQUEST_TIMEOUT           | 60                | How long a request can take to arrive (sec)                                 |
-    | RESPONSE_TIMEOUT          | 60                | How long a response can take to process (sec)                               |
-    | KEEP_ALIVE                | True              | Disables keep-alive when False                                              |
-    | KEEP_ALIVE_TIMEOUT        | 5                 | How long to hold a TCP connection open (sec)                                |
-    | GRACEFUL_SHUTDOWN_TIMEOUT | 15.0              | How long to wait to force close non-idle connection (sec)                   |
-    | ACCESS_LOG                | True              | Disable or enable access log                                                |
-    | PROXIES_COUNT             | -1                | The number of proxy servers in front of the app (e.g. nginx; see below)     |
-    | FORWARDED_FOR_HEADER      | "X-Forwarded-For" | The name of "X-Forwarded-For" HTTP header that contains client and proxy ip |
-    | REAL_IP_HEADER            | "X-Real-IP"       | The name of "X-Real-IP" HTTP header that contains real client ip            |
-
-### The different Timeout variables:
-
-#### `REQUEST_TIMEOUT`
-
-A request timeout measures the duration of time between the instant when a new open TCP connection is passed to the 
-Sanic backend server, and the instant when the whole HTTP request is received. If the time taken exceeds the 
-`REQUEST_TIMEOUT` value (in seconds), this is considered a Client Error so Sanic generates an `HTTP 408` response 
-and sends that to the client. Set this parameter's value higher if your clients routinely pass very large request payloads 
-or upload requests very slowly.
-
-#### `RESPONSE_TIMEOUT`
-
-A response timeout measures the duration of time between the instant the Sanic server passes the HTTP request to the 
-Sanic App, and the instant a HTTP response is sent to the client. If the time taken exceeds the `RESPONSE_TIMEOUT` 
-value (in seconds), this is considered a Server Error so Sanic generates an `HTTP 503` response and sends that to the 
-client. Set this parameter's value higher if your application is likely to have long-running process that delay the 
-generation of a response.
-
-#### `KEEP_ALIVE_TIMEOUT`
-
-##### What is Keep Alive? And what does the Keep Alive Timeout value do?
-
-`Keep-Alive` is a HTTP feature introduced in `HTTP 1.1`. When sending a HTTP request, the client (usually a web browser application) 
-can set a `Keep-Alive` header to indicate the http server (Sanic) to not close the TCP connection after it has send the response. 
-This allows the client to reuse the existing TCP connection to send subsequent HTTP requests, and ensures more efficient 
-network traffic for both the client and the server.
-
-The `KEEP_ALIVE` config variable is set to `True` in Sanic by default. If you don't need this feature in your application, 
-set it to `False` to cause all client connections to close immediately after a response is sent, regardless of 
-the `Keep-Alive` header on the request.
-
-The amount of time the server holds the TCP connection open is decided by the server itself. 
-In Sanic, that value is configured using the `KEEP_ALIVE_TIMEOUT` value. By default, it is set to 5 seconds. 
-This is the same default setting as the Apache HTTP server and is a good balance between allowing enough time for 
-the client to send a new request, and not holding open too many connections at once. Do not exceed 75 seconds unless 
-you know your clients are using a browser which supports TCP connections held open for that long.
-
-For reference:
-```
-Apache httpd server default keepalive timeout = 5 seconds
-Nginx server default keepalive timeout = 75 seconds
-Nginx performance tuning guidelines uses keepalive = 15 seconds
-IE (5-9) client hard keepalive limit = 60 seconds
-Firefox client hard keepalive limit = 115 seconds
-Opera 11 client hard keepalive limit = 120 seconds
-Chrome 13+ client keepalive limit > 300+ seconds
-```
-
-### About proxy servers and client ip
-
-When you use a reverse proxy server (e.g. nginx), the value of `request.ip` will contain ip of a proxy, typically `127.0.0.1`. To determine the real client ip, `X-Forwarded-For` and `X-Real-IP` HTTP headers are used. But client can fake these headers if they have not been overridden by a proxy. Sanic has a set of options to determine the level of confidence in these headers.
-
-* If you have a single proxy, set `PROXIES_COUNT` to `1`. Then Sanic will use `X-Real-IP` if available or the last ip from `X-Forwarded-For`.
-
-* If you have multiple proxies, set `PROXIES_COUNT` equal to their number to allow Sanic to select the correct ip from `X-Forwarded-For`.
-
-* If you don't use a proxy, set `PROXIES_COUNT` to `0` to ignore these headers and prevent ip falsification.
-
-* If you don't use `X-Real-IP` (e.g. your proxy sends only `X-Forwarded-For`), set `REAL_IP_HEADER` to an empty string.
-
-The real ip will be available in `request.remote_addr`. If HTTP headers are unavailable or untrusted, `request.remote_addr` will be an empty string; in this case use `request.ip` instead.

docs/sanic/config.rst

@@ -0,0 +1,242 @@
+Configuration
+=============
+
+Any reasonably complex application will need configuration that is not baked into the actual code. Settings might be different for different environments or installations.
+
+Basics
+------
+
+Sanic holds the configuration in the `config` attribute of the application object. The configuration object is merely an object that can be modified either using dot-notation or like a dictionary:
+
+.. code-block:: python
+
+    app = Sanic('myapp')
+    app.config.DB_NAME = 'appdb'
+    app.config.DB_USER = 'appuser'
+
+Since the config object actually is a dictionary, you can use its `update` method in order to set several values at once:
+
+.. code-block:: python
+
+    db_settings = {
+        'DB_HOST': 'localhost',
+        'DB_NAME': 'appdb',
+        'DB_USER': 'appuser'
+    }
+    app.config.update(db_settings)
+
+In general the convention is to only have UPPERCASE configuration parameters. The methods described below for loading configuration only look for such uppercase parameters.
+
+Loading Configuration
+---------------------
+
+There are several ways how to load configuration.
+
+From Environment Variables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Any variables defined with the `SANIC_` prefix will be applied to the sanic config. For example, setting `SANIC_REQUEST_TIMEOUT` will be loaded by the application automatically and fed into the `REQUEST_TIMEOUT` config variable. You can pass a different prefix to Sanic:
+
+.. code-block:: python
+
+    app = Sanic(load_env='MYAPP_')
+
+Then the above variable would be `MYAPP_REQUEST_TIMEOUT`. If you want to disable loading from environment variables you can set it to `False` instead:
+
+.. code-block:: python
+
+    app = Sanic(load_env=False)
+
+From an Object
+~~~~~~~~~~~~~~
+
+If there are a lot of configuration values and they have sensible defaults it might be helpful to put them into a module:
+
+.. code-block:: python
+
+    import myapp.default_settings
+
+    app = Sanic('myapp')
+    app.config.from_object(myapp.default_settings)
+
+or also by path to config:
+
+.. code-block:: python
+
+    app = Sanic('myapp')
+    app.config.from_object('config.path.config.Class')
+
+You could use a class or any other object as well.
+
+From a File
+~~~~~~~~~~~
+
+Usually you will want to load configuration from a file that is not part of the distributed application. You can load configuration from a file using `from_pyfile(/path/to/config_file)`. However, that requires the program to know the path to the config file. So instead you can specify the location of the config file in an environment variable and tell Sanic to use that to find the config file:
+
+.. code-block:: python
+
+    app = Sanic('myapp')
+    app.config.from_envvar('MYAPP_SETTINGS')
+
+Then you can run your application with the `MYAPP_SETTINGS` environment variable set:
+
+.. code-block:: python
+
+    #$ MYAPP_SETTINGS=/path/to/config_file python3 myapp.py
+    #INFO: Goin' Fast @ http://0.0.0.0:8000
+
+
+The config files are regular Python files which are executed in order to load them. This allows you to use arbitrary logic for constructing the right configuration. Only uppercase variables are added to the configuration. Most commonly the configuration consists of simple key value pairs:
+
+.. code-block:: python
+
+    # config_file
+    DB_HOST = 'localhost'
+    DB_NAME = 'appdb'
+    DB_USER = 'appuser'
+
+Builtin Configuration Values
+----------------------------
+
+Out of the box there are just a few predefined values which can be overwritten when creating the application.
+
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| Variable                  | Default           | Description                                                                 |
++===========================+===================+=============================================================================+
+| REQUEST_MAX_SIZE          | 100000000         | How big a request may be (bytes)                                            |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| REQUEST_BUFFER_QUEUE_SIZE | 100               | Request streaming buffer queue size                                         |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| REQUEST_TIMEOUT           | 60                | How long a request can take to arrive (sec)                                 |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| RESPONSE_TIMEOUT          | 60                | How long a response can take to process (sec)                               |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| KEEP_ALIVE                | True              | Disables keep-alive when False                                              |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| KEEP_ALIVE_TIMEOUT        | 5                 | How long to hold a TCP connection open (sec)                                |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| GRACEFUL_SHUTDOWN_TIMEOUT | 15.0              | How long to wait to force close non-idle connection (sec)                   |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| ACCESS_LOG                | True              | Disable or enable access log                                                |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| PROXIES_COUNT             | -1                | The number of proxy servers in front of the app (e.g. nginx; see below)     |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| FORWARDED_FOR_HEADER      | "X-Forwarded-For" | The name of "X-Forwarded-For" HTTP header that contains client and proxy ip |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+| REAL_IP_HEADER            | "X-Real-IP"       | The name of "X-Real-IP" HTTP header that contains real client ip            |
++---------------------------+-------------------+-----------------------------------------------------------------------------+
+
+The different Timeout variables:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`REQUEST_TIMEOUT`
+#################
+
+A request timeout measures the duration of time between the instant when a new open TCP connection is passed to the
+Sanic backend server, and the instant when the whole HTTP request is received. If the time taken exceeds the
+`REQUEST_TIMEOUT` value (in seconds), this is considered a Client Error so Sanic generates an `HTTP 408` response
+and sends that to the client. Set this parameter's value higher if your clients routinely pass very large request payloads
+or upload requests very slowly.
+
+`RESPONSE_TIMEOUT`
+##################
+
+A response timeout measures the duration of time between the instant the Sanic server passes the HTTP request to the
+Sanic App, and the instant a HTTP response is sent to the client. If the time taken exceeds the `RESPONSE_TIMEOUT`
+value (in seconds), this is considered a Server Error so Sanic generates an `HTTP 503` response and sends that to the
+client. Set this parameter's value higher if your application is likely to have long-running process that delay the
+generation of a response.
+
+`KEEP_ALIVE_TIMEOUT`
+####################
+
+What is Keep Alive? And what does the Keep Alive Timeout value do?
+******************************************************************
+
+`Keep-Alive` is a HTTP feature introduced in `HTTP 1.1`. When sending a HTTP request, the client (usually a web browser application)
+can set a `Keep-Alive` header to indicate the http server (Sanic) to not close the TCP connection after it has send the response.
+This allows the client to reuse the existing TCP connection to send subsequent HTTP requests, and ensures more efficient
+network traffic for both the client and the server.
+
+The `KEEP_ALIVE` config variable is set to `True` in Sanic by default. If you don't need this feature in your application,
+set it to `False` to cause all client connections to close immediately after a response is sent, regardless of
+the `Keep-Alive` header on the request.
+
+The amount of time the server holds the TCP connection open is decided by the server itself.
+In Sanic, that value is configured using the `KEEP_ALIVE_TIMEOUT` value. By default, it is set to 5 seconds.
+This is the same default setting as the Apache HTTP server and is a good balance between allowing enough time for
+the client to send a new request, and not holding open too many connections at once. Do not exceed 75 seconds unless
+you know your clients are using a browser which supports TCP connections held open for that long.
+
+For reference:
+
+* Apache httpd server default keepalive timeout = 5 seconds
+* Nginx server default keepalive timeout = 75 seconds
+* Nginx performance tuning guidelines uses keepalive = 15 seconds
+* IE (5-9) client hard keepalive limit = 60 seconds
+* Firefox client hard keepalive limit = 115 seconds
+* Opera 11 client hard keepalive limit = 120 seconds
+* Chrome 13+ client keepalive limit > 300+ seconds
+
+
+Proxy configuration
+~~~~~~~~~~~~~~~~~~~
+
+When you use a reverse proxy server (e.g. nginx), the value of `request.ip` will contain ip of a proxy,
+typically `127.0.0.1`. Sanic may be configured to use proxy headers for determining the true client IP,
+available as `request.remote_addr`. The full external URL is also constructed from header fields if available.
+
+Without proper precautions, a malicious client may use proxy headers to spoof its own IP. To avoid such issues, Sanic does not use any proxy headers unless explicitly enabled.
+
+Services behind reverse proxies must configure `FORWARDED_SECRET`, `REAL_IP_HEADER` and/or `PROXIES_COUNT`.
+
+Forwarded header
+################
+
+.. Forwarded: for="1.2.3.4"; proto="https"; host="yoursite.com"; secret="Pr0xy", for="10.0.0.1"; proto="http"; host="proxy.internal"; by="_1234proxy"
+
+* Set `FORWARDED_SECRET` to an identifier used by the proxy of interest.
+
+The secret is used to securely identify a specific proxy server. Given the above header, secret `Pr0xy` would use the
+information on the first line and secret `_1234proxy` would use the second line. The secret must exactly match the value
+of `secret` or `by`. A secret in `by` must begin with an underscore and use only characters specified in
+`RFC 7239 section 6.3 <https://tools.ietf.org/html/rfc7239#section-6.3>`_, while `secret` has no such restrictions.
+
+Sanic ignores any elements without the secret key, and will not even parse the header if no secret is set.
+
+All other proxy headers are ignored once a trusted forwarded element is found, as it already carries complete information about the client.
+
+Traditional proxy headers
+#########################
+
+..  X-Real-IP: 1.2.3.4
+    X-Forwarded-For: 1.2.3.4, 10.0.0.1
+    X-Forwarded-Proto: https
+    X-Forwarded-Host: yoursite.com
+
+
+* Set `REAL_IP_HEADER` to `x-real-ip`, `true-client-ip`, `cf-connecting-ip` or other name of such header.
+* Set `PROXIES_COUNT` to the number of entries expected in `x-forwarded-for` (name configurable via `FORWARDED_FOR_HEADER`).
+
+If client IP is found by one of these methods, Sanic uses the following headers for URL parts:
+
+* `x-forwarded-proto`, `x-forwarded-host`, `x-forwarded-port`, `x-forwarded-path` and if necessary, `x-scheme`.
+
+Proxy config if using ...
+#########################
+
+* a proxy that supports `forwarded`: set `FORWARDED_SECRET` to the value that the proxy inserts in the header
+    * Apache Traffic Server: `CONFIG proxy.config.http.insert_forwarded STRING for|proto|host|by=_secret`
+    * NGHTTPX: `nghttpx --add-forwarded=for,proto,host,by --forwarded-for=ip --forwarded-by=_secret`
+    * NGINX: after `the official instructions <https://www.nginx.com/resources/wiki/start/topics/examples/forwarded/>`_, add anywhere in your config:
+
+..        proxy_set_header Forwarded "$proxy_add_forwarded;by=\"_$server_name\";proto=$scheme;host=\"$http_host\";path=\"$request_uri\";secret=_secret";
+
+* a custom header with client IP: set `REAL_IP_HEADER` to the name of that header
+* `x-forwarded-for`: set `PROXIES_COUNT` to `1` for a single proxy, or a greater number to allow Sanic to select the correct IP
+* no proxies: no configuration required!
+
+Changes in Sanic 19.9
+#####################
+
+Earlier Sanic versions had unsafe default settings. From 19.9 onwards proxy settings must be set manually, and support for negative PROXIES_COUNT has been removed.

docs/sanic/contributing.rst

@@ -1,89 +1 @@
-Contributing
-============
-
-Thank you for your interest! Sanic is always looking for contributors.
-If you don’t feel comfortable contributing code, adding docstrings to
-the source files is very appreciated.
-
-Installation
-------------
-
-To develop on sanic (and mainly to just run the tests) it is highly
-recommend to install from sources.
-
-So assume you have already cloned the repo and are in the working
-directory with a virtual environment already set up, then run:
-
-.. code:: bash
-
-   pip3 install -e '.[dev]'
-
-Dependency Changes
-------------------
-
-``Sanic`` doesn't use ``requirements*.txt`` files to manage any kind of dependencies related to it in order to simplify the
-effort required in managing the dependencies. Please make sure you have read and understood the following section of
-the document that explains the way ``sanic`` manages dependencies inside the ``setup.py`` file.
-
-+------------------------+-----------------------------------------------+--------------------------------+
-| Dependency Type        | Usage                                         | Installation                   |
-+========================+===============================================+================================+
-| requirements           | Bare minimum dependencies required for sanic  | ``pip3 install -e .``          |
-|                        | to function                                   |                                |
-+------------------------+-----------------------------------------------+--------------------------------+
-| tests_require /        | Dependencies required to run the Unit Tests   | ``pip3 install -e '.[test]'``  |
-| extras_require['test'] | for ``sanic``                                 |                                |
-+------------------------+-----------------------------------------------+--------------------------------+
-| extras_require['dev']  | Additional Development requirements to add    | ``pip3 install -e '.[dev]'``   |
-|                        | for contributing                              |                                |
-+------------------------+-----------------------------------------------+--------------------------------+
-| extras_require['docs'] | Dependencies required to enable building and  | ``pip3 install -e '.[docs]'``  |
-|                        | enhancing sanic documentation                 |                                |
-+------------------------+-----------------------------------------------+--------------------------------+
-
-Running tests
--------------
-
-To run the tests for sanic it is recommended to use tox like so:
-
-.. code:: bash
-
-   tox
-
-See it’s that simple!
-
-Pull requests!
---------------
-
-So the pull request approval rules are pretty simple:
-
-* All pull requests must pass unit tests
-* All pull requests must be reviewed and approved by at least one current collaborator on the project
-* All pull requests must pass flake8 checks
-* If you decide to remove/change anything from any common interface a deprecation message should accompany it.
-* If you implement a new feature you should have at least one unit test to accompany it.
-
-Documentation
--------------
-
-Sanic’s documentation is built using `sphinx`_. Guides are written in
-Markdown and can be found in the ``docs`` folder, while the module
-reference is automatically generated using ``sphinx-apidoc``.
-
-To generate the documentation from scratch:
-
-.. code:: bash
-
-   sphinx-apidoc -fo docs/_api/ sanic
-   sphinx-build -b html docs docs/_build
-
-The HTML documentation will be created in the ``docs/_build`` folder.
-
-.. warning::
-    One of the main goals of Sanic is speed. Code that lowers the
-    performance of Sanic without significant gains in usability, security,
-    or features may not be merged. Please don’t let this intimidate you! If
-    you have any concerns about an idea, open an issue for discussion and
-    help.
-
-.. _sphinx: http://www.sphinx-doc.org/en/1.5.1/
+.. include:: ../../CONTRIBUTING.rst

docs/sanic/debug_mode.rst

@@ -13,7 +13,7 @@ and by default will enable the Auto Reload feature.
 Setting the debug mode
 ----------------------
 
-By setting the ``debug`` mode a more verbose output from Sanic will be outputed
+By setting the ``debug`` mode a more verbose output from Sanic will be output
 and the Automatic Reloader will be activated.
 
 .. code-block:: python

docs/sanic/decorators.md

@@ -1,39 +0,0 @@
-# Handler Decorators
-
-Since Sanic handlers are simple Python functions, you can apply decorators to them in a similar manner to Flask. A typical use case is when you want some code to run before a handler's code is executed. 
-
-## Authorization Decorator
-
-Let's say you want to check that a user is authorized to access a particular endpoint. You can create a decorator that wraps a handler function, checks a request if the client is authorized to access a resource, and sends the appropriate response.
-
-
-```python
-from functools import wraps
-from sanic.response import json
-
-def authorized():
-    def decorator(f):
-        @wraps(f)
-        async def decorated_function(request, *args, **kwargs):
-            # run some method that checks the request
-            # for the client's authorization status
-            is_authorized = check_request_for_authorization_status(request)
-
-            if is_authorized:
-                # the user is authorized.
-                # run the handler method and return the response
-                response = await f(request, *args, **kwargs)
-                return response
-            else:
-                # the user is not authorized. 
-                return json({'status': 'not_authorized'}, 403)
-        return decorated_function
-    return decorator
-
-
-@app.route("/")
-@authorized()
-async def test(request):
-    return json({'status': 'authorized'})
-``` 
-

docs/sanic/decorators.rst

@@ -0,0 +1,40 @@
+Handler Decorators
+==================
+
+Since Sanic handlers are simple Python functions, you can apply decorators to them in a similar manner to Flask. A typical use case is when you want some code to run before a handler's code is executed.
+
+Authorization Decorator
+-----------------------
+
+Let's say you want to check that a user is authorized to access a particular endpoint. You can create a decorator that wraps a handler function, checks a request if the client is authorized to access a resource, and sends the appropriate response.
+
+
+.. code-block:: python
+
+    from functools import wraps
+    from sanic.response import json
+
+    def authorized():
+        def decorator(f):
+            @wraps(f)
+            async def decorated_function(request, *args, **kwargs):
+                # run some method that checks the request
+                # for the client's authorization status
+                is_authorized = check_request_for_authorization_status(request)
+
+                if is_authorized:
+                    # the user is authorized.
+                    # run the handler method and return the response
+                    response = await f(request, *args, **kwargs)
+                    return response
+                else:
+                    # the user is not authorized.
+                    return json({'status': 'not_authorized'}, 403)
+            return decorated_function
+        return decorator
+
+
+    @app.route("/")
+    @authorized()
+    async def test(request):
+        return json({'status': 'authorized'})

docs/sanic/deploying.md

@@ -1,160 +0,0 @@
-# Deploying
-
-Deploying Sanic is very simple using one of three options: the inbuilt webserver,
-an [ASGI webserver](https://asgi.readthedocs.io/en/latest/implementations.html), or `gunicorn`.
-It is also very common to place Sanic behind a reverse proxy, like `nginx`. 
-
-## Running via Sanic webserver
-
-After defining an instance of `sanic.Sanic`, we can call the `run` method with the following
-keyword arguments:
-
-- `host` *(default `"127.0.0.1"`)*: Address to host the server on.
-- `port` *(default `8000`)*: Port to host the server on.
-- `debug` *(default `False`)*: Enables debug output (slows server).
-- `ssl` *(default `None`)*: `SSLContext` for SSL encryption of worker(s).
-- `sock` *(default `None`)*: Socket for the server to accept connections from.
-- `workers` *(default `1`)*: Number of worker processes to spawn.
-- `loop` *(default `None`)*: An `asyncio`-compatible event loop. If none is
-                             specified, Sanic creates its own event loop.
-- `protocol` *(default `HttpProtocol`)*: Subclass
-  of
-  [asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.html#protocol-classes).
-- `access_log` *(default `True`)*: Enables log on handling requests (significantly slows server).
-
-```python
-app.run(host='0.0.0.0', port=1337, access_log=False)
-```
-
-In the above example, we decided to turn off the access log in order to increase performance.
-
-### Workers
-
-By default, Sanic listens in the main process using only one CPU core. To crank
-up the juice, just specify the number of workers in the `run` arguments.
-
-```python
-app.run(host='0.0.0.0', port=1337, workers=4)
-```
-
-Sanic will automatically spin up multiple processes and route traffic between
-them. We recommend as many workers as you have available cores.
-
-### Running via command
-
-If you like using command line arguments, you can launch a Sanic webserver by
-executing the module. For example, if you initialized Sanic as `app` in a file
-named `server.py`, you could run the server like so:
-
-`python -m sanic server.app --host=0.0.0.0 --port=1337 --workers=4`
-
-With this way of running sanic, it is not necessary to invoke `app.run` in your
-Python file. If you do, make sure you wrap it so that it only executes when
-directly run by the interpreter.
-
-```python
-if __name__ == '__main__':
-    app.run(host='0.0.0.0', port=1337, workers=4)
-```
-
-## Running via ASGI
-
-Sanic is also ASGI-compliant. This means you can use your preferred ASGI webserver
-to run Sanic. The three main implementations of ASGI are
-[Daphne](http://github.com/django/daphne), [Uvicorn](https://www.uvicorn.org/),
-and [Hypercorn](https://pgjones.gitlab.io/hypercorn/index.html).
-
-Follow their documentation for the proper way to run them, but it should look
-something like:
-
-```
-daphne myapp:app
-uvicorn myapp:app
-hypercorn myapp:app
-```
-
-A couple things to note when using ASGI:
-
-1. When using the Sanic webserver, websockets will run using the [`websockets`](https://websockets.readthedocs.io/) package. In ASGI mode, there is no need for this package since websockets are managed in the ASGI server.
-1. The ASGI [lifespan protocol](https://asgi.readthedocs.io/en/latest/specs/lifespan.html) supports
-only two server events: startup and shutdown. Sanic has four: before startup, after startup, 
-before shutdown, and after shutdown. Therefore, in ASGI mode, the startup and shutdown events will 
-run consecutively and not actually around the server process beginning and ending (since that 
-is now controlled by the ASGI server). Therefore, it is best to use `after_server_start` and 
-`before_server_stop`.
-1. ASGI mode is still in "beta" as of Sanic v19.6.
-
-## Running via Gunicorn
-
-[Gunicorn](http://gunicorn.org/) ‘Green Unicorn’ is a WSGI HTTP Server for UNIX.
-It’s a pre-fork worker model ported from Ruby’s Unicorn project.
-
-In order to run Sanic application with Gunicorn, you need to use the special `sanic.worker.GunicornWorker`
-for Gunicorn `worker-class` argument:
-
-```
-gunicorn myapp:app --bind 0.0.0.0:1337 --worker-class sanic.worker.GunicornWorker
-```
-
-If your application suffers from memory leaks, you can configure Gunicorn to gracefully restart a worker
-after it has processed a given number of requests. This can be a convenient way to help limit the effects
-of the memory leak.
-
-See the [Gunicorn Docs](http://docs.gunicorn.org/en/latest/settings.html#max-requests) for more information.
-
-## Other deployment considerations
-
-### Running behind a reverse proxy
-
-Sanic can be used with a reverse proxy (e.g. nginx). There's a simple example of nginx configuration:
-
-```
-server {
-  listen 80;
-  server_name example.org;
-
-  location / {
-    proxy_pass http://127.0.0.1:8000;
-    proxy_set_header Host $host;
-    proxy_set_header X-Real-IP $remote_addr;
-    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-  }
-}
-```
-
-If you want to get real client ip, you should configure `X-Real-IP` and `X-Forwarded-For` HTTP headers and set `app.config.PROXIES_COUNT` to `1`; see the configuration page for more information.
-
-### Disable debug logging for performance
-
-To improve the performance add `debug=False` and `access_log=False` in the `run` arguments.
-
-```python
-app.run(host='0.0.0.0', port=1337, workers=4, debug=False, access_log=False)
-```
-
-Running via Gunicorn you can set Environment variable `SANIC_ACCESS_LOG="False"`
-
-```
-env SANIC_ACCESS_LOG="False" gunicorn myapp:app --bind 0.0.0.0:1337 --worker-class sanic.worker.GunicornWorker --log-level warning
-```
-
-Or you can rewrite app config directly
-
-```python
-app.config.ACCESS_LOG = False
-```
-
-### Asynchronous support and sharing the loop
-
-This is suitable if you *need* to share the Sanic process with other applications, in particular the `loop`.
-However, be advised that this method does not support using multiple processes, and is not the preferred way
-to run the app in general.
-
-Here is an incomplete example (please see `run_async.py` in examples for something more practical):
-
-```python
-server = app.create_server(host="0.0.0.0", port=8000, return_asyncio_server=True)
-loop = asyncio.get_event_loop()
-task = asyncio.ensure_future(server)
-loop.run_forever()
-```

docs/sanic/deploying.rst

@@ -0,0 +1,201 @@
+Deploying
+=========
+
+Deploying Sanic is very simple using one of three options: the inbuilt webserver,
+an `ASGI webserver <https://asgi.readthedocs.io/en/latest/implementations.html>`_, or `gunicorn`.
+It is also very common to place Sanic behind a reverse proxy, like `nginx`.
+
+Running via Sanic webserver
+---------------------------
+
+After defining an instance of `sanic.Sanic`, we can call the `run` method with the following
+keyword arguments:
+
+- `host` *(default `"127.0.0.1"`)*: Address to host the server on.
+- `port` *(default `8000`)*: Port to host the server on.
+- `debug` *(default `False`)*: Enables debug output (slows server).
+- `ssl` *(default `None`)*: `SSLContext` for SSL encryption of worker(s).
+- `sock` *(default `None`)*: Socket for the server to accept connections from.
+- `workers` *(default `1`)*: Number of worker processes to spawn.
+- `loop` *(default `None`)*: An `asyncio`-compatible event loop. If none is specified, Sanic creates its own event loop.
+- `protocol` *(default `HttpProtocol`)*: Subclass of `asyncio.protocol <https://docs.python.org/3/library/asyncio-protocol.html#protocol-classes>`_.
+- `access_log` *(default `True`)*: Enables log on handling requests (significantly slows server).
+
+.. code-block:: python
+
+    app.run(host='0.0.0.0', port=1337, access_log=False)
+
+In the above example, we decided to turn off the access log in order to increase performance.
+
+Workers
+~~~~~~~
+
+By default, Sanic listens in the main process using only one CPU core. To crank
+up the juice, just specify the number of workers in the `run` arguments.
+
+.. code-block:: python
+
+    app.run(host='0.0.0.0', port=1337, workers=4)
+
+Sanic will automatically spin up multiple processes and route traffic between
+them. We recommend as many workers as you have available cores.
+
+Running via command
+~~~~~~~~~~~~~~~~~~~
+
+If you like using command line arguments, you can launch a Sanic webserver by
+executing the module. For example, if you initialized Sanic as `app` in a file
+named `server.py`, you could run the server like so:
+
+.. python -m sanic server.app --host=0.0.0.0 --port=1337 --workers=4
+
+With this way of running sanic, it is not necessary to invoke `app.run` in your
+Python file. If you do, make sure you wrap it so that it only executes when
+directly run by the interpreter.
+
+.. code-block:: python
+
+    if __name__ == '__main__':
+        app.run(host='0.0.0.0', port=1337, workers=4)
+
+Running via ASGI
+----------------
+
+Sanic is also ASGI-compliant. This means you can use your preferred ASGI webserver
+to run Sanic. The three main implementations of ASGI are
+`Daphne <http://github.com/django/daphne>`_, `Uvicorn <https://www.uvicorn.org/>`_,
+and `Hypercorn <https://pgjones.gitlab.io/hypercorn/index.html>`_.
+
+Follow their documentation for the proper way to run them, but it should look
+something like:
+
+::
+
+    daphne myapp:app
+    uvicorn myapp:app
+    hypercorn myapp:app
+
+A couple things to note when using ASGI:
+
+1. When using the Sanic webserver, websockets will run using the `websockets <https://websockets.readthedocs.io/>`_ package.
+In ASGI mode, there is no need for this package since websockets are managed in the ASGI server.
+2. The ASGI `lifespan protocol <https://asgi.readthedocs.io/en/latest/specs/lifespan.html>`, supports
+only two server events: startup and shutdown. Sanic has four: before startup, after startup,
+before shutdown, and after shutdown. Therefore, in ASGI mode, the startup and shutdown events will
+run consecutively and not actually around the server process beginning and ending (since that
+is now controlled by the ASGI server). Therefore, it is best to use `after_server_start` and
+`before_server_stop`.
+3. ASGI mode is still in "beta" as of Sanic v19.6.
+
+Running via Gunicorn
+--------------------
+
+`Gunicorn <http://gunicorn.org/>`_ ‘Green Unicorn’ is a WSGI HTTP Server for UNIX.
+It’s a pre-fork worker model ported from Ruby’s Unicorn project.
+
+In order to run Sanic application with Gunicorn, you need to use the special `sanic.worker.GunicornWorker`
+for Gunicorn `worker-class` argument:
+
+::
+
+    gunicorn myapp:app --bind 0.0.0.0:1337 --worker-class sanic.worker.GunicornWorker
+
+
+If your application suffers from memory leaks, you can configure Gunicorn to gracefully restart a worker
+after it has processed a given number of requests. This can be a convenient way to help limit the effects
+of the memory leak.
+
+See the `Gunicorn Docs <http://docs.gunicorn.org/en/latest/settings.html#max-requests>`_ for more information.
+
+Other deployment considerations
+-------------------------------
+
+Running behind a reverse proxy
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sanic can be used with a reverse proxy (e.g. nginx). There's a simple example of nginx configuration:
+
+
+::
+
+    server {
+      listen 80;
+      server_name example.org;
+      location / {
+        proxy_pass http://127.0.0.1:8000;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      }
+    }
+
+
+If you want to get real client ip, you should configure `X-Real-IP` and `X-Forwarded-For` HTTP headers and set `app.config.PROXIES_COUNT` to `1`; see the configuration page for more information.
+
+Disable debug logging for performance
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To improve the performance add `debug=False` and `access_log=False` in the `run` arguments.
+
+.. code-block:: python
+
+    app.run(host='0.0.0.0', port=1337, workers=4, debug=False, access_log=False)
+
+Running via Gunicorn you can set Environment variable `SANIC_ACCESS_LOG="False"`
+
+::
+
+    env SANIC_ACCESS_LOG="False" gunicorn myapp:app --bind 0.0.0.0:1337 --worker-class sanic.worker.GunicornWorker --log-level warning
+
+Or you can rewrite app config directly
+
+.. code-block:: python
+
+    app.config.ACCESS_LOG = False
+
+Asynchronous support and sharing the loop
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is suitable if you *need* to share the Sanic process with other applications, in particular the `loop`.
+However, be advised that this method does not support using multiple processes, and is not the preferred way
+to run the app in general.
+
+Here is an incomplete example (please see `run_async.py` in examples for something more practical):
+
+.. code-block:: python
+
+    server = app.create_server(host="0.0.0.0", port=8000, return_asyncio_server=True)
+    loop = asyncio.get_event_loop()
+    task = asyncio.ensure_future(server)
+    loop.run_forever()
+
+Caveat: using this method, calling `app.create_server()` will trigger "before_server_start" server events, but not
+"after_server_start", "before_server_stop", or "after_server_stop" server events.
+
+For more advanced use-cases, you can trigger these events using the AsyncioServer object, returned by awaiting
+the server task.
+
+Here is an incomplete example (please see `run_async_advanced.py` in examples for something more complete):
+
+.. code-block:: python
+
+    serv_coro = app.create_server(host="0.0.0.0", port=8000, return_asyncio_server=True)
+    loop = asyncio.get_event_loop()
+    serv_task = asyncio.ensure_future(serv_coro, loop=loop)
+    server = loop.run_until_complete(serv_task)
+    server.after_start()
+    try:
+        loop.run_forever()
+    except KeyboardInterrupt as e:
+        loop.stop()
+    finally:
+        server.before_stop()
+
+        # Wait for server to close
+        close_task = server.close()
+        loop.run_until_complete(close_task)
+
+        # Complete all tasks on the loop
+        for connection in server.connections:
+            connection.close_if_idle()
+        server.after_stop()

docs/sanic/exceptions.md

@@ -1,88 +0,0 @@
-# Exceptions
-
-Exceptions can be thrown from within request handlers and will automatically be
-handled by Sanic. Exceptions take a message as their first argument, and can
-also take a status code to be passed back in the HTTP response.
-
-## Throwing an exception
-
-To throw an exception, simply `raise` the relevant exception from the
-`sanic.exceptions` module.
-
-```python
-from sanic.exceptions import ServerError
-
-@app.route('/killme')
-async def i_am_ready_to_die(request):
-	raise ServerError("Something bad happened", status_code=500)
-```
-
-You can also use the `abort` function with the appropriate status code:
-
-```python
-from sanic.exceptions import abort
-from sanic.response import text
-
-@app.route('/youshallnotpass')
-async def no_no(request):
-        abort(401)
-        # this won't happen
-        text("OK")
-```
-
-## Handling exceptions
-
-To override Sanic's default handling of an exception, the `@app.exception`
-decorator is used. The decorator expects a list of exceptions to handle as
-arguments. You can pass `SanicException` to catch them all! The decorated
-exception handler function must take a `Request` and `Exception` object as
-arguments.
-
-```python
-from sanic.response import text
-from sanic.exceptions import NotFound
-
-@app.exception(NotFound)
-async def ignore_404s(request, exception):
-	return text("Yep, I totally found the page: {}".format(request.url))
-```
-
-You can also add an exception handler as such:
-
-```python
-from sanic import Sanic
-
-async def server_error_handler(request, exception):
-	return text("Oops, server error", status=500)
-
-app = Sanic()
-app.error_handler.add(Exception, server_error_handler)
-```
-
-In some cases, you might want to add some more error handling
-functionality to what is provided by default. In that case, you 
-can subclass Sanic's default error handler as such:
-
-```python
-from sanic import Sanic
-from sanic.handlers import ErrorHandler
-
-class CustomErrorHandler(ErrorHandler):
-	def default(self, request, exception):
-		''' handles errors that have no error handlers assigned '''
-		# You custom error handling logic...
-		return super().default(request, exception)
-		
-app = Sanic()
-app.error_handler = CustomErrorHandler()
-```
-
-## Useful exceptions
-
-Some of the most useful exceptions are presented below:
-
-- `NotFound`: called when a suitable route for the request isn't found.
-- `ServerError`: called when something goes wrong inside the server. This
-  usually occurs if there is an exception raised in user code.
-
-See the `sanic.exceptions` module for the full list of exceptions to throw.

docs/sanic/exceptions.rst

@@ -0,0 +1,92 @@
+Exceptions
+==========
+
+Exceptions can be thrown from within request handlers and will automatically be
+handled by Sanic. Exceptions take a message as their first argument, and can
+also take a status code to be passed back in the HTTP response.
+
+Throwing an exception
+---------------------
+
+To throw an exception, simply `raise` the relevant exception from the
+`sanic.exceptions` module.
+
+.. code-block:: python
+
+    from sanic.exceptions import ServerError
+
+    @app.route('/killme')
+    async def i_am_ready_to_die(request):
+        raise ServerError("Something bad happened", status_code=500)
+
+You can also use the `abort` function with the appropriate status code:
+
+.. code-block:: python
+
+    from sanic.exceptions import abort
+    from sanic.response import text
+
+    @app.route('/youshallnotpass')
+    async def no_no(request):
+            abort(401)
+            # this won't happen
+            text("OK")
+
+Handling exceptions
+-------------------
+
+To override Sanic's default handling of an exception, the `@app.exception`
+decorator is used. The decorator expects a list of exceptions to handle as
+arguments. You can pass `SanicException` to catch them all! The decorated
+exception handler function must take a `Request` and `Exception` object as
+arguments.
+
+.. code-block:: python
+
+    from sanic.response import text
+    from sanic.exceptions import NotFound
+
+    @app.exception(NotFound)
+    async def ignore_404s(request, exception):
+        return text("Yep, I totally found the page: {}".format(request.url))
+
+You can also add an exception handler as such:
+
+.. code-block:: python
+
+    from sanic import Sanic
+
+    async def server_error_handler(request, exception):
+        return text("Oops, server error", status=500)
+
+    app = Sanic()
+    app.error_handler.add(Exception, server_error_handler)
+
+In some cases, you might want to add some more error handling
+functionality to what is provided by default. In that case, you
+can subclass Sanic's default error handler as such:
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.handlers import ErrorHandler
+
+    class CustomErrorHandler(ErrorHandler):
+        def default(self, request, exception):
+            ''' handles errors that have no error handlers assigned '''
+            # You custom error handling logic...
+            return super().default(request, exception)
+
+    app = Sanic()
+    app.error_handler = CustomErrorHandler()
+
+Useful exceptions
+-----------------
+
+Some of the most useful exceptions are presented below:
+
+- `NotFound`: called when a suitable route for the request isn't found.
+- `ServerError`: called when something goes wrong inside the server. This
+  usually occurs if there is an exception raised in user code.
+
+See the `sanic.exceptions` module for the full list of exceptions to throw.

docs/sanic/extensions.md

@@ -1 +0,0 @@
-Moved to the [`awesome-sanic`](https://github.com/mekicha/awesome-sanic) list.

docs/sanic/extensions.rst

@@ -0,0 +1,4 @@
+Extensions
+==========
+
+Moved to the `awesome-sanic <https://github.com/mekicha/awesome-sanic>`_ list.

docs/sanic/getting_started.md

@@ -1,57 +0,0 @@
-# Getting Started
-
-Make sure you have both [pip](https://pip.pypa.io/en/stable/installing/) and at
-least version 3.6 of Python before starting. Sanic uses the new `async`/`await`
-syntax, so earlier versions of python won't work.
-
-## 1. Install Sanic
-
->   If you are running on a clean install of Fedora 28 or above, please make sure you have the ``redhat-rpm-config`` package installed in case if you want to use ``sanic`` with ``ujson`` dependency.
-
-```bash
-pip3 install sanic
-```
-
-To install sanic without `uvloop` or `ujson` using bash, you can provide either or both of these environmental variables
-using any truthy string like `'y', 'yes', 't', 'true', 'on', '1'` and setting the `SANIC_NO_X` (`X` = `UVLOOP`/`UJSON`) 
-to true will stop that features installation.
-
-```bash
-SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true pip3 install sanic
-```
-
-You can also install Sanic from [`conda-forge`](https://anaconda.org/conda-forge/sanic) 
-
-```bash
-conda config --add channels conda-forge
-conda install sanic
-```
-
-##  2. Create a file called `main.py`
-
-  ```python
-  from sanic import Sanic
-  from sanic.response import json
-
-  app = Sanic()
-
-  @app.route("/")
-  async def test(request):
-      return json({"hello": "world"})
-
-  if __name__ == "__main__":
-      app.run(host="0.0.0.0", port=8000)
-  ```
-
-## 3. Run the server
-
-  ```
-  python3 main.py
-  ```
-
-## 4. Check your browser
-
-Open the address `http://0.0.0.0:8000` in your web browser. You should see
-the message *Hello world!*.
-
-You now have a working Sanic server!

docs/sanic/getting_started.rst

@@ -0,0 +1,62 @@
+Getting Started
+===============
+
+Make sure you have both `pip <https://pip.pypa.io/en/stable/installing/>`_ and at
+least version 3.6 of Python before starting. Sanic uses the new `async`/`await`
+syntax, so earlier versions of python won't work.
+
+1. Install Sanic
+----------------
+
+>   If you are running on a clean install of Fedora 28 or above, please make sure you have the ``redhat-rpm-config`` package installed in case if you want to use ``sanic`` with ``ujson`` dependency.
+
+.. code-block:: bash
+
+    pip3 install sanic
+
+To install sanic without `uvloop` or `ujson` using bash, you can provide either or both of these environmental variables
+using any truthy string like `'y', 'yes', 't', 'true', 'on', '1'` and setting the `SANIC_NO_X` (`X` = `UVLOOP`/`UJSON`)
+to true will stop that features installation.
+
+.. code-block:: bash
+
+    SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true pip3 install sanic
+
+You can also install Sanic from `conda-forge <https://anaconda.org/conda-forge/sanic>`_
+
+.. code-block:: bash
+
+    conda config --add channels conda-forge
+    conda install sanic
+
+2. Create a file called `main.py`
+---------------------------------
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+
+    app = Sanic()
+
+    @app.route("/")
+    async def test(request):
+      return json({"hello": "world"})
+
+    if __name__ == "__main__":
+      app.run(host="0.0.0.0", port=8000)
+
+3. Run the server
+-----------------
+
+.. code-block:: bash
+
+    python3 main.py
+
+4. Check your browser
+---------------------
+
+Open the address `http://0.0.0.0:8000 <http://0.0.0.0:8000>`_ in your web browser. You should see
+the message *Hello world!*.
+
+You now have a working Sanic server!

docs/sanic/index.rst

@@ -26,4 +26,5 @@ Sanic aspires to be simple
 
 .. note::
 
-    Sanic does not support Python 3.5 from version 19.6 and forward. However, version 18.12LTS is supported thru December 2020. Official Python support for version 3.5 is set to expire in September 2020.
+    Sanic does not support Python 3.5 from version 19.6 and forward. However, version 18.12LTS is supported thru
+    December 2020. Official Python support for version 3.5 is set to expire in September 2020.

docs/sanic/middleware.md

@@ -1,158 +0,0 @@
-# Middleware And Listeners
-
-Middleware are functions which are executed before or after requests to the
-server. They can be used to modify the *request to* or *response from*
-user-defined handler functions.
-
-Additionally, Sanic provides listeners which allow you to run code at various points of your application's lifecycle.
-
-## Middleware
-
-There are two types of middleware: request and response. Both are declared
-using the `@app.middleware` decorator, with the decorator's parameter being a
-string representing its type: `'request'` or `'response'`.
-
-* Request middleware receives only the `request` as argument.
-* Response middleware receives both the `request` and `response`.
-
-The simplest middleware doesn't modify the request or response at all:
-
-```
-@app.middleware('request')
-async def print_on_request(request):
-	print("I print when a request is received by the server")
-
-@app.middleware('response')
-async def print_on_response(request, response):
-	print("I print when a response is returned by the server")
-```
-
-## Modifying the request or response
-
-Middleware can modify the request or response parameter it is given, *as long
-as it does not return it*. The following example shows a practical use-case for
-this.
-
-```
-app = Sanic(__name__)
-
-
-@app.middleware('request')
-async def add_key(request):
-    # Add a key to request object like dict object
-    request['foo'] = 'bar'
-
-
-@app.middleware('response')
-async def custom_banner(request, response):
-	response.headers["Server"] = "Fake-Server"
-
-
-@app.middleware('response')
-async def prevent_xss(request, response):
-	response.headers["x-xss-protection"] = "1; mode=block"
-
-
-app.run(host="0.0.0.0", port=8000)
-```
-
-The above code will apply the three middleware in order. The first middleware
-**add_key** will add a new key `foo` into `request` object. This worked because
-`request` object can be manipulated like `dict` object. Then, the second middleware
-**custom_banner** will change the HTTP response header *Server* to
-*Fake-Server*, and the last middleware **prevent_xss** will add the HTTP
-header for preventing Cross-Site-Scripting (XSS) attacks. These two functions
-are invoked *after* a user function returns a response.
-
-## Responding early
-
-If middleware returns a `HTTPResponse` object, the request will stop processing
-and the response will be returned. If this occurs to a request before the
-relevant user route handler is reached, the handler will never be called.
-Returning a response will also prevent any further middleware from running.
-
-```
-@app.middleware('request')
-async def halt_request(request):
-	return text('I halted the request')
-
-@app.middleware('response')
-async def halt_response(request, response):
-	return text('I halted the response')
-```
-
-## Listeners
-
-If you want to execute startup/teardown code as your server starts or closes, you can use the following listeners:
-
-- `before_server_start`
-- `after_server_start`
-- `before_server_stop`
-- `after_server_stop`
-
-These listeners are implemented as decorators on functions which accept the app object as well as the asyncio loop.
-
-For example:
-
-```
-@app.listener('before_server_start')
-async def setup_db(app, loop):
-    app.db = await db_setup()
-
-@app.listener('after_server_start')
-async def notify_server_started(app, loop):
-    print('Server successfully started!')
-
-@app.listener('before_server_stop')
-async def notify_server_stopping(app, loop):
-    print('Server shutting down!')
-
-@app.listener('after_server_stop')
-async def close_db(app, loop):
-    await app.db.close()
-```
-
-It's also possible to register a listener using the `register_listener` method.
-This may be useful if you define your listeners in another module besides
-the one you instantiate your app in.
-
-```
-app = Sanic()
-
-async def setup_db(app, loop):
-    app.db = await db_setup()
-
-app.register_listener(setup_db, 'before_server_start')
-
-```
-
-If you want to schedule a background task to run after the loop has started,
-Sanic provides the `add_task` method to easily do so.
-
-```
-async def notify_server_started_after_five_seconds():
-    await asyncio.sleep(5)
-    print('Server successfully started!')
-
-app.add_task(notify_server_started_after_five_seconds())
-```
-
-Sanic will attempt to automatically inject the app, passing it as an argument to the task:
-
-```
-async def notify_server_started_after_five_seconds(app):
-    await asyncio.sleep(5)
-    print(app.name)
-
-app.add_task(notify_server_started_after_five_seconds)
-```
-
-Or you can pass the app explicitly for the same effect:
-
-```
-async def notify_server_started_after_five_seconds(app):
-    await asyncio.sleep(5)
-    print(app.name)
-
-app.add_task(notify_server_started_after_five_seconds(app))
-`

docs/sanic/middleware.rst

@@ -0,0 +1,177 @@
+Middleware And Listeners
+========================
+
+Middleware are functions which are executed before or after requests to the
+server. They can be used to modify the *request to* or *response from*
+user-defined handler functions.
+
+Additionally, Sanic provides listeners which allow you to run code at various points of your application's lifecycle.
+
+Middleware
+----------
+
+There are two types of middleware: request and response. Both are declared
+using the `@app.middleware` decorator, with the decorator's parameter being a
+string representing its type: `'request'` or `'response'`.
+
+* Request middleware receives only the `request` as argument.
+* Response middleware receives both the `request` and `response`.
+
+The simplest middleware doesn't modify the request or response at all:
+
+.. code-block:: python
+
+    @app.middleware('request')
+    async def print_on_request(request):
+        print("I print when a request is received by the server")
+
+    @app.middleware('response')
+    async def print_on_response(request, response):
+        print("I print when a response is returned by the server")
+
+Modifying the request or response
+---------------------------------
+
+Middleware can modify the request or response parameter it is given, *as long
+as it does not return it*. The following example shows a practical use-case for
+this.
+
+.. code-block:: python
+
+    app = Sanic(__name__)
+
+
+    @app.middleware('request')
+    async def add_key(request):
+        # Arbitrary data may be stored in request context:
+        request.ctx.foo = 'bar'
+
+
+    @app.middleware('response')
+    async def custom_banner(request, response):
+        response.headers["Server"] = "Fake-Server"
+
+
+    @app.middleware('response')
+    async def prevent_xss(request, response):
+        response.headers["x-xss-protection"] = "1; mode=block"
+
+
+    @app.get("/")
+    async def index(request):
+        return sanic.response.text(request.ctx.foo)
+
+
+    app.run(host="0.0.0.0", port=8000)
+
+The three middlewares are executed in order:
+
+1. The first request middleware **add_key** adds a new key `foo` into request context.
+2. Request is routed to handler **index**, which gets the key from context and returns a text response.
+3. The first response middleware **custom_banner** changes the HTTP response header *Server* to say *Fake-Server*
+4. The second response middleware **prevent_xss** adds the HTTP header for preventing Cross-Site-Scripting (XSS) attacks.
+
+Responding early
+----------------
+
+If middleware returns a `HTTPResponse` object, the request will stop processing
+and the response will be returned. If this occurs to a request before the
+relevant user route handler is reached, the handler will never be called.
+Returning a response will also prevent any further middleware from running.
+
+.. code-block:: python
+
+    @app.middleware('request')
+    async def halt_request(request):
+        return text('I halted the request')
+
+    @app.middleware('response')
+    async def halt_response(request, response):
+        return text('I halted the response')
+
+Custom context
+--------------
+
+Arbitrary data may be stored in `request.ctx`. A typical use case
+would be to store the user object acquired from database in an authentication
+middleware. Keys added are accessible to all later middleware as well as
+the handler over the duration of the request.
+
+Custom context is reserved for applications and extensions. Sanic itself makes
+no use of it.
+
+Listeners
+---------
+
+If you want to execute startup/teardown code as your server starts or closes, you can use the following listeners:
+
+- `before_server_start`
+- `after_server_start`
+- `before_server_stop`
+- `after_server_stop`
+
+These listeners are implemented as decorators on functions which accept the app object as well as the asyncio loop.
+
+For example:
+
+.. code-block:: python
+
+    @app.listener('before_server_start')
+    async def setup_db(app, loop):
+        app.db = await db_setup()
+
+    @app.listener('after_server_start')
+    async def notify_server_started(app, loop):
+        print('Server successfully started!')
+
+    @app.listener('before_server_stop')
+    async def notify_server_stopping(app, loop):
+        print('Server shutting down!')
+
+    @app.listener('after_server_stop')
+    async def close_db(app, loop):
+        await app.db.close()
+
+It's also possible to register a listener using the `register_listener` method.
+This may be useful if you define your listeners in another module besides
+the one you instantiate your app in.
+
+.. code-block:: python
+
+    app = Sanic()
+
+    async def setup_db(app, loop):
+        app.db = await db_setup()
+
+    app.register_listener(setup_db, 'before_server_start')
+
+If you want to schedule a background task to run after the loop has started,
+Sanic provides the `add_task` method to easily do so.
+
+.. code-block:: python
+
+    async def notify_server_started_after_five_seconds():
+        await asyncio.sleep(5)
+        print('Server successfully started!')
+
+    app.add_task(notify_server_started_after_five_seconds())
+
+Sanic will attempt to automatically inject the app, passing it as an argument to the task:
+
+.. code-block:: python
+
+    async def notify_server_started_after_five_seconds(app):
+        await asyncio.sleep(5)
+        print(app.name)
+
+    app.add_task(notify_server_started_after_five_seconds)
+
+Or you can pass the app explicitly for the same effect:
+
+.. code-block:: python
+
+    async def notify_server_started_after_five_seconds(app):
+        await asyncio.sleep(5)
+        print(app.name)
+
+    app.add_task(notify_server_started_after_five_seconds(app))

docs/sanic/request_data.md

@@ -1,257 +0,0 @@
-# Request Data
-
-When an endpoint receives a HTTP request, the route function is passed a
-`Request` object.
-
-The following variables are accessible as properties on `Request` objects:
-
-- `json` (any) - JSON body
-
-  ```python
-  from sanic.response import json
-
-  @app.route("/json")
-  def post_json(request):
-      return json({ "received": True, "message": request.json })
-  ```
-
-- `args` (dict) - Query string variables. A query string is the section of a
-  URL that resembles `?key1=value1&key2=value2`. If that URL were to be parsed,
-  the `args` dictionary would look like `{'key1': ['value1'], 'key2': ['value2']}`.
-  The request's `query_string` variable holds the unparsed string value.
-  Property is providing the default parsing strategy. If you would like to change it look to the section below
-  (`Changing the default parsing rules of the queryset`).
-
-  ```python
-  from sanic.response import json
-
-  @app.route("/query_string")
-  def query_string(request):
-      return json({ "parsed": True, "args": request.args, "url": request.url, "query_string": request.query_string })
-  ```
-
-- `query_args` (list) - On many cases you would need to access the url arguments in
-  a less packed form. `query_args` is the list of `(key, value)` tuples.
-  Property is providing the default parsing strategy. If you would like to change it look to the section below
-  (`Changing the default parsing rules of the queryset`).
-  For the same previous URL queryset `?key1=value1&key2=value2`, the
-  `query_args` list would look like `[('key1', 'value1'), ('key2', 'value2')]`.
-  And in case of the multiple params with the same key like `?key1=value1&key2=value2&key1=value3`
-  the `query_args` list would look like `[('key1', 'value1'), ('key2', 'value2'), ('key1', 'value3')]`.
-
-  The difference between Request.args and Request.query_args
-  for the queryset `?key1=value1&key2=value2&key1=value3`
-
-  ```python
-  from sanic import Sanic
-  from sanic.response import json
-
-  app = Sanic(__name__)
-
-
-  @app.route("/test_request_args")
-  async def test_request_args(request):
-      return json({
-          "parsed": True,
-          "url": request.url,
-          "query_string": request.query_string,
-          "args": request.args,
-          "raw_args": request.raw_args,
-          "query_args": request.query_args,
-      })
-
-  if __name__ == '__main__':
-      app.run(host="0.0.0.0", port=8000)
-  ```
-
-  Output
-
-  ```
-  {
-    "parsed":true,
-    "url":"http:\/\/0.0.0.0:8000\/test_request_args?key1=value1&key2=value2&key1=value3",
-    "query_string":"key1=value1&key2=value2&key1=value3",
-    "args":{"key1":["value1","value3"],"key2":["value2"]},
-    "raw_args":{"key1":"value1","key2":"value2"},
-    "query_args":[["key1","value1"],["key2","value2"],["key1","value3"]]
-  }
-  ```
-
-  `raw_args` contains only the first entry of `key1`. Will be deprecated in the future versions.
-
-- `files` (dictionary of `File` objects) - List of files that have a name, body, and type
-
-  ```python
-  from sanic.response import json
-
-  @app.route("/files")
-  def post_json(request):
-      test_file = request.files.get('test')
-
-      file_parameters = {
-          'body': test_file.body,
-          'name': test_file.name,
-          'type': test_file.type,
-      }
-
-      return json({ "received": True, "file_names": request.files.keys(), "test_file_parameters": file_parameters })
-  ```
-
-- `form` (dict) - Posted form variables.
-
-  ```python
-  from sanic.response import json
-
-  @app.route("/form")
-  def post_json(request):
-      return json({ "received": True, "form_data": request.form, "test": request.form.get('test') })
-  ```
-
-- `body` (bytes) - Posted raw body. This property allows retrieval of the
-  request's raw data, regardless of content type.
-
-  ```python
-  from sanic.response import text
-
-  @app.route("/users", methods=["POST",])
-  def create_user(request):
-      return text("You are trying to create a user with the following POST: %s" % request.body)
-  ```
-
-- `headers` (dict) - A case-insensitive dictionary that contains the request headers.
-
-- `method` (str) - HTTP method of the request (ie `GET`, `POST`).
-
-- `ip` (str) - IP address of the requester.
-
-- `port` (str) - Port address of the requester.
-
-- `socket` (tuple) - (IP, port) of the requester.
-
-- `app` - a reference to the Sanic application object that is handling this request. This is useful when inside blueprints or other handlers in modules that do not have access to the global `app` object.
-
-  ```python
-  from sanic.response import json
-  from sanic import Blueprint
-
-  bp = Blueprint('my_blueprint')
-
-  @bp.route('/')
-  async def bp_root(request):
-      if request.app.config['DEBUG']:
-          return json({'status': 'debug'})
-      else:
-          return json({'status': 'production'})
-
-  ```
-- `url`: The full URL of the request, ie: `http://localhost:8000/posts/1/?foo=bar`
-- `scheme`: The URL scheme associated with the request: `http` or `https`
-- `host`: The host associated with the request: `localhost:8080`
-- `path`: The path of the request: `/posts/1/`
-- `query_string`: The query string of the request: `foo=bar` or a blank string `''`
-- `uri_template`: Template for matching route handler: `/posts/<id>/`
-- `token`: The value of Authorization header: `Basic YWRtaW46YWRtaW4=`
-
-
-## Changing the default parsing rules of the queryset
-
-The default parameters that are using internally in `args` and `query_args` properties to parse queryset:
-
-- `keep_blank_values` (bool): `False` - flag indicating whether blank values in
-  percent-encoded queries should be treated as blank strings.
-  A true value indicates that blanks should be retained as blank
-  strings.  The default false value indicates that blank values
-  are to be ignored and treated as if they were  not included.
-- `strict_parsing` (bool): `False` - flag indicating what to do with parsing errors. If
-  false (the default), errors are silently ignored. If true,
-  errors raise a ValueError exception.
-- `encoding` and `errors` (str): 'utf-8' and 'replace' - specify how to decode percent-encoded sequences
-  into Unicode characters, as accepted by the bytes.decode() method.
-
-If you would like to change that default parameters you could call `get_args` and `get_query_args` methods
-with the new values.
-
-For the queryset `/?test1=value1&test2=&test3=value3`:
-
-```python
-from sanic.response import json
-
-@app.route("/query_string")
-def query_string(request):
-    args_with_blank_values = request.get_args(keep_blank_values=True)
-    return json({
-        "parsed": True,
-        "url": request.url,
-        "args_with_blank_values": args_with_blank_values,
-        "query_string": request.query_string
-    })
-```
-
-The output will be:
-
-```
-{
-    "parsed": true,
-    "url": "http:\/\/0.0.0.0:8000\/query_string?test1=value1&test2=&test3=value3",
-    "args_with_blank_values": {"test1": ["value1"], "test2": "", "test3": ["value3"]},
-    "query_string": "test1=value1&test2=&test3=value3"
-}
-```
-
-## Accessing values using `get` and `getlist`
-
-The request properties which return a dictionary actually return a subclass of
-`dict` called `RequestParameters`. The key difference when using this object is
-the distinction between the `get` and `getlist` methods.
-
-- `get(key, default=None)` operates as normal, except that when the value of
-  the given key is a list, *only the first item is returned*.
-- `getlist(key, default=None)` operates as normal, *returning the entire list*.
-
-```python
-from sanic.request import RequestParameters
-
-args = RequestParameters()
-args['titles'] = ['Post 1', 'Post 2']
-
-args.get('titles') # => 'Post 1'
-
-args.getlist('titles') # => ['Post 1', 'Post 2']
-```
-
-## Accessing the handler name with the request.endpoint attribute
-
-The `request.endpoint` attribute holds the handler's name. For instance, the below
-route will return "hello".
-
-```python
-from sanic.response import text
-from sanic import Sanic
-
-app = Sanic()
-
-@app.get("/")
-def hello(request):
-    return text(request.endpoint)
-```
-
-Or, with a blueprint it will be include both, separated by a period. For example,
- the below route would return foo.bar:
-
-```python
-from sanic import Sanic
-from sanic import Blueprint
-from sanic.response import text
-
-
-app = Sanic(__name__)
-blueprint = Blueprint('foo')
-
-@blueprint.get('/')
-async def bar(request):
-    return text(request.endpoint)
-
-app.blueprint(blueprint)
-
-app.run(host="0.0.0.0", port=8000, debug=True)
-```

docs/sanic/request_data.rst

@@ -0,0 +1,274 @@
+Request Data
+============
+
+When an endpoint receives a HTTP request, the route function is passed a
+`Request` object.
+
+The following variables are accessible as properties on `Request` objects:
+
+- `json` (any) - JSON body
+
+.. code-block:: python
+
+    from sanic.response import json
+
+    @app.route("/json")
+    def post_json(request):
+      return json({ "received": True, "message": request.json })
+
+
+- `args` (dict) - Query string variables. A query string is the section of a
+  URL that resembles ``?key1=value1&key2=value2``.
+If that URL were to be parsed, the `args` dictionary would look like `{'key1': ['value1'], 'key2': ['value2']}`.
+The request's `query_string` variable holds the unparsed string value. Property is providing the default parsing
+strategy. If you would like to change it look to the section below (`Changing the default parsing rules of the queryset`).
+
+.. code-block:: python
+
+    from sanic.response import json
+
+    @app.route("/query_string")
+    def query_string(request):
+      return json({ "parsed": True, "args": request.args, "url": request.url, "query_string": request.query_string })
+
+- `query_args` (list) - On many cases you would need to access the url arguments in
+  a less packed form. `query_args` is the list of `(key, value)` tuples.
+Property is providing the default parsing strategy. If you would like to change it look to the section below
+(`Changing the default parsing rules of the queryset`). For the same previous URL queryset `?key1=value1&key2=value2`,
+the `query_args` list would look like `[('key1', 'value1'), ('key2', 'value2')]`. And in case of the multiple params
+with the same key like `?key1=value1&key2=value2&key1=value3` the `query_args` list would look like
+`[('key1', 'value1'), ('key2', 'value2'), ('key1', 'value3')]`.
+
+The difference between Request.args and Request.query_args for the queryset `?key1=value1&key2=value2&key1=value3`
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+
+    app = Sanic(__name__)
+
+
+    @app.route("/test_request_args")
+    async def test_request_args(request):
+      return json({
+          "parsed": True,
+          "url": request.url,
+          "query_string": request.query_string,
+          "args": request.args,
+          "raw_args": request.raw_args,
+          "query_args": request.query_args,
+      })
+
+    if __name__ == '__main__':
+      app.run(host="0.0.0.0", port=8000)
+
+  Output
+
+.. code-block:: json
+
+    {
+        "parsed":true,
+        "url":"http:\/\/0.0.0.0:8000\/test_request_args?key1=value1&key2=value2&key1=value3",
+        "query_string":"key1=value1&key2=value2&key1=value3",
+        "args":{"key1":["value1","value3"],"key2":["value2"]},
+        "raw_args":{"key1":"value1","key2":"value2"},
+        "query_args":[["key1","value1"],["key2","value2"],["key1","value3"]]
+    }
+
+- `raw_args` contains only the first entry of `key1`. Will be deprecated in the future versions.
+
+- `files` (dictionary of `File` objects) - List of files that have a name, body, and type
+
+.. code-block:: python
+
+    from sanic.response import json
+
+    @app.route("/files")
+    def post_json(request):
+      test_file = request.files.get('test')
+
+      file_parameters = {
+          'body': test_file.body,
+          'name': test_file.name,
+          'type': test_file.type,
+      }
+
+      return json({ "received": True, "file_names": request.files.keys(), "test_file_parameters": file_parameters })
+
+- `form` (dict) - Posted form variables.
+
+.. code-block:: python
+
+    from sanic.response import json
+
+    @app.route("/form")
+    def post_json(request):
+      return json({ "received": True, "form_data": request.form, "test": request.form.get('test') })
+
+- `body` (bytes) - Posted raw body. This property allows retrieval of the
+  request's raw data, regardless of content type.
+
+.. code-block:: python
+
+  from sanic.response import text
+
+  @app.route("/users", methods=["POST",])
+  def create_user(request):
+      return text("You are trying to create a user with the following POST: %s" % request.body)
+
+
+- `headers` (dict) - A case-insensitive dictionary that contains the request headers.
+
+- `method` (str) - HTTP method of the request (ie `GET`, `POST`).
+
+- `ip` (str) - IP address of the requester.
+
+- `port` (str) - Port address of the requester.
+
+- `socket` (tuple) - (IP, port) of the requester.
+
+- `app` - a reference to the Sanic application object that is handling this request. This is useful when inside blueprints or other handlers in modules that do not have access to the global `app` object.
+
+.. code-block:: python
+
+  from sanic.response import json
+  from sanic import Blueprint
+
+  bp = Blueprint('my_blueprint')
+
+  @bp.route('/')
+  async def bp_root(request):
+      if request.app.config['DEBUG']:
+          return json({'status': 'debug'})
+      else:
+          return json({'status': 'production'})
+
+- `url`: The full URL of the request, ie: `http://localhost:8000/posts/1/?foo=bar`
+- `scheme`: The URL scheme associated with the request: 'http|https|ws|wss' or arbitrary value given by the headers.
+- `host`: The host associated with the request(which in the `Host` header): `localhost:8080`
+- `server_name`: The hostname of the server, without port number. the value is seeked in this order: `config.SERVER_NAME`, `x-forwarded-host` header, :func:`Request.host`
+- `server_port`: Like `server_name`. Seeked in this order: `x-forwarded-port` header, :func:`Request.host`, actual port used by the transport layer socket.
+- `path`: The path of the request: `/posts/1/`
+- `query_string`: The query string of the request: `foo=bar` or a blank string `''`
+- `uri_template`: Template for matching route handler: `/posts/<id>/`
+- `token`: The value of Authorization header: `Basic YWRtaW46YWRtaW4=`
+
+- `url_for`: Just like `sanic.Sanic.url_for`, but automatically determine `scheme` and `netloc` base on the request. Since this method is aiming to generate correct schema & netloc, `_external` is implied.
+
+
+Changing the default parsing rules of the queryset
+--------------------------------------------------
+
+The default parameters that are using internally in `args` and `query_args` properties to parse queryset:
+
+- `keep_blank_values` (bool): `False` - flag indicating whether blank values in
+  percent-encoded queries should be treated as blank strings.
+  A true value indicates that blanks should be retained as blank
+  strings.  The default false value indicates that blank values
+  are to be ignored and treated as if they were  not included.
+- `strict_parsing` (bool): `False` - flag indicating what to do with parsing errors. If
+  false (the default), errors are silently ignored. If true,
+  errors raise a ValueError exception.
+- `encoding` and `errors` (str): 'utf-8' and 'replace' - specify how to decode percent-encoded sequences
+  into Unicode characters, as accepted by the bytes.decode() method.
+
+If you would like to change that default parameters you could call `get_args` and `get_query_args` methods
+with the new values.
+
+For the queryset `/?test1=value1&test2=&test3=value3`:
+
+.. code-block:: python
+
+    from sanic.response import json
+
+    @app.route("/query_string")
+    def query_string(request):
+        args_with_blank_values = request.get_args(keep_blank_values=True)
+        return json({
+            "parsed": True,
+            "url": request.url,
+            "args_with_blank_values": args_with_blank_values,
+            "query_string": request.query_string
+        })
+
+The output will be:
+
+.. code-block:: JSON
+
+    {
+        "parsed": true,
+        "url": "http:\/\/0.0.0.0:8000\/query_string?test1=value1&test2=&test3=value3",
+        "args_with_blank_values": {"test1": ["value1"], "test2": "", "test3": ["value3"]},
+        "query_string": "test1=value1&test2=&test3=value3"
+    }
+
+Accessing values using `get` and `getlist`
+------------------------------------------
+
+The `request.args` returns a subclass of `dict` called `RequestParameters`. 
+The key difference when using this object is the distinction between the `get` and `getlist` methods.
+
+- `get(key, default=None)` operates as normal, except that when the value of
+  the given key is a list, *only the first item is returned*.
+- `getlist(key, default=None)` operates as normal, *returning the entire list*.
+
+.. code-block:: python
+
+    from sanic.request import RequestParameters
+
+    args = RequestParameters()
+    args['titles'] = ['Post 1', 'Post 2']
+
+    args.get('titles') # => 'Post 1'
+
+    args.getlist('titles') # => ['Post 1', 'Post 2']
+
+.. code-block:: python
+    from sanic import Sanic
+    from sanic.response import json
+
+    app = Sanic(name="example")
+
+    @app.route("/")
+    def get_handler(request):
+        return json({
+            "p1": request.args.getlist("p1")
+        })
+        
+Accessing the handler name with the request.endpoint attribute
+--------------------------------------------------------------
+
+The `request.endpoint` attribute holds the handler's name. For instance, the below
+route will return "hello".
+
+.. code-block:: python
+
+    from sanic.response import text
+    from sanic import Sanic
+
+    app = Sanic()
+
+    @app.get("/")
+    def hello(request):
+        return text(request.endpoint)
+
+Or, with a blueprint it will be include both, separated by a period. For example, the below route would return foo.bar:
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic import Blueprint
+    from sanic.response import text
+
+
+    app = Sanic(__name__)
+    blueprint = Blueprint('foo')
+
+    @blueprint.get('/')
+    async def bar(request):
+        return text(request.endpoint)
+
+    app.blueprint(blueprint)
+
+    app.run(host="0.0.0.0", port=8000, debug=True)

docs/sanic/response.md

@@ -1,114 +0,0 @@
-# Response
-
-Use functions in `sanic.response` module to create responses.
-
-## Plain Text
-
-```python
-from sanic import response
-
-
-@app.route('/text')
-def handle_request(request):
-    return response.text('Hello world!')
-```
-
-## HTML
-
-```python
-from sanic import response
-
-
-@app.route('/html')
-def handle_request(request):
-    return response.html('<p>Hello world!</p>')
-```
-
-## JSON
-
-
-```python
-from sanic import response
-
-
-@app.route('/json')
-def handle_request(request):
-    return response.json({'message': 'Hello world!'})
-```
-
-## File
-
-```python
-from sanic import response
-
-
-@app.route('/file')
-async def handle_request(request):
-    return await response.file('/srv/www/whatever.png')
-```
-
-## Streaming
-
-```python
-from sanic import response
-
-@app.route("/streaming")
-async def index(request):
-    async def streaming_fn(response):
-        await response.write('foo')
-        await response.write('bar')
-    return response.stream(streaming_fn, content_type='text/plain')
-```
-
-See [Streaming](streaming.md) for more information.
-
-## File Streaming
-For large files, a combination of File and Streaming above
-```python
-from sanic import response
-
-@app.route('/big_file.png')
-async def handle_request(request):
-    return await response.file_stream('/srv/www/whatever.png')
-```
-
-## Redirect
-
-```python
-from sanic import response
-
-
-@app.route('/redirect')
-def handle_request(request):
-    return response.redirect('/json')
-```
-
-## Raw
-
-Response without encoding the body
-
-```python
-from sanic import response
-
-
-@app.route('/raw')
-def handle_request(request):
-    return response.raw(b'raw data')
-```
-
-## Modify headers or status
-
-To modify headers or status code, pass the `headers` or `status` argument to those functions:
-
-```python
-from sanic import response
-
-
-@app.route('/json')
-def handle_request(request):
-    return response.json(
-        {'message': 'Hello world!'},
-        headers={'X-Served-By': 'sanic'},
-        status=200
-    )
-```

docs/sanic/response.rst

@@ -0,0 +1,126 @@
+Response
+========
+
+Use functions in `sanic.response` module to create responses.
+
+Plain Text
+----------
+
+.. code-block:: python
+
+    from sanic import response
+
+
+    @app.route('/text')
+    def handle_request(request):
+        return response.text('Hello world!')
+
+HTML
+----
+
+.. code-block:: python
+
+    from sanic import response
+
+
+    @app.route('/html')
+    def handle_request(request):
+        return response.html('<p>Hello world!</p>')
+
+JSON
+----
+
+
+.. code-block:: python
+
+    from sanic import response
+
+
+    @app.route('/json')
+    def handle_request(request):
+        return response.json({'message': 'Hello world!'})
+
+File
+----
+
+.. code-block:: python
+
+    from sanic import response
+
+
+    @app.route('/file')
+    async def handle_request(request):
+        return await response.file('/srv/www/whatever.png')
+
+Streaming
+---------
+
+.. code-block:: python
+
+    from sanic import response
+
+    @app.route("/streaming")
+    async def index(request):
+        async def streaming_fn(response):
+            await response.write('foo')
+            await response.write('bar')
+        return response.stream(streaming_fn, content_type='text/plain')
+
+See `Streaming <streaming.html>`_ for more information.
+
+File Streaming
+--------------
+
+For large files, a combination of File and Streaming above
+
+.. code-block:: python
+
+    from sanic import response
+
+    @app.route('/big_file.png')
+    async def handle_request(request):
+        return await response.file_stream('/srv/www/whatever.png')
+
+Redirect
+--------
+
+.. code-block:: python
+
+    from sanic import response
+
+
+    @app.route('/redirect')
+    def handle_request(request):
+        return response.redirect('/json')
+
+Raw
+---
+
+Response without encoding the body
+
+.. code-block:: python
+
+    from sanic import response
+
+
+    @app.route('/raw')
+    def handle_request(request):
+        return response.raw(b'raw data')
+
+Modify headers or status
+------------------------
+
+To modify headers or status code, pass the `headers` or `status` argument to those functions:
+
+.. code-block:: python
+
+    from sanic import response
+
+
+    @app.route('/json')
+    def handle_request(request):
+        return response.json(
+            {'message': 'Hello world!'},
+            headers={'X-Served-By': 'sanic'},
+            status=200
+        )

docs/sanic/routing.md

@@ -1,375 +0,0 @@
-# Routing
-
-Routing allows the user to specify handler functions for different URL endpoints.
-
-A basic route looks like the following, where `app` is an instance of the
-`Sanic` class:
-
-```python
-from sanic.response import json
-
-@app.route("/")
-async def test(request):
-    return json({ "hello": "world" })
-```
-
-When the url `http://server.url/` is accessed (the base url of the server), the
-final `/` is matched by the router to the handler function, `test`, which then
-returns a JSON object.
-
-Sanic handler functions must be defined using the `async def` syntax, as they
-are asynchronous functions.
-
-## Request parameters
-
-Sanic comes with a basic router that supports request parameters.
-
-To specify a parameter, surround it with angle quotes like so: `<PARAM>`.
-Request parameters will be passed to the route handler functions as keyword
-arguments.
-
-```python
-from sanic.response import text
-
-@app.route('/tag/<tag>')
-async def tag_handler(request, tag):
-	return text('Tag - {}'.format(tag))
-```
-
-To specify a type for the parameter, add a `:type` after the parameter name,
-inside the quotes. If the parameter does not match the specified type, Sanic
-will throw a `NotFound` exception, resulting in a `404: Page not found` error
-on the URL.
-
-```python
-from sanic.response import text
-
-@app.route('/number/<integer_arg:int>')
-async def integer_handler(request, integer_arg):
-	return text('Integer - {}'.format(integer_arg))
-
-@app.route('/number/<number_arg:number>')
-async def number_handler(request, number_arg):
-	return text('Number - {}'.format(number_arg))
-
-@app.route('/person/<name:[A-z]+>')
-async def person_handler(request, name):
-	return text('Person - {}'.format(name))
-
-@app.route('/folder/<folder_id:[A-z0-9]{0,4}>')
-async def folder_handler(request, folder_id):
-	return text('Folder - {}'.format(folder_id))
-
-```
-
-## HTTP request types
-
-By default, a route defined on a URL will be available for only GET requests to that URL.
-However, the `@app.route` decorator accepts an optional parameter, `methods`,
-which allows the handler function to work with any of the HTTP methods in the list.
-
-```python
-from sanic.response import text
-
-@app.route('/post', methods=['POST'])
-async def post_handler(request):
-	return text('POST request - {}'.format(request.json))
-
-@app.route('/get', methods=['GET'])
-async def get_handler(request):
-	return text('GET request - {}'.format(request.args))
-
-```
-
-There is also an optional `host` argument (which can be a list or a string). This restricts a route to the host or hosts provided. If there is a also a route with no host, it will be the default.
-
-```python
-@app.route('/get', methods=['GET'], host='example.com')
-async def get_handler(request):
-	return text('GET request - {}'.format(request.args))
-
-# if the host header doesn't match example.com, this route will be used
-@app.route('/get', methods=['GET'])
-async def get_handler(request):
-	return text('GET request in default - {}'.format(request.args))
-```
-
-There are also shorthand method decorators:
-
-```python
-from sanic.response import text
-
-@app.post('/post')
-async def post_handler(request):
-	return text('POST request - {}'.format(request.json))
-
-@app.get('/get')
-async def get_handler(request):
-	return text('GET request - {}'.format(request.args))
-
-```
-## The `add_route` method
-
-As we have seen, routes are often specified using the `@app.route` decorator.
-However, this decorator is really just a wrapper for the `app.add_route`
-method, which is used as follows:
-
-```python
-from sanic.response import text
-
-# Define the handler functions
-async def handler1(request):
-	return text('OK')
-
-async def handler2(request, name):
-	return text('Folder - {}'.format(name))
-
-async def person_handler2(request, name):
-	return text('Person - {}'.format(name))
-
-# Add each handler function as a route
-app.add_route(handler1, '/test')
-app.add_route(handler2, '/folder/<name>')
-app.add_route(person_handler2, '/person/<name:[A-z]>', methods=['GET'])
-```
-
-## URL building with `url_for`
-
-Sanic provides a `url_for` method, to generate URLs based on the handler method name. This is useful if you want to avoid hardcoding url paths into your app; instead, you can just reference the handler name. For example:
-
-```python
-from sanic.response import redirect
-
-@app.route('/')
-async def index(request):
-    # generate a URL for the endpoint `post_handler`
-    url = app.url_for('post_handler', post_id=5)
-    # the URL is `/posts/5`, redirect to it
-    return redirect(url)    
-
-@app.route('/posts/<post_id>')
-async def post_handler(request, post_id):
-    return text('Post - {}'.format(post_id))
-```
-
-Other things to keep in mind when using `url_for`:
-
-- Keyword arguments passed to `url_for` that are not request parameters will be included in the URL's query string. For example:
-```python
-url = app.url_for('post_handler', post_id=5, arg_one='one', arg_two='two')
-# /posts/5?arg_one=one&arg_two=two
-```
-- Multivalue argument can be passed to `url_for`. For example:
-```python
-url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two'])
-# /posts/5?arg_one=one&arg_one=two
-```
-- Also some special arguments (`_anchor`, `_external`, `_scheme`, `_method`, `_server`) passed to `url_for` will have special url building (`_method` is not supported now and will be ignored). For example:
-```python
-url = app.url_for('post_handler', post_id=5, arg_one='one', _anchor='anchor')
-# /posts/5?arg_one=one#anchor
-
-url = app.url_for('post_handler', post_id=5, arg_one='one', _external=True)
-# //server/posts/5?arg_one=one
-# _external requires you to pass an argument _server or set SERVER_NAME in app.config if not url will be same as no _external
-
-url = app.url_for('post_handler', post_id=5, arg_one='one', _scheme='http', _external=True)
-# http://server/posts/5?arg_one=one
-# when specifying _scheme, _external must be True
-
-# you can pass all special arguments at once
-url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two'], arg_two=2, _anchor='anchor', _scheme='http', _external=True, _server='another_server:8888')
-# http://another_server:8888/posts/5?arg_one=one&arg_one=two&arg_two=2#anchor
-```
-- All valid parameters must be passed to `url_for` to build a URL. If a parameter is not supplied, or if a parameter does not match the specified type, a `URLBuildError` will be raised.
-
-## WebSocket routes
-
-Routes for the WebSocket protocol can be defined with the `@app.websocket`
-decorator:
-
-```python
-@app.websocket('/feed')
-async def feed(request, ws):
-    while True:
-        data = 'hello!'
-        print('Sending: ' + data)
-        await ws.send(data)
-        data = await ws.recv()
-        print('Received: ' + data)
-```
-
-Alternatively, the `app.add_websocket_route` method can be used instead of the
-decorator:
-
-```python
-async def feed(request, ws):
-    pass
-
-app.add_websocket_route(my_websocket_handler, '/feed')
-```
-
-Handlers to a WebSocket route are invoked with the request as first argument, and a
-WebSocket protocol object as second argument. The protocol object has `send`
-and `recv` methods to send and receive data respectively.
-
-WebSocket support requires the [websockets](https://github.com/aaugustin/websockets)
-package by Aymeric Augustin.
-
-
-## About `strict_slashes`
-
-You can make `routes` strict to trailing slash or not, it's configurable.
-
-```python
-
-# provide default strict_slashes value for all routes
-app = Sanic('test_route_strict_slash', strict_slashes=True)
-
-# you can also overwrite strict_slashes value for specific route
-@app.get('/get', strict_slashes=False)
-def handler(request):
-    return text('OK')
-
-# It also works for blueprints
-bp = Blueprint('test_bp_strict_slash', strict_slashes=True)
-
-@bp.get('/bp/get', strict_slashes=False)
-def handler(request):
-    return text('OK')
-
-app.blueprint(bp)
-```
-
-The behavior of how the `strict_slashes` flag follows a defined hierarchy which decides if a specific route
-falls under the `strict_slashes` behavior.
-
-```bash
-|___ Route
-     |___ Blueprint
-            |___ Application
-```
-
-Above hierarchy defines how the `strict_slashes` flag will behave. The first non `None` value of the `strict_slashes`
-found in the above order will be applied to the route in question.
-
-```python
-from sanic import Sanic, Blueprint
-from sanic.response import text
-
-app = Sanic("sample_strict_slashes", strict_slashes=True)
-
-@app.get("/r1")
-def r1(request):
-    return text("strict_slashes is applicable from App level")
-
-@app.get("/r2", strict_slashes=False)
-def r2(request):
-    return text("strict_slashes is not applicable due to  False value set in route level")
-
-bp = Blueprint("bp", strict_slashes=False)
-
-@bp.get("/r3", strict_slashes=True)
-def r3(request):
-    return text("strict_slashes applicable from blueprint route level")
-
-bp1 = Blueprint("bp1", strict_slashes=True)
-
-@bp.get("/r4")
-def r3(request):
-    return text("strict_slashes applicable from blueprint level")
-```
-
-## User defined route name
-
-A custom route name can be used by passing a `name` argument while registering the route which will
-override the default route name generated using the `handler.__name__` attribute.
-
-```python
-
-app = Sanic('test_named_route')
-
-@app.get('/get', name='get_handler')
-def handler(request):
-    return text('OK')
-
-# then you need use `app.url_for('get_handler')`
-# instead of # `app.url_for('handler')`
-
-# It also works for blueprints
-bp = Blueprint('test_named_bp')
-
-@bp.get('/bp/get', name='get_handler')
-def handler(request):
-    return text('OK')
-
-app.blueprint(bp)
-
-# then you need use `app.url_for('test_named_bp.get_handler')`
-# instead of `app.url_for('test_named_bp.handler')`
-
-# different names can be used for same url with different methods
-
-@app.get('/test', name='route_test')
-def handler(request):
-    return text('OK')
-
-@app.post('/test', name='route_post')
-def handler2(request):
-    return text('OK POST')
-
-@app.put('/test', name='route_put')
-def handler3(request):
-    return text('OK PUT')
-
-# below url are the same, you can use any of them
-# '/test'
-app.url_for('route_test')
-# app.url_for('route_post')
-# app.url_for('route_put')
-
-# for same handler name with different methods
-# you need specify the name (it's url_for issue)
-@app.get('/get')
-def handler(request):
-    return text('OK')
-
-@app.post('/post', name='post_handler')
-def handler(request):
-    return text('OK')
-
-# then
-# app.url_for('handler') == '/get'
-# app.url_for('post_handler') == '/post'
-```
-
-## Build URL for static files
-
-Sanic supports using `url_for` method to build static file urls. In case if the static url
-is pointing to a directory, `filename` parameter to the `url_for` can be ignored.   q
-
-```python
-
-app = Sanic('test_static')
-app.static('/static', './static')
-app.static('/uploads', './uploads', name='uploads')
-app.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
-
-bp = Blueprint('bp', url_prefix='bp')
-bp.static('/static', './static')
-bp.static('/uploads', './uploads', name='uploads')
-bp.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
-app.blueprint(bp)
-
-# then build the url
-app.url_for('static', filename='file.txt') == '/static/file.txt'
-app.url_for('static', name='static', filename='file.txt') == '/static/file.txt'
-app.url_for('static', name='uploads', filename='file.txt') == '/uploads/file.txt'
-app.url_for('static', name='best_png') == '/the_best.png'
-
-# blueprint url building
-app.url_for('static', name='bp.static', filename='file.txt') == '/bp/static/file.txt'
-app.url_for('static', name='bp.uploads', filename='file.txt') == '/bp/uploads/file.txt'
-app.url_for('static', name='bp.best_png') == '/bp/static/the_best.png'
-
-```

docs/sanic/routing.rst

@@ -0,0 +1,433 @@
+Routing
+-------
+
+Routing allows the user to specify handler functions for different URL endpoints.
+
+A basic route looks like the following, where `app` is an instance of the
+`Sanic` class:
+
+.. code-block:: python
+
+    from sanic.response import json
+
+    @app.route("/")
+    async def test(request):
+        return json({ "hello": "world" })
+
+When the url `http://server.url/` is accessed (the base url of the server), the
+final `/` is matched by the router to the handler function, `test`, which then
+returns a JSON object.
+
+Sanic handler functions must be defined using the `async def` syntax, as they
+are asynchronous functions.
+
+Request parameters
+==================
+
+Sanic comes with a basic router that supports request parameters.
+
+To specify a parameter, surround it with angle quotes like so: `<PARAM>`.
+Request parameters will be passed to the route handler functions as keyword
+arguments.
+
+.. code-block:: python
+
+    from sanic.response import text
+
+    @app.route('/tag/<tag>')
+    async def tag_handler(request, tag):
+        return text('Tag - {}'.format(tag))
+
+To specify a type for the parameter, add a `:type` after the parameter name,
+inside the quotes. If the parameter does not match the specified type, Sanic
+will throw a `NotFound` exception, resulting in a `404: Page not found` error
+on the URL.
+
+Supported types
+~~~~~~~~~~~~~~~
+
+* `string`
+    * "Bob"
+    * "Python 3"
+* `int`
+    * 10
+    * 20
+    * 30
+    * -10
+    * (No floats work here)
+* `number`
+    * 1
+    * 1.5
+    * 10
+    * -10
+* `alpha`
+    * "Bob"
+    * "Python"
+    * (If it contains a symbol or a non alphanumeric character it will fail)
+* `path`
+    * "hello"
+    * "hello.text"
+    * "hello world"
+* `uuid`
+    * 123a123a-a12a-1a1a-a1a1-1a12a1a12345 (UUIDv4 Support)
+* `regex expression`
+
+If no type is set then a string is expected. The argument given to the function will always be a string, independent of the type.
+
+.. code-block:: python
+
+    from sanic.response import text
+
+    @app.route('/string/<string_arg:string>')
+    async def string_handler(request, string_arg):
+        return text('String - {}'.format(string_arg))
+
+    @app.route('/int/<integer_arg:int>')
+    async def integer_handler(request, integer_arg):
+        return text('Integer - {}'.format(integer_arg))
+
+    @app.route('/number/<number_arg:number>')
+    async def number_handler(request, number_arg):
+        return text('Number - {}'.format(number_arg))
+
+    @app.route('/alpha/<alpha_arg:alpha>')
+    async def number_handler(request, alpha_arg):
+        return text('Alpha - {}'.format(alpha_arg))
+
+    @app.route('/path/<path_arg:path>')
+    async def number_handler(request, path_arg):
+        return text('Path - {}'.format(path_arg))
+
+    @app.route('/uuid/<uuid_arg:uuid>')
+    async def number_handler(request, uuid_arg):
+        return text('Uuid - {}'.format(uuid_arg))
+
+    @app.route('/person/<name:[A-z]+>')
+    async def person_handler(request, name):
+        return text('Person - {}'.format(name))
+
+    @app.route('/folder/<folder_id:[A-z0-9]{0,4}>')
+    async def folder_handler(request, folder_id):
+        return text('Folder - {}'.format(folder_id))
+
+.. warning::
+
+    `str` is not a valid type tag. If you want `str` recognition then you must use `string`
+
+HTTP request types
+==================
+
+By default, a route defined on a URL will be available for only GET requests to that URL.
+However, the `@app.route` decorator accepts an optional parameter, `methods`,
+which allows the handler function to work with any of the HTTP methods in the list.
+
+.. code-block:: python
+
+    from sanic.response import text
+
+    @app.route('/post', methods=['POST'])
+    async def post_handler(request):
+        return text('POST request - {}'.format(request.json))
+
+    @app.route('/get', methods=['GET'])
+    async def get_handler(request):
+        return text('GET request - {}'.format(request.args))
+
+There is also an optional `host` argument (which can be a list or a string). This restricts a route to the host or hosts provided. If there is a also a route with no host, it will be the default.
+
+.. code-block:: python
+
+    @app.route('/get', methods=['GET'], host='example.com')
+    async def get_handler(request):
+        return text('GET request - {}'.format(request.args))
+
+    # if the host header doesn't match example.com, this route will be used
+    @app.route('/get', methods=['GET'])
+    async def get_handler(request):
+        return text('GET request in default - {}'.format(request.args))
+
+There are also shorthand method decorators:
+
+.. code-block:: python
+
+    from sanic.response import text
+
+    @app.post('/post')
+    async def post_handler(request):
+        return text('POST request - {}'.format(request.json))
+
+    @app.get('/get')
+    async def get_handler(request):
+        return text('GET request - {}'.format(request.args))
+
+The `add_route` method
+======================
+
+As we have seen, routes are often specified using the `@app.route` decorator.
+However, this decorator is really just a wrapper for the `app.add_route`
+method, which is used as follows:
+
+.. code-block:: python
+
+    from sanic.response import text
+
+    # Define the handler functions
+    async def handler1(request):
+        return text('OK')
+
+    async def handler2(request, name):
+        return text('Folder - {}'.format(name))
+
+    async def person_handler2(request, name):
+        return text('Person - {}'.format(name))
+
+    # Add each handler function as a route
+    app.add_route(handler1, '/test')
+    app.add_route(handler2, '/folder/<name>')
+    app.add_route(person_handler2, '/person/<name:[A-z]>', methods=['GET'])
+
+URL building with `url_for`
+===========================
+
+Sanic provides a `url_for` method, to generate URLs based on the handler method name. This is useful if you want to avoid hardcoding url paths into your app; instead, you can just reference the handler name. For example:
+
+.. code-block:: python
+
+    from sanic.response import redirect
+
+    @app.route('/')
+    async def index(request):
+        # generate a URL for the endpoint `post_handler`
+        url = app.url_for('post_handler', post_id=5)
+        # the URL is `/posts/5`, redirect to it
+        return redirect(url)
+
+    @app.route('/posts/<post_id>')
+    async def post_handler(request, post_id):
+        return text('Post - {}'.format(post_id))
+
+Other things to keep in mind when using `url_for`:
+
+- Keyword arguments passed to `url_for` that are not request parameters will be included in the URL's query string. For example:
+
+.. code-block:: python
+
+    url = app.url_for('post_handler', post_id=5, arg_one='one', arg_two='two')
+    # /posts/5?arg_one=one&arg_two=two
+
+- Multivalue argument can be passed to `url_for`. For example:
+
+.. code-block:: python
+
+    url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two'])
+    # /posts/5?arg_one=one&arg_one=two
+
+- Also some special arguments (`_anchor`, `_external`, `_scheme`, `_method`, `_server`) passed to `url_for` will have special url building (`_method` is not supported now and will be ignored). For example:
+
+.. code-block:: python
+
+    url = app.url_for('post_handler', post_id=5, arg_one='one', _anchor='anchor')
+    # /posts/5?arg_one=one#anchor
+
+    url = app.url_for('post_handler', post_id=5, arg_one='one', _external=True)
+    # //server/posts/5?arg_one=one
+    # _external requires you to pass an argument _server or set SERVER_NAME in app.config if not url will be same as no _external
+
+    url = app.url_for('post_handler', post_id=5, arg_one='one', _scheme='http', _external=True)
+    # http://server/posts/5?arg_one=one
+    # when specifying _scheme, _external must be True
+
+    # you can pass all special arguments at once
+    url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two'], arg_two=2, _anchor='anchor', _scheme='http', _external=True, _server='another_server:8888')
+    # http://another_server:8888/posts/5?arg_one=one&arg_one=two&arg_two=2#anchor
+
+- All valid parameters must be passed to `url_for` to build a URL. If a parameter is not supplied, or if a parameter does not match the specified type, a `URLBuildError` will be raised.
+
+WebSocket routes
+================
+
+Routes for the WebSocket protocol can be defined with the `@app.websocket`
+decorator:
+
+.. code-block:: python
+
+    @app.websocket('/feed')
+    async def feed(request, ws):
+        while True:
+            data = 'hello!'
+            print('Sending: ' + data)
+            await ws.send(data)
+            data = await ws.recv()
+            print('Received: ' + data)
+
+Alternatively, the `app.add_websocket_route` method can be used instead of the
+decorator:
+
+.. code-block:: python
+
+    async def feed(request, ws):
+        pass
+
+    app.add_websocket_route(my_websocket_handler, '/feed')
+
+Handlers to a WebSocket route are invoked with the request as first argument, and a
+WebSocket protocol object as second argument. The protocol object has `send`
+and `recv` methods to send and receive data respectively.
+
+WebSocket support requires the `websockets <https://github.com/aaugustin/websockets>`_
+package by Aymeric Augustin.
+
+
+About `strict_slashes`
+======================
+
+You can make `routes` strict to trailing slash or not, it's configurable.
+
+.. code-block:: python
+
+    # provide default strict_slashes value for all routes
+    app = Sanic('test_route_strict_slash', strict_slashes=True)
+
+    # you can also overwrite strict_slashes value for specific route
+    @app.get('/get', strict_slashes=False)
+    def handler(request):
+        return text('OK')
+
+    # It also works for blueprints
+    bp = Blueprint('test_bp_strict_slash', strict_slashes=True)
+
+    @bp.get('/bp/get', strict_slashes=False)
+    def handler(request):
+        return text('OK')
+
+    app.blueprint(bp)
+
+The behavior of how the `strict_slashes` flag follows a defined hierarchy which decides if a specific route
+falls under the `strict_slashes` behavior.
+
+|    Route/
+|    ├──Blueprint/
+|       ├──Application/
+
+Above hierarchy defines how the `strict_slashes` flag will behave. The first non `None` value of the `strict_slashes`
+found in the above order will be applied to the route in question.
+
+.. code-block:: python
+
+    from sanic import Sanic, Blueprint
+    from sanic.response import text
+
+    app = Sanic("sample_strict_slashes", strict_slashes=True)
+
+    @app.get("/r1")
+    def r1(request):
+        return text("strict_slashes is applicable from App level")
+
+    @app.get("/r2", strict_slashes=False)
+    def r2(request):
+        return text("strict_slashes is not applicable due to  False value set in route level")
+
+    bp = Blueprint("bp", strict_slashes=False)
+
+    @bp.get("/r3", strict_slashes=True)
+    def r3(request):
+        return text("strict_slashes applicable from blueprint route level")
+
+    bp1 = Blueprint("bp1", strict_slashes=True)
+
+    @bp.get("/r4")
+    def r3(request):
+        return text("strict_slashes applicable from blueprint level")
+
+User defined route name
+=======================
+
+A custom route name can be used by passing a `name` argument while registering the route which will
+override the default route name generated using the `handler.__name__` attribute.
+
+.. code-block:: python
+
+    app = Sanic('test_named_route')
+
+    @app.get('/get', name='get_handler')
+    def handler(request):
+        return text('OK')
+
+    # then you need use `app.url_for('get_handler')`
+    # instead of # `app.url_for('handler')`
+
+    # It also works for blueprints
+    bp = Blueprint('test_named_bp')
+
+    @bp.get('/bp/get', name='get_handler')
+    def handler(request):
+        return text('OK')
+
+    app.blueprint(bp)
+
+    # then you need use `app.url_for('test_named_bp.get_handler')`
+    # instead of `app.url_for('test_named_bp.handler')`
+
+    # different names can be used for same url with different methods
+
+    @app.get('/test', name='route_test')
+    def handler(request):
+        return text('OK')
+
+    @app.post('/test', name='route_post')
+    def handler2(request):
+        return text('OK POST')
+
+    @app.put('/test', name='route_put')
+    def handler3(request):
+        return text('OK PUT')
+
+    # below url are the same, you can use any of them
+    # '/test'
+    app.url_for('route_test')
+    # app.url_for('route_post')
+    # app.url_for('route_put')
+
+    # for same handler name with different methods
+    # you need specify the name (it's url_for issue)
+    @app.get('/get')
+    def handler(request):
+        return text('OK')
+
+    @app.post('/post', name='post_handler')
+    def handler(request):
+        return text('OK')
+
+    # then
+    # app.url_for('handler') == '/get'
+    # app.url_for('post_handler') == '/post'
+
+Build URL for static files
+==========================
+
+Sanic supports using `url_for` method to build static file urls. In case if the static url
+is pointing to a directory, `filename` parameter to the `url_for` can be ignored.   q
+
+.. code-block:: python
+
+    app = Sanic('test_static')
+    app.static('/static', './static')
+    app.static('/uploads', './uploads', name='uploads')
+    app.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
+
+    bp = Blueprint('bp', url_prefix='bp')
+    bp.static('/static', './static')
+    bp.static('/uploads', './uploads', name='uploads')
+    bp.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
+    app.blueprint(bp)
+
+    # then build the url
+    app.url_for('static', filename='file.txt') == '/static/file.txt'
+    app.url_for('static', name='static', filename='file.txt') == '/static/file.txt'
+    app.url_for('static', name='uploads', filename='file.txt') == '/uploads/file.txt'
+    app.url_for('static', name='best_png') == '/the_best.png'
+
+    # blueprint url building
+    app.url_for('static', name='bp.static', filename='file.txt') == '/bp/static/file.txt'
+    app.url_for('static', name='bp.uploads', filename='file.txt') == '/bp/uploads/file.txt'
+    app.url_for('static', name='bp.best_png') == '/bp/static/the_best.png'

docs/sanic/static_files.md

@@ -1,83 +0,0 @@
-# Static Files
-
-Static files and directories, such as an image file, are served by Sanic when
-registered with the `app.static()` method. The method takes an endpoint URL and a
-filename. The file specified will then be accessible via the given endpoint.
-
-```python
-from sanic import Sanic
-from sanic.blueprints import Blueprint
-
-app = Sanic(__name__)
-
-# Serves files from the static folder to the URL /static
-app.static('/static', './static')
-# use url_for to build the url, name defaults to 'static' and can be ignored
-app.url_for('static', filename='file.txt') == '/static/file.txt'
-app.url_for('static', name='static', filename='file.txt') == '/static/file.txt'
-
-# Serves the file /home/ubuntu/test.png when the URL /the_best.png
-# is requested
-app.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
-
-# you can use url_for to build the static file url
-# you can ignore name and filename parameters if you don't define it
-app.url_for('static', name='best_png') == '/the_best.png'
-app.url_for('static', name='best_png', filename='any') == '/the_best.png'
-
-# you need define the name for other static files
-app.static('/another.png', '/home/ubuntu/another.png', name='another')
-app.url_for('static', name='another') == '/another.png'
-app.url_for('static', name='another', filename='any') == '/another.png'
-
-# also, you can use static for blueprint
-bp = Blueprint('bp', url_prefix='/bp')
-bp.static('/static', './static')
-
-# servers the file directly
-bp.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
-app.blueprint(bp)
-
-app.url_for('static', name='bp.static', filename='file.txt') == '/bp/static/file.txt'
-app.url_for('static', name='bp.best_png') == '/bp/test_best.png'
-
-app.run(host="0.0.0.0", port=8000)
-```
-
-> **Note:** Sanic does not provide directory index when you serve a static directory.
-
-## Virtual Host
-
-The `app.static()` method also support **virtual host**. You can serve your static files with specific **virtual host** with `host` argument. For example:
-
-```python
-from sanic import Sanic
-
-app = Sanic(__name__)
-
-app.static('/static', './static')
-app.static('/example_static', './example_static', host='www.example.com')
-```
-
-## Streaming Large File
-
-In some cases, you might server large file(ex: videos, images, etc.) with Sanic. You can choose to use **streaming file** rather than download directly.
-
-Here is an example:
-```python
-from sanic import Sanic
-
-app = Sanic(__name__)
-
-app.static('/large_video.mp4', '/home/ubuntu/large_video.mp4', stream_large_files=True)
-```
-
-When `stream_large_files` is `True`, Sanic will use `file_stream()` instead of `file()` to serve static files. This will use **1KB** as the default chunk size. And, if needed, you can also use a custom chunk size. For example:
-```python
-from sanic import Sanic
-
-app = Sanic(__name__)
-
-chunk_size = 1024 * 1024 * 8 # Set chunk size to 8KB
-app.static('/large_video.mp4', '/home/ubuntu/large_video.mp4', stream_large_files=chunk_size)
-```

docs/sanic/static_files.rst

@@ -0,0 +1,92 @@
+Static Files
+============
+
+Static files and directories, such as an image file, are served by Sanic when
+registered with the `app.static()` method. The method takes an endpoint URL and a
+filename. The file specified will then be accessible via the given endpoint.
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.blueprints import Blueprint
+
+    app = Sanic(__name__)
+
+    # Serves files from the static folder to the URL /static
+    app.static('/static', './static')
+    # use url_for to build the url, name defaults to 'static' and can be ignored
+    app.url_for('static', filename='file.txt') == '/static/file.txt'
+    app.url_for('static', name='static', filename='file.txt') == '/static/file.txt'
+
+    # Serves the file /home/ubuntu/test.png when the URL /the_best.png
+    # is requested
+    app.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
+
+    # you can use url_for to build the static file url
+    # you can ignore name and filename parameters if you don't define it
+    app.url_for('static', name='best_png') == '/the_best.png'
+    app.url_for('static', name='best_png', filename='any') == '/the_best.png'
+
+    # you need define the name for other static files
+    app.static('/another.png', '/home/ubuntu/another.png', name='another')
+    app.url_for('static', name='another') == '/another.png'
+    app.url_for('static', name='another', filename='any') == '/another.png'
+
+    # also, you can use static for blueprint
+    bp = Blueprint('bp', url_prefix='/bp')
+    bp.static('/static', './static')
+
+    # specify a different content_type for your files
+    # such as adding 'charset'
+    app.static('/', '/public/index.html', content_type="text/html; charset=utf-8")
+
+    # servers the file directly
+    bp.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
+    app.blueprint(bp)
+
+    app.url_for('static', name='bp.static', filename='file.txt') == '/bp/static/file.txt'
+    app.url_for('static', name='bp.best_png') == '/bp/test_best.png'
+
+    app.run(host="0.0.0.0", port=8000)
+
+> **Note:** Sanic does not provide directory index when you serve a static directory.
+
+Virtual Host
+------------
+
+The `app.static()` method also support **virtual host**. You can serve your static files with specific **virtual host** with `host` argument. For example:
+
+.. code-block:: python
+
+    from sanic import Sanic
+
+    app = Sanic(__name__)
+
+    app.static('/static', './static')
+    app.static('/example_static', './example_static', host='www.example.com')
+
+Streaming Large File
+--------------------
+
+In some cases, you might server large file(ex: videos, images, etc.) with Sanic. You can choose to use **streaming file** rather than download directly.
+
+Here is an example:
+
+.. code-block:: python
+
+    from sanic import Sanic
+
+    app = Sanic(__name__)
+
+    app.static('/large_video.mp4', '/home/ubuntu/large_video.mp4', stream_large_files=True)
+
+When `stream_large_files` is `True`, Sanic will use `file_stream()` instead of `file()` to serve static files. This will use **1KB** as the default chunk size. And, if needed, you can also use a custom chunk size. For example:
+
+.. code-block:: python
+
+    from sanic import Sanic
+
+    app = Sanic(__name__)
+
+    chunk_size = 1024 * 1024 * 8 # Set chunk size to 8KB
+    app.static('/large_video.mp4', '/home/ubuntu/large_video.mp4', stream_large_files=chunk_size)

docs/sanic/streaming.md

@@ -1,143 +0,0 @@
-# Streaming
-
-## Request Streaming
-
-Sanic allows you to get request data by stream, as below. When the request ends, `await request.stream.read()` returns `None`. Only post, put and patch decorator have stream argument.
-
-```python
-from sanic import Sanic
-from sanic.views import CompositionView
-from sanic.views import HTTPMethodView
-from sanic.views import stream as stream_decorator
-from sanic.blueprints import Blueprint
-from sanic.response import stream, text
-
-bp = Blueprint('blueprint_request_stream')
-app = Sanic('request_stream')
-
-
-class SimpleView(HTTPMethodView):
-
-    @stream_decorator
-    async def post(self, request):
-        result = ''
-        while True:
-            body = await request.stream.read()
-            if body is None:
-                break
-            result += body.decode('utf-8')
-        return text(result)
-
-
-@app.post('/stream', stream=True)
-async def handler(request):
-    async def streaming(response):
-        while True:
-            body = await request.stream.read()
-            if body is None:
-                break
-            body = body.decode('utf-8').replace('1', 'A')
-            await response.write(body)
-    return stream(streaming)
-
-
-@bp.put('/bp_stream', stream=True)
-async def bp_put_handler(request):
-    result = ''
-    while True:
-        body = await request.stream.read()
-        if body is None:
-            break
-        result += body.decode('utf-8').replace('1', 'A')
-    return text(result)
-
-
-# You can also use `bp.add_route()` with stream argument
-async def bp_post_handler(request):
-    result = ''
-    while True:
-        body = await request.stream.read()
-        if body is None:
-            break
-        result += body.decode('utf-8').replace('1', 'A')
-    return text(result)
-
-bp.add_route(bp_post_handler, '/bp_stream', methods=['POST'], stream=True)
-
-
-async def post_handler(request):
-    result = ''
-    while True:
-        body = await request.stream.read()
-        if body is None:
-            break
-        result += body.decode('utf-8')
-    return text(result)
-
-app.blueprint(bp)
-app.add_route(SimpleView.as_view(), '/method_view')
-view = CompositionView()
-view.add(['POST'], post_handler, stream=True)
-app.add_route(view, '/composition_view')
-
-
-if __name__ == '__main__':
-    app.run(host='127.0.0.1', port=8000)
-```
-
-## Response Streaming
-
-Sanic allows you to stream content to the client with the `stream` method. This method accepts a coroutine callback which is passed a `StreamingHTTPResponse` object that is written to. A simple example is like follows:
-
-```python
-from sanic import Sanic
-from sanic.response import stream
-
-app = Sanic(__name__)
-
-@app.route("/")
-async def test(request):
-    async def sample_streaming_fn(response):
-        await response.write('foo,')
-        await response.write('bar')
-
-    return stream(sample_streaming_fn, content_type='text/csv')
-```
-
-This is useful in situations where you want to stream content to the client that originates in an external service, like a database. For example, you can stream database records to the client with the asynchronous cursor that `asyncpg` provides:
-
-```python
-@app.route("/")
-async def index(request):
-    async def stream_from_db(response):
-        conn = await asyncpg.connect(database='test')
-        async with conn.transaction():
-            async for record in conn.cursor('SELECT generate_series(0, 10)'):
-                await response.write(record[0])
-
-    return stream(stream_from_db)
-```
-
-If a client supports HTTP/1.1, Sanic will use [chunked transfer encoding](https://en.wikipedia.org/wiki/Chunked_transfer_encoding); you can explicitly enable or disable it using `chunked` option of the `stream` function.
-
-## File Streaming
-
-Sanic provides `sanic.response.file_stream` function that is useful when you want to send a large file. It returns a `StreamingHTTPResponse` object and will use chunked transfer encoding by default; for this reason Sanic doesn't add `Content-Length` HTTP header in the response. If you want to use this header, you can disable chunked transfer encoding and add it manually:
-
-```python
-from aiofiles import os as async_os
-from sanic.response import file_stream
-
-@app.route("/")
-async def index(request):
-    file_path = "/srv/www/whatever.png"
-
-    file_stat = await async_os.stat(file_path)
-    headers = {"Content-Length": str(file_stat.st_size)}
-
-    return await file_stream(
-        file_path,
-        headers=headers,
-        chunked=False,
-    )
-```

docs/sanic/streaming.rst

@@ -0,0 +1,147 @@
+Streaming
+=========
+
+Request Streaming
+-----------------
+
+Sanic allows you to get request data by stream, as below. When the request ends, `await request.stream.read()` returns `None`. Only post, put and patch decorator have stream argument.
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.views import CompositionView
+    from sanic.views import HTTPMethodView
+    from sanic.views import stream as stream_decorator
+    from sanic.blueprints import Blueprint
+    from sanic.response import stream, text
+
+    bp = Blueprint('blueprint_request_stream')
+    app = Sanic('request_stream')
+
+
+    class SimpleView(HTTPMethodView):
+
+        @stream_decorator
+        async def post(self, request):
+            result = ''
+            while True:
+                body = await request.stream.read()
+                if body is None:
+                    break
+                result += body.decode('utf-8')
+            return text(result)
+
+
+    @app.post('/stream', stream=True)
+    async def handler(request):
+        async def streaming(response):
+            while True:
+                body = await request.stream.read()
+                if body is None:
+                    break
+                body = body.decode('utf-8').replace('1', 'A')
+                await response.write(body)
+        return stream(streaming)
+
+
+    @bp.put('/bp_stream', stream=True)
+    async def bp_put_handler(request):
+        result = ''
+        while True:
+            body = await request.stream.read()
+            if body is None:
+                break
+            result += body.decode('utf-8').replace('1', 'A')
+        return text(result)
+
+
+    # You can also use `bp.add_route()` with stream argument
+    async def bp_post_handler(request):
+        result = ''
+        while True:
+            body = await request.stream.read()
+            if body is None:
+                break
+            result += body.decode('utf-8').replace('1', 'A')
+        return text(result)
+
+    bp.add_route(bp_post_handler, '/bp_stream', methods=['POST'], stream=True)
+
+
+    async def post_handler(request):
+        result = ''
+        while True:
+            body = await request.stream.read()
+            if body is None:
+                break
+            result += body.decode('utf-8')
+        return text(result)
+
+    app.blueprint(bp)
+    app.add_route(SimpleView.as_view(), '/method_view')
+    view = CompositionView()
+    view.add(['POST'], post_handler, stream=True)
+    app.add_route(view, '/composition_view')
+
+
+    if __name__ == '__main__':
+        app.run(host='127.0.0.1', port=8000)
+
+Response Streaming
+------------------
+
+Sanic allows you to stream content to the client with the `stream` method. This method accepts a coroutine callback which is passed a `StreamingHTTPResponse` object that is written to. A simple example is like follows:
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.response import stream
+
+    app = Sanic(__name__)
+
+    @app.route("/")
+    async def test(request):
+        async def sample_streaming_fn(response):
+            await response.write('foo,')
+            await response.write('bar')
+
+        return stream(sample_streaming_fn, content_type='text/csv')
+
+This is useful in situations where you want to stream content to the client that originates in an external service, like a database. For example, you can stream database records to the client with the asynchronous cursor that `asyncpg` provides:
+
+.. code-block:: python
+
+    @app.route("/")
+    async def index(request):
+        async def stream_from_db(response):
+            conn = await asyncpg.connect(database='test')
+            async with conn.transaction():
+                async for record in conn.cursor('SELECT generate_series(0, 10)'):
+                    await response.write(record[0])
+
+        return stream(stream_from_db)
+
+If a client supports HTTP/1.1, Sanic will use `chunked transfer encoding <https://en.wikipedia.org/wiki/Chunked_transfer_encoding>`_; you can explicitly enable or disable it using `chunked` option of the `stream` function.
+
+File Streaming
+--------------
+
+Sanic provides `sanic.response.file_stream` function that is useful when you want to send a large file. It returns a `StreamingHTTPResponse` object and will use chunked transfer encoding by default; for this reason Sanic doesn't add `Content-Length` HTTP header in the response. If you want to use this header, you can disable chunked transfer encoding and add it manually:
+
+.. code-block:: python
+
+    from aiofiles import os as async_os
+    from sanic.response import file_stream
+
+    @app.route("/")
+    async def index(request):
+        file_path = "/srv/www/whatever.png"
+
+        file_stat = await async_os.stat(file_path)
+        headers = {"Content-Length": str(file_stat.st_size)}
+
+        return await file_stream(
+            file_path,
+            headers=headers,
+            chunked=False,
+        )

docs/sanic/testing.md

@@ -1,144 +0,0 @@
-# Testing
-
-Sanic endpoints can be tested locally using the `test_client` object, which
-depends on the additional [`requests-async`](https://github.com/encode/requests-async)
-library, which implements an API that mirrors the `requests` library.
-
-The `test_client` exposes `get`, `post`, `put`, `delete`, `patch`, `head` and `options` methods
-for you to run against your application. A simple example (using pytest) is like follows:
-
-```python
-# Import the Sanic app, usually created with Sanic(__name__)
-from external_server import app
-
-def test_index_returns_200():
-    request, response = app.test_client.get('/')
-    assert response.status == 200
-
-def test_index_put_not_allowed():
-    request, response = app.test_client.put('/')
-    assert response.status == 405
-```
-
-Internally, each time you call one of the `test_client` methods, the Sanic app is run at `127.0.0.1:42101` and 
-your test request is executed against your application, using `requests-async`. 
-
-The `test_client` methods accept the following arguments and keyword arguments:
-
-- `uri` *(default `'/'`)* A string representing the URI to test.
-- `gather_request` *(default `True`)* A boolean which determines whether the
-  original request will be returned by the function. If set to `True`, the
-  return value is a tuple of `(request, response)`, if `False` only the
-  response is returned.
-- `server_kwargs` *(default `{}`) a dict of additional arguments to pass into `app.run` before the test request is run.
-- `debug` *(default `False`)* A boolean which determines whether to run the server in debug mode.
-
-The function further takes the `*request_args` and `**request_kwargs`, which are passed directly to the request.
-
-For example, to supply data to a GET request, you would do the following:
-
-```python
-def test_get_request_includes_data():
-    params = {'key1': 'value1', 'key2': 'value2'}
-    request, response = app.test_client.get('/', params=params)
-    assert request.args.get('key1') == 'value1'
-```
-
-And to supply data to a JSON POST request:
-
-```python
-def test_post_json_request_includes_data():
-    data = {'key1': 'value1', 'key2': 'value2'}
-    request, response = app.test_client.post('/', data=json.dumps(data))
-    assert request.json.get('key1') == 'value1'
-```
-
-
-More information about
-the available arguments to `requests-async` can be found
-[in the documentation for `requests`](https://2.python-requests.org/en/master/).
-
-
-## Using a random port
-
-If you need to test using a free unpriveleged port chosen by the kernel
-instead of the default with `SanicTestClient`, you can do so by specifying
-`port=None`. On most systems the port will be in the range 1024 to 65535.
-
-```python
-# Import the Sanic app, usually created with Sanic(__name__)
-from external_server import app
-from sanic.testing import SanicTestClient
-
-def test_index_returns_200():
-    request, response = SanicTestClient(app, port=None).get('/')
-    assert response.status == 200
-```
-
-
-## pytest-sanic
-
-[pytest-sanic](https://github.com/yunstanford/pytest-sanic) is a pytest plugin, it helps you to test your code asynchronously.
-Just write tests like,
-
-```python
-async def test_sanic_db_find_by_id(app):
-    """
-    Let's assume that, in db we have,
-        {
-            "id": "123",
-            "name": "Kobe Bryant",
-            "team": "Lakers",
-        }
-    """
-    doc = await app.db["players"].find_by_id("123")
-    assert doc.name == "Kobe Bryant"
-    assert doc.team == "Lakers"
-```
-
-[pytest-sanic](https://github.com/yunstanford/pytest-sanic) also provides some useful fixtures, like loop, unused_port,
-test_server, test_client.
-
-```python
-@pytest.yield_fixture
-def app():
-    app = Sanic("test_sanic_app")
-
-    @app.route("/test_get", methods=['GET'])
-    async def test_get(request):
-        return response.json({"GET": True})
-
-    @app.route("/test_post", methods=['POST'])
-    async def test_post(request):
-        return response.json({"POST": True})
-
-    yield app
-
-
-@pytest.fixture
-def test_cli(loop, app, test_client):
-    return loop.run_until_complete(test_client(app, protocol=WebSocketProtocol))
-
-
-#########
-# Tests #
-#########
-
-async def test_fixture_test_client_get(test_cli):
-    """
-    GET request
-    """
-    resp = await test_cli.get('/test_get')
-    assert resp.status == 200
-    resp_json = await resp.json()
-    assert resp_json == {"GET": True}
-
-async def test_fixture_test_client_post(test_cli):
-    """
-    POST request
-    """
-    resp = await test_cli.post('/test_post')
-    assert resp.status == 200
-    resp_json = await resp.json()
-    assert resp_json == {"POST": True}
-```

docs/sanic/testing.rst

@@ -0,0 +1,145 @@
+Testing
+=======
+
+Sanic endpoints can be tested locally using the `test_client` object, which
+depends on an additional package: `httpx <https://www.encode.io/httpx/>`_
+library, which implements an API that mirrors the `requests` library.
+
+The `test_client` exposes `get`, `post`, `put`, `delete`, `patch`, `head` and `options` methods
+for you to run against your application. A simple example (using pytest) is like follows:
+
+.. code-block:: python
+
+    # Import the Sanic app, usually created with Sanic(__name__)
+    from external_server import app
+
+    def test_index_returns_200():
+        request, response = app.test_client.get('/')
+        assert response.status == 200
+
+    def test_index_put_not_allowed():
+        request, response = app.test_client.put('/')
+        assert response.status == 405
+
+Internally, each time you call one of the `test_client` methods, the Sanic app is run at `127.0.0.1:42101` and
+your test request is executed against your application, using `httpx`.
+
+The `test_client` methods accept the following arguments and keyword arguments:
+
+- `uri` *(default `'/'`)* A string representing the URI to test.
+- `gather_request` *(default `True`)* A boolean which determines whether the
+  original request will be returned by the function. If set to `True`, the
+  return value is a tuple of `(request, response)`, if `False` only the
+  response is returned.
+- `server_kwargs` *(default `{}`)* a dict of additional arguments to pass into `app.run` before the test request is run.
+- `debug` *(default `False`)* A boolean which determines whether to run the server in debug mode.
+
+The function further takes the `*request_args` and `**request_kwargs`, which are passed directly to the request.
+
+For example, to supply data to a GET request, you would do the following:
+
+.. code-block:: python
+
+    def test_get_request_includes_data():
+        params = {'key1': 'value1', 'key2': 'value2'}
+        request, response = app.test_client.get('/', params=params)
+        assert request.args.get('key1') == 'value1'
+
+And to supply data to a JSON POST request:
+
+.. code-block:: python
+
+    def test_post_json_request_includes_data():
+        data = {'key1': 'value1', 'key2': 'value2'}
+        request, response = app.test_client.post('/', data=json.dumps(data))
+        assert request.json.get('key1') == 'value1'
+
+More information about
+the available arguments to `httpx` can be found
+[in the documentation for `httpx <https://www.encode.io/httpx/>`_.
+
+
+Using a random port
+-------------------
+
+If you need to test using a free unpriveleged port chosen by the kernel
+instead of the default with `SanicTestClient`, you can do so by specifying
+`port=None`. On most systems the port will be in the range 1024 to 65535.
+
+.. code-block:: python
+
+    # Import the Sanic app, usually created with Sanic(__name__)
+    from external_server import app
+    from sanic.testing import SanicTestClient
+
+    def test_index_returns_200():
+        request, response = SanicTestClient(app, port=None).get('/')
+        assert response.status == 200
+
+pytest-sanic
+------------
+
+`pytest-sanic <https://github.com/yunstanford/pytest-sanic>`_ is a pytest plugin, it helps you to test your code asynchronously.
+Just write tests like,
+
+.. code-block:: python
+
+    async def test_sanic_db_find_by_id(app):
+        """
+        Let's assume that, in db we have,
+            {
+                "id": "123",
+                "name": "Kobe Bryant",
+                "team": "Lakers",
+            }
+        """
+        doc = await app.db["players"].find_by_id("123")
+        assert doc.name == "Kobe Bryant"
+        assert doc.team == "Lakers"
+
+`pytest-sanic <https://github.com/yunstanford/pytest-sanic>`_ also provides some useful fixtures, like loop, unused_port,
+test_server, test_client.
+
+.. code-block:: python
+
+    @pytest.yield_fixture
+    def app():
+        app = Sanic("test_sanic_app")
+
+        @app.route("/test_get", methods=['GET'])
+        async def test_get(request):
+            return response.json({"GET": True})
+
+        @app.route("/test_post", methods=['POST'])
+        async def test_post(request):
+            return response.json({"POST": True})
+
+        yield app
+
+
+    @pytest.fixture
+    def test_cli(loop, app, test_client):
+        return loop.run_until_complete(test_client(app, protocol=WebSocketProtocol))
+
+
+    #########
+    # Tests #
+    #########
+
+    async def test_fixture_test_client_get(test_cli):
+        """
+        GET request
+        """
+        resp = await test_cli.get('/test_get')
+        assert resp.status == 200
+        resp_json = await resp.json()
+        assert resp_json == {"GET": True}
+
+    async def test_fixture_test_client_post(test_cli):
+        """
+        POST request
+        """
+        resp = await test_cli.post('/test_post')
+        assert resp.status == 200
+        resp_json = await resp.json()
+        assert resp_json == {"POST": True}

docs/sanic/versioning.md

@@ -1,50 +0,0 @@
-# Versioning
-
-You can pass the `version` keyword to the route decorators, or to a blueprint initializer. It will result in the `v{version}` url prefix where `{version}` is the version number.
-
-## Per route
-
-You can pass a version number to the routes directly.
-
-```python
-from sanic import response
-
-
-@app.route('/text', version=1)
-def handle_request(request):
-    return response.text('Hello world! Version 1')
-
-@app.route('/text', version=2)
-def handle_request(request):
-    return response.text('Hello world! Version 2')
-
-app.run(port=80)
-```
-
-Then with curl:
-
-```bash
-curl localhost/v1/text
-curl localhost/v2/text
-```
-
-## Global blueprint version
-
-You can also pass a version number to the blueprint, which will apply to all routes.
-
-```python
-from sanic import response
-from sanic.blueprints import Blueprint
-
-bp = Blueprint('test', version=1)
-
-@bp.route('/html')
-def handle_request(request):
-    return response.html('<p>Hello world!</p>')
-```
-
-Then with curl:
-
-```bash
-curl localhost/v1/html
-```

docs/sanic/versioning.rst

@@ -0,0 +1,54 @@
+Versioning
+==========
+
+You can pass the `version` keyword to the route decorators, or to a blueprint initializer. It will result in the `v{version}` url prefix where `{version}` is the version number.
+
+Per route
+---------
+
+You can pass a version number to the routes directly.
+
+.. code-block:: python
+
+    from sanic import response
+
+
+    @app.route('/text', version=1)
+    def handle_request(request):
+        return response.text('Hello world! Version 1')
+
+    @app.route('/text', version=2)
+    def handle_request(request):
+        return response.text('Hello world! Version 2')
+
+    app.run(port=80)
+
+Then with curl:
+
+.. code-block:: bash
+
+    curl localhost/v1/text
+    curl localhost/v2/text
+
+
+Global blueprint version
+------------------------
+
+You can also pass a version number to the blueprint, which will apply to all routes.
+
+.. code-block:: python
+
+    from sanic import response
+    from sanic.blueprints import Blueprint
+
+    bp = Blueprint('test', version=1)
+
+    @bp.route('/html')
+    def handle_request(request):
+        return response.html('<p>Hello world!</p>')
+
+Then with curl:
+
+.. code-block:: bash
+
+    curl localhost/v1/html

docs/sanic/websocket.rst

@@ -1,7 +1,10 @@
 WebSocket
 =========
 
-Sanic provides an easy to user abstraction on top of `websockets`. To setup a WebSocket:
+Sanic provides an easy to use abstraction on top of `websockets`.
+Sanic Supports websocket versions 7 and 8.
+
+To setup a WebSocket:
 
 .. code:: python
 

environment.yml

@@ -13,7 +13,7 @@ dependencies:
   - sphinx==1.8.3
   - sphinx_rtd_theme==0.4.2
   - recommonmark==0.5.0
-  - requests-async==0.5.0
+  - httpx==0.9.3
   - sphinxcontrib-asyncio>=0.2.0
   - docutils==0.14
   - pygments==2.3.1

examples/authorized_sanic.py

@@ -13,8 +13,7 @@ def check_request_for_authorization_status(request):
     return flag
 
 
-def authorized():
-    def decorator(f):
+def authorized(f):
     @wraps(f)
     async def decorated_function(request, *args, **kwargs):
         # run some method that checks the request
@@ -30,11 +29,10 @@ def authorized():
             # the user is not authorized.
             return json({'status': 'not_authorized'}, 403)
     return decorated_function
-    return decorator
 
 
 @app.route("/")
-@authorized()
+@authorized
 async def test(request):
     return json({'status': 'authorized'})
 

examples/run_async_advanced.py

@@ -0,0 +1,38 @@
+from sanic import Sanic
+from sanic import response
+from signal import signal, SIGINT
+import asyncio
+import uvloop
+
+app = Sanic(__name__)
+
+@app.listener('after_server_start')
+async def after_start_test(app, loop):
+    print("Async Server Started!")
+
+@app.route("/")
+async def test(request):
+    return response.json({"answer": "42"})
+
+asyncio.set_event_loop(uvloop.new_event_loop())
+serv_coro = app.create_server(host="0.0.0.0", port=8000, return_asyncio_server=True)
+loop = asyncio.get_event_loop()
+serv_task = asyncio.ensure_future(serv_coro, loop=loop)
+signal(SIGINT, lambda s, f: loop.stop())
+server = loop.run_until_complete(serv_task)
+server.after_start()
+try:
+    loop.run_forever()
+except KeyboardInterrupt as e:
+    loop.stop()
+finally:
+    server.before_stop()
+
+    # Wait for server to close
+    close_task = server.close()
+    loop.run_until_complete(close_task)
+
+    # Complete all tasks on the loop
+    for connection in server.connections:
+        connection.close_if_idle()
+    server.after_stop()

sanic/__init__.py

@@ -1,7 +1,6 @@
+from sanic.__version__ import __version__
 from sanic.app import Sanic
 from sanic.blueprints import Blueprint
 
 
-__version__ = "19.6.0"
-
-__all__ = ["Sanic", "Blueprint"]
+__all__ = ["Sanic", "Blueprint", "__version__"]

sanic/__main__.py

@@ -1,5 +1,6 @@
 from argparse import ArgumentParser
 from importlib import import_module
+from typing import Any, Dict, Optional
 
 from sanic.app import Sanic
 from sanic.log import logger
@@ -35,7 +36,10 @@ if __name__ == "__main__":
                 )
             )
         if args.cert is not None or args.key is not None:
-            ssl = {"cert": args.cert, "key": args.key}
+            ssl = {
+                "cert": args.cert,
+                "key": args.key,
+            }  # type: Optional[Dict[str, Any]]
         else:
             ssl = None
 

sanic/__version__.py

@@ -0,0 +1 @@
+__version__ = "19.12.5"

sanic/app.py

@@ -11,7 +11,7 @@ from inspect import getmodulename, isawaitable, signature, stack
 from socket import socket
 from ssl import Purpose, SSLContext, create_default_context
 from traceback import format_exc
-from typing import Any, Optional, Type, Union
+from typing import Any, Dict, Optional, Type, Union
 from urllib.parse import urlencode, urlunparse
 
 from sanic import reloader_helpers
@@ -24,7 +24,13 @@ from sanic.handlers import ErrorHandler
 from sanic.log import LOGGING_CONFIG_DEFAULTS, error_logger, logger
 from sanic.response import HTTPResponse, StreamingHTTPResponse
 from sanic.router import Router
-from sanic.server import HttpProtocol, Signal, serve, serve_multiple
+from sanic.server import (
+    AsyncioServer,
+    HttpProtocol,
+    Signal,
+    serve,
+    serve_multiple,
+)
 from sanic.static import register as static_register
 from sanic.testing import SanicASGITestClient, SanicTestClient
 from sanic.views import CompositionView
@@ -46,6 +52,13 @@ class Sanic:
 
         # Get name from previous stack frame
         if name is None:
+            warnings.warn(
+                "Sanic(name=None) is deprecated and None value support "
+                "for `name` will be removed in the next release. "
+                "Please use Sanic(name='your_application_name') instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
             frame_records = stack()[1]
             name = getmodulename(frame_records[1])
 
@@ -72,7 +85,8 @@ class Sanic:
         self.is_request_stream = False
         self.websocket_enabled = False
         self.websocket_tasks = set()
-
+        self.named_request_middleware = {}
+        self.named_response_middleware = {}
         # Register alternative method names
         self.go_fast = self.run
 
@@ -138,11 +152,9 @@ class Sanic:
         """
         Register the listener for a given event.
 
-        Args:
-            listener: callable i.e. setup_db(app, loop)
-            event: when to register listener i.e. 'before_server_start'
-
-        Returns: listener
+        :param listener: callable i.e. setup_db(app, loop)
+        :param event: when to register listener i.e. 'before_server_start'
+        :return: listener
         """
 
         return self.listener(event)(listener)
@@ -167,7 +179,7 @@ class Sanic:
         :param stream:
         :param version:
         :param name: user defined route name for url_for
-        :return: decorated function
+        :return: tuple of routes, decorated function
         """
 
         # Fix case where the user did not prefix the URL with a /
@@ -182,6 +194,12 @@ class Sanic:
             strict_slashes = self.strict_slashes
 
         def response(handler):
+            if isinstance(handler, tuple):
+                # if a handler fn is already wrapped in a route, the handler
+                # variable will be a tuple of (existing routes, handler fn)
+                routes, handler = handler
+            else:
+                routes = []
             args = list(signature(handler).parameters.keys())
 
             if not args:
@@ -193,6 +211,7 @@ class Sanic:
             if stream:
                 handler.is_stream = stream
 
+            routes.extend(
                 self.router.add(
                     uri=uri,
                     methods=methods,
@@ -202,7 +221,8 @@ class Sanic:
                     version=version,
                     name=name,
                 )
-            return handler
+            )
+            return routes, handler
 
         return response
 
@@ -441,7 +461,9 @@ class Sanic:
     def websocket(
         self, uri, host=None, strict_slashes=None, subprotocols=None, name=None
     ):
-        """Decorate a function to be registered as a websocket route
+        """
+        Decorate a function to be registered as a websocket route
+
         :param uri: path of the URL
         :param host: Host IP or FQDN details
         :param strict_slashes: If the API endpoint needs to terminate
@@ -449,7 +471,7 @@ class Sanic:
         :param subprotocols: optional list of str with supported subprotocols
         :param name: A unique name assigned to the URL so that it can
                      be used with :func:`url_for`
-        :return: decorated function
+        :return: tuple of routes, decorated function
         """
         self.enable_websocket()
 
@@ -462,6 +484,13 @@ class Sanic:
             strict_slashes = self.strict_slashes
 
         def response(handler):
+            if isinstance(handler, tuple):
+                # if a handler fn is already wrapped in a route, the handler
+                # variable will be a tuple of (existing routes, handler fn)
+                routes, handler = handler
+            else:
+                routes = []
+
             async def websocket_handler(request, *args, **kwargs):
                 request.app = self
                 if not getattr(handler, "__blueprintname__", False):
@@ -502,6 +531,7 @@ class Sanic:
                     self.websocket_tasks.remove(fut)
                 await ws.close()
 
+            routes.extend(
                 self.router.add(
                     uri=uri,
                     handler=websocket_handler,
@@ -510,7 +540,8 @@ class Sanic:
                     strict_slashes=strict_slashes,
                     name=name,
                 )
-            return handler
+            )
+            return routes, handler
 
         return response
 
@@ -531,6 +562,7 @@ class Sanic:
         :param host: Host IP or FQDN details
         :param uri: URL path that will be mapped to the websocket
                     handler
+                    handler
         :param strict_slashes: If the API endpoint needs to terminate
                 with a "/" or not
         :param subprotocols: Subprotocols to be used with websocket
@@ -632,6 +664,22 @@ class Sanic:
                 self.response_middleware.appendleft(middleware)
         return middleware
 
+    def register_named_middleware(
+        self, middleware, route_names, attach_to="request"
+    ):
+        if attach_to == "request":
+            for _rn in route_names:
+                if _rn not in self.named_request_middleware:
+                    self.named_request_middleware[_rn] = deque()
+                if middleware not in self.named_request_middleware[_rn]:
+                    self.named_request_middleware[_rn].append(middleware)
+        if attach_to == "response":
+            for _rn in route_names:
+                if _rn not in self.named_response_middleware:
+                    self.named_response_middleware[_rn] = deque()
+                if middleware not in self.named_response_middleware[_rn]:
+                    self.named_response_middleware[_rn].append(middleware)
+
     # Decorator
     def middleware(self, middleware_or_request):
         """
@@ -768,7 +816,7 @@ class Sanic:
             URLBuildError
         """
         # find the route by the supplied view name
-        kw = {}
+        kw: Dict[str, str] = {}
         # special static files url_for
         if view_name == "static":
             kw.update(name=kwargs.pop("name", "static"))
@@ -782,6 +830,14 @@ class Sanic:
                 "Endpoint with name `{}` was not found".format(view_name)
             )
 
+        # If the route has host defined, split that off
+        # TODO: Retain netloc and path separately in Route objects
+        host = uri.find("/")
+        if host > 0:
+            host, uri = uri[:host], uri[host:]
+        else:
+            host = None
+
         if view_name == "static" or view_name.endswith(".static"):
             filename = kwargs.pop("filename", None)
             # it's static folder
@@ -814,7 +870,7 @@ class Sanic:
 
         netloc = kwargs.pop("_server", None)
         if netloc is None and external:
-            netloc = self.config.get("SERVER_NAME", "")
+            netloc = host or self.config.get("SERVER_NAME", "")
 
         if external:
             if not scheme:
@@ -903,20 +959,23 @@ class Sanic:
         # allocation before assignment below.
         response = None
         cancelled = False
+        name = None
         try:
+            # Fetch handler from router
+            handler, args, kwargs, uri, name = self.router.get(request)
+
             # -------------------------------------------- #
             # Request Middleware
             # -------------------------------------------- #
-            response = await self._run_request_middleware(request)
+            response = await self._run_request_middleware(
+                request, request_name=name
+            )
             # No middleware results
             if not response:
                 # -------------------------------------------- #
                 # Execute Handler
                 # -------------------------------------------- #
 
-                # Fetch handler from router
-                handler, args, kwargs, uri = self.router.get(request)
-
                 request.uri_template = uri
                 if handler is None:
                     raise ServerError(
@@ -980,7 +1039,7 @@ class Sanic:
             if response is not None:
                 try:
                     response = await self._run_response_middleware(
-                        request, response
+                        request, response, request_name=name
                     )
                 except CancelledError:
                     # Response middleware can timeout too, as above.
@@ -1159,7 +1218,7 @@ class Sanic:
         access_log: Optional[bool] = None,
         return_asyncio_server=False,
         asyncio_server_kwargs=None,
-    ) -> None:
+    ) -> Optional[AsyncioServer]:
         """
         Asynchronous version of :func:`run`.
 
@@ -1199,7 +1258,7 @@ class Sanic:
         :param asyncio_server_kwargs: key-value arguments for
                                       asyncio/uvloop create_server method
         :type asyncio_server_kwargs: dict
-        :return: Nothing
+        :return: AsyncioServer if return_asyncio_server is true, else Nothing
         """
 
         if sock is None:
@@ -1252,10 +1311,14 @@ class Sanic:
             if isawaitable(result):
                 await result
 
-    async def _run_request_middleware(self, request):
+    async def _run_request_middleware(self, request, request_name=None):
         # The if improves speed.  I don't know why
-        if self.request_middleware:
-            for middleware in self.request_middleware:
+        named_middleware = self.named_request_middleware.get(
+            request_name, deque()
+        )
+        applicable_middleware = self.request_middleware + named_middleware
+        if applicable_middleware:
+            for middleware in applicable_middleware:
                 response = middleware(request)
                 if isawaitable(response):
                     response = await response
@@ -1263,9 +1326,15 @@ class Sanic:
                     return response
         return None
 
-    async def _run_response_middleware(self, request, response):
-        if self.response_middleware:
-            for middleware in self.response_middleware:
+    async def _run_response_middleware(
+        self, request, response, request_name=None
+    ):
+        named_middleware = self.named_response_middleware.get(
+            request_name, deque()
+        )
+        applicable_middleware = self.response_middleware + named_middleware
+        if applicable_middleware:
+            for middleware in applicable_middleware:
                 _response = middleware(request, response)
                 if isawaitable(_response):
                     _response = await _response
@@ -1307,6 +1376,12 @@ class Sanic:
                 "stop_event will be removed from future versions.",
                 DeprecationWarning,
             )
+        if self.config.PROXIES_COUNT and self.config.PROXIES_COUNT < 0:
+            raise ValueError(
+                "PROXIES_COUNT cannot be negative. "
+                "https://sanic.readthedocs.io/en/latest/sanic/config.html"
+                "#proxy-configuration"
+            )
 
         self.error_handler.debug = debug
         self.debug = debug
@@ -1399,3 +1474,5 @@ class Sanic:
         self.asgi = True
         asgi_app = await ASGIApp.create(self, scope, receive, send)
         await asgi_app()
+
+    _asgi_single_callable = True  # We conform to ASGI 3.0 single-callable

sanic/asgi.py

@@ -1,13 +1,23 @@
 import asyncio
 import warnings
 
-from http.cookies import SimpleCookie
 from inspect import isawaitable
-from typing import Any, Awaitable, Callable, MutableMapping, Union
+from typing import (
+    Any,
+    Awaitable,
+    Callable,
+    Dict,
+    List,
+    MutableMapping,
+    Optional,
+    Tuple,
+    Union,
+)
 from urllib.parse import quote
 
-from multidict import CIMultiDict
+import sanic.app  # noqa
 
+from sanic.compat import Header
 from sanic.exceptions import InvalidUsage, ServerError
 from sanic.log import logger
 from sanic.request import Request
@@ -56,6 +66,8 @@ class MockProtocol:
 
 
 class MockTransport:
+    _protocol: Optional[MockProtocol]
+
     def __init__(
         self, scope: ASGIScope, receive: ASGIReceive, send: ASGISend
     ) -> None:
@@ -70,11 +82,12 @@ class MockTransport:
             self._protocol = MockProtocol(self, self.loop)
         return self._protocol
 
-    def get_extra_info(self, info: str) -> Union[str, bool]:
+    def get_extra_info(self, info: str) -> Union[str, bool, None]:
         if info == "peername":
             return self.scope.get("server")
         elif info == "sslcontext":
             return self.scope.get("scheme") in ["https", "wss"]
+        return None
 
     def get_websocket_connection(self) -> WebSocketConnection:
         try:
@@ -88,7 +101,7 @@ class MockTransport:
         self._websocket_connection = WebSocketConnection(send, receive)
         return self._websocket_connection
 
-    def add_task(self) -> None:  # noqa
+    def add_task(self) -> None:
         raise NotImplementedError
 
     async def send(self, data) -> None:
@@ -119,27 +132,20 @@ class Lifespan:
                 "the ASGI server is stopped."
             )
 
-    # async def pre_startup(self) -> None:
-    #     for handler in self.asgi_app.sanic_app.listeners[
-    #         "before_server_start"
-    #     ]:
-    #         response = handler(
-    #             self.asgi_app.sanic_app, self.asgi_app.sanic_app.loop
-    #         )
-    #         if isawaitable(response):
-    #             await response
-
     async def startup(self) -> None:
-        for handler in self.asgi_app.sanic_app.listeners[
-            "before_server_start"
-        ]:
-            response = handler(
-                self.asgi_app.sanic_app, self.asgi_app.sanic_app.loop
-            )
-            if isawaitable(response):
-                await response
+        """
+        Gather the listeners to fire on server start.
+        Because we are using a third-party server and not Sanic server, we do
+        not have access to fire anything BEFORE the server starts.
+        Therefore, we fire before_server_start and after_server_start
+        in sequence since the ASGI lifespan protocol only supports a single
+        startup event.
+        """
+        listeners = self.asgi_app.sanic_app.listeners.get(
+            "before_server_start", []
+        ) + self.asgi_app.sanic_app.listeners.get("after_server_start", [])
 
-        for handler in self.asgi_app.sanic_app.listeners["after_server_start"]:
+        for handler in listeners:
             response = handler(
                 self.asgi_app.sanic_app, self.asgi_app.sanic_app.loop
             )
@@ -147,14 +153,19 @@ class Lifespan:
                 await response
 
     async def shutdown(self) -> None:
-        for handler in self.asgi_app.sanic_app.listeners["before_server_stop"]:
-            response = handler(
-                self.asgi_app.sanic_app, self.asgi_app.sanic_app.loop
-            )
-            if isawaitable(response):
-                await response
+        """
+        Gather the listeners to fire on server stop.
+        Because we are using a third-party server and not Sanic server, we do
+        not have access to fire anything AFTER the server stops.
+        Therefore, we fire before_server_stop and after_server_stop
+        in sequence since the ASGI lifespan protocol only supports a single
+        shutdown event.
+        """
+        listeners = self.asgi_app.sanic_app.listeners.get(
+            "before_server_stop", []
+        ) + self.asgi_app.sanic_app.listeners.get("after_server_stop", [])
 
-        for handler in self.asgi_app.sanic_app.listeners["after_server_stop"]:
+        for handler in listeners:
             response = handler(
                 self.asgi_app.sanic_app, self.asgi_app.sanic_app.loop
             )
@@ -176,6 +187,13 @@ class Lifespan:
 
 
 class ASGIApp:
+    sanic_app: "sanic.app.Sanic"
+    request: Request
+    transport: MockTransport
+    do_stream: bool
+    lifespan: Lifespan
+    ws: Optional[WebSocketConnection]
+
     def __init__(self) -> None:
         self.ws = None
 
@@ -186,10 +204,10 @@ class ASGIApp:
         instance = cls()
         instance.sanic_app = sanic_app
         instance.transport = MockTransport(scope, receive, send)
-        instance.transport.add_task = sanic_app.loop.create_task
         instance.transport.loop = sanic_app.loop
+        setattr(instance.transport, "add_task", sanic_app.loop.create_task)
 
-        headers = CIMultiDict(
+        headers = Header(
             [
                 (key.decode("latin-1"), value.decode("latin-1"))
                 for key, value in scope.get("headers", [])
@@ -203,8 +221,13 @@ class ASGIApp:
         if scope["type"] == "lifespan":
             await instance.lifespan(scope, receive, send)
         else:
-            url_bytes = scope.get("root_path", "") + quote(scope["path"])
-            url_bytes = url_bytes.encode("latin-1")
+            path = (
+                scope["path"][1:]
+                if scope["path"].startswith("/")
+                else scope["path"]
+            )
+            url = "/".join([scope.get("root_path", ""), quote(path)])
+            url_bytes = url.encode("latin-1")
             url_bytes += b"?" + scope["query_string"]
 
             if scope["type"] == "http":
@@ -223,7 +246,8 @@ class ASGIApp:
                 # TODO:
                 # - close connection
 
-            instance.request = Request(
+            request_class = sanic_app.request_class or Request
+            instance.request = request_class(
                 url_bytes,
                 headers,
                 version,
@@ -285,15 +309,30 @@ class ASGIApp:
         callback = None if self.ws else self.stream_callback
         await handler(self.request, None, callback)
 
+    _asgi_single_callable = True  # We conform to ASGI 3.0 single-callable
+
     async def stream_callback(self, response: HTTPResponse) -> None:
         """
         Write the response.
         """
-
+        headers: List[Tuple[bytes, bytes]] = []
+        cookies: Dict[str, str] = {}
+        content_length: List[str] = []
         try:
-            headers = [
+            content_length = response.headers.popall("content-length", [])
+            cookies = {
+                v.key: v
+                for _, v in list(
+                    filter(
+                        lambda item: item[0].lower() == "set-cookie",
+                        response.headers.items(),
+                    )
+                )
+            }
+            headers += [
                 (str(name).encode("latin-1"), str(value).encode("latin-1"))
                 for name, value in response.headers.items()
+                if name.lower() not in ["set-cookie"]
             ]
         except AttributeError:
             logger.error(
@@ -312,19 +351,42 @@ class ASGIApp:
                 if name not in (b"Set-Cookie",)
             ]
 
-        if "content-length" not in response.headers and not isinstance(
-            response, StreamingHTTPResponse
-        ):
+        response.asgi = True
+        is_streaming = isinstance(response, StreamingHTTPResponse)
+        if is_streaming and getattr(response, "chunked", False):
+            # disable sanic chunking, this is done at the ASGI-server level
+            setattr(response, "chunked", False)
+            # content-length header is removed to signal to the ASGI-server
+            # to use automatic-chunking if it supports it
+        elif len(content_length) > 0:
             headers += [
-                (b"content-length", str(len(response.body)).encode("latin-1"))
+                (b"content-length", str(content_length[0]).encode("latin-1"))
+            ]
+        elif not is_streaming:
+            headers += [
+                (
+                    b"content-length",
+                    str(len(getattr(response, "body", b""))).encode("latin-1"),
+                )
+            ]
+
+        if "content-type" not in response.headers:
+            headers += [
+                (b"content-type", str(response.content_type).encode("latin-1"))
             ]
 
         if response.cookies:
-            cookies = SimpleCookie()
-            cookies.load(response.cookies)
+            cookies.update(
+                {
+                    v.key: v
+                    for _, v in response.cookies.items()
+                    if v.key not in cookies.keys()
+                }
+            )
+
         headers += [
             (b"set-cookie", cookie.encode("utf-8"))
-                for name, cookie in response.cookies.items()
+            for k, cookie in cookies.items()
         ]
 
         await self.transport.send(

sanic/blueprint_group.py

@@ -1,10 +1,11 @@
-from collections import MutableSequence
+from collections.abc import MutableSequence
 
 
 class BlueprintGroup(MutableSequence):
     """
     This class provides a mechanism to implement a Blueprint Group
-    using the `Blueprint.group` method. To avoid having to re-write
+    using the :meth:`~sanic.blueprints.Blueprint.group` method in
+    :class:`~sanic.blueprints.Blueprint`. To avoid having to re-write
     some of the existing implementation, this class provides a custom
     iterator implementation that will let you use the object of this
     class as a list/tuple inside the existing implementation.
@@ -55,7 +56,7 @@ class BlueprintGroup(MutableSequence):
         """
         return self._blueprints[item]
 
-    def __setitem__(self, index: int, item: object) -> None:
+    def __setitem__(self, index, item) -> None:
         """
         Abstract method implemented to turn the `BlueprintGroup` class
         into a list like object to support all the existing behavior.
@@ -68,7 +69,7 @@ class BlueprintGroup(MutableSequence):
         """
         self._blueprints[index] = item
 
-    def __delitem__(self, index: int) -> None:
+    def __delitem__(self, index) -> None:
         """
         Abstract method implemented to turn the `BlueprintGroup` class
         into a list like object to support all the existing behavior.

sanic/blueprints.py

@@ -104,6 +104,8 @@ class Blueprint:
 
         url_prefix = options.get("url_prefix", self.url_prefix)
 
+        routes = []
+
         # Routes
         for future in self.routes:
             # attach the blueprint name to the handler so that it can be
@@ -114,7 +116,7 @@ class Blueprint:
 
             version = future.version or self.version
 
-            app.route(
+            _routes, _ = app.route(
                 uri=uri[1:] if uri.startswith("//") else uri,
                 methods=future.methods,
                 host=future.host or self.host,
@@ -123,6 +125,8 @@ class Blueprint:
                 version=version,
                 name=future.name,
             )(future.handler)
+            if _routes:
+                routes += _routes
 
         for future in self.websocket_routes:
             # attach the blueprint name to the handler so that it can be
@@ -130,21 +134,27 @@ class Blueprint:
             future.handler.__blueprintname__ = self.name
             # Prepend the blueprint URI prefix if available
             uri = url_prefix + future.uri if url_prefix else future.uri
-            app.websocket(
+            _routes, _ = app.websocket(
                 uri=uri,
                 host=future.host or self.host,
                 strict_slashes=future.strict_slashes,
                 name=future.name,
             )(future.handler)
+            if _routes:
+                routes += _routes
 
+        route_names = [route.name for route in routes]
         # Middleware
         for future in self.middlewares:
             if future.args or future.kwargs:
-                app.register_middleware(
-                    future.middleware, *future.args, **future.kwargs
+                app.register_named_middleware(
+                    future.middleware,
+                    route_names,
+                    *future.args,
+                    **future.kwargs
                 )
             else:
-                app.register_middleware(future.middleware)
+                app.register_named_middleware(future.middleware, route_names)
 
         # Exceptions
         for future in self.exceptions:

sanic/compat.py

@@ -0,0 +1,6 @@
+from multidict import CIMultiDict  # type: ignore
+
+
+class Header(CIMultiDict):
+    def get_all(self, key):
+        return self.getall(key, default=[])

sanic/config.py

@@ -26,9 +26,10 @@ DEFAULT_CONFIG = {
     "WEBSOCKET_WRITE_LIMIT": 2 ** 16,
     "GRACEFUL_SHUTDOWN_TIMEOUT": 15.0,  # 15 sec
     "ACCESS_LOG": True,
-    "PROXIES_COUNT": -1,
+    "FORWARDED_SECRET": None,
+    "REAL_IP_HEADER": None,
+    "PROXIES_COUNT": None,
     "FORWARDED_FOR_HEADER": "X-Forwarded-For",
-    "REAL_IP_HEADER": "X-Real-IP",
 }
 
 
@@ -80,7 +81,7 @@ class Config(dict):
         module.__file__ = filename
         try:
             with open(filename) as config_file:
-                exec(
+                exec(  # nosec
                     compile(config_file.read(), filename, "exec"),
                     module.__dict__,
                 )

sanic/cookies.py

@@ -130,6 +130,10 @@ class Cookie(dict):
         :return: Cookie encoded in a codec of choosing.
         :except: UnicodeEncodeError
         """
+        return str(self).encode(encoding)
+
+    def __str__(self):
+        """Format as a Set-Cookie header value."""
         output = ["%s=%s" % (self.key, _quote(self.value))]
         for key, value in self.items():
             if key == "max-age":
@@ -147,4 +151,4 @@ class Cookie(dict):
             else:
                 output.append("%s=%s" % (self._keys[key], value))
 
-        return "; ".join(output).encode(encoding)
+        return "; ".join(output)

sanic/headers.py

@@ -0,0 +1,182 @@
+import re
+
+from typing import Any, Dict, Iterable, List, Optional, Tuple, Union
+from urllib.parse import unquote
+
+
+HeaderIterable = Iterable[Tuple[str, Any]]  # Values convertible to str
+Options = Dict[str, Union[int, str]]  # key=value fields in various headers
+OptionsIterable = Iterable[Tuple[str, str]]  # May contain duplicate keys
+
+_token, _quoted = r"([\w!#$%&'*+\-.^_`|~]+)", r'"([^"]*)"'
+_param = re.compile(fr";\s*{_token}=(?:{_token}|{_quoted})", re.ASCII)
+_firefox_quote_escape = re.compile(r'\\"(?!; |\s*$)')
+_ipv6 = "(?:[0-9A-Fa-f]{0,4}:){2,7}[0-9A-Fa-f]{0,4}"
+_ipv6_re = re.compile(_ipv6)
+_host_re = re.compile(
+    r"((?:\[" + _ipv6 + r"\])|[a-zA-Z0-9.\-]{1,253})(?::(\d{1,5}))?"
+)
+
+# RFC's quoted-pair escapes are mostly ignored by browsers. Chrome, Firefox and
+# curl all have different escaping, that we try to handle as well as possible,
+# even though no client espaces in a way that would allow perfect handling.
+
+# For more information, consult ../tests/test_requests.py
+
+
+def parse_content_header(value: str) -> Tuple[str, Options]:
+    """Parse content-type and content-disposition header values.
+
+    E.g. 'form-data; name=upload; filename=\"file.txt\"' to
+    ('form-data', {'name': 'upload', 'filename': 'file.txt'})
+
+    Mostly identical to cgi.parse_header and werkzeug.parse_options_header
+    but runs faster and handles special characters better. Unescapes quotes.
+    """
+    value = _firefox_quote_escape.sub("%22", value)
+    pos = value.find(";")
+    if pos == -1:
+        options: Dict[str, Union[int, str]] = {}
+    else:
+        options = {
+            m.group(1).lower(): m.group(2) or m.group(3).replace("%22", '"')
+            for m in _param.finditer(value[pos:])
+        }
+        value = value[:pos]
+    return value.strip().lower(), options
+
+
+# https://tools.ietf.org/html/rfc7230#section-3.2.6 and
+# https://tools.ietf.org/html/rfc7239#section-4
+# This regex is for *reversed* strings because that works much faster for
+# right-to-left matching than the other way around. Be wary that all things are
+# a bit backwards! _rparam matches forwarded pairs alike ";key=value"
+_rparam = re.compile(f"(?:{_token}|{_quoted})={_token}\\s*($|[;,])", re.ASCII)
+
+
+def parse_forwarded(headers, config) -> Optional[Options]:
+    """Parse RFC 7239 Forwarded headers.
+    The value of `by` or `secret` must match `config.FORWARDED_SECRET`
+    :return: dict with keys and values, or None if nothing matched
+    """
+    header = headers.getall("forwarded", None)
+    secret = config.FORWARDED_SECRET
+    if header is None or not secret:
+        return None
+    header = ",".join(header)  # Join multiple header lines
+    if secret not in header:
+        return None
+    # Loop over <separator><key>=<value> elements from right to left
+    sep = pos = None
+    options: List[Tuple[str, str]] = []
+    found = False
+    for m in _rparam.finditer(header[::-1]):
+        # Start of new element? (on parser skips and non-semicolon right sep)
+        if m.start() != pos or sep != ";":
+            # Was the previous element (from right) what we wanted?
+            if found:
+                break
+            # Clear values and parse as new element
+            del options[:]
+        pos = m.end()
+        val_token, val_quoted, key, sep = m.groups()
+        key = key.lower()[::-1]
+        val = (val_token or val_quoted.replace('"\\', '"'))[::-1]
+        options.append((key, val))
+        if key in ("secret", "by") and val == secret:
+            found = True
+        # Check if we would return on next round, to avoid useless parse
+        if found and sep != ";":
+            break
+    # If secret was found, return the matching options in left-to-right order
+    return fwd_normalize(reversed(options)) if found else None
+
+
+def parse_xforwarded(headers, config) -> Optional[Options]:
+    """Parse traditional proxy headers."""
+    real_ip_header = config.REAL_IP_HEADER
+    proxies_count = config.PROXIES_COUNT
+    addr = real_ip_header and headers.get(real_ip_header)
+    if not addr and proxies_count:
+        assert proxies_count > 0
+        try:
+            # Combine, split and filter multiple headers' entries
+            forwarded_for = headers.getall(config.FORWARDED_FOR_HEADER)
+            proxies = [
+                p
+                for p in (
+                    p.strip() for h in forwarded_for for p in h.split(",")
+                )
+                if p
+            ]
+            addr = proxies[-proxies_count]
+        except (KeyError, IndexError):
+            pass
+    # No processing of other headers if no address is found
+    if not addr:
+        return None
+
+    def options():
+        yield "for", addr
+        for key, header in (
+            ("proto", "x-scheme"),
+            ("proto", "x-forwarded-proto"),  # Overrides X-Scheme if present
+            ("host", "x-forwarded-host"),
+            ("port", "x-forwarded-port"),
+            ("path", "x-forwarded-path"),
+        ):
+            yield key, headers.get(header)
+
+    return fwd_normalize(options())
+
+
+def fwd_normalize(fwd: OptionsIterable) -> Options:
+    """Normalize and convert values extracted from forwarded headers."""
+    ret: Dict[str, Union[int, str]] = {}
+    for key, val in fwd:
+        if val is not None:
+            try:
+                if key in ("by", "for"):
+                    ret[key] = fwd_normalize_address(val)
+                elif key in ("host", "proto"):
+                    ret[key] = val.lower()
+                elif key == "port":
+                    ret[key] = int(val)
+                elif key == "path":
+                    ret[key] = unquote(val)
+                else:
+                    ret[key] = val
+            except ValueError:
+                pass
+    return ret
+
+
+def fwd_normalize_address(addr: str) -> str:
+    """Normalize address fields of proxy headers."""
+    if addr == "unknown":
+        raise ValueError()  # omit unknown value identifiers
+    if addr.startswith("_"):
+        return addr  # do not lower-case obfuscated strings
+    if _ipv6_re.fullmatch(addr):
+        addr = f"[{addr}]"  # bracket IPv6
+    return addr.lower()
+
+
+def parse_host(host: str) -> Tuple[Optional[str], Optional[int]]:
+    """Split host:port into hostname and port.
+    :return: None in place of missing elements
+    """
+    m = _host_re.fullmatch(host)
+    if not m:
+        return None, None
+    host, port = m.groups()
+    return host.lower(), int(port) if port is not None else None
+
+
+def format_http1(headers: HeaderIterable) -> bytes:
+    """Convert a headers iterable into HTTP/1 header format.
+
+    - Outputs UTF-8 bytes where each header line ends with \\r\\n.
+    - Values are converted into strings if necessary.
+    """
+    return "".join(f"{name}: {val}\r\n" for name, val in headers).encode()

sanic/helpers.py

@@ -8,6 +8,7 @@ STATUS_CODES = {
     100: b"Continue",
     101: b"Switching Protocols",
     102: b"Processing",
+    103: b"Early Hints",
     200: b"OK",
     201: b"Created",
     202: b"Accepted",

sanic/request.py

@@ -1,32 +1,28 @@
 import asyncio
 import email.utils
-import json
-import sys
 import warnings
 
-from cgi import parse_header
 from collections import defaultdict, namedtuple
 from http.cookies import SimpleCookie
+from types import SimpleNamespace
 from urllib.parse import parse_qs, parse_qsl, unquote, urlunparse
 
-from httptools import parse_url
+from httptools import parse_url  # type: ignore
 
 from sanic.exceptions import InvalidUsage
+from sanic.headers import (
+    parse_content_header,
+    parse_forwarded,
+    parse_host,
+    parse_xforwarded,
+)
 from sanic.log import error_logger, logger
 
 
 try:
-    from ujson import loads as json_loads
+    from ujson import loads as json_loads  # type: ignore
 except ImportError:
-    if sys.version_info[:2] == (3, 5):
-
-        def json_loads(data):
-            # on Python 3.5 json.loads only supports str not bytes
-            return json.loads(data.decode())
-
-    else:
-        json_loads = json.loads
-
+    from json import loads as json_loads  # type: ignore
 
 DEFAULT_HTTP_CONTENT_TYPE = "application/octet-stream"
 EXPECT_HEADER = "EXPECT"
@@ -66,8 +62,12 @@ class StreamBuffer:
     def is_full(self):
         return self._queue.full()
 
+    @property
+    def buffer_size(self):
+        return self._queue.maxsize
 
-class Request(dict):
+
+class Request:
     """Properties of an HTTP request such as URL, headers, etc."""
 
     __slots__ = (
@@ -80,6 +80,7 @@ class Request(dict):
         "_socket",
         "app",
         "body",
+        "ctx",
         "endpoint",
         "headers",
         "method",
@@ -88,6 +89,7 @@ class Request(dict):
         "parsed_files",
         "parsed_form",
         "parsed_json",
+        "parsed_forwarded",
         "raw_url",
         "stream",
         "transport",
@@ -108,6 +110,8 @@ class Request(dict):
 
         # Init but do not inhale
         self.body_init()
+        self.ctx = SimpleNamespace()
+        self.parsed_forwarded = None
         self.parsed_json = None
         self.parsed_form = None
         self.parsed_files = None
@@ -123,10 +127,30 @@ class Request(dict):
             self.__class__.__name__, self.method, self.path
         )
 
-    def __bool__(self):
-        if self.transport:
-            return True
-        return False
+    def get(self, key, default=None):
+        """.. deprecated:: 19.9
+        Custom context is now stored in `request.custom_context.yourkey`"""
+        return self.ctx.__dict__.get(key, default)
+
+    def __contains__(self, key):
+        """.. deprecated:: 19.9
+        Custom context is now stored in `request.custom_context.yourkey`"""
+        return key in self.ctx.__dict__
+
+    def __getitem__(self, key):
+        """.. deprecated:: 19.9
+        Custom context is now stored in `request.custom_context.yourkey`"""
+        return self.ctx.__dict__[key]
+
+    def __delitem__(self, key):
+        """.. deprecated:: 19.9
+        Custom context is now stored in `request.custom_context.yourkey`"""
+        del self.ctx.__dict__[key]
+
+    def __setitem__(self, key, value):
+        """.. deprecated:: 19.9
+        Custom context is now stored in `request.custom_context.yourkey`"""
+        setattr(self.ctx, key, value)
 
     def body_init(self):
         self.body = []
@@ -178,7 +202,7 @@ class Request(dict):
             content_type = self.headers.get(
                 "Content-Type", DEFAULT_HTTP_CONTENT_TYPE
             )
-            content_type, parameters = parse_header(content_type)
+            content_type, parameters = parse_content_header(content_type)
             try:
                 if content_type == "application/x-www-form-urlencoded":
                     self.parsed_form = RequestParameters(
@@ -213,27 +237,35 @@ class Request(dict):
         Method to parse `query_string` using `urllib.parse.parse_qs`.
         This methods is used by `args` property.
         Can be used directly if you need to change default parameters.
-        :param keep_blank_values: flag indicating whether blank values in
+
+        :param keep_blank_values:
+            flag indicating whether blank values in
             percent-encoded queries should be treated as blank strings.
             A true value indicates that blanks should be retained as blank
             strings.  The default false value indicates that blank values
             are to be ignored and treated as if they were  not included.
         :type keep_blank_values: bool
-        :param strict_parsing: flag indicating what to do with parsing errors.
+        :param strict_parsing:
+            flag indicating what to do with parsing errors.
             If false (the default), errors are silently ignored. If true,
             errors raise a ValueError exception.
         :type strict_parsing: bool
-        :param encoding: specify how to decode percent-encoded sequences
+        :param encoding:
+            specify how to decode percent-encoded sequences
             into Unicode characters, as accepted by the bytes.decode() method.
         :type encoding: str
-        :param errors: specify how to decode percent-encoded sequences
+        :param errors:
+            specify how to decode percent-encoded sequences
             into Unicode characters, as accepted by the bytes.decode() method.
         :type errors: str
         :return: RequestParameters
         """
-        if not self.parsed_args[
-            (keep_blank_values, strict_parsing, encoding, errors)
-        ]:
+        if (
+            keep_blank_values,
+            strict_parsing,
+            encoding,
+            errors,
+        ) not in self.parsed_args:
             if self.query_string:
                 self.parsed_args[
                     (keep_blank_values, strict_parsing, encoding, errors)
@@ -276,27 +308,35 @@ class Request(dict):
         Method to parse `query_string` using `urllib.parse.parse_qsl`.
         This methods is used by `query_args` property.
         Can be used directly if you need to change default parameters.
-        :param keep_blank_values: flag indicating whether blank values in
+
+        :param keep_blank_values:
+            flag indicating whether blank values in
             percent-encoded queries should be treated as blank strings.
             A true value indicates that blanks should be retained as blank
             strings.  The default false value indicates that blank values
             are to be ignored and treated as if they were  not included.
         :type keep_blank_values: bool
-        :param strict_parsing: flag indicating what to do with parsing errors.
+        :param strict_parsing:
+            flag indicating what to do with parsing errors.
             If false (the default), errors are silently ignored. If true,
             errors raise a ValueError exception.
         :type strict_parsing: bool
-        :param encoding: specify how to decode percent-encoded sequences
+        :param encoding:
+            specify how to decode percent-encoded sequences
             into Unicode characters, as accepted by the bytes.decode() method.
         :type encoding: str
-        :param errors: specify how to decode percent-encoded sequences
+        :param errors:
+            specify how to decode percent-encoded sequences
             into Unicode characters, as accepted by the bytes.decode() method.
         :type errors: str
         :return: list
         """
-        if not self.parsed_not_grouped_args[
-            (keep_blank_values, strict_parsing, encoding, errors)
-        ]:
+        if (
+            keep_blank_values,
+            strict_parsing,
+            encoding,
+            errors,
+        ) not in self.parsed_not_grouped_args:
             if self.query_string:
                 self.parsed_not_grouped_args[
                     (keep_blank_values, strict_parsing, encoding, errors)
@@ -329,12 +369,18 @@ class Request(dict):
 
     @property
     def ip(self):
+        """
+        :return: peer ip of the socket
+        """
         if not hasattr(self, "_socket"):
             self._get_address()
         return self._ip
 
     @property
     def port(self):
+        """
+        :return: peer port of the socket
+        """
         if not hasattr(self, "_socket"):
             self._get_address()
         return self._port
@@ -353,46 +399,78 @@ class Request(dict):
         self._ip = self._socket[0]
         self._port = self._socket[1]
 
+    @property
+    def server_name(self):
+        """
+        Attempt to get the server's external hostname in this order:
+        `config.SERVER_NAME`, proxied or direct Host headers
+        :func:`Request.host`
+
+        :return: the server name without port number
+        :rtype: str
+        """
+        server_name = self.app.config.get("SERVER_NAME")
+        if server_name:
+            host = server_name.split("//", 1)[-1].split("/", 1)[0]
+            return parse_host(host)[0]
+        return parse_host(self.host)[0]
+
+    @property
+    def forwarded(self):
+        if self.parsed_forwarded is None:
+            self.parsed_forwarded = (
+                parse_forwarded(self.headers, self.app.config)
+                or parse_xforwarded(self.headers, self.app.config)
+                or {}
+            )
+        return self.parsed_forwarded
+
+    @property
+    def server_port(self):
+        """
+        Attempt to get the server's external port number in this order:
+        `config.SERVER_NAME`, proxied or direct Host headers
+        :func:`Request.host`,
+        actual port used by the transport layer socket.
+        :return: server port
+        :rtype: int
+        """
+        if self.forwarded:
+            return self.forwarded.get("port") or (
+                80 if self.scheme in ("http", "ws") else 443
+            )
+        return (
+            parse_host(self.host)[1]
+            or self.transport.get_extra_info("sockname")[1]
+        )
+
     @property
     def remote_addr(self):
-        """Attempt to return the original client ip based on X-Forwarded-For
-        or X-Real-IP. If HTTP headers are unavailable or untrusted, returns
-        an empty string.
+        """Attempt to return the original client ip based on `forwarded`,
+        `x-forwarded-for` or `x-real-ip`. If HTTP headers are unavailable or
+        untrusted, returns an empty string.
 
         :return: original client ip.
         """
         if not hasattr(self, "_remote_addr"):
-            if self.app.config.PROXIES_COUNT == 0:
-                self._remote_addr = ""
-            elif self.app.config.REAL_IP_HEADER and self.headers.get(
-                self.app.config.REAL_IP_HEADER
-            ):
-                self._remote_addr = self.headers[
-                    self.app.config.REAL_IP_HEADER
-                ]
-            elif self.app.config.FORWARDED_FOR_HEADER:
-                forwarded_for = self.headers.get(
-                    self.app.config.FORWARDED_FOR_HEADER, ""
-                ).split(",")
-                remote_addrs = [
-                    addr
-                    for addr in [addr.strip() for addr in forwarded_for]
-                    if addr
-                ]
-                if self.app.config.PROXIES_COUNT == -1:
-                    self._remote_addr = remote_addrs[0]
-                elif len(remote_addrs) >= self.app.config.PROXIES_COUNT:
-                    self._remote_addr = remote_addrs[
-                        -self.app.config.PROXIES_COUNT
-                    ]
-                else:
-                    self._remote_addr = ""
-            else:
-                self._remote_addr = ""
+            self._remote_addr = self.forwarded.get("for", "")
         return self._remote_addr
 
     @property
     def scheme(self):
+        """
+        Attempt to get the request scheme.
+        Seeking the value in this order:
+        `forwarded` header, `x-forwarded-proto` header,
+        `x-scheme` header, the sanic app itself.
+
+        :return: http|https|ws|wss or arbitrary value given by the headers.
+        :rtype: str
+        """
+        forwarded_proto = self.forwarded.get("proto")
+        if forwarded_proto:
+            return forwarded_proto
+
         if (
             self.app.websocket_enabled
             and self.headers.get("upgrade") == "websocket"
@@ -408,9 +486,11 @@ class Request(dict):
 
     @property
     def host(self):
-        # it appears that httptools doesn't return the host
-        # so pull it from the headers
-        return self.headers.get("Host", "")
+        """
+        :return: proxied or direct Host header. Hostname and port number may be
+          separated by sanic.headers.parse_host(request.host).
+        """
+        return self.forwarded.get("host", self.headers.get("Host", ""))
 
     @property
     def content_type(self):
@@ -438,6 +518,38 @@ class Request(dict):
             (self.scheme, self.host, self.path, None, self.query_string, None)
         )
 
+    def url_for(self, view_name, **kwargs):
+        """
+        Same as :func:`sanic.Sanic.url_for`, but automatically determine
+        `scheme` and `netloc` base on the request. Since this method is aiming
+        to generate correct schema & netloc, `_external` is implied.
+
+        :param kwargs: takes same parameters as in :func:`sanic.Sanic.url_for`
+        :return: an absolute url to the given view
+        :rtype: str
+        """
+        # Full URL SERVER_NAME can only be handled in app.url_for
+        try:
+            if "//" in self.app.config.SERVER_NAME:
+                return self.app.url_for(view_name, _external=True, **kwargs)
+        except AttributeError:
+            pass
+
+        scheme = self.scheme
+        host = self.server_name
+        port = self.server_port
+
+        if (scheme.lower() in ("http", "ws") and port == 80) or (
+            scheme.lower() in ("https", "wss") and port == 443
+        ):
+            netloc = host
+        else:
+            netloc = "{}:{}".format(host, port)
+
+        return self.app.url_for(
+            view_name, _external=True, _scheme=scheme, _server=netloc, **kwargs
+        )
+
 
 File = namedtuple("File", ["type", "body", "name"])
 
@@ -470,7 +582,7 @@ def parse_multipart_form(body, boundary):
 
             colon_index = form_line.index(":")
             form_header_field = form_line[0:colon_index].lower()
-            form_header_value, form_parameters = parse_header(
+            form_header_value, form_parameters = parse_content_header(
                 form_line[colon_index + 2 :]
             )
 

sanic/response.py

@@ -3,16 +3,17 @@ from mimetypes import guess_type
 from os import path
 from urllib.parse import quote_plus
 
-from aiofiles import open as open_async
-from multidict import CIMultiDict
+from aiofiles import open as open_async  # type: ignore
 
+from sanic.compat import Header
 from sanic.cookies import CookieJar
+from sanic.headers import format_http1
 from sanic.helpers import STATUS_CODES, has_message_body, remove_entity_headers
 
 
 try:
     from ujson import dumps as json_dumps
-except BaseException:
+except ImportError:
     from json import dumps
 
     # This is done in order to ensure that the JSON response is
@@ -21,6 +22,9 @@ except BaseException:
 
 
 class BaseHTTPResponse:
+    def __init__(self):
+        self.asgi = False
+
     def _encode_body(self, data):
         try:
             # Try to encode it regularly
@@ -30,20 +34,7 @@ class BaseHTTPResponse:
             return str(data).encode()
 
     def _parse_headers(self):
-        headers = b""
-        for name, value in self.headers.items():
-            try:
-                headers += b"%b: %b\r\n" % (
-                    name.encode(),
-                    value.encode("utf-8"),
-                )
-            except AttributeError:
-                headers += b"%b: %b\r\n" % (
-                    str(name).encode(),
-                    str(value).encode("utf-8"),
-                )
-
-        return headers
+        return format_http1(self.headers.items())
 
     @property
     def cookies(self):
@@ -71,12 +62,15 @@ class StreamingHTTPResponse(BaseHTTPResponse):
         content_type="text/plain",
         chunked=True,
     ):
+        super().__init__()
+
         self.content_type = content_type
         self.streaming_fn = streaming_fn
         self.status = status
-        self.headers = CIMultiDict(headers or {})
+        self.headers = Header(headers or {})
         self.chunked = chunked
         self._cookies = None
+        self.protocol = None
 
     async def write(self, data):
         """Writes a chunk of data to the streaming response.
@@ -86,6 +80,8 @@ class StreamingHTTPResponse(BaseHTTPResponse):
         if type(data) != bytes:
             data = self._encode_body(data)
 
+        # `chunked` will always be False in ASGI-mode, even if the underlying
+        # ASGI Transport implements Chunked transport. That does it itself.
         if self.chunked:
             await self.protocol.push_data(b"%x\r\n%b\r\n" % (len(data), data))
         else:
@@ -105,6 +101,7 @@ class StreamingHTTPResponse(BaseHTTPResponse):
             keep_alive=keep_alive,
             keep_alive_timeout=keep_alive_timeout,
         )
+        if not getattr(self, "asgi", False):
             await self.protocol.push_data(headers)
             await self.protocol.drain()
         await self.streaming_fn(self)
@@ -153,9 +150,11 @@ class HTTPResponse(BaseHTTPResponse):
         body=None,
         status=200,
         headers=None,
-        content_type="text/plain",
+        content_type=None,
         body_bytes=b"",
     ):
+        super().__init__()
+
         self.content_type = content_type
 
         if body is not None:
@@ -164,7 +163,7 @@ class HTTPResponse(BaseHTTPResponse):
             self.body = body_bytes
 
         self.status = status
-        self.headers = CIMultiDict(headers or {})
+        self.headers = Header(headers or {})
         self._cookies = None
 
     def output(self, version="1.1", keep_alive=False, keep_alive_timeout=None):
@@ -181,9 +180,9 @@ class HTTPResponse(BaseHTTPResponse):
                 "Content-Length", len(self.body)
             )
 
-        self.headers["Content-Type"] = self.headers.get(
-            "Content-Type", self.content_type
-        )
+        # self.headers get priority over content_type
+        if self.content_type and "Content-Type" not in self.headers:
+            self.headers["Content-Type"] = self.content_type
 
         if self.status in (304, 412):
             self.headers = remove_entity_headers(self.headers)
@@ -214,6 +213,16 @@ class HTTPResponse(BaseHTTPResponse):
         return self._cookies
 
 
+def empty(status=204, headers=None):
+    """
+    Returns an empty response to the client.
+
+    :param status Response code.
+    :param headers Custom Headers.
+    """
+    return HTTPResponse(body_bytes=b"", status=status, headers=headers)
+
+
 def json(
     body,
     status=200,

sanic/router.py

@@ -140,21 +140,22 @@ class Router:
             docs for further details.
         :return: Nothing
         """
+        routes = []
         if version is not None:
             version = re.escape(str(version).strip("/").lstrip("v"))
             uri = "/".join(["/v{}".format(version), uri.lstrip("/")])
         # add regular version
-        self._add(uri, methods, handler, host, name)
+        routes.append(self._add(uri, methods, handler, host, name))
 
         if strict_slashes:
-            return
+            return routes
 
         if not isinstance(host, str) and host is not None:
             # we have gotten back to the top of the recursion tree where the
             # host was originally a list. By now, we've processed the strict
             # slashes logic on the leaf nodes (the individual host strings in
             # the list of host)
-            return
+            return routes
 
         # Add versions with and without trailing /
         slashed_methods = self.routes_all.get(uri + "/", frozenset({}))
@@ -176,10 +177,12 @@ class Router:
         )
         # add version with trailing slash
         if slash_is_missing:
-            self._add(uri + "/", methods, handler, host, name)
+            routes.append(self._add(uri + "/", methods, handler, host, name))
         # add version without trailing slash
         elif without_slash_is_missing:
-            self._add(uri[:-1], methods, handler, host, name)
+            routes.append(self._add(uri[:-1], methods, handler, host, name))
+
+        return routes
 
     def _add(self, uri, methods, handler, host=None, name=None):
         """Add a handler to the route list
@@ -328,6 +331,7 @@ class Router:
             self.routes_dynamic[url_hash(uri)].append(route)
         else:
             self.routes_static[uri] = route
+        return route
 
     @staticmethod
     def check_dynamic_route_exists(pattern, routes_to_check, parameters):
@@ -442,6 +446,7 @@ class Router:
             method=method,
             allowed_methods=self.get_supported_methods(url),
         )
+
         if route:
             if route.methods and method not in route.methods:
                 raise method_not_supported
@@ -476,7 +481,7 @@ class Router:
         route_handler = route.handler
         if hasattr(route_handler, "handlers"):
             route_handler = route_handler.handlers[method]
-        return route_handler, [], kwargs, route.uri
+        return route_handler, [], kwargs, route.uri, route.name
 
     def is_stream_handler(self, request):
         """Handler for request is stream or not.

sanic/server.py

@@ -2,6 +2,7 @@ import asyncio
 import os
 import traceback
 
+from collections import deque
 from functools import partial
 from inspect import isawaitable
 from multiprocessing import Process
@@ -10,10 +11,10 @@ from signal import signal as signal_func
 from socket import SO_REUSEADDR, SOL_SOCKET, socket
 from time import time
 
-from httptools import HttpRequestParser
-from httptools.parser.errors import HttpParserError
-from multidict import CIMultiDict
+from httptools import HttpRequestParser  # type: ignore
+from httptools.parser.errors import HttpParserError  # type: ignore
 
+from sanic.compat import Header
 from sanic.exceptions import (
     HeaderExpectationFailed,
     InvalidUsage,
@@ -28,8 +29,9 @@ from sanic.response import HTTPResponse
 
 
 try:
-    import uvloop
+    import uvloop  # type: ignore
 
+    if not isinstance(asyncio.get_event_loop_policy(), uvloop.EventLoopPolicy):
         asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
 except ImportError:
     pass
@@ -85,6 +87,7 @@ class HttpProtocol(asyncio.Protocol):
         "_header_fragment",
         "state",
         "_debug",
+        "_body_chunks",
     )
 
     def __init__(
@@ -147,6 +150,7 @@ class HttpProtocol(asyncio.Protocol):
             self.state["requests_count"] = 0
         self._debug = debug
         self._not_paused.set()
+        self._body_chunks = deque()
 
     @property
     def keep_alive(self):
@@ -304,7 +308,7 @@ class HttpProtocol(asyncio.Protocol):
     def on_headers_complete(self):
         self.request = self.request_class(
             url_bytes=self.url,
-            headers=CIMultiDict(self.headers),
+            headers=Header(self.headers),
             version=self.parser.get_http_version(),
             method=self.parser.get_method().decode(),
             transport=self.transport,
@@ -346,13 +350,39 @@ class HttpProtocol(asyncio.Protocol):
 
     def on_body(self, body):
         if self.is_request_stream and self._is_stream_handler:
+            # body chunks can be put into asyncio.Queue out of order if
+            # multiple tasks put concurrently and the queue is full in python
+            # 3.7. so we should not create more than one task putting into the
+            # queue simultaneously.
+            self._body_chunks.append(body)
+            if (
+                not self._request_stream_task
+                or self._request_stream_task.done()
+            ):
                 self._request_stream_task = self.loop.create_task(
-                self.body_append(body)
+                    self.stream_append()
                 )
         else:
             self.request.body_push(body)
 
     async def body_append(self, body):
+        if (
+            self.request is None
+            or self._request_stream_task is None
+            or self._request_stream_task.cancelled()
+        ):
+            return
+
+        if self.request.stream.is_full():
+            self.transport.pause_reading()
+            await self.request.stream.put(body)
+            self.transport.resume_reading()
+        else:
+            await self.request.stream.put(body)
+
+    async def stream_append(self):
+        while self._body_chunks:
+            body = self._body_chunks.popleft()
             if self.request.stream.is_full():
                 self.transport.pause_reading()
                 await self.request.stream.put(body)
@@ -367,8 +397,13 @@ class HttpProtocol(asyncio.Protocol):
             self._request_timeout_handler.cancel()
             self._request_timeout_handler = None
         if self.is_request_stream and self._is_stream_handler:
+            self._body_chunks.append(None)
+            if (
+                not self._request_stream_task
+                or self._request_stream_task.done()
+            ):
                 self._request_stream_task = self.loop.create_task(
-                self.request.stream.put(None)
+                    self.stream_append()
                 )
             return
         self.request.body_finish()
@@ -633,6 +668,98 @@ def trigger_events(events, loop):
             loop.run_until_complete(result)
 
 
+class AsyncioServer:
+    """
+    Wraps an asyncio server with functionality that might be useful to
+    a user who needs to manage the server lifecycle manually.
+    """
+
+    __slots__ = (
+        "loop",
+        "serve_coro",
+        "_after_start",
+        "_before_stop",
+        "_after_stop",
+        "server",
+        "connections",
+    )
+
+    def __init__(
+        self,
+        loop,
+        serve_coro,
+        connections,
+        after_start,
+        before_stop,
+        after_stop,
+    ):
+        # Note, Sanic already called "before_server_start" events
+        # before this helper was even created. So we don't need it here.
+        self.loop = loop
+        self.serve_coro = serve_coro
+        self._after_start = after_start
+        self._before_stop = before_stop
+        self._after_stop = after_stop
+        self.server = None
+        self.connections = connections
+
+    def after_start(self):
+        """Trigger "after_server_start" events"""
+        trigger_events(self._after_start, self.loop)
+
+    def before_stop(self):
+        """Trigger "before_server_stop" events"""
+        trigger_events(self._before_stop, self.loop)
+
+    def after_stop(self):
+        """Trigger "after_server_stop" events"""
+        trigger_events(self._after_stop, self.loop)
+
+    def is_serving(self):
+        if self.server:
+            return self.server.is_serving()
+        return False
+
+    def wait_closed(self):
+        if self.server:
+            return self.server.wait_closed()
+
+    def close(self):
+        if self.server:
+            self.server.close()
+            coro = self.wait_closed()
+            task = asyncio.ensure_future(coro, loop=self.loop)
+            return task
+
+    def start_serving(self):
+        if self.server:
+            try:
+                return self.server.start_serving()
+            except AttributeError:
+                raise NotImplementedError(
+                    "server.start_serving not available in this version "
+                    "of asyncio or uvloop."
+                )
+
+    def serve_forever(self):
+        if self.server:
+            try:
+                return self.server.serve_forever()
+            except AttributeError:
+                raise NotImplementedError(
+                    "server.serve_forever not available in this version "
+                    "of asyncio or uvloop."
+                )
+
+    def __await__(self):
+        """Starts the asyncio server, returns AsyncServerCoro"""
+        task = asyncio.ensure_future(self.serve_coro)
+        while not task.done():
+            yield
+        self.server = task.result()
+        return self
+
+
 def serve(
     host,
     port,
@@ -699,6 +826,8 @@ def serve(
     :param reuse_port: `True` for multiple workers
     :param loop: asyncio compatible event loop
     :param protocol: subclass of asyncio protocol class
+    :param run_async: bool: Do not create a new event loop for the server,
+                      and return an AsyncServer object rather than running it
     :param request_class: Request class to use
     :param access_log: disable/enable access log
     :param websocket_max_size: enforces the maximum size for
@@ -743,6 +872,7 @@ def serve(
         response_timeout=response_timeout,
         keep_alive_timeout=keep_alive_timeout,
         request_max_size=request_max_size,
+        request_buffer_queue_size=request_buffer_queue_size,
         request_class=request_class,
         access_log=access_log,
         keep_alive=keep_alive,
@@ -770,7 +900,14 @@ def serve(
     )
 
     if run_async:
-        return server_coroutine
+        return AsyncioServer(
+            loop,
+            server_coroutine,
+            connections,
+            after_start,
+            before_stop,
+            after_stop,
+        )
 
     trigger_events(before_start, loop)
 

sanic/static.py

@@ -4,7 +4,7 @@ from re import sub
 from time import gmtime, strftime
 from urllib.parse import unquote
 
-from aiofiles.os import stat
+from aiofiles.os import stat  # type: ignore
 
 from sanic.exceptions import (
     ContentRangeError,

sanic/testing.py

@@ -1,13 +1,7 @@
-import asyncio
-import types
-import typing
-
 from json import JSONDecodeError
 from socket import socket
-from urllib.parse import unquote, urlsplit
 
-import httpcore
-import requests_async as requests
+import httpx
 import websockets
 
 from sanic.asgi import ASGIApp
@@ -22,13 +16,14 @@ PORT = 42101
 
 
 class SanicTestClient:
-    def __init__(self, app, port=PORT):
+    def __init__(self, app, port=PORT, host=HOST):
         """Use port=None to bind to a random port"""
         self.app = app
         self.port = port
+        self.host = host
 
     def get_new_session(self):
-        return requests.Session()
+        return httpx.Client()
 
     async def _local_request(self, method, url, *args, **kwargs):
         logger.info(url)
@@ -59,7 +54,8 @@ class SanicTestClient:
 
                 if raw_cookies:
                     response.raw_cookies = {}
-                    for cookie in response.cookies:
+
+                    for cookie in response.cookies.jar:
                         response.raw_cookies[cookie.name] = cookie
 
                 return response
@@ -71,6 +67,7 @@ class SanicTestClient:
         gather_request=True,
         debug=False,
         server_kwargs={"auto_reload": False},
+        host=None,
         *request_args,
         **request_kwargs,
     ):
@@ -95,11 +92,13 @@ class SanicTestClient:
                 return self.app.error_handler.default(request, exception)
 
         if self.port:
-            server_kwargs = dict(host=HOST, port=self.port, **server_kwargs)
-            host, port = HOST, self.port
+            server_kwargs = dict(
+                host=host or self.host, port=self.port, **server_kwargs
+            )
+            host, port = host or self.host, self.port
         else:
             sock = socket()
-            sock.bind((HOST, 0))
+            sock.bind((host or self.host, 0))
             server_kwargs = dict(sock=sock, **server_kwargs)
             host, port = sock.getsockname()
 
@@ -175,181 +174,6 @@ class SanicTestClient:
         return self._sanic_endpoint_test("websocket", *args, **kwargs)
 
 
-class SanicASGIAdapter(requests.asgi.ASGIAdapter):  # noqa
-    async def send(  # type: ignore
-        self,
-        request: requests.PreparedRequest,
-        gather_return: bool = False,
-        *args: typing.Any,
-        **kwargs: typing.Any,
-    ) -> requests.Response:
-        """This method is taken MOSTLY verbatim from requests-asyn. The
-        difference is the capturing of a response on the ASGI call and then
-        returning it on the response object. This is implemented to achieve:
-
-        request, response = await app.asgi_client.get("/")
-
-        You can see the original code here:
-        https://github.com/encode/requests-async/blob/614f40f77f19e6c6da8a212ae799107b0384dbf9/requests_async/asgi.py#L51"""  # noqa
-        scheme, netloc, path, query, fragment = urlsplit(
-            request.url
-        )  # type: ignore
-
-        default_port = {"http": 80, "ws": 80, "https": 443, "wss": 443}[scheme]
-
-        if ":" in netloc:
-            host, port_string = netloc.split(":", 1)
-            port = int(port_string)
-        else:
-            host = netloc
-            port = default_port
-
-        # Include the 'host' header.
-        if "host" in request.headers:
-            headers = []  # type: typing.List[typing.Tuple[bytes, bytes]]
-        elif port == default_port:
-            headers = [(b"host", host.encode())]
-        else:
-            headers = [(b"host", (f"{host}:{port}").encode())]
-
-        # Include other request headers.
-        headers += [
-            (key.lower().encode(), value.encode())
-            for key, value in request.headers.items()
-        ]
-
-        no_response = False
-        if scheme in {"ws", "wss"}:
-            subprotocol = request.headers.get("sec-websocket-protocol", None)
-            if subprotocol is None:
-                subprotocols = []  # type: typing.Sequence[str]
-            else:
-                subprotocols = [
-                    value.strip() for value in subprotocol.split(",")
-                ]
-
-            scope = {
-                "type": "websocket",
-                "path": unquote(path),
-                "root_path": "",
-                "scheme": scheme,
-                "query_string": query.encode(),
-                "headers": headers,
-                "client": ["testclient", 50000],
-                "server": [host, port],
-                "subprotocols": subprotocols,
-            }
-            no_response = True
-
-        else:
-            scope = {
-                "type": "http",
-                "http_version": "1.1",
-                "method": request.method,
-                "path": unquote(path),
-                "root_path": "",
-                "scheme": scheme,
-                "query_string": query.encode(),
-                "headers": headers,
-                "client": ["testclient", 50000],
-                "server": [host, port],
-                "extensions": {"http.response.template": {}},
-            }
-
-        async def receive():
-            nonlocal request_complete, response_complete
-
-            if request_complete:
-                while not response_complete:
-                    await asyncio.sleep(0.0001)
-                return {"type": "http.disconnect"}
-
-            body = request.body
-            if isinstance(body, str):
-                body_bytes = body.encode("utf-8")  # type: bytes
-            elif body is None:
-                body_bytes = b""
-            elif isinstance(body, types.GeneratorType):
-                try:
-                    chunk = body.send(None)
-                    if isinstance(chunk, str):
-                        chunk = chunk.encode("utf-8")
-                    return {
-                        "type": "http.request",
-                        "body": chunk,
-                        "more_body": True,
-                    }
-                except StopIteration:
-                    request_complete = True
-                    return {"type": "http.request", "body": b""}
-            else:
-                body_bytes = body
-
-            request_complete = True
-            return {"type": "http.request", "body": body_bytes}
-
-        async def send(message) -> None:
-            nonlocal raw_kwargs, response_started, response_complete, template, context  # noqa
-
-            if message["type"] == "http.response.start":
-                assert (
-                    not response_started
-                ), 'Received multiple "http.response.start" messages.'
-                raw_kwargs["status_code"] = message["status"]
-                raw_kwargs["headers"] = message["headers"]
-                response_started = True
-            elif message["type"] == "http.response.body":
-                assert response_started, (
-                    'Received "http.response.body" '
-                    'without "http.response.start".'
-                )
-                assert (
-                    not response_complete
-                ), 'Received "http.response.body" after response completed.'
-                body = message.get("body", b"")
-                more_body = message.get("more_body", False)
-                if request.method != "HEAD":
-                    raw_kwargs["content"] += body
-                if not more_body:
-                    response_complete = True
-            elif message["type"] == "http.response.template":
-                template = message["template"]
-                context = message["context"]
-
-        request_complete = False
-        response_started = False
-        response_complete = False
-        raw_kwargs = {"content": b""}  # type: typing.Dict[str, typing.Any]
-        template = None
-        context = None
-        return_value = None
-
-        try:
-            return_value = await self.app(scope, receive, send)
-        except BaseException as exc:
-            if not self.suppress_exceptions:
-                raise exc from None
-
-        if no_response:
-            response_started = True
-            raw_kwargs = {"status_code": 204, "headers": []}
-
-        if not self.suppress_exceptions:
-            assert response_started, "TestClient did not receive any response."
-        elif not response_started:
-            raw_kwargs = {"status_code": 500, "headers": []}
-
-        raw = httpcore.Response(**raw_kwargs)
-        response = self.build_response(request, raw)
-        if template is not None:
-            response.template = template
-            response.context = context
-
-        if gather_return:
-            response.return_value = return_value
-        return response
-
-
 class TestASGIApp(ASGIApp):
     async def __call__(self):
         await super().__call__()
@@ -361,7 +185,11 @@ async def app_call_with_return(self, scope, receive, send):
     return await asgi_app()
 
 
-class SanicASGITestClient(requests.ASGISession):
+class SanicASGIDispatch(httpx.dispatch.ASGIDispatch):
+    pass
+
+
+class SanicASGITestClient(httpx.Client):
     def __init__(
         self,
         app,
@@ -370,18 +198,18 @@ class SanicASGITestClient(requests.ASGISession):
     ) -> None:
         app.__class__.__call__ = app_call_with_return
         app.asgi = True
-        super().__init__(app)
 
-        adapter = SanicASGIAdapter(
-            app, suppress_exceptions=suppress_exceptions
-        )
-        self.mount("http://", adapter)
-        self.mount("https://", adapter)
-        self.mount("ws://", adapter)
-        self.mount("wss://", adapter)
-        self.headers.update({"user-agent": "testclient"})
         self.app = app
-        self.base_url = base_url
+
+        dispatch = SanicASGIDispatch(app=app, client=(ASGI_HOST, PORT))
+        super().__init__(dispatch=dispatch, base_url=base_url)
+
+        self.last_request = None
+
+        def _collect_request(request):
+            self.last_request = request
+
+        app.request_middleware.appendleft(_collect_request)
 
     async def request(self, method, url, gather_request=True, *args, **kwargs):
 
@@ -391,24 +219,12 @@ class SanicASGITestClient(requests.ASGISession):
         response.body = response.content
         response.content_type = response.headers.get("content-type")
 
-        if hasattr(response, "return_value"):
-            request = response.return_value
-            del response.return_value
-            return request, response
-
-        return response
-
-    def merge_environment_settings(self, *args, **kwargs):
-        settings = super().merge_environment_settings(*args, **kwargs)
-        settings.update({"gather_return": self.gather_request})
-        return settings
+        return self.last_request, response
 
     async def websocket(self, uri, subprotocols=None, *args, **kwargs):
-        if uri.startswith(("ws:", "wss:")):
-            url = uri
-        else:
-            uri = uri if uri.startswith("/") else "/{uri}".format(uri=uri)
-            url = "ws://testserver{uri}".format(uri=uri)
+        scheme = "ws"
+        path = uri
+        root_path = "{}://{}".format(scheme, ASGI_HOST)
 
         headers = kwargs.get("headers", {})
         headers.setdefault("connection", "upgrade")
@@ -418,6 +234,24 @@ class SanicASGITestClient(requests.ASGISession):
             headers.setdefault(
                 "sec-websocket-protocol", ", ".join(subprotocols)
             )
-            kwargs["headers"] = headers
 
-            return await self.request("websocket", url, **kwargs)
+        scope = {
+            "type": "websocket",
+            "asgi": {"version": "3.0"},
+            "http_version": "1.1",
+            "headers": [map(lambda y: y.encode(), x) for x in headers.items()],
+            "scheme": scheme,
+            "root_path": root_path,
+            "path": path,
+            "query_string": b"",
+        }
+
+        async def receive():
+            return {}
+
+        async def send(message):
+            pass
+
+        await self.app(scope, receive, send)
+
+        return None, {}

sanic/views.py

@@ -1,3 +1,5 @@
+from typing import Any, Callable, List
+
 from sanic.constants import HTTP_METHODS
 from sanic.exceptions import InvalidUsage
 
@@ -37,7 +39,7 @@ class HTTPMethodView:
     To add any decorator you could set it into decorators variable
     """
 
-    decorators = []
+    decorators: List[Callable[[Callable[..., Any]], Callable[..., Any]]] = []
 
     def dispatch_request(self, request, *args, **kwargs):
         handler = getattr(self, request.method.lower(), None)

sanic/websocket.py

@@ -1,13 +1,27 @@
-from typing import Any, Awaitable, Callable, MutableMapping, Optional, Union
+from typing import (
+    Any,
+    Awaitable,
+    Callable,
+    Dict,
+    MutableMapping,
+    Optional,
+    Union,
+)
 
-from httptools import HttpParserUpgrade
-from websockets import ConnectionClosed  # noqa
-from websockets import InvalidHandshake, WebSocketCommonProtocol, handshake
+from httptools import HttpParserUpgrade  # type: ignore
+from websockets import (  # type: ignore
+    ConnectionClosed,
+    InvalidHandshake,
+    WebSocketCommonProtocol,
+    handshake,
+)
 
 from sanic.exceptions import InvalidUsage
 from sanic.server import HttpProtocol
 
 
+__all__ = ["ConnectionClosed", "WebSocketProtocol", "WebSocketConnection"]
+
 ASIMessage = MutableMapping[str, Any]
 
 
@@ -105,6 +119,9 @@ class WebSocketProtocol(HttpProtocol):
             read_limit=self.websocket_read_limit,
             write_limit=self.websocket_write_limit,
         )
+        # Following two lines are required for websockets 8.x
+        self.websocket.is_client = False
+        self.websocket.side = "server"
         self.websocket.subprotocol = subprotocol
         self.websocket.connection_made(request.transport)
         self.websocket.connection_open()
@@ -125,14 +142,12 @@ class WebSocketConnection:
         self._receive = receive
 
     async def send(self, data: Union[str, bytes], *args, **kwargs) -> None:
-        message = {"type": "websocket.send"}
+        message: Dict[str, Union[str, bytes]] = {"type": "websocket.send"}
 
-        try:
-            data.decode()
-        except AttributeError:
-            message.update({"text": str(data)})
-        else:
+        if isinstance(data, bytes):
             message.update({"bytes": data})
+        else:
+            message.update({"text": str(data)})
 
         await self._send(message)
 
@@ -144,6 +159,8 @@ class WebSocketConnection:
         elif message["type"] == "websocket.disconnect":
             pass
 
+        return None
+
     receive = recv
 
     async def accept(self) -> None:

sanic/worker.py

@@ -5,19 +5,19 @@ import signal
 import sys
 import traceback
 
-import gunicorn.workers.base as base
+import gunicorn.workers.base as base  # type: ignore
 
 from sanic.server import HttpProtocol, Signal, serve, trigger_events
 from sanic.websocket import WebSocketProtocol
 
 
 try:
-    import ssl
+    import ssl  # type: ignore
 except ImportError:
-    ssl = None
+    ssl = None  # type: ignore
 
 try:
-    import uvloop
+    import uvloop  # type: ignore
 
     asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
 except ImportError:

scripts/changelog.py

@@ -0,0 +1,59 @@
+#!/usr/bin/env python
+
+from os import path
+
+if __name__ == "__main__":
+    try:
+        import towncrier
+        import click
+    except ImportError:
+        print(
+            "Please make sure you have a installed towncrier and click before using this tool"
+        )
+        exit(1)
+
+    @click.command()
+    @click.option(
+        "--draft",
+        "draft",
+        default=False,
+        flag_value=True,
+        help="Render the news fragments, don't write to files, "
+        "don't check versions.",
+    )
+    @click.option(
+        "--dir", "directory", default=path.dirname(path.abspath(__file__))
+    )
+    @click.option("--name", "project_name", default=None)
+    @click.option(
+        "--version",
+        "project_version",
+        default=None,
+        help="Render the news fragments using given version.",
+    )
+    @click.option("--date", "project_date", default=None)
+    @click.option(
+        "--yes",
+        "answer_yes",
+        default=False,
+        flag_value=True,
+        help="Do not ask for confirmation to remove news fragments.",
+    )
+    def _main(
+        draft,
+        directory,
+        project_name,
+        project_version,
+        project_date,
+        answer_yes,
+    ):
+        return towncrier.__main(
+            draft,
+            directory,
+            project_name,
+            project_version,
+            project_date,
+            answer_yes,
+        )
+
+    _main()

scripts/pyproject.toml

@@ -0,0 +1,33 @@
+[tool.towncrier]
+package = "sanic"
+package_dir = ".."
+filename = "../CHANGELOG.rst"
+directory = "./changelogs"
+underlines = ["=", "*", "~"]
+issue_format = "`#{issue} <https://github.com/huge-success/sanic/issues/{issue}>`__"
+title_format = "Version {version}"
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "Features"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Bugfixes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "doc"
+name = "Improved Documentation"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "removal"
+name = "Deprecations and Removals"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "misc"
+name = "Miscellaneous internal changes"
+showcontent = true

scripts/release.py

@@ -5,11 +5,12 @@ from collections import OrderedDict
 from configparser import RawConfigParser
 from datetime import datetime
 from json import dumps
-from os import path
+from os import path, chdir
 from subprocess import Popen, PIPE
 
 from jinja2 import Environment, BaseLoader
 from requests import patch
+import towncrier
 
 GIT_COMMANDS = {
     "get_tag": ["git describe --tags --abbrev=0"],
@@ -56,6 +57,18 @@ RELEASE_NOTE_UPDATE_URL = (
 )
 
 
+class Directory:
+    def __init__(self):
+        self._old_path = path.dirname(path.abspath(__file__))
+        self._new_path = path.dirname(self._old_path)
+
+    def __enter__(self):
+        chdir(self._new_path)
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        chdir(self._old_path)
+
+
 def _run_shell_command(command: list):
     try:
         process = Popen(
@@ -118,14 +131,14 @@ def _get_current_tag(git_command_name="get_tag"):
 
 
 def _update_release_version_for_sanic(
-    current_version, new_version, config_file
+    current_version, new_version, config_file, generate_changelog
 ):
     config_parser = RawConfigParser()
     with open(config_file) as cfg:
         config_parser.read_file(cfg)
     config_parser.set("version", "current_version", new_version)
 
-    version_file = config_parser.get("version", "file")
+    version_files = config_parser.get("version", "files")
     current_version_line = config_parser.get(
         "version", "current_version_pattern"
     ).format(current_version=current_version)
@@ -133,6 +146,7 @@ def _update_release_version_for_sanic(
         "version", "new_version_pattern"
     ).format(new_version=new_version)
 
+    for version_file in version_files.split(","):
         with open(version_file) as init_file:
             data = init_file.read()
 
@@ -143,6 +157,16 @@ def _update_release_version_for_sanic(
     with open(config_file, "w") as config:
         config_parser.write(config)
 
+    if generate_changelog:
+        towncrier.__main(
+            draft=False,
+            directory=path.dirname(path.abspath(__file__)),
+            project_name=None,
+            project_version=new_version,
+            project_date=None,
+            answer_yes=True,
+        )
+
     command = GIT_COMMANDS.get("commit_version_change")
     command[0] = command[0].format(
         new_version=new_version, current_version=current_version
@@ -240,7 +264,9 @@ def release(args: Namespace):
         current_version=current_version,
         new_version=new_version,
         config_file=args.config,
+        generate_changelog=args.generate_changelog,
     )
+    if args.tag_release:
         _tag_release(
             current_version=current_version,
             new_version=new_version,
@@ -278,13 +304,13 @@ if __name__ == "__main__":
         "--token",
         "-t",
         help="Git access token with necessary access to Huge Sanic Org",
-        required=True,
+        required=False,
     )
     cli.add_argument(
         "--milestone",
         "-ms",
         help="Git Release milestone information to include in relase note",
-        required=True,
+        required=False,
     )
     cli.add_argument(
         "--release-name",
@@ -300,5 +326,28 @@ if __name__ == "__main__":
         action="store_true",
         required=False,
     )
+    cli.add_argument(
+        "--tag-release",
+        help="Tag a new release for Sanic",
+        default=False,
+        action="store_true",
+        required=False,
+    )
+    cli.add_argument(
+        "--generate-changelog",
+        help="Generate changelog for Sanic as part of release",
+        default=False,
+        action="store_true",
+        required=False,
+    )
     args = cli.parse_args()
+    if args.tag_release:
+        for key, value in {
+            "--token/-t": args.token,
+            "--milestone/-m": args.milestone,
+        }.items():
+            if not value:
+                print(f"{key} is mandatory while using --tag-release")
+                exit(1)
+    with Directory():
         release(args)

setup.cfg

@@ -14,7 +14,8 @@ multi_line_output = 3
 not_skip = __init__.py
 
 [version]
-current_version = 19.3.1
-file = sanic/__init__.py
+current_version = 19.12.0
+files = sanic/__version__.py
 current_version_pattern = __version__ = "{current_version}"
 new_version_pattern = __version__ = "{new_version}"
+

setup.py

@@ -5,6 +5,7 @@ import codecs
 import os
 import re
 import sys
+
 from distutils.util import strtobool
 
 from setuptools import setup
@@ -24,6 +25,7 @@ class PyTest(TestCommand):
 
     def run_tests(self):
         import shlex
+
         import pytest
 
         errno = pytest.main(shlex.split(self.pytest_args))
@@ -36,7 +38,7 @@ def open_local(paths, mode="r", encoding="utf8"):
     return codecs.open(path, mode, encoding)
 
 
-with open_local(["sanic", "__init__.py"], encoding="latin1") as fp:
+with open_local(["sanic", "__version__.py"], encoding="latin1") as fp:
     try:
         version = re.findall(
             r"^__version__ = \"([^']+)\"\r?$", fp.read(), re.M
@@ -60,6 +62,7 @@ setup_kwargs = {
     "long_description": long_description,
     "packages": ["sanic"],
     "platforms": "any",
+    "python_requires": ">=3.6",
     "classifiers": [
         "Development Status :: 4 - Beta",
         "Environment :: Web Environment",
@@ -73,21 +76,21 @@ env_dependency = (
     '; sys_platform != "win32" ' 'and implementation_name == "cpython"'
 )
 ujson = "ujson>=1.35" + env_dependency
-uvloop = "uvloop>=0.5.3" + env_dependency
+uvloop = "uvloop>=0.5.3,<0.15.0" + env_dependency
 
 requirements = [
     "httptools>=0.0.10",
     uvloop,
     ujson,
     "aiofiles>=0.3.0",
-    "websockets>=6.0,<7.0",
-    "multidict>=4.0,<5.0",
-    "requests-async==0.5.0",
+    "websockets>=7.0,<9.0",
+    "multidict==5.0.0",
+    "httpx==0.9.3",
 ]
 
 tests_require = [
-    "pytest==4.1.0",
-    "multidict>=4.0,<5.0",
+    "pytest==5.2.1",
+    "multidict==5.0.0",
     "gunicorn",
     "pytest-cov",
     "httpcore==0.3.0",
@@ -99,6 +102,25 @@ tests_require = [
     "pytest-benchmark",
 ]
 
+docs_require = [
+    "sphinx>=2.1.2",
+    "sphinx_rtd_theme",
+    "recommonmark>=0.5.0",
+    "docutils",
+    "pygments",
+]
+
+dev_require = tests_require + [
+    "aiofiles",
+    "tox",
+    "black",
+    "flake8",
+    "bandit",
+    "towncrier",
+]
+
+all_require = dev_require + docs_require
+
 if strtobool(os.environ.get("SANIC_NO_UJSON", "no")):
     print("Installing without uJSON")
     requirements.remove(ujson)
@@ -112,15 +134,9 @@ if strtobool(os.environ.get("SANIC_NO_UVLOOP", "no")):
 
 extras_require = {
     "test": tests_require,
-    "dev": tests_require + ["aiofiles", "tox", "black", "flake8"],
-    "docs": [
-        "sphinx",
-        "sphinx_rtd_theme",
-        "recommonmark",
-        "sphinxcontrib-asyncio",
-        "docutils",
-        "pygments",
-    ],
+    "dev": dev_require,
+    "docs": docs_require,
+    "all": all_require,
 }
 
 setup_kwargs["install_requires"] = requirements

tests/performance/wheezy/simple_server.py

@@ -39,6 +39,7 @@ main = WSGIApplication(
 
 if __name__ == "__main__":
     import sys
+
     from wsgiref.simple_server import make_server
 
     try:

tests/test_app.py

@@ -41,6 +41,20 @@ def test_create_asyncio_server(app):
         assert srv.is_serving() is True
 
 
+@pytest.mark.skipif(
+    sys.version_info < (3, 7), reason="requires python3.7 or higher"
+)
+def test_asyncio_server_no_start_serving(app):
+    if not uvloop_installed():
+        loop = asyncio.get_event_loop()
+        asyncio_srv_coro = app.create_server(
+            return_asyncio_server=True,
+            asyncio_server_kwargs=dict(start_serving=False),
+        )
+        srv = loop.run_until_complete(asyncio_srv_coro)
+        assert srv.is_serving() is False
+
+
 @pytest.mark.skipif(
     sys.version_info < (3, 7), reason="requires python3.7 or higher"
 )
@@ -53,6 +67,10 @@ def test_asyncio_server_start_serving(app):
         )
         srv = loop.run_until_complete(asyncio_srv_coro)
         assert srv.is_serving() is False
+        loop.run_until_complete(srv.start_serving())
+        assert srv.is_serving() is True
+        srv.close()
+        # Looks like we can't easily test `serve_forever()`
 
 
 def test_app_loop_not_running(app):
@@ -94,7 +112,7 @@ def test_app_route_raise_value_error(app):
 
 def test_app_handle_request_handler_is_none(app, monkeypatch):
     def mockreturn(*args, **kwargs):
-        return None, [], {}, ""
+        return None, [], {}, "", ""
 
     # Not sure how to make app.router.get() return None, so use mock here.
     monkeypatch.setattr(app.router, "get", mockreturn)

tests/test_asgi.py

@@ -1,12 +1,15 @@
 import asyncio
 
-from collections import deque
+from collections import deque, namedtuple
 
 import pytest
 import uvicorn
 
+from sanic import Sanic
 from sanic.asgi import MockTransport
 from sanic.exceptions import InvalidUsage
+from sanic.request import Request
+from sanic.response import json, text
 from sanic.websocket import WebSocketConnection
 
 
@@ -201,3 +204,88 @@ def test_improper_websocket_connection(transport, send, receive):
     transport.create_websocket_connection(send, receive)
     connection = transport.get_websocket_connection()
     assert isinstance(connection, WebSocketConnection)
+
+
+@pytest.mark.asyncio
+async def test_request_class_regular(app):
+    @app.get("/regular")
+    def regular_request(request):
+        return text(request.__class__.__name__)
+
+    _, response = await app.asgi_client.get("/regular")
+    assert response.body == b"Request"
+
+
+@pytest.mark.asyncio
+async def test_request_class_custom():
+    class MyCustomRequest(Request):
+        pass
+
+    app = Sanic(request_class=MyCustomRequest)
+
+    @app.get("/custom")
+    def custom_request(request):
+        return text(request.__class__.__name__)
+
+    _, response = await app.asgi_client.get("/custom")
+    assert response.body == b"MyCustomRequest"
+
+
+@pytest.mark.asyncio
+async def test_cookie_customization(app):
+    @app.get("/cookie")
+    def get_cookie(request):
+        response = text("There's a cookie up in this response")
+        response.cookies["test"] = "Cookie1"
+        response.cookies["test"]["httponly"] = True
+
+        response.cookies["c2"] = "Cookie2"
+        response.cookies["c2"]["httponly"] = False
+
+        return response
+
+    _, response = await app.asgi_client.get("/cookie")
+
+    CookieDef = namedtuple("CookieDef", ("value", "httponly"))
+    Cookie = namedtuple("Cookie", ("domain", "path", "value", "httponly"))
+    cookie_map = {
+        "test": CookieDef("Cookie1", True),
+        "c2": CookieDef("Cookie2", False),
+    }
+
+    cookies = {
+        c.name: Cookie(c.domain, c.path, c.value, "HttpOnly" in c._rest.keys())
+        for c in response.cookies.jar
+    }
+
+    for name, definition in cookie_map.items():
+        cookie = cookies.get(name)
+        assert cookie
+        assert cookie.value == definition.value
+        assert cookie.domain == "mockserver.local"
+        assert cookie.path == "/"
+        assert cookie.httponly == definition.httponly
+
+
+@pytest.mark.asyncio
+async def test_json_content_type(app):
+    @app.get("/json")
+    def send_json(request):
+        return json({"foo": "bar"})
+
+    @app.get("/text")
+    def send_text(request):
+        return text("foobar")
+
+    @app.get("/custom")
+    def send_custom(request):
+        return text("foobar", content_type="somethingelse")
+
+    _, response = await app.asgi_client.get("/json")
+    assert response.headers.get("content-type") == "application/json"
+
+    _, response = await app.asgi_client.get("/text")
+    assert response.headers.get("content-type") == "text/plain; charset=utf-8"
+
+    _, response = await app.asgi_client.get("/custom")
+    assert response.headers.get("content-type") == "somethingelse"

tests/test_blueprint_group.py

@@ -83,7 +83,7 @@ def test_bp_group_with_additional_route_params(app: Sanic):
     _, response = app.test_client.patch("/api/bp2/route/bp2", headers=header)
     assert response.text == "PATCH_bp2"
 
-    _, response = app.test_client.get("/v2/api/bp1/request_path")
+    _, response = app.test_client.put("/v2/api/bp1/request_path")
     assert response.status == 401
 
 
@@ -141,8 +141,8 @@ def test_bp_group(app: Sanic):
     _, response = app.test_client.get("/api/bp3")
     assert response.text == "BP3_OK"
 
-    assert MIDDLEWARE_INVOKE_COUNTER["response"] == 4
-    assert MIDDLEWARE_INVOKE_COUNTER["request"] == 4
+    assert MIDDLEWARE_INVOKE_COUNTER["response"] == 3
+    assert MIDDLEWARE_INVOKE_COUNTER["request"] == 2
 
 
 def test_bp_group_list_operations(app: Sanic):

tests/test_blueprints.py

@@ -268,7 +268,7 @@ def test_bp_middleware(app):
     request, response = app.test_client.get("/")
 
     assert response.status == 200
-    assert response.text == "OK"
+    assert response.text == "FAIL"
 
 
 def test_bp_exception_handler(app):

tests/test_config.py

@@ -19,8 +19,8 @@ def temp_path():
 
 
 class ConfigTest:
-        not_for_config = 'should not be used'
-        CONFIG_VALUE = 'should be used'
+    not_for_config = "should not be used"
+    CONFIG_VALUE = "should be used"
 
 
 def test_load_from_object(app):
@@ -31,15 +31,15 @@ def test_load_from_object(app):
 
 
 def test_load_from_object_string(app):
-    app.config.from_object('test_config.ConfigTest')
-    assert 'CONFIG_VALUE' in app.config
-    assert app.config.CONFIG_VALUE == 'should be used'
-    assert 'not_for_config' not in app.config
+    app.config.from_object("test_config.ConfigTest")
+    assert "CONFIG_VALUE" in app.config
+    assert app.config.CONFIG_VALUE == "should be used"
+    assert "not_for_config" not in app.config
 
 
 def test_load_from_object_string_exception(app):
     with pytest.raises(ImportError):
-        app.config.from_object('test_config.Config.test')
+        app.config.from_object("test_config.Config.test")
 
 
 def test_auto_load_env():

tests/test_headers.py

@@ -0,0 +1,63 @@
+import pytest
+
+from sanic import headers
+
+
+@pytest.mark.parametrize(
+    "input, expected",
+    [
+        ("text/plain", ("text/plain", {})),
+        ("text/vnd.just.made.this.up ; ", ("text/vnd.just.made.this.up", {})),
+        (
+            "text/plain;charset=us-ascii",
+            ("text/plain", {"charset": "us-ascii"}),
+        ),
+        (
+            'text/plain ; charset="us-ascii"',
+            ("text/plain", {"charset": "us-ascii"}),
+        ),
+        (
+            'text/plain ; charset="us-ascii"; another=opt',
+            ("text/plain", {"charset": "us-ascii", "another": "opt"}),
+        ),
+        (
+            'attachment; filename="silly.txt"',
+            ("attachment", {"filename": "silly.txt"}),
+        ),
+        (
+            'attachment; filename="strange;name"',
+            ("attachment", {"filename": "strange;name"}),
+        ),
+        (
+            'attachment; filename="strange;name";size=123;',
+            ("attachment", {"filename": "strange;name", "size": "123"}),
+        ),
+        (
+            'form-data; name="files"; filename="fo\\"o;bar\\"',
+            ("form-data", {"name": "files", "filename": 'fo"o;bar\\'})
+            # cgi.parse_header:
+            # ('form-data', {'name': 'files', 'filename': 'fo"o;bar\\'})
+            # werkzeug.parse_options_header:
+            # ('form-data', {'name': 'files', 'filename': '"fo\\"o', 'bar\\"': None})
+        ),
+        # <input type=file name="foo&quot;;bar\"> with Unicode filename!
+        (
+            # Chrome:
+            # Content-Disposition: form-data; name="foo%22;bar\"; filename="😀"
+            'form-data; name="foo%22;bar\\"; filename="😀"',
+            ("form-data", {"name": 'foo";bar\\', "filename": "😀"})
+            # cgi: ('form-data', {'name': 'foo%22;bar"; filename="😀'})
+            # werkzeug: ('form-data', {'name': 'foo%22;bar"; filename='})
+        ),
+        (
+            # Firefox:
+            # Content-Disposition: form-data; name="foo\";bar\"; filename="😀"
+            'form-data; name="foo\\";bar\\"; filename="😀"',
+            ("form-data", {"name": 'foo";bar\\', "filename": "😀"})
+            # cgi: ('form-data', {'name': 'foo";bar"; filename="😀'})
+            # werkzeug: ('form-data', {'name': 'foo";bar"; filename='})
+        ),
+    ],
+)
+def test_parse_headers(input, expected):
+    assert headers.parse_content_header(input) == expected

tests/test_helpers.py

@@ -1,8 +1,9 @@
 import inspect
 
+import pytest
+
 from sanic import helpers
 from sanic.config import Config
-import pytest
 
 
 def test_has_message_body():
@@ -63,15 +64,15 @@ def test_remove_entity_headers():
 
 
 def test_import_string_class():
-    obj = helpers.import_string('sanic.config.Config')
+    obj = helpers.import_string("sanic.config.Config")
     assert isinstance(obj, Config)
 
 
 def test_import_string_module():
-    module = helpers.import_string('sanic.config')
+    module = helpers.import_string("sanic.config")
     assert inspect.ismodule(module)
 
 
 def test_import_string_exception():
     with pytest.raises(ImportError):
-        helpers.import_string('test.test.test')
+        helpers.import_string("test.test.test")

tests/test_keep_alive_timeout.py

@@ -1,15 +1,9 @@
 import asyncio
-import functools
-import socket
 
 from asyncio import sleep as aio_sleep
-from http.client import _encode
 from json import JSONDecodeError
 
-import httpcore
-import requests_async as requests
-
-from httpcore import PoolTimeout
+import httpx
 
 from sanic import Sanic, server
 from sanic.response import text
@@ -21,24 +15,28 @@ CONFIG_FOR_TESTS = {"KEEP_ALIVE_TIMEOUT": 2, "KEEP_ALIVE": True}
 old_conn = None
 
 
-class ReusableSanicConnectionPool(httpcore.ConnectionPool):
-    async def acquire_connection(self, origin):
+class ReusableSanicConnectionPool(
+    httpx.dispatch.connection_pool.ConnectionPool
+):
+    async def acquire_connection(self, origin, timeout):
         global old_conn
-        connection = self.active_connections.pop_by_origin(
-            origin, http2_only=True
-        )
-        if connection is None:
-            connection = self.keepalive_connections.pop_by_origin(origin)
+        connection = self.pop_connection(origin)
 
         if connection is None:
-            await self.max_connections.acquire()
-            connection = httpcore.HTTPConnection(
+            pool_timeout = None if timeout is None else timeout.pool_timeout
+
+            await self.max_connections.acquire(timeout=pool_timeout)
+            connection = httpx.dispatch.connection.HTTPConnection(
                 origin,
-                ssl=self.ssl,
-                timeout=self.timeout,
+                verify=self.verify,
+                cert=self.cert,
+                http2=self.http2,
                 backend=self.backend,
                 release_func=self.release_connection,
+                trust_env=self.trust_env,
+                uds=self.uds,
             )
+
         self.active_connections.add(connection)
 
         if old_conn is not None:
@@ -51,17 +49,10 @@ class ReusableSanicConnectionPool(httpcore.ConnectionPool):
         return connection
 
 
-class ReusableSanicAdapter(requests.adapters.HTTPAdapter):
-    def __init__(self):
-        self.pool = ReusableSanicConnectionPool()
-
-
-class ResusableSanicSession(requests.Session):
+class ResusableSanicSession(httpx.Client):
     def __init__(self, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
-        adapter = ReusableSanicAdapter()
-        self.mount("http://", adapter)
-        self.mount("https://", adapter)
+        dispatch = ReusableSanicConnectionPool()
+        super().__init__(dispatch=dispatch, *args, **kwargs)
 
 
 class ReuseableSanicTestClient(SanicTestClient):
@@ -74,6 +65,9 @@ class ReuseableSanicTestClient(SanicTestClient):
         self._tcp_connector = None
         self._session = None
 
+    def get_new_session(self):
+        return ResusableSanicSession()
+
     # Copied from SanicTestClient, but with some changes to reuse the
     # same loop for the same app.
     def _sanic_endpoint_test(
@@ -167,7 +161,6 @@ class ReuseableSanicTestClient(SanicTestClient):
                 self._server.close()
                 self._loop.run_until_complete(self._server.wait_closed())
                 self._server = None
-                self.app.stop()
 
             if self._session:
                 self._loop.run_until_complete(self._session.close())
@@ -186,7 +179,7 @@ class ReuseableSanicTestClient(SanicTestClient):
             "request_keepalive", CONFIG_FOR_TESTS["KEEP_ALIVE_TIMEOUT"]
         )
         if not self._session:
-            self._session = ResusableSanicSession()
+            self._session = self.get_new_session()
         try:
             response = await getattr(self._session, method.lower())(
                 url, verify=False, timeout=request_keepalive, *args, **kwargs

tests/test_multiprocessing.py

@@ -5,6 +5,7 @@ import signal
 
 import pytest
 
+from sanic import Blueprint
 from sanic.response import text
 from sanic.testing import HOST, PORT
 
@@ -37,8 +38,6 @@ def test_multiprocessing(app):
     reason="SIGALRM is not implemented for this platform",
 )
 def test_multiprocessing_with_blueprint(app):
-    from sanic import Blueprint
-
     # Selects a number at random so we can spot check
     num_workers = random.choice(range(2, multiprocessing.cpu_count() * 2 + 1))
     process_list = set()
@@ -64,27 +63,27 @@ def handler(request):
     return text("Hello")
 
 
-# Muliprocessing on Windows requires app to be able to be pickled
+# Multiprocessing on Windows requires app to be able to be pickled
 @pytest.mark.parametrize("protocol", [3, 4])
 def test_pickle_app(app, protocol):
     app.route("/")(handler)
     p_app = pickle.dumps(app, protocol=protocol)
+    del app
     up_p_app = pickle.loads(p_app)
     assert up_p_app
-    request, response = app.test_client.get("/")
+    request, response = up_p_app.test_client.get("/")
     assert response.text == "Hello"
 
 
 @pytest.mark.parametrize("protocol", [3, 4])
 def test_pickle_app_with_bp(app, protocol):
-    from sanic import Blueprint
-
     bp = Blueprint("test_text")
     bp.route("/")(handler)
     app.blueprint(bp)
     p_app = pickle.dumps(app, protocol=protocol)
+    del app
     up_p_app = pickle.loads(p_app)
     assert up_p_app
-    request, response = app.test_client.get("/")
-    assert app.is_request_stream is False
+    request, response = up_p_app.test_client.get("/")
+    assert up_p_app.is_request_stream is False
     assert response.text == "Hello"

tests/test_request_buffer_queue_size.py

@@ -0,0 +1,37 @@
+import io
+
+from sanic.response import text
+
+
+data = "abc" * 10_000_000
+
+
+def test_request_buffer_queue_size(app):
+    default_buf_qsz = app.config.get("REQUEST_BUFFER_QUEUE_SIZE")
+    qsz = 1
+    while qsz == default_buf_qsz:
+        qsz += 1
+    app.config.REQUEST_BUFFER_QUEUE_SIZE = qsz
+
+    @app.post("/post", stream=True)
+    async def post(request):
+        assert request.stream.buffer_size == qsz
+        print("request.stream.buffer_size =", request.stream.buffer_size)
+
+        bio = io.BytesIO()
+        while True:
+            bdata = await request.stream.read()
+            if not bdata:
+                break
+            bio.write(bdata)
+
+            head = bdata[:3].decode("utf-8")
+            tail = bdata[3:][-3:].decode("utf-8")
+            print(head, "...", tail)
+
+        bio.seek(0)
+        return text(bio.read().decode("utf-8"))
+
+    request, response = app.test_client.post("/post", data=data)
+    assert response.status == 200
+    assert response.text == data

tests/test_request_data.py

@@ -9,21 +9,74 @@ except ImportError:
     from json import loads
 
 
-def test_storage(app):
+def test_custom_context(app):
     @app.middleware("request")
     def store(request):
+        request.ctx.user = "sanic"
+        request.ctx.session = None
+
+    @app.route("/")
+    def handler(request):
+        # Accessing non-existant key should fail with AttributeError
+        try:
+            invalid = request.ctx.missing
+        except AttributeError as e:
+            invalid = str(e)
+        return json(
+            {
+                "user": request.ctx.user,
+                "session": request.ctx.session,
+                "has_user": hasattr(request.ctx, "user"),
+                "has_session": hasattr(request.ctx, "session"),
+                "has_missing": hasattr(request.ctx, "missing"),
+                "invalid": invalid,
+            }
+        )
+
+    request, response = app.test_client.get("/")
+    assert response.json == {
+        "user": "sanic",
+        "session": None,
+        "has_user": True,
+        "has_session": True,
+        "has_missing": False,
+        "invalid": "'types.SimpleNamespace' object has no attribute 'missing'",
+    }
+
+
+# Remove this once the deprecated API is abolished.
+def test_custom_context_old(app):
+    @app.middleware("request")
+    def store(request):
+        try:
+            request["foo"]
+        except KeyError:
+            pass
         request["user"] = "sanic"
-        request["sidekick"] = "tails"
+        sidekick = request.get("sidekick", "tails")  # Item missing -> default
+        request["sidekick"] = sidekick
+        request["bar"] = request["sidekick"]
         del request["sidekick"]
 
     @app.route("/")
     def handler(request):
         return json(
-            {"user": request.get("user"), "sidekick": request.get("sidekick")}
+            {
+                "user": request.get("user"),
+                "sidekick": request.get("sidekick"),
+                "has_bar": "bar" in request,
+                "has_sidekick": "sidekick" in request,
+            }
         )
 
     request, response = app.test_client.get("/")
 
+    assert response.json == {
+        "user": "sanic",
+        "sidekick": None,
+        "has_bar": True,
+        "has_sidekick": False,
+    }
     response_json = loads(response.text)
     assert response_json["user"] == "sanic"
     assert response_json.get("sidekick") is None

tests/test_request_stream.py

@@ -332,7 +332,7 @@ def test_request_stream_handle_exception(app):
     assert response.text == "Error: Requested URL /in_valid_post not found"
 
     # 405
-    request, response = app.test_client.get("/post/random_id", data=data)
+    request, response = app.test_client.get("/post/random_id")
     assert response.status == 405
     assert (
         response.text == "Error: Method GET not allowed for URL"

tests/test_request_timeout.py

@@ -1,49 +1,70 @@
 import asyncio
 
-import httpcore
-import requests_async as requests
+import httpx
 
 from sanic import Sanic
 from sanic.response import text
 from sanic.testing import SanicTestClient
 
 
-class DelayableSanicConnectionPool(httpcore.ConnectionPool):
+class DelayableHTTPConnection(httpx.dispatch.connection.HTTPConnection):
+    def __init__(self, *args, **kwargs):
+        self._request_delay = None
+        if "request_delay" in kwargs:
+            self._request_delay = kwargs.pop("request_delay")
+        super().__init__(*args, **kwargs)
+
+    async def send(self, request, verify=None, cert=None, timeout=None):
+        if self.h11_connection is None and self.h2_connection is None:
+            await self.connect(verify=verify, cert=cert, timeout=timeout)
+
+        if self._request_delay:
+            await asyncio.sleep(self._request_delay)
+
+        if self.h2_connection is not None:
+            response = await self.h2_connection.send(request, timeout=timeout)
+        else:
+            assert self.h11_connection is not None
+            response = await self.h11_connection.send(request, timeout=timeout)
+
+        return response
+
+
+class DelayableSanicConnectionPool(
+    httpx.dispatch.connection_pool.ConnectionPool
+):
     def __init__(self, request_delay=None, *args, **kwargs):
         self._request_delay = request_delay
         super().__init__(*args, **kwargs)
 
-    async def send(self, request, stream=False, ssl=None, timeout=None):
-        connection = await self.acquire_connection(request.url.origin)
-        if (
-            connection.h11_connection is None
-            and connection.h2_connection is None
-        ):
-            await connection.connect(ssl=ssl, timeout=timeout)
-        if self._request_delay:
-            await asyncio.sleep(self._request_delay)
-        try:
-            response = await connection.send(
-                request, stream=stream, ssl=ssl, timeout=timeout
+    async def acquire_connection(self, origin, timeout=None):
+        connection = self.pop_connection(origin)
+
+        if connection is None:
+            pool_timeout = None if timeout is None else timeout.pool_timeout
+
+            await self.max_connections.acquire(timeout=pool_timeout)
+            connection = DelayableHTTPConnection(
+                origin,
+                verify=self.verify,
+                cert=self.cert,
+                http2=self.http2,
+                backend=self.backend,
+                release_func=self.release_connection,
+                trust_env=self.trust_env,
+                uds=self.uds,
+                request_delay=self._request_delay,
             )
-        except BaseException as exc:
-            self.active_connections.remove(connection)
-            self.max_connections.release()
-            raise exc
-        return response
+
+        self.active_connections.add(connection)
+
+        return connection
 
 
-class DelayableSanicAdapter(requests.adapters.HTTPAdapter):
-    def __init__(self, request_delay=None):
-        self.pool = DelayableSanicConnectionPool(request_delay=request_delay)
-
-
-class DelayableSanicSession(requests.Session):
+class DelayableSanicSession(httpx.Client):
     def __init__(self, request_delay=None, *args, **kwargs) -> None:
-        super().__init__(*args, **kwargs)
-        adapter = DelayableSanicAdapter(request_delay=request_delay)
-        self.mount("http://", adapter)
-        self.mount("https://", adapter)
+        dispatch = DelayableSanicConnectionPool(request_delay=request_delay)
+        super().__init__(dispatch=dispatch, *args, **kwargs)
 
 
 class DelayableSanicTestClient(SanicTestClient):

tests/test_requests.py

@@ -10,7 +10,7 @@ import pytest
 
 from sanic import Blueprint, Sanic
 from sanic.exceptions import ServerError
-from sanic.request import DEFAULT_HTTP_CONTENT_TYPE, RequestParameters
+from sanic.request import DEFAULT_HTTP_CONTENT_TYPE, Request, RequestParameters
 from sanic.response import json, text
 from sanic.testing import ASGI_HOST, HOST, PORT
 
@@ -55,11 +55,11 @@ def test_ip(app):
 async def test_ip_asgi(app):
     @app.route("/")
     def handler(request):
-        return text("{}".format(request.ip))
+        return text("{}".format(request.url))
 
     request, response = await app.asgi_client.get("/")
 
-    assert response.text == "mockserver"
+    assert response.text == "http://mockserver/"
 
 
 def test_text(app):
@@ -207,24 +207,24 @@ async def test_empty_json_asgi(app):
 
 
 def test_invalid_json(app):
-    @app.route("/")
+    @app.post("/")
     async def handler(request):
         return json(request.json)
 
     data = "I am not json"
-    request, response = app.test_client.get("/", data=data)
+    request, response = app.test_client.post("/", data=data)
 
     assert response.status == 400
 
 
 @pytest.mark.asyncio
 async def test_invalid_json_asgi(app):
-    @app.route("/")
+    @app.post("/")
     async def handler(request):
         return json(request.json)
 
     data = "I am not json"
-    request, response = await app.asgi_client.get("/", data=data)
+    request, response = await app.asgi_client.post("/", data=data)
 
     assert response.status == 400
 
@@ -244,6 +244,17 @@ def test_query_string(app):
     assert request.args.getlist("test1") == ["1"]
     assert request.args.get("test3", default="My value") == "My value"
 
+def test_popped_stays_popped(app):
+    @app.route("/")
+    async def handler(request):
+        return text("OK")
+
+    request, response = app.test_client.get(
+        "/", params=[("test1", "1")]
+    )
+
+    assert request.args.pop("test1") == ["1"]
+    assert "test1" not in request.args
 
 @pytest.mark.asyncio
 async def test_query_string_asgi(app):
@@ -401,8 +412,234 @@ async def test_content_type_asgi(app):
     assert response.text == "application/json"
 
 
+def test_standard_forwarded(app):
+    @app.route("/")
+    async def handler(request):
+        return json(request.forwarded)
+
+    # Without configured FORWARDED_SECRET, x-headers should be respected
+    app.config.PROXIES_COUNT = 1
+    app.config.REAL_IP_HEADER = "x-real-ip"
+    headers = {
+        "Forwarded": (
+            'for=1.1.1.1, for=injected;host="'
+            ', for="[::2]";proto=https;host=me.tld;path="/app/";secret=mySecret'
+            ",for=broken;;secret=b0rked"
+            ", for=127.0.0.3;scheme=http;port=1234"
+        ),
+        "X-Real-IP": "127.0.0.2",
+        "X-Forwarded-For": "127.0.1.1",
+        "X-Scheme": "ws",
+    }
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {"for": "127.0.0.2", "proto": "ws"}
+    assert request.remote_addr == "127.0.0.2"
+    assert request.scheme == "ws"
+    assert request.server_port == 80
+
+    app.config.FORWARDED_SECRET = "mySecret"
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {
+        "for": "[::2]",
+        "proto": "https",
+        "host": "me.tld",
+        "path": "/app/",
+        "secret": "mySecret",
+    }
+    assert request.remote_addr == "[::2]"
+    assert request.server_name == "me.tld"
+    assert request.scheme == "https"
+    assert request.server_port == 443
+
+    # Empty Forwarded header -> use X-headers
+    headers["Forwarded"] = ""
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {"for": "127.0.0.2", "proto": "ws"}
+
+    # Header present but not matching anything
+    request, response = app.test_client.get("/", headers={"Forwarded": "."})
+    assert response.json == {}
+
+    # Forwarded header present but no matching secret -> use X-headers
+    headers = {
+        "Forwarded": "for=1.1.1.1;secret=x, for=127.0.0.1",
+        "X-Real-IP": "127.0.0.2",
+    }
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {"for": "127.0.0.2"}
+    assert request.remote_addr == "127.0.0.2"
+
+    # Different formatting and hitting both ends of the header
+    headers = {"Forwarded": 'Secret="mySecret";For=127.0.0.4;Port=1234'}
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {
+        "for": "127.0.0.4",
+        "port": 1234,
+        "secret": "mySecret",
+    }
+
+    # Test escapes (modify this if you see anyone implementing quoted-pairs)
+    headers = {"Forwarded": 'for=test;quoted="\\,x=x;y=\\";secret=mySecret'}
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {
+        "for": "test",
+        "quoted": "\\,x=x;y=\\",
+        "secret": "mySecret",
+    }
+
+    # Secret insulated by malformed field #1
+    headers = {"Forwarded": "for=test;secret=mySecret;b0rked;proto=wss;"}
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {"for": "test", "secret": "mySecret"}
+
+    # Secret insulated by malformed field #2
+    headers = {"Forwarded": "for=test;b0rked;secret=mySecret;proto=wss"}
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {"proto": "wss", "secret": "mySecret"}
+
+    # Unexpected termination should not lose existing acceptable values
+    headers = {"Forwarded": "b0rked;secret=mySecret;proto=wss"}
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {"proto": "wss", "secret": "mySecret"}
+
+    # Field normalization
+    headers = {
+        "Forwarded": 'PROTO=WSS;BY="CAFE::8000";FOR=unknown;PORT=X;HOST="A:2";'
+        'PATH="/With%20Spaces%22Quoted%22/sanicApp?key=val";SECRET=mySecret'
+    }
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {
+        "proto": "wss",
+        "by": "[cafe::8000]",
+        "host": "a:2",
+        "path": '/With Spaces"Quoted"/sanicApp?key=val',
+        "secret": "mySecret",
+    }
+
+    # Using "by" field as secret
+    app.config.FORWARDED_SECRET = "_proxySecret"
+    headers = {"Forwarded": "for=1.2.3.4; by=_proxySecret"}
+    request, response = app.test_client.get("/", headers=headers)
+    assert response.json == {"for": "1.2.3.4", "by": "_proxySecret"}
+
+
+@pytest.mark.asyncio
+async def test_standard_forwarded_asgi(app):
+    @app.route("/")
+    async def handler(request):
+        return json(request.forwarded)
+
+    # Without configured FORWARDED_SECRET, x-headers should be respected
+    app.config.PROXIES_COUNT = 1
+    app.config.REAL_IP_HEADER = "x-real-ip"
+    headers = {
+        "Forwarded": (
+            'for=1.1.1.1, for=injected;host="'
+            ', for="[::2]";proto=https;host=me.tld;path="/app/";secret=mySecret'
+            ",for=broken;;secret=b0rked"
+            ", for=127.0.0.3;scheme=http;port=1234"
+        ),
+        "X-Real-IP": "127.0.0.2",
+        "X-Forwarded-For": "127.0.1.1",
+        "X-Scheme": "ws",
+    }
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {"for": "127.0.0.2", "proto": "ws"}
+    assert request.remote_addr == "127.0.0.2"
+    assert request.scheme == "ws"
+    assert request.server_port == 80
+
+    app.config.FORWARDED_SECRET = "mySecret"
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {
+        "for": "[::2]",
+        "proto": "https",
+        "host": "me.tld",
+        "path": "/app/",
+        "secret": "mySecret",
+    }
+    assert request.remote_addr == "[::2]"
+    assert request.server_name == "me.tld"
+    assert request.scheme == "https"
+    assert request.server_port == 443
+
+    # Empty Forwarded header -> use X-headers
+    headers["Forwarded"] = ""
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {"for": "127.0.0.2", "proto": "ws"}
+
+    # Header present but not matching anything
+    request, response = await app.asgi_client.get(
+        "/", headers={"Forwarded": "."}
+    )
+    assert response.json() == {}
+
+    # Forwarded header present but no matching secret -> use X-headers
+    headers = {
+        "Forwarded": "for=1.1.1.1;secret=x, for=127.0.0.1",
+        "X-Real-IP": "127.0.0.2",
+    }
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {"for": "127.0.0.2"}
+    assert request.remote_addr == "127.0.0.2"
+
+    # Different formatting and hitting both ends of the header
+    headers = {"Forwarded": 'Secret="mySecret";For=127.0.0.4;Port=1234'}
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {
+        "for": "127.0.0.4",
+        "port": 1234,
+        "secret": "mySecret",
+    }
+
+    # Test escapes (modify this if you see anyone implementing quoted-pairs)
+    headers = {"Forwarded": 'for=test;quoted="\\,x=x;y=\\";secret=mySecret'}
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {
+        "for": "test",
+        "quoted": "\\,x=x;y=\\",
+        "secret": "mySecret",
+    }
+
+    # Secret insulated by malformed field #1
+    headers = {"Forwarded": "for=test;secret=mySecret;b0rked;proto=wss;"}
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {"for": "test", "secret": "mySecret"}
+
+    # Secret insulated by malformed field #2
+    headers = {"Forwarded": "for=test;b0rked;secret=mySecret;proto=wss"}
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {"proto": "wss", "secret": "mySecret"}
+
+    # Unexpected termination should not lose existing acceptable values
+    headers = {"Forwarded": "b0rked;secret=mySecret;proto=wss"}
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {"proto": "wss", "secret": "mySecret"}
+
+    # Field normalization
+    headers = {
+        "Forwarded": 'PROTO=WSS;BY="CAFE::8000";FOR=unknown;PORT=X;HOST="A:2";'
+        'PATH="/With%20Spaces%22Quoted%22/sanicApp?key=val";SECRET=mySecret'
+    }
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {
+        "proto": "wss",
+        "by": "[cafe::8000]",
+        "host": "a:2",
+        "path": '/With Spaces"Quoted"/sanicApp?key=val',
+        "secret": "mySecret",
+    }
+
+    # Using "by" field as secret
+    app.config.FORWARDED_SECRET = "_proxySecret"
+    headers = {"Forwarded": "for=1.2.3.4; by=_proxySecret"}
+    request, response = await app.asgi_client.get("/", headers=headers)
+    assert response.json() == {"for": "1.2.3.4", "by": "_proxySecret"}
+
+
 def test_remote_addr_with_two_proxies(app):
     app.config.PROXIES_COUNT = 2
+    app.config.REAL_IP_HEADER = "x-real-ip"
 
     @app.route("/")
     async def handler(request):
@@ -443,6 +680,7 @@ def test_remote_addr_with_two_proxies(app):
 @pytest.mark.asyncio
 async def test_remote_addr_with_two_proxies_asgi(app):
     app.config.PROXIES_COUNT = 2
+    app.config.REAL_IP_HEADER = "x-real-ip"
 
     @app.route("/")
     async def handler(request):
@@ -480,57 +718,6 @@ async def test_remote_addr_with_two_proxies_asgi(app):
     assert response.text == "127.0.0.1"
 
 
-def test_remote_addr_with_infinite_number_of_proxies(app):
-    app.config.PROXIES_COUNT = -1
-
-    @app.route("/")
-    async def handler(request):
-        return text(request.remote_addr)
-
-    headers = {"X-Real-IP": "127.0.0.2", "X-Forwarded-For": "127.0.1.1"}
-    request, response = app.test_client.get("/", headers=headers)
-    assert request.remote_addr == "127.0.0.2"
-    assert response.text == "127.0.0.2"
-
-    headers = {"X-Forwarded-For": "127.0.1.1"}
-    request, response = app.test_client.get("/", headers=headers)
-    assert request.remote_addr == "127.0.1.1"
-    assert response.text == "127.0.1.1"
-
-    headers = {
-        "X-Forwarded-For": "127.0.0.5, 127.0.0.4, 127.0.0.3, 127.0.0.2, 127.0.0.1"
-    }
-    request, response = app.test_client.get("/", headers=headers)
-    assert request.remote_addr == "127.0.0.5"
-    assert response.text == "127.0.0.5"
-
-
-@pytest.mark.asyncio
-async def test_remote_addr_with_infinite_number_of_proxies_asgi(app):
-    app.config.PROXIES_COUNT = -1
-
-    @app.route("/")
-    async def handler(request):
-        return text(request.remote_addr)
-
-    headers = {"X-Real-IP": "127.0.0.2", "X-Forwarded-For": "127.0.1.1"}
-    request, response = await app.asgi_client.get("/", headers=headers)
-    assert request.remote_addr == "127.0.0.2"
-    assert response.text == "127.0.0.2"
-
-    headers = {"X-Forwarded-For": "127.0.1.1"}
-    request, response = await app.asgi_client.get("/", headers=headers)
-    assert request.remote_addr == "127.0.1.1"
-    assert response.text == "127.0.1.1"
-
-    headers = {
-        "X-Forwarded-For": "127.0.0.5, 127.0.0.4, 127.0.0.3, 127.0.0.2, 127.0.0.1"
-    }
-    request, response = await app.asgi_client.get("/", headers=headers)
-    assert request.remote_addr == "127.0.0.5"
-    assert response.text == "127.0.0.5"
-
-
 def test_remote_addr_without_proxy(app):
     app.config.PROXIES_COUNT = 0
 
@@ -629,6 +816,27 @@ async def test_remote_addr_custom_headers_asgi(app):
     assert response.text == "127.0.0.2"
 
 
+def test_forwarded_scheme(app):
+    @app.route("/")
+    async def handler(request):
+        return text(request.remote_addr)
+
+    app.config.PROXIES_COUNT = 1
+    request, response = app.test_client.get("/")
+    assert request.scheme == "http"
+
+    request, response = app.test_client.get(
+        "/",
+        headers={"X-Forwarded-For": "127.1.2.3", "X-Forwarded-Proto": "https"},
+    )
+    assert request.scheme == "https"
+
+    request, response = app.test_client.get(
+        "/", headers={"X-Forwarded-For": "127.1.2.3", "X-Scheme": "https"}
+    )
+    assert request.scheme == "https"
+
+
 def test_match_info(app):
     @app.route("/api/v1/user/<user_id>/")
     async def handler(request, user_id):
@@ -1307,9 +1515,6 @@ def test_request_bool(app):
     request, response = app.test_client.get("/")
     assert bool(request)
 
-    request.transport = False
-    assert not bool(request)
-
 
 def test_request_parsing_form_failed(app, caplog):
     @app.route("/", methods=["POST"])
@@ -1613,26 +1818,6 @@ def test_request_port(app):
     assert hasattr(request, "_port")
 
 
-@pytest.mark.asyncio
-async def test_request_port_asgi(app):
-    @app.get("/")
-    def handler(request):
-        return text("OK")
-
-    request, response = await app.asgi_client.get("/")
-
-    port = request.port
-    assert isinstance(port, int)
-
-    delattr(request, "_socket")
-    delattr(request, "_port")
-
-    port = request.port
-    assert isinstance(port, int)
-    assert hasattr(request, "_socket")
-    assert hasattr(request, "_port")
-
-
 def test_request_socket(app):
     @app.get("/")
     def handler(request):
@@ -1656,6 +1841,100 @@ def test_request_socket(app):
     assert hasattr(request, "_socket")
 
 
+def test_request_server_name(app):
+    @app.get("/")
+    def handler(request):
+        return text("OK")
+
+    request, response = app.test_client.get("/")
+    assert request.server_name == "127.0.0.1"
+
+
+def test_request_server_name_in_host_header(app):
+    @app.get("/")
+    def handler(request):
+        return text("OK")
+
+    request, response = app.test_client.get(
+        "/", headers={"Host": "my-server:5555"}
+    )
+    assert request.server_name == "my-server"
+
+    request, response = app.test_client.get(
+        "/", headers={"Host": "[2a00:1450:400f:80c::200e]:5555"}
+    )
+    assert request.server_name == "[2a00:1450:400f:80c::200e]"
+
+    request, response = app.test_client.get(
+        "/", headers={"Host": "mal_formed"}
+    )
+    assert request.server_name == None  # For now (later maybe 127.0.0.1)
+
+
+def test_request_server_name_forwarded(app):
+    @app.get("/")
+    def handler(request):
+        return text("OK")
+
+    app.config.PROXIES_COUNT = 1
+    request, response = app.test_client.get(
+        "/",
+        headers={
+            "Host": "my-server:5555",
+            "X-Forwarded-For": "127.1.2.3",
+            "X-Forwarded-Host": "your-server",
+        },
+    )
+    assert request.server_name == "your-server"
+
+
+def test_request_server_port(app):
+    @app.get("/")
+    def handler(request):
+        return text("OK")
+
+    request, response = app.test_client.get("/", headers={"Host": "my-server"})
+    assert request.server_port == app.test_client.port
+
+
+def test_request_server_port_in_host_header(app):
+    @app.get("/")
+    def handler(request):
+        return text("OK")
+
+    request, response = app.test_client.get(
+        "/", headers={"Host": "my-server:5555"}
+    )
+    assert request.server_port == 5555
+
+    request, response = app.test_client.get(
+        "/", headers={"Host": "[2a00:1450:400f:80c::200e]:5555"}
+    )
+    assert request.server_port == 5555
+
+    request, response = app.test_client.get(
+        "/", headers={"Host": "mal_formed:5555"}
+    )
+    assert request.server_port == app.test_client.port
+
+
+def test_request_server_port_forwarded(app):
+    @app.get("/")
+    def handler(request):
+        return text("OK")
+
+    app.config.PROXIES_COUNT = 1
+    request, response = app.test_client.get(
+        "/",
+        headers={
+            "Host": "my-server:5555",
+            "X-Forwarded-For": "127.1.2.3",
+            "X-Forwarded-Port": "4444",
+        },
+    )
+    assert request.server_port == 4444
+
+
 def test_request_form_invalid_content_type(app):
     @app.route("/", methods=["POST"])
     async def post(request):
@@ -1666,6 +1945,65 @@ def test_request_form_invalid_content_type(app):
     assert request.form == {}
 
 
+def test_server_name_and_url_for(app):
+    @app.get("/foo")
+    def handler(request):
+        return text("ok")
+
+    app.config.SERVER_NAME = "my-server"
+    assert app.url_for("handler", _external=True) == "http://my-server/foo"
+    request, response = app.test_client.get("/foo")
+    assert (
+        request.url_for("handler")
+        == f"http://my-server:{app.test_client.port}/foo"
+    )
+
+    app.config.SERVER_NAME = "https://my-server/path"
+    request, response = app.test_client.get("/foo")
+    url = f"https://my-server/path/foo"
+    assert app.url_for("handler", _external=True) == url
+    assert request.url_for("handler") == url
+
+
+def test_url_for_with_forwarded_request(app):
+    @app.get("/")
+    def handler(request):
+        return text("OK")
+
+    @app.get("/another_view/")
+    def view_name(request):
+        return text("OK")
+
+    app.config.SERVER_NAME = "my-server"
+    app.config.PROXIES_COUNT = 1
+    request, response = app.test_client.get(
+        "/",
+        headers={
+            "X-Forwarded-For": "127.1.2.3",
+            "X-Forwarded-Proto": "https",
+            "X-Forwarded-Port": "6789",
+        },
+    )
+    assert app.url_for("view_name") == "/another_view"
+    assert (
+        app.url_for("view_name", _external=True)
+        == "http://my-server/another_view"
+    )
+    assert (
+        request.url_for("view_name") == "https://my-server:6789/another_view"
+    )
+
+    request, response = app.test_client.get(
+        "/",
+        headers={
+            "X-Forwarded-For": "127.1.2.3",
+            "X-Forwarded-Proto": "https",
+            "X-Forwarded-Port": "443",
+        },
+    )
+    assert request.url_for("view_name") == "https://my-server/another_view"
+
+
 @pytest.mark.asyncio
 async def test_request_form_invalid_content_type_asgi(app):
     @app.route("/", methods=["POST"])
@@ -1756,3 +2094,19 @@ async def test_endpoint_blueprint_asgi():
     request, response = await app.asgi_client.get("/bp")
 
     assert request.endpoint == "named.my_blueprint.bp_root"
+
+
+def test_url_for_without_server_name(app):
+    @app.route("/sample")
+    def sample(request):
+        return json({"url": request.url_for("url_for")})
+
+    @app.route("/url-for")
+    def url_for(request):
+        return text("url-for")
+
+    request, response = app.test_client.get("/sample")
+    assert (
+        response.json["url"]
+        == f"http://127.0.0.1:{app.test_client.port}/url-for"
+    )

tests/test_response.py

@@ -15,6 +15,7 @@ from aiofiles import os as async_os
 from sanic.response import (
     HTTPResponse,
     StreamingHTTPResponse,
+    empty,
     file,
     file_stream,
     json,
@@ -231,6 +232,12 @@ def test_chunked_streaming_returns_correct_content(streaming_app):
     assert response.text == "foo,bar"
 
 
+@pytest.mark.asyncio
+async def test_chunked_streaming_returns_correct_content_asgi(streaming_app):
+    request, response = await streaming_app.asgi_client.get("/")
+    assert response.text == "foo,bar"
+
+
 def test_non_chunked_streaming_adds_correct_headers(non_chunked_streaming_app):
     request, response = non_chunked_streaming_app.test_client.get("/")
     assert "Transfer-Encoding" not in response.headers
@@ -238,8 +245,18 @@ def test_non_chunked_streaming_adds_correct_headers(non_chunked_streaming_app):
     assert response.headers["Content-Length"] == "7"
 
 
+@pytest.mark.asyncio
+async def test_non_chunked_streaming_adds_correct_headers_asgi(
+    non_chunked_streaming_app,
+):
+    request, response = await non_chunked_streaming_app.asgi_client.get("/")
+    assert "Transfer-Encoding" not in response.headers
+    assert response.headers["Content-Type"] == "text/csv"
+    assert response.headers["Content-Length"] == "7"
+
+
 def test_non_chunked_streaming_returns_correct_content(
-    non_chunked_streaming_app
+    non_chunked_streaming_app,
 ):
     request, response = non_chunked_streaming_app.test_client.get("/")
     assert response.text == "foo,bar"
@@ -254,7 +271,7 @@ def test_stream_response_status_returns_correct_headers(status):
 
 @pytest.mark.parametrize("keep_alive_timeout", [10, 20, 30])
 def test_stream_response_keep_alive_returns_correct_headers(
-    keep_alive_timeout
+    keep_alive_timeout,
 ):
     response = StreamingHTTPResponse(sample_streaming_fn)
     headers = response.get_headers(
@@ -283,7 +300,7 @@ def test_stream_response_does_not_include_chunked_header_if_disabled():
 
 
 def test_stream_response_writes_correct_content_to_transport_when_chunked(
-    streaming_app
+    streaming_app,
 ):
     response = StreamingHTTPResponse(sample_streaming_fn)
     response.protocol = MagicMock(HttpProtocol)
@@ -591,3 +608,13 @@ def test_raw_response(app):
     request, response = app.test_client.get("/test")
     assert response.content_type == "application/octet-stream"
     assert response.body == b"raw_response"
+
+
+def test_empty_response(app):
+    @app.get("/test")
+    def handler(request):
+        return empty()
+
+    request, response = app.test_client.get("/test")
+    assert response.content_type is None
+    assert response.body == b""

tests/test_routes.py

@@ -551,6 +551,35 @@ def test_route_duplicate(app):
             pass
 
 
+def test_double_stack_route(app):
+    @app.route("/test/1")
+    @app.route("/test/2")
+    async def handler1(request):
+        return text("OK")
+
+    request, response = app.test_client.get("/test/1")
+    assert response.status == 200
+    request, response = app.test_client.get("/test/2")
+    assert response.status == 200
+
+
+@pytest.mark.asyncio
+async def test_websocket_route_asgi(app):
+    ev = asyncio.Event()
+
+    @app.websocket("/test/1")
+    @app.websocket("/test/2")
+    async def handler(request, ws):
+        ev.set()
+
+    request, response = await app.asgi_client.websocket("/test/1")
+    first_set = ev.is_set()
+    ev.clear()
+    request, response = await app.asgi_client.websocket("/test/1")
+    second_set = ev.is_set()
+    assert first_set and second_set
+
+
 def test_method_not_allowed(app):
     @app.route("/test", methods=["GET"])
     async def handler(request):

tests/test_server_events.py

@@ -1,3 +1,4 @@
+import asyncio
 import signal
 
 import pytest
@@ -89,3 +90,53 @@ async def test_trigger_before_events_create_server(app):
 
     assert hasattr(app, "db")
     assert isinstance(app.db, MySanicDb)
+
+
+def test_create_server_trigger_events(app):
+    """Test if create_server can trigger server events"""
+
+    flag1 = False
+    flag2 = False
+    flag3 = False
+
+    async def stop(app, loop):
+        nonlocal flag1
+        flag1 = True
+        await asyncio.sleep(0.1)
+        app.stop()
+
+    async def before_stop(app, loop):
+        nonlocal flag2
+        flag2 = True
+
+    async def after_stop(app, loop):
+        nonlocal flag3
+        flag3 = True
+
+    app.listener("after_server_start")(stop)
+    app.listener("before_server_stop")(before_stop)
+    app.listener("after_server_stop")(after_stop)
+
+    loop = asyncio.get_event_loop()
+    serv_coro = app.create_server(return_asyncio_server=True)
+    serv_task = asyncio.ensure_future(serv_coro, loop=loop)
+    server = loop.run_until_complete(serv_task)
+    server.after_start()
+    try:
+        loop.run_forever()
+    except KeyboardInterrupt as e:
+        loop.stop()
+    finally:
+        # Run the on_stop function if provided
+        server.before_stop()
+
+        # Wait for server to close
+        close_task = server.close()
+        loop.run_until_complete(close_task)
+
+        # Complete all tasks on the loop
+        signal.stopped = True
+        for connection in server.connections:
+            connection.close_if_idle()
+        server.after_stop()
+    assert flag1 and flag2 and flag3

tests/test_utf8.py

@@ -37,14 +37,14 @@ def skip_test_utf8_route(app):
 
 
 def test_utf8_post_json(app):
-    @app.route("/")
+    @app.post("/")
     async def handler(request):
         return text("OK")
 
     payload = {"test": "✓"}
     headers = {"content-type": "application/json"}
 
-    request, response = app.test_client.get(
+    request, response = app.test_client.post(
         "/", data=json_dumps(payload), headers=headers
     )
 

tox.ini

@@ -1,25 +1,25 @@
 [tox]
-envlist = py36, py37, {py36,py37}-no-ext, lint, check
+envlist = py36, py37, pyNightly, {py36,py37,pyNightly}-no-ext, lint, check, security, docs
 
 [testenv]
 usedevelop = True
 setenv =
-    {py36,py37}-no-ext: SANIC_NO_UJSON=1
-    {py36,py37}-no-ext: SANIC_NO_UVLOOP=1
+    {py36,py37,pyNightly}-no-ext: SANIC_NO_UJSON=1
+    {py36,py37,pyNightly}-no-ext: SANIC_NO_UVLOOP=1
 deps =
     coverage
-    pytest==4.1.0
+    pytest==5.2.1
     pytest-cov
     pytest-sanic
     pytest-sugar
     httpcore==0.3.0
-    requests-async==0.5.0
-    chardet<=2.3.0
+    httpx==0.9.3
+    multidict==5.0.0
     beautifulsoup4
     gunicorn
     pytest-benchmark
     uvicorn
-    websockets>=6.0,<7.0
+    websockets>=7.0,<8.0
 commands =
     pytest {posargs:tests --cov sanic}
     - coverage combine --append
@@ -31,12 +31,20 @@ deps =
     flake8
     black
     isort
+    bandit
 
 commands =
     flake8 sanic
-    black --config ./.black.toml --check --verbose sanic
+    black --config ./.black.toml --check --verbose sanic/
     isort --check-only --recursive sanic
 
+[testenv:type-checking]
+deps =
+    mypy
+
+commands =
+    mypy sanic
+
 [testenv:check]
 deps =
     docutils
@@ -47,3 +55,24 @@ commands =
 [pytest]
 filterwarnings =
     ignore:.*async with lock.* instead:DeprecationWarning
+
+[testenv:security]
+deps =
+    bandit
+
+commands =
+    bandit --recursive sanic --skip B404,B101 --exclude sanic/reloader_helpers.py
+
+[testenv:docs]
+platform = linux|linux2|darwin
+whitelist_externals = make
+deps =
+    sphinx>=2.1.2
+    sphinx_rtd_theme>=0.4.3
+    recommonmark>=0.5.0
+    docutils
+    pygments
+    gunicorn
+
+commands =
+    make docs-test