Merge pull request #1438 from yunstanford/master

18.12 Release

.appveyor.yml

@@ -0,0 +1,32 @@
+version: "{branch}.{build}"
+
+environment:
+  matrix:
+    - TOXENV: py35-no-ext
+      PYTHON: "C:\\Python35-x64"
+      PYTHON_VERSION: "3.5.x"
+      PYTHON_ARCH: "64"
+
+    - TOXENV: py36-no-ext
+      PYTHON: "C:\\Python36-x64"
+      PYTHON_VERSION: "3.6.x"
+      PYTHON_ARCH: "64"
+
+    - TOXENV: py37-no-ext
+      PYTHON: "C:\\Python37-x64"
+      PYTHON_VERSION: "3.7.x"
+      PYTHON_ARCH: "64"
+
+init: SET "PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
+
+install:
+  - pip install tox
+
+build: off
+
+test_script: tox
+
+notifications:
+  - provider: Email
+    on_build_success: false
+    on_build_status_changed: false

.coveragerc

@@ -1,7 +1,7 @@
 [run]
 branch = True
 source = sanic
-omit = site-packages, sanic/utils.py
+omit = site-packages, sanic/utils.py, sanic/__main__.py
 
 [html]
 directory = coverage

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is, make sure to paste any exceptions and tracebacks.
+
+
+**Code snippet**
+Relevant source code, make sure to remove what is not necessary.
+
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+
+**Environment (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Version [e.g. 0.8.3]
+
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,16 @@
+---
+name: Feature request
+about: Suggest an idea for Sanic
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+
+**Additional context**
+Add any other context or sample code about the feature request here.

.github/ISSUE_TEMPLATE/help-wanted.md

@@ -0,0 +1,13 @@
+---
+name: Help wanted
+about: Do you need help? Try community.sanicframework.org
+
+---
+
+*DELETE ALL BEFORE POSTING*
+*Post your HELP WANTED questions on [the community forum](https://community.sanicframework.org/)*.
+
+Checkout the community forum before posting any question here.
+We prefer if you put these kinds of questions here:
+
+https://community.sanicframework.org/c/questions-and-help

.travis.yml

@@ -1,5 +1,4 @@
 sudo: false
-dist: precise
 language: python
 cache:
   directories:
@@ -14,17 +13,29 @@ matrix:
       python: 3.6
     - env: TOX_ENV=py36-no-ext
       python: 3.6
-    - env: TOX_ENV=flake8
+    - env: TOX_ENV=py37
+      python: 3.7
+      dist: xenial
+      sudo: true
+    - env: TOX_ENV=py37-no-ext
+      python: 3.7
+      dist: xenial
+      sudo: true
+    - env: TOX_ENV=lint
       python: 3.6
     - env: TOX_ENV=check
       python: 3.6
-install: pip install -U tox
-script: tox -e $TOX_ENV
+install:
+  - pip install -U tox
+  - pip install codecov
+script: travis_retry tox -e $TOX_ENV
+after_success:
+  - codecov
 deploy:
   provider: pypi
   user: channelcat
   password:
-    secure: OgADRQH3+dTL5swGzXkeRJDNbLpFzwqYnXB4iLD0Npvzj9QnKyQVvkbaeq6VmV9dpEFb5ULaAKYQq19CrXYDm28yanUSn6jdJ4SukaHusi7xt07U6H7pmoX/uZ2WZYqCSLM8cSp8TXY/3oV3rY5Jfj/AibE5XTbim5/lrhsvW6NR+ALzxc0URRPAHDZEPpojTCjSTjpY0aDsaKWg4mXVRMFfY3O68j6KaIoukIZLuoHfePLKrbZxaPG5VxNhMHEaICdxVxE/dO+7pQmQxXuIsEOHK1QiVJ9YrSGcNqgEqhN36kYP8dqMeVB07sv8Xa6o/Uax2/wXS2HEJvuwP1YD6WkoZuo9ZB85bcMdg7BV9jJDbVFVPJwc75BnTLHrMa3Q1KrRlKRDBUXBUsQivPuWhFNwUgvEayq2qSI3aRQR4Z0O+DfboEhXYojSoD64/EWBTZ7vhgbvOTGEdukUQSYrKj9P8jc1s8exomTsAiqdFxTUpzfiammUSL+M93lP4urtahl1jjXFX7gd3DzdEEb0NsGkx5lm/qdsty8/TeAvKUmC+RVU6T856W6MqN0P+yGbpWUARcSE7fwztC3SPxwAuxvIN3BHmRhOUHoORPNG2VpfbnscIzBKJR4v0JKzbpi0IDa66K+tCGsCEvQuL4cxVOtoUySPWNSUAyUWWUrGM2k=
+    secure: h7oNDjA/ObDBGK7xt55SV0INHOclMJW/byxMrNxvCZ0JxiRk7WBNtWYt0WJjyf5lO/L0/sfgiAk0GIdFon57S24njSLPAq/a4ptkWZ68s2A+TaF6ezJSZvE9V8khivjoeub90TzfX6P5aukRja1CSxXKJm+v0V8hGE4CZGyCgEDvK3JqIakpXllSDl19DhVftCS/lQZD7AXrZlg1kZnPCMtB5IbCVR4L2bfrSJVNptBi2CqqxacY2MOLu+jv5FzJ2BGVIJ2zoIJS2T+JmGJzpiamF6y8Amv0667i9lg2DXWCtI3PsQzCmwa3F/ZsI+ohUAvJC5yvzP7SyTJyXifRBdJ9O137QkNAHFoJOOY3B4GSnTo8/boajKXEqGiV4h2EgwNjBaR0WJl0pB7HHUCBMkNRWqo6ACB8eCr04tXWXPvkGIc+wPjq960hsUZea1O31MuktYc9Ot6eiFqm7OKoItdi7LxCen1eTj93ePgkiEnVZ+p/04Hh1U7CX31UJMNu5kCvZPIANnAuDsS2SK7Qkr88OAuWL0wmrBcXKOcnVkJtZ5mzx8T54bI1RrSYtFDBLFfOPb0GucSziMBtQpE76qPEauVwIXBk3RnR8N57xBR/lvTaIk758tf+haO0llEO5rVls1zLNZ+VlTzXy7hX0OZbdopIAcCFBFWqWMAdXQc=
   on:
     tags: true
   distributions: "sdist bdist_wheel"

CHANGELOG.md

@@ -1,3 +1,80 @@
+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
@@ -5,18 +82,18 @@ Version 0.1
  - 0.1.6
   - Static files
   - Lazy Cookie Loading
- - 0.1.5 
+ - 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 
+ - 0.1.4
   - Multiprocessing
  - 0.1.3
   - Blueprint support
   - Faster Response processing
- - 0.1.1 - 0.1.2 
+ - 0.1.1 - 0.1.2
   - Struggling to update pypi via CI
- - 0.1.0 
-  - Released to public
+ - 0.1.0
+  - Released to public

Dockerfile

@@ -1,6 +0,0 @@
-FROM python:3.6
-
-ADD . /app
-WORKDIR /app
-
-RUN pip install tox

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) [year] [fullname]
+Copyright (c) 2016-present Channel Cat
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

MANIFEST.in

@@ -1,4 +1,7 @@
 include README.rst
+include MANIFEST.in
+include LICENSE
+include setup.py
 
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

Makefile

@@ -1,4 +1,4 @@
 test:
 	find . -name "*.pyc" -delete
-	docker build -t sanic/test-image .
+	docker build -t sanic/test-image -f docker/Dockerfile .
 	docker run -t sanic/test-image tox

README.rst

@@ -1,15 +1,15 @@
 Sanic
 =====
 
-|Join the chat at https://gitter.im/sanic-python/Lobby| |Build Status| |PyPI| |PyPI version|
+|Join the chat at https://gitter.im/sanic-python/Lobby| |Build Status| |AppVeyor Build Status| |Documentation| |Codecov| |PyPI| |PyPI version| |Code style black|
 
 Sanic is a Flask-like Python 3.5+ web server that's written to go fast.  It's based on the work done by the amazing folks at magicstack, and was inspired by `this article <https://magic.io/blog/uvloop-blazing-fast-python-networking/>`_.
 
 On top of being Flask-like, Sanic supports async request handlers.  This means you can use the new shiny async/await syntax from Python 3.5, making your code non-blocking and speedy.
 
-Sanic is developed `on GitHub <https://github.com/channelcat/sanic/>`_. Contributions are welcome!
+Sanic is developed `on GitHub <https://github.com/huge-success/sanic/>`_. We also have `a community discussion board <https://community.sanicframework.org/>`_. Contributions are welcome!
 
-If you have a project that utilizes Sanic make sure to comment on the `issue <https://github.com/channelcat/sanic/issues/396>`_ that we use to track those projects!
+If you have a project that utilizes Sanic make sure to comment on the `issue <https://github.com/huge-success/sanic/issues/396>`_ that we use to track those projects!
 
 Hello World Example
 -------------------
@@ -21,23 +21,23 @@ Hello World Example
 
     app = Sanic()
 
-    @app.route("/")
+    @app.route('/')
     async def test(request):
-        return json({"hello": "world"})
+        return json({'hello': 'world'})
 
-    if __name__ == "__main__":
-        app.run(host="0.0.0.0", port=8000)
+    if __name__ == '__main__':
+        app.run(host='0.0.0.0', port=8000)
 
 Installation
 ------------
 
--  ``python -m pip install sanic``
+-  ``pip install sanic``
 
-To install sanic without uvloop or json using bash, you can provide either or both of these environmental variables
+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 NO_X to true will stop that features
 installation.
 
-- ``SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true python -m pip install sanic``
+- ``SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true pip install sanic``
 
 
 Documentation
@@ -47,33 +47,36 @@ Documentation
 
 .. |Join the chat at https://gitter.im/sanic-python/Lobby| image:: https://badges.gitter.im/sanic-python/Lobby.svg
    :target: https://gitter.im/sanic-python/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
-.. |Build Status| image:: https://travis-ci.org/channelcat/sanic.svg?branch=master
-   :target: https://travis-ci.org/channelcat/sanic
+.. |Codecov| image:: https://codecov.io/gh/huge-success/sanic/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/huge-success/sanic
+.. |Build Status| image:: https://travis-ci.org/huge-success/sanic.svg?branch=master
+   :target: https://travis-ci.org/huge-success/sanic
+.. |AppVeyor Build Status| image:: https://ci.appveyor.com/api/projects/status/d8pt3ids0ynexi8c/branch/master?svg=true
+   :target: https://ci.appveyor.com/project/huge-success/sanic
 .. |Documentation| image:: https://readthedocs.org/projects/sanic/badge/?version=latest
    :target: http://sanic.readthedocs.io/en/latest/?badge=latest
 .. |PyPI| image:: https://img.shields.io/pypi/v/sanic.svg
    :target: https://pypi.python.org/pypi/sanic/
 .. |PyPI version| image:: https://img.shields.io/pypi/pyversions/sanic.svg
    :target: https://pypi.python.org/pypi/sanic/
+.. |Code style black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/ambv/black
    
+Questions and Discussion
+------------------------
+
+`Ask a question or join the conversation <https://community.sanicframework.org/>`_.
+
 
 Examples
 --------
-`Non-Core examples <https://github.com/channelcat/sanic/wiki/Examples/>`_. Examples of plugins and Sanic that are outside the scope of Sanic core.
+`Non-Core examples <https://github.com/huge-success/sanic/wiki/Examples/>`_. Examples of plugins and Sanic that are outside the scope of Sanic core.
 
-`Extensions <https://github.com/channelcat/sanic/wiki/Extensions/>`_. Sanic extensions created by the community.
+`Extensions <https://github.com/huge-success/sanic/wiki/Extensions/>`_. Sanic extensions created by the community.
 
-`Projects <https://github.com/channelcat/sanic/wiki/Projects/>`_. Sanic in production use.
+`Projects <https://github.com/huge-success/sanic/wiki/Projects/>`_. Sanic in production use.
 
 
-TODO
-----
- * http2
-
-Limitations
------------
-* No wheels for uvloop and httptools on Windows :(
-
 Final Thoughts
 --------------
 

docker/Dockerfile

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

docker/bin/entrypoint.sh

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

docker/bin/install_python.sh

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

docs/conf.py

@@ -25,7 +25,7 @@ import sanic
 
 # -- General configuration ------------------------------------------------
 
-extensions = ['sphinx.ext.autodoc']
+extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.asyncio']
 
 templates_path = ['_templates']
 

docs/index.rst

@@ -14,14 +14,18 @@ Guides
    sanic/exceptions
    sanic/middleware
    sanic/blueprints
+   sanic/websocket
    sanic/config
    sanic/cookies
    sanic/decorators
    sanic/streaming
    sanic/class_based_views
    sanic/custom_protocol
+   sanic/sockets
    sanic/ssl
    sanic/logging
+   sanic/versioning
+   sanic/debug_mode
    sanic/testing
    sanic/deploying
    sanic/extensions

docs/sanic/blueprints.md

@@ -48,7 +48,74 @@ 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=None, pattern=re.compile('^/$'), parameters=[])]
+[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
@@ -93,7 +160,14 @@ def ignore_404s(request, exception):
 Static files can be served globally, under the blueprint prefix.
 
 ```python
-bp.static('/folder/to/serve', '/web/path')
+
+# 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
@@ -172,7 +246,7 @@ takes the format `<blueprint_name>.<handler_name>`. For example:
 ```python
 @blueprint_v1.route('/')
 async def root(request):
-    url = app.url_for('v1.post_handler', post_id=5) # --> '/v1/post/5'
+    url = request.app.url_for('v1.post_handler', post_id=5) # --> '/v1/post/5'
     return redirect(url)
 
 
@@ -180,5 +254,3 @@ async def root(request):
 async def post_handler(request, post_id):
     return text('Post {} in Blueprint V1'.format(post_id))
 ```
-
-

docs/sanic/class_based_views.md

@@ -92,10 +92,27 @@ class ViewWithDecorator(HTTPMethodView):
   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')
 ```
 
-#### URL Building
+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:

docs/sanic/config.md

@@ -29,9 +29,15 @@ In general the convention is to only have UPPERCASE configuration parameters. Th
 
 There are several ways how to load configuration.
 
-### From environment variables.
+### 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. You can pass the `load_env` boolean to the Sanic constructor to override that:
+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)
@@ -79,8 +85,37 @@ DB_USER = 'appuser'
 
 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_TIMEOUT   | 60        | How long a request can take (sec) |
-    | KEEP_ALIVE        | True      | Disables keep-alive when False    |
+    | Variable                  | Default   | Description                                            |
+    | ------------------------- | --------- | ------------------------------------------------------ |
+    | REQUEST_MAX_SIZE          | 100000000 | How big a request may be (bytes)                       |
+    | 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 take to force close non-idle connection (sec) |
+    | ACCESS_LOG                | True      | Disable or enable access log                           |
+
+### The different Timeout variables:
+
+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 a HTTP 408 response and sends that to the client. Adjust this value higher if your clients routinely pass very large request payloads or upload requests very slowly.
+
+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 a HTTP 503 response and sets that to the client. Adjust this value higher if your application is likely to have long-running process that delay the generation of a response.
+
+### What is Keep Alive? And what does the Keep Alive Timeout value do?
+
+Keep-Alive is a HTTP feature indroduced in HTTP 1.1. When sending a HTTP request, the client (usually a web browser application) can set a Keep-Alive header to indicate for 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
+```

docs/sanic/contributing.md

@@ -29,8 +29,8 @@ See it's that simple!
 ## Pull requests!
 
 So the pull request approval rules are pretty simple:
-1. All pull requests must pass unit tests
-* All pull requests must be reviewed and approved by at least 
+* 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

docs/sanic/debug_mode.rst

@@ -0,0 +1,53 @@
+Debug Mode
+=============
+
+When enabling Sanic's debug mode, Sanic will provide a more verbose logging output
+and by default will enable the Auto Reload feature.
+
+.. warning::
+
+    Sanic's debug more will slow down the server's performance
+    and is therefore advised to enable it only in development environments.
+
+
+Setting the debug mode
+----------------------
+
+By setting the ``debug`` mode a more verbose output from Sanic will be outputed
+and the Automatic Reloader will be activated.
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+
+    app = Sanic()
+
+    @app.route('/')
+    async def hello_world(request):
+        return json({"hello": "world"})
+
+    if __name__ == '__main__':
+        app.run(host="0.0.0.0", port=8000, debug=True)
+
+
+
+Manually setting auto reload
+----------------------------
+
+Sanic offers a way to enable or disable the Automatic Reloader manually,
+the ``auto_reload`` argument will activate or deactivate the Automatic Reloader.
+
+.. code-block:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+
+    app = Sanic()
+
+    @app.route('/')
+    async def hello_world(request):
+        return json({"hello": "world"})
+
+    if __name__ == '__main__':
+        app.run(host="0.0.0.0", port=8000, auto_reload=True)

docs/sanic/decorators.md

@@ -34,6 +34,6 @@ def authorized():
 @app.route("/")
 @authorized()
 async def test(request):
-    return json({status: 'authorized'})
+    return json({'status': 'authorized'})
 ``` 
 

docs/sanic/exceptions.md

@@ -13,7 +13,7 @@ To throw an exception, simply `raise` the relevant exception from the
 from sanic.exceptions import ServerError
 
 @app.route('/killme')
-def i_am_ready_to_die(request):
+async def i_am_ready_to_die(request):
 	raise ServerError("Something bad happened", status_code=500)
 ```
 
@@ -24,7 +24,7 @@ from sanic.exceptions import abort
 from sanic.response import text
 
 @app.route('/youshallnotpass')
-def no_no(request):
+async def no_no(request):
         abort(401)
         # this won't happen
         text("OK")
@@ -43,10 +43,40 @@ from sanic.response import text
 from sanic.exceptions import NotFound
 
 @app.exception(NotFound)
-def ignore_404s(request, exception):
+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 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:

docs/sanic/extensions.md

@@ -1,12 +1,14 @@
 # Extensions
 
 A list of Sanic extensions created by the community.
-
+- [Sanic-Plugins-Framework](https://github.com/ashleysommer/sanicpluginsframework): Library for easily creating and using Sanic plugins.
 - [Sessions](https://github.com/subyraman/sanic_session): Support for sessions.
   Allows using redis, memcache or an in memory store.
 - [CORS](https://github.com/ashleysommer/sanic-cors): A port of flask-cors.
 - [Compress](https://github.com/subyraman/sanic_compress): Allows you to easily gzip Sanic responses. A port of Flask-Compress.
 - [Jinja2](https://github.com/lixxu/sanic-jinja2): Support for Jinja2 template.
+- [Sanic JWT](https://github.com/ahopkins/sanic-jwt): Authentication, JWT, and permission scoping for Sanic.
+- [Sanic-JWT-Extended](https://github.com/devArtoria/Sanic-JWT-Extended): Provides extended JWT support for Sanic
 - [OpenAPI/Swagger](https://github.com/channelcat/sanic-openapi): OpenAPI support, plus a Swagger UI.
 - [Pagination](https://github.com/lixxu/python-paginate): Simple pagination support.
 - [Motor](https://github.com/lixxu/sanic-motor): Simple motor wrapper.
@@ -18,6 +20,7 @@ A list of Sanic extensions created by the community.
 `Babel` library
 - [Dispatch](https://github.com/ashleysommer/sanic-dispatcher): A dispatcher inspired by `DispatcherMiddleware` in werkzeug. Can act as a Sanic-to-WSGI adapter.
 - [Sanic-OAuth](https://github.com/Sniedes722/Sanic-OAuth): OAuth Library for connecting to & creating your own token providers.
+- [sanic-oauth](https://gitlab.com/SirEdvin/sanic-oauth): OAuth Library with many provider and OAuth1/OAuth2 support.
 - [Sanic-nginx-docker-example](https://github.com/itielshwartz/sanic-nginx-docker-example): Simple and easy to use example of Sanic behined nginx using docker-compose.
 - [sanic-graphql](https://github.com/graphql-python/sanic-graphql): GraphQL integration with Sanic
 - [sanic-prometheus](https://github.com/dkruchinin/sanic-prometheus): Prometheus metrics for Sanic
@@ -25,3 +28,9 @@ A list of Sanic extensions created by the community.
 - [sanic-transmute](https://github.com/yunstanford/sanic-transmute): A Sanic extension that generates APIs from python function and classes, and also generates Swagger UI/documentation automatically.
 - [pytest-sanic](https://github.com/yunstanford/pytest-sanic): A pytest plugin for Sanic. It helps you to test your code asynchronously.
 - [jinja2-sanic](https://github.com/yunstanford/jinja2-sanic): a jinja2 template renderer for Sanic.([Documentation](http://jinja2-sanic.readthedocs.io/en/latest/))
+- [GINO](https://github.com/fantix/gino): An asyncio ORM on top of SQLAlchemy core, delivered with a Sanic extension. ([Documentation](https://python-gino.readthedocs.io/))
+- [Sanic-Auth](https://github.com/pyx/sanic-auth): A minimal backend agnostic session-based user authentication mechanism for Sanic.
+- [Sanic-CookieSession](https://github.com/pyx/sanic-cookiesession): A client-side only, cookie-based session, similar to the built-in session in Flask.
+- [Sanic-WTF](https://github.com/pyx/sanic-wtf): Sanic-WTF makes using WTForms with Sanic and CSRF (Cross-Site Request Forgery) protection a little bit easier.
+- [sanic-script](https://github.com/tim2anna/sanic-script): An extension for Sanic that adds support for writing commands to your application.
+- [sanic-sse](https://github.com/inn0kenty/sanic_sse): [Server-Sent Events](https://en.wikipedia.org/wiki/Server-sent_events) implementation for Sanic.

docs/sanic/getting_started.md

@@ -4,24 +4,37 @@ Make sure you have both [pip](https://pip.pypa.io/en/stable/installing/) and at
 least version 3.5 of Python before starting. Sanic uses the new `async`/`await`
 syntax, so earlier versions of python won't work.
 
-1. Install Sanic: `python3 -m pip install sanic`
-2. Create a file called `main.py` with the following code:
+## 1. Install Sanic
+
+  ```
+  python3 -m pip install sanic
+  ```
+
+##  2. Create a file called `main.py`
 
   ```python
   from sanic import Sanic
-  from sanic.response import text
+  from sanic.response import json
 
-  app = Sanic(__name__)
+  app = Sanic()
 
   @app.route("/")
   async def test(request):
-      return text('Hello world!')
+      return json({"hello": "world"})
 
-  app.run(host="0.0.0.0", port=8000, debug=True)
+  if __name__ == "__main__":
+      app.run(host="0.0.0.0", port=8000)
   ```
-  
-3. Run the server: `python3 main.py`
-4. Open the address `http://0.0.0.0:8000` in your web browser. You should see
-   the message *Hello world!*.
+
+## 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/logging.md

@@ -9,28 +9,44 @@ A simple example using default settings would be like this:
 
 ```python
 from sanic import Sanic
-from sanic.config import LOGGING
-
-# The default logging handlers are ['accessStream', 'errorStream']
-# but we change it to use other handlers here for demo purpose
-LOGGING['loggers']['network']['handlers'] = [
-    'accessSysLog', 'errorSysLog']
+from sanic.log import logger
+from sanic.response import text
 
 app = Sanic('test')
 
 @app.route('/')
 async def test(request):
-    return response.text('Hello World!')
+    logger.info('Here is your log')
+    return text('Hello World!')
 
 if __name__ == "__main__":
-  app.run(log_config=LOGGING)
+  app.run(debug=True, access_log=True)
 ```
 
-And to close logging, simply assign log_config=None:
+After the server is running, you can see some messages looks like:
+```
+[2018-11-06 21:16:53 +0800] [24622] [INFO] Goin' Fast @ http://127.0.0.1:8000
+[2018-11-06 21:16:53 +0800] [24667] [INFO] Starting worker [24667]
+```
+
+You can send a request to server and it will print the log messages:
+```
+[2018-11-06 21:18:53 +0800] [25685] [INFO] Here is your log
+[2018-11-06 21:18:53 +0800] - (sanic.access)[INFO][127.0.0.1:57038]: GET http://localhost:8000/  200 12
+```
+
+To use your own logging config, simply use `logging.config.dictConfig`, or
+pass `log_config` when you initialize `Sanic` app:
+
+```python
+app = Sanic('test', log_config=LOGGING_CONFIG)
+```
+
+And to close logging, simply assign access_log=False:
 
 ```python
 if __name__ == "__main__":
-  app.run(log_config=None)
+  app.run(access_log=False)
 ```
 
 This would skip calling logging functions when handling requests.
@@ -38,64 +54,29 @@ And you could even do further in production to gain extra speed:
 
 ```python
 if __name__ == "__main__":
-  # disable internal messages
-  app.run(debug=False, log_config=None)
+  # disable debug messages
+  app.run(debug=False, access_log=False)
 ```
 
 ### Configuration
 
-By default, log_config parameter is set to use sanic.config.LOGGING dictionary for configuration. The default configuration provides several predefined `handlers`:
+By default, log_config parameter is set to use sanic.log.LOGGING_CONFIG_DEFAULTS dictionary for configuration.
 
-- internal (using [logging.StreamHandler](https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler))<br>
-  For internal information console outputs.
+There are three `loggers` used in sanic, and **must be defined if you want to create your own logging configuration**:
 
-
-- accessStream (using [logging.StreamHandler](https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler))<br>
-  For requests information logging in console
-
-
-- errorStream (using [logging.StreamHandler](https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler))<br>
-  For error message and traceback logging in console.
-
-
-- accessSysLog (using [logging.handlers.SysLogHandler](https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler))<br>
-  For requests information logging to syslog.
-  Currently supports Windows (via localhost:514), Darwin (/var/run/syslog),
-  Linux (/dev/log) and FreeBSD (/dev/log).<br>
-  You would not be able to access this property if the directory doesn't exist.
-  (Notice that in Docker you have to enable everything by yourself)
-
-
-- errorSysLog (using [logging.handlers.SysLogHandler](https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler))<br>
-  For error message and traceback logging to syslog.
-  Currently supports Windows (via localhost:514), Darwin (/var/run/syslog),
-  Linux (/dev/log) and FreeBSD (/dev/log).<br>
-  You would not be able to access this property if the directory doesn't exist.
-  (Notice that in Docker you have to enable everything by yourself)
-
-
-And `filters`:
-
-- accessFilter (using sanic.log.DefaultFilter)<br>
-  The filter that allows only levels in `DEBUG`, `INFO`, and `NONE(0)`
-
-
-- errorFilter (using sanic.log.DefaultFilter)<br>
-  The filter that allows only levels in `WARNING`, `ERROR`, and `CRITICAL`
-
-There are two `loggers` used in sanic, and **must be defined if you want to create your own logging configuration**:
-
-- sanic:<br>
+- sanic.root:<br>
   Used to log internal messages.
 
+- sanic.error:<br>
+  Used to log error logs.
 
-- network:<br>
-  Used to log requests from network, and any information from those requests.
+- sanic.access:<br>
+  Used to log access logs.
 
 #### Log format:
 
 In addition to default parameters provided by python (asctime, levelname, message),
-Sanic provides additional parameters for network logger with accessFilter:
+Sanic provides additional parameters for access logger with:
 
 - host (str)<br>
   request.ip

docs/sanic/middleware.md

@@ -4,19 +4,20 @@ 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 providers listeners which allow you to run code at various points of your application's lifecycle.
+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'`. Response middleware
-receives both the request and the response as arguments.
+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:
 
-```python
+```
 @app.middleware('request')
 async def print_on_request(request):
 	print("I print when a request is received by the server")
@@ -32,7 +33,7 @@ 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.
 
-```python
+```
 app = Sanic(__name__)
 
 @app.middleware('response')
@@ -59,7 +60,7 @@ 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.
 
-```python
+```
 @app.middleware('request')
 async def halt_request(request):
 	return text('I halted the request')
@@ -78,11 +79,11 @@ If you want to execute startup/teardown code as your server starts or closes, yo
 - `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. 
+These listeners are implemented as decorators on functions which accept the app object as well as the asyncio loop.
 
 For example:
 
-```python
+```
 @app.listener('before_server_start')
 async def setup_db(app, loop):
     app.db = await db_setup()
@@ -100,13 +101,47 @@ 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.
 
-```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:
+
+```
+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/request_data.md

@@ -71,8 +71,16 @@ The following variables are accessible as properties on `Request` objects:
       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
@@ -95,6 +103,7 @@ The following variables are accessible as properties on `Request` objects:
 - `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=`
 
 
 ## Accessing values using `get` and `getlist`

docs/sanic/response.md

@@ -91,7 +91,7 @@ from sanic import response
 
 @app.route('/raw')
 def handle_request(request):
-    return response.raw('raw data')
+    return response.raw(b'raw data')
 ```
 
 ## Modify headers or status

docs/sanic/routing.md

@@ -138,13 +138,14 @@ app.add_route(person_handler2, '/person/<name:[A-z]>', methods=['GET'])
 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)
-
+    return redirect(url)    
 
 @app.route('/posts/<post_id>')
 async def post_handler(request, post_id):
@@ -214,3 +215,121 @@ 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)
+```
+
+## User defined route name
+
+You can pass `name` to change the route name to avoid using the default name  (`handler.__name__`).
+
+```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
+
+You can use `url_for` for static file url building now.
+If it's for file directly, `filename` can be ignored.
+
+```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/sockets.rst

@@ -0,0 +1,66 @@
+Sockets
+=======
+
+Sanic can use the python
+`socket module <https://docs.python.org/3/library/socket.html>`_ to accommodate
+non IPv4 sockets.
+
+IPv6 example:
+
+.. code:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+    import socket
+
+    sock = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
+    sock.bind(('::', 7777))
+
+    app = Sanic()
+
+
+    @app.route("/")
+    async def test(request):
+        return json({"hello": "world"})
+
+    if __name__ == "__main__":
+        app.run(sock=sock)
+
+to test IPv6 ``curl -g -6 "http://[::1]:7777/"``
+
+
+UNIX socket example:
+
+.. code:: python
+
+    import signal
+    import sys
+    import socket
+    import os
+    from sanic import Sanic
+    from sanic.response import json
+
+
+    server_socket = '/tmp/sanic.sock'
+
+    sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+    sock.bind(server_socket)
+
+    app = Sanic()
+
+
+    @app.route("/")
+    async def test(request):
+        return json({"hello": "world"})
+
+
+    def signal_handler(sig, frame):
+            print('Exiting')
+            os.unlink(server_socket)
+            sys.exit(0)
+
+
+    if __name__ == "__main__":
+        app.run(sock=sock)
+
+to test UNIX: ``curl -v --unix-socket /tmp/sanic.sock http://localhost/hello``

docs/sanic/static_files.md

@@ -1,21 +1,83 @@
 # 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
+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')
+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: currently you cannot build a URL for a static file using `url_for`. 
+> **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 spefic **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/streaming.md

@@ -37,7 +37,7 @@ async def handler(request):
             if body is None:
                 break
             body = body.decode('utf-8').replace('1', 'A')
-            response.write(body)
+            await response.write(body)
     return stream(streaming)
 
 
@@ -85,8 +85,8 @@ app = Sanic(__name__)
 @app.route("/")
 async def test(request):
     async def sample_streaming_fn(response):
-        response.write('foo,')
-        response.write('bar')
+        await response.write('foo,')
+        await response.write('bar')
 
     return stream(sample_streaming_fn, content_type='text/csv')
 ```
@@ -100,7 +100,7 @@ async def index(request):
         conn = await asyncpg.connect(database='test')
         async with conn.transaction():
             async for record in conn.cursor('SELECT generate_series(0, 10)'):
-                response.write(record[0])
+                await response.write(record[0])
 
     return stream(stream_from_db)
 ```

docs/sanic/testing.md

@@ -20,7 +20,7 @@ def test_index_put_not_allowed():
     assert response.status == 405
 ```
 
-Internally, each time you call one of the `test_client` methods, the Sanic app is run at `127.0.01:42101` and 
+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 `aiohttp`. 
 
 The `test_client` methods accept the following arguments and keyword arguments:

docs/sanic/websocket.rst

@@ -0,0 +1,52 @@
+WebSocket
+=========
+
+Sanic supports websockets, to setup a WebSocket:
+
+.. code:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+    from sanic.websocket import WebSocketProtocol
+
+    app = Sanic()
+
+    @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)
+
+    if __name__ == "__main__":
+        app.run(host="0.0.0.0", port=8000, protocol=WebSocketProtocol)
+
+
+Alternatively, the ``app.add_websocket_route`` method can be used instead of the
+decorator:
+
+.. code:: python
+
+    async def feed(request, ws):
+        pass
+
+    app.add_websocket_route(feed, '/feed')
+
+
+Handlers for a WebSocket route are passed 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.
+
+
+You could setup your own WebSocket configuration through ``app.config``, like
+
+.. code:: python
+
+    app.config.WEBSOCKET_MAX_SIZE = 2 ** 20
+    app.config.WEBSOCKET_MAX_QUEUE = 32
+    app.config.WEBSOCKET_READ_LIMIT = 2 ** 16
+    app.config.WEBSOCKET_WRITE_LIMIT = 2 ** 16
+
+Find more in ``Configuration`` section.

environment.yml

@@ -12,8 +12,10 @@ dependencies:
 - zlib=1.2.8=0
 - pip:
   - uvloop>=0.5.3
-  - httptools>=0.0.9
+  - httptools>=0.0.10
   - ujson>=1.35
   - aiofiles>=0.3.0
-  - websockets>=3.2
-  - https://github.com/channelcat/docutils-fork/zipball/master
+  - websockets>=6.0
+  - sphinxcontrib-asyncio>=0.2.0
+  - multidict>=4.0,<5.0
+  - https://github.com/channelcat/docutils-fork/zipball/master

examples/add_task_sanic.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+import asyncio
+
+from sanic import Sanic
+
+app = Sanic()
+
+
+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())
+
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000)

examples/authorized_sanic.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+
+from sanic import Sanic
+from functools import wraps
+from sanic.response import json
+
+app = Sanic()
+
+
+def check_request_for_authorization_status(request):
+    # Note: Define your check, for instance cookie, session.
+    flag = True
+    return flag
+
+
+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'})
+
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000)

examples/blueprints.py

@@ -1,7 +1,5 @@
-from sanic import Sanic
-from sanic import Blueprint
-from sanic.response import json
-
+from sanic import Blueprint, Sanic
+from sanic.response import file, json
 
 app = Sanic(__name__)
 blueprint = Blueprint('name', url_prefix='/my_blueprint')
@@ -19,7 +17,12 @@ async def foo2(request):
     return json({'msg': 'hi from blueprint2'})
 
 
-@blueprint3.websocket('/foo')
+@blueprint3.route('/foo')
+async def index(request):
+    return await file('websocket.html')
+
+
+@app.websocket('/feed')
 async def foo3(request, ws):
     while True:
         data = 'hello!'

examples/log_request_id.py

@@ -0,0 +1,86 @@
+'''
+Based on example from https://github.com/Skyscanner/aiotask-context
+and `examples/{override_logging,run_async}.py`.
+
+Needs https://github.com/Skyscanner/aiotask-context/tree/52efbc21e2e1def2d52abb9a8e951f3ce5e6f690 or newer
+
+$ pip install git+https://github.com/Skyscanner/aiotask-context.git
+'''
+
+import asyncio
+import uuid
+import logging
+from signal import signal, SIGINT
+
+from sanic import Sanic
+from sanic import response
+
+import uvloop
+import aiotask_context as context
+
+log = logging.getLogger(__name__)
+
+
+class RequestIdFilter(logging.Filter):
+    def filter(self, record):
+        record.request_id = context.get('X-Request-ID')
+        return True
+
+
+LOG_SETTINGS = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'handlers': {
+        'console': {
+            'class': 'logging.StreamHandler',
+            'level': 'DEBUG',
+            'formatter': 'default',
+            'filters': ['requestid'],
+        },
+    },
+    'filters': {
+        'requestid': {
+            '()': RequestIdFilter,
+        },
+    },
+    'formatters': {
+        'default': {
+            'format': '%(asctime)s %(levelname)s %(name)s:%(lineno)d %(request_id)s | %(message)s',
+        },
+    },
+    'loggers': {
+        '': {
+            'level': 'DEBUG',
+            'handlers': ['console'],
+            'propagate': True
+        },
+    }
+}
+
+
+app = Sanic(__name__, log_config=LOG_SETTINGS)
+
+
+@app.middleware('request')
+async def set_request_id(request):
+    request_id = request.headers.get('X-Request-ID') or str(uuid.uuid4())
+    context.set("X-Request-ID", request_id)
+
+
+@app.route("/")
+async def test(request):
+    log.debug('X-Request-ID: %s', context.get('X-Request-ID'))
+    log.info('Hello from test!')
+    return response.json({"test": True})
+
+
+if __name__ == '__main__':
+    asyncio.set_event_loop(uvloop.new_event_loop())
+    server = app.create_server(host="0.0.0.0", port=8000)
+    loop = asyncio.get_event_loop()
+    loop.set_task_factory(context.task_factory)
+    task = asyncio.ensure_future(server)
+    try:
+        loop.run_forever()
+    except:
+        loop.stop()

examples/pytest_xdist.py

@@ -0,0 +1,49 @@
+"""pytest-xdist example for sanic server
+
+Install testing tools:
+
+    $ pip install pytest pytest-xdist
+
+Run with xdist params:
+
+    $ pytest examples/pytest_xdist.py -n 8  # 8 workers
+"""
+import re
+from sanic import Sanic
+from sanic.response import text
+from sanic.testing import PORT as PORT_BASE, SanicTestClient
+import pytest
+
+
+@pytest.fixture(scope="session")
+def test_port(worker_id):
+    m = re.search(r'[0-9]+', worker_id)
+    if m:
+        num_id = m.group(0)
+    else:
+        num_id = 0
+    port = PORT_BASE + int(num_id)
+    return port
+
+
+@pytest.fixture(scope="session")
+def app():
+    app = Sanic()
+
+    @app.route('/')
+    async def index(request):
+        return text('OK')
+
+    return app
+
+
+@pytest.fixture(scope="session")
+def client(app, test_port):
+    return SanicTestClient(app, test_port)
+
+
+@pytest.mark.parametrize('run_id', range(100))
+def test_index(client, run_id):
+    request, response = client._sanic_endpoint_test('get', '/')
+    assert response.status == 200
+    assert response.text == 'OK'

examples/request_stream/server.py

@@ -30,7 +30,7 @@ async def handler(request):
             if body is None:
                 break
             body = body.decode('utf-8').replace('1', 'A')
-            response.write(body)
+            await response.write(body)
     return stream(streaming)
 
 

examples/simple_async_view.py

@@ -0,0 +1,42 @@
+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')
+
+
+class SimpleAsyncView(HTTPMethodView):
+
+    async def get(self, request):
+        return text('I am async get method')
+
+    async def post(self, request):
+        return text('I am async post method')
+
+    async def put(self, request):
+        return text('I am async put method')
+
+
+app.add_route(SimpleView.as_view(), '/')
+app.add_route(SimpleAsyncView.as_view(), '/async')
+
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000, debug=True)

examples/teapot.py

@@ -0,0 +1,13 @@
+from sanic import Sanic
+from sanic import response as res
+
+app = Sanic(__name__)
+
+
+@app.route("/")
+async def test(req):
+    return res.text("I\'m a teapot", status=418)
+
+
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000)

examples/try_everything.py

@@ -1,7 +1,7 @@
 import os
 
 from sanic import Sanic
-from sanic.log import log
+from sanic.log import logger as log
 from sanic import response
 from sanic.exceptions import ServerError
 
@@ -18,7 +18,7 @@ def test_sync(request):
     return response.json({"test": True})
 
 
-@app.route("/dynamic/<name>/<id:int>")
+@app.route("/dynamic/<name>/<i:int>")
 def test_params(request, name, i):
     return response.text("yeehaww {} {}".format(name, i))
 
@@ -66,7 +66,7 @@ def post_json(request):
 
 
 @app.route("/form")
-def post_json(request):
+def post_form_json(request):
     return response.json({"received": True, "form_data": request.form, "test": request.form.get('test')})
 
 

pyproject.toml

@@ -0,0 +1,2 @@
+[tool.black]
+line-length = 79

requirements-dev.txt

@@ -1,12 +1,13 @@
 aiofiles
-aiohttp==1.3.5
+aiohttp>=2.3.0,<=3.2.1
 chardet<=2.3.0
 beautifulsoup4
 coverage
-httptools
+httptools>=0.0.10
 flake8
-pytest
+pytest==3.3.2
 tox
-ujson
-uvloop
+ujson; sys_platform != "win32" and implementation_name == "cpython"
+uvloop; sys_platform != "win32" and implementation_name == "cpython"
 gunicorn
+multidict>=4.0,<5.0

requirements-docs.txt

@@ -1,3 +1,4 @@
 sphinx
 sphinx_rtd_theme
 recommonmark
+sphinxcontrib-asyncio

requirements.txt

@@ -1,5 +1,6 @@
 aiofiles
-httptools
-ujson
-uvloop
-websockets
+httptools>=0.0.10
+ujson; sys_platform != "win32" and implementation_name == "cpython"
+uvloop; sys_platform != "win32" and implementation_name == "cpython"
+websockets>=6.0,<7.0
+multidict>=4.0,<5.0

sanic/__init__.py

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

sanic/__main__.py

@@ -1,20 +1,23 @@
 from argparse import ArgumentParser
 from importlib import import_module
 
-from sanic.log import log
 from sanic.app import Sanic
+from sanic.log import logger
+
 
 if __name__ == "__main__":
-    parser = ArgumentParser(prog='sanic')
-    parser.add_argument('--host', dest='host', type=str, default='127.0.0.1')
-    parser.add_argument('--port', dest='port', type=int, default=8000)
-    parser.add_argument('--cert', dest='cert', type=str,
-                        help='location of certificate for SSL')
-    parser.add_argument('--key', dest='key', type=str,
-                        help='location of keyfile for SSL.')
-    parser.add_argument('--workers', dest='workers', type=int, default=1, )
-    parser.add_argument('--debug', dest='debug', action="store_true")
-    parser.add_argument('module')
+    parser = ArgumentParser(prog="sanic")
+    parser.add_argument("--host", dest="host", type=str, default="127.0.0.1")
+    parser.add_argument("--port", dest="port", type=int, default=8000)
+    parser.add_argument(
+        "--cert", dest="cert", type=str, help="location of certificate for SSL"
+    )
+    parser.add_argument(
+        "--key", dest="key", type=str, help="location of keyfile for SSL."
+    )
+    parser.add_argument("--workers", dest="workers", type=int, default=1)
+    parser.add_argument("--debug", dest="debug", action="store_true")
+    parser.add_argument("module")
     args = parser.parse_args()
 
     try:
@@ -25,20 +28,29 @@ if __name__ == "__main__":
         module = import_module(module_name)
         app = getattr(module, app_name, None)
         if not isinstance(app, Sanic):
-            raise ValueError("Module is not a Sanic app, it is a {}.  "
-                             "Perhaps you meant {}.app?"
-                             .format(type(app).__name__, args.module))
+            raise ValueError(
+                "Module is not a Sanic app, it is a {}.  "
+                "Perhaps you meant {}.app?".format(
+                    type(app).__name__, args.module
+                )
+            )
         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}
         else:
             ssl = None
 
-        app.run(host=args.host, port=args.port,
-                workers=args.workers, debug=args.debug, ssl=ssl)
+        app.run(
+            host=args.host,
+            port=args.port,
+            workers=args.workers,
+            debug=args.debug,
+            ssl=ssl,
+        )
     except ImportError as e:
-        log.error("No module named {} found.\n"
-                  "  Example File: project/sanic_server.py -> app\n"
-                  "  Example Module: project.sanic_server.app"
-                  .format(e.name))
-    except ValueError as e:
-        log.error("{}".format(e))
+        logger.error(
+            "No module named {} found.\n"
+            "  Example File: project/sanic_server.py -> app\n"
+            "  Example Module: project.sanic_server.app".format(e.name)
+        )
+    except ValueError:
+        logger.exception("Failed to run app")

sanic/blueprints.py

@@ -3,22 +3,46 @@ from collections import defaultdict, namedtuple
 from sanic.constants import HTTP_METHODS
 from sanic.views import CompositionView
 
-FutureRoute = namedtuple('Route',
-                         ['handler', 'uri', 'methods', 'host',
-                          'strict_slashes', 'stream', 'version'])
-FutureListener = namedtuple('Listener', ['handler', 'uri', 'methods', 'host'])
-FutureMiddleware = namedtuple('Route', ['middleware', 'args', 'kwargs'])
-FutureException = namedtuple('Route', ['handler', 'args', 'kwargs'])
-FutureStatic = namedtuple('Route',
-                          ['uri', 'file_or_directory', 'args', 'kwargs'])
+
+FutureRoute = namedtuple(
+    "FutureRoute",
+    [
+        "handler",
+        "uri",
+        "methods",
+        "host",
+        "strict_slashes",
+        "stream",
+        "version",
+        "name",
+    ],
+)
+FutureListener = namedtuple(
+    "FutureListener", ["handler", "uri", "methods", "host"]
+)
+FutureMiddleware = namedtuple(
+    "FutureMiddleware", ["middleware", "args", "kwargs"]
+)
+FutureException = namedtuple("FutureException", ["handler", "args", "kwargs"])
+FutureStatic = namedtuple(
+    "FutureStatic", ["uri", "file_or_directory", "args", "kwargs"]
+)
 
 
 class Blueprint:
-    def __init__(self, name, url_prefix=None, host=None, version=None):
+    def __init__(
+        self,
+        name,
+        url_prefix=None,
+        host=None,
+        version=None,
+        strict_slashes=False,
+    ):
         """Create a new blueprint
 
         :param name: unique name of the blueprint
         :param url_prefix: URL to be prefixed before all route URLs
+        :param strict_slashes: strict to trailing slash
         """
         self.name = name
         self.url_prefix = url_prefix
@@ -31,11 +55,37 @@ class Blueprint:
         self.middlewares = []
         self.statics = []
         self.version = version
+        self.strict_slashes = strict_slashes
+
+    @staticmethod
+    def group(*blueprints, url_prefix=""):
+        """Create a list of blueprints, optionally
+        grouping them under a general URL prefix.
+
+        :param blueprints: blueprints to be registered as a group
+        :param url_prefix: URL route to be prepended to all sub-prefixes
+        """
+
+        def chain(nested):
+            """itertools.chain() but leaves strings untouched"""
+            for i in nested:
+                if isinstance(i, (list, tuple)):
+                    yield from chain(i)
+                else:
+                    yield i
+
+        bps = []
+        for bp in chain(blueprints):
+            if bp.url_prefix is None:
+                bp.url_prefix = ""
+            bp.url_prefix = url_prefix + bp.url_prefix
+            bps.append(bp)
+        return bps
 
     def register(self, app, options):
         """Register the blueprint to the sanic app."""
 
-        url_prefix = options.get('url_prefix', self.url_prefix)
+        url_prefix = options.get("url_prefix", self.url_prefix)
 
         # Routes
         for future in self.routes:
@@ -48,13 +98,14 @@ class Blueprint:
             version = future.version or self.version
 
             app.route(
-                uri=uri[1:] if uri.startswith('//') else uri,
+                uri=uri[1:] if uri.startswith("//") else uri,
                 methods=future.methods,
                 host=future.host or self.host,
                 strict_slashes=future.strict_slashes,
                 stream=future.stream,
-                version=version
-                )(future.handler)
+                version=version,
+                name=future.name,
+            )(future.handler)
 
         for future in self.websocket_routes:
             # attach the blueprint name to the handler so that it can be
@@ -65,15 +116,16 @@ class Blueprint:
             app.websocket(
                 uri=uri,
                 host=future.host or self.host,
-                strict_slashes=future.strict_slashes
-                )(future.handler)
+                strict_slashes=future.strict_slashes,
+                name=future.name,
+            )(future.handler)
 
         # Middleware
         for future in self.middlewares:
             if future.args or future.kwargs:
-                app.register_middleware(future.middleware,
-                                        *future.args,
-                                        **future.kwargs)
+                app.register_middleware(
+                    future.middleware, *future.args, **future.kwargs
+                )
             else:
                 app.register_middleware(future.middleware)
 
@@ -85,67 +137,118 @@ class Blueprint:
         for future in self.statics:
             # Prepend the blueprint URI prefix if available
             uri = url_prefix + future.uri if url_prefix else future.uri
-            app.static(uri, future.file_or_directory,
-                       *future.args, **future.kwargs)
+            app.static(
+                uri, future.file_or_directory, *future.args, **future.kwargs
+            )
 
         # Event listeners
         for event, listeners in self.listeners.items():
             for listener in listeners:
                 app.listener(event)(listener)
 
-    def route(self, uri, methods=frozenset({'GET'}), host=None,
-              strict_slashes=False, stream=False, version=None):
+    def route(
+        self,
+        uri,
+        methods=frozenset({"GET"}),
+        host=None,
+        strict_slashes=None,
+        stream=False,
+        version=None,
+        name=None,
+    ):
         """Create a blueprint route from a decorated function.
 
         :param uri: endpoint at which the route will be accessible.
         :param methods: list of acceptable HTTP methods.
         """
+        if strict_slashes is None:
+            strict_slashes = self.strict_slashes
+
         def decorator(handler):
             route = FutureRoute(
-                handler, uri, methods, host, strict_slashes, stream, version)
+                handler,
+                uri,
+                methods,
+                host,
+                strict_slashes,
+                stream,
+                version,
+                name,
+            )
             self.routes.append(route)
             return handler
+
         return decorator
 
-    def add_route(self, handler, uri, methods=frozenset({'GET'}), host=None,
-                  strict_slashes=False, version=None):
+    def add_route(
+        self,
+        handler,
+        uri,
+        methods=frozenset({"GET"}),
+        host=None,
+        strict_slashes=None,
+        version=None,
+        name=None,
+    ):
         """Create a blueprint route from a function.
 
         :param handler: function for handling uri requests. Accepts function,
                         or class instance with a view_class method.
         :param uri: endpoint at which the route will be accessible.
         :param methods: list of acceptable HTTP methods.
+        :param host:
+        :param strict_slashes:
+        :param version:
+        :param name: user defined route name for url_for
         :return: function or class instance
         """
         # Handle HTTPMethodView differently
-        if hasattr(handler, 'view_class'):
+        if hasattr(handler, "view_class"):
             methods = set()
 
             for method in HTTP_METHODS:
                 if getattr(handler.view_class, method.lower(), None):
                     methods.add(method)
 
+        if strict_slashes is None:
+            strict_slashes = self.strict_slashes
+
         # handle composition view differently
         if isinstance(handler, CompositionView):
             methods = handler.handlers.keys()
 
-        self.route(uri=uri, methods=methods, host=host,
-                   strict_slashes=strict_slashes, version=version)(handler)
+        self.route(
+            uri=uri,
+            methods=methods,
+            host=host,
+            strict_slashes=strict_slashes,
+            version=version,
+            name=name,
+        )(handler)
         return handler
 
-    def websocket(self, uri, host=None, strict_slashes=False, version=None):
+    def websocket(
+        self, uri, host=None, strict_slashes=None, version=None, name=None
+    ):
         """Create a blueprint websocket route from a decorated function.
 
         :param uri: endpoint at which the route will be accessible.
         """
+        if strict_slashes is None:
+            strict_slashes = self.strict_slashes
+
         def decorator(handler):
-            route = FutureRoute(handler, uri, [], host, strict_slashes,
-                                False, version)
+            route = FutureRoute(
+                handler, uri, [], host, strict_slashes, False, version, name
+            )
             self.websocket_routes.append(route)
             return handler
+
         return decorator
 
-    def add_websocket_route(self, handler, uri, host=None, version=None):
+    def add_websocket_route(
+        self, handler, uri, host=None, version=None, name=None
+    ):
         """Create a blueprint websocket route from a function.
 
         :param handler: function for handling uri requests. Accepts function,
@@ -153,7 +256,7 @@ class Blueprint:
         :param uri: endpoint at which the route will be accessible.
         :return: function or class instance
         """
-        self.websocket(uri=uri, host=host, version=version)(handler)
+        self.websocket(uri=uri, host=host, version=version, name=name)(handler)
         return handler
 
     def listener(self, event):
@@ -161,13 +264,16 @@ class Blueprint:
 
         :param event: Event to listen to.
         """
+
         def decorator(listener):
             self.listeners[event].append(listener)
             return listener
+
         return decorator
 
     def middleware(self, *args, **kwargs):
         """Create a blueprint middleware from a decorated function."""
+
         def register_middleware(_middleware):
             future_middleware = FutureMiddleware(_middleware, args, kwargs)
             self.middlewares.append(future_middleware)
@@ -183,10 +289,12 @@ class Blueprint:
 
     def exception(self, *args, **kwargs):
         """Create a blueprint exception from a decorated function."""
+
         def decorator(handler):
             exception = FutureException(handler, args, kwargs)
             self.exceptions.append(exception)
             return handler
+
         return decorator
 
     def static(self, uri, file_or_directory, *args, **kwargs):
@@ -195,40 +303,120 @@ class Blueprint:
         :param uri: endpoint at which the route will be accessible.
         :param file_or_directory: Static asset.
         """
+        name = kwargs.pop("name", "static")
+        if not name.startswith(self.name + "."):
+            name = "{}.{}".format(self.name, name)
+        kwargs.update(name=name)
+
+        strict_slashes = kwargs.get("strict_slashes")
+        if strict_slashes is None and self.strict_slashes is not None:
+            kwargs.update(strict_slashes=self.strict_slashes)
+
         static = FutureStatic(uri, file_or_directory, args, kwargs)
         self.statics.append(static)
 
     # Shorthand method decorators
-    def get(self, uri, host=None, strict_slashes=False, version=None):
-        return self.route(uri, methods=["GET"], host=host,
-                          strict_slashes=strict_slashes, version=version)
+    def get(
+        self, uri, host=None, strict_slashes=None, version=None, name=None
+    ):
+        return self.route(
+            uri,
+            methods=["GET"],
+            host=host,
+            strict_slashes=strict_slashes,
+            version=version,
+            name=name,
+        )
 
-    def post(self, uri, host=None, strict_slashes=False, stream=False,
-             version=None):
-        return self.route(uri, methods=["POST"], host=host,
-                          strict_slashes=strict_slashes, stream=stream,
-                          version=version)
+    def post(
+        self,
+        uri,
+        host=None,
+        strict_slashes=None,
+        stream=False,
+        version=None,
+        name=None,
+    ):
+        return self.route(
+            uri,
+            methods=["POST"],
+            host=host,
+            strict_slashes=strict_slashes,
+            stream=stream,
+            version=version,
+            name=name,
+        )
 
-    def put(self, uri, host=None, strict_slashes=False, stream=False,
-            version=None):
-        return self.route(uri, methods=["PUT"], host=host,
-                          strict_slashes=strict_slashes, stream=stream,
-                          version=version)
+    def put(
+        self,
+        uri,
+        host=None,
+        strict_slashes=None,
+        stream=False,
+        version=None,
+        name=None,
+    ):
+        return self.route(
+            uri,
+            methods=["PUT"],
+            host=host,
+            strict_slashes=strict_slashes,
+            stream=stream,
+            version=version,
+            name=name,
+        )
 
-    def head(self, uri, host=None, strict_slashes=False, version=None):
-        return self.route(uri, methods=["HEAD"], host=host,
-                          strict_slashes=strict_slashes, version=version)
+    def head(
+        self, uri, host=None, strict_slashes=None, version=None, name=None
+    ):
+        return self.route(
+            uri,
+            methods=["HEAD"],
+            host=host,
+            strict_slashes=strict_slashes,
+            version=version,
+            name=name,
+        )
 
-    def options(self, uri, host=None, strict_slashes=False, version=None):
-        return self.route(uri, methods=["OPTIONS"], host=host,
-                          strict_slashes=strict_slashes, version=version)
+    def options(
+        self, uri, host=None, strict_slashes=None, version=None, name=None
+    ):
+        return self.route(
+            uri,
+            methods=["OPTIONS"],
+            host=host,
+            strict_slashes=strict_slashes,
+            version=version,
+            name=name,
+        )
 
-    def patch(self, uri, host=None, strict_slashes=False, stream=False,
-              version=None):
-        return self.route(uri, methods=["PATCH"], host=host,
-                          strict_slashes=strict_slashes, stream=stream,
-                          version=version)
+    def patch(
+        self,
+        uri,
+        host=None,
+        strict_slashes=None,
+        stream=False,
+        version=None,
+        name=None,
+    ):
+        return self.route(
+            uri,
+            methods=["PATCH"],
+            host=host,
+            strict_slashes=strict_slashes,
+            stream=stream,
+            version=version,
+            name=name,
+        )
 
-    def delete(self, uri, host=None, strict_slashes=False, version=None):
-        return self.route(uri, methods=["DELETE"], host=host,
-                          strict_slashes=strict_slashes, version=version)
+    def delete(
+        self, uri, host=None, strict_slashes=None, version=None, name=None
+    ):
+        return self.route(
+            uri,
+            methods=["DELETE"],
+            host=host,
+            strict_slashes=strict_slashes,
+            version=version,
+            name=name,
+        )

sanic/config.py

@@ -1,102 +1,10 @@
 import os
-import sys
-import syslog
-import platform
 import types
 
-from sanic.log import DefaultFilter
+from sanic.exceptions import PyFileError
 
-SANIC_PREFIX = 'SANIC_'
 
-_address_dict = {
-    'Windows': ('localhost', 514),
-    'Darwin': '/var/run/syslog',
-    'Linux': '/dev/log',
-    'FreeBSD': '/var/run/log'
-}
-
-LOGGING = {
-    'version': 1,
-    'disable_existing_loggers': False,
-    'filters': {
-        'accessFilter': {
-            '()': DefaultFilter,
-            'param': [0, 10, 20]
-        },
-        'errorFilter': {
-            '()': DefaultFilter,
-            'param': [30, 40, 50]
-        }
-    },
-    'formatters': {
-        'simple': {
-            'format': '%(asctime)s - (%(name)s)[%(levelname)s]: %(message)s',
-            'datefmt': '%Y-%m-%d %H:%M:%S'
-        },
-        'access': {
-            'format': '%(asctime)s - (%(name)s)[%(levelname)s][%(host)s]: ' +
-                      '%(request)s %(message)s %(status)d %(byte)d',
-            'datefmt': '%Y-%m-%d %H:%M:%S'
-        }
-    },
-    'handlers': {
-        'internal': {
-            'class': 'logging.StreamHandler',
-            'filters': ['accessFilter'],
-            'formatter': 'simple',
-            'stream': sys.stderr
-        },
-        'accessStream': {
-            'class': 'logging.StreamHandler',
-            'filters': ['accessFilter'],
-            'formatter': 'access',
-            'stream': sys.stderr
-        },
-        'errorStream': {
-            'class': 'logging.StreamHandler',
-            'filters': ['errorFilter'],
-            'formatter': 'simple',
-            'stream': sys.stderr
-        },
-        # before you use accessSysLog, be sure that log levels
-        # 0, 10, 20 have been enabled in you syslog configuration
-        # otherwise you won't be able to see the output in syslog
-        # logging file.
-        'accessSysLog': {
-            'class': 'logging.handlers.SysLogHandler',
-            'address': _address_dict.get(platform.system(),
-                                         ('localhost', 514)),
-            'facility': syslog.LOG_DAEMON,
-            'filters': ['accessFilter'],
-            'formatter': 'access'
-        },
-        'errorSysLog': {
-            'class': 'logging.handlers.SysLogHandler',
-            'address': _address_dict.get(platform.system(),
-                                         ('localhost', 514)),
-            'facility': syslog.LOG_DAEMON,
-            'filters': ['errorFilter'],
-            'formatter': 'simple'
-        },
-    },
-    'loggers': {
-        'sanic': {
-            'level': 'DEBUG',
-            'handlers': ['internal', 'errorStream']
-        },
-        'network': {
-            'level': 'DEBUG',
-            'handlers': ['accessStream', 'errorStream']
-        }
-    }
-}
-
-# this happens when using container or systems without syslog
-# keep things in config would cause file not exists error
-_addr = LOGGING['handlers']['accessSysLog']['address']
-if type(_addr) is str and not os.path.exists(_addr):
-    LOGGING['handlers'].pop('accessSysLog')
-    LOGGING['handlers'].pop('errorSysLog')
+SANIC_PREFIX = "SANIC_"
 
 
 class Config(dict):
@@ -125,13 +33,19 @@ class Config(dict):
 """
         self.REQUEST_MAX_SIZE = 100000000  # 100 megabytes
         self.REQUEST_TIMEOUT = 60  # 60 seconds
+        self.RESPONSE_TIMEOUT = 60  # 60 seconds
         self.KEEP_ALIVE = keep_alive
+        self.KEEP_ALIVE_TIMEOUT = 5  # 5 seconds
         self.WEBSOCKET_MAX_SIZE = 2 ** 20  # 1 megabytes
         self.WEBSOCKET_MAX_QUEUE = 32
+        self.WEBSOCKET_READ_LIMIT = 2 ** 16
+        self.WEBSOCKET_WRITE_LIMIT = 2 ** 16
         self.GRACEFUL_SHUTDOWN_TIMEOUT = 15.0  # 15 sec
+        self.ACCESS_LOG = True
 
         if load_env:
-            self.load_environment_vars()
+            prefix = SANIC_PREFIX if load_env is True else load_env
+            self.load_environment_vars(prefix=prefix)
 
     def __getattr__(self, attr):
         try:
@@ -151,9 +65,10 @@ class Config(dict):
         """
         config_file = os.environ.get(variable_name)
         if not config_file:
-            raise RuntimeError('The environment variable %r is not set and '
-                               'thus configuration could not be loaded.' %
-                               variable_name)
+            raise RuntimeError(
+                "The environment variable %r is not set and "
+                "thus configuration could not be loaded." % variable_name
+            )
         return self.from_pyfile(config_file)
 
     def from_pyfile(self, filename):
@@ -162,15 +77,20 @@ class Config(dict):
 
         :param filename: an absolute path to the config file
         """
-        module = types.ModuleType('config')
+        module = types.ModuleType("config")
         module.__file__ = filename
         try:
             with open(filename) as config_file:
-                exec(compile(config_file.read(), filename, 'exec'),
-                     module.__dict__)
+                exec(
+                    compile(config_file.read(), filename, "exec"),
+                    module.__dict__,
+                )
         except IOError as e:
-            e.strerror = 'Unable to load configuration file (%s)' % e.strerror
+            e.strerror = "Unable to load configuration file (%s)" % e.strerror
             raise
+        except Exception as e:
+            raise PyFileError(filename) from e
+
         self.from_object(module)
         return True
 
@@ -195,14 +115,14 @@ class Config(dict):
             if key.isupper():
                 self[key] = getattr(obj, key)
 
-    def load_environment_vars(self):
+    def load_environment_vars(self, prefix=SANIC_PREFIX):
         """
-        Looks for any ``SANIC_`` prefixed environment variables and applies
+        Looks for prefixed environment variables and applies
         them to the configuration if present.
         """
         for k, v in os.environ.items():
-            if k.startswith(SANIC_PREFIX):
-                _, config_key = k.split(SANIC_PREFIX, 1)
+            if k.startswith(prefix):
+                _, config_key = k.split(prefix, 1)
                 try:
                     self[config_key] = int(v)
                 except ValueError:

sanic/constants.py

@@ -1 +1 @@
-HTTP_METHODS = ('GET', 'POST', 'PUT', 'HEAD', 'OPTIONS', 'PATCH', 'DELETE')
+HTTP_METHODS = ("GET", "POST", "PUT", "HEAD", "OPTIONS", "PATCH", "DELETE")

sanic/cookies.py

@@ -1,6 +1,7 @@
 import re
 import string
 
+
 # ------------------------------------------------------------ #
 #  SimpleCookie
 # ------------------------------------------------------------ #
@@ -8,18 +9,16 @@ import string
 # Straight up copied this section of dark magic from SimpleCookie
 
 _LegalChars = string.ascii_letters + string.digits + "!#$%&'*+-.^_`|~:"
-_UnescapedChars = _LegalChars + ' ()/<=>?@[]{}'
+_UnescapedChars = _LegalChars + " ()/<=>?@[]{}"
 
-_Translator = {n: '\\%03o' % n
-               for n in set(range(256)) - set(map(ord, _UnescapedChars))}
-_Translator.update({
-    ord('"'): '\\"',
-    ord('\\'): '\\\\',
-})
+_Translator = {
+    n: "\\%03o" % n for n in set(range(256)) - set(map(ord, _UnescapedChars))
+}
+_Translator.update({ord('"'): '\\"', ord("\\"): "\\\\"})
 
 
 def _quote(str):
-    """Quote a string for use in a cookie header.
+    r"""Quote a string for use in a cookie header.
     If the string does not need to be double-quoted, then just return the
     string.  Otherwise, surround the string in doublequotes and quote
     (with a \) special characters.
@@ -30,7 +29,7 @@ def _quote(str):
         return '"' + str.translate(_Translator) + '"'
 
 
-_is_legal_key = re.compile('[%s]+' % re.escape(_LegalChars)).fullmatch
+_is_legal_key = re.compile("[%s]+" % re.escape(_LegalChars)).fullmatch
 
 # ------------------------------------------------------------ #
 #  Custom SimpleCookie
@@ -47,33 +46,37 @@ class CookieJar(dict):
         super().__init__()
         self.headers = headers
         self.cookie_headers = {}
+        self.header_key = "Set-Cookie"
 
     def __setitem__(self, key, value):
         # If this cookie doesn't exist, add it to the header keys
-        cookie_header = self.cookie_headers.get(key)
-        if not cookie_header:
+        if not self.cookie_headers.get(key):
             cookie = Cookie(key, value)
-            cookie['path'] = '/'
-            cookie_header = MultiHeader("Set-Cookie")
-            self.cookie_headers[key] = cookie_header
-            self.headers[cookie_header] = cookie
+            cookie["path"] = "/"
+            self.cookie_headers[key] = self.header_key
+            self.headers.add(self.header_key, cookie)
             return super().__setitem__(key, cookie)
         else:
             self[key].value = value
 
     def __delitem__(self, key):
         if key not in self.cookie_headers:
-            self[key] = ''
-            self[key]['max-age'] = 0
+            self[key] = ""
+            self[key]["max-age"] = 0
         else:
             cookie_header = self.cookie_headers[key]
-            del self.headers[cookie_header]
+            # remove it from header
+            cookies = self.headers.popall(cookie_header)
+            for cookie in cookies:
+                if cookie.key != key:
+                    self.headers.add(cookie_header, cookie)
             del self.cookie_headers[key]
             return super().__delitem__(key)
 
 
 class Cookie(dict):
     """A stripped down version of Morsel from SimpleCookie #gottagofast"""
+
     _keys = {
         "expires": "expires",
         "path": "Path",
@@ -83,8 +86,9 @@ class Cookie(dict):
         "secure": "Secure",
         "httponly": "HttpOnly",
         "version": "Version",
+        "samesite": "SameSite",
     }
-    _flags = {'secure', 'httponly'}
+    _flags = {"secure", "httponly"}
 
     def __init__(self, key, value):
         if key in self._keys:
@@ -98,42 +102,31 @@ class Cookie(dict):
     def __setitem__(self, key, value):
         if key not in self._keys:
             raise KeyError("Unknown cookie property")
-        return super().__setitem__(key, value)
+        if value is not False:
+            return super().__setitem__(key, value)
 
     def encode(self, encoding):
-        output = ['%s=%s' % (self.key, _quote(self.value))]
+        output = ["%s=%s" % (self.key, _quote(self.value))]
         for key, value in self.items():
-            if key == 'max-age':
+            if key == "max-age":
                 try:
-                    output.append('%s=%d' % (self._keys[key], value))
+                    output.append("%s=%d" % (self._keys[key], value))
                 except TypeError:
-                    output.append('%s=%s' % (self._keys[key], value))
-            elif key == 'expires':
+                    output.append("%s=%s" % (self._keys[key], value))
+            elif key == "expires":
                 try:
-                    output.append('%s=%s' % (
-                        self._keys[key],
-                        value.strftime("%a, %d-%b-%Y %T GMT")
-                    ))
+                    output.append(
+                        "%s=%s"
+                        % (
+                            self._keys[key],
+                            value.strftime("%a, %d-%b-%Y %T GMT"),
+                        )
+                    )
                 except AttributeError:
-                    output.append('%s=%s' % (self._keys[key], value))
+                    output.append("%s=%s" % (self._keys[key], value))
             elif key in self._flags and self[key]:
                 output.append(self._keys[key])
             else:
-                output.append('%s=%s' % (self._keys[key], value))
+                output.append("%s=%s" % (self._keys[key], value))
 
         return "; ".join(output).encode(encoding)
-
-# ------------------------------------------------------------ #
-#  Header Trickery
-# ------------------------------------------------------------ #
-
-
-class MultiHeader:
-    """String-holding object which allow us to set a header within response
-    that has a unique key, but may contain duplicate header names
-    """
-    def __init__(self, name):
-        self.name = name
-
-    def encode(self):
-        return self.name.encode()

sanic/exceptions.py

@@ -1,6 +1,7 @@
-from sanic.response import ALL_STATUS_CODES, COMMON_STATUS_CODES
+from sanic.helpers import STATUS_CODES
 
-TRACEBACK_STYLE = '''
+
+TRACEBACK_STYLE = """
     <style>
         body {
             padding: 20px;
@@ -61,9 +62,9 @@ TRACEBACK_STYLE = '''
             font-size: 14px;
         }
     </style>
-'''
+"""
 
-TRACEBACK_WRAPPER_HTML = '''
+TRACEBACK_WRAPPER_HTML = """
     <html>
         <head>
             {style}
@@ -78,27 +79,27 @@ TRACEBACK_WRAPPER_HTML = '''
             </div>
         </body>
     </html>
-'''
+"""
 
-TRACEBACK_WRAPPER_INNER_HTML = '''
+TRACEBACK_WRAPPER_INNER_HTML = """
     <h1>{exc_name}</h1>
     <h3><code>{exc_value}</code></h3>
     <div class="tb-wrapper">
         <p class="tb-header">Traceback (most recent call last):</p>
         {frame_html}
     </div>
-'''
+"""
 
-TRACEBACK_BORDER = '''
+TRACEBACK_BORDER = """
     <div class="tb-border">
         <b><i>
             The above exception was the direct cause of the
             following exception:
         </i></b>
     </div>
-'''
+"""
 
-TRACEBACK_LINE_HTML = '''
+TRACEBACK_LINE_HTML = """
     <div class="frame-line">
         <p class="frame-descriptor">
             File {0.filename}, line <i>{0.lineno}</i>,
@@ -106,15 +107,15 @@ TRACEBACK_LINE_HTML = '''
         </p>
         <p class="frame-code"><code>{0.line}</code></p>
     </div>
-'''
+"""
 
-INTERNAL_SERVER_ERROR_HTML = '''
+INTERNAL_SERVER_ERROR_HTML = """
     <h1>Internal Server Error</h1>
     <p>
         The server encountered an internal error and cannot complete
         your request.
     </p>
-'''
+"""
 
 
 _sanic_exceptions = {}
@@ -124,15 +125,16 @@ def add_status_code(code):
     """
     Decorator used for adding exceptions to _sanic_exceptions.
     """
+
     def class_decorator(cls):
         cls.status_code = code
         _sanic_exceptions[code] = cls
         return cls
+
     return class_decorator
 
 
 class SanicException(Exception):
-
     def __init__(self, message, status_code=None):
         super().__init__(message)
 
@@ -150,18 +152,34 @@ class InvalidUsage(SanicException):
     pass
 
 
+@add_status_code(405)
+class MethodNotSupported(SanicException):
+    def __init__(self, message, method, allowed_methods):
+        super().__init__(message)
+        self.headers = dict()
+        self.headers["Allow"] = ", ".join(allowed_methods)
+        if method in ["HEAD", "PATCH", "PUT", "DELETE"]:
+            self.headers["Content-Length"] = 0
+
+
 @add_status_code(500)
 class ServerError(SanicException):
     pass
 
 
+@add_status_code(503)
+class ServiceUnavailable(SanicException):
+    """The server is currently unavailable (because it is overloaded or
+    down for maintenance). Generally, this is a temporary state."""
+
+    pass
+
+
 class URLBuildError(ServerError):
     pass
 
 
 class FileNotFound(NotFound):
-    pass
-
     def __init__(self, message, path, relative_url):
         super().__init__(message)
         self.path = path
@@ -170,6 +188,14 @@ class FileNotFound(NotFound):
 
 @add_status_code(408)
 class RequestTimeout(SanicException):
+    """The Web server (running the Web site) thinks that there has been too
+    long an interval of time between 1) the establishment of an IP
+    connection (socket) between the client and the server and
+    2) the receipt of any data on that socket, so the server has dropped
+    the connection. The socket connection has actually been lost - the Web
+    server has 'timed out' on that particular socket connection.
+    """
+
     pass
 
 
@@ -184,13 +210,11 @@ class HeaderNotFound(InvalidUsage):
 
 @add_status_code(416)
 class ContentRangeError(SanicException):
-    pass
-
     def __init__(self, message, content_range):
         super().__init__(message)
         self.headers = {
-            'Content-Type': 'text/plain',
-            "Content-Range": "bytes */%s" % (content_range.total,)
+            "Content-Type": "text/plain",
+            "Content-Range": "bytes */%s" % (content_range.total,),
         }
 
 
@@ -203,12 +227,18 @@ class InvalidRangeType(ContentRangeError):
     pass
 
 
+class PyFileError(Exception):
+    def __init__(self, file):
+        super().__init__("could not execute config file %s", file)
+
+
 @add_status_code(401)
 class Unauthorized(SanicException):
     """
     Unauthorized exception (401 HTTP status code).
 
     :param message: Message describing the exception.
+    :param status_code: HTTP Status code.
     :param scheme: Name of the authentication scheme to be used.
 
     When present, kwargs is used to complete the WWW-Authentication header.
@@ -216,11 +246,13 @@ class Unauthorized(SanicException):
     Examples::
 
         # With a Basic auth-scheme, realm MUST be present:
-        raise Unauthorized("Auth required.", "Basic", realm="Restricted Area")
+        raise Unauthorized("Auth required.",
+                           scheme="Basic",
+                           realm="Restricted Area")
 
         # With a Digest auth-scheme, things are a bit more complicated:
         raise Unauthorized("Auth required.",
-                           "Digest",
+                           scheme="Digest",
                            realm="Restricted Area",
                            qop="auth, auth-int",
                            algorithm="MD5",
@@ -228,20 +260,25 @@ class Unauthorized(SanicException):
                            opaque="zyxwvu")
 
         # With a Bearer auth-scheme, realm is optional so you can write:
-        raise Unauthorized("Auth required.", "Bearer")
+        raise Unauthorized("Auth required.", scheme="Bearer")
 
         # or, if you want to specify the realm:
-        raise Unauthorized("Auth required.", "Bearer", realm="Restricted Area")
+        raise Unauthorized("Auth required.",
+                           scheme="Bearer",
+                           realm="Restricted Area")
     """
-    def __init__(self, message, scheme, **kwargs):
-        super().__init__(message)
 
-        values = ["{!s}={!r}".format(k, v) for k, v in kwargs.items()]
-        challenge = ', '.join(values)
+    def __init__(self, message, status_code=None, scheme=None, **kwargs):
+        super().__init__(message, status_code)
 
-        self.headers = {
-            "WWW-Authenticate": "{} {}".format(scheme, challenge).rstrip()
-        }
+        # if auth-scheme is specified, set "WWW-Authenticate" header
+        if scheme is not None:
+            values = ['{!s}="{!s}"'.format(k, v) for k, v in kwargs.items()]
+            challenge = ", ".join(values)
+
+            self.headers = {
+                "WWW-Authenticate": "{} {}".format(scheme, challenge).rstrip()
+            }
 
 
 def abort(status_code, message=None):
@@ -254,9 +291,8 @@ def abort(status_code, message=None):
                     in response.py for the given status code.
     """
     if message is None:
-        message = COMMON_STATUS_CODES.get(status_code,
-                                          ALL_STATUS_CODES.get(status_code))
+        message = STATUS_CODES.get(status_code)
         # These are stored as bytes in the STATUS_CODES dict
-        message = message.decode('utf8')
+        message = message.decode("utf8")
     sanic_exception = _sanic_exceptions.get(status_code, SanicException)
     raise sanic_exception(message=message, status_code=status_code)

sanic/handlers.py

@@ -1,19 +1,21 @@
 import sys
-from traceback import format_exc, extract_tb
+
+from traceback import extract_tb, format_exc
 
 from sanic.exceptions import (
-    ContentRangeError,
-    HeaderNotFound,
     INTERNAL_SERVER_ERROR_HTML,
-    InvalidRangeType,
-    SanicException,
+    TRACEBACK_BORDER,
     TRACEBACK_LINE_HTML,
     TRACEBACK_STYLE,
     TRACEBACK_WRAPPER_HTML,
     TRACEBACK_WRAPPER_INNER_HTML,
-    TRACEBACK_BORDER)
-from sanic.log import log
-from sanic.response import text, html
+    ContentRangeError,
+    HeaderNotFound,
+    InvalidRangeType,
+    SanicException,
+)
+from sanic.log import logger
+from sanic.response import html, text
 
 
 class ErrorHandler:
@@ -36,7 +38,8 @@ class ErrorHandler:
         return TRACEBACK_WRAPPER_INNER_HTML.format(
             exc_name=exception.__class__.__name__,
             exc_value=exception,
-            frame_html=''.join(frame_html))
+            frame_html="".join(frame_html),
+        )
 
     def _render_traceback_html(self, exception, request):
         exc_type, exc_value, tb = sys.exc_info()
@@ -51,13 +54,14 @@ class ErrorHandler:
             exc_name=exception.__class__.__name__,
             exc_value=exception,
             inner_html=TRACEBACK_BORDER.join(reversed(exceptions)),
-            path=request.path)
+            path=request.path,
+        )
 
     def add(self, exception, handler):
         self.handlers.append((exception, handler))
 
     def lookup(self, exception):
-        handler = self.cached_handlers.get(exception, self._missing)
+        handler = self.cached_handlers.get(type(exception), self._missing)
         if handler is self._missing:
             for exception_class, handler in self.handlers:
                 if isinstance(exception, exception_class):
@@ -79,45 +83,50 @@ class ErrorHandler:
         response = None
         try:
             if handler:
-                response = handler(request=request, exception=exception)
+                response = handler(request, exception)
             if response is None:
-                response = self.default(request=request, exception=exception)
+                response = self.default(request, exception)
         except Exception:
             self.log(format_exc())
+            try:
+                url = repr(request.url)
+            except AttributeError:
+                url = "unknown"
+            response_message = (
+                "Exception raised in exception handler " '"%s" for uri: %s'
+            )
+            logger.exception(response_message, handler.__name__, url)
+
             if self.debug:
-                url = getattr(request, 'url', 'unknown')
-                response_message = (
-                    'Exception raised in exception handler "{}" '
-                    'for uri: "{}"\n{}').format(
-                        handler.__name__, url, format_exc())
-                log.error(response_message)
-                return text(response_message, 500)
+                return text(response_message % (handler.__name__, url), 500)
             else:
-                return text('An error occurred while handling an error', 500)
+                return text("An error occurred while handling an error", 500)
         return response
 
-    def log(self, message, level='error'):
+    def log(self, message, level="error"):
         """
-        Override this method in an ErrorHandler subclass to prevent
-        logging exceptions.
+        Deprecated, do not use.
         """
-        getattr(log, level)(message)
 
     def default(self, request, exception):
         self.log(format_exc())
+        try:
+            url = repr(request.url)
+        except AttributeError:
+            url = "unknown"
+
+        response_message = "Exception occurred while handling uri: %s"
+        logger.exception(response_message, url)
+
         if issubclass(type(exception), SanicException):
             return text(
-                'Error: {}'.format(exception),
-                status=getattr(exception, 'status_code', 500),
-                headers=getattr(exception, 'headers', dict())
+                "Error: {}".format(exception),
+                status=getattr(exception, "status_code", 500),
+                headers=getattr(exception, "headers", dict()),
             )
         elif self.debug:
             html_output = self._render_traceback_html(exception, request)
 
-            response_message = (
-                'Exception occurred while handling uri: "{}"\n{}'.format(
-                    request.url, format_exc()))
-            log.error(response_message)
             return html(html_output, status=500)
         else:
             return html(INTERNAL_SERVER_ERROR_HTML, status=500)
@@ -125,47 +134,54 @@ class ErrorHandler:
 
 class ContentRangeHandler:
     """Class responsible for parsing request header"""
-    __slots__ = ('start', 'end', 'size', 'total', 'headers')
+
+    __slots__ = ("start", "end", "size", "total", "headers")
 
     def __init__(self, request, stats):
         self.total = stats.st_size
-        _range = request.headers.get('Range')
+        _range = request.headers.get("Range")
         if _range is None:
-            raise HeaderNotFound('Range Header Not Found')
-        unit, _, value = tuple(map(str.strip, _range.partition('=')))
-        if unit != 'bytes':
+            raise HeaderNotFound("Range Header Not Found")
+        unit, _, value = tuple(map(str.strip, _range.partition("=")))
+        if unit != "bytes":
             raise InvalidRangeType(
-                '%s is not a valid Range Type' % (unit,), self)
-        start_b, _, end_b = tuple(map(str.strip, value.partition('-')))
+                "%s is not a valid Range Type" % (unit,), self
+            )
+        start_b, _, end_b = tuple(map(str.strip, value.partition("-")))
         try:
             self.start = int(start_b) if start_b else None
         except ValueError:
             raise ContentRangeError(
-                '\'%s\' is invalid for Content Range' % (start_b,), self)
+                "'%s' is invalid for Content Range" % (start_b,), self
+            )
         try:
             self.end = int(end_b) if end_b else None
         except ValueError:
             raise ContentRangeError(
-                '\'%s\' is invalid for Content Range' % (end_b,), self)
+                "'%s' is invalid for Content Range" % (end_b,), self
+            )
         if self.end is None:
             if self.start is None:
                 raise ContentRangeError(
-                    'Invalid for Content Range parameters', self)
+                    "Invalid for Content Range parameters", self
+                )
             else:
                 # this case represents `Content-Range: bytes 5-`
-                self.end = self.total
+                self.end = self.total - 1
         else:
             if self.start is None:
                 # this case represents `Content-Range: bytes -5`
                 self.start = self.total - self.end
-                self.end = self.total
+                self.end = self.total - 1
         if self.start >= self.end:
             raise ContentRangeError(
-                'Invalid for Content Range parameters', self)
-        self.size = self.end - self.start
+                "Invalid for Content Range parameters", self
+            )
+        self.size = self.end - self.start + 1
         self.headers = {
-            'Content-Range': "bytes %s-%s/%s" % (
-                self.start, self.end, self.total)}
+            "Content-Range": "bytes %s-%s/%s"
+            % (self.start, self.end, self.total)
+        }
 
     def __bool__(self):
         return self.size > 0

sanic/helpers.py

@@ -0,0 +1,133 @@
+"""Defines basics of HTTP standard."""
+
+STATUS_CODES = {
+    100: b"Continue",
+    101: b"Switching Protocols",
+    102: b"Processing",
+    200: b"OK",
+    201: b"Created",
+    202: b"Accepted",
+    203: b"Non-Authoritative Information",
+    204: b"No Content",
+    205: b"Reset Content",
+    206: b"Partial Content",
+    207: b"Multi-Status",
+    208: b"Already Reported",
+    226: b"IM Used",
+    300: b"Multiple Choices",
+    301: b"Moved Permanently",
+    302: b"Found",
+    303: b"See Other",
+    304: b"Not Modified",
+    305: b"Use Proxy",
+    307: b"Temporary Redirect",
+    308: b"Permanent Redirect",
+    400: b"Bad Request",
+    401: b"Unauthorized",
+    402: b"Payment Required",
+    403: b"Forbidden",
+    404: b"Not Found",
+    405: b"Method Not Allowed",
+    406: b"Not Acceptable",
+    407: b"Proxy Authentication Required",
+    408: b"Request Timeout",
+    409: b"Conflict",
+    410: b"Gone",
+    411: b"Length Required",
+    412: b"Precondition Failed",
+    413: b"Request Entity Too Large",
+    414: b"Request-URI Too Long",
+    415: b"Unsupported Media Type",
+    416: b"Requested Range Not Satisfiable",
+    417: b"Expectation Failed",
+    418: b"I'm a teapot",
+    422: b"Unprocessable Entity",
+    423: b"Locked",
+    424: b"Failed Dependency",
+    426: b"Upgrade Required",
+    428: b"Precondition Required",
+    429: b"Too Many Requests",
+    431: b"Request Header Fields Too Large",
+    451: b"Unavailable For Legal Reasons",
+    500: b"Internal Server Error",
+    501: b"Not Implemented",
+    502: b"Bad Gateway",
+    503: b"Service Unavailable",
+    504: b"Gateway Timeout",
+    505: b"HTTP Version Not Supported",
+    506: b"Variant Also Negotiates",
+    507: b"Insufficient Storage",
+    508: b"Loop Detected",
+    510: b"Not Extended",
+    511: b"Network Authentication Required",
+}
+
+# According to https://tools.ietf.org/html/rfc2616#section-7.1
+_ENTITY_HEADERS = frozenset(
+    [
+        "allow",
+        "content-encoding",
+        "content-language",
+        "content-length",
+        "content-location",
+        "content-md5",
+        "content-range",
+        "content-type",
+        "expires",
+        "last-modified",
+        "extension-header",
+    ]
+)
+
+# According to https://tools.ietf.org/html/rfc2616#section-13.5.1
+_HOP_BY_HOP_HEADERS = frozenset(
+    [
+        "connection",
+        "keep-alive",
+        "proxy-authenticate",
+        "proxy-authorization",
+        "te",
+        "trailers",
+        "transfer-encoding",
+        "upgrade",
+    ]
+)
+
+
+def has_message_body(status):
+    """
+    According to the following RFC message body and length SHOULD NOT
+    be included in responses status 1XX, 204 and 304.
+    https://tools.ietf.org/html/rfc2616#section-4.4
+    https://tools.ietf.org/html/rfc2616#section-4.3
+    """
+    return status not in (204, 304) and not (100 <= status < 200)
+
+
+def is_entity_header(header):
+    """Checks if the given header is an Entity Header"""
+    return header.lower() in _ENTITY_HEADERS
+
+
+def is_hop_by_hop_header(header):
+    """Checks if the given header is a Hop By Hop header"""
+    return header.lower() in _HOP_BY_HOP_HEADERS
+
+
+def remove_entity_headers(headers, allowed=("content-location", "expires")):
+    """
+    Removes all the entity headers present in the headers given.
+    According to RFC 2616 Section 10.3.5,
+    Content-Location and Expires are allowed as for the
+    "strong cache validator".
+    https://tools.ietf.org/html/rfc2616#section-10.3.5
+
+    returns the headers without the entity headers
+    """
+    allowed = set([h.lower() for h in allowed])
+    headers = {
+        header: value
+        for header, value in headers.items()
+        if not is_entity_header(header) or header.lower() in allowed
+    }
+    return headers

sanic/log.py

@@ -1,18 +1,58 @@
 import logging
+import sys
 
 
-class DefaultFilter(logging.Filter):
-
-    def __init__(self, param=None):
-        self.param = param
-
-    def filter(self, record):
-        if self.param is None:
-            return True
-        if record.levelno in self.param:
-            return True
-        return False
+LOGGING_CONFIG_DEFAULTS = dict(
+    version=1,
+    disable_existing_loggers=False,
+    loggers={
+        "sanic.root": {"level": "INFO", "handlers": ["console"]},
+        "sanic.error": {
+            "level": "INFO",
+            "handlers": ["error_console"],
+            "propagate": True,
+            "qualname": "sanic.error",
+        },
+        "sanic.access": {
+            "level": "INFO",
+            "handlers": ["access_console"],
+            "propagate": True,
+            "qualname": "sanic.access",
+        },
+    },
+    handlers={
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "generic",
+            "stream": sys.stdout,
+        },
+        "error_console": {
+            "class": "logging.StreamHandler",
+            "formatter": "generic",
+            "stream": sys.stderr,
+        },
+        "access_console": {
+            "class": "logging.StreamHandler",
+            "formatter": "access",
+            "stream": sys.stdout,
+        },
+    },
+    formatters={
+        "generic": {
+            "format": "%(asctime)s [%(process)d] [%(levelname)s] %(message)s",
+            "datefmt": "[%Y-%m-%d %H:%M:%S %z]",
+            "class": "logging.Formatter",
+        },
+        "access": {
+            "format": "%(asctime)s - (%(name)s)[%(levelname)s][%(host)s]: "
+            + "%(request)s %(message)s %(status)d %(byte)d",
+            "datefmt": "[%Y-%m-%d %H:%M:%S %z]",
+            "class": "logging.Formatter",
+        },
+    },
+)
 
 
-log = logging.getLogger('sanic')
-netlog = logging.getLogger('network')
+logger = logging.getLogger("sanic.root")
+error_logger = logging.getLogger("sanic.error")
+access_logger = logging.getLogger("sanic.access")

sanic/reloader_helpers.py

@@ -0,0 +1,158 @@
+import os
+import signal
+import subprocess
+import sys
+
+from multiprocessing import Process
+from time import sleep
+
+
+def _iter_module_files():
+    """This iterates over all relevant Python files.
+
+    It goes through all
+    loaded files from modules, all files in folders of already loaded modules
+    as well as all files reachable through a package.
+    """
+    # The list call is necessary on Python 3 in case the module
+    # dictionary modifies during iteration.
+    for module in list(sys.modules.values()):
+        if module is None:
+            continue
+        filename = getattr(module, "__file__", None)
+        if filename:
+            old = None
+            while not os.path.isfile(filename):
+                old = filename
+                filename = os.path.dirname(filename)
+                if filename == old:
+                    break
+            else:
+                if filename[-4:] in (".pyc", ".pyo"):
+                    filename = filename[:-1]
+                yield filename
+
+
+def _get_args_for_reloading():
+    """Returns the executable."""
+    rv = [sys.executable]
+    rv.extend(sys.argv)
+    return rv
+
+
+def restart_with_reloader():
+    """Create a new process and a subprocess in it with the same arguments as
+    this one.
+    """
+    args = _get_args_for_reloading()
+    new_environ = os.environ.copy()
+    new_environ["SANIC_SERVER_RUNNING"] = "true"
+    cmd = " ".join(args)
+    worker_process = Process(
+        target=subprocess.call,
+        args=(cmd,),
+        kwargs=dict(shell=True, env=new_environ),
+    )
+    worker_process.start()
+    return worker_process
+
+
+def kill_process_children_unix(pid):
+    """Find and kill child processes of a process (maximum two level).
+
+    :param pid: PID of parent process (process ID)
+    :return: Nothing
+    """
+    root_process_path = "/proc/{pid}/task/{pid}/children".format(pid=pid)
+    if not os.path.isfile(root_process_path):
+        return
+    with open(root_process_path) as children_list_file:
+        children_list_pid = children_list_file.read().split()
+
+    for child_pid in children_list_pid:
+        children_proc_path = "/proc/%s/task/%s/children" % (
+            child_pid,
+            child_pid,
+        )
+        if not os.path.isfile(children_proc_path):
+            continue
+        with open(children_proc_path) as children_list_file_2:
+            children_list_pid_2 = children_list_file_2.read().split()
+        for _pid in children_list_pid_2:
+            try:
+                os.kill(int(_pid), signal.SIGTERM)
+            except ProcessLookupError:
+                continue
+        try:
+            os.kill(int(child_pid), signal.SIGTERM)
+        except ProcessLookupError:
+            continue
+
+
+def kill_process_children_osx(pid):
+    """Find and kill child processes of a process.
+
+    :param pid: PID of parent process (process ID)
+    :return: Nothing
+    """
+    subprocess.run(["pkill", "-P", str(pid)])
+
+
+def kill_process_children(pid):
+    """Find and kill child processes of a process.
+
+    :param pid: PID of parent process (process ID)
+    :return: Nothing
+    """
+    if sys.platform == "darwin":
+        kill_process_children_osx(pid)
+    elif sys.platform == "linux":
+        kill_process_children_unix(pid)
+    else:
+        pass  # should signal error here
+
+
+def kill_program_completly(proc):
+    """Kill worker and it's child processes and exit.
+
+    :param proc: worker process (process ID)
+    :return: Nothing
+    """
+    kill_process_children(proc.pid)
+    proc.terminate()
+    os._exit(0)
+
+
+def watchdog(sleep_interval):
+    """Watch project files, restart worker process if a change happened.
+
+    :param sleep_interval: interval in second.
+    :return: Nothing
+    """
+    mtimes = {}
+    worker_process = restart_with_reloader()
+    signal.signal(
+        signal.SIGTERM, lambda *args: kill_program_completly(worker_process)
+    )
+    signal.signal(
+        signal.SIGINT, lambda *args: kill_program_completly(worker_process)
+    )
+    while True:
+        for filename in _iter_module_files():
+            try:
+                mtime = os.stat(filename).st_mtime
+            except OSError:
+                continue
+
+            old_time = mtimes.get(filename)
+            if old_time is None:
+                mtimes[filename] = mtime
+                continue
+            elif mtime > old_time:
+                kill_process_children(worker_process.pid)
+                worker_process.terminate()
+                worker_process = restart_with_reloader()
+                mtimes[filename] = mtime
+                break
+
+        sleep(sleep_interval)

sanic/request.py

@@ -1,26 +1,33 @@
-import sys
 import json
+import sys
+
 from cgi import parse_header
 from collections import namedtuple
 from http.cookies import SimpleCookie
-from httptools import parse_url
 from urllib.parse import parse_qs, urlunparse
 
+from httptools import parse_url
+
+from sanic.exceptions import InvalidUsage
+from sanic.log import error_logger, logger
+
+
 try:
     from ujson import loads as json_loads
 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 sanic.exceptions import InvalidUsage
-from sanic.log import log
-
 
 DEFAULT_HTTP_CONTENT_TYPE = "application/octet-stream"
+
+
 # HTTP/1.1: https://www.w3.org/Protocols/rfc2616/rfc2616-sec7.html#sec7.2.1
 # > If the media type remains unknown, the recipient SHOULD treat it
 # > as type "application/octet-stream"
@@ -42,13 +49,32 @@ class RequestParameters(dict):
 
 class Request(dict):
     """Properties of an HTTP request such as URL, headers, etc."""
+
     __slots__ = (
-        'app', 'headers', 'version', 'method', '_cookies', 'transport',
-        'body', 'parsed_json', 'parsed_args', 'parsed_form', 'parsed_files',
-        '_ip', '_parsed_url', 'uri_template', 'stream', '_remote_addr'
+        "app",
+        "headers",
+        "version",
+        "method",
+        "_cookies",
+        "transport",
+        "body",
+        "parsed_json",
+        "parsed_args",
+        "parsed_form",
+        "parsed_files",
+        "_ip",
+        "_parsed_url",
+        "uri_template",
+        "stream",
+        "_remote_addr",
+        "_socket",
+        "_port",
+        "__weakref__",
+        "raw_url",
     )
 
     def __init__(self, url_bytes, headers, version, method, transport):
+        self.raw_url = url_bytes
         # TODO: Content-Encoding detection
         self._parsed_url = parse_url(url_bytes)
         self.app = None
@@ -59,7 +85,7 @@ class Request(dict):
         self.transport = transport
 
         # Init but do not inhale
-        self.body = []
+        self.body_init()
         self.parsed_json = None
         self.parsed_form = None
         self.parsed_files = None
@@ -68,15 +94,41 @@ class Request(dict):
         self._cookies = None
         self.stream = None
 
+    def __repr__(self):
+        if self.method is None or not self.path:
+            return "<{0}>".format(self.__class__.__name__)
+        return "<{0}: {1} {2}>".format(
+            self.__class__.__name__, self.method, self.path
+        )
+
+    def __bool__(self):
+        if self.transport:
+            return True
+        return False
+
+    def body_init(self):
+        self.body = []
+
+    def body_push(self, data):
+        self.body.append(data)
+
+    def body_finish(self):
+        self.body = b"".join(self.body)
+
     @property
     def json(self):
         if self.parsed_json is None:
-            try:
-                self.parsed_json = json_loads(self.body)
-            except Exception:
-                if not self.body:
-                    return None
-                raise InvalidUsage("Failed when parsing body as json")
+            self.load_json()
+
+        return self.parsed_json
+
+    def load_json(self, loads=json_loads):
+        try:
+            self.parsed_json = loads(self.body)
+        except Exception:
+            if not self.body:
+                return None
+            raise InvalidUsage("Failed when parsing body as json")
 
         return self.parsed_json
 
@@ -86,8 +138,8 @@ class Request(dict):
 
         :return: token related to request
         """
-        prefixes = ('Bearer', 'Token')
-        auth_header = self.headers.get('Authorization')
+        prefixes = ("Bearer", "Token")
+        auth_header = self.headers.get("Authorization")
 
         if auth_header is not None:
             for prefix in prefixes:
@@ -102,19 +154,22 @@ class Request(dict):
             self.parsed_form = RequestParameters()
             self.parsed_files = RequestParameters()
             content_type = self.headers.get(
-                'Content-Type', DEFAULT_HTTP_CONTENT_TYPE)
+                "Content-Type", DEFAULT_HTTP_CONTENT_TYPE
+            )
             content_type, parameters = parse_header(content_type)
             try:
-                if content_type == 'application/x-www-form-urlencoded':
+                if content_type == "application/x-www-form-urlencoded":
                     self.parsed_form = RequestParameters(
-                        parse_qs(self.body.decode('utf-8')))
-                elif content_type == 'multipart/form-data':
+                        parse_qs(self.body.decode("utf-8"))
+                    )
+                elif content_type == "multipart/form-data":
                     # TODO: Stream this instead of reading to/from memory
-                    boundary = parameters['boundary'].encode('utf-8')
-                    self.parsed_form, self.parsed_files = (
-                        parse_multipart_form(self.body, boundary))
+                    boundary = parameters["boundary"].encode("utf-8")
+                    self.parsed_form, self.parsed_files = parse_multipart_form(
+                        self.body, boundary
+                    )
             except Exception:
-                log.exception("Failed when parsing form")
+                error_logger.exception("Failed when parsing form")
 
         return self.parsed_form
 
@@ -130,7 +185,8 @@ class Request(dict):
         if self.parsed_args is None:
             if self.query_string:
                 self.parsed_args = RequestParameters(
-                    parse_qs(self.query_string))
+                    parse_qs(self.query_string)
+                )
             else:
                 self.parsed_args = RequestParameters()
         return self.parsed_args
@@ -142,52 +198,74 @@ class Request(dict):
     @property
     def cookies(self):
         if self._cookies is None:
-            cookie = self.headers.get('Cookie')
+            cookie = self.headers.get("Cookie")
             if cookie is not None:
                 cookies = SimpleCookie()
                 cookies.load(cookie)
-                self._cookies = {name: cookie.value
-                                 for name, cookie in cookies.items()}
+                self._cookies = {
+                    name: cookie.value for name, cookie in cookies.items()
+                }
             else:
                 self._cookies = {}
         return self._cookies
 
     @property
     def ip(self):
-        if not hasattr(self, '_ip'):
-            self._ip = (self.transport.get_extra_info('peername') or
-                        (None, None))
+        if not hasattr(self, "_socket"):
+            self._get_address()
         return self._ip
 
+    @property
+    def port(self):
+        if not hasattr(self, "_socket"):
+            self._get_address()
+        return self._port
+
+    @property
+    def socket(self):
+        if not hasattr(self, "_socket"):
+            self._get_address()
+        return self._socket
+
+    def _get_address(self):
+        self._socket = self.transport.get_extra_info("peername") or (
+            None,
+            None,
+        )
+        self._ip = self._socket[0]
+        self._port = self._socket[1]
+
     @property
     def remote_addr(self):
         """Attempt to return the original client ip based on X-Forwarded-For.
 
         :return: original client ip.
         """
-        if not hasattr(self, '_remote_addr'):
-            forwarded_for = self.headers.get('X-Forwarded-For', '').split(',')
+        if not hasattr(self, "_remote_addr"):
+            forwarded_for = self.headers.get("X-Forwarded-For", "").split(",")
             remote_addrs = [
-                addr for addr in [
-                    addr.strip() for addr in forwarded_for
-                ] if addr
+                addr
+                for addr in [addr.strip() for addr in forwarded_for]
+                if addr
             ]
             if len(remote_addrs) > 0:
                 self._remote_addr = remote_addrs[0]
             else:
-                self._remote_addr = ''
+                self._remote_addr = ""
         return self._remote_addr
 
     @property
     def scheme(self):
-        if self.app.websocket_enabled \
-                and self.headers.get('upgrade') == 'websocket':
-            scheme = 'ws'
+        if (
+            self.app.websocket_enabled
+            and self.headers.get("upgrade") == "websocket"
+        ):
+            scheme = "ws"
         else:
-            scheme = 'http'
+            scheme = "http"
 
-        if self.transport.get_extra_info('sslcontext'):
-            scheme += 's'
+        if self.transport.get_extra_info("sslcontext"):
+            scheme += "s"
 
         return scheme
 
@@ -195,11 +273,11 @@ class Request(dict):
     def host(self):
         # it appears that httptools doesn't return the host
         # so pull it from the headers
-        return self.headers.get('Host', '')
+        return self.headers.get("Host", "")
 
     @property
     def content_type(self):
-        return self.headers.get('Content-Type', DEFAULT_HTTP_CONTENT_TYPE)
+        return self.headers.get("Content-Type", DEFAULT_HTTP_CONTENT_TYPE)
 
     @property
     def match_info(self):
@@ -208,27 +286,23 @@ class Request(dict):
 
     @property
     def path(self):
-        return self._parsed_url.path.decode('utf-8')
+        return self._parsed_url.path.decode("utf-8")
 
     @property
     def query_string(self):
         if self._parsed_url.query:
-            return self._parsed_url.query.decode('utf-8')
+            return self._parsed_url.query.decode("utf-8")
         else:
-            return ''
+            return ""
 
     @property
     def url(self):
-        return urlunparse((
-            self.scheme,
-            self.host,
-            self.path,
-            None,
-            self.query_string,
-            None))
+        return urlunparse(
+            (self.scheme, self.host, self.path, None, self.query_string, None)
+        )
 
 
-File = namedtuple('File', ['type', 'body', 'name'])
+File = namedtuple("File", ["type", "body", "name"])
 
 
 def parse_multipart_form(body, boundary):
@@ -244,42 +318,52 @@ def parse_multipart_form(body, boundary):
     form_parts = body.split(boundary)
     for form_part in form_parts[1:-1]:
         file_name = None
-        file_type = None
+        content_type = "text/plain"
+        content_charset = "utf-8"
         field_name = None
         line_index = 2
         line_end_index = 0
         while not line_end_index == -1:
-            line_end_index = form_part.find(b'\r\n', line_index)
-            form_line = form_part[line_index:line_end_index].decode('utf-8')
+            line_end_index = form_part.find(b"\r\n", line_index)
+            form_line = form_part[line_index:line_end_index].decode("utf-8")
             line_index = line_end_index + 2
 
             if not form_line:
                 break
 
-            colon_index = form_line.index(':')
+            colon_index = form_line.index(":")
             form_header_field = form_line[0:colon_index].lower()
             form_header_value, form_parameters = parse_header(
-                form_line[colon_index + 2:])
+                form_line[colon_index + 2 :]
+            )
 
-            if form_header_field == 'content-disposition':
-                if 'filename' in form_parameters:
-                    file_name = form_parameters['filename']
-                field_name = form_parameters.get('name')
-            elif form_header_field == 'content-type':
-                file_type = form_header_value
+            if form_header_field == "content-disposition":
+                file_name = form_parameters.get("filename")
+                field_name = form_parameters.get("name")
+            elif form_header_field == "content-type":
+                content_type = form_header_value
+                content_charset = form_parameters.get("charset", "utf-8")
 
-        post_data = form_part[line_index:-4]
-        if file_name or file_type:
-            file = File(type=file_type, name=file_name, body=post_data)
-            if field_name in files:
-                files[field_name].append(file)
+        if field_name:
+            post_data = form_part[line_index:-4]
+            if file_name:
+                form_file = File(
+                    type=content_type, name=file_name, body=post_data
+                )
+                if field_name in files:
+                    files[field_name].append(form_file)
+                else:
+                    files[field_name] = [form_file]
             else:
-                files[field_name] = [file]
+                value = post_data.decode(content_charset)
+                if field_name in fields:
+                    fields[field_name].append(value)
+                else:
+                    fields[field_name] = [value]
         else:
-            value = post_data.decode('utf-8')
-            if field_name in fields:
-                fields[field_name].append(value)
-            else:
-                fields[field_name] = [value]
+            logger.debug(
+                "Form-data field does not have a 'name' parameter "
+                "in the Content-Disposition header"
+            )
 
     return fields, files

sanic/response.py

@@ -1,80 +1,23 @@
+from functools import partial
 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 sanic.cookies import CookieJar
+from sanic.helpers import STATUS_CODES, has_message_body, remove_entity_headers
+
 
 try:
     from ujson import dumps as json_dumps
-except:
-    from json import dumps as json_dumps
+except BaseException:
+    from json import dumps
 
-from aiofiles import open as open_async
-
-from sanic.cookies import CookieJar
-
-COMMON_STATUS_CODES = {
-    200: b'OK',
-    400: b'Bad Request',
-    404: b'Not Found',
-    500: b'Internal Server Error',
-}
-ALL_STATUS_CODES = {
-    100: b'Continue',
-    101: b'Switching Protocols',
-    102: b'Processing',
-    200: b'OK',
-    201: b'Created',
-    202: b'Accepted',
-    203: b'Non-Authoritative Information',
-    204: b'No Content',
-    205: b'Reset Content',
-    206: b'Partial Content',
-    207: b'Multi-Status',
-    208: b'Already Reported',
-    226: b'IM Used',
-    300: b'Multiple Choices',
-    301: b'Moved Permanently',
-    302: b'Found',
-    303: b'See Other',
-    304: b'Not Modified',
-    305: b'Use Proxy',
-    307: b'Temporary Redirect',
-    308: b'Permanent Redirect',
-    400: b'Bad Request',
-    401: b'Unauthorized',
-    402: b'Payment Required',
-    403: b'Forbidden',
-    404: b'Not Found',
-    405: b'Method Not Allowed',
-    406: b'Not Acceptable',
-    407: b'Proxy Authentication Required',
-    408: b'Request Timeout',
-    409: b'Conflict',
-    410: b'Gone',
-    411: b'Length Required',
-    412: b'Precondition Failed',
-    413: b'Request Entity Too Large',
-    414: b'Request-URI Too Long',
-    415: b'Unsupported Media Type',
-    416: b'Requested Range Not Satisfiable',
-    417: b'Expectation Failed',
-    422: b'Unprocessable Entity',
-    423: b'Locked',
-    424: b'Failed Dependency',
-    426: b'Upgrade Required',
-    428: b'Precondition Required',
-    429: b'Too Many Requests',
-    431: b'Request Header Fields Too Large',
-    500: b'Internal Server Error',
-    501: b'Not Implemented',
-    502: b'Bad Gateway',
-    503: b'Service Unavailable',
-    504: b'Gateway Timeout',
-    505: b'HTTP Version Not Supported',
-    506: b'Variant Also Negotiates',
-    507: b'Insufficient Storage',
-    508: b'Loop Detected',
-    510: b'Not Extended',
-    511: b'Network Authentication Required'
-}
+    # This is done in order to ensure that the JSON response is
+    # kept consistent across both ujson and inbuilt json usage.
+    json_dumps = partial(dumps, separators=(",", ":"))
 
 
 class BaseHTTPResponse:
@@ -87,16 +30,18 @@ class BaseHTTPResponse:
             return str(data).encode()
 
     def _parse_headers(self):
-        headers = b''
+        headers = b""
         for name, value in self.headers.items():
             try:
-                headers += (
-                    b'%b: %b\r\n' % (
-                        name.encode(), value.encode('utf-8')))
+                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')))
+                headers += b"%b: %b\r\n" % (
+                    str(name).encode(),
+                    str(value).encode("utf-8"),
+                )
 
         return headers
 
@@ -109,18 +54,24 @@ class BaseHTTPResponse:
 
 class StreamingHTTPResponse(BaseHTTPResponse):
     __slots__ = (
-        'transport', 'streaming_fn',
-        'status', 'content_type', 'headers', '_cookies')
+        "protocol",
+        "streaming_fn",
+        "status",
+        "content_type",
+        "headers",
+        "_cookies",
+    )
 
-    def __init__(self, streaming_fn, status=200, headers=None,
-                 content_type='text/plain'):
+    def __init__(
+        self, streaming_fn, status=200, headers=None, content_type="text/plain"
+    ):
         self.content_type = content_type
         self.streaming_fn = streaming_fn
         self.status = status
-        self.headers = headers or {}
+        self.headers = CIMultiDict(headers or {})
         self._cookies = None
 
-    def write(self, data):
+    async def write(self, data):
         """Writes a chunk of data to the streaming response.
 
         :param data: bytes-ish data to be written.
@@ -128,59 +79,69 @@ class StreamingHTTPResponse(BaseHTTPResponse):
         if type(data) != bytes:
             data = self._encode_body(data)
 
-        self.transport.write(
-            b"%x\r\n%b\r\n" % (len(data), data))
+        self.protocol.push_data(b"%x\r\n%b\r\n" % (len(data), data))
+        await self.protocol.drain()
 
     async def stream(
-            self, version="1.1", keep_alive=False, keep_alive_timeout=None):
+        self, version="1.1", keep_alive=False, keep_alive_timeout=None
+    ):
         """Streams headers, runs the `streaming_fn` callback that writes
         content to the response body, then finalizes the response body.
         """
         headers = self.get_headers(
-            version, keep_alive=keep_alive,
-            keep_alive_timeout=keep_alive_timeout)
-        self.transport.write(headers)
-
+            version,
+            keep_alive=keep_alive,
+            keep_alive_timeout=keep_alive_timeout,
+        )
+        self.protocol.push_data(headers)
+        await self.protocol.drain()
         await self.streaming_fn(self)
-        self.transport.write(b'0\r\n\r\n')
+        self.protocol.push_data(b"0\r\n\r\n")
+        # no need to await drain here after this write, because it is the
+        # very last thing we write and nothing needs to wait for it.
 
     def get_headers(
-            self, version="1.1", keep_alive=False, keep_alive_timeout=None):
+        self, version="1.1", keep_alive=False, keep_alive_timeout=None
+    ):
         # This is all returned in a kind-of funky way
         # We tried to make this as fast as possible in pure python
-        timeout_header = b''
+        timeout_header = b""
         if keep_alive and keep_alive_timeout is not None:
-            timeout_header = b'Keep-Alive: %d\r\n' % keep_alive_timeout
+            timeout_header = b"Keep-Alive: %d\r\n" % keep_alive_timeout
 
-        self.headers['Transfer-Encoding'] = 'chunked'
-        self.headers.pop('Content-Length', None)
-        self.headers['Content-Type'] = self.headers.get(
-            'Content-Type', self.content_type)
+        self.headers["Transfer-Encoding"] = "chunked"
+        self.headers.pop("Content-Length", None)
+        self.headers["Content-Type"] = self.headers.get(
+            "Content-Type", self.content_type
+        )
 
         headers = self._parse_headers()
 
-        # Try to pull from the common codes first
-        # Speeds up response rate 6% over pulling from all
-        status = COMMON_STATUS_CODES.get(self.status)
-        if not status:
-            status = ALL_STATUS_CODES.get(self.status)
+        if self.status is 200:
+            status = b"OK"
+        else:
+            status = STATUS_CODES.get(self.status)
 
-        return (b'HTTP/%b %d %b\r\n'
-                b'%b'
-                b'%b\r\n') % (
-                   version.encode(),
-                   self.status,
-                   status,
-                   timeout_header,
-                   headers
-               )
+        return (b"HTTP/%b %d %b\r\n" b"%b" b"%b\r\n") % (
+            version.encode(),
+            self.status,
+            status,
+            timeout_header,
+            headers,
+        )
 
 
 class HTTPResponse(BaseHTTPResponse):
-    __slots__ = ('body', 'status', 'content_type', 'headers', '_cookies')
+    __slots__ = ("body", "status", "content_type", "headers", "_cookies")
 
-    def __init__(self, body=None, status=200, headers=None,
-                 content_type='text/plain', body_bytes=b''):
+    def __init__(
+        self,
+        body=None,
+        status=200,
+        headers=None,
+        content_type="text/plain",
+        body_bytes=b"",
+    ):
         self.content_type = content_type
 
         if body is not None:
@@ -189,42 +150,48 @@ class HTTPResponse(BaseHTTPResponse):
             self.body = body_bytes
 
         self.status = status
-        self.headers = headers or {}
+        self.headers = CIMultiDict(headers or {})
         self._cookies = None
 
-    def output(
-            self, version="1.1", keep_alive=False, keep_alive_timeout=None):
+    def output(self, version="1.1", keep_alive=False, keep_alive_timeout=None):
         # This is all returned in a kind-of funky way
         # We tried to make this as fast as possible in pure python
-        timeout_header = b''
+        timeout_header = b""
         if keep_alive and keep_alive_timeout is not None:
-            timeout_header = b'Keep-Alive: %d\r\n' % keep_alive_timeout
-        self.headers['Content-Length'] = self.headers.get(
-            'Content-Length', len(self.body))
-        self.headers['Content-Type'] = self.headers.get(
-            'Content-Type', self.content_type)
+            timeout_header = b"Keep-Alive: %d\r\n" % keep_alive_timeout
+
+        body = b""
+        if has_message_body(self.status):
+            body = self.body
+            self.headers["Content-Length"] = self.headers.get(
+                "Content-Length", len(self.body)
+            )
+
+        self.headers["Content-Type"] = self.headers.get(
+            "Content-Type", self.content_type
+        )
+
+        if self.status in (304, 412):
+            self.headers = remove_entity_headers(self.headers)
 
         headers = self._parse_headers()
 
-        # Try to pull from the common codes first
-        # Speeds up response rate 6% over pulling from all
-        status = COMMON_STATUS_CODES.get(self.status)
-        if not status:
-            status = ALL_STATUS_CODES.get(self.status, b'UNKNOWN RESPONSE')
+        if self.status is 200:
+            status = b"OK"
+        else:
+            status = STATUS_CODES.get(self.status, b"UNKNOWN RESPONSE")
 
-        return (b'HTTP/%b %d %b\r\n'
-                b'Connection: %b\r\n'
-                b'%b'
-                b'%b\r\n'
-                b'%b') % (
-                   version.encode(),
-                   self.status,
-                   status,
-                   b'keep-alive' if keep_alive else b'close',
-                   timeout_header,
-                   headers,
-                   self.body
-               )
+        return (
+            b"HTTP/%b %d %b\r\n" b"Connection: %b\r\n" b"%b" b"%b\r\n" b"%b"
+        ) % (
+            version.encode(),
+            self.status,
+            status,
+            b"keep-alive" if keep_alive else b"close",
+            timeout_header,
+            headers,
+            body,
+        )
 
     @property
     def cookies(self):
@@ -233,8 +200,14 @@ class HTTPResponse(BaseHTTPResponse):
         return self._cookies
 
 
-def json(body, status=200, headers=None,
-         content_type="application/json", **kwargs):
+def json(
+    body,
+    status=200,
+    headers=None,
+    content_type="application/json",
+    dumps=json_dumps,
+    **kwargs
+):
     """
     Returns response object with body in json format.
 
@@ -243,12 +216,17 @@ def json(body, status=200, headers=None,
     :param headers: Custom Headers.
     :param kwargs: Remaining arguments that are passed to the json encoder.
     """
-    return HTTPResponse(json_dumps(body, **kwargs), headers=headers,
-                        status=status, content_type=content_type)
+    return HTTPResponse(
+        dumps(body, **kwargs),
+        headers=headers,
+        status=status,
+        content_type=content_type,
+    )
 
 
-def text(body, status=200, headers=None,
-         content_type="text/plain; charset=utf-8"):
+def text(
+    body, status=200, headers=None, content_type="text/plain; charset=utf-8"
+):
     """
     Returns response object with body in text format.
 
@@ -258,12 +236,13 @@ def text(body, status=200, headers=None,
     :param content_type: the content type (string) of the response
     """
     return HTTPResponse(
-        body, status=status, headers=headers,
-        content_type=content_type)
+        body, status=status, headers=headers, content_type=content_type
+    )
 
 
-def raw(body, status=200, headers=None,
-        content_type="application/octet-stream"):
+def raw(
+    body, status=200, headers=None, content_type="application/octet-stream"
+):
     """
     Returns response object without encoding the body.
 
@@ -272,8 +251,12 @@ def raw(body, status=200, headers=None,
     :param headers: Custom Headers.
     :param content_type: the content type (string) of the response.
     """
-    return HTTPResponse(body_bytes=body, status=status, headers=headers,
-                        content_type=content_type)
+    return HTTPResponse(
+        body_bytes=body,
+        status=status,
+        headers=headers,
+        content_type=content_type,
+    )
 
 
 def html(body, status=200, headers=None):
@@ -284,50 +267,85 @@ def html(body, status=200, headers=None):
     :param status: Response code.
     :param headers: Custom Headers.
     """
-    return HTTPResponse(body, status=status, headers=headers,
-                        content_type="text/html; charset=utf-8")
+    return HTTPResponse(
+        body,
+        status=status,
+        headers=headers,
+        content_type="text/html; charset=utf-8",
+    )
 
 
-async def file(location, mime_type=None, headers=None, _range=None):
+async def file(
+    location,
+    status=200,
+    mime_type=None,
+    headers=None,
+    filename=None,
+    _range=None,
+):
     """Return a response object with file data.
 
     :param location: Location of file on system.
     :param mime_type: Specific mime_type.
     :param headers: Custom Headers.
+    :param filename: Override filename.
     :param _range:
     """
-    filename = path.split(location)[-1]
+    headers = headers or {}
+    if filename:
+        headers.setdefault(
+            "Content-Disposition", 'attachment; filename="{}"'.format(filename)
+        )
+    filename = filename or path.split(location)[-1]
 
-    async with open_async(location, mode='rb') as _file:
+    async with open_async(location, mode="rb") as _file:
         if _range:
             await _file.seek(_range.start)
             out_stream = await _file.read(_range.size)
-            headers['Content-Range'] = 'bytes %s-%s/%s' % (
-                _range.start, _range.end, _range.total)
+            headers["Content-Range"] = "bytes %s-%s/%s" % (
+                _range.start,
+                _range.end,
+                _range.total,
+            )
+            status = 206
         else:
             out_stream = await _file.read()
 
-    mime_type = mime_type or guess_type(filename)[0] or 'text/plain'
-
-    return HTTPResponse(status=200,
-                        headers=headers,
-                        content_type=mime_type,
-                        body_bytes=out_stream)
+    mime_type = mime_type or guess_type(filename)[0] or "text/plain"
+    return HTTPResponse(
+        status=status,
+        headers=headers,
+        content_type=mime_type,
+        body_bytes=out_stream,
+    )
 
 
-async def file_stream(location, chunk_size=4096, mime_type=None, headers=None,
-                      _range=None):
+async def file_stream(
+    location,
+    status=200,
+    chunk_size=4096,
+    mime_type=None,
+    headers=None,
+    filename=None,
+    _range=None,
+):
     """Return a streaming response object with file data.
 
     :param location: Location of file on system.
     :param chunk_size: The size of each chunk in the stream (in bytes)
     :param mime_type: Specific mime_type.
     :param headers: Custom Headers.
+    :param filename: Override filename.
     :param _range:
     """
-    filename = path.split(location)[-1]
+    headers = headers or {}
+    if filename:
+        headers.setdefault(
+            "Content-Disposition", 'attachment; filename="{}"'.format(filename)
+        )
+    filename = filename or path.split(location)[-1]
 
-    _file = await open_async(location, mode='rb')
+    _file = await open_async(location, mode="rb")
 
     async def _streaming_fn(response):
         nonlocal _file, chunk_size
@@ -341,30 +359,39 @@ async def file_stream(location, chunk_size=4096, mime_type=None, headers=None,
                     if len(content) < 1:
                         break
                     to_send -= len(content)
-                    response.write(content)
+                    await response.write(content)
             else:
                 while True:
                     content = await _file.read(chunk_size)
                     if len(content) < 1:
                         break
-                    response.write(content)
+                    await response.write(content)
         finally:
             await _file.close()
         return  # Returning from this fn closes the stream
 
-    mime_type = mime_type or guess_type(filename)[0] or 'text/plain'
+    mime_type = mime_type or guess_type(filename)[0] or "text/plain"
     if _range:
-        headers['Content-Range'] = 'bytes %s-%s/%s' % (
-            _range.start, _range.end, _range.total)
-    return StreamingHTTPResponse(streaming_fn=_streaming_fn,
-                                 status=200,
-                                 headers=headers,
-                                 content_type=mime_type)
+        headers["Content-Range"] = "bytes %s-%s/%s" % (
+            _range.start,
+            _range.end,
+            _range.total,
+        )
+        status = 206
+    return StreamingHTTPResponse(
+        streaming_fn=_streaming_fn,
+        status=status,
+        headers=headers,
+        content_type=mime_type,
+    )
 
 
 def stream(
-        streaming_fn, status=200, headers=None,
-        content_type="text/plain; charset=utf-8"):
+    streaming_fn,
+    status=200,
+    headers=None,
+    content_type="text/plain; charset=utf-8",
+):
     """Accepts an coroutine `streaming_fn` which can be used to
     write chunks to a streaming response. Returns a `StreamingHTTPResponse`.
 
@@ -384,15 +411,13 @@ def stream(
     :param headers: Custom Headers.
     """
     return StreamingHTTPResponse(
-        streaming_fn,
-        headers=headers,
-        content_type=content_type,
-        status=status
+        streaming_fn, headers=headers, content_type=content_type, status=status
     )
 
 
-def redirect(to, headers=None, status=302,
-             content_type="text/html; charset=utf-8"):
+def redirect(
+    to, headers=None, status=302, content_type="text/html; charset=utf-8"
+):
     """Abort execution and cause a 302 redirect (by default).
 
     :param to: path or fully qualified URL to redirect to
@@ -403,10 +428,12 @@ def redirect(to, headers=None, status=302,
     """
     headers = headers or {}
 
+    # URL Quote the URL before redirecting
+    safe_to = quote_plus(to, safe=":/%#?&=@[]!$&'()*+,;")
+
     # According to RFC 7231, a relative URI is now permitted.
-    headers['Location'] = to
+    headers["Location"] = safe_to
 
     return HTTPResponse(
-        status=status,
-        headers=headers,
-        content_type=content_type)
+        status=status, headers=headers, content_type=content_type
+    )

sanic/router.py

@@ -1,29 +1,38 @@
 import re
+import uuid
+
 from collections import defaultdict, namedtuple
 from collections.abc import Iterable
 from functools import lru_cache
+from urllib.parse import unquote
 
-from sanic.exceptions import NotFound, InvalidUsage
+from sanic.exceptions import MethodNotSupported, NotFound
 from sanic.views import CompositionView
 
+
 Route = namedtuple(
-    'Route',
-    ['handler', 'methods', 'pattern', 'parameters', 'name', 'uri'])
-Parameter = namedtuple('Parameter', ['name', 'cast'])
+    "Route", ["handler", "methods", "pattern", "parameters", "name", "uri"]
+)
+Parameter = namedtuple("Parameter", ["name", "cast"])
 
 REGEX_TYPES = {
-    'string': (str, r'[^/]+'),
-    'int': (int, r'\d+'),
-    'number': (float, r'[0-9\\.]+'),
-    'alpha': (str, r'[A-Za-z]+'),
-    'path': (str, r'[^/].*?'),
+    "string": (str, r"[^/]+"),
+    "int": (int, r"\d+"),
+    "number": (float, r"[0-9\\.]+"),
+    "alpha": (str, r"[A-Za-z]+"),
+    "path": (str, r"[^/].*?"),
+    "uuid": (
+        uuid.UUID,
+        r"[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-"
+        r"[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}",
+    ),
 }
 
 ROUTER_CACHE_SIZE = 1024
 
 
 def url_hash(url):
-    return url.count('/')
+    return url.count("/")
 
 
 class RouteExists(Exception):
@@ -34,6 +43,10 @@ class RouteDoesNotExist(Exception):
     pass
 
 
+class ParameterNameConflicts(Exception):
+    pass
+
+
 class Router:
     """Router supports basic routing with parameters and method checks
 
@@ -60,13 +73,16 @@ class Router:
     also be passed in as the type. The argument given to the function will
     always be a string, independent of the type.
     """
+
     routes_static = None
     routes_dynamic = None
     routes_always_check = None
-    parameter_pattern = re.compile(r'<(.+?)>')
+    parameter_pattern = re.compile(r"<(.+?)>")
 
     def __init__(self):
         self.routes_all = {}
+        self.routes_names = {}
+        self.routes_static_files = {}
         self.routes_static = {}
         self.routes_dynamic = defaultdict(list)
         self.routes_always_check = []
@@ -88,9 +104,13 @@ class Router:
         """
         # We could receive NAME or NAME:PATTERN
         name = parameter_string
-        pattern = 'string'
-        if ':' in parameter_string:
-            name, pattern = parameter_string.split(':', 1)
+        pattern = "string"
+        if ":" in parameter_string:
+            name, pattern = parameter_string.split(":", 1)
+            if not name:
+                raise ValueError(
+                    "Invalid parameter syntax: {}".format(parameter_string)
+                )
 
         default = (str, pattern)
         # Pull from pre-configured types
@@ -98,8 +118,16 @@ class Router:
 
         return name, _type, pattern
 
-    def add(self, uri, methods, handler, host=None, strict_slashes=False,
-            version=None):
+    def add(
+        self,
+        uri,
+        methods,
+        handler,
+        host=None,
+        strict_slashes=False,
+        version=None,
+        name=None,
+    ):
         """Add a handler to the route list
 
         :param uri: path to match
@@ -113,34 +141,47 @@ class Router:
         :return: Nothing
         """
         if version is not None:
-            if uri.startswith('/'):
-                uri = "/".join(["/v{}".format(str(version)), uri[1:]])
-            else:
-                uri = "/".join(["/v{}".format(str(version)), uri])
+            version = re.escape(str(version).strip("/").lstrip("v"))
+            uri = "/".join(["/v{}".format(version), uri.lstrip("/")])
         # add regular version
-        self._add(uri, methods, handler, host)
+        self._add(uri, methods, handler, host, name)
 
         if strict_slashes:
             return
 
+        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
+
         # Add versions with and without trailing /
-        slash_is_missing = (
-            not uri[-1] == '/'
-            and not self.routes_all.get(uri + '/', False)
-        )
+        slashed_methods = self.routes_all.get(uri + "/", frozenset({}))
+        unslashed_methods = self.routes_all.get(uri[:-1], frozenset({}))
+        if isinstance(methods, Iterable):
+            _slash_is_missing = all(
+                method in slashed_methods for method in methods
+            )
+            _without_slash_is_missing = all(
+                method in unslashed_methods for method in methods
+            )
+        else:
+            _slash_is_missing = methods in slashed_methods
+            _without_slash_is_missing = methods in unslashed_methods
+
+        slash_is_missing = not uri[-1] == "/" and not _slash_is_missing
         without_slash_is_missing = (
-            uri[-1] == '/'
-            and not self.routes_all.get(uri[:-1], False)
-            and not uri == '/'
+            uri[-1] == "/" and not _without_slash_is_missing and not uri == "/"
         )
         # add version with trailing slash
         if slash_is_missing:
-            self._add(uri + '/', methods, handler, host)
+            self._add(uri + "/", methods, handler, host, name)
         # add version without trailing slash
         elif without_slash_is_missing:
-            self._add(uri[:-1], methods, handler, host)
+            self._add(uri[:-1], methods, handler, host, name)
 
-    def _add(self, uri, methods, handler, host=None):
+    def _add(self, uri, methods, handler, host=None, name=None):
         """Add a handler to the route list
 
         :param uri: path to match
@@ -148,6 +189,7 @@ class Router:
             provided, any method is allowed
         :param handler: request handler function.
             When executed, it should provide a response object.
+        :param name: user defined route name for url_for
         :return: Nothing
         """
         if host is not None:
@@ -157,11 +199,13 @@ class Router:
 
             else:
                 if not isinstance(host, Iterable):
-                    raise ValueError("Expected either string or Iterable of "
-                                     "host strings, not {!r}".format(host))
+                    raise ValueError(
+                        "Expected either string or Iterable of "
+                        "host strings, not {!r}".format(host)
+                    )
 
                 for host_ in host:
-                    self.add(uri, methods, handler, host_)
+                    self.add(uri, methods, handler, host_, name)
                 return
 
         # Dict for faster lookups of if method allowed
@@ -169,40 +213,48 @@ class Router:
             methods = frozenset(methods)
 
         parameters = []
+        parameter_names = set()
         properties = {"unhashable": None}
 
         def add_parameter(match):
             name = match.group(1)
             name, _type, pattern = self.parse_parameter_string(name)
 
-            parameter = Parameter(
-                name=name, cast=_type)
+            if name in parameter_names:
+                raise ParameterNameConflicts(
+                    "Multiple parameter named <{name}> "
+                    "in route uri {uri}".format(name=name, uri=uri)
+                )
+            parameter_names.add(name)
+
+            parameter = Parameter(name=name, cast=_type)
             parameters.append(parameter)
 
             # Mark the whole route as unhashable if it has the hash key in it
-            if re.search(r'(^|[^^]){1}/', pattern):
-                properties['unhashable'] = True
+            if re.search(r"(^|[^^]){1}/", pattern):
+                properties["unhashable"] = True
             # Mark the route as unhashable if it matches the hash key
-            elif re.search(r'/', pattern):
-                properties['unhashable'] = True
+            elif re.search(r"/", pattern):
+                properties["unhashable"] = True
 
-            return '({})'.format(pattern)
+            return "({})".format(pattern)
 
         pattern_string = re.sub(self.parameter_pattern, add_parameter, uri)
-        pattern = re.compile(r'^{}$'.format(pattern_string))
+        pattern = re.compile(r"^{}$".format(pattern_string))
 
         def merge_route(route, methods, handler):
             # merge to the existing route when possible.
             if not route.methods or not methods:
                 # method-unspecified routes are not mergeable.
-                raise RouteExists(
-                    "Route already registered: {}".format(uri))
+                raise RouteExists("Route already registered: {}".format(uri))
             elif route.methods.intersection(methods):
                 # already existing method is not overloadable.
                 duplicated = methods.intersection(route.methods)
                 raise RouteExists(
                     "Route already registered: {} [{}]".format(
-                        uri, ','.join(list(duplicated))))
+                        uri, ",".join(list(duplicated))
+                    )
+                )
             if isinstance(route.handler, CompositionView):
                 view = route.handler
             else:
@@ -210,42 +262,67 @@ class Router:
                 view.add(route.methods, route.handler)
             view.add(methods, handler)
             route = route._replace(
-                handler=view, methods=methods.union(route.methods))
+                handler=view, methods=methods.union(route.methods)
+            )
             return route
 
         if parameters:
             # TODO: This is too complex, we need to reduce the complexity
-            if properties['unhashable']:
+            if properties["unhashable"]:
                 routes_to_check = self.routes_always_check
                 ndx, route = self.check_dynamic_route_exists(
-                    pattern, routes_to_check)
+                    pattern, routes_to_check, parameters
+                )
             else:
                 routes_to_check = self.routes_dynamic[url_hash(uri)]
                 ndx, route = self.check_dynamic_route_exists(
-                    pattern, routes_to_check)
+                    pattern, routes_to_check, parameters
+                )
             if ndx != -1:
                 # Pop the ndx of the route, no dups of the same route
                 routes_to_check.pop(ndx)
         else:
             route = self.routes_all.get(uri)
 
+        # prefix the handler name with the blueprint name
+        # if available
+        # special prefix for static files
+        is_static = False
+        if name and name.startswith("_static_"):
+            is_static = True
+            name = name.split("_static_", 1)[-1]
+
+        if hasattr(handler, "__blueprintname__"):
+            handler_name = "{}.{}".format(
+                handler.__blueprintname__, name or handler.__name__
+            )
+        else:
+            handler_name = name or getattr(handler, "__name__", None)
+
         if route:
             route = merge_route(route, methods, handler)
         else:
-            # prefix the handler name with the blueprint name
-            # if available
-            if hasattr(handler, '__blueprintname__'):
-                handler_name = '{}.{}'.format(
-                    handler.__blueprintname__, handler.__name__)
-            else:
-                handler_name = getattr(handler, '__name__', None)
-
             route = Route(
-                handler=handler, methods=methods, pattern=pattern,
-                parameters=parameters, name=handler_name, uri=uri)
+                handler=handler,
+                methods=methods,
+                pattern=pattern,
+                parameters=parameters,
+                name=handler_name,
+                uri=uri,
+            )
 
         self.routes_all[uri] = route
-        if properties['unhashable']:
+        if is_static:
+            pair = self.routes_static_files.get(handler_name)
+            if not (pair and (pair[0] + "/" == uri or uri + "/" == pair[0])):
+                self.routes_static_files[handler_name] = (uri, route)
+
+        else:
+            pair = self.routes_names.get(handler_name)
+            if not (pair and (pair[0] + "/" == uri or uri + "/" == pair[0])):
+                self.routes_names[handler_name] = (uri, route)
+
+        if properties["unhashable"]:
             self.routes_always_check.append(route)
         elif parameters:
             self.routes_dynamic[url_hash(uri)].append(route)
@@ -253,9 +330,9 @@ class Router:
             self.routes_static[uri] = route
 
     @staticmethod
-    def check_dynamic_route_exists(pattern, routes_to_check):
+    def check_dynamic_route_exists(pattern, routes_to_check, parameters):
         for ndx, route in enumerate(routes_to_check):
-            if route.pattern == pattern:
+            if route.pattern == pattern and route.parameters == parameters:
                 return ndx, route
         else:
             return -1, None
@@ -265,13 +342,25 @@ class Router:
             uri = host + uri
         try:
             route = self.routes_all.pop(uri)
+            for handler_name, pairs in self.routes_names.items():
+                if pairs[0] == uri:
+                    self.routes_names.pop(handler_name)
+                    break
+
+            for handler_name, pairs in self.routes_static_files.items():
+                if pairs[0] == uri:
+                    self.routes_static_files.pop(handler_name)
+                    break
+
         except KeyError:
             raise RouteDoesNotExist("Route was not registered: {}".format(uri))
 
         if route in self.routes_always_check:
             self.routes_always_check.remove(route)
-        elif url_hash(uri) in self.routes_dynamic \
-                and route in self.routes_dynamic[url_hash(uri)]:
+        elif (
+            url_hash(uri) in self.routes_dynamic
+            and route in self.routes_dynamic[url_hash(uri)]
+        ):
             self.routes_dynamic[url_hash(uri)].remove(route)
         else:
             self.routes_static.pop(uri)
@@ -280,20 +369,20 @@ class Router:
             self._get.cache_clear()
 
     @lru_cache(maxsize=ROUTER_CACHE_SIZE)
-    def find_route_by_view_name(self, view_name):
+    def find_route_by_view_name(self, view_name, name=None):
         """Find a route in the router based on the specified view name.
 
         :param view_name: string of view name to search by
+        :param kwargs: additional params, usually for static files
         :return: tuple containing (uri, Route)
         """
         if not view_name:
             return (None, None)
 
-        for uri, route in self.routes_all.items():
-            if route.name == view_name:
-                return uri, route
+        if view_name == "static" or view_name.endswith(".static"):
+            return self.routes_static_files.get(name, (None, None))
 
-        return (None, None)
+        return self.routes_names.get(view_name, (None, None))
 
     def get(self, request):
         """Get a request handler based on the URL of the request, or raises an
@@ -304,14 +393,25 @@ class Router:
         """
         # No virtual hosts specified; default behavior
         if not self.hosts:
-            return self._get(request.path, request.method, '')
+            return self._get(request.path, request.method, "")
         # virtual hosts specified; try to match route to the host header
         try:
-            return self._get(request.path, request.method,
-                             request.headers.get("Host", ''))
+            return self._get(
+                request.path, request.method, request.headers.get("Host", "")
+            )
         # try default hosts
         except NotFound:
-            return self._get(request.path, request.method, '')
+            return self._get(request.path, request.method, "")
+
+    def get_supported_methods(self, url):
+        """Get a list of supported methods for a url and optional host.
+
+        :param url: URL string (including host)
+        :return: frozenset of supported methods
+        """
+        route = self.routes_all.get(url)
+        # if methods are None then this logic will prevent an error
+        return getattr(route, "methods", None) or frozenset()
 
     @lru_cache(maxsize=ROUTER_CACHE_SIZE)
     def _get(self, url, method, host):
@@ -322,12 +422,14 @@ class Router:
         :param method: request method
         :return: handler, arguments, keyword arguments
         """
-        url = host + url
+        url = unquote(host + url)
         # Check against known static routes
         route = self.routes_static.get(url)
-        method_not_supported = InvalidUsage(
-            'Method {} not allowed for URL {}'.format(
-                method, url), status_code=405)
+        method_not_supported = MethodNotSupported(
+            "Method {} not allowed for URL {}".format(method, url),
+            method=method,
+            allowed_methods=self.get_supported_methods(url),
+        )
         if route:
             if route.methods and method not in route.methods:
                 raise method_not_supported
@@ -353,13 +455,14 @@ class Router:
                     # Route was found but the methods didn't match
                     if route_found:
                         raise method_not_supported
-                    raise NotFound('Requested URL {} not found'.format(url))
+                    raise NotFound("Requested URL {} not found".format(url))
 
-        kwargs = {p.name: p.cast(value)
-                  for value, p
-                  in zip(match.groups(1), route.parameters)}
+        kwargs = {
+            p.name: p.cast(value)
+            for value, p in zip(match.groups(1), route.parameters)
+        }
         route_handler = route.handler
-        if hasattr(route_handler, 'handlers'):
+        if hasattr(route_handler, "handlers"):
             route_handler = route_handler.handlers[method]
         return route_handler, [], kwargs, route.uri
 
@@ -370,9 +473,10 @@ class Router:
         """
         try:
             handler = self.get(request)[0]
-        except (NotFound, InvalidUsage):
+        except (NotFound, MethodNotSupported):
             return False
-        if (hasattr(handler, 'view_class') and
-                hasattr(handler.view_class, request.method.lower())):
+        if hasattr(handler, "view_class") and hasattr(
+            handler.view_class, request.method.lower()
+        ):
             handler = getattr(handler.view_class, request.method.lower())
-        return hasattr(handler, 'is_stream')
+        return hasattr(handler, "is_stream")

sanic/server.py

@@ -1,34 +1,38 @@
 import asyncio
 import os
 import traceback
+
 from functools import partial
 from inspect import isawaitable
 from multiprocessing import Process
-from signal import (
-    SIGTERM, SIGINT,
-    signal as signal_func,
-    Signals
-)
-from socket import (
-    socket,
-    SOL_SOCKET,
-    SO_REUSEADDR,
-)
+from signal import SIG_IGN, SIGINT, SIGTERM, Signals
+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 sanic.exceptions import (
+    InvalidUsage,
+    PayloadTooLarge,
+    RequestTimeout,
+    ServerError,
+    ServiceUnavailable,
+)
+from sanic.log import access_logger, logger
+from sanic.request import Request
+from sanic.response import HTTPResponse
+
 
 try:
-    import uvloop as async_loop
-except ImportError:
-    async_loop = asyncio
+    import uvloop
+
+    asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
+except ImportError:
+    pass
 
-from sanic.log import log, netlog
-from sanic.response import HTTPResponse
-from sanic.request import Request
-from sanic.exceptions import (
-    RequestTimeout, PayloadTooLarge, InvalidUsage, ServerError)
 
 current_time = None
 
@@ -37,45 +41,68 @@ class Signal:
     stopped = False
 
 
-class CIDict(dict):
-    """Case Insensitive dict where all keys are converted to lowercase
-    This does not maintain the inputted case when calling items() or keys()
-    in favor of speed, since headers are case insensitive
-    """
-
-    def get(self, key, default=None):
-        return super().get(key.casefold(), default)
-
-    def __getitem__(self, key):
-        return super().__getitem__(key.casefold())
-
-    def __setitem__(self, key, value):
-        return super().__setitem__(key.casefold(), value)
-
-    def __contains__(self, key):
-        return super().__contains__(key.casefold())
-
-
 class HttpProtocol(asyncio.Protocol):
     __slots__ = (
         # event loop, connection
-        'loop', 'transport', 'connections', 'signal',
+        "loop",
+        "transport",
+        "connections",
+        "signal",
         # request params
-        'parser', 'request', 'url', 'headers',
+        "parser",
+        "request",
+        "url",
+        "headers",
         # request config
-        'request_handler', 'request_timeout', 'request_max_size',
-        'request_class', 'is_request_stream', 'router',
-        # enable or disable access log / error log purpose
-        'has_log',
+        "request_handler",
+        "request_timeout",
+        "response_timeout",
+        "keep_alive_timeout",
+        "request_max_size",
+        "request_class",
+        "is_request_stream",
+        "router",
+        "error_handler",
+        # enable or disable access log purpose
+        "access_log",
         # connection management
-        '_total_request_size', '_timeout_handler', '_last_communication_time',
-        '_is_stream_handler')
+        "_total_request_size",
+        "_request_timeout_handler",
+        "_response_timeout_handler",
+        "_keep_alive_timeout_handler",
+        "_last_request_time",
+        "_last_response_time",
+        "_is_stream_handler",
+        "_not_paused",
+        "_request_handler_task",
+        "_request_stream_task",
+        "_keep_alive",
+        "_header_fragment",
+        "state",
+        "_debug",
+    )
 
-    def __init__(self, *, loop, request_handler, error_handler,
-                 signal=Signal(), connections=set(), request_timeout=60,
-                 request_max_size=None, request_class=None, has_log=True,
-                 keep_alive=True, is_request_stream=False, router=None,
-                 state=None, debug=False, **kwargs):
+    def __init__(
+        self,
+        *,
+        loop,
+        request_handler,
+        error_handler,
+        signal=Signal(),
+        connections=set(),
+        request_timeout=60,
+        response_timeout=60,
+        keep_alive_timeout=5,
+        request_max_size=None,
+        request_class=None,
+        access_log=True,
+        keep_alive=True,
+        is_request_stream=False,
+        router=None,
+        state=None,
+        debug=False,
+        **kwargs
+    ):
         self.loop = loop
         self.transport = None
         self.request = None
@@ -84,33 +111,41 @@ class HttpProtocol(asyncio.Protocol):
         self.headers = None
         self.router = router
         self.signal = signal
-        self.has_log = has_log
+        self.access_log = access_log
         self.connections = connections
         self.request_handler = request_handler
         self.error_handler = error_handler
         self.request_timeout = request_timeout
+        self.response_timeout = response_timeout
+        self.keep_alive_timeout = keep_alive_timeout
         self.request_max_size = request_max_size
         self.request_class = request_class or Request
         self.is_request_stream = is_request_stream
         self._is_stream_handler = False
+        self._not_paused = asyncio.Event(loop=loop)
         self._total_request_size = 0
-        self._timeout_handler = None
+        self._request_timeout_handler = None
+        self._response_timeout_handler = None
+        self._keep_alive_timeout_handler = None
         self._last_request_time = None
+        self._last_response_time = None
         self._request_handler_task = None
         self._request_stream_task = None
         self._keep_alive = keep_alive
-        self._header_fragment = b''
+        self._header_fragment = b""
         self.state = state if state else {}
-        if 'requests_count' not in self.state:
-            self.state['requests_count'] = 0
+        if "requests_count" not in self.state:
+            self.state["requests_count"] = 0
         self._debug = debug
+        self._not_paused.set()
 
     @property
     def keep_alive(self):
         return (
-            self._keep_alive and
-            not self.signal.stopped and
-            self.parser.should_keep_alive())
+            self._keep_alive
+            and not self.signal.stopped
+            and self.parser.should_keep_alive()
+        )
 
     # -------------------------------------------- #
     # Connection
@@ -118,31 +153,78 @@ class HttpProtocol(asyncio.Protocol):
 
     def connection_made(self, transport):
         self.connections.add(self)
-        self._timeout_handler = self.loop.call_later(
-            self.request_timeout, self.connection_timeout)
+        self._request_timeout_handler = self.loop.call_later(
+            self.request_timeout, self.request_timeout_callback
+        )
         self.transport = transport
         self._last_request_time = current_time
 
     def connection_lost(self, exc):
         self.connections.discard(self)
-        self._timeout_handler.cancel()
+        if self._request_handler_task:
+            self._request_handler_task.cancel()
+        if self._request_stream_task:
+            self._request_stream_task.cancel()
+        if self._request_timeout_handler:
+            self._request_timeout_handler.cancel()
+        if self._response_timeout_handler:
+            self._response_timeout_handler.cancel()
+        if self._keep_alive_timeout_handler:
+            self._keep_alive_timeout_handler.cancel()
 
-    def connection_timeout(self):
-        # Check if
+    def pause_writing(self):
+        self._not_paused.clear()
+
+    def resume_writing(self):
+        self._not_paused.set()
+
+    def request_timeout_callback(self):
+        # See the docstring in the RequestTimeout exception, to see
+        # exactly what this timeout is checking for.
+        # Check if elapsed time since request initiated exceeds our
+        # configured maximum request timeout value
         time_elapsed = current_time - self._last_request_time
         if time_elapsed < self.request_timeout:
             time_left = self.request_timeout - time_elapsed
-            self._timeout_handler = (
-                self.loop.call_later(time_left, self.connection_timeout))
+            self._request_timeout_handler = self.loop.call_later(
+                time_left, self.request_timeout_callback
+            )
         else:
             if self._request_stream_task:
                 self._request_stream_task.cancel()
             if self._request_handler_task:
                 self._request_handler_task.cancel()
-            try:
-                raise RequestTimeout('Request Timeout')
-            except RequestTimeout as exception:
-                self.write_error(exception)
+            self.write_error(RequestTimeout("Request Timeout"))
+
+    def response_timeout_callback(self):
+        # Check if elapsed time since response was initiated exceeds our
+        # configured maximum request timeout value
+        time_elapsed = current_time - self._last_request_time
+        if time_elapsed < self.response_timeout:
+            time_left = self.response_timeout - time_elapsed
+            self._response_timeout_handler = self.loop.call_later(
+                time_left, self.response_timeout_callback
+            )
+        else:
+            if self._request_stream_task:
+                self._request_stream_task.cancel()
+            if self._request_handler_task:
+                self._request_handler_task.cancel()
+            self.write_error(ServiceUnavailable("Response Timeout"))
+
+    def keep_alive_timeout_callback(self):
+        # Check if elapsed time since last response exceeds our configured
+        # maximum keep alive timeout value
+        time_elapsed = current_time - self._last_response_time
+        if time_elapsed < self.keep_alive_timeout:
+            time_left = self.keep_alive_timeout - time_elapsed
+            self._keep_alive_timeout_handler = self.loop.call_later(
+                time_left, self.keep_alive_timeout_callback
+            )
+        else:
+            logger.debug("KeepAlive Timeout. Closing connection.")
+            self.transport.close()
+            self.transport = None
 
     # -------------------------------------------- #
     # Parsing
@@ -153,8 +235,7 @@ class HttpProtocol(asyncio.Protocol):
         # memory limits
         self._total_request_size += len(data)
         if self._total_request_size > self.request_max_size:
-            exception = PayloadTooLarge('Payload Too Large')
-            self.write_error(exception)
+            self.write_error(PayloadTooLarge("Payload Too Large"))
 
         # Create parser if this is the first time we're receiving data
         if self.parser is None:
@@ -163,17 +244,16 @@ class HttpProtocol(asyncio.Protocol):
             self.parser = HttpRequestParser(self)
 
         # requests count
-        self.state['requests_count'] = self.state['requests_count'] + 1
+        self.state["requests_count"] = self.state["requests_count"] + 1
 
         # Parse request chunk or close connection
         try:
             self.parser.feed_data(data)
         except HttpParserError:
-            message = 'Bad Request'
+            message = "Bad Request"
             if self._debug:
-                message += '\n' + traceback.format_exc()
-            exception = InvalidUsage(message)
-            self.write_error(exception)
+                message += "\n" + traceback.format_exc()
+            self.write_error(InvalidUsage(message))
 
     def on_url(self, url):
         if not self.url:
@@ -185,28 +265,38 @@ class HttpProtocol(asyncio.Protocol):
         self._header_fragment += name
 
         if value is not None:
-            if self._header_fragment == b'Content-Length' \
-                    and int(value) > self.request_max_size:
-                exception = PayloadTooLarge('Payload Too Large')
-                self.write_error(exception)
-
+            if (
+                self._header_fragment == b"Content-Length"
+                and int(value) > self.request_max_size
+            ):
+                self.write_error(PayloadTooLarge("Payload Too Large"))
+            try:
+                value = value.decode()
+            except UnicodeDecodeError:
+                value = value.decode("latin_1")
             self.headers.append(
-                    (self._header_fragment.decode().casefold(),
-                     value.decode()))
+                (self._header_fragment.decode().casefold(), value)
+            )
 
-            self._header_fragment = b''
+            self._header_fragment = b""
 
     def on_headers_complete(self):
         self.request = self.request_class(
             url_bytes=self.url,
-            headers=CIDict(self.headers),
+            headers=CIMultiDict(self.headers),
             version=self.parser.get_http_version(),
             method=self.parser.get_method().decode(),
-            transport=self.transport
+            transport=self.transport,
         )
+        # Remove any existing KeepAlive handler here,
+        # It will be recreated if required on the new request.
+        if self._keep_alive_timeout_handler:
+            self._keep_alive_timeout_handler.cancel()
+            self._keep_alive_timeout_handler = None
         if self.is_request_stream:
             self._is_stream_handler = self.router.is_stream_handler(
-                self.request)
+                self.request
+            )
             if self._is_stream_handler:
                 self.request.stream = asyncio.Queue()
                 self.execute_request_handler()
@@ -214,159 +304,209 @@ class HttpProtocol(asyncio.Protocol):
     def on_body(self, body):
         if self.is_request_stream and self._is_stream_handler:
             self._request_stream_task = self.loop.create_task(
-                self.request.stream.put(body))
+                self.request.stream.put(body)
+            )
             return
-        self.request.body.append(body)
+        self.request.body_push(body)
 
     def on_message_complete(self):
+        # Entire request (headers and whole body) is received.
+        # We can cancel and remove the request timeout handler now.
+        if self._request_timeout_handler:
+            self._request_timeout_handler.cancel()
+            self._request_timeout_handler = None
         if self.is_request_stream and self._is_stream_handler:
             self._request_stream_task = self.loop.create_task(
-                self.request.stream.put(None))
+                self.request.stream.put(None)
+            )
             return
-        self.request.body = b''.join(self.request.body)
+        self.request.body_finish()
         self.execute_request_handler()
 
     def execute_request_handler(self):
+        self._response_timeout_handler = self.loop.call_later(
+            self.response_timeout, self.response_timeout_callback
+        )
+        self._last_request_time = current_time
         self._request_handler_task = self.loop.create_task(
             self.request_handler(
-                self.request,
-                self.write_response,
-                self.stream_response))
+                self.request, self.write_response, self.stream_response
+            )
+        )
 
     # -------------------------------------------- #
     # Responding
     # -------------------------------------------- #
+    def log_response(self, response):
+        if self.access_log:
+            extra = {"status": getattr(response, "status", 0)}
+
+            if isinstance(response, HTTPResponse):
+                extra["byte"] = len(response.body)
+            else:
+                extra["byte"] = -1
+
+            extra["host"] = "UNKNOWN"
+            if self.request is not None:
+                if self.request.ip:
+                    extra["host"] = "{0}:{1}".format(
+                        self.request.ip, self.request.port
+                    )
+
+                extra["request"] = "{0} {1}".format(
+                    self.request.method, self.request.url
+                )
+            else:
+                extra["request"] = "nil"
+
+            access_logger.info("", extra=extra)
+
     def write_response(self, response):
         """
         Writes response content synchronously to the transport.
         """
+        if self._response_timeout_handler:
+            self._response_timeout_handler.cancel()
+            self._response_timeout_handler = None
         try:
             keep_alive = self.keep_alive
             self.transport.write(
                 response.output(
-                    self.request.version, keep_alive,
-                    self.request_timeout))
-            if self.has_log:
-                netlog.info('', extra={
-                    'status': response.status,
-                    'byte': len(response.body),
-                    'host': '{0}:{1}'.format(self.request.ip[0],
-                                             self.request.ip[1]),
-                    'request': '{0} {1}'.format(self.request.method,
-                                                self.request.url)
-                })
+                    self.request.version, keep_alive, self.keep_alive_timeout
+                )
+            )
+            self.log_response(response)
         except AttributeError:
-            log.error(
-                ('Invalid response object for url {}, '
-                 'Expected Type: HTTPResponse, Actual Type: {}').format(
-                    self.url, type(response)))
-            self.write_error(ServerError('Invalid response type'))
+            logger.error(
+                "Invalid response object for url %s, "
+                "Expected Type: HTTPResponse, Actual Type: %s",
+                self.url,
+                type(response),
+            )
+            self.write_error(ServerError("Invalid response type"))
         except RuntimeError:
-            log.error(
-                'Connection lost before response written @ {}'.format(
-                    self.request.ip))
+            if self._debug:
+                logger.error(
+                    "Connection lost before response written @ %s",
+                    self.request.ip,
+                )
+            keep_alive = False
         except Exception as e:
             self.bail_out(
-                "Writing response failed, connection closed {}".format(
-                    repr(e)))
+                "Writing response failed, connection closed {}".format(repr(e))
+            )
         finally:
             if not keep_alive:
                 self.transport.close()
+                self.transport = None
             else:
-                self._last_request_time = current_time
+                self._keep_alive_timeout_handler = self.loop.call_later(
+                    self.keep_alive_timeout, self.keep_alive_timeout_callback
+                )
+                self._last_response_time = current_time
                 self.cleanup()
 
+    async def drain(self):
+        await self._not_paused.wait()
+
+    def push_data(self, data):
+        self.transport.write(data)
+
     async def stream_response(self, response):
         """
         Streams a response to the client asynchronously. Attaches
         the transport to the response so the response consumer can
         write to the response as needed.
         """
+        if self._response_timeout_handler:
+            self._response_timeout_handler.cancel()
+            self._response_timeout_handler = None
 
         try:
             keep_alive = self.keep_alive
-            response.transport = self.transport
+            response.protocol = self
             await response.stream(
-                self.request.version, keep_alive, self.request_timeout)
-            if self.has_log:
-                netlog.info('', extra={
-                    'status': response.status,
-                    'byte': -1,
-                    'host': '{0}:{1}'.format(self.request.ip[0],
-                                             self.request.ip[1]),
-                    'request': '{0} {1}'.format(self.request.method,
-                                                self.request.url)
-                })
+                self.request.version, keep_alive, self.keep_alive_timeout
+            )
+            self.log_response(response)
         except AttributeError:
-            log.error(
-                ('Invalid response object for url {}, '
-                 'Expected Type: HTTPResponse, Actual Type: {}').format(
-                    self.url, type(response)))
-            self.write_error(ServerError('Invalid response type'))
+            logger.error(
+                "Invalid response object for url %s, "
+                "Expected Type: HTTPResponse, Actual Type: %s",
+                self.url,
+                type(response),
+            )
+            self.write_error(ServerError("Invalid response type"))
         except RuntimeError:
-            log.error(
-                'Connection lost before response written @ {}'.format(
-                    self.request.ip))
+            if self._debug:
+                logger.error(
+                    "Connection lost before response written @ %s",
+                    self.request.ip,
+                )
+            keep_alive = False
         except Exception as e:
             self.bail_out(
-                "Writing response failed, connection closed {}".format(
-                    repr(e)))
+                "Writing response failed, connection closed {}".format(repr(e))
+            )
         finally:
             if not keep_alive:
                 self.transport.close()
+                self.transport = None
             else:
-                self._last_request_time = current_time
+                self._keep_alive_timeout_handler = self.loop.call_later(
+                    self.keep_alive_timeout, self.keep_alive_timeout_callback
+                )
+                self._last_response_time = current_time
                 self.cleanup()
 
     def write_error(self, exception):
+        # An error _is_ a response.
+        # Don't throw a response timeout, when a response _is_ given.
+        if self._response_timeout_handler:
+            self._response_timeout_handler.cancel()
+            self._response_timeout_handler = None
         response = None
         try:
             response = self.error_handler.response(self.request, exception)
-            version = self.request.version if self.request else '1.1'
+            version = self.request.version if self.request else "1.1"
             self.transport.write(response.output(version))
         except RuntimeError:
-            log.error(
-                'Connection lost before error written @ {}'.format(
-                    self.request.ip if self.request else 'Unknown'))
+            if self._debug:
+                logger.error(
+                    "Connection lost before error written @ %s",
+                    self.request.ip if self.request else "Unknown",
+                )
         except Exception as e:
             self.bail_out(
                 "Writing error failed, connection closed {}".format(repr(e)),
-                from_error=True)
+                from_error=True,
+            )
         finally:
-            if self.has_log:
-                extra = dict()
-                if isinstance(response, HTTPResponse):
-                    extra['status'] = response.status
-                    extra['byte'] = len(response.body)
-                else:
-                    extra['status'] = 0
-                    extra['byte'] = -1
-                if self.request:
-                    extra['host'] = '%s:%d' % self.request.ip,
-                    extra['request'] = '%s %s' % (self.request.method,
-                                                  self.url)
-                else:
-                    extra['host'] = 'UNKNOWN'
-                    extra['request'] = 'nil'
-                if self.parser and not (self.keep_alive
-                                        and extra['status'] == 408):
-                    netlog.info('', extra=extra)
-            self.transport.close()
+            if self.parser and (
+                self.keep_alive or getattr(response, "status", 0) == 408
+            ):
+                self.log_response(response)
+            try:
+                self.transport.close()
+            except AttributeError:
+                logger.debug("Connection lost before server could close it.")
 
     def bail_out(self, message, from_error=False):
         if from_error or self.transport.is_closing():
-            log.error(
-                ("Transport closed @ {} and exception "
-                 "experienced during error handling").format(
-                    self.transport.get_extra_info('peername')))
-            log.debug(
-                'Exception:\n{}'.format(traceback.format_exc()))
+            logger.error(
+                "Transport closed @ %s and exception "
+                "experienced during error handling",
+                self.transport.get_extra_info("peername"),
+            )
+            logger.debug("Exception:", exc_info=True)
         else:
-            exception = ServerError(message)
-            self.write_error(exception)
-            log.error(message)
+            self.write_error(ServerError(message))
+            logger.error(message)
 
     def cleanup(self):
+        """This is called when KeepAlive feature is used,
+        it resets the connection in order for it to be able
+        to handle receiving another request on the same connection."""
         self.parser = None
         self.request = None
         self.url = None
@@ -419,15 +559,43 @@ def trigger_events(events, loop):
             loop.run_until_complete(result)
 
 
-def serve(host, port, request_handler, error_handler, before_start=None,
-          after_start=None, before_stop=None, after_stop=None, debug=False,
-          request_timeout=60, ssl=None, sock=None, request_max_size=None,
-          reuse_port=False, loop=None, protocol=HttpProtocol, backlog=100,
-          register_sys_signals=True, run_async=False, connections=None,
-          signal=Signal(), request_class=None, has_log=True, keep_alive=True,
-          is_request_stream=False, router=None, websocket_max_size=None,
-          websocket_max_queue=None, state=None,
-          graceful_shutdown_timeout=15.0):
+def serve(
+    host,
+    port,
+    request_handler,
+    error_handler,
+    before_start=None,
+    after_start=None,
+    before_stop=None,
+    after_stop=None,
+    debug=False,
+    request_timeout=60,
+    response_timeout=60,
+    keep_alive_timeout=5,
+    ssl=None,
+    sock=None,
+    request_max_size=None,
+    reuse_port=False,
+    loop=None,
+    protocol=HttpProtocol,
+    backlog=100,
+    register_sys_signals=True,
+    run_multiple=False,
+    run_async=False,
+    connections=None,
+    signal=Signal(),
+    request_class=None,
+    access_log=True,
+    keep_alive=True,
+    is_request_stream=False,
+    router=None,
+    websocket_max_size=None,
+    websocket_max_queue=None,
+    websocket_read_limit=2 ** 16,
+    websocket_write_limit=2 ** 16,
+    state=None,
+    graceful_shutdown_timeout=15.0,
+):
     """Start asynchronous HTTP Server on an individual process.
 
     :param host: Address to host on
@@ -446,6 +614,8 @@ def serve(host, port, request_handler, error_handler, before_start=None,
                        `app` instance and `loop`
     :param debug: enables debug output (slows server)
     :param request_timeout: time in seconds
+    :param response_timeout: time in seconds
+    :param keep_alive_timeout: time in seconds
     :param ssl: SSLContext
     :param sock: Socket for the server to accept connections from
     :param request_max_size: size in bytes, `None` for no limit
@@ -453,13 +623,26 @@ def serve(host, port, request_handler, error_handler, before_start=None,
     :param loop: asyncio compatible event loop
     :param protocol: subclass of asyncio protocol class
     :param request_class: Request class to use
-    :param has_log: disable/enable access log and error log
+    :param access_log: disable/enable access log
+    :param websocket_max_size: enforces the maximum size for
+                               incoming messages in bytes.
+    :param websocket_max_queue: sets the maximum length of the queue
+                                that holds incoming messages.
+    :param websocket_read_limit: sets the high-water limit of the buffer for
+                                 incoming bytes, the low-water limit is half
+                                 the high-water limit.
+    :param websocket_write_limit: sets the high-water limit of the buffer for
+                                  outgoing bytes, the low-water limit is a
+                                  quarter of the high-water limit.
     :param is_request_stream: disable/enable Request.stream
     :param router: Router object
+    :param graceful_shutdown_timeout: How long take to Force close non-idle
+                                      connection
     :return: Nothing
     """
     if not run_async:
-        loop = async_loop.new_event_loop()
+        # create new event_loop after fork
+        loop = asyncio.new_event_loop()
         asyncio.set_event_loop(loop)
 
     if debug:
@@ -474,14 +657,18 @@ def serve(host, port, request_handler, error_handler, before_start=None,
         request_handler=request_handler,
         error_handler=error_handler,
         request_timeout=request_timeout,
+        response_timeout=response_timeout,
+        keep_alive_timeout=keep_alive_timeout,
         request_max_size=request_max_size,
         request_class=request_class,
-        has_log=has_log,
+        access_log=access_log,
         keep_alive=keep_alive,
         is_request_stream=is_request_stream,
         router=router,
         websocket_max_size=websocket_max_size,
         websocket_max_queue=websocket_max_queue,
+        websocket_read_limit=websocket_read_limit,
+        websocket_write_limit=websocket_write_limit,
         state=state,
         debug=debug,
     )
@@ -493,7 +680,7 @@ def serve(host, port, request_handler, error_handler, before_start=None,
         ssl=ssl,
         reuse_port=reuse_port,
         sock=sock,
-        backlog=backlog
+        backlog=backlog,
     )
 
     # Instead of pulling time at the end of every request,
@@ -507,26 +694,33 @@ def serve(host, port, request_handler, error_handler, before_start=None,
 
     try:
         http_server = loop.run_until_complete(server_coroutine)
-    except:
-        log.exception("Unable to start server")
+    except BaseException:
+        logger.exception("Unable to start server")
         return
 
     trigger_events(after_start, loop)
 
+    # Ignore SIGINT when run_multiple
+    if run_multiple:
+        signal_func(SIGINT, SIG_IGN)
+
     # Register signals for graceful termination
     if register_sys_signals:
-        for _signal in (SIGINT, SIGTERM):
+        _singals = (SIGTERM,) if run_multiple else (SIGINT, SIGTERM)
+        for _signal in _singals:
             try:
                 loop.add_signal_handler(_signal, loop.stop)
             except NotImplementedError:
-                log.warn('Sanic tried to use loop.add_signal_handler but it is'
-                         ' not implemented on this platform.')
+                logger.warning(
+                    "Sanic tried to use loop.add_signal_handler "
+                    "but it is not implemented on this platform."
+                )
     pid = os.getpid()
     try:
-        log.info('Starting worker [{}]'.format(pid))
+        logger.info("Starting worker [%s]", pid)
         loop.run_forever()
     finally:
-        log.info("Stopping worker [{}]".format(pid))
+        logger.info("Stopping worker [%s]", pid)
 
         # Run the on_stop function if provided
         trigger_events(before_stop, loop)
@@ -554,7 +748,7 @@ def serve(host, port, request_handler, error_handler, before_start=None,
         coros = []
         for conn in connections:
             if hasattr(conn, "websocket") and conn.websocket:
-                coros.append(conn.websocket.close_connection(force=True))
+                coros.append(conn.websocket.close_connection())
             else:
                 conn.close()
 
@@ -575,28 +769,29 @@ def serve_multiple(server_settings, workers):
     :param stop_event: if provided, is used as a stop signal
     :return:
     """
-    server_settings['reuse_port'] = True
+    server_settings["reuse_port"] = True
+    server_settings["run_multiple"] = True
 
     # Handling when custom socket is not provided.
-    if server_settings.get('sock') is None:
+    if server_settings.get("sock") is None:
         sock = socket()
         sock.setsockopt(SOL_SOCKET, SO_REUSEADDR, 1)
-        sock.bind((server_settings['host'], server_settings['port']))
+        sock.bind((server_settings["host"], server_settings["port"]))
         sock.set_inheritable(True)
-        server_settings['sock'] = sock
-        server_settings['host'] = None
-        server_settings['port'] = None
+        server_settings["sock"] = sock
+        server_settings["host"] = None
+        server_settings["port"] = None
 
     def sig_handler(signal, frame):
-        log.info("Received signal {}. Shutting down.".format(
-            Signals(signal).name))
+        logger.info("Received signal %s. Shutting down.", Signals(signal).name)
         for process in processes:
-            os.kill(process.pid, SIGINT)
+            os.kill(process.pid, SIGTERM)
 
     signal_func(SIGINT, lambda s, f: sig_handler(s, f))
     signal_func(SIGTERM, lambda s, f: sig_handler(s, f))
 
     processes = []
+
     for _ in range(workers):
         process = Process(target=serve, kwargs=server_settings)
         process.daemon = True
@@ -609,4 +804,4 @@ def serve_multiple(server_settings, workers):
     # the above processes will block this until they're stopped
     for process in processes:
         process.terminate()
-    server_settings.get('sock').close()
+    server_settings.get("sock").close()

sanic/static.py

@@ -1,7 +1,7 @@
 from mimetypes import guess_type
 from os import path
 from re import sub
-from time import strftime, gmtime
+from time import gmtime, strftime
 from urllib.parse import unquote
 
 from aiofiles.os import stat
@@ -13,12 +13,22 @@ from sanic.exceptions import (
     InvalidUsage,
 )
 from sanic.handlers import ContentRangeHandler
-from sanic.response import file, file_stream, HTTPResponse
+from sanic.response import HTTPResponse, file, file_stream
 
 
-def register(app, uri, file_or_directory, pattern,
-             use_modified_since, use_content_range,
-             stream_large_files):
+def register(
+    app,
+    uri,
+    file_or_directory,
+    pattern,
+    use_modified_since,
+    use_content_range,
+    stream_large_files,
+    name="static",
+    host=None,
+    strict_slashes=None,
+    content_type=None,
+):
     # TODO: Though sanic is not a file server, I feel like we should at least
     #       make a good effort here.  Modified-since is nice, but we could
     #       also look into etags, expires, and caching
@@ -39,16 +49,18 @@ def register(app, uri, file_or_directory, pattern,
                               than the file() handler to send the file
                               If this is an integer, this represents the
                               threshold size to switch to file_stream()
+    :param name: user defined name used for url_for
+    :param content_type: user defined content type for header
     """
     # If we're not trying to match a file directly,
     # serve from the folder
     if not path.isfile(file_or_directory):
-        uri += '<file_uri:' + pattern + '>'
+        uri += "<file_uri:" + pattern + ">"
 
     async def _handler(request, file_uri=None):
         # Using this to determine if the URL is trying to break out of the path
         # served.  os.path.realpath seems to be very slow
-        if file_uri and '../' in file_uri:
+        if file_uri and "../" in file_uri:
             raise InvalidUsage("Invalid URL")
         # Merge served directory and requested file if provided
         # Strip all / that in the beginning of the URL to help prevent python
@@ -56,15 +68,16 @@ def register(app, uri, file_or_directory, pattern,
         root_path = file_path = file_or_directory
         if file_uri:
             file_path = path.join(
-                file_or_directory, sub('^[/]*', '', file_uri))
+                file_or_directory, sub("^[/]*", "", file_uri)
+            )
 
         # URL decode the path sent by the browser otherwise we won't be able to
         # match filenames which got encoded (filenames with spaces etc)
         file_path = path.abspath(unquote(file_path))
         if not file_path.startswith(path.abspath(unquote(root_path))):
-            raise FileNotFound('File not found',
-                               path=file_or_directory,
-                               relative_url=file_uri)
+            raise FileNotFound(
+                "File not found", path=file_or_directory, relative_url=file_uri
+            )
         try:
             headers = {}
             # Check if the client has been sent this file before
@@ -73,48 +86,61 @@ def register(app, uri, file_or_directory, pattern,
             if use_modified_since:
                 stats = await stat(file_path)
                 modified_since = strftime(
-                    '%a, %d %b %Y %H:%M:%S GMT', gmtime(stats.st_mtime))
-                if request.headers.get('If-Modified-Since') == modified_since:
+                    "%a, %d %b %Y %H:%M:%S GMT", gmtime(stats.st_mtime)
+                )
+                if request.headers.get("If-Modified-Since") == modified_since:
                     return HTTPResponse(status=304)
-                headers['Last-Modified'] = modified_since
+                headers["Last-Modified"] = modified_since
             _range = None
             if use_content_range:
                 _range = None
                 if not stats:
                     stats = await stat(file_path)
-                headers['Accept-Ranges'] = 'bytes'
-                headers['Content-Length'] = str(stats.st_size)
-                if request.method != 'HEAD':
+                headers["Accept-Ranges"] = "bytes"
+                headers["Content-Length"] = str(stats.st_size)
+                if request.method != "HEAD":
                     try:
                         _range = ContentRangeHandler(request, stats)
                     except HeaderNotFound:
                         pass
                     else:
-                        del headers['Content-Length']
+                        del headers["Content-Length"]
                         for key, value in _range.headers.items():
                             headers[key] = value
-            if request.method == 'HEAD':
-                return HTTPResponse(
-                    headers=headers,
-                    content_type=guess_type(file_path)[0] or 'text/plain')
+            headers["Content-Type"] = (
+                content_type or guess_type(file_path)[0] or "text/plain"
+            )
+            if request.method == "HEAD":
+                return HTTPResponse(headers=headers)
             else:
                 if stream_large_files:
-                    if isinstance(stream_large_files, int):
+                    if type(stream_large_files) == int:
                         threshold = stream_large_files
                     else:
-                        threshold = 1024*1000
+                        threshold = 1024 * 1024
 
                     if not stats:
                         stats = await stat(file_path)
                     if stats.st_size >= threshold:
-                        return await file_stream(file_path, headers=headers,
-                                                 _range=_range)
+                        return await file_stream(
+                            file_path, headers=headers, _range=_range
+                        )
                 return await file(file_path, headers=headers, _range=_range)
         except ContentRangeError:
             raise
         except Exception:
-            raise FileNotFound('File not found',
-                               path=file_or_directory,
-                               relative_url=file_uri)
+            raise FileNotFound(
+                "File not found", path=file_or_directory, relative_url=file_uri
+            )
 
-    app.route(uri, methods=['GET', 'HEAD'])(_handler)
+    # special prefix for static files
+    if not name.startswith("_static_"):
+        name = "_static_{}".format(name)
+
+    app.route(
+        uri,
+        methods=["GET", "HEAD"],
+        name=name,
+        host=host,
+        strict_slashes=strict_slashes,
+    )(_handler)

sanic/testing.py

@@ -1,73 +1,98 @@
-import traceback
 from json import JSONDecodeError
 
-from sanic.log import log
+from sanic.exceptions import MethodNotSupported
+from sanic.log import logger
+from sanic.response import text
 
-HOST = '127.0.0.1'
+
+HOST = "127.0.0.1"
 PORT = 42101
 
 
 class SanicTestClient:
-    def __init__(self, app):
+    def __init__(self, app, port=PORT):
         self.app = app
+        self.port = port
 
     async def _local_request(self, method, uri, cookies=None, *args, **kwargs):
         import aiohttp
-        if uri.startswith(('http:', 'https:', 'ftp:', 'ftps://' '//')):
+
+        if uri.startswith(("http:", "https:", "ftp:", "ftps://" "//")):
             url = uri
         else:
-            url = 'http://{host}:{port}{uri}'.format(
-                host=HOST, port=PORT, uri=uri)
+            url = "http://{host}:{port}{uri}".format(
+                host=HOST, port=self.port, uri=uri
+            )
 
-        log.info(url)
-        conn = aiohttp.TCPConnector(verify_ssl=False)
+        logger.info(url)
+        conn = aiohttp.TCPConnector(ssl=False)
         async with aiohttp.ClientSession(
-                cookies=cookies, connector=conn) as session:
-            async with getattr(
-                    session, method.lower())(url, *args, **kwargs) as response:
+            cookies=cookies, connector=conn
+        ) as session:
+            async with getattr(session, method.lower())(
+                url, *args, **kwargs
+            ) as response:
                 try:
                     response.text = await response.text()
-                except UnicodeDecodeError as e:
+                except UnicodeDecodeError:
                     response.text = None
 
                 try:
                     response.json = await response.json()
-                except (JSONDecodeError,
-                        UnicodeDecodeError,
-                        aiohttp.ClientResponseError):
+                except (
+                    JSONDecodeError,
+                    UnicodeDecodeError,
+                    aiohttp.ClientResponseError,
+                ):
                     response.json = None
 
                 response.body = await response.read()
                 return response
 
     def _sanic_endpoint_test(
-            self, method='get', uri='/', gather_request=True,
-            debug=False, server_kwargs={},
-            *request_args, **request_kwargs):
+        self,
+        method="get",
+        uri="/",
+        gather_request=True,
+        debug=False,
+        server_kwargs={"auto_reload": False},
+        *request_args,
+        **request_kwargs
+    ):
         results = [None, None]
         exceptions = []
 
         if gather_request:
+
             def _collect_request(request):
                 if results[0] is None:
                     results[0] = request
+
             self.app.request_middleware.appendleft(_collect_request)
 
-        @self.app.listener('after_server_start')
+        @self.app.exception(MethodNotSupported)
+        async def error_handler(request, exception):
+            if request.method in ["HEAD", "PATCH", "PUT", "DELETE"]:
+                return text(
+                    "", exception.status_code, headers=exception.headers
+                )
+            else:
+                return self.app.error_handler.default(request, exception)
+
+        @self.app.listener("after_server_start")
         async def _collect_response(sanic, loop):
             try:
                 response = await self._local_request(
-                    method, uri, *request_args,
-                    **request_kwargs)
+                    method, uri, *request_args, **request_kwargs
+                )
                 results[-1] = response
             except Exception as e:
-                log.error(
-                    'Exception:\n{}'.format(traceback.format_exc()))
+                logger.exception("Exception")
                 exceptions.append(e)
             self.app.stop()
 
-        self.app.run(host=HOST, debug=debug, port=PORT, **server_kwargs)
-        self.app.listeners['after_server_start'].pop()
+        self.app.run(host=HOST, debug=debug, port=self.port, **server_kwargs)
+        self.app.listeners["after_server_start"].pop()
 
         if exceptions:
             raise ValueError("Exception during request: {}".format(exceptions))
@@ -76,34 +101,37 @@ class SanicTestClient:
             try:
                 request, response = results
                 return request, response
-            except:
+            except BaseException:
                 raise ValueError(
                     "Request and response object expected, got ({})".format(
-                        results))
+                        results
+                    )
+                )
         else:
             try:
                 return results[-1]
-            except:
+            except BaseException:
                 raise ValueError(
-                    "Request object expected, got ({})".format(results))
+                    "Request object expected, got ({})".format(results)
+                )
 
     def get(self, *args, **kwargs):
-        return self._sanic_endpoint_test('get', *args, **kwargs)
+        return self._sanic_endpoint_test("get", *args, **kwargs)
 
     def post(self, *args, **kwargs):
-        return self._sanic_endpoint_test('post', *args, **kwargs)
+        return self._sanic_endpoint_test("post", *args, **kwargs)
 
     def put(self, *args, **kwargs):
-        return self._sanic_endpoint_test('put', *args, **kwargs)
+        return self._sanic_endpoint_test("put", *args, **kwargs)
 
     def delete(self, *args, **kwargs):
-        return self._sanic_endpoint_test('delete', *args, **kwargs)
+        return self._sanic_endpoint_test("delete", *args, **kwargs)
 
     def patch(self, *args, **kwargs):
-        return self._sanic_endpoint_test('patch', *args, **kwargs)
+        return self._sanic_endpoint_test("patch", *args, **kwargs)
 
     def options(self, *args, **kwargs):
-        return self._sanic_endpoint_test('options', *args, **kwargs)
+        return self._sanic_endpoint_test("options", *args, **kwargs)
 
     def head(self, *args, **kwargs):
-        return self._sanic_endpoint_test('head', *args, **kwargs)
+        return self._sanic_endpoint_test("head", *args, **kwargs)

sanic/views.py

@@ -1,5 +1,5 @@
-from sanic.exceptions import InvalidUsage
 from sanic.constants import HTTP_METHODS
+from sanic.exceptions import InvalidUsage
 
 
 class HTTPMethodView:
@@ -48,6 +48,7 @@ class HTTPMethodView:
         """Return view function for use with the routing system, that
         dispatches request to appropriate handler method.
         """
+
         def view(*args, **kwargs):
             self = view.view_class(*class_args, **class_kwargs)
             return self.dispatch_request(*args, **kwargs)
@@ -94,11 +95,13 @@ class CompositionView:
         for method in methods:
             if method not in HTTP_METHODS:
                 raise InvalidUsage(
-                    '{} is not a valid HTTP method.'.format(method))
+                    "{} is not a valid HTTP method.".format(method)
+                )
 
             if method in self.handlers:
                 raise InvalidUsage(
-                    'Method {} is already registered.'.format(method))
+                    "Method {} is already registered.".format(method)
+                )
             self.handlers[method] = handler
 
     def __call__(self, request, *args, **kwargs):

sanic/websocket.py

@@ -1,22 +1,42 @@
+from httptools import HttpParserUpgrade
+from websockets import ConnectionClosed  # noqa
+from websockets import InvalidHandshake, WebSocketCommonProtocol, handshake
+
 from sanic.exceptions import InvalidUsage
 from sanic.server import HttpProtocol
-from httptools import HttpParserUpgrade
-from websockets import handshake, WebSocketCommonProtocol, InvalidHandshake
-from websockets import ConnectionClosed  # noqa
 
 
 class WebSocketProtocol(HttpProtocol):
-    def __init__(self, *args, websocket_max_size=None,
-                 websocket_max_queue=None, **kwargs):
+    def __init__(
+        self,
+        *args,
+        websocket_timeout=10,
+        websocket_max_size=None,
+        websocket_max_queue=None,
+        websocket_read_limit=2 ** 16,
+        websocket_write_limit=2 ** 16,
+        **kwargs
+    ):
         super().__init__(*args, **kwargs)
         self.websocket = None
+        self.websocket_timeout = websocket_timeout
         self.websocket_max_size = websocket_max_size
         self.websocket_max_queue = websocket_max_queue
+        self.websocket_read_limit = websocket_read_limit
+        self.websocket_write_limit = websocket_write_limit
 
-    def connection_timeout(self):
-        # timeouts make no sense for websocket routes
+    # timeouts make no sense for websocket routes
+    def request_timeout_callback(self):
         if self.websocket is None:
-            super().connection_timeout()
+            super().request_timeout_callback()
+
+    def response_timeout_callback(self):
+        if self.websocket is None:
+            super().response_timeout_callback()
+
+    def keep_alive_timeout_callback(self):
+        if self.websocket is None:
+            super().keep_alive_timeout_callback()
 
     def connection_lost(self, exc):
         if self.websocket is not None:
@@ -41,33 +61,45 @@ class WebSocketProtocol(HttpProtocol):
         else:
             super().write_response(response)
 
-    async def websocket_handshake(self, request):
+    async def websocket_handshake(self, request, subprotocols=None):
         # let the websockets package do the handshake with the client
-        headers = []
-
-        def get_header(k):
-            return request.headers.get(k, '')
-
-        def set_header(k, v):
-            headers.append((k, v))
+        headers = {}
 
         try:
-            key = handshake.check_request(get_header)
-            handshake.build_response(set_header, key)
+            key = handshake.check_request(request.headers)
+            handshake.build_response(headers, key)
         except InvalidHandshake:
-            raise InvalidUsage('Invalid websocket request')
+            raise InvalidUsage("Invalid websocket request")
+
+        subprotocol = None
+        if subprotocols and "Sec-Websocket-Protocol" in request.headers:
+            # select a subprotocol
+            client_subprotocols = [
+                p.strip()
+                for p in request.headers["Sec-Websocket-Protocol"].split(",")
+            ]
+            for p in client_subprotocols:
+                if p in subprotocols:
+                    subprotocol = p
+                    headers["Sec-Websocket-Protocol"] = subprotocol
+                    break
 
         # write the 101 response back to the client
-        rv = b'HTTP/1.1 101 Switching Protocols\r\n'
-        for k, v in headers:
-            rv += k.encode('utf-8') + b': ' + v.encode('utf-8') + b'\r\n'
-        rv += b'\r\n'
+        rv = b"HTTP/1.1 101 Switching Protocols\r\n"
+        for k, v in headers.items():
+            rv += k.encode("utf-8") + b": " + v.encode("utf-8") + b"\r\n"
+        rv += b"\r\n"
         request.transport.write(rv)
 
         # hook up the websocket protocol
         self.websocket = WebSocketCommonProtocol(
+            timeout=self.websocket_timeout,
             max_size=self.websocket_max_size,
-            max_queue=self.websocket_max_queue
+            max_queue=self.websocket_max_queue,
+            read_limit=self.websocket_read_limit,
+            write_limit=self.websocket_write_limit,
         )
+        self.websocket.subprotocol = subprotocol
         self.websocket.connection_made(request.transport)
+        self.websocket.connection_open()
         return self.websocket

sanic/worker.py

@@ -1,10 +1,16 @@
-import os
-import sys
-import signal
 import asyncio
 import logging
+import os
+import signal
+import sys
 import traceback
 
+import gunicorn.workers.base as base
+
+from sanic.server import HttpProtocol, Signal, serve, trigger_events
+from sanic.websocket import WebSocketProtocol
+
+
 try:
     import ssl
 except ImportError:
@@ -12,17 +18,17 @@ except ImportError:
 
 try:
     import uvloop
+
     asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
 except ImportError:
     pass
-import gunicorn.workers.base as base
-
-from sanic.server import trigger_events, serve, HttpProtocol, Signal
-from sanic.websocket import WebSocketProtocol
 
 
 class GunicornWorker(base.Worker):
 
+    http_protocol = HttpProtocol
+    websocket_protocol = WebSocketProtocol
+
     def __init__(self, *args, **kw):  # pragma: no cover
         super().__init__(*args, **kw)
         cfg = self.cfg
@@ -46,37 +52,45 @@ class GunicornWorker(base.Worker):
 
     def run(self):
         is_debug = self.log.loglevel == logging.DEBUG
-        protocol = (WebSocketProtocol if self.app.callable.websocket_enabled
-                    else HttpProtocol)
+        protocol = (
+            self.websocket_protocol
+            if self.app.callable.websocket_enabled
+            else self.http_protocol
+        )
         self._server_settings = self.app.callable._helper(
             loop=self.loop,
             debug=is_debug,
             protocol=protocol,
             ssl=self.ssl_context,
-            run_async=True)
-        self._server_settings['signal'] = self.signal
-        self._server_settings.pop('sock')
-        trigger_events(self._server_settings.get('before_start', []),
-                       self.loop)
-        self._server_settings['before_start'] = ()
+            run_async=True,
+        )
+        self._server_settings["signal"] = self.signal
+        self._server_settings.pop("sock")
+        trigger_events(
+            self._server_settings.get("before_start", []), self.loop
+        )
+        self._server_settings["before_start"] = ()
 
         self._runner = asyncio.ensure_future(self._run(), loop=self.loop)
         try:
             self.loop.run_until_complete(self._runner)
             self.app.callable.is_running = True
-            trigger_events(self._server_settings.get('after_start', []),
-                           self.loop)
+            trigger_events(
+                self._server_settings.get("after_start", []), self.loop
+            )
             self.loop.run_until_complete(self._check_alive())
-            trigger_events(self._server_settings.get('before_stop', []),
-                           self.loop)
+            trigger_events(
+                self._server_settings.get("before_stop", []), self.loop
+            )
             self.loop.run_until_complete(self.close())
-        except:
+        except BaseException:
             traceback.print_exc()
         finally:
             try:
-                trigger_events(self._server_settings.get('after_stop', []),
-                               self.loop)
-            except:
+                trigger_events(
+                    self._server_settings.get("after_stop", []), self.loop
+                )
+            except BaseException:
                 traceback.print_exc()
             finally:
                 self.loop.close()
@@ -86,8 +100,11 @@ class GunicornWorker(base.Worker):
     async def close(self):
         if self.servers:
             # stop accepting connections
-            self.log.info("Stopping server: %s, connections: %s",
-                          self.pid, len(self.connections))
+            self.log.info(
+                "Stopping server: %s, connections: %s",
+                self.pid,
+                len(self.connections),
+            )
             for server in self.servers:
                 server.close()
                 await server.wait_closed()
@@ -101,8 +118,9 @@ class GunicornWorker(base.Worker):
             # gracefully shutdown timeout
             start_shutdown = 0
             graceful_shutdown_timeout = self.cfg.graceful_timeout
-            while self.connections and \
-                    (start_shutdown < graceful_shutdown_timeout):
+            while self.connections and (
+                start_shutdown < graceful_shutdown_timeout
+            ):
                 await asyncio.sleep(0.1)
                 start_shutdown = start_shutdown + 0.1
 
@@ -111,7 +129,7 @@ class GunicornWorker(base.Worker):
             coros = []
             for conn in self.connections:
                 if hasattr(conn, "websocket") and conn.websocket:
-                    coros.append(conn.websocket.close_connection(force=True))
+                    coros.append(conn.websocket.close_connection())
                 else:
                     conn.close()
             _shutdown = asyncio.gather(*coros, loop=self.loop)
@@ -143,8 +161,8 @@ class GunicornWorker(base.Worker):
                 if self.max_requests and req_count > self.max_requests:
                     self.alive = False
                     self.log.info(
-                            "Max requests exceeded, shutting down: %s", self
-                        )
+                        "Max requests exceeded, shutting down: %s", self
+                    )
                 elif pid == os.getpid() and self.ppid != os.getppid():
                     self.alive = False
                     self.log.info("Parent changed, shutting down: %s", self)
@@ -170,23 +188,29 @@ class GunicornWorker(base.Worker):
     def init_signals(self):
         # Set up signals through the event loop API.
 
-        self.loop.add_signal_handler(signal.SIGQUIT, self.handle_quit,
-                                     signal.SIGQUIT, None)
+        self.loop.add_signal_handler(
+            signal.SIGQUIT, self.handle_quit, signal.SIGQUIT, None
+        )
 
-        self.loop.add_signal_handler(signal.SIGTERM, self.handle_exit,
-                                     signal.SIGTERM, None)
+        self.loop.add_signal_handler(
+            signal.SIGTERM, self.handle_exit, signal.SIGTERM, None
+        )
 
-        self.loop.add_signal_handler(signal.SIGINT, self.handle_quit,
-                                     signal.SIGINT, None)
+        self.loop.add_signal_handler(
+            signal.SIGINT, self.handle_quit, signal.SIGINT, None
+        )
 
-        self.loop.add_signal_handler(signal.SIGWINCH, self.handle_winch,
-                                     signal.SIGWINCH, None)
+        self.loop.add_signal_handler(
+            signal.SIGWINCH, self.handle_winch, signal.SIGWINCH, None
+        )
 
-        self.loop.add_signal_handler(signal.SIGUSR1, self.handle_usr1,
-                                     signal.SIGUSR1, None)
+        self.loop.add_signal_handler(
+            signal.SIGUSR1, self.handle_usr1, signal.SIGUSR1, None
+        )
 
-        self.loop.add_signal_handler(signal.SIGABRT, self.handle_abort,
-                                     signal.SIGABRT, None)
+        self.loop.add_signal_handler(
+            signal.SIGABRT, self.handle_abort, signal.SIGABRT, None
+        )
 
         # Don't let SIGTERM and SIGUSR1 disturb active requests
         # by interrupting system calls

setup.cfg

@@ -0,0 +1,17 @@
+[flake8]
+# https://github.com/ambv/black#slices
+# https://github.com/ambv/black#line-breaks--binary-operators
+ignore = E203, W503
+
+
+[isort]
+atomic=true
+default_section = THIRDPARTY
+include_trailing_comma = true
+known_first_party = sanic
+known_third_party = pytest
+line_length = 79
+lines_after_imports = 2
+lines_between_types = 1
+multi_line_output = 3
+not_skip = __init__.py

setup.py

@@ -21,7 +21,7 @@ def open_local(paths, mode='r', encoding='utf8'):
 
 with open_local(['sanic', '__init__.py'], encoding='latin1') as fp:
     try:
-        version = re.findall(r"^__version__ = '([^']+)'\r?$",
+        version = re.findall(r"^__version__ = \"([^']+)\"\r?$",
                              fp.read(), re.M)[0]
     except IndexError:
         raise RuntimeError('Unable to determine version.')
@@ -43,38 +43,35 @@ setup_kwargs = {
     'packages': ['sanic'],
     'platforms': 'any',
     'classifiers': [
-        'Development Status :: 2 - Pre-Alpha',
+        'Development Status :: 4 - Beta',
         'Environment :: Web Environment',
         'License :: OSI Approved :: MIT License',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
     ],
 }
 
-ujson = 'ujson>=1.35'
-uvloop = 'uvloop>=0.5.3'
+env_dependency = '; sys_platform != "win32" and implementation_name == "cpython"'
+ujson = 'ujson>=1.35' + env_dependency
+uvloop = 'uvloop>=0.5.3' + env_dependency
 
 requirements = [
-    'httptools>=0.0.9',
+    'httptools>=0.0.10',
     uvloop,
     ujson,
     'aiofiles>=0.3.0',
-    'websockets>=3.2',
+    'websockets>=6.0,<7.0',
+    'multidict>=4.0,<5.0',
 ]
 if strtobool(os.environ.get("SANIC_NO_UJSON", "no")):
     print("Installing without uJSON")
     requirements.remove(ujson)
 
+# 'nt' means windows OS
 if strtobool(os.environ.get("SANIC_NO_UVLOOP", "no")):
     print("Installing without uvLoop")
     requirements.remove(uvloop)
 
-try:
-    setup_kwargs['install_requires'] = requirements
-    setup(**setup_kwargs)
-except DistutilsPlatformError as exception:
-    requirements.remove(ujson)
-    requirements.remove(uvloop)
-    print("Installing without uJSON or uvLoop")
-    setup_kwargs['install_requires'] = requirements
-    setup(**setup_kwargs)
+setup_kwargs['install_requires'] = requirements
+setup(**setup_kwargs)

tests/conftest.py

@@ -0,0 +1,12 @@
+import sys
+import pytest
+
+from sanic import Sanic
+
+if sys.platform in ['win32', 'cygwin']:
+    collect_ignore = ["test_worker.py"]
+
+
+@pytest.fixture
+def app(request):
+    return Sanic(request.node.name)

tests/static/bp/decode me.txt

@@ -0,0 +1 @@
+I am just a regular static file that needs to have its uri decoded

tests/static/bp/test.file

@@ -0,0 +1 @@
+I am just a regular static file

tests/static/test.html

@@ -0,0 +1,26 @@
+<html>
+<body>
+<pre>
+                 ▄▄▄▄▄
+        ▀▀▀██████▄▄▄       _______________
+      ▄▄▄▄▄  █████████▄  /                 \
+     ▀▀▀▀█████▌ ▀▐▄ ▀▐█ |   Gotta go fast!  |
+   ▀▀█████▄▄ ▀██████▄██ | _________________/
+   ▀▄▄▄▄▄  ▀▀█▄▀█════█▀ |/
+        ▀▀▀▄  ▀▀███ ▀       ▄▄
+     ▄███▀▀██▄████████▄ ▄▀▀▀▀▀▀█▌
+   ██▀▄▄▄██▀▄███▀ ▀▀████      ▄██
+▄▀▀▀▄██▄▀▀▌████▒▒▒▒▒▒███     ▌▄▄▀
+▌    ▐▀████▐███▒▒▒▒▒▐██▌
+▀▄▄▄▄▀   ▀▀████▒▒▒▒▄██▀
+          ▀▀█████████▀
+        ▄▄██▀██████▀█
+      ▄██▀     ▀▀▀  █
+     ▄█             ▐▌
+ ▄▄▄▄█▌              ▀█▄▄▄▄▀▀▄
+▌     ▐                ▀▀▄▄▄▀
+ ▀▀▄▄▀
+
+</pre>
+</body>
+</html>

tests/test_app.py

@@ -0,0 +1,149 @@
+import asyncio
+import logging
+
+import pytest
+
+from sanic.exceptions import SanicException
+from sanic.response import text
+
+
+def test_app_loop_running(app):
+
+    @app.get('/test')
+    async def handler(request):
+        assert isinstance(app.loop, asyncio.AbstractEventLoop)
+        return text('pass')
+
+    request, response = app.test_client.get('/test')
+    assert response.text == 'pass'
+
+
+def test_app_loop_not_running(app):
+    with pytest.raises(SanicException) as excinfo:
+        app.loop
+
+    assert str(excinfo.value) == (
+        'Loop can only be retrieved after the app has started '
+        'running. Not supported with `create_server` function'
+    )
+
+
+def test_app_run_raise_type_error(app):
+
+    with pytest.raises(TypeError) as excinfo:
+        app.run(loop='loop')
+
+    assert str(excinfo.value) == (
+        'loop is not a valid argument. To use an existing loop, '
+        'change to create_server().\nSee more: '
+        'https://sanic.readthedocs.io/en/latest/sanic/deploying.html'
+        '#asynchronous-support'
+    )
+
+
+def test_app_route_raise_value_error(app):
+
+    with pytest.raises(ValueError) as excinfo:
+        @app.route('/test')
+        async def handler():
+            return text('test')
+
+    assert str(excinfo.value) == 'Required parameter `request` missing in the handler() route?'
+
+
+def test_app_handle_request_handler_is_none(app, monkeypatch):
+
+    def mockreturn(*args, **kwargs):
+        return None, [], {}, ''
+
+    # Not sure how to make app.router.get() return None, so use mock here.
+    monkeypatch.setattr(app.router, 'get', mockreturn)
+
+    @app.get('/test')
+    def handler(request):
+        return text('test')
+
+    request, response = app.test_client.get('/test')
+
+    assert response.text == 'Error: \'None\' was returned while requesting a handler from the router'
+
+
+@pytest.mark.parametrize('websocket_enabled', [True, False])
+@pytest.mark.parametrize('enable', [True, False])
+def test_app_enable_websocket(app, websocket_enabled, enable):
+    app.websocket_enabled = websocket_enabled
+    app.enable_websocket(enable=enable)
+
+    assert app.websocket_enabled == enable
+
+    @app.websocket('/ws')
+    async def handler(request, ws):
+        await ws.send('test')
+
+    assert app.websocket_enabled == True
+
+
+def test_handle_request_with_nested_exception(app, monkeypatch):
+
+    err_msg = 'Mock Exception'
+
+    # Not sure how to raise an exception in app.error_handler.response(), use mock here
+    def mock_error_handler_response(*args, **kwargs):
+        raise Exception(err_msg)
+
+    monkeypatch.setattr(app.error_handler, 'response', mock_error_handler_response)
+
+    @app.get('/')
+    def handler(request):
+        raise Exception
+        return text('OK')
+
+    request, response = app.test_client.get('/')
+    assert response.status == 500
+    assert response.text == 'An error occurred while handling an error'
+
+
+def test_handle_request_with_nested_exception_debug(app, monkeypatch):
+
+    err_msg = 'Mock Exception'
+
+    # Not sure how to raise an exception in app.error_handler.response(), use mock here
+    def mock_error_handler_response(*args, **kwargs):
+        raise Exception(err_msg)
+
+    monkeypatch.setattr(app.error_handler, 'response', mock_error_handler_response)
+
+    @app.get('/')
+    def handler(request):
+        raise Exception
+        return text('OK')
+
+    request, response = app.test_client.get('/', debug=True)
+    assert response.status == 500
+    assert response.text.startswith(
+        'Error while handling error: {}\nStack: Traceback (most recent call last):\n'.format(err_msg)
+    )
+
+
+def test_handle_request_with_nested_sanic_exception(app, monkeypatch, caplog):
+
+    # Not sure how to raise an exception in app.error_handler.response(), use mock here
+    def mock_error_handler_response(*args, **kwargs):
+        raise SanicException('Mock SanicException')
+
+    monkeypatch.setattr(app.error_handler, 'response', mock_error_handler_response)
+
+    @app.get('/')
+    def handler(request):
+        raise Exception
+        return text('OK')
+
+    with caplog.at_level(logging.ERROR):
+        request, response = app.test_client.get('/')
+    assert response.status == 500
+    assert response.text == 'Error: Mock SanicException'
+    assert caplog.record_tuples[0] == (
+        'sanic.root',
+        logging.ERROR,
+        "Exception occurred while handling uri: 'http://127.0.0.1:42101/'"
+    )

tests/test_bad_request.py

@@ -1,10 +1,9 @@
 import asyncio
-from sanic import Sanic
 
 
-def test_bad_request_response():
-    app = Sanic('test_bad_request_response')
+def test_bad_request_response(app):
     lines = []
+
     @app.listener('after_server_start')
     async def _request(sanic, loop):
         connect = asyncio.open_connection('127.0.0.1', 42101)

tests/test_blueprints.py

@@ -1,21 +1,43 @@
 import asyncio
 import inspect
+import os
+
 import pytest
 
-from sanic import Sanic
+from sanic.app import Sanic
 from sanic.blueprints import Blueprint
-from sanic.response import json, text
-from sanic.exceptions import NotFound, ServerError, InvalidUsage
 from sanic.constants import HTTP_METHODS
+from sanic.exceptions import NotFound, ServerError, InvalidUsage
+from sanic.request import Request
+from sanic.response import text, json
+from sanic.views import CompositionView
 
 
 # ------------------------------------------------------------ #
 #  GET
 # ------------------------------------------------------------ #
 
+@pytest.fixture(scope='module')
+def static_file_directory():
+    """The static directory to serve"""
+    current_file = inspect.getfile(inspect.currentframe())
+    current_directory = os.path.dirname(os.path.abspath(current_file))
+    static_directory = os.path.join(current_directory, 'static')
+    return static_directory
+
+
+def get_file_path(static_file_directory, file_name):
+    return os.path.join(static_file_directory, file_name)
+
+
+def get_file_content(static_file_directory, file_name):
+    """The content of the static file to check"""
+    with open(get_file_path(static_file_directory, file_name), 'rb') as file:
+        return file.read()
+
+
 @pytest.mark.parametrize('method', HTTP_METHODS)
-def test_versioned_routes_get(method):
-    app = Sanic('test_shorhand_routes_get')
+def test_versioned_routes_get(app, method):
     bp = Blueprint('test_text')
 
     method = method.lower()
@@ -27,7 +49,7 @@ def test_versioned_routes_get(method):
             return text('OK')
     else:
         print(func)
-        raise
+        raise Exception("{} is not callable".format(func))
 
     app.blueprint(bp)
 
@@ -37,8 +59,7 @@ def test_versioned_routes_get(method):
     assert response.status == 200
 
 
-def test_bp():
-    app = Sanic('test_text')
+def test_bp(app):
     bp = Blueprint('test_text')
 
     @bp.route('/')
@@ -51,23 +72,23 @@ def test_bp():
 
     assert response.text == 'Hello'
 
-def test_bp_strict_slash():
-    app = Sanic('test_route_strict_slash')
+
+def test_bp_strict_slash(app):
     bp = Blueprint('test_text')
 
     @bp.get('/get', strict_slashes=True)
-    def handler(request):
+    def get_handler(request):
         return text('OK')
 
     @bp.post('/post/', strict_slashes=True)
-    def handler(request):
+    def post_handler(request):
         return text('OK')
 
     app.blueprint(bp)
 
     request, response = app.test_client.get('/get')
     assert response.text == 'OK'
-    assert response.json == None
+    assert response.json is None
 
     request, response = app.test_client.get('/get/')
     assert response.status == 404
@@ -79,8 +100,67 @@ def test_bp_strict_slash():
     assert response.status == 404
 
 
-def test_bp_with_url_prefix():
-    app = Sanic('test_text')
+def test_bp_strict_slash_default_value(app):
+    bp = Blueprint('test_text', strict_slashes=True)
+
+    @bp.get('/get')
+    def get_handler(request):
+        return text('OK')
+
+    @bp.post('/post/')
+    def post_handler(request):
+        return text('OK')
+
+    app.blueprint(bp)
+
+    request, response = app.test_client.get('/get/')
+    assert response.status == 404
+
+    request, response = app.test_client.post('/post')
+    assert response.status == 404
+
+
+def test_bp_strict_slash_without_passing_default_value(app):
+    bp = Blueprint('test_text')
+
+    @bp.get('/get')
+    def get_handler(request):
+        return text('OK')
+
+    @bp.post('/post/')
+    def post_handler(request):
+        return text('OK')
+
+    app.blueprint(bp)
+
+    request, response = app.test_client.get('/get/')
+    assert response.text == 'OK'
+
+    request, response = app.test_client.post('/post')
+    assert response.text == 'OK'
+
+
+def test_bp_strict_slash_default_value_can_be_overwritten(app):
+    bp = Blueprint('test_text', strict_slashes=True)
+
+    @bp.get('/get', strict_slashes=False)
+    def get_handler(request):
+        return text('OK')
+
+    @bp.post('/post/', strict_slashes=False)
+    def post_handler(request):
+        return text('OK')
+
+    app.blueprint(bp)
+
+    request, response = app.test_client.get('/get/')
+    assert response.text == 'OK'
+
+    request, response = app.test_client.post('/post')
+    assert response.text == 'OK'
+
+
+def test_bp_with_url_prefix(app):
     bp = Blueprint('test_text', url_prefix='/test1')
 
     @bp.route('/')
@@ -93,8 +173,7 @@ def test_bp_with_url_prefix():
     assert response.text == 'Hello'
 
 
-def test_several_bp_with_url_prefix():
-    app = Sanic('test_text')
+def test_several_bp_with_url_prefix(app):
     bp = Blueprint('test_text', url_prefix='/test1')
     bp2 = Blueprint('test_text2', url_prefix='/test2')
 
@@ -114,16 +193,16 @@ def test_several_bp_with_url_prefix():
     request, response = app.test_client.get('/test2/')
     assert response.text == 'Hello2'
 
-def test_bp_with_host():
-    app = Sanic('test_bp_host')
+
+def test_bp_with_host(app):
     bp = Blueprint('test_bp_host', url_prefix='/test1', host="example.com")
 
     @bp.route('/')
-    def handler(request):
+    def handler1(request):
         return text('Hello')
 
     @bp.route('/', host="sub.example.com")
-    def handler(request):
+    def handler2(request):
         return text('Hello subdomain!')
 
     app.blueprint(bp)
@@ -141,8 +220,7 @@ def test_bp_with_host():
     assert response.text == 'Hello subdomain!'
 
 
-def test_several_bp_with_host():
-    app = Sanic('test_text')
+def test_several_bp_with_host(app):
     bp = Blueprint('test_text',
                    url_prefix='/test',
                    host="example.com")
@@ -155,14 +233,13 @@ def test_several_bp_with_host():
         return text('Hello')
 
     @bp2.route('/')
-    def handler2(request):
+    def handler1(request):
         return text('Hello2')
 
     @bp2.route('/other/')
     def handler2(request):
         return text('Hello3')
 
-
     app.blueprint(bp)
     app.blueprint(bp2)
 
@@ -185,8 +262,8 @@ def test_several_bp_with_host():
         headers=headers)
     assert response.text == 'Hello3'
 
-def test_bp_middleware():
-    app = Sanic('test_middleware')
+
+def test_bp_middleware(app):
     blueprint = Blueprint('test_middleware')
 
     @blueprint.middleware('response')
@@ -204,8 +281,8 @@ def test_bp_middleware():
     assert response.status == 200
     assert response.text == 'OK'
 
-def test_bp_exception_handler():
-    app = Sanic('test_middleware')
+
+def test_bp_exception_handler(app):
     blueprint = Blueprint('test_middleware')
 
     @blueprint.route('/1')
@@ -229,7 +306,6 @@ def test_bp_exception_handler():
     request, response = app.test_client.get('/1')
     assert response.status == 400
 
-
     request, response = app.test_client.get('/2')
     assert response.status == 200
     assert response.text == 'OK'
@@ -237,8 +313,8 @@ def test_bp_exception_handler():
     request, response = app.test_client.get('/3')
     assert response.status == 200
 
-def test_bp_listeners():
-    app = Sanic('test_middleware')
+
+def test_bp_listeners(app):
     blueprint = Blueprint('test_middleware')
 
     order = []
@@ -271,14 +347,14 @@ def test_bp_listeners():
 
     request, response = app.test_client.get('/')
 
-    assert order == [1,2,3,4,5,6]
+    assert order == [1, 2, 3, 4, 5, 6]
 
-def test_bp_static():
+
+def test_bp_static(app):
     current_file = inspect.getfile(inspect.currentframe())
     with open(current_file, 'rb') as file:
         current_file_contents = file.read()
 
-    app = Sanic('test_static')
     blueprint = Blueprint('test_static')
 
     blueprint.static('/testing.file', current_file)
@@ -289,8 +365,30 @@ def test_bp_static():
     assert response.status == 200
     assert response.body == current_file_contents
 
-def test_bp_shorthand():
-    app = Sanic('test_shorhand_routes')
+
+@pytest.mark.parametrize('file_name', ['test.html'])
+def test_bp_static_content_type(app, file_name):
+    # This is done here, since no other test loads a file here
+    current_file = inspect.getfile(inspect.currentframe())
+    current_directory = os.path.dirname(os.path.abspath(current_file))
+    static_directory = os.path.join(current_directory, 'static')
+
+    blueprint = Blueprint('test_static')
+    blueprint.static(
+        '/testing.file',
+        get_file_path(static_directory, file_name),
+        content_type='text/html; charset=utf-8'
+    )
+
+    app.blueprint(blueprint)
+
+    request, response = app.test_client.get('/testing.file')
+    assert response.status == 200
+    assert response.body == get_file_content(static_directory, file_name)
+    assert response.headers['Content-Type'] == 'text/html; charset=utf-8'
+
+
+def test_bp_shorthand(app):
     blueprint = Blueprint('test_shorhand_routes')
     ev = asyncio.Event()
 
@@ -300,37 +398,37 @@ def test_bp_shorthand():
         return text('OK')
 
     @blueprint.put('/put')
-    def handler(request):
+    def put_handler(request):
         assert request.stream is None
         return text('OK')
 
     @blueprint.post('/post')
-    def handler(request):
+    def post_handler(request):
         assert request.stream is None
         return text('OK')
 
     @blueprint.head('/head')
-    def handler(request):
+    def head_handler(request):
         assert request.stream is None
         return text('OK')
 
     @blueprint.options('/options')
-    def handler(request):
+    def options_handler(request):
         assert request.stream is None
         return text('OK')
 
     @blueprint.patch('/patch')
-    def handler(request):
+    def patch_handler(request):
         assert request.stream is None
         return text('OK')
 
     @blueprint.delete('/delete')
-    def handler(request):
+    def delete_handler(request):
         assert request.stream is None
         return text('OK')
 
-    @blueprint.websocket('/ws')
-    async def handler(request, ws):
+    @blueprint.websocket('/ws/', strict_slashes=True)
+    async def websocket_handler(request, ws):
         assert request.stream is None
         ev.set()
 
@@ -380,10 +478,229 @@ def test_bp_shorthand():
     request, response = app.test_client.get('/delete')
     assert response.status == 405
 
-    request, response = app.test_client.get('/ws', headers={
+    request, response = app.test_client.get('/ws/', headers={
         'Upgrade': 'websocket',
         'Connection': 'upgrade',
         'Sec-WebSocket-Key': 'dGhlIHNhbXBsZSBub25jZQ==',
         'Sec-WebSocket-Version': '13'})
     assert response.status == 101
     assert ev.is_set()
+
+
+def test_bp_group(app):
+    deep_0 = Blueprint('deep_0', url_prefix='/deep')
+    deep_1 = Blueprint('deep_1', url_prefix='/deep1')
+
+    @deep_0.route('/')
+    def handler(request):
+        return text('D0_OK')
+
+    @deep_1.route('/bottom')
+    def bottom_handler(request):
+        return text('D1B_OK')
+
+    mid_0 = Blueprint.group(deep_0, deep_1, url_prefix='/mid')
+    mid_1 = Blueprint('mid_tier', url_prefix='/mid1')
+
+    @mid_1.route('/')
+    def handler1(request):
+        return text('M1_OK')
+
+    top = Blueprint.group(mid_0, mid_1)
+
+    app.blueprint(top)
+
+    @app.route('/')
+    def handler2(request):
+        return text('TOP_OK')
+
+    request, response = app.test_client.get('/')
+    assert response.text == 'TOP_OK'
+
+    request, response = app.test_client.get('/mid1')
+    assert response.text == 'M1_OK'
+
+    request, response = app.test_client.get('/mid/deep')
+    assert response.text == 'D0_OK'
+
+    request, response = app.test_client.get('/mid/deep1/bottom')
+    assert response.text == 'D1B_OK'
+
+
+def test_bp_group_with_default_url_prefix(app):
+    from sanic.response import json
+    bp_resources = Blueprint('bp_resources')
+
+    @bp_resources.get('/')
+    def list_resources_handler(request):
+        resource = {}
+        return json([resource])
+
+    bp_resource = Blueprint('bp_resource', url_prefix='/<resource_id>')
+
+    @bp_resource.get('/')
+    def get_resource_hander(request, resource_id):
+        resource = {'resource_id': resource_id}
+        return json(resource)
+
+    bp_resources_group = Blueprint.group(bp_resources, bp_resource,
+                                         url_prefix='/resources')
+    bp_api_v1 = Blueprint('bp_api_v1')
+
+    @bp_api_v1.get('/info')
+    def api_v1_info(request):
+        return text('api_version: v1')
+
+    bp_api_v1_group = Blueprint.group(bp_api_v1, bp_resources_group,
+                                      url_prefix='/v1')
+    bp_api_group = Blueprint.group(bp_api_v1_group, url_prefix='/api')
+    app.blueprint(bp_api_group)
+
+    request, response = app.test_client.get('/api/v1/info')
+    assert response.text == 'api_version: v1'
+
+    request, response = app.test_client.get('/api/v1/resources')
+    assert response.json == [{}]
+
+    from uuid import uuid4
+    resource_id = str(uuid4())
+    request, response = app.test_client.get(
+        '/api/v1/resources/{0}'.format(resource_id))
+    assert response.json == {'resource_id': resource_id}
+
+
+def test_blueprint_middleware_with_args(app: Sanic):
+    bp = Blueprint(name="with_args_bp", url_prefix="/wa")
+
+    @bp.middleware
+    def middleware_with_no_tag(request: Request):
+        if request.headers.get("content-type") == "application/json":
+            request.headers["accepts"] = "plain/text"
+        else:
+            request.headers["accepts"] = "application/json"
+
+    @bp.route("/")
+    def default_route(request):
+        if request.headers.get("accepts") == "application/json":
+            return json({"test": "value"})
+        else:
+            return text("value")
+
+    app.blueprint(bp)
+
+    _, response = app.test_client.get("/wa", headers={"content-type": "application/json"})
+    assert response.text == "value"
+
+    _, response = app.test_client.get("/wa", headers={"content-type": "plain/text"})
+    assert response.json.get("test") == "value"
+    d = {}
+
+
+@pytest.mark.parametrize('file_name',
+                         ['test.file'])
+def test_static_blueprint_name(app: Sanic, static_file_directory, file_name):
+    current_file = inspect.getfile(inspect.currentframe())
+    with open(current_file, 'rb') as file:
+        current_file_contents = file.read()
+
+    bp = Blueprint(name="static", url_prefix="/static", strict_slashes=False)
+
+    bp.static(
+        "/test.file/",
+        get_file_path(static_file_directory, file_name),
+        name="static.testing",
+        strict_slashes=True)
+
+    app.blueprint(bp)
+
+    uri = app.url_for('static', name='static.testing')
+    assert uri == "/static/test.file"
+
+    _, response = app.test_client.get("/static/test.file")
+    assert response.status == 404
+
+    _, response = app.test_client.get("/static/test.file/")
+    assert response.status == 200
+
+
+def test_route_handler_add(app: Sanic):
+    view = CompositionView()
+
+    async def get_handler(request):
+        return json({
+            "response": "OK"
+        })
+
+    view.add(["GET"], get_handler, stream=False)
+
+    async def default_handler(request):
+        return text("OK")
+
+    bp = Blueprint(name="handler", url_prefix="/handler")
+    bp.add_route(
+        default_handler,
+        uri="/default/",
+        strict_slashes=True)
+
+    bp.add_route(view, uri="/view", name="test")
+
+    app.blueprint(bp)
+
+    _, response = app.test_client.get("/handler/default/")
+    assert response.text == "OK"
+
+    _, response = app.test_client.get("/handler/view")
+    assert response.json["response"] == "OK"
+
+
+def test_websocket_route(app: Sanic):
+    event = asyncio.Event()
+
+    async def websocket_handler(request, ws):
+        assert ws.subprotocol is None
+        event.set()
+
+    bp = Blueprint(name="handler", url_prefix="/ws")
+    bp.add_websocket_route(websocket_handler, "/test", name="test")
+
+    app.blueprint(bp)
+
+    _, response = app.test_client.get("/ws/test", headers={
+        'Upgrade': 'websocket',
+        'Connection': 'upgrade',
+        'Sec-WebSocket-Key': 'dGhlIHNhbXBsZSBub25jZQ==',
+        'Sec-WebSocket-Version': '13'
+    })
+    assert response.status == 101
+    assert event.is_set()
+
+
+def test_duplicate_blueprint(app):
+    bp_name = 'bp'
+    bp = Blueprint(bp_name)
+    bp1 = Blueprint(bp_name)
+
+    app.blueprint(bp)
+
+    with pytest.raises(AssertionError) as excinfo:
+        app.blueprint(bp1)
+
+    assert str(excinfo.value) == (
+        'A blueprint with the name "{}" is already registered.  '
+        'Blueprint names must be unique.'
+    ).format(bp_name)
+
+
+@pytest.mark.parametrize('debug', [True, False, None])
+def test_register_blueprint(app, debug):
+    bp = Blueprint('bp')
+
+    app.debug = debug
+    with pytest.warns(DeprecationWarning) as record:
+        app.register_blueprint(bp)
+    
+    assert record[0].message.args[0] == (
+        "Use of register_blueprint will be deprecated in "
+        "version 1.0.  Please use the blueprint method"
+        " instead"
+    )

tests/test_config.py

@@ -1,12 +1,22 @@
 from os import environ
+from pathlib import Path
+from contextlib import contextmanager
+from tempfile import TemporaryDirectory
+from textwrap import dedent
 import pytest
-from tempfile import NamedTemporaryFile
 
 from sanic import Sanic
+from sanic.exceptions import PyFileError
 
 
-def test_load_from_object():
-    app = Sanic('test_load_from_object')
+@contextmanager
+def temp_path():
+    """ a simple cross platform replacement for NamedTemporaryFile """
+    with TemporaryDirectory() as td:
+        yield Path(td, 'file')
+
+
+def test_load_from_object(app):
     class Config:
         not_for_config = 'should not be used'
         CONFIG_VALUE = 'should be used'
@@ -16,30 +26,52 @@ def test_load_from_object():
     assert app.config.CONFIG_VALUE == 'should be used'
     assert 'not_for_config' not in app.config
 
+
 def test_auto_load_env():
     environ["SANIC_TEST_ANSWER"] = "42"
     app = Sanic()
-    assert app.config.TEST_ANSWER == "42"
+    assert app.config.TEST_ANSWER == 42
     del environ["SANIC_TEST_ANSWER"]
 
-def test_auto_load_env():
+
+def test_dont_load_env():
     environ["SANIC_TEST_ANSWER"] = "42"
     app = Sanic(load_env=False)
-    assert getattr(app.config, 'TEST_ANSWER', None) == None
+    assert getattr(app.config, 'TEST_ANSWER', None) is None
     del environ["SANIC_TEST_ANSWER"]
 
-def test_load_from_file():
-    app = Sanic('test_load_from_file')
-    config = b"""
-VALUE = 'some value'
-condition = 1 == 1
-if condition:
-    CONDITIONAL = 'should be set'
-    """
-    with NamedTemporaryFile() as config_file:
-        config_file.write(config)
-        config_file.seek(0)
-        app.config.from_pyfile(config_file.name)
+
+def test_load_env_prefix():
+    environ["MYAPP_TEST_ANSWER"] = "42"
+    app = Sanic(load_env='MYAPP_')
+    assert app.config.TEST_ANSWER == 42
+    del environ["MYAPP_TEST_ANSWER"]
+
+
+def test_load_env_prefix_float_values():
+    environ["MYAPP_TEST_ROI"] = "2.3"
+    app = Sanic(load_env="MYAPP_")
+    assert app.config.TEST_ROI == 2.3
+    del environ["MYAPP_TEST_ROI"]
+
+
+def test_load_env_prefix_string_value():
+    environ["MYAPP_TEST_TOKEN"] = "somerandomtesttoken"
+    app = Sanic(load_env="MYAPP_")
+    assert app.config.TEST_TOKEN == "somerandomtesttoken"
+    del environ["MYAPP_TEST_TOKEN"]
+
+
+def test_load_from_file(app):
+    config = dedent("""
+    VALUE = 'some value'
+    condition = 1 == 1
+    if condition:
+        CONDITIONAL = 'should be set'
+    """)
+    with temp_path() as config_path:
+        config_path.write_text(config)
+        app.config.from_pyfile(str(config_path))
         assert 'VALUE' in app.config
         assert app.config.VALUE == 'some value'
         assert 'CONDITIONAL' in app.config
@@ -47,33 +79,41 @@ if condition:
         assert 'condition' not in app.config
 
 
-def test_load_from_missing_file():
-    app = Sanic('test_load_from_missing_file')
+def test_load_from_missing_file(app):
     with pytest.raises(IOError):
         app.config.from_pyfile('non-existent file')
 
 
-def test_load_from_envvar():
-    app = Sanic('test_load_from_envvar')
-    config = b"VALUE = 'some value'"
-    with NamedTemporaryFile() as config_file:
-        config_file.write(config)
-        config_file.seek(0)
-        environ['APP_CONFIG'] = config_file.name
+def test_load_from_envvar(app):
+    config = "VALUE = 'some value'"
+    with temp_path() as config_path:
+        config_path.write_text(config)
+        environ['APP_CONFIG'] = str(config_path)
         app.config.from_envvar('APP_CONFIG')
         assert 'VALUE' in app.config
         assert app.config.VALUE == 'some value'
 
 
-def test_load_from_missing_envvar():
-    app = Sanic('test_load_from_missing_envvar')
-    with pytest.raises(RuntimeError):
+def test_load_from_missing_envvar(app):
+    with pytest.raises(RuntimeError) as e:
         app.config.from_envvar('non-existent variable')
+        assert str(e.value) == ("The environment variable 'non-existent "
+                                "variable' is not set and thus configuration "
+                                "could not be loaded.")
 
 
-def test_overwrite_exisiting_config():
-    app = Sanic('test_overwrite_exisiting_config')
+def test_load_config_from_file_invalid_syntax(app):
+    config = "VALUE = some value"
+    with temp_path() as config_path:
+        config_path.write_text(config)
+
+        with pytest.raises(PyFileError):
+            app.config.from_pyfile(config_path)
+
+
+def test_overwrite_exisiting_config(app):
     app.config.DEFAULT = 1
+
     class Config:
         DEFAULT = 2
 
@@ -81,7 +121,17 @@ def test_overwrite_exisiting_config():
     assert app.config.DEFAULT == 2
 
 
-def test_missing_config():
-    app = Sanic('test_missing_config')
-    with pytest.raises(AttributeError):
+def test_overwrite_exisiting_config_ignore_lowercase(app):
+    app.config.default = 1
+
+    class Config:
+        default = 2
+
+    app.config.from_object(Config)
+    assert app.config.default == 1
+
+
+def test_missing_config(app):
+    with pytest.raises(AttributeError) as e:
         app.config.NON_EXISTENT
+        assert str(e.value) == ("Config has no 'NON_EXISTENT'")

tests/test_cookies.py

@@ -1,16 +1,14 @@
 from datetime import datetime, timedelta
 from http.cookies import SimpleCookie
-from sanic import Sanic
-from sanic.response import json, text
+from sanic.response import text
 import pytest
-
+from sanic.cookies import Cookie
 
 # ------------------------------------------------------------ #
 #  GET
 # ------------------------------------------------------------ #
 
-def test_cookies():
-    app = Sanic('test_text')
+def test_cookies(app):
 
     @app.route('/')
     def handler(request):
@@ -25,16 +23,34 @@ def test_cookies():
     assert response.text == 'Cookies are: working!'
     assert response_cookies['right_back'].value == 'at you'
 
+
 @pytest.mark.parametrize("httponly,expected", [
         (False, False),
         (True, True),
 ])
-def test_false_cookies(httponly, expected):
-    app = Sanic('test_text')
+def test_false_cookies_encoded(app, httponly, expected):
 
     @app.route('/')
     def handler(request):
-        response = text('Cookies are: {}'.format(request.cookies['test']))
+        response = text('hello cookies')
+        response.cookies['hello'] = 'world'
+        response.cookies['hello']['httponly'] = httponly
+        return text(response.cookies['hello'].encode('utf8'))
+
+    request, response = app.test_client.get('/')
+
+    assert ('HttpOnly' in response.text) == expected
+
+
+@pytest.mark.parametrize("httponly,expected", [
+        (False, False),
+        (True, True),
+])
+def test_false_cookies(app, httponly, expected):
+
+    @app.route('/')
+    def handler(request):
+        response = text('hello cookies')
         response.cookies['right_back'] = 'at you'
         response.cookies['right_back']['httponly'] = httponly
         return response
@@ -43,10 +59,10 @@ def test_false_cookies(httponly, expected):
     response_cookies = SimpleCookie()
     response_cookies.load(response.headers.get('Set-Cookie', {}))
 
-    'HttpOnly' in response_cookies == expected
+    assert ('HttpOnly' in response_cookies['right_back'].output()) == expected
 
-def test_http2_cookies():
-    app = Sanic('test_http2_cookies')
+
+def test_http2_cookies(app):
 
     @app.route('/')
     async def handler(request):
@@ -58,15 +74,16 @@ def test_http2_cookies():
 
     assert response.text == 'Cookies are: working!'
 
-def test_cookie_options():
-    app = Sanic('test_text')
+
+def test_cookie_options(app):
 
     @app.route('/')
     def handler(request):
         response = text("OK")
         response.cookies['test'] = 'at you'
         response.cookies['test']['httponly'] = True
-        response.cookies['test']['expires'] = datetime.now() + timedelta(seconds=10)
+        response.cookies['test']['expires'] = (datetime.now() +
+                                               timedelta(seconds=10))
         return response
 
     request, response = app.test_client.get('/')
@@ -74,10 +91,10 @@ def test_cookie_options():
     response_cookies.load(response.headers.get('Set-Cookie', {}))
 
     assert response_cookies['test'].value == 'at you'
-    assert response_cookies['test']['httponly'] == True
+    assert response_cookies['test']['httponly'] is True
 
-def test_cookie_deletion():
-    app = Sanic('test_text')
+
+def test_cookie_deletion(app):
 
     @app.route('/')
     def handler(request):
@@ -93,4 +110,82 @@ def test_cookie_deletion():
 
     assert int(response_cookies['i_want_to_die']['max-age']) == 0
     with pytest.raises(KeyError):
-        hold_my_beer = response.cookies['i_never_existed']
+        response.cookies['i_never_existed']
+
+
+def test_cookie_reserved_cookie():
+    with pytest.raises(expected_exception=KeyError) as e:
+        Cookie("domain", "testdomain.com")
+        assert e.message == "Cookie name is a reserved word"
+
+
+def test_cookie_illegal_key_format():
+    with pytest.raises(expected_exception=KeyError) as e:
+        Cookie("testå", "test")
+        assert e.message == "Cookie key contains illegal characters"
+
+
+def test_cookie_set_unknown_property():
+    c = Cookie("test_cookie", "value")
+    with pytest.raises(expected_exception=KeyError) as e:
+        c["invalid"] = "value"
+        assert e.message == "Unknown cookie property"
+
+
+def test_cookie_set_same_key(app):
+
+    cookies = {'test': 'wait'}
+
+    @app.get('/')
+    def handler(request):
+        response = text('pass')
+        response.cookies['test'] = 'modified'
+        response.cookies['test'] = 'pass'
+        return response
+
+    request, response = app.test_client.get('/', cookies=cookies)
+    assert response.status == 200
+    assert response.cookies['test'].value == 'pass'
+
+
+@pytest.mark.parametrize('max_age', ['0', 30, '30'])
+def test_cookie_max_age(app, max_age):
+    cookies = {'test': 'wait'}
+
+    @app.get('/')
+    def handler(request):
+        response = text('pass')
+        response.cookies['test'] = 'pass'
+        response.cookies['test']['max-age'] = max_age
+        return response
+
+    request, response = app.test_client.get('/', cookies=cookies)
+    assert response.status == 200
+
+    assert response.cookies['test'].value == 'pass'
+    assert response.cookies['test']['max-age'] == str(max_age)
+
+
+@pytest.mark.parametrize('expires', [
+    datetime.now() + timedelta(seconds=60), 
+    'Fri, 21-Dec-2018 15:30:00 GMT'
+    ])
+def test_cookie_expires(app, expires):
+    cookies = {'test': 'wait'}
+
+    @app.get('/')
+    def handler(request):
+        response = text('pass')
+        response.cookies['test'] = 'pass'
+        response.cookies['test']['expires'] = expires
+        return response
+
+    request, response = app.test_client.get('/', cookies=cookies)
+    assert response.status == 200
+
+    assert response.cookies['test'].value == 'pass'
+
+    if isinstance(expires, datetime):
+        expires = expires.strftime("%a, %d-%b-%Y %T GMT")
+
+    assert response.cookies['test']['expires'] == expires

tests/test_create_task.py

@@ -1,17 +1,16 @@
-from sanic import Sanic
 from sanic.response import text
 from threading import Event
 import asyncio
+from queue import Queue
 
 
-def test_create_task():
+def test_create_task(app):
     e = Event()
 
     async def coro():
         await asyncio.sleep(0.05)
         e.set()
 
-    app = Sanic('test_create_task')
     app.add_task(coro)
 
     @app.route('/early')
@@ -28,3 +27,19 @@ def test_create_task():
 
     request, response = app.test_client.get('/late')
     assert response.body == b'True'
+
+
+def test_create_task_with_app_arg(app):
+    q = Queue()
+
+    @app.route('/')
+    def not_set(request):
+        return "hello"
+
+    async def coro(app):
+        q.put(app.name)
+
+    app.add_task(coro)
+
+    request, response = app.test_client.get('/')
+    assert q.get() == 'test_create_task_with_app_arg'

tests/test_custom_protocol.py

@@ -1,9 +1,6 @@
-from sanic import Sanic
 from sanic.server import HttpProtocol
 from sanic.response import text
 
-app = Sanic('test_custom_porotocol')
-
 
 class CustomHttpProtocol(HttpProtocol):
 
@@ -16,12 +13,12 @@ class CustomHttpProtocol(HttpProtocol):
         self.transport.close()
 
 
-@app.route('/1')
-async def handler_1(request):
-    return 'OK'
+def test_use_custom_protocol(app):
 
+    @app.route('/1')
+    async def handler_1(request):
+        return 'OK'
 
-def test_use_custom_protocol():
     server_kwargs = {
         'protocol': CustomHttpProtocol
     }

tests/test_custom_request.py

@@ -0,0 +1,53 @@
+from io import BytesIO
+
+from sanic import Sanic
+from sanic.request import Request
+from sanic.response import json_dumps, text
+
+
+class CustomRequest(Request):
+    __slots__ = ("body_buffer",)
+
+    def body_init(self):
+        self.body_buffer = BytesIO()
+
+    def body_push(self, data):
+        self.body_buffer.write(data)
+
+    def body_finish(self):
+        self.body = self.body_buffer.getvalue()
+        self.body_buffer.close()
+
+
+def test_custom_request():
+    app = Sanic(request_class=CustomRequest)
+
+    @app.route("/post", methods=["POST"])
+    async def post_handler(request):
+        return text("OK")
+
+    @app.route("/get")
+    async def get_handler(request):
+        return text("OK")
+
+    payload = {"test": "OK"}
+    headers = {"content-type": "application/json"}
+
+    request, response = app.test_client.post(
+        "/post", data=json_dumps(payload), headers=headers
+    )
+
+    assert isinstance(request.body_buffer, BytesIO)
+    assert request.body_buffer.closed
+    assert request.body == b'{"test":"OK"}'
+    assert request.json.get("test") == "OK"
+    assert response.text == "OK"
+    assert response.status == 200
+
+    request, response = app.test_client.get("/get")
+
+    assert isinstance(request.body_buffer, BytesIO)
+    assert request.body_buffer.closed
+    assert request.body == b""
+    assert response.text == "OK"
+    assert response.status == 200

tests/test_dynamic_routes.py

@@ -1,4 +1,3 @@
-from sanic import Sanic
 from sanic.response import text
 from sanic.router import RouteExists
 import pytest
@@ -10,8 +9,7 @@ import pytest
     ("put", "text", "OK2 test"),
     ("delete", "status", 405),
 ])
-def test_overload_dynamic_routes(method, attr, expected):
-    app = Sanic('test_dynamic_route')
+def test_overload_dynamic_routes(app, method, attr, expected):
 
     @app.route('/overload/<param>', methods=['GET'])
     async def handler1(request, param):
@@ -25,8 +23,7 @@ def test_overload_dynamic_routes(method, attr, expected):
     assert getattr(response, attr) == expected
 
 
-def test_overload_dynamic_routes_exist():
-    app = Sanic('test_dynamic_route')
+def test_overload_dynamic_routes_exist(app):
 
     @app.route('/overload/<param>', methods=['GET'])
     async def handler1(request, param):

tests/test_exceptions.py

@@ -31,14 +31,18 @@ def exception_app():
     def handler_403(request):
         raise Forbidden("Forbidden")
 
+    @app.route('/401')
+    def handler_401(request):
+        raise Unauthorized("Unauthorized")
+
     @app.route('/401/basic')
     def handler_401_basic(request):
-        raise Unauthorized("Unauthorized", "Basic", realm="Sanic")
+        raise Unauthorized("Unauthorized", scheme="Basic", realm="Sanic")
 
     @app.route('/401/digest')
     def handler_401_digest(request):
         raise Unauthorized("Unauthorized",
-                           "Digest",
+                           scheme="Digest",
                            realm="Sanic",
                            qop="auth, auth-int",
                            algorithm="MD5",
@@ -47,17 +51,25 @@ def exception_app():
 
     @app.route('/401/bearer')
     def handler_401_bearer(request):
-        raise Unauthorized("Unauthorized", "Bearer")
+        raise Unauthorized("Unauthorized", scheme="Bearer")
 
     @app.route('/invalid')
     def handler_invalid(request):
         raise InvalidUsage("OK")
 
+    @app.route('/abort/401')
+    def handler_401_error(request):
+        abort(401)
+
     @app.route('/abort')
-    def handler_invalid(request):
+    def handler_500_error(request):
         abort(500)
         return text("OK")
 
+    @app.route('/abort/message')
+    def handler_abort_message(request):
+        abort(500, message='Abort')
+
     @app.route('/divide_by_zero')
     def handle_unhandled_exception(request):
         1 / 0
@@ -73,8 +85,7 @@ def exception_app():
     return app
 
 
-def test_catch_exception_list():
-    app = Sanic('exception_list')
+def test_catch_exception_list(app):
 
     @app.exception([SanicExceptionTestException, NotFound])
     def exception_list(request, exception):
@@ -124,10 +135,13 @@ def test_forbidden_exception(exception_app):
 
 def test_unauthorized_exception(exception_app):
     """Test the built-in Unauthorized exception"""
+    request, response = exception_app.test_client.get('/401')
+    assert response.status == 401
+
     request, response = exception_app.test_client.get('/401/basic')
     assert response.status == 401
     assert response.headers.get('WWW-Authenticate') is not None
-    assert response.headers.get('WWW-Authenticate') == "Basic realm='Sanic'"
+    assert response.headers.get('WWW-Authenticate') == 'Basic realm="Sanic"'
 
     request, response = exception_app.test_client.get('/401/digest')
     assert response.status == 401
@@ -135,10 +149,10 @@ def test_unauthorized_exception(exception_app):
     auth_header = response.headers.get('WWW-Authenticate')
     assert auth_header is not None
     assert auth_header.startswith('Digest')
-    assert "qop='auth, auth-int'" in auth_header
-    assert "algorithm='MD5'" in auth_header
-    assert "nonce='abcdef'" in auth_header
-    assert "opaque='zyxwvu'" in auth_header
+    assert 'qop="auth, auth-int"' in auth_header
+    assert 'algorithm="MD5"' in auth_header
+    assert 'nonce="abcdef"' in auth_header
+    assert 'opaque="zyxwvu"' in auth_header
 
     request, response = exception_app.test_client.get('/401/bearer')
     assert response.status == 401
@@ -175,7 +189,7 @@ def test_exception_in_exception_handler_debug_off(exception_app):
     assert response.body == b'An error occurred while handling an error'
 
 
-def test_exception_in_exception_handler_debug_off(exception_app):
+def test_exception_in_exception_handler_debug_on(exception_app):
     """Test that an exception thrown in an error handler is handled"""
     request, response = exception_app.test_client.get(
         '/error_in_error_handler_handler',
@@ -186,5 +200,12 @@ def test_exception_in_exception_handler_debug_off(exception_app):
 
 def test_abort(exception_app):
     """Test the abort function"""
+    request, response = exception_app.test_client.get('/abort/401')
+    assert response.status == 401
+
     request, response = exception_app.test_client.get('/abort')
     assert response.status == 500
+
+    request, response = exception_app.test_client.get('/abort/message')
+    assert response.status == 500
+    assert response.text == 'Error: Abort'

tests/test_exceptions_handler.py

@@ -131,7 +131,7 @@ def test_exception_handler_lookup():
 
     try:
         ModuleNotFoundError
-    except:
+    except Exception:
         class ModuleNotFoundError(ImportError):
             pass
 

tests/test_helpers.py

@@ -0,0 +1,74 @@
+from sanic import helpers
+
+
+def test_has_message_body():
+    tests = (
+        (100, False),
+        (102, False),
+        (204, False),
+        (200, True),
+        (304, False),
+        (400, True),
+    )
+    for status_code, expected in tests:
+        assert helpers.has_message_body(status_code) is expected
+
+
+def test_is_entity_header():
+    tests = (
+        ("allow", True),
+        ("extension-header", True),
+        ("", False),
+        ("test", False),
+    )
+    for header, expected in tests:
+        assert helpers.is_entity_header(header) is expected
+
+
+def test_is_hop_by_hop_header():
+    tests = (
+        ("connection", True),
+        ("upgrade", True),
+        ("", False),
+        ("test", False),
+    )
+    for header, expected in tests:
+        assert helpers.is_hop_by_hop_header(header) is expected
+
+
+def test_remove_entity_headers():
+    tests = (
+        (
+            {},
+            {}
+        ),
+        (
+            {
+                "Allow": "GET, POST, HEAD",
+            },
+            {}
+        ),
+        (
+            {
+                "Content-Type": "application/json",
+                "Expires": "Wed, 21 Oct 2015 07:28:00 GMT",
+                "Foo": "Bar"
+            },
+            {
+                "Expires": "Wed, 21 Oct 2015 07:28:00 GMT",
+                "Foo": "Bar"
+            },
+        ),
+        (
+            {
+                "Allow": "GET, POST, HEAD",
+                "Content-Location": "/test"
+            },
+            {
+                "Content-Location": "/test"
+            },
+        ),
+    )
+
+    for header, expected in tests:
+        assert helpers.remove_entity_headers(header) == expected

tests/test_keep_alive_timeout.py

@@ -0,0 +1,268 @@
+from json import JSONDecodeError
+from sanic import Sanic
+import asyncio
+from asyncio import sleep as aio_sleep
+from sanic.response import text
+from sanic.config import Config
+from sanic import server
+import aiohttp
+from aiohttp import TCPConnector
+from sanic.testing import SanicTestClient, HOST, PORT
+
+
+class ReuseableTCPConnector(TCPConnector):
+    def __init__(self, *args, **kwargs):
+        super(ReuseableTCPConnector, self).__init__(*args, **kwargs)
+        self.old_proto = None
+
+    async def connect(self, req, *args, **kwargs):
+        new_conn = await super(ReuseableTCPConnector, self)\
+                                .connect(req, *args, **kwargs)
+        if self.old_proto is not None:
+            if self.old_proto != new_conn._protocol:
+                raise RuntimeError(
+                    "We got a new connection, wanted the same one!")
+        print(new_conn.__dict__)
+        self.old_proto = new_conn._protocol
+        return new_conn
+
+
+class ReuseableSanicTestClient(SanicTestClient):
+    def __init__(self, app, loop=None):
+        super(ReuseableSanicTestClient, self).__init__(app)
+        if loop is None:
+            loop = asyncio.get_event_loop()
+        self._loop = loop
+        self._server = None
+        self._tcp_connector = None
+        self._session = None
+
+    # Copied from SanicTestClient, but with some changes to reuse the
+    # same loop for the same app.
+    def _sanic_endpoint_test(
+            self, method='get', uri='/', gather_request=True,
+            debug=False, server_kwargs={},
+            *request_args, **request_kwargs):
+        loop = self._loop
+        results = [None, None]
+        exceptions = []
+        do_kill_server = request_kwargs.pop('end_server', False)
+        if gather_request:
+            def _collect_request(request):
+                if results[0] is None:
+                    results[0] = request
+
+            self.app.request_middleware.appendleft(_collect_request)
+
+        @self.app.listener('after_server_start')
+        async def _collect_response(loop):
+            try:
+                if do_kill_server:
+                    request_kwargs['end_session'] = True
+                response = await self._local_request(
+                    method, uri, *request_args,
+                    **request_kwargs)
+                results[-1] = response
+            except Exception as e2:
+                import traceback
+                traceback.print_tb(e2.__traceback__)
+                exceptions.append(e2)
+            # Don't stop here! self.app.stop()
+
+        if self._server is not None:
+            _server = self._server
+        else:
+            _server_co = self.app.create_server(host=HOST, debug=debug,
+                                                port=PORT, **server_kwargs)
+
+            server.trigger_events(
+                self.app.listeners['before_server_start'], loop)
+
+            try:
+                loop._stopping = False
+                http_server = loop.run_until_complete(_server_co)
+            except Exception as e1:
+                import traceback
+                traceback.print_tb(e1.__traceback__)
+                raise e1
+            self._server = _server = http_server
+        server.trigger_events(
+            self.app.listeners['after_server_start'], loop)
+        self.app.listeners['after_server_start'].pop()
+
+        if do_kill_server:
+            try:
+                _server.close()
+                self._server = None
+                loop.run_until_complete(_server.wait_closed())
+                self.app.stop()
+            except Exception as e3:
+                import traceback
+                traceback.print_tb(e3.__traceback__)
+                exceptions.append(e3)
+        if exceptions:
+            raise ValueError(
+                "Exception during request: {}".format(exceptions))
+
+        if gather_request:
+            self.app.request_middleware.pop()
+            try:
+                request, response = results
+                return request, response
+            except Exception:
+                raise ValueError(
+                    "Request and response object expected, got ({})".format(
+                        results))
+        else:
+            try:
+                return results[-1]
+            except Exception:
+                raise ValueError(
+                    "Request object expected, got ({})".format(results))
+
+    # Copied from SanicTestClient, but with some changes to reuse the
+    # same TCPConnection and the sane ClientSession more than once.
+    # Note, you cannot use the same session if you are in a _different_
+    # loop, so the changes above are required too.
+    async def _local_request(self, method, uri, cookies=None, *args,
+                             **kwargs):
+        request_keepalive = kwargs.pop('request_keepalive',
+                                       Config.KEEP_ALIVE_TIMEOUT)
+        if uri.startswith(('http:', 'https:', 'ftp:', 'ftps://' '//')):
+            url = uri
+        else:
+            url = 'http://{host}:{port}{uri}'.format(
+                host=HOST, port=self.port, uri=uri)
+        do_kill_session = kwargs.pop('end_session', False)
+        if self._session:
+            session = self._session
+        else:
+            if self._tcp_connector:
+                conn = self._tcp_connector
+            else:
+                conn = ReuseableTCPConnector(
+                    verify_ssl=False,
+                    loop=self._loop,
+                    keepalive_timeout=request_keepalive
+                )
+                self._tcp_connector = conn
+            session = aiohttp.ClientSession(cookies=cookies,
+                                            connector=conn,
+                                            loop=self._loop)
+            self._session = session
+
+        async with getattr(session, method.lower())(
+                url, *args, **kwargs) as response:
+            try:
+                response.text = await response.text()
+            except UnicodeDecodeError:
+                response.text = None
+
+            try:
+                response.json = await response.json()
+            except (JSONDecodeError,
+                    UnicodeDecodeError,
+                    aiohttp.ClientResponseError):
+                response.json = None
+
+            response.body = await response.read()
+        if do_kill_session:
+            await session.close()
+            self._session = None
+        return response
+
+
+Config.KEEP_ALIVE_TIMEOUT = 2
+Config.KEEP_ALIVE = True
+keep_alive_timeout_app_reuse = Sanic('test_ka_timeout_reuse')
+keep_alive_app_client_timeout = Sanic('test_ka_client_timeout')
+keep_alive_app_server_timeout = Sanic('test_ka_server_timeout')
+
+
+@keep_alive_timeout_app_reuse.route('/1')
+async def handler1(request):
+    return text('OK')
+
+
+@keep_alive_app_client_timeout.route('/1')
+async def handler2(request):
+    return text('OK')
+
+
+@keep_alive_app_server_timeout.route('/1')
+async def handler3(request):
+    return text('OK')
+
+
+def test_keep_alive_timeout_reuse():
+    """If the server keep-alive timeout and client keep-alive timeout are
+     both longer than the delay, the client _and_ server will successfully
+     reuse the existing connection."""
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    client = ReuseableSanicTestClient(keep_alive_timeout_app_reuse, loop)
+    headers = {
+        'Connection': 'keep-alive'
+    }
+    request, response = client.get('/1', headers=headers)
+    assert response.status == 200
+    assert response.text == 'OK'
+    loop.run_until_complete(aio_sleep(1))
+    request, response = client.get('/1', end_server=True)
+    assert response.status == 200
+    assert response.text == 'OK'
+
+
+def test_keep_alive_client_timeout():
+    """If the server keep-alive timeout is longer than the client
+    keep-alive timeout, client will try to create a new connection here."""
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    client = ReuseableSanicTestClient(keep_alive_app_client_timeout,
+                                      loop)
+    headers = {
+        'Connection': 'keep-alive'
+    }
+    request, response = client.get('/1', headers=headers,
+                                   request_keepalive=1)
+    assert response.status == 200
+    assert response.text == 'OK'
+    loop.run_until_complete(aio_sleep(2))
+    exception = None
+    try:
+        request, response = client.get('/1', end_server=True,
+                                       request_keepalive=1)
+    except ValueError as e:
+        exception = e
+    assert exception is not None
+    assert isinstance(exception, ValueError)
+    assert "got a new connection" in exception.args[0]
+
+
+def test_keep_alive_server_timeout():
+    """If the client keep-alive timeout is longer than the server
+    keep-alive timeout, the client will either a 'Connection reset' error
+    _or_ a new connection. Depending on how the event-loop handles the
+    broken server connection."""
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+    client = ReuseableSanicTestClient(keep_alive_app_server_timeout,
+                                      loop)
+    headers = {
+        'Connection': 'keep-alive'
+    }
+    request, response = client.get('/1', headers=headers,
+                                   request_keepalive=60)
+    assert response.status == 200
+    assert response.text == 'OK'
+    loop.run_until_complete(aio_sleep(3))
+    exception = None
+    try:
+        request, response = client.get('/1', request_keepalive=60,
+                                       end_server=True)
+    except ValueError as e:
+        exception = e
+    assert exception is not None
+    assert isinstance(exception, ValueError)
+    assert "Connection reset" in exception.args[0] or \
+           "got a new connection" in exception.args[0]

tests/test_logging.py

@@ -1,11 +1,18 @@
 import uuid
+import logging
+
+from io import StringIO
 from importlib import reload
 
-from sanic.config import LOGGING
+import pytest
+from unittest.mock import Mock
+
+import sanic
 from sanic.response import text
+from sanic.log import LOGGING_CONFIG_DEFAULTS
 from sanic import Sanic
-from io import StringIO
-import logging
+from sanic.log import logger
+
 
 logging_format = '''module: %(module)s; \
 function: %(funcName)s(); \
@@ -17,7 +24,7 @@ def reset_logging():
     reload(logging)
 
 
-def test_log():
+def test_log(app):
     log_stream = StringIO()
     for handler in logging.root.handlers[:]:
         logging.root.removeHandler(handler)
@@ -27,7 +34,6 @@ def test_log():
         stream=log_stream
     )
     log = logging.getLogger()
-    app = Sanic('test_logging')
     rand_string = str(uuid.uuid4())
 
     @app.route('/')
@@ -40,18 +46,90 @@ def test_log():
     assert rand_string in log_text
 
 
-def test_default_log_fmt():
+def test_logging_defaults():
+    # reset_logging()
+    app = Sanic("test_logging")
 
-    reset_logging()
-    Sanic()
-    for fmt in [h.formatter for h in logging.getLogger('sanic').handlers]:
-        assert fmt._fmt == LOGGING['formatters']['simple']['format']
+    for fmt in [h.formatter for h in logging.getLogger('sanic.root').handlers]:
+        assert fmt._fmt == LOGGING_CONFIG_DEFAULTS['formatters']['generic']['format']
 
-    reset_logging()
-    Sanic(log_config=None)
-    for fmt in [h.formatter for h in logging.getLogger('sanic').handlers]:
-        assert fmt._fmt == "%(asctime)s: %(levelname)s: %(message)s"
+    for fmt in [h.formatter for h in logging.getLogger('sanic.error').handlers]:
+        assert fmt._fmt == LOGGING_CONFIG_DEFAULTS['formatters']['generic']['format']
+
+    for fmt in [h.formatter for h in logging.getLogger('sanic.access').handlers]:
+        assert fmt._fmt == LOGGING_CONFIG_DEFAULTS['formatters']['access']['format']
 
 
-if __name__ == "__main__":
-    test_log()
+def test_logging_pass_customer_logconfig():
+    # reset_logging()
+
+    modified_config = LOGGING_CONFIG_DEFAULTS
+    modified_config['formatters']['generic']['format'] = '%(asctime)s - (%(name)s)[%(levelname)s]: %(message)s'
+    modified_config['formatters']['access']['format'] = '%(asctime)s - (%(name)s)[%(levelname)s]: %(message)s'
+
+    app = Sanic("test_logging", log_config=modified_config)
+
+    for fmt in [h.formatter for h in logging.getLogger('sanic.root').handlers]:
+        assert fmt._fmt == modified_config['formatters']['generic']['format']
+
+    for fmt in [h.formatter for h in logging.getLogger('sanic.error').handlers]:
+        assert fmt._fmt == modified_config['formatters']['generic']['format']
+
+    for fmt in [h.formatter for h in logging.getLogger('sanic.access').handlers]:
+        assert fmt._fmt == modified_config['formatters']['access']['format']
+
+
+@pytest.mark.parametrize('debug', (True, False, ))
+def test_log_connection_lost(app, debug, monkeypatch):
+    """ Should not log Connection lost exception on non debug """
+    stream = StringIO()
+    root = logging.getLogger('sanic.root')
+    root.addHandler(logging.StreamHandler(stream))
+    monkeypatch.setattr(sanic.server, 'logger', root)
+
+    @app.route('/conn_lost')
+    async def conn_lost(request):
+        response = text('Ok')
+        response.output = Mock(side_effect=RuntimeError)
+        return response
+
+    with pytest.raises(ValueError):
+        # catch ValueError: Exception during request
+        app.test_client.get('/conn_lost', debug=debug)
+
+    log = stream.getvalue()
+
+    if debug:
+        assert 'Connection lost before response written @' in log
+    else:
+        assert 'Connection lost before response written @' not in log
+
+
+def test_logger(caplog):
+    rand_string = str(uuid.uuid4())
+
+    app = Sanic()
+
+    @app.get('/')
+    def log_info(request):
+        logger.info(rand_string)
+        return text('hello')
+
+    with caplog.at_level(logging.INFO):
+        request, response = app.test_client.get('/')
+
+    assert caplog.record_tuples[0] == ('sanic.root', logging.INFO, 'Goin\' Fast @ http://127.0.0.1:42101')
+    assert caplog.record_tuples[1] == ('sanic.root', logging.INFO, 'http://127.0.0.1:42101/')
+    assert caplog.record_tuples[2] == ('sanic.root', logging.INFO, rand_string)
+    assert caplog.record_tuples[-1] == ('sanic.root', logging.INFO, 'Server Stopped')
+
+
+def test_logging_modified_root_logger_config():
+    # reset_logging()
+
+    modified_config = LOGGING_CONFIG_DEFAULTS
+    modified_config['loggers']['sanic.root']['level'] = 'DEBUG'
+
+    app = Sanic("test_logging", log_config=modified_config)
+
+    assert logging.getLogger('sanic.root').getEffectiveLevel() == logging.DEBUG

tests/test_middleware.py

@@ -1,25 +1,23 @@
-from json import loads as json_loads, dumps as json_dumps
-from sanic import Sanic
-from sanic.request import Request
-from sanic.response import json, text, HTTPResponse
-from sanic.exceptions import NotFound
+import logging
+from asyncio import CancelledError
 
+from sanic.exceptions import NotFound
+from sanic.request import Request
+from sanic.response import HTTPResponse, text
 
 # ------------------------------------------------------------ #
 #  GET
 # ------------------------------------------------------------ #
 
-def test_middleware_request():
-    app = Sanic('test_middleware_request')
-
+def test_middleware_request(app):
     results = []
 
     @app.middleware
-    async def handler(request):
+    async def handler1(request):
         results.append(request)
 
     @app.route('/')
-    async def handler(request):
+    async def handler2(request):
         return text('OK')
 
     request, response = app.test_client.get('/')
@@ -28,13 +26,11 @@ def test_middleware_request():
     assert type(results[0]) is Request
 
 
-def test_middleware_response():
-    app = Sanic('test_middleware_response')
-
+def test_middleware_response(app):
     results = []
 
     @app.middleware('request')
-    async def process_response(request):
+    async def process_request(request):
         results.append(request)
 
     @app.middleware('response')
@@ -54,12 +50,11 @@ def test_middleware_response():
     assert isinstance(results[2], HTTPResponse)
 
 
-def test_middleware_response_exception():
-    app = Sanic('test_middleware_response_exception')
+def test_middleware_response_exception(app):
     result = {'status_code': None}
 
     @app.middleware('response')
-    async def process_response(reqest, response):
+    async def process_response(request, response):
         result['status_code'] = response.status
         return response
 
@@ -75,8 +70,51 @@ def test_middleware_response_exception():
     assert response.text == 'OK'
     assert result['status_code'] == 404
 
-def test_middleware_override_request():
-    app = Sanic('test_middleware_override_request')
+
+def test_middleware_response_raise_cancelled_error(app, caplog):
+
+    @app.middleware('response')
+    async def process_response(request, response):
+        raise CancelledError('CancelledError at response middleware')
+
+    @app.get('/')
+    def handler(request):
+        return text('OK')
+
+    with caplog.at_level(logging.ERROR):
+        reqrequest, response = app.test_client.get('/')
+
+    assert response.status == 503
+    assert caplog.record_tuples[0] == (
+        'sanic.root',
+        logging.ERROR,
+        'Exception occurred while handling uri: \'http://127.0.0.1:42101/\''
+    )
+
+
+def test_middleware_response_raise_exception(app, caplog):
+
+    @app.middleware('response')
+    async def process_response(request, response):
+        raise Exception('Exception at response middleware')
+
+    with caplog.at_level(logging.ERROR):
+        reqrequest, response = app.test_client.get('/')
+
+    assert response.status == 404
+    assert caplog.record_tuples[0] == (
+        'sanic.root',
+        logging.ERROR,
+        'Exception occurred while handling uri: \'http://127.0.0.1:42101/\''
+    )
+    assert caplog.record_tuples[1] == (
+        'sanic.error',
+        logging.ERROR,
+        'Exception occurred in one of response middleware handlers'
+    )
+
+
+def test_middleware_override_request(app):
 
     @app.middleware
     async def halt_request(request):
@@ -92,8 +130,7 @@ def test_middleware_override_request():
     assert response.text == 'OK'
 
 
-def test_middleware_override_response():
-    app = Sanic('test_middleware_override_response')
+def test_middleware_override_response(app):
 
     @app.middleware('response')
     async def process_response(request, response):
@@ -109,10 +146,7 @@ def test_middleware_override_response():
     assert response.text == 'OK'
 
 
-
-def test_middleware_order():
-    app = Sanic('test_middleware_order')
-
+def test_middleware_order(app):
     order = []
 
     @app.middleware('request')
@@ -146,4 +180,4 @@ def test_middleware_order():
     request, response = app.test_client.get('/')
 
     assert response.status == 200
-    assert order == [1,2,3,4,5,6]
+    assert order == [1, 2, 3, 4, 5, 6]

tests/test_multiprocessing.py

@@ -1,16 +1,22 @@
 import multiprocessing
 import random
 import signal
+import pickle
+import pytest
 
-from sanic import Sanic
 from sanic.testing import HOST, PORT
+from sanic.response import text
 
 
-def test_multiprocessing():
+@pytest.mark.skipif(
+    not hasattr(signal, 'SIGALRM'),
+    reason='SIGALRM is not implemented for this platform, we have to come '
+    'up with another timeout strategy to test these'
+)
+def test_multiprocessing(app):
     """Tests that the number of children we produce is correct"""
     # Selects a number at random so we can spot check
-    num_workers = random.choice(range(2,  multiprocessing.cpu_count() * 2 + 1))
-    app = Sanic('test_multiprocessing')
+    num_workers = random.choice(range(2, multiprocessing.cpu_count() * 2 + 1))
     process_list = set()
 
     def stop_on_alarm(*args):
@@ -19,8 +25,62 @@ def test_multiprocessing():
             process.terminate()
 
     signal.signal(signal.SIGALRM, stop_on_alarm)
-    signal.alarm(1)
+    signal.alarm(3)
     app.run(HOST, PORT, workers=num_workers)
 
     assert len(process_list) == num_workers
 
+
+@pytest.mark.skipif(
+    not hasattr(signal, 'SIGALRM'),
+    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()
+
+    def stop_on_alarm(*args):
+        for process in multiprocessing.active_children():
+            process_list.add(process.pid)
+            process.terminate()
+
+    signal.signal(signal.SIGALRM, stop_on_alarm)
+    signal.alarm(3)
+
+    bp = Blueprint('test_text')
+    app.blueprint(bp)
+    app.run(HOST, PORT, workers=num_workers)
+
+    assert len(process_list) == num_workers
+
+
+# this function must be outside a test function so that it can be
+# able to be pickled (local functions cannot be pickled).
+def handler(request):
+    return text('Hello')
+
+# Muliprocessing 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)
+    up_p_app = pickle.loads(p_app)
+    assert up_p_app
+    request, response = 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)
+    up_p_app = pickle.loads(p_app)
+    assert up_p_app
+    request, response = app.test_client.get('/')
+    assert app.is_request_stream is False
+    assert response.text == 'Hello'

tests/test_named_routes.py

@@ -0,0 +1,365 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import asyncio
+import pytest
+
+from sanic.blueprints import Blueprint
+from sanic.response import text
+from sanic.exceptions import URLBuildError
+from sanic.constants import HTTP_METHODS
+
+
+# ------------------------------------------------------------ #
+#  UTF-8
+# ------------------------------------------------------------ #
+
+@pytest.mark.parametrize('method', HTTP_METHODS)
+def test_versioned_named_routes_get(app, method):
+    bp = Blueprint('test_bp', url_prefix='/bp')
+
+    method = method.lower()
+    route_name = 'route_{}'.format(method)
+    route_name2 = 'route2_{}'.format(method)
+
+    func = getattr(app, method)
+    if callable(func):
+        @func('/{}'.format(method), version=1, name=route_name)
+        def handler(request):
+            return text('OK')
+    else:
+        print(func)
+        raise
+
+    func = getattr(bp, method)
+    if callable(func):
+        @func('/{}'.format(method), version=1, name=route_name2)
+        def handler2(request):
+            return text('OK')
+
+    else:
+        print(func)
+        raise
+
+    app.blueprint(bp)
+
+    assert app.router.routes_all['/v1/{}'.format(method)].name == route_name
+
+    route = app.router.routes_all['/v1/bp/{}'.format(method)]
+    assert route.name == 'test_bp.{}'.format(route_name2)
+
+    assert app.url_for(route_name) == '/v1/{}'.format(method)
+    url = app.url_for('test_bp.{}'.format(route_name2))
+    assert url == '/v1/bp/{}'.format(method)
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_shorthand_default_routes_get(app):
+
+    @app.get('/get')
+    def handler(request):
+        return text('OK')
+
+    assert app.router.routes_all['/get'].name == 'handler'
+    assert app.url_for('handler') == '/get'
+
+
+def test_shorthand_named_routes_get(app):
+    bp = Blueprint('test_bp', url_prefix='/bp')
+
+    @app.get('/get', name='route_get')
+    def handler(request):
+        return text('OK')
+
+    @bp.get('/get', name='route_bp')
+    def handler2(request):
+        return text('Blueprint')
+
+    app.blueprint(bp)
+
+    assert app.router.routes_all['/get'].name == 'route_get'
+    assert app.url_for('route_get') == '/get'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+    assert app.router.routes_all['/bp/get'].name == 'test_bp.route_bp'
+    assert app.url_for('test_bp.route_bp') == '/bp/get'
+    with pytest.raises(URLBuildError):
+        app.url_for('test_bp.handler2')
+
+
+def test_shorthand_named_routes_post(app):
+
+    @app.post('/post', name='route_name')
+    def handler(request):
+        return text('OK')
+
+    assert app.router.routes_all['/post'].name == 'route_name'
+    assert app.url_for('route_name') == '/post'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_shorthand_named_routes_put(app):
+
+    @app.put('/put', name='route_put')
+    def handler(request):
+        assert request.stream is None
+        return text('OK')
+
+    assert app.is_request_stream is False
+    assert app.router.routes_all['/put'].name == 'route_put'
+    assert app.url_for('route_put') == '/put'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_shorthand_named_routes_delete(app):
+
+    @app.delete('/delete', name='route_delete')
+    def handler(request):
+        assert request.stream is None
+        return text('OK')
+
+    assert app.is_request_stream is False
+    assert app.router.routes_all['/delete'].name == 'route_delete'
+    assert app.url_for('route_delete') == '/delete'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_shorthand_named_routes_patch(app):
+
+    @app.patch('/patch', name='route_patch')
+    def handler(request):
+        assert request.stream is None
+        return text('OK')
+
+    assert app.is_request_stream is False
+    assert app.router.routes_all['/patch'].name == 'route_patch'
+    assert app.url_for('route_patch') == '/patch'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_shorthand_named_routes_head(app):
+
+    @app.head('/head', name='route_head')
+    def handler(request):
+        assert request.stream is None
+        return text('OK')
+
+    assert app.is_request_stream is False
+    assert app.router.routes_all['/head'].name == 'route_head'
+    assert app.url_for('route_head') == '/head'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_shorthand_named_routes_options(app):
+
+    @app.options('/options', name='route_options')
+    def handler(request):
+        assert request.stream is None
+        return text('OK')
+
+    assert app.is_request_stream is False
+    assert app.router.routes_all['/options'].name == 'route_options'
+    assert app.url_for('route_options') == '/options'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_named_static_routes(app):
+
+    @app.route('/test', name='route_test')
+    async def handler1(request):
+        return text('OK1')
+
+    @app.route('/pizazz', name='route_pizazz')
+    async def handler2(request):
+        return text('OK2')
+
+    assert app.router.routes_all['/test'].name == 'route_test'
+    assert app.router.routes_static['/test'].name == 'route_test'
+    assert app.url_for('route_test') == '/test'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler1')
+
+    assert app.router.routes_all['/pizazz'].name == 'route_pizazz'
+    assert app.router.routes_static['/pizazz'].name == 'route_pizazz'
+    assert app.url_for('route_pizazz') == '/pizazz'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler2')
+
+
+def test_named_dynamic_route(app):
+    results = []
+
+    @app.route('/folder/<name>', name='route_dynamic')
+    async def handler(request, name):
+        results.append(name)
+        return text('OK')
+
+    assert app.router.routes_all['/folder/<name>'].name == 'route_dynamic'
+    assert app.url_for('route_dynamic', name='test') == '/folder/test'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_dynamic_named_route_regex(app):
+
+    @app.route('/folder/<folder_id:[A-Za-z0-9]{0,4}>', name='route_re')
+    async def handler(request, folder_id):
+        return text('OK')
+
+    route = app.router.routes_all['/folder/<folder_id:[A-Za-z0-9]{0,4}>']
+    assert route.name == 'route_re'
+    assert app.url_for('route_re', folder_id='test') == '/folder/test'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_dynamic_named_route_path(app):
+
+    @app.route('/<path:path>/info', name='route_dynamic_path')
+    async def handler(request, path):
+        return text('OK')
+
+    route = app.router.routes_all['/<path:path>/info']
+    assert route.name == 'route_dynamic_path'
+    assert app.url_for('route_dynamic_path', path='path/1') == '/path/1/info'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_dynamic_named_route_unhashable(app):
+
+    @app.route('/folder/<unhashable:[A-Za-z0-9/]+>/end/',
+               name='route_unhashable')
+    async def handler(request, unhashable):
+        return text('OK')
+
+    route = app.router.routes_all['/folder/<unhashable:[A-Za-z0-9/]+>/end/']
+    assert route.name == 'route_unhashable'
+    url = app.url_for('route_unhashable', unhashable='test/asdf')
+    assert url == '/folder/test/asdf/end'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_websocket_named_route(app):
+    ev = asyncio.Event()
+
+    @app.websocket('/ws', name='route_ws')
+    async def handler(request, ws):
+        assert ws.subprotocol is None
+        ev.set()
+
+    assert app.router.routes_all['/ws'].name == 'route_ws'
+    assert app.url_for('route_ws') == '/ws'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_websocket_named_route_with_subprotocols(app):
+    results = []
+
+    @app.websocket('/ws', subprotocols=['foo', 'bar'], name='route_ws')
+    async def handler(request, ws):
+        results.append(ws.subprotocol)
+
+    assert app.router.routes_all['/ws'].name == 'route_ws'
+    assert app.url_for('route_ws') == '/ws'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_static_add_named_route(app):
+
+    async def handler1(request):
+        return text('OK1')
+
+    async def handler2(request):
+        return text('OK2')
+
+    app.add_route(handler1, '/test', name='route_test')
+    app.add_route(handler2, '/test2', name='route_test2')
+
+    assert app.router.routes_all['/test'].name == 'route_test'
+    assert app.router.routes_static['/test'].name == 'route_test'
+    assert app.url_for('route_test') == '/test'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler1')
+
+    assert app.router.routes_all['/test2'].name == 'route_test2'
+    assert app.router.routes_static['/test2'].name == 'route_test2'
+    assert app.url_for('route_test2') == '/test2'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler2')
+
+
+def test_dynamic_add_named_route(app):
+    results = []
+
+    async def handler(request, name):
+        results.append(name)
+        return text('OK')
+
+    app.add_route(handler, '/folder/<name>', name='route_dynamic')
+    assert app.router.routes_all['/folder/<name>'].name == 'route_dynamic'
+    assert app.url_for('route_dynamic', name='test') == '/folder/test'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_dynamic_add_named_route_unhashable(app):
+
+    async def handler(request, unhashable):
+        return text('OK')
+
+    app.add_route(handler, '/folder/<unhashable:[A-Za-z0-9/]+>/end/',
+                  name='route_unhashable')
+    route = app.router.routes_all['/folder/<unhashable:[A-Za-z0-9/]+>/end/']
+    assert route.name == 'route_unhashable'
+    url = app.url_for('route_unhashable', unhashable='folder1')
+    assert url == '/folder/folder1/end'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler')
+
+
+def test_overload_routes(app):
+
+    @app.route('/overload', methods=['GET'], name='route_first')
+    async def handler1(request):
+        return text('OK1')
+
+    @app.route('/overload', methods=['POST', 'PUT'], name='route_second')
+    async def handler2(request):
+        return text('OK2')
+
+    request, response = app.test_client.get(app.url_for('route_first'))
+    assert response.text == 'OK1'
+
+    request, response = app.test_client.post(app.url_for('route_first'))
+    assert response.text == 'OK2'
+
+    request, response = app.test_client.put(app.url_for('route_first'))
+    assert response.text == 'OK2'
+
+    request, response = app.test_client.get(app.url_for('route_second'))
+    assert response.text == 'OK1'
+
+    request, response = app.test_client.post(app.url_for('route_second'))
+    assert response.text == 'OK2'
+
+    request, response = app.test_client.put(app.url_for('route_second'))
+    assert response.text == 'OK2'
+
+    assert app.router.routes_all['/overload'].name == 'route_first'
+    with pytest.raises(URLBuildError):
+        app.url_for('handler1')
+
+    assert app.url_for('route_first') == '/overload'
+    assert app.url_for('route_second') == app.url_for('route_first')

tests/test_payload_too_large.py

@@ -1,49 +1,45 @@
-from sanic import Sanic
 from sanic.exceptions import PayloadTooLarge
 from sanic.response import text
 
 
-def test_payload_too_large_from_error_handler():
-    data_received_app = Sanic('data_received')
-    data_received_app.config.REQUEST_MAX_SIZE = 1
+def test_payload_too_large_from_error_handler(app):
+    app.config.REQUEST_MAX_SIZE = 1
 
-    @data_received_app.route('/1')
+    @app.route('/1')
     async def handler1(request):
         return text('OK')
 
-    @data_received_app.exception(PayloadTooLarge)
+    @app.exception(PayloadTooLarge)
     def handler_exception(request, exception):
         return text('Payload Too Large from error_handler.', 413)
 
-    response = data_received_app.test_client.get('/1', gather_request=False)
+    response = app.test_client.get('/1', gather_request=False)
     assert response.status == 413
     assert response.text == 'Payload Too Large from error_handler.'
 
 
-def test_payload_too_large_at_data_received_default():
-    data_received_default_app = Sanic('data_received_default')
-    data_received_default_app.config.REQUEST_MAX_SIZE = 1
+def test_payload_too_large_at_data_received_default(app):
+    app.config.REQUEST_MAX_SIZE = 1
 
-    @data_received_default_app.route('/1')
+    @app.route('/1')
     async def handler2(request):
         return text('OK')
 
-    response = data_received_default_app.test_client.get(
+    response = app.test_client.get(
         '/1', gather_request=False)
     assert response.status == 413
     assert response.text == 'Error: Payload Too Large'
 
 
-def test_payload_too_large_at_on_header_default():
-    on_header_default_app = Sanic('on_header')
-    on_header_default_app.config.REQUEST_MAX_SIZE = 500
+def test_payload_too_large_at_on_header_default(app):
+    app.config.REQUEST_MAX_SIZE = 500
 
-    @on_header_default_app.post('/1')
+    @app.post('/1')
     async def handler3(request):
         return text('OK')
 
     data = 'a' * 1000
-    response = on_header_default_app.test_client.post(
+    response = app.test_client.post(
         '/1', gather_request=False, data=data)
     assert response.status == 413
     assert response.text == 'Error: Payload Too Large'

tests/test_redirect.py

@@ -1,12 +1,11 @@
 import pytest
+from urllib.parse import quote
 
-from sanic import Sanic
 from sanic.response import text, redirect
 
 
 @pytest.fixture
-def redirect_app():
-    app = Sanic('test_redirection')
+def redirect_app(app):
 
     @app.route('/redirect_init')
     async def redirect_init(request):
@@ -21,17 +20,21 @@ def redirect_app():
         return text('OK')
 
     @app.route('/1')
-    def handler(request):
+    def handler1(request):
         return redirect('/2')
 
     @app.route('/2')
-    def handler(request):
+    def handler2(request):
         return redirect('/3')
 
     @app.route('/3')
-    def handler(request):
+    def handler3(request):
         return text('OK')
 
+    @app.route('/redirect_with_header_injection')
+    async def redirect_with_header_injection(request):
+        return redirect("/unsafe\ntest-header: test-value\n\ntest-body")
+
     return app
 
 
@@ -92,3 +95,38 @@ def test_chained_redirect(redirect_app):
         assert response.url.endswith('/3')
     except AttributeError:
         assert response.url.path.endswith('/3')
+
+
+def test_redirect_with_header_injection(redirect_app):
+    """
+    Test redirection to a URL with header and body injections.
+    """
+    request, response = redirect_app.test_client.get(
+        "/redirect_with_header_injection",
+        allow_redirects=False)
+
+    assert response.status == 302
+    assert "test-header" not in response.headers
+    assert not response.text.startswith('test-body')
+
+
+@pytest.mark.parametrize("test_str", ["sanic-test", "sanictest", "sanic test"])
+async def test_redirect_with_params(app, test_client, test_str):
+
+    @app.route("/api/v1/test/<test>/")
+    async def init_handler(request, test):
+        assert test == test_str
+        return redirect("/api/v2/test/{}/".format(quote(test)))
+
+    @app.route("/api/v2/test/<test>/")
+    async def target_handler(request, test):
+        assert test == test_str
+        return text("OK")
+
+    test_cli = await test_client(app)
+
+    response = await test_cli.get("/api/v1/test/{}/".format(quote(test_str)))
+    assert response.status == 200
+
+    txt = await response.text()
+    assert txt == "OK"

tests/test_request_cancel.py

@@ -0,0 +1,72 @@
+import asyncio
+import contextlib
+
+from sanic.response import text, stream
+
+
+async def test_request_cancel_when_connection_lost(loop, app, test_client):
+    app.still_serving_cancelled_request = False
+
+    @app.get('/')
+    async def handler(request):
+        await asyncio.sleep(1.0)
+        # at this point client is already disconnected
+        app.still_serving_cancelled_request = True
+        return text('OK')
+
+    test_cli = await test_client(app)
+
+    # schedule client call
+    task = loop.create_task(test_cli.get('/'))
+    loop.call_later(0.01, task)
+    await asyncio.sleep(0.5)
+
+    # cancelling request and closing connection after 0.5 sec
+    task.cancel()
+
+    with contextlib.suppress(asyncio.CancelledError):
+        await task
+
+    # Wait for server and check if it's still serving the cancelled request
+    await asyncio.sleep(1.0)
+
+    assert app.still_serving_cancelled_request is False
+
+
+async def test_stream_request_cancel_when_conn_lost(loop, app, test_client):
+    app.still_serving_cancelled_request = False
+
+    @app.post('/post/<id>', stream=True)
+    async def post(request, id):
+        assert isinstance(request.stream, asyncio.Queue)
+
+        async def streaming(response):
+            while True:
+                body = await request.stream.get()
+                if body is None:
+                    break
+                await response.write(body.decode('utf-8'))
+
+        await asyncio.sleep(1.0)
+        # at this point client is already disconnected
+        app.still_serving_cancelled_request = True
+
+        return stream(streaming)
+
+    test_cli = await test_client(app)
+
+    # schedule client call
+    task = loop.create_task(test_cli.post('/post/1'))
+    loop.call_later(0.01, task)
+    await asyncio.sleep(0.5)
+
+    # cancelling request and closing connection after 0.5 sec
+    task.cancel()
+
+    with contextlib.suppress(asyncio.CancelledError):
+        await task
+
+    # Wait for server and check if it's still serving the cancelled request
+    await asyncio.sleep(1.0)
+
+    assert app.still_serving_cancelled_request is False

tests/test_request_data.py

@@ -1,6 +1,5 @@
 import random
 
-from sanic import Sanic
 from sanic.response import json
 
 try:
@@ -9,8 +8,7 @@ except ImportError:
     from json import loads
 
 
-def test_storage():
-    app = Sanic('test_text')
+def test_storage(app):
 
     @app.middleware('request')
     def store(request):
@@ -20,7 +18,10 @@ def test_storage():
 
     @app.route('/')
     def handler(request):
-        return json({'user': request.get('user'), 'sidekick': request.get('sidekick')})
+        return json({
+            'user': request.get('user'),
+            'sidekick': request.get('sidekick')
+        })
 
     request, response = app.test_client.get('/')
 
@@ -29,8 +30,7 @@ def test_storage():
     assert response_json.get('sidekick') is None
 
 
-def test_app_injection():
-    app = Sanic('test_app_injection')
+def test_app_injection(app):
     expected = random.choice(range(0, 100))
 
     @app.listener('after_server_start')