Merge pull request #702 from seemethere/increment_054

Increment to 0.5.4

.coveragerc

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

.gitignore

@@ -1,11 +1,18 @@
 *~
 *.egg-info
 *.egg
+*.eggs
+*.pyc
 .coverage
 .coverage.*
 coverage
 .tox
 settings.py
-*.pyc
 .idea/*
 .cache/*
+.python-version
+docs/_build/
+docs/_api/
+build/*
+access.log
+error.log

.travis.yml

@@ -1,19 +1,15 @@
+sudo: false
 language: python
 python:
-  - '3.5'
-  - '3.6'
-install:
-  - pip install -r requirements.txt
-  - pip install -r requirements-dev.txt
-  - python setup.py install
-  - pip install flake8
-  - pip install pytest
-before_script: flake8 sanic
-script: py.test -v tests
+- '3.5'
+- '3.6'
+install: pip install tox-travis
+script: tox
 deploy:
   provider: pypi
   user: channelcat
   password:
-    secure: jH4+Di2/qcBwWVhI5/3NYd/JuDDgf5/cF85h+oQnAjgwP6me3th9RS0PHL2gjKJrmyRgwrW7a3eSAityo5sQSlBloQCNrtCE30rkDiwtgoIxDW72NR/nE8nUkS9Utgy87eS+3B4NrO7ag4GTqO5ET8SQ4/MCiQwyUQATLXj2s2eTpQvqJeZG6YgoeFAOYvlR580yznXoOwldWlkiymJiWSdR/01lthtWCi40sYC/QoU7psODJ/tPcsqgQtQKyUVsci7mKvp3Y8ImkoO/POM01jYNsS9qLh5pKTNCEYxtyzC77whenCNHn7WReVidd56g1ADosbNo4yY/1D3VAvwjUnkQ0SzdBQfT7IIzccEuC0j1NXKPN97OX0a6XzyUMYJ1XiU3juTJOPxdYBPbsDM3imQiwrOh1faIf0HCgNTN+Lxe5l8obCH7kffNcVUhs2zI0+2t4MS5tjb/OVuYD/TFn+bM33DqzLctTOK/pGn6xefzZcdzb191LPo99Lof+4fo6jNUpb0UmcBu5ZJzxh0lGe8FPIK3UAG/hrYDDgjx8s8RtUJjcEUQz0659XffYx7DLlgHO7cWyfjrHD3yrLzDbYr5mAS4FR+4D917V7UL+on4SsKHN00UuMGPguqSYo/xYyPLnJU5XK0du4MIpsNMB8TtrJOIewOOfD32+AisPQ8=
+    secure: OgADRQH3+dTL5swGzXkeRJDNbLpFzwqYnXB4iLD0Npvzj9QnKyQVvkbaeq6VmV9dpEFb5ULaAKYQq19CrXYDm28yanUSn6jdJ4SukaHusi7xt07U6H7pmoX/uZ2WZYqCSLM8cSp8TXY/3oV3rY5Jfj/AibE5XTbim5/lrhsvW6NR+ALzxc0URRPAHDZEPpojTCjSTjpY0aDsaKWg4mXVRMFfY3O68j6KaIoukIZLuoHfePLKrbZxaPG5VxNhMHEaICdxVxE/dO+7pQmQxXuIsEOHK1QiVJ9YrSGcNqgEqhN36kYP8dqMeVB07sv8Xa6o/Uax2/wXS2HEJvuwP1YD6WkoZuo9ZB85bcMdg7BV9jJDbVFVPJwc75BnTLHrMa3Q1KrRlKRDBUXBUsQivPuWhFNwUgvEayq2qSI3aRQR4Z0O+DfboEhXYojSoD64/EWBTZ7vhgbvOTGEdukUQSYrKj9P8jc1s8exomTsAiqdFxTUpzfiammUSL+M93lP4urtahl1jjXFX7gd3DzdEEb0NsGkx5lm/qdsty8/TeAvKUmC+RVU6T856W6MqN0P+yGbpWUARcSE7fwztC3SPxwAuxvIN3BHmRhOUHoORPNG2VpfbnscIzBKJR4v0JKzbpi0IDa66K+tCGsCEvQuL4cxVOtoUySPWNSUAyUWWUrGM2k=
   on:
     tags: true
+  distributions: "sdist bdist_wheel"

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing
+
+Thank you for your interest! Sanic is always looking for contributors. If you
+don't feel comfortable contributing code, adding docstrings to the source files
+is very appreciated.
+
+## Installation
+
+To develop on sanic (and mainly to just run the tests) it is highly recommend to
+install from sources.
+
+So assume you have already cloned the repo and are in the working directory with
+a virtual environment already set up, then run:
+
+```bash
+python setup.py develop && pip install -r requirements-dev.txt
+```
+
+## Running tests
+
+To run the tests for sanic it is recommended to use tox like so:
+
+```bash
+tox
+```
+
+See it's that simple!
+
+## Pull requests!
+
+So the pull request approval rules are pretty simple:
+1. All pull requests must pass unit tests
+2. All pull requests must be reviewed and approved by at least 
+one current collaborator on the project
+3. All pull requests must pass flake8 checks
+4. If you decide to remove/change anything from any common interface
+a deprecation message should accompany it.
+5. If you implement a new feature you should have at least one unit
+test to accompany it.
+
+## Documentation
+
+Sanic's documentation is built
+using [sphinx](http://www.sphinx-doc.org/en/1.5.1/). Guides are written in
+Markdown and can be found in the `docs` folder, while the module reference is
+automatically generated using `sphinx-apidoc`.
+
+To generate the documentation from scratch:
+
+```bash
+sphinx-apidoc -fo docs/_api/ sanic
+sphinx-build -b html docs docs/_build
+```
+
+The HTML documentation will be created in the `docs/_build` folder.
+
+## Warning
+
+One of the main goals of Sanic is speed. Code that lowers the performance of
+Sanic without significant gains in usability, security, or features may not be
+merged. Please don't let this intimidate you! If you have any concerns about an
+idea, open an issue for discussion and help.

Dockerfile

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

MANIFEST.in

@@ -0,0 +1,4 @@
+include README.rst
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

Makefile

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

README.md

@@ -1,96 +0,0 @@
-# Sanic
-
-[![Join the chat at https://gitter.im/sanic-python/Lobby](https://badges.gitter.im/sanic-python/Lobby.svg)](https://gitter.im/sanic-python/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-[![Build Status](https://travis-ci.org/channelcat/sanic.svg?branch=master)](https://travis-ci.org/channelcat/sanic)
-[![PyPI](https://img.shields.io/pypi/v/sanic.svg)](https://pypi.python.org/pypi/sanic/)
-[![PyPI](https://img.shields.io/pypi/pyversions/sanic.svg)](https://pypi.python.org/pypi/sanic/)
-
-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.
-
-## Benchmarks
-
-All tests were run on an AWS medium instance running ubuntu, using 1 process.  Each script delivered a small JSON response and was tested with wrk using 100 connections.  Pypy was tested for Falcon and Flask but did not speed up requests.
-
-
-
-| Server  | Implementation      | Requests/sec | Avg Latency |
-| ------- | ------------------- | ------------:| -----------:|
-| Sanic   | Python 3.5 + uvloop |       33,342 |      2.96ms |
-| Wheezy  | gunicorn + meinheld |       20,244 |      4.94ms |
-| Falcon  | gunicorn + meinheld |       18,972 |      5.27ms |
-| Bottle  | gunicorn + meinheld |       13,596 |      7.36ms |
-| Flask   | gunicorn + meinheld |        4,988 |     20.08ms |
-| Kyoukai | Python 3.5 + uvloop |        3,889 |     27.44ms |
-| Aiohttp | Python 3.5 + uvloop |        2,979 |     33.42ms |
-| Tornado | Python 3.5          |        2,138 |     46.66ms |
-
-## Hello World
-
-```python
-from sanic import Sanic
-from sanic.response import json
-
-
-app = Sanic()
-
-
-@app.route("/")
-async def test(request):
-    return json({"hello": "world"})
-
-if __name__ == "__main__":
-    app.run(host="0.0.0.0", port=8000)
-
-```
-
-## Installation
- * `python -m pip install sanic`
-
-## Documentation
- * [Getting started](docs/getting_started.md)
- * [Request Data](docs/request_data.md)
- * [Routing](docs/routing.md)
- * [Middleware](docs/middleware.md)
- * [Exceptions](docs/exceptions.md)
- * [Blueprints](docs/blueprints.md)
- * [Class Based Views](docs/class_based_views.md)
- * [Cookies](docs/cookies.md)
- * [Static Files](docs/static_files.md)
- * [Testing](docs/testing.md)
- * [Deploying](docs/deploying.md)
- * [Contributing](docs/contributing.md)
- * [License](LICENSE)
-
-## TODO:
- * Streamed file processing
- * File output
- * Examples of integrations with 3rd-party modules
- * RESTful router
-
-## Limitations:
- * No wheels for uvloop and httptools on Windows :(
-
-## Final Thoughts:
-
-                     ▄▄▄▄▄
-            ▀▀▀██████▄▄▄       _______________
-          ▄▄▄▄▄  █████████▄  /                 \
-         ▀▀▀▀█████▌ ▀▐▄ ▀▐█ |   Gotta go fast!  |
-       ▀▀█████▄▄ ▀██████▄██ | _________________/
-       ▀▄▄▄▄▄  ▀▀█▄▀█════█▀ |/
-            ▀▀▀▄  ▀▀███ ▀       ▄▄
-         ▄███▀▀██▄████████▄ ▄▀▀▀▀▀▀█▌
-       ██▀▄▄▄██▀▄███▀ ▀▀████      ▄██
-    ▄▀▀▀▄██▄▀▀▌████▒▒▒▒▒▒███     ▌▄▄▀
-    ▌    ▐▀████▐███▒▒▒▒▒▐██▌
-    ▀▄▄▄▄▀   ▀▀████▒▒▒▒▄██▀
-              ▀▀█████████▀
-            ▄▄██▀██████▀█
-          ▄██▀     ▀▀▀  █
-         ▄█             ▐▌
-     ▄▄▄▄█▌              ▀█▄▄▄▄▀▀▄
-    ▌     ▐                ▀▀▄▄▄▀
-     ▀▀▄▄▀

README.rst

@@ -0,0 +1,119 @@
+Sanic
+=====
+
+|Join the chat at https://gitter.im/sanic-python/Lobby| |Build Status| |PyPI| |PyPI version|
+
+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!
+
+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!
+
+Benchmarks
+----------
+
+All tests were run on an AWS medium instance running ubuntu, using 1
+process. Each script delivered a small JSON response and was tested with
+wrk using 100 connections. Pypy was tested for Falcon and Flask but did
+not speed up requests.
+
++-----------+-----------------------+----------------+---------------+
+| Server    | Implementation        | Requests/sec   | Avg Latency   |
++===========+=======================+================+===============+
+| Sanic     | Python 3.5 + uvloop   | 33,342         | 2.96ms        |
++-----------+-----------------------+----------------+---------------+
+| Wheezy    | gunicorn + meinheld   | 20,244         | 4.94ms        |
++-----------+-----------------------+----------------+---------------+
+| Falcon    | gunicorn + meinheld   | 18,972         | 5.27ms        |
++-----------+-----------------------+----------------+---------------+
+| Bottle    | gunicorn + meinheld   | 13,596         | 7.36ms        |
++-----------+-----------------------+----------------+---------------+
+| Flask     | gunicorn + meinheld   | 4,988          | 20.08ms       |
++-----------+-----------------------+----------------+---------------+
+| Kyoukai   | Python 3.5 + uvloop   | 3,889          | 27.44ms       |
++-----------+-----------------------+----------------+---------------+
+| Aiohttp   | Python 3.5 + uvloop   | 2,979          | 33.42ms       |
++-----------+-----------------------+----------------+---------------+
+| Tornado   | Python 3.5            | 2,138          | 46.66ms       |
++-----------+-----------------------+----------------+---------------+
+
+Hello World Example
+-------------------
+
+.. code:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+
+    app = Sanic()
+
+    @app.route("/")
+    async def test(request):
+        return json({"hello": "world"})
+
+    if __name__ == "__main__":
+        app.run(host="0.0.0.0", port=8000)
+
+Installation
+------------
+
+-  ``python -m pip install sanic``
+
+To install sanic without uvloop or json 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``
+
+
+Documentation
+-------------
+
+`Documentation on Readthedocs <http://sanic.readthedocs.io/>`_.
+
+.. |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
+.. |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/
+
+TODO
+----
+ * Streamed file processing
+ * http2
+
+Limitations
+-----------
+* No wheels for uvloop and httptools on Windows :(
+
+Final Thoughts
+--------------
+
+::
+
+                     ▄▄▄▄▄
+            ▀▀▀██████▄▄▄       _______________
+          ▄▄▄▄▄  █████████▄  /                 \
+         ▀▀▀▀█████▌ ▀▐▄ ▀▐█ |   Gotta go fast!  |
+       ▀▀█████▄▄ ▀██████▄██ | _________________/
+       ▀▄▄▄▄▄  ▀▀█▄▀█════█▀ |/
+            ▀▀▀▄  ▀▀███ ▀       ▄▄
+         ▄███▀▀██▄████████▄ ▄▀▀▀▀▀▀█▌
+       ██▀▄▄▄██▀▄███▀ ▀▀████      ▄██
+    ▄▀▀▀▄██▄▀▀▌████▒▒▒▒▒▒███     ▌▄▄▀
+    ▌    ▐▀████▐███▒▒▒▒▒▐██▌
+    ▀▄▄▄▄▀   ▀▀████▒▒▒▒▄██▀
+              ▀▀█████████▀
+            ▄▄██▀██████▀█
+          ▄██▀     ▀▀▀  █
+         ▄█             ▐▌
+     ▄▄▄▄█▌              ▀█▄▄▄▄▀▀▄
+    ▌     ▐                ▀▀▄▄▄▀
+     ▀▀▄▄▀

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Sanic
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/blueprints.md

@@ -1,111 +0,0 @@
-# Blueprints
-
-Blueprints are objects that can be used for sub-routing within an application.
-Instead of adding routes to the application object, blueprints define similar
-methods for adding routes, which are then registered with the application in a
-flexible and pluggable manner.
-
-## Why?
-
-Blueprints are especially useful for larger applications, where your application
-logic can be broken down into several groups or areas of responsibility.
-
-It is also useful for API versioning, where one blueprint may point at
-`/v1/<routes>`, and another pointing at `/v2/<routes>`.
-
-
-## My First Blueprint
-
-The following shows a very simple blueprint that registers a handler-function at
-the root `/` of your application.
-
-Suppose you save this file as `my_blueprint.py`, this can be imported in your
-main application later.
-
-```python
-from sanic.response import json
-from sanic import Blueprint
-
-bp = Blueprint('my_blueprint')
-
-@bp.route('/')
-async def bp_root(request):
-    return json({'my': 'blueprint'})
-
-```
-
-## Registering Blueprints
-Blueprints must be registered with the application.
-
-```python
-from sanic import Sanic
-from my_blueprint import bp
-
-app = Sanic(__name__)
-app.blueprint(bp)
-
-app.run(host='0.0.0.0', port=8000, debug=True)
-```
-
-This will add the blueprint to the application and register any routes defined
-by that blueprint.
-In this example, the registered routes in the `app.router` will look like:
-
-```python
-[Route(handler=<function bp_root at 0x7f908382f9d8>, methods=None, pattern=re.compile('^/$'), parameters=[])]
-```
-
-## Middleware
-Using blueprints allows you to also register middleware globally.
-
-```python
-@bp.middleware
-async def halt_request(request):
-	print("I am a spy")
-
-@bp.middleware('request')
-async def halt_request(request):
-	return text('I halted the request')
-
-@bp.middleware('response')
-async def halt_response(request, response):
-	return text('I halted the response')
-```
-
-## Exceptions
-Exceptions can also be applied exclusively to blueprints globally.
-
-```python
-@bp.exception(NotFound)
-def ignore_404s(request, exception):
-	return text("Yep, I totally found the page: {}".format(request.url))
-
-## Static files
-Static files can also be served globally, under the blueprint prefix.
-
-```python
-bp.static('/folder/to/serve', '/web/path')
-```
-
-## Start and Stop
-Blueprints and run functions during the start and stop process of the server.
-If running in multiprocessor mode (more than 1 worker), these are triggered after the workers fork
-Available events are:
-
- * before_server_start - Executed before the server begins to accept connections
- * after_server_start - Executed after the server begins to accept connections
- * before_server_stop - Executed before the server stops accepting connections
- * after_server_stop - Executed after the server is stopped and all requests are complete
-
-```python
-bp = Blueprint('my_blueprint')
-
-@bp.listen('before_server_start')
-async def setup_connection():
-    global database
-    database = mysql.connect(host='127.0.0.1'...)
-    
-@bp.listen('after_server_stop')
-async def close_connection():
-    await database.close()
-```

docs/class_based_views.md

@@ -1,45 +0,0 @@
-# Class based views
-
-Sanic has simple class based implementation. You should implement methods(get, post, put, patch, delete) for the class to every HTTP method you want to support. If someone tries to use a method that has not been implemented, there will be 405 response.
-
-## Examples
-```python
-from sanic import Sanic
-from sanic.views import HTTPMethodView
-from sanic.response import text
-
-app = Sanic('some_name')
-
-
-class SimpleView(HTTPMethodView):
-
-  def get(self, request):
-      return text('I am get method')
-
-  def post(self, request):
-      return text('I am post method')
-
-  def put(self, request):
-      return text('I am put method')
-
-  def patch(self, request):
-      return text('I am patch method')
-
-  def delete(self, request):
-      return text('I am delete method')
-
-app.add_route(SimpleView(), '/')
-
-```
-
-If you need any url params just mention them in method definition:
-
-```python
-class NameView(HTTPMethodView):
-
-  def get(self, request, name):
-    return text('Hello {}'.format(name))
-
-app.add_route(NameView(), '/<name>')
-
-```

docs/conf.py

@@ -0,0 +1,142 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Sanic documentation build configuration file, created by
+# sphinx-quickstart on Sun Dec 25 18:07:21 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+
+import os
+import sys
+
+# Add support for Markdown documentation using Recommonmark
+from recommonmark.parser import CommonMarkParser
+
+# Ensure that sanic is present in the path, to allow sphinx-apidoc to
+# autogenerate documentation from docstrings
+root_directory = os.path.dirname(os.getcwd())
+sys.path.insert(0, root_directory)
+
+import sanic
+
+# -- General configuration ------------------------------------------------
+
+extensions = ['sphinx.ext.autodoc']
+
+templates_path = ['_templates']
+
+# Enable support for both Restructured Text and Markdown
+source_parsers = {'.md': CommonMarkParser}
+source_suffix = ['.rst', '.md']
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Sanic'
+copyright = '2016, Sanic contributors'
+author = 'Sanic contributors'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = sanic.__version__
+# The full version, including alpha/beta/rc tags.
+release = sanic.__version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+#
+# modules.rst is generated by sphinx-apidoc but is unused. This suppresses
+# a warning about it.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'modules.rst']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Sanicdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [(master_doc, 'Sanic.tex', 'Sanic Documentation',
+                    'Sanic contributors', 'manual'), ]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, 'sanic', 'Sanic Documentation', [author], 1)]
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Sanic', 'Sanic Documentation', author, 'Sanic',
+     'One line description of project.', 'Miscellaneous'),
+]
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# -- Custom Settings -------------------------------------------------------
+
+suppress_warnings = ['image.nonlocal_uri']

docs/contributing.md

@@ -1,10 +0,0 @@
-# How to contribute to Sanic
-
-Thank you for your interest!
-
-## Running tests
-* `python -m pip install pytest`
-* `python -m pytest tests`
-
-## Warning
-One of the main goals of Sanic is speed.  Code that lowers the performance of Sanic without significant gains in usability, security, or features may not be merged.

docs/cookies.md

@@ -1,50 +0,0 @@
-# Cookies
-
-## Request
-
-Request cookies can be accessed via the request.cookie dictionary
-
-### Example
-
-```python
-from sanic import Sanic
-from sanic.response import text
-
-@app.route("/cookie")
-async def test(request):
-    test_cookie = request.cookies.get('test')
-    return text("Test cookie set to: {}".format(test_cookie))
-```
-
-## Response
-
-Response cookies can be set like dictionary values and 
-have the following parameters available:
-
-* expires - datetime - Time for cookie to expire on the client's browser
-* path - string - The Path attribute specifies the subset of URLs to 
-         which this cookie applies
-* comment - string - Cookie comment (metadata)
-* domain - string - Specifies the domain for which the
-           cookie is valid.  An explicitly specified domain must always 
-           start with a dot.
-* max-age - number - Number of seconds the cookie should live for
-* secure - boolean - Specifies whether the cookie will only be sent via
-           HTTPS
-* httponly - boolean - Specifies whether the cookie cannot be read
-             by javascript
-
-### Example
-
-```python
-from sanic import Sanic
-from sanic.response import text
-
-@app.route("/cookie")
-async def test(request):
-    response = text("There's a cookie up in this response")
-    response.cookies['test'] = 'It worked!'
-    response.cookies['test']['domain'] = '.gotta-go-fast.com'
-    response.cookies['test']['httponly'] = True
-    return response
-```

docs/deploying.md

@@ -1,35 +0,0 @@
-# Deploying
-
-When it comes to deploying Sanic, there's not much to it, but there are
-a few things to take note of.
-
-## Workers
-
-By default, Sanic listens in the main process using only 1 CPU core.
-To crank up the juice, just specify the number of workers in the run
-arguments like so:
-
-```python
-app.run(host='0.0.0.0', port=1337, workers=4)
-```
-
-Sanic will automatically spin up multiple processes and route
-traffic between them.  We recommend as many workers as you have
-available cores.
-
-## Running via Command
-
-If you like using command line arguments, you can launch a sanic server
-by executing the module.  For example, if you initialized sanic as
-app in a file named server.py, you could run the server like so:
-
-`python -m sanic server.app --host=0.0.0.0 --port=1337 --workers=4`
-
-With this way of running sanic, it is not necessary to run app.run in
-your python file.  If you do, just make sure you wrap it in name == main
-like so:
-
-```python
-if __name__ == '__main__':
-    app.run(host='0.0.0.0', port=1337, workers=4)
-```

docs/exceptions.md

@@ -1,28 +0,0 @@
-# Exceptions
-
-Exceptions can be thrown from within request handlers and will automatically be handled by Sanic.  Exceptions take a message as their first argument, and can also take a status_code to be passed back in the HTTP response.  Check sanic.exceptions for the full list of exceptions to throw.
-
-## Throwing an exception
-
-```python
-from sanic import Sanic
-from sanic.exceptions import ServerError
-
-@app.route('/killme')
-def i_am_ready_to_die(request):
-	raise ServerError("Something bad happened")
-```
-
-## Handling Exceptions
-
-Just use the @exception decorator.  The decorator expects a list of exceptions to handle as arguments.  You can pass SanicException to catch them all!  The exception handler must expect a request and exception object as arguments.
-
-```python
-from sanic import Sanic
-from sanic.response import text
-from sanic.exceptions import NotFound
-
-@app.exception(NotFound)
-def ignore_404s(request, exception):
-	return text("Yep, I totally found the page: {}".format(request.url))
-```

docs/getting_started.md

@@ -1,25 +0,0 @@
-# Getting Started
-
-Make sure you have pip and python 3.5 before starting
-
-## Benchmarks
- * Install Sanic
- * `python3 -m pip install sanic`
- * Edit main.py to include:
-```python
-from sanic import Sanic
-from sanic.response import json
-
-app = Sanic(__name__)
-
-@app.route("/")
-async def test(request):
-    return json({ "hello": "world" })
-
-app.run(host="0.0.0.0", port=8000, debug=True)
-```
- * Run `python3 main.py`
-
-You now have a working Sanic server!  To continue on, check out:
- * [Request Data](request_data.md)
- * [Routing](routing.md)

docs/index.rst

@@ -0,0 +1,36 @@
+.. include:: sanic/index.rst
+
+Guides
+======
+
+.. toctree::
+   :maxdepth: 2
+
+   sanic/getting_started
+   sanic/routing
+   sanic/request_data
+   sanic/response
+   sanic/static_files
+   sanic/exceptions
+   sanic/middleware
+   sanic/blueprints
+   sanic/config
+   sanic/cookies
+   sanic/streaming
+   sanic/class_based_views
+   sanic/custom_protocol
+   sanic/ssl
+   sanic/logging
+   sanic/testing
+   sanic/deploying
+   sanic/extensions
+   sanic/contributing
+
+
+Module Documentation
+====================
+
+.. toctree::
+
+* :ref:`genindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=Sanic
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/middleware.md

@@ -1,49 +0,0 @@
-# Middleware
-
-Middleware can be executed before or after requests.  It is executed in the order it was registered.  If middleware returns a response object, the request will stop processing and a response will be returned.
-
-Middleware is registered via the middleware decorator, and can either be added as 'request' or 'response' middleware, based on the argument provided in the decorator.  Response middleware receives both the request and the response as arguments.
-
-## Examples
-
-```python
-app = Sanic(__name__)
-
-@app.middleware
-async def halt_request(request):
-	print("I am a spy")
-
-@app.middleware('request')
-async def halt_request(request):
-	return text('I halted the request')
-
-@app.middleware('response')
-async def halt_response(request, response):
-	return text('I halted the response')
-
-@app.route('/')
-async def handler(request):
-	return text('I would like to speak now please')
-
-app.run(host="0.0.0.0", port=8000)
-```
-
-## Middleware chain
-
-If you want to apply the middleware as a chain, applying more than one, is so easy. You only have to be aware that you do **not return** any response in your middleware:
-
-```python
-app = Sanic(__name__)
-
-@app.middleware('response')
-async def custom_banner(request, response):
-	response.headers["Server"] = "Fake-Server"
-
-@app.middleware('response')
-async def prevent_xss(request, response):
-	response.headers["x-xss-protection"] = "1; mode=block"
-
-app.run(host="0.0.0.0", port=8000)
-```
-
-The above code will apply the two middlewares in order. First the middleware **custom_banner** will change the HTTP Response headers *Server* by *Fake-Server*, and the second middleware **prevent_xss** will add the HTTP Headers for prevent Cross-Site-Scripting (XSS) attacks.

docs/request_data.md

@@ -1,49 +0,0 @@
-# Request Data
-
-## Properties
-
-The following request variables are accessible as properties:
-
-`request.files` (dictionary of File objects) - List of files that have a name, body, and type  
-`request.json` (any) - JSON body  
-`request.args` (dict) - Query String variables.  Use getlist to get multiple of the same name  
-`request.form` (dict) - Posted form variables.  Use getlist to get multiple of the same name  
-`request.body` (bytes) - Posted raw body.  To get the raw data, regardless of content type  
-
-See request.py for more information
-
-## Examples
-
-```python
-from sanic import Sanic
-from sanic.response import json, text
-
-@app.route("/json")
-def post_json(request):
-    return json({ "received": True, "message": request.json })
-
-@app.route("/form")
-def post_json(request):
-    return json({ "received": True, "form_data": request.form, "test": request.form.get('test') })
-
-@app.route("/files")
-def post_json(request):
-	test_file = request.files.get('test')
-
-	file_parameters = {
-		'body': test_file.body,
-		'name': test_file.name,
-		'type': test_file.type,
-	}
-
-    return json({ "received": True, "file_names": request.files.keys(), "test_file_parameters": file_parameters })
-
-@app.route("/query_string")
-def query_string(request):
-    return json({ "parsed": True, "args": request.args, "url": request.url, "query_string": request.query_string })
-
-
-@app.route("/users", methods=["POST",])
-def create_user(request):
-    return text("You are trying to create a user with the following POST: %s" % request.body)
-```

docs/routing.md

@@ -1,44 +0,0 @@
-# Routing
-
-Sanic comes with a basic router that supports request parameters.  To specify a parameter, surround it with carrots like so: `<PARAM>`.  Request parameters will be passed to the request handler functions as keyword arguments.  To specify a type, add a :type after the parameter name, in the carrots.  If the parameter does not match the type supplied, Sanic will throw a NotFound exception, resulting in a 404 page not found error.
-
-
-## Examples
-
-```python
-from sanic import Sanic
-from sanic.response import text
-
-@app.route('/tag/<tag>')
-async def tag_handler(request, tag):
-	return text('Tag - {}'.format(tag))
-
-@app.route('/number/<integer_arg:int>')
-async def integer_handler(request, integer_arg):
-	return text('Integer - {}'.format(integer_arg))
-
-@app.route('/number/<number_arg:number>')
-async def number_handler(request, number_arg):
-	return text('Number - {}'.format(number_arg))
-
-@app.route('/person/<name:[A-z]>')
-async def person_handler(request, name):
-	return text('Person - {}'.format(name))
-
-@app.route('/folder/<folder_id:[A-z0-9]{0,4}>')
-async def folder_handler(request, folder_id):
-	return text('Folder - {}'.format(folder_id))
-
-async def handler1(request):
-	return text('OK')
-app.add_route(handler1, '/test')
-
-async def handler(request, name):
-	return text('Folder - {}'.format(name))
-app.add_route(handler, '/folder/<name>')
-
-async def person_handler(request, name):
-	return text('Person - {}'.format(name))
-app.add_route(handler, '/person/<name:[A-z]>')
-
-```

docs/sanic/blueprints.md

@@ -0,0 +1,184 @@
+# Blueprints
+
+Blueprints are objects that can be used for sub-routing within an application.
+Instead of adding routes to the application instance, blueprints define similar
+methods for adding routes, which are then registered with the application in a
+flexible and pluggable manner.
+
+Blueprints are especially useful for larger applications, where your
+application logic can be broken down into several groups or areas of
+responsibility.
+
+## My First Blueprint
+
+The following shows a very simple blueprint that registers a handler-function at
+the root `/` of your application.
+
+Suppose you save this file as `my_blueprint.py`, which can be imported into your
+main application later.
+
+```python
+from sanic.response import json
+from sanic import Blueprint
+
+bp = Blueprint('my_blueprint')
+
+@bp.route('/')
+async def bp_root(request):
+    return json({'my': 'blueprint'})
+
+```
+
+## Registering blueprints
+
+Blueprints must be registered with the application.
+
+```python
+from sanic import Sanic
+from my_blueprint import bp
+
+app = Sanic(__name__)
+app.blueprint(bp)
+
+app.run(host='0.0.0.0', port=8000, debug=True)
+```
+
+This will add the blueprint to the application and register any routes defined
+by that blueprint. In this example, the registered routes in the `app.router`
+will look like:
+
+```python
+[Route(handler=<function bp_root at 0x7f908382f9d8>, methods=None, pattern=re.compile('^/$'), parameters=[])]
+```
+
+## Using blueprints
+
+Blueprints have much the same functionality as an application instance.
+
+### WebSocket routes
+
+WebSocket handlers can be registered on a blueprint using the `@bp.websocket`
+decorator or `bp.add_websocket_route` method.
+
+### Middleware
+
+Using blueprints allows you to also register middleware globally.
+
+```python
+@bp.middleware
+async def print_on_request(request):
+	print("I am a spy")
+
+@bp.middleware('request')
+async def halt_request(request):
+	return text('I halted the request')
+
+@bp.middleware('response')
+async def halt_response(request, response):
+	return text('I halted the response')
+```
+
+### Exceptions
+
+Exceptions can be applied exclusively to blueprints globally.
+
+```python
+@bp.exception(NotFound)
+def ignore_404s(request, exception):
+	return text("Yep, I totally found the page: {}".format(request.url))
+```
+
+### Static files
+
+Static files can be served globally, under the blueprint prefix.
+
+```python
+bp.static('/folder/to/serve', '/web/path')
+```
+
+## Start and stop
+
+Blueprints can run functions during the start and stop process of the server.
+If running in multiprocessor mode (more than 1 worker), these are triggered
+after the workers fork.
+
+Available events are:
+
+- `before_server_start`: Executed before the server begins to accept connections
+- `after_server_start`: Executed after the server begins to accept connections
+- `before_server_stop`: Executed before the server stops accepting connections
+- `after_server_stop`: Executed after the server is stopped and all requests are complete
+
+```python
+bp = Blueprint('my_blueprint')
+
+@bp.listener('before_server_start')
+async def setup_connection(app, loop):
+    global database
+    database = mysql.connect(host='127.0.0.1'...)
+
+@bp.listener('after_server_stop')
+async def close_connection(app, loop):
+    await database.close()
+```
+
+## Use-case: API versioning
+
+Blueprints can be very useful for API versioning, where one blueprint may point
+at `/v1/<routes>`, and another pointing at `/v2/<routes>`.
+
+When a blueprint is initialised, it can take an optional `url_prefix` argument,
+which will be prepended to all routes defined on the blueprint. This feature
+can be used to implement our API versioning scheme.
+
+```python
+# blueprints.py
+from sanic.response import text
+from sanic import Blueprint
+
+blueprint_v1 = Blueprint('v1', url_prefix='/v1')
+blueprint_v2 = Blueprint('v2', url_prefix='/v2')
+
+@blueprint_v1.route('/')
+async def api_v1_root(request):
+    return text('Welcome to version 1 of our documentation')
+
+@blueprint_v2.route('/')
+async def api_v2_root(request):
+    return text('Welcome to version 2 of our documentation')
+```
+
+When we register our blueprints on the app, the routes `/v1` and `/v2` will now
+point to the individual blueprints, which allows the creation of *sub-sites*
+for each API version.
+
+```python
+# main.py
+from sanic import Sanic
+from blueprints import blueprint_v1, blueprint_v2
+
+app = Sanic(__name__)
+app.blueprint(blueprint_v1, url_prefix='/v1')
+app.blueprint(blueprint_v2, url_prefix='/v2')
+
+app.run(host='0.0.0.0', port=8000, debug=True)
+```
+
+## URL Building with `url_for`
+
+If you wish to generate a URL for a route inside of a blueprint, remember that the endpoint name
+takes the format `<blueprint_name>.<handler_name>`. For example:
+
+```
+@blueprint_v1.route('/')
+async def root(request):
+    url = app.url_for('v1.post_handler', post_id=5) # --> '/v1/post/5'
+    return redirect(url)
+
+
+@blueprint_v1.route('/post/<post_id>')
+async def post_handler(request, post_id):
+    return text('Post {} in Blueprint V1'.format(post_id))
+```
+
+

docs/sanic/class_based_views.md

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

docs/sanic/config.md

@@ -0,0 +1,86 @@
+# Configuration
+
+Any reasonably complex application will need configuration that is not baked into the actual code. Settings might be different for different environments or installations.
+
+## Basics
+
+Sanic holds the configuration in the `config` attribute of the application object. The configuration object is merely an object that can be modified either using dot-notation or like a dictionary:
+
+```
+app = Sanic('myapp')
+app.config.DB_NAME = 'appdb'
+app.config.DB_USER = 'appuser'
+```
+
+Since the config object actually is a dictionary, you can use its `update` method in order to set several values at once:
+
+```
+db_settings = {
+    'DB_HOST': 'localhost',
+    'DB_NAME': 'appdb',
+    'DB_USER': 'appuser'
+}
+app.config.update(db_settings)
+```
+
+In general the convention is to only have UPPERCASE configuration parameters. The methods described below for loading configuration only look for such uppercase parameters.
+
+## Loading Configuration
+
+There are several ways how to load configuration.
+
+### From environment variables.
+
+Any variables defined with the `SANIC_` prefix will be applied to the sanic config. For example, setting `SANIC_REQUEST_TIMEOUT` will be loaded by the application automatically. You can pass the `load_vars` boolean to the Sanic constructor to override that:
+
+```python
+app = Sanic(load_vars=False)
+```
+
+### From an Object
+
+If there are a lot of configuration values and they have sensible defaults it might be helpful to put them into a module:
+
+```
+import myapp.default_settings
+
+app = Sanic('myapp')
+app.config.from_object(myapp.default_settings)
+```
+
+You could use a class or any other object as well.
+
+### From a File
+
+Usually you will want to load configuration from a file that is not part of the distributed application. You can load configuration from a file using `from_file(/path/to/config_file)`. However, that requires the program to know the path to the config file. So instead you can specify the location of the config file in an environment variable and tell Sanic to use that to find the config file:
+
+```
+app = Sanic('myapp')
+app.config.from_envvar('MYAPP_SETTINGS')
+```
+
+Then you can run your application with the `MYAPP_SETTINGS` environment variable set:
+
+```
+$ MYAPP_SETTINGS=/path/to/config_file python3 myapp.py
+INFO: Goin' Fast @ http://0.0.0.0:8000
+```
+
+The config files are regular Python files which are executed in order to load them. This allows you to use arbitrary logic for constructing the right configuration. Only uppercase varibales are added to the configuration. Most commonly the configuration consists of simple key value pairs:
+
+```
+# config_file
+DB_HOST = 'localhost'
+DB_NAME = 'appdb'
+DB_USER = 'appuser'
+```
+
+## Builtin Configuration Values
+
+Out of the box there are just a few predefined values which can be overwritten when creating the application.
+
+    | Variable          | Default   | Description                       |
+    | ----------------- | --------- | --------------------------------- |
+    | REQUEST_MAX_SIZE  | 100000000 | How big a request may be (bytes)  |
+    | REQUEST_TIMEOUT   | 60        | How long a request can take (sec) |
+    | KEEP_ALIVE        | True      | Disables keep-alive when False    |

docs/sanic/contributing.md

@@ -0,0 +1,62 @@
+# Contributing
+
+Thank you for your interest! Sanic is always looking for contributors. If you
+don't feel comfortable contributing code, adding docstrings to the source files
+is very appreciated.
+
+## Installation
+
+To develop on sanic (and mainly to just run the tests) it is highly recommend to
+install from sources.
+
+So assume you have already cloned the repo and are in the working directory with
+a virtual environment already set up, then run:
+
+```bash
+python setup.py develop && pip install -r requirements-dev.txt
+```
+
+## Running tests
+
+To run the tests for sanic it is recommended to use tox like so:
+
+```bash
+tox
+```
+
+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 
+one current collaborator on the project
+* All pull requests must pass flake8 checks
+* If you decide to remove/change anything from any common interface
+a deprecation message should accompany it.
+* If you implement a new feature you should have at least one unit
+test to accompany it.
+
+## Documentation
+
+Sanic's documentation is built
+using [sphinx](http://www.sphinx-doc.org/en/1.5.1/). Guides are written in
+Markdown and can be found in the `docs` folder, while the module reference is
+automatically generated using `sphinx-apidoc`.
+
+To generate the documentation from scratch:
+
+```bash
+sphinx-apidoc -fo docs/_api/ sanic
+sphinx-build -b html docs docs/_build
+```
+
+The HTML documentation will be created in the `docs/_build` folder.
+
+## Warning
+
+One of the main goals of Sanic is speed. Code that lowers the performance of
+Sanic without significant gains in usability, security, or features may not be
+merged. Please don't let this intimidate you! If you have any concerns about an
+idea, open an issue for discussion and help.

docs/sanic/cookies.md

@@ -0,0 +1,75 @@
+# Cookies
+
+Cookies are pieces of data which persist inside a user's browser. Sanic can
+both read and write cookies, which are stored as key-value pairs.
+
+## Reading cookies
+
+A user's cookies can be accessed via the `Request` object's `cookies` dictionary.
+
+```python
+from sanic.response import text
+
+@app.route("/cookie")
+async def test(request):
+    test_cookie = request.cookies.get('test')
+    return text("Test cookie set to: {}".format(test_cookie))
+```
+
+## Writing cookies
+
+When returning a response, cookies can be set on the `Response` object.
+
+```python
+from sanic.response import text
+
+@app.route("/cookie")
+async def test(request):
+    response = text("There's a cookie up in this response")
+    response.cookies['test'] = 'It worked!'
+    response.cookies['test']['domain'] = '.gotta-go-fast.com'
+    response.cookies['test']['httponly'] = True
+    return response
+```
+
+## Deleting cookies
+
+Cookies can be removed semantically or explicitly.
+
+```python
+from sanic.response import text
+
+@app.route("/cookie")
+async def test(request):
+    response = text("Time to eat some cookies muahaha")
+
+    # This cookie will be set to expire in 0 seconds
+    del response.cookies['kill_me']
+
+    # This cookie will self destruct in 5 seconds
+    response.cookies['short_life'] = 'Glad to be here'
+    response.cookies['short_life']['max-age'] = 5
+    del response.cookies['favorite_color']
+
+    # This cookie will remain unchanged
+    response.cookies['favorite_color'] = 'blue'
+    response.cookies['favorite_color'] = 'pink'
+    del response.cookies['favorite_color']
+
+    return response
+```
+
+Response cookies can be set like dictionary values and have the following
+parameters available:
+
+- `expires` (datetime): The time for the cookie to expire on the
+                        client's browser.
+- `path` (string): The subset of URLs to which this cookie applies.  Defaults to /.
+- `comment` (string): A comment (metadata).
+- `domain` (string): Specifies the domain for which the cookie is valid. An
+           explicitly specified domain must always start with a dot.
+- `max-age` (number): Number of seconds the cookie should live for.
+- `secure` (boolean): Specifies whether the cookie will only be sent via
+                      HTTPS.
+- `httponly` (boolean): Specifies whether the cookie cannot be read by
+                        Javascript.

docs/sanic/custom_protocol.md

@@ -0,0 +1,72 @@
+# Custom Protocols
+
+*Note: this is advanced usage, and most readers will not need such functionality.*
+
+You can change the behavior of Sanic's protocol by specifying a custom
+protocol, which should be a subclass
+of
+[asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.html#protocol-classes).
+This protocol can then be passed as the keyword argument `protocol` to the `sanic.run` method.
+
+The constructor of the custom protocol class receives the following keyword
+arguments from Sanic.
+
+- `loop`: an `asyncio`-compatible event loop.
+- `connections`: a `set` to store protocol objects. When Sanic receives
+  `SIGINT` or `SIGTERM`, it executes `protocol.close_if_idle` for all protocol
+  objects stored in this set.
+- `signal`: a `sanic.server.Signal` object with the `stopped` attribute. When
+  Sanic receives `SIGINT` or `SIGTERM`, `signal.stopped` is assigned `True`.
+- `request_handler`: a coroutine that takes a `sanic.request.Request` object
+  and a `response` callback as arguments.
+- `error_handler`: a `sanic.exceptions.Handler` which is called when exceptions
+  are raised.
+- `request_timeout`: the number of seconds before a request times out.
+- `request_max_size`: an integer specifying the maximum size of a request, in bytes.
+
+## Example
+
+An error occurs in the default protocol if a handler function does not return
+an `HTTPResponse` object.
+
+By overriding the `write_response` protocol method, if a handler returns a
+string it will be converted to an `HTTPResponse object`.
+
+```python
+from sanic import Sanic
+from sanic.server import HttpProtocol
+from sanic.response import text
+
+app = Sanic(__name__)
+
+
+class CustomHttpProtocol(HttpProtocol):
+
+    def __init__(self, *, loop, request_handler, error_handler,
+                 signal, connections, request_timeout, request_max_size):
+        super().__init__(
+            loop=loop, request_handler=request_handler,
+            error_handler=error_handler, signal=signal,
+            connections=connections, request_timeout=request_timeout,
+            request_max_size=request_max_size)
+
+    def write_response(self, response):
+        if isinstance(response, str):
+            response = text(response)
+        self.transport.write(
+            response.output(self.request.version)
+        )
+        self.transport.close()
+
+
+@app.route('/')
+async def string(request):
+    return 'string'
+
+
+@app.route('/1')
+async def response(request):
+    return text('response')
+
+app.run(host='0.0.0.0', port=8000, protocol=CustomHttpProtocol)
+```

docs/sanic/decorators.md

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

docs/sanic/deploying.md

@@ -0,0 +1,72 @@
+# Deploying
+
+Deploying Sanic is made simple by the inbuilt webserver. After defining an
+instance of `sanic.Sanic`, we can call the `run` method with the following
+keyword arguments:
+
+- `host` *(default `"127.0.0.1"`)*: Address to host the server on.
+- `port` *(default `8000`)*: Port to host the server on.
+- `debug` *(default `False`)*: Enables debug output (slows server).
+- `ssl` *(default `None`)*: `SSLContext` for SSL encryption of worker(s).
+- `sock` *(default `None`)*: Socket for the server to accept connections from.
+- `workers` *(default `1`)*: Number of worker processes to spawn.
+- `loop` *(default `None`)*: An `asyncio`-compatible event loop. If none is
+                             specified, Sanic creates its own event loop.
+- `protocol` *(default `HttpProtocol`)*: Subclass
+  of
+  [asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.html#protocol-classes).
+
+## Workers
+
+By default, Sanic listens in the main process using only one CPU core. To crank
+up the juice, just specify the number of workers in the `run` arguments.
+
+```python
+app.run(host='0.0.0.0', port=1337, workers=4)
+```
+
+Sanic will automatically spin up multiple processes and route traffic between
+them. We recommend as many workers as you have available cores.
+
+## Running via command
+
+If you like using command line arguments, you can launch a Sanic server by
+executing the module. For example, if you initialized Sanic as `app` in a file
+named `server.py`, you could run the server like so:
+
+`python -m sanic server.app --host=0.0.0.0 --port=1337 --workers=4`
+
+With this way of running sanic, it is not necessary to invoke `app.run` in your
+Python file. If you do, make sure you wrap it so that it only executes when
+directly run by the interpreter.
+
+```python
+if __name__ == '__main__':
+    app.run(host='0.0.0.0', port=1337, workers=4)
+```
+
+## Running via Gunicorn
+
+[Gunicorn](http://gunicorn.org/) ‘Green Unicorn’ is a WSGI HTTP Server for UNIX.
+It’s a pre-fork worker model ported from Ruby’s Unicorn project.
+
+In order to run Sanic application with Gunicorn, you need to use the special `sanic.worker.GunicornWorker`
+for Gunicorn `worker-class` argument:
+
+```
+gunicorn --bind 0.0.0.0:1337 --worker-class sanic.worker.GunicornWorker
+```
+
+## Asynchronous support
+This is suitable if you *need* to share the sanic process with other applications, in particular the `loop`.
+However be advised that this method does not support using multiple processes, and is not the preferred way
+to run the app in general.
+
+Here is an incomplete example (please see `run_async.py` in examples for something more practical):
+
+```python
+server = app.create_server(host="0.0.0.0", port=8000)
+loop = asyncio.get_event_loop()
+task = asyncio.ensure_future(server)
+loop.run_forever()
+```

docs/sanic/exceptions.md

@@ -0,0 +1,45 @@
+# Exceptions
+
+Exceptions can be thrown from within request handlers and will automatically be
+handled by Sanic. Exceptions take a message as their first argument, and can
+also take a status code to be passed back in the HTTP response.
+
+## Throwing an exception
+
+To throw an exception, simply `raise` the relevant exception from the
+`sanic.exceptions` module.
+
+```python
+from sanic.exceptions import ServerError
+
+@app.route('/killme')
+def i_am_ready_to_die(request):
+	raise ServerError("Something bad happened", status_code=500)
+```
+
+## Handling exceptions
+
+To override Sanic's default handling of an exception, the `@app.exception`
+decorator is used. The decorator expects a list of exceptions to handle as
+arguments. You can pass `SanicException` to catch them all! The decorated
+exception handler function must take a `Request` and `Exception` object as
+arguments.
+
+```python
+from sanic.response import text
+from sanic.exceptions import NotFound
+
+@app.exception(NotFound)
+def ignore_404s(request, exception):
+	return text("Yep, I totally found the page: {}".format(request.url))
+```
+
+## Useful exceptions
+
+Some of the most useful exceptions are presented below:
+
+- `NotFound`: called when a suitable route for the request isn't found.
+- `ServerError`: called when something goes wrong inside the server. This
+  usually occurs if there is an exception raised in user code.
+
+See the `sanic.exceptions` module for the full list of exceptions to throw.

docs/sanic/extensions.md

@@ -0,0 +1,24 @@
+# Extensions
+
+A list of Sanic extensions created by the community.
+
+- [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.
+- [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.
+- [Sanic CRUD](https://github.com/Typhon66/sanic_crud): CRUD REST API generation with peewee models.
+- [UserAgent](https://github.com/lixxu/sanic-useragent): Add `user_agent` to request
+- [Limiter](https://github.com/bohea/sanic-limiter): Rate limiting for sanic.
+- [Sanic EnvConfig](https://github.com/jamesstidard/sanic-envconfig): Pull environment variables into your sanic config.
+- [Babel](https://github.com/lixxu/sanic-babel): Adds i18n/l10n support to Sanic applications with the help of the
+`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-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
+- [Sanic-RestPlus](https://github.com/ashleysommer/sanic-restplus): A port of Flask-RestPlus for Sanic. Full-featured REST API with SwaggerUI generation.

docs/sanic/getting_started.md

@@ -0,0 +1,27 @@
+# Getting Started
+
+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:
+
+  ```python
+  from sanic import Sanic
+  from sanic.response import text
+
+  app = Sanic(__name__)
+
+  @app.route("/")
+  async def test(request):
+      return text('Hello world!')
+
+  app.run(host="0.0.0.0", port=8000, debug=True)
+  ```
+  
+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!*.
+
+You now have a working Sanic server!

docs/sanic/index.rst

@@ -0,0 +1,25 @@
+Sanic
+=================================
+
+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 aspires to be simple
+---------------------------
+
+.. code:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+
+    app = Sanic()
+
+    @app.route("/")
+    async def test(request):
+        return json({"hello": "world"})
+
+    if __name__ == "__main__":
+        app.run(host="0.0.0.0", port=8000)

docs/sanic/logging.md

@@ -0,0 +1,128 @@
+# Logging
+
+
+Sanic allows you to do different types of logging (access log, error log) on the requests based on the [python3 logging API](https://docs.python.org/3/howto/logging.html). You should have some basic knowledge on python3 logging if you want do create a new configuration.
+
+### Quck Start
+
+A simple example using default setting 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'] = [
+    'accessTimedRotatingFile', 'errorTimedRotationgFile']
+
+app = Sanic('test')
+
+@app.route('/')
+async def test(request):
+    return response.text('Hello World!')
+
+if __name__ == "__main__":
+  app.run(log_config=LOGGING)
+```
+
+After the program starts, it will log down all the information/requests in access.log and error.log in your working directory.
+
+And to close logging, simply assign log_config=None:
+
+```python
+if __name__ == "__main__":
+  app.run(log_config=None)
+```
+
+This would skip calling logging functions when handling requests.
+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)
+```
+
+### Configuration
+
+By default, log_config parameter is set to use sanic.config.LOGGING dictionary for configuration. The default configuration provides several predefined `handlers`:
+
+- internal (using [logging.StreamHandler](https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler))<br>
+  For internal information console outputs.
+
+
+- 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)
+
+
+- accessTimedRotatingFile (using [logging.handlers.TimedRotatingFileHandler](https://docs.python.org/3/library/logging.handlers.html#logging.handlers.TimedRotatingFileHandler))<br>
+  For requests information logging to file with daily rotation support.
+
+
+- errorTimedRotatingFile (using [logging.handlers.TimedRotatingFileHandler](https://docs.python.org/3/library/logging.handlers.html#logging.handlers.TimedRotatingFileHandler))<br>
+  For error message and traceback logging to file with daily rotation support.
+
+And `filters`:
+
+- accessFilter (using sanic.defaultFilter.DefaultFilter)<br>
+  The filter that allows only levels in `DEBUG`, `INFO`, and `NONE(0)`
+
+
+- errorFilter (using sanic.defaultFilter.DefaultFilter)<br>
+  The filter taht 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>
+  Used to log internal messages.
+
+
+- network:<br>
+  Used to log requests from network, and any information from those requests.
+
+#### Log format:
+
+In addition to default parameters provided by python (asctime, levelname, message),
+Sanic provides additional parameters for network logger with accessFilter:
+
+- host (str)<br>
+  request.ip
+
+
+- request (str)<br>
+  request.method + " " + request.url
+
+
+- status (int)<br>
+  response.status
+
+
+- byte (int)<br>
+  len(response.body)
+
+
+The default access log format is 
+```python
+%(asctime)s - (%(name)s)[%(levelname)s][%(host)s]: %(request)s %(message)s %(status)d %(byte)d
+```

docs/sanic/middleware.md

@@ -0,0 +1,112 @@
+# Middleware And Listeners
+
+Middleware are functions which are executed before or after requests to the
+server. They can be used to modify the *request to* or *response from*
+user-defined handler functions.
+
+Additionally, Sanic providers 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.
+
+
+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")
+
+@app.middleware('response')
+async def print_on_response(request, response):
+	print("I print when a response is returned by the server")
+```
+
+## Modifying the request or response
+
+Middleware can modify the request or response parameter it is given, *as long
+as it does not return it*. The following example shows a practical use-case for
+this.
+
+```python
+app = Sanic(__name__)
+
+@app.middleware('response')
+async def custom_banner(request, response):
+	response.headers["Server"] = "Fake-Server"
+
+@app.middleware('response')
+async def prevent_xss(request, response):
+	response.headers["x-xss-protection"] = "1; mode=block"
+
+app.run(host="0.0.0.0", port=8000)
+```
+
+The above code will apply the two middleware in order. First, the middleware
+**custom_banner** will change the HTTP response header *Server* to
+*Fake-Server*, and the second middleware **prevent_xss** will add the HTTP
+header for preventing Cross-Site-Scripting (XSS) attacks. These two functions
+are invoked *after* a user function returns a response.
+
+## Responding early
+
+If middleware returns a `HTTPResponse` object, the request will stop processing
+and the response will be returned. If this occurs to a request before the
+relevant user route handler is reached, the handler will never be called.
+Returning a response will also prevent any further middleware from running.
+
+```python
+@app.middleware('request')
+async def halt_request(request):
+	return text('I halted the request')
+
+@app.middleware('response')
+async def halt_response(request, response):
+	return text('I halted the response')
+```
+
+## Listeners
+
+If you want to execute startup/teardown code as your server starts or closes, you can use the following listeners:
+
+- `before_server_start`
+- `after_server_start`
+- `before_server_stop`
+- `after_server_stop`
+
+These listeners are implemented as decorators on functions which accept the app object as well as the asyncio loop. 
+
+For example:
+
+```python
+@app.listener('before_server_start')
+async def setup_db(app, loop):
+    app.db = await db_setup()
+
+@app.listener('after_server_start')
+async def notify_server_started(app, loop):
+    print('Server successfully started!')
+
+@app.listener('before_server_stop')
+async def notify_server_stopping(app, loop):
+    print('Server shutting down!')
+
+@app.listener('after_server_stop')
+async def close_db(app, loop):
+    await app.db.close()
+```
+
+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())
+```

docs/sanic/request_data.md

@@ -0,0 +1,119 @@
+# Request Data
+
+When an endpoint receives a HTTP request, the route function is passed a
+`Request` object.
+
+The following variables are accessible as properties on `Request` objects:
+
+- `json` (any) - JSON body
+
+  ```python
+  from sanic.response import json
+
+  @app.route("/json")
+  def post_json(request):
+      return json({ "received": True, "message": request.json })
+  ```
+
+- `args` (dict) - Query string variables. A query string is the section of a
+  URL that resembles `?key1=value1&key2=value2`. If that URL were to be parsed,
+  the `args` dictionary would look like `{'key1': ['value1'], 'key2': ['value2']}`.
+  The request's `query_string` variable holds the unparsed string value.
+
+  ```python
+  from sanic.response import json
+
+  @app.route("/query_string")
+  def query_string(request):
+      return json({ "parsed": True, "args": request.args, "url": request.url, "query_string": request.query_string })
+  ```
+
+- `raw_args` (dict) - On many cases you would need to access the url arguments in
+  a less packed dictionary. For same previous URL `?key1=value1&key2=value2`, the
+  `raw_args` dictionary would look like `{'key1': 'value1', 'key2': 'value2'}`.
+
+- `files` (dictionary of `File` objects) - List of files that have a name, body, and type
+
+  ```python
+  from sanic.response import json
+
+  @app.route("/files")
+  def post_json(request):
+      test_file = request.files.get('test')
+
+      file_parameters = {
+          'body': test_file.body,
+          'name': test_file.name,
+          'type': test_file.type,
+      }
+
+      return json({ "received": True, "file_names": request.files.keys(), "test_file_parameters": file_parameters })
+  ```
+
+- `form` (dict) - Posted form variables.
+
+  ```python
+  from sanic.response import json
+
+  @app.route("/form")
+  def post_json(request):
+      return json({ "received": True, "form_data": request.form, "test": request.form.get('test') })
+  ```
+
+- `body` (bytes) - Posted raw body. This property allows retrieval of the
+  request's raw data, regardless of content type.
+
+  ```python
+  from sanic.response import text
+
+  @app.route("/users", methods=["POST",])
+  def create_user(request):
+      return text("You are trying to create a user with the following POST: %s" % request.body)
+  ```
+
+- `ip` (str) - IP address of the requester.
+
+- `app` - a reference to the Sanic application object that is handling this request. This is useful when inside blueprints or other handlers in modules that do not have access to the global `app` object.
+
+  ```python
+  from sanic.response import json
+  from sanic import Blueprint
+
+  bp = Blueprint('my_blueprint')
+
+  @bp.route('/')
+  async def bp_root(request):
+      if request.app.config['DEBUG']:
+          return json({'status': 'debug'})
+      else:
+          return json({'status': 'production'})
+
+  ```
+- `url`: The full URL of the request, ie: `http://localhost:8000/posts/1/?foo=bar`
+- `scheme`: The URL scheme associated with the request: `http` or `https`
+- `host`: The host associated with the request: `localhost:8080`
+- `path`: The path of the request: `/posts/1/`
+- `query_string`: The query string of the request: `foo=bar` or a blank string `''`
+- `uri_template`: Template for matching route handler: `/posts/<id>/`
+
+
+## Accessing values using `get` and `getlist`
+
+The request properties which return a dictionary actually return a subclass of
+`dict` called `RequestParameters`. The key difference when using this object is
+the distinction between the `get` and `getlist` methods.
+
+- `get(key, default=None)` operates as normal, except that when the value of
+  the given key is a list, *only the first item is returned*.
+- `getlist(key, default=None)` operates as normal, *returning the entire list*.
+
+```python
+from sanic.request import RequestParameters
+
+args = RequestParameters()
+args['titles'] = ['Post 1', 'Post 2']
+
+args.get('titles') # => 'Post 1'
+
+args.getlist('titles') # => ['Post 1', 'Post 2']
+```

docs/sanic/response.md

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

docs/sanic/routing.md

@@ -0,0 +1,217 @@
+# Routing
+
+Routing allows the user to specify handler functions for different URL endpoints.
+
+A basic route looks like the following, where `app` is an instance of the
+`Sanic` class:
+
+```python
+from sanic.response import json
+
+@app.route("/")
+async def test(request):
+    return json({ "hello": "world" })
+```
+
+When the url `http://server.url/` is accessed (the base url of the server), the
+final `/` is matched by the router to the handler function, `test`, which then
+returns a JSON object.
+
+Sanic handler functions must be defined using the `async def` syntax, as they
+are asynchronous functions.
+
+## Request parameters
+
+Sanic comes with a basic router that supports request parameters.
+
+To specify a parameter, surround it with angle quotes like so: `<PARAM>`.
+Request parameters will be passed to the route handler functions as keyword
+arguments.
+
+```python
+from sanic.response import text
+
+@app.route('/tag/<tag>')
+async def tag_handler(request, tag):
+	return text('Tag - {}'.format(tag))
+```
+
+To specify a type for the parameter, add a `:type` after the parameter name,
+inside the quotes. If the parameter does not match the specified type, Sanic
+will throw a `NotFound` exception, resulting in a `404: Page not found` error
+on the URL.
+
+```python
+from sanic.response import text
+
+@app.route('/number/<integer_arg:int>')
+async def integer_handler(request, integer_arg):
+	return text('Integer - {}'.format(integer_arg))
+
+@app.route('/number/<number_arg:number>')
+async def number_handler(request, number_arg):
+	return text('Number - {}'.format(number_arg))
+
+@app.route('/person/<name:[A-z]+>')
+async def person_handler(request, name):
+	return text('Person - {}'.format(name))
+
+@app.route('/folder/<folder_id:[A-z0-9]{0,4}>')
+async def folder_handler(request, folder_id):
+	return text('Folder - {}'.format(folder_id))
+
+```
+
+## HTTP request types
+
+By default, a route defined on a URL will be available for only GET requests to that URL.
+However, the `@app.route` decorator accepts an optional parameter, `methods`,
+which allows the handler function to work with any of the HTTP methods in the list.
+
+```python
+from sanic.response import text
+
+@app.route('/post', methods=['POST'])
+async def post_handler(request):
+	return text('POST request - {}'.format(request.json))
+
+@app.route('/get', methods=['GET'])
+async def get_handler(request):
+	return text('GET request - {}'.format(request.args))
+
+```
+
+There is also an optional `host` argument (which can be a list or a string). This restricts a route to the host or hosts provided. If there is a also a route with no host, it will be the default.
+
+```python
+@app.route('/get', methods=['GET'], host='example.com')
+async def get_handler(request):
+	return text('GET request - {}'.format(request.args))
+
+# if the host header doesn't match example.com, this route will be used
+@app.route('/get', methods=['GET'])
+async def get_handler(request):
+	return text('GET request in default - {}'.format(request.args))
+```
+
+There are also shorthand method decorators:
+
+```python
+from sanic.response import text
+
+@app.post('/post')
+async def post_handler(request):
+	return text('POST request - {}'.format(request.json))
+
+@app.get('/get')
+async def get_handler(request):
+	return text('GET request - {}'.format(request.args))
+
+```
+## The `add_route` method
+
+As we have seen, routes are often specified using the `@app.route` decorator.
+However, this decorator is really just a wrapper for the `app.add_route`
+method, which is used as follows:
+
+```python
+from sanic.response import text
+
+# Define the handler functions
+async def handler1(request):
+	return text('OK')
+
+async def handler2(request, name):
+	return text('Folder - {}'.format(name))
+
+async def person_handler2(request, name):
+	return text('Person - {}'.format(name))
+
+# Add each handler function as a route
+app.add_route(handler1, '/test')
+app.add_route(handler2, '/folder/<name>')
+app.add_route(person_handler2, '/person/<name:[A-z]>', methods=['GET'])
+```
+
+## URL building with `url_for`
+
+Sanic provides a `url_for` method, to generate URLs based on the handler method name. This is useful if you want to avoid hardcoding url paths into your app; instead, you can just reference the handler name. For example:
+
+```python
+@app.route('/')
+async def index(request):
+    # generate a URL for the endpoint `post_handler`
+    url = app.url_for('post_handler', post_id=5)
+    # the URL is `/posts/5`, redirect to it
+    return redirect(url)
+
+
+@app.route('/posts/<post_id>')
+async def post_handler(request, post_id):
+    return text('Post - {}'.format(post_id))
+```
+
+Other things to keep in mind when using `url_for`:
+
+- Keyword arguments passed to `url_for` that are not request parameters will be included in the URL's query string. For example:
+```python
+url = app.url_for('post_handler', post_id=5, arg_one='one', arg_two='two')
+# /posts/5?arg_one=one&arg_two=two
+```
+- Multivalue argument can be passed to `url_for`. For example:
+```python
+url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two'])
+# /posts/5?arg_one=one&arg_one=two
+```
+- Also some special arguments (`_anchor`, `_external`, `_scheme`, `_method`, `_server`) passed to `url_for` will have special url building (`_method` is not support now and will be ignored). For example:
+```python
+url = app.url_for('post_handler', post_id=5, arg_one='one', _anchor='anchor')
+# /posts/5?arg_one=one#anchor
+
+url = app.url_for('post_handler', post_id=5, arg_one='one', _external=True)
+# //server/posts/5?arg_one=one
+# _external requires passed argument _server or SERVER_NAME in app.config or url will be same as no _external
+
+url = app.url_for('post_handler', post_id=5, arg_one='one', _scheme='http', _external=True)
+# http://server/posts/5?arg_one=one
+# when specifying _scheme, _external must be True
+
+# you can pass all special arguments one time
+url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two'], arg_two=2, _anchor='anchor', _scheme='http', _external=True, _server='another_server:8888')
+# http://another_server:8888/posts/5?arg_one=one&arg_one=two&arg_two=2#anchor
+```
+- All valid parameters must be passed to `url_for` to build a URL. If a parameter is not supplied, or if a parameter does not match the specified type, a `URLBuildError` will be thrown.
+
+## WebSocket routes
+
+Routes for the WebSocket protocol can be defined with the `@app.websocket`
+decorator:
+
+```python
+@app.websocket('/feed')
+async def feed(request, ws):
+    while True:
+        data = 'hello!'
+        print('Sending: ' + data)
+        await ws.send(data)
+        data = await ws.recv()
+        print('Received: ' + data)
+```
+
+Alternatively, the `app.add_websocket_route` method can be used instead of the
+decorator:
+
+```python
+async def feed(request, ws):
+    pass
+
+app.add_websocket_route(my_websocket_handler, '/feed')
+```
+
+Handlers 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.
+
+WebSocket support requires the [websockets](https://github.com/aaugustin/websockets)
+package by Aymeric Augustin.
+

docs/sanic/ssl.rst

@@ -0,0 +1,20 @@
+SSL Example
+-----------
+
+Optionally pass in an SSLContext:
+
+.. code:: python
+
+  import ssl
+  context = ssl.create_default_context(purpose=ssl.Purpose.CLIENT_AUTH)
+  context.load_cert_chain("/path/to/cert", keyfile="/path/to/keyfile")
+
+  app.run(host="0.0.0.0", port=8443, ssl=context)
+
+You can also pass in the locations of a certificate and key as a dictionary:
+
+
+.. code:: python
+
+  ssl = {'cert': "/path/to/cert", 'key': "/path/to/keyfile"}
+  app.run(host="0.0.0.0", port=8443, ssl=ssl)

docs/sanic/static_files.md

@@ -0,0 +1,21 @@
+# Static Files
+
+Static files and directories, such as an image file, are served by Sanic when
+registered with the `app.static` method. The method takes an endpoint URL and a
+filename. The file specified will then be accessible via the given endpoint.
+
+```python
+from sanic import Sanic
+app = Sanic(__name__)
+
+# Serves files from the static folder to the URL /static
+app.static('/static', './static')
+
+# 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.run(host="0.0.0.0", port=8000)
+```
+
+Note: currently you cannot build a URL for a static file using `url_for`. 

docs/sanic/streaming.md

@@ -0,0 +1,32 @@
+# Streaming
+
+Sanic allows you to stream content to the client with the `stream` method. This method accepts a coroutine callback which is passed a `StreamingHTTPResponse` object that is written to. A simple example is like follows:
+
+```python
+from sanic import Sanic
+from sanic.response import stream
+
+app = Sanic(__name__)
+
+@app.route("/")
+async def test(request):
+    async def sample_streaming_fn(response):
+        response.write('foo,')
+        response.write('bar')
+
+    return stream(sample_streaming_fn, content_type='text/csv')
+```
+
+This is useful in situations where you want to stream content to the client that originates in an external service, like a database. For example, you can stream database records to the client with the asynchronous cursor that `asyncpg` provides:
+
+```python
+@app.route("/")
+async def index(request):
+    async def stream_from_db(response):
+        conn = await asyncpg.connect(database='test')
+        async with conn.transaction():
+            async for record in conn.cursor('SELECT generate_series(0, 10)'):
+                response.write(record[0])
+
+    return stream(stream_from_db)
+```

docs/sanic/testing.md

@@ -0,0 +1,59 @@
+# Testing
+
+Sanic endpoints can be tested locally using the `test_client` object, which
+depends on the additional [aiohttp](https://aiohttp.readthedocs.io/en/stable/)
+library. 
+
+The `test_client` exposes `get`, `post`, `put`, `delete`, `patch`, `head` and `options` methods
+for you to run against your application. A simple example (using pytest) is like follows:
+
+```python
+# Import the Sanic app, usually created with Sanic(__name__)
+from external_server import app
+
+def test_index_returns_200():
+    request, response = app.test_client.get('/')
+    assert response.status == 200
+
+def test_index_put_not_allowed():
+    request, response = app.test_client.put('/')
+    assert response.status == 405
+```
+
+Internally, each time you call one of the `test_client` methods, the Sanic app is run at `127.0.01:42101` and 
+your test request is executed against your application, using `aiohttp`. 
+
+The `test_client` methods accept the following arguments and keyword arguments:
+
+- `uri` *(default `'/'`)* A string representing the URI to test.
+- `gather_request` *(default `True`)* A boolean which determines whether the
+  original request will be returned by the function. If set to `True`, the
+  return value is a tuple of `(request, response)`, if `False` only the
+  response is returned.
+- `server_kwargs` *(default `{}`) a dict of additional arguments to pass into `app.run` before the test request is run.
+- `debug` *(default `False`)* A boolean which determines whether to run the server in debug mode.
+
+The function further takes the `*request_args` and `**request_kwargs`, which are passed directly to the aiohttp ClientSession request.
+
+For example, to supply data to a GET request, you would do the following:
+
+```python
+def test_get_request_includes_data():
+    params = {'key1': 'value1', 'key2': 'value2'}
+    request, response = app.test_client.get('/', params=params)
+    assert request.args.get('key1') == 'value1'
+```
+
+And to supply data to a JSON POST request:
+
+```python
+def test_post_json_request_includes_data():
+    data = {'key1': 'value1', 'key2': 'value2'}
+    request, response = app.test_client.post('/', data=json.dumps(data))
+    assert request.json.get('key1') == 'value1'
+```
+
+
+More information about
+the available arguments to aiohttp can be found
+[in the documentation for ClientSession](https://aiohttp.readthedocs.io/en/stable/client_reference.html#client-session).

docs/static_files.md

@@ -1,18 +0,0 @@
-# Static Files
-
-Both directories and files can be served by registering with static
-
-## Example
-
-```python
-app = Sanic(__name__)
-
-# Serves files from the static folder to the URL /static
-app.static('/static', './static')
-
-# 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.run(host="0.0.0.0", port=8000)
-```

docs/testing.md

@@ -1,51 +0,0 @@
-# Testing
-
-Sanic endpoints can be tested locally using the `sanic.utils` module, which
-depends on the additional [aiohttp](https://aiohttp.readthedocs.io/en/stable/)
-library. The `sanic_endpoint_test` function runs a local server, issues a
-configurable request to an endpoint, and returns the result. It takes the
-following arguments:
-
-- `app` An instance of a Sanic app.
-- `method` *(default `'get'`)* A string representing the HTTP method to use.
-- `uri` *(default `'/'`)* A string representing the endpoint to test.
-- `gather_request` *(default `True`)* A boolean which determines whether the
-  original request will be returned by the function. If set to `True`, the
-  return value is a tuple of `(request, response)`, if `False` only the
-  response is returned.
-- `loop` *(default `None`)* The event loop to use.
-- `debug` *(default `False`)* A boolean which determines whether to run the
-  server in debug mode.
-
-The function further takes the `*request_args` and `**request_kwargs`, which
-are passed directly to the aiohttp ClientSession request. For example, to
-supply data with a GET request, `method` would be `get` and the keyword
-argument `params={'value', 'key'}` would be supplied. More information about
-the available arguments to aiohttp can be found
-[in the documentation for ClientSession](https://aiohttp.readthedocs.io/en/stable/client_reference.html#client-session).
-
-Below is a complete example of an endpoint test,
-using [pytest](http://doc.pytest.org/en/latest/). The test checks that the
-`/challenge` endpoint responds to a GET request with a supplied challenge
-string.
-
-```python
-import pytest
-import aiohttp
-from sanic.utils import sanic_endpoint_test
-
-# Import the Sanic app, usually created with Sanic(__name__)
-from external_server import app
-
-def test_endpoint_challenge():
-    # Create the challenge data
-    request_data = {'challenge': 'dummy_challenge'}
-
-    # Send the request to the endpoint, using the default `get` method
-    request, response = sanic_endpoint_test(app,
-                                            uri='/challenge',
-                                            params=request_data)
-
-    # Assert that the server responds with the challenge string
-    assert response.text == request_data['challenge']
-```

environment.yml

@@ -0,0 +1,19 @@
+name: py35
+dependencies:
+- openssl=1.0.2g=0
+- pip=8.1.1=py35_0
+- python=3.5.1=0
+- readline=6.2=2
+- setuptools=20.3=py35_0
+- sqlite=3.9.2=0
+- tk=8.5.18=0
+- wheel=0.29.0=py35_0
+- xz=5.0.5=1
+- zlib=1.2.8=0
+- pip:
+  - uvloop>=0.5.3
+  - httptools>=0.0.9
+  - ujson>=1.35
+  - aiofiles>=0.3.0
+  - websockets>=3.2
+  - https://github.com/channelcat/docutils-fork/zipball/master

examples/aiohttp_example.py

@@ -1,33 +1,26 @@
 from sanic import Sanic
-from sanic.response import json
+from sanic import response
 
-import uvloop
 import aiohttp
 
-#Create an event loop manually so that we can use it for both sanic & aiohttp
-loop = uvloop.new_event_loop()
-
 app = Sanic(__name__)
 
 async def fetch(session, url):
     """
     Use session object to perform 'get' request on url
     """
-    async with session.get(url) as response:
-        return await response.json()
+    async with session.get(url) as result:
+        return await result.json()
 
 
-@app.route("/")
-async def test(request):
-    """
-    Download and serve example JSON
-    """
+@app.route('/')
+async def handle_request(request):
     url = "https://api.github.com/repos/channelcat/sanic"
-
-    async with aiohttp.ClientSession(loop=loop) as session:
-        response = await fetch(session, url)
-        return json(response)
+    
+    async with aiohttp.ClientSession() as session:
+        result = await fetch(session, url)
+        return response.json(result)
 
 
-app.run(host="0.0.0.0", port=8000, loop=loop)
-
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000, workers=2)

examples/asyncorm/__main__.py

@@ -0,0 +1,140 @@
+from sanic import Sanic
+from sanic.exceptions import NotFound
+from sanic.response import json
+from sanic.views import HTTPMethodView
+
+from asyncorm import configure_orm
+from asyncorm.exceptions import QuerysetError
+
+from library.models import Book
+from library.serializer import BookSerializer
+
+app = Sanic(name=__name__)
+
+
+@app.listener('before_server_start')
+def orm_configure(sanic, loop):
+    db_config = {'database': 'sanic_example',
+                 'host': 'localhost',
+                 'user': 'sanicdbuser',
+                 'password': 'sanicDbPass',
+                 }
+
+    # configure_orm needs a dictionary with:
+    #    * the database configuration
+    #    * the application/s where the models are defined
+    orm_app = configure_orm({'loop': loop,  # always use the sanic loop!
+                             'db_config': db_config,
+                             'modules': ['library', ],  # list of apps
+                             })
+
+    # orm_app is the object that orchestrates the whole ORM
+    # sync_db should be run only once, better do that as external command
+    # it creates the tables in the database!!!!
+    # orm_app.sync_db()
+
+
+# for all the 404 lets handle the exceptions
+@app.exception(NotFound)
+def ignore_404s(request, exception):
+    return json({'method': request.method,
+                 'status': exception.status_code,
+                 'error': exception.args[0],
+                 'results': None,
+                 })
+
+
+# now the propper sanic workflow
+class BooksView(HTTPMethodView):
+    def arg_parser(self, request):
+        parsed_args = {}
+        for k, v in request.args.items():
+            parsed_args[k] = v[0]
+        return parsed_args
+
+    async def get(self, request):
+        filtered_by = self.arg_parser(request)
+
+        if filtered_by:
+            q_books = await Book.objects.filter(**filtered_by)
+        else:
+            q_books = await Book.objects.all()
+
+        books = [BookSerializer.serialize(book) for book in q_books]
+
+        return json({'method': request.method,
+                     'status': 200,
+                     'results': books or None,
+                     'count': len(books),
+                     })
+
+    async def post(self, request):
+        # populate the book with the data in the request
+        book = Book(**request.json)
+
+        # and await on save
+        await book.save()
+
+        return json({'method': request.method,
+                     'status': 201,
+                     'results': BookSerializer.serialize(book),
+                     })
+
+
+class BookView(HTTPMethodView):
+    async def get_object(self, request, book_id):
+        try:
+            # await on database consults
+            book = await Book.objects.get(**{'id': book_id})
+        except QuerysetError as e:
+            raise NotFound(e.args[0])
+        return book
+
+    async def get(self, request, book_id):
+        # await on database consults
+        book = await self.get_object(request, book_id)
+
+        return json({'method': request.method,
+                     'status': 200,
+                     'results': BookSerializer.serialize(book),
+                     })
+
+    async def put(self, request, book_id):
+        # await on database consults
+        book = await self.get_object(request, book_id)
+        # await on save
+        await book.save(**request.json)
+
+        return json({'method': request.method,
+                     'status': 200,
+                     'results': BookSerializer.serialize(book),
+                     })
+
+    async def patch(self, request, book_id):
+        # await on database consults
+        book = await self.get_object(request, book_id)
+        # await on save
+        await book.save(**request.json)
+
+        return json({'method': request.method,
+                     'status': 200,
+                     'results': BookSerializer.serialize(book),
+                     })
+
+    async def delete(self, request, book_id):
+        # await on database consults
+        book = await self.get_object(request, book_id)
+        # await on its deletion
+        await book.delete()
+
+        return json({'method': request.method,
+                     'status': 200,
+                     'results': None
+                     })
+
+
+app.add_route(BooksView.as_view(), '/books/')
+app.add_route(BookView.as_view(), '/books/<book_id:int>/')
+
+if __name__ == '__main__':
+    app.run()

examples/asyncorm/library/models.py

@@ -0,0 +1,21 @@
+from asyncorm.model import Model
+from asyncorm.fields import CharField, IntegerField, DateField
+
+
+BOOK_CHOICES = (
+    ('hard cover', 'hard cover book'),
+    ('paperback', 'paperback book')
+)
+
+
+# This is a simple model definition
+class Book(Model):
+    name = CharField(max_length=50)
+    synopsis = CharField(max_length=255)
+    book_type = CharField(max_length=15, null=True, choices=BOOK_CHOICES)
+    pages = IntegerField(null=True)
+    date_created = DateField(auto_now=True)
+
+    class Meta():
+        ordering = ['name', ]
+        unique_together = ['name', 'synopsis']

examples/asyncorm/library/serializer.py

@@ -0,0 +1,15 @@
+from asyncorm.model import ModelSerializer, SerializerMethod
+from library.models import Book
+
+
+class BookSerializer(ModelSerializer):
+    book_type = SerializerMethod()
+
+    def get_book_type(self, instance):
+        return instance.book_type_display()
+
+    class Meta():
+        model = Book
+        fields = [
+            'id', 'name', 'synopsis', 'book_type', 'pages', 'date_created'
+        ]

examples/asyncorm/requirements.txt

@@ -0,0 +1,2 @@
+asyncorm==0.0.7
+sanic==0.4.1

examples/blueprints.py

@@ -6,6 +6,7 @@ from sanic.response import json, text
 app = Sanic(__name__)
 blueprint = Blueprint('name', url_prefix='/my_blueprint')
 blueprint2 = Blueprint('name', url_prefix='/my_blueprint2')
+blueprint3 = Blueprint('name', url_prefix='/my_blueprint3')
 
 
 @blueprint.route('/foo')
@@ -17,8 +18,17 @@ async def foo(request):
 async def foo2(request):
     return json({'msg': 'hi from blueprint2'})
 
+@blueprint3.websocket('/foo')
+async def foo3(request, ws):
+    while True:
+        data = 'hello!'
+        print('Sending: ' + data)
+        await ws.send(data)
+        data = await ws.recv()
+        print('Received: ' + data)
 
-app.register_blueprint(blueprint)
-app.register_blueprint(blueprint2)
+app.blueprint(blueprint)
+app.blueprint(blueprint2)
+app.blueprint(blueprint3)
 
 app.run(host="0.0.0.0", port=8000, debug=True)

examples/cache_example.py

@@ -1,6 +1,6 @@
 """
 Example of caching using aiocache package. To run it you will need a Redis
-instance running in localhost:6379.
+instance running in localhost:6379. You can also try with SimpleMemoryCache.
 
 Running this example you will see that the first call lasts 3 seconds and
 the rest are instant because the value is retrieved from the Redis.
@@ -20,9 +20,14 @@ from aiocache.serializers import JsonSerializer
 
 app = Sanic(__name__)
 
-aiocache.settings.set_defaults(
-    cache="aiocache.RedisCache"
-)
+
+@app.listener('before_server_start')
+def init_cache(sanic, loop):
+    aiocache.settings.set_defaults(
+        class_="aiocache.RedisCache",
+        # class_="aiocache.SimpleMemoryCache",
+        loop=loop
+    )
 
 
 @cached(key="my_custom_key", serializer=JsonSerializer())
@@ -38,4 +43,4 @@ async def test(request):
     return json(await expensive_call())
 
 
-app.run(host="0.0.0.0", port=8000, loop=asyncio.get_event_loop())
+app.run(host="0.0.0.0", port=8000)

examples/dask_distributed.py

@@ -0,0 +1,41 @@
+from sanic import Sanic
+from sanic import response
+
+from tornado.platform.asyncio import BaseAsyncIOLoop, to_asyncio_future
+from distributed import LocalCluster, Client
+
+
+app = Sanic(__name__)
+
+
+def square(x):
+    return x**2
+
+
+@app.listener('after_server_start')
+async def setup(app, loop):
+    # configure tornado use asyncio's loop
+    ioloop = BaseAsyncIOLoop(loop)
+
+    # init distributed client
+    app.client = Client('tcp://localhost:8786', loop=ioloop, start=False)
+    await to_asyncio_future(app.client._start())
+
+
+@app.listener('before_server_stop')
+async def stop(app, loop):
+    await to_asyncio_future(app.client._shutdown())
+
+
+@app.route('/<value:int>')
+async def test(request, value):
+    future = app.client.submit(square, value)
+    result = await to_asyncio_future(future._result())
+    return response.text(f'The square of {value} is {result}')
+
+
+if __name__ == '__main__':
+    # Distributed cluster should run somewhere else
+    with LocalCluster(scheduler_port=8786, nanny=False, n_workers=2,
+                      threads_per_worker=1) as cluster:
+        app.run(host="0.0.0.0", port=8000)

examples/detailed_example.py

@@ -0,0 +1,136 @@
+# This demo requires aioredis and environmental variables established in ENV_VARS
+import json
+import logging
+import os
+
+from datetime import datetime
+
+import aioredis
+
+import sanic
+from sanic import Sanic
+
+
+ENV_VARS = ["REDIS_HOST", "REDIS_PORT",
+            "REDIS_MINPOOL", "REDIS_MAXPOOL",
+            "REDIS_PASS", "APP_LOGFILE"]
+
+app = Sanic(name=__name__)
+
+logger = None
+
+
+@app.middleware("request")
+async def log_uri(request):
+    # Simple middleware to log the URI endpoint that was called
+    logger.info("URI called: {0}".format(request.url))
+
+
+@app.listener('before_server_start')
+async def before_server_start(app, loop):
+    logger.info("Starting redis pool")
+    app.redis_pool = await aioredis.create_pool(
+        (app.config.REDIS_HOST, int(app.config.REDIS_PORT)),
+        minsize=int(app.config.REDIS_MINPOOL),
+        maxsize=int(app.config.REDIS_MAXPOOL),
+        password=app.config.REDIS_PASS)
+
+
+@app.listener('after_server_stop')
+async def after_server_stop(app, loop):
+    logger.info("Closing redis pool")
+    app.redis_pool.close()
+    await app.redis_pool.wait_closed()
+
+
+@app.middleware("request")
+async def attach_db_connectors(request):
+    # Just put the db objects in the request for easier access
+    logger.info("Passing redis pool to request object")
+    request["redis"] = request.app.redis_pool
+
+
+@app.route("/state/<user_id>", methods=["GET"])
+async def access_state(request, user_id):
+    try:
+        # Check to see if the value is in cache, if so lets return that
+        with await request["redis"] as redis_conn:
+            state = await redis_conn.get(user_id, encoding="utf-8")
+            if state:
+                return sanic.response.json({"msg": "Success",
+                                            "status": 200,
+                                            "success": True,
+                                            "data": json.loads(state),
+                                            "finished_at": datetime.now().isoformat()})
+        # Then state object is not in redis
+        logger.critical("Unable to find user_data in cache.")
+        return sanic.response.HTTPResponse({"msg": "User state not found",
+                                            "success": False,
+                                            "status": 404,
+                                            "finished_at": datetime.now().isoformat()}, status=404)
+    except aioredis.ProtocolError:
+        logger.critical("Unable to connect to state cache")
+        return sanic.response.HTTPResponse({"msg": "Internal Server Error",
+                                            "status": 500,
+                                            "success": False,
+                                            "finished_at": datetime.now().isoformat()}, status=500)
+
+
+@app.route("/state/<user_id>/push", methods=["POST"])
+async def set_state(request, user_id):
+    try:
+        # Pull a connection from the pool
+        with await request["redis"] as redis_conn:
+            # Set the value in cache to your new value
+            await redis_conn.set(user_id, json.dumps(request.json), expire=1800)
+            logger.info("Successfully pushed state to cache")
+            return sanic.response.HTTPResponse({"msg": "Successfully pushed state to cache",
+                                                "success": True,
+                                                "status": 200,
+                                                "finished_at": datetime.now().isoformat()})
+    except aioredis.ProtocolError:
+        logger.critical("Unable to connect to state cache")
+        return sanic.response.HTTPResponse({"msg": "Internal Server Error",
+                                            "status": 500,
+                                            "success": False,
+                                            "finished_at": datetime.now().isoformat()}, status=500)
+
+
+def configure():
+    # Setup environment variables
+    env_vars = [os.environ.get(v, None) for v in ENV_VARS]
+    if not all(env_vars):
+        # Send back environment variables that were not set
+        return False, ", ".join([ENV_VARS[i] for i, flag in env_vars if not flag])
+    else:
+        # Add all the env vars to our app config
+        app.config.update({k: v for k, v in zip(ENV_VARS, env_vars)})
+        setup_logging()
+    return True, None
+
+
+def setup_logging():
+    logging_format = "[%(asctime)s] %(process)d-%(levelname)s "
+    logging_format += "%(module)s::%(funcName)s():l%(lineno)d: "
+    logging_format += "%(message)s"
+
+    logging.basicConfig(
+        filename=app.config.APP_LOGFILE,
+        format=logging_format,
+        level=logging.DEBUG)
+
+
+def main(result, missing):
+    if result:
+        try:
+            app.run(host="0.0.0.0", port=8080, debug=True)
+        except:
+            logging.critical("User killed server. Closing")
+    else:
+        logging.critical("Unable to start. Missing environment variables [{0}]".format(missing))
+
+
+if __name__ == "__main__":
+    result, missing = configure()
+    logger = logging.getLogger()
+    main(result, missing)

examples/exception_monitoring.py

@@ -1,39 +1,34 @@
 """
 Example intercepting uncaught exceptions using Sanic's error handler framework.
-
 This may be useful for developers wishing to use Sentry, Airbrake, etc.
 or a custom system to log and monitor unexpected errors in production.
-
 First we create our own class inheriting from Handler in sanic.exceptions,
 and pass in an instance of it when we create our Sanic instance. Inside this
 class' default handler, we can do anything including sending exceptions to
 an external service.
 """
-
-
-
+from sanic.handlers import ErrorHandler
+from sanic.exceptions import SanicException
 """
 Imports and code relevant for our CustomHandler class
 (Ordinarily this would be in a separate file)
 """
-from sanic.response import text
-from sanic.exceptions import Handler, SanicException
 
-class CustomHandler(Handler):
+
+class CustomHandler(ErrorHandler):
+
     def default(self, request, exception):
         # Here, we have access to the exception object
         # and can do anything with it (log, send to external service, etc)
 
         # Some exceptions are trivial and built into Sanic (404s, etc)
-        if not issubclass(type(exception), SanicException):
+        if not isinstance(exception, SanicException):
             print(exception)
 
         # Then, we must finish handling the exception by returning
         # our response to the client
         # For this we can just call the super class' default handler
-        return super.default(self, request, exception)
-
-
+        return super().default(request, exception)
 
 
 """
@@ -42,19 +37,20 @@ server's error_handler to an instance of our CustomHandler
 """
 
 from sanic import Sanic
-from sanic.response import json
+from sanic import response
 
 app = Sanic(__name__)
 
-handler = CustomHandler(sanic=app)
+handler = CustomHandler()
 app.error_handler = handler
 
+
 @app.route("/")
 async def test(request):
     # Here, something occurs which causes an unexpected exception
     # This exception will flow to our custom handler.
-    x = 1 / 0
-    return json({"test": True})
+    1 / 0
+    return response.json({"test": True})
 
 
-app.run(host="0.0.0.0", port=8000, debug=True)
+app.run(host="0.0.0.0", port=8000, debug=True)

examples/jinja_example.py

@@ -1,18 +0,0 @@
-## To use this example:
-# curl -d '{"name": "John Doe"}' localhost:8000
-
-from sanic import Sanic
-from sanic.response import html
-from jinja2 import Template
-
-template = Template('Hello {{ name }}!')
-
-app = Sanic(__name__)
-
-@app.route('/')
-async def test(request):
-    data = request.json
-    return html(template.render(**data))
-
-
-app.run(host="0.0.0.0", port=8000)

examples/jinja_example/jinja_example.py

@@ -0,0 +1,28 @@
+# Render templates in a Flask like way from a "template" directory in
+# the project
+
+from sanic import Sanic
+from sanic import response
+from jinja2 import Environment, PackageLoader, select_autoescape
+
+app = Sanic(__name__)
+
+# Load the template environment with async support
+template_env = Environment(
+    loader=PackageLoader('jinja_example', 'templates'),
+    autoescape=select_autoescape(['html', 'xml']),
+    enable_async=True
+)
+
+# Load the template from file
+template = template_env.get_template("example_template.html")
+
+
+@app.route('/')
+async def test(request):
+    rendered_template = await template.render_async(
+        knights='that say nih; asynchronously')
+    return response.html(rendered_template)
+
+
+app.run(host="0.0.0.0", port=8080, debug=True)

examples/jinja_example/requirements.txt

@@ -0,0 +1,8 @@
+aiofiles==0.3.1
+httptools==0.0.9
+Jinja2==2.9.6
+MarkupSafe==1.0
+sanic==0.5.2
+ujson==1.35
+uvloop==0.8.0
+websockets==3.3

examples/jinja_example/templates/example_template.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>My Webpage</title>
+</head>
+<body>
+    <h1>Hello World</h1>
+    <p>knights - {{ knights }}</p>
+</body>
+</html>

examples/limit_concurrency.py

@@ -0,0 +1,37 @@
+from sanic import Sanic
+from sanic.response import json
+
+import asyncio
+import aiohttp
+
+app = Sanic(__name__)
+
+sem = None
+
+@app.listener('before_server_start')
+def init(sanic, loop):
+    global sem
+    CONCURRENCY_PER_WORKER = 4
+    sem = asyncio.Semaphore(CONCURRENCY_PER_WORKER, loop=loop)
+
+async def bounded_fetch(session, url):
+    """
+    Use session object to perform 'get' request on url
+    """
+    async with sem, session.get(url) as response:
+        return await response.json()
+
+
+@app.route("/")
+async def test(request):
+    """
+    Download and serve example JSON
+    """
+    url = "https://api.github.com/repos/channelcat/sanic"
+
+    async with aiohttp.ClientSession() as session:
+        response = await bounded_fetch(session, url)
+        return json(response)
+
+
+app.run(host="0.0.0.0", port=8000, workers=2)

examples/modify_header_example.py

@@ -0,0 +1,26 @@
+"""
+Modify header or status in response
+"""
+
+from sanic import Sanic
+from sanic import response
+
+app = Sanic(__name__)
+
+@app.route('/')
+def handle_request(request):
+    return response.json(
+        {'message': 'Hello world!'},
+        headers={'X-Served-By': 'sanic'},
+        status=200
+    )
+    
+@app.route('/unauthorized')
+def handle_request(request):
+    return response.json(
+        {'message': 'You are not authorized'},
+        headers={'X-Served-By': 'sanic'},
+        status=404
+    )
+
+app.run(host="0.0.0.0", port=8000, debug=True)

examples/override_logging.py

@@ -0,0 +1,22 @@
+from sanic import Sanic
+from sanic import response
+import logging
+
+logging_format = "[%(asctime)s] %(process)d-%(levelname)s "
+logging_format += "%(module)s::%(funcName)s():l%(lineno)d: "
+logging_format += "%(message)s"
+
+logging.basicConfig(
+    format=logging_format,
+    level=logging.DEBUG
+)
+log = logging.getLogger()
+
+# Set logger to override default basicConfig
+sanic = Sanic()
+@sanic.route("/")
+def test(request):
+    log.info("received request; responding with 'hey'")
+    return response.text("hey")
+
+sanic.run(host="0.0.0.0", port=8000)

examples/plotly_example/plotlyjs_example.py

@@ -0,0 +1,85 @@
+from sanic import Sanic
+
+from sanic_session import InMemorySessionInterface
+from sanic_jinja2 import SanicJinja2
+
+import json
+import plotly
+
+import pandas as pd
+import numpy as np
+
+app = Sanic(__name__)
+
+jinja = SanicJinja2(app)
+session = InMemorySessionInterface(cookie_name=app.name, prefix=app.name)
+
+@app.middleware('request')
+async def print_on_request(request):
+	print(request.headers)
+	await session.open(request)
+
+@app.middleware('response')
+async def print_on_response(request, response):
+	await session.save(request, response)
+
+
+
+@app.route('/')
+async def index(request):
+    rng = pd.date_range('1/1/2011', periods=7500, freq='H')
+    ts = pd.Series(np.random.randn(len(rng)), index=rng)
+
+    graphs = [
+        dict(
+            data=[
+                dict(
+                    x=[1, 2, 3],
+                    y=[10, 20, 30],
+                    type='scatter'
+                ),
+            ],
+            layout=dict(
+                title='first graph'
+            )
+        ),
+
+        dict(
+            data=[
+                dict(
+                    x=[1, 3, 5],
+                    y=[10, 50, 30],
+                    type='bar'
+                ),
+            ],
+            layout=dict(
+                title='second graph'
+            )
+        ),
+
+        dict(
+            data=[
+                dict(
+                    x=ts.index,  # Can use the pandas data structures directly
+                    y=ts
+                )
+            ]
+        )
+    ]
+
+    # Add "ids" to each of the graphs to pass up to the client
+    # for templating
+    ids = ['graph-{}'.format(i) for i, _ in enumerate(graphs)]
+
+    # Convert the figures to JSON
+    # PlotlyJSONEncoder appropriately converts pandas, datetime, etc
+    # objects to their JSON equivalents
+    graphJSON = json.dumps(graphs, cls=plotly.utils.PlotlyJSONEncoder)
+
+    return jinja.render('index.html', request,
+                           ids=ids,
+                           graphJSON=graphJSON)
+
+
+if __name__ == '__main__':
+    app.run(host='0.0.0.0', port=8000, debug=True)

examples/plotly_example/requirements.txt

@@ -0,0 +1,5 @@
+pandas==0.19.2
+plotly==2.0.7
+sanic==0.5.0
+sanic-jinja2==0.5.1
+sanic-session==0.1.3

examples/redirect_example.py

@@ -0,0 +1,17 @@
+from sanic import Sanic
+from sanic import response
+
+app = Sanic(__name__)
+
+    
+@app.route('/')
+def handle_request(request):
+    return response.redirect('/redirect')
+    
+@app.route('/redirect')
+async def test(request):
+    return response.json({"Redirected": True})
+
+
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000)

examples/request_timeout.py

@@ -1,6 +1,6 @@
-from sanic import Sanic
 import asyncio
-from sanic.response import text
+from sanic import Sanic
+from sanic import response
 from sanic.config import Config
 from sanic.exceptions import RequestTimeout
 
@@ -11,11 +11,11 @@ app = Sanic(__name__)
 @app.route('/')
 async def test(request):
     await asyncio.sleep(3)
-    return text('Hello, world!')
+    return response.text('Hello, world!')
 
 
 @app.exception(RequestTimeout)
 def timeout(request, exception):
-    return text('RequestTimeout from error_handler.', 408)
+    return response.text('RequestTimeout from error_handler.', 408)
 
-app.run(host='0.0.0.0', port=8000)
+app.run(host='0.0.0.0', port=8000)

examples/run_async.py

@@ -0,0 +1,22 @@
+from sanic import Sanic
+from sanic import response
+from multiprocessing import Event
+from signal import signal, SIGINT
+import asyncio
+import uvloop
+
+app = Sanic(__name__)
+
+@app.route("/")
+async def test(request):
+    return response.json({"answer": "42"})
+
+asyncio.set_event_loop(uvloop.new_event_loop())
+server = app.create_server(host="0.0.0.0", port=8000)
+loop = asyncio.get_event_loop()
+task = asyncio.ensure_future(server)
+signal(SIGINT, lambda s, f: loop.stop())
+try:
+    loop.run_forever()
+except:
+    loop.stop()

examples/sanic_aiomysql_with_global_pool.py

@@ -0,0 +1,62 @@
+# encoding: utf-8
+"""
+You need the aiomysql
+"""
+import os
+
+import aiomysql
+
+from sanic import Sanic
+from sanic.response import json
+
+database_name = os.environ['DATABASE_NAME']
+database_host = os.environ['DATABASE_HOST']
+database_user = os.environ['DATABASE_USER']
+database_password = os.environ['DATABASE_PASSWORD']
+app = Sanic()
+
+
+@app.listener("before_server_start")
+async def get_pool(app, loop):
+    """
+    the first param  is the global instance ,
+    so we can store our connection pool in it .
+    and it can be used by different request
+    :param args:
+    :param kwargs:
+    :return:
+    """
+    app.pool = {
+        "aiomysql": await aiomysql.create_pool(host=database_host, user=database_user, password=database_password,
+                                               db=database_name,
+                                               maxsize=5)}
+    async with app.pool['aiomysql'].acquire() as conn:
+        async with conn.cursor() as cur:
+            await cur.execute('DROP TABLE IF EXISTS sanic_polls')
+            await cur.execute("""CREATE TABLE sanic_polls (
+                                    id serial primary key,
+                                    question varchar(50),
+                                    pub_date timestamp
+                                );""")
+            for i in range(0, 100):
+                await cur.execute("""INSERT INTO sanic_polls
+                                (id, question, pub_date) VALUES ({}, {}, now())
+                """.format(i, i))
+
+
+@app.route("/")
+async def test():
+    result = []
+    data = {}
+    async with app.pool['aiomysql'].acquire() as conn:
+        async with conn.cursor() as cur:
+            await cur.execute("SELECT question, pub_date FROM sanic_polls")
+            async for row in cur:
+                result.append({"question": row[0], "pub_date": row[1]})
+    if result or len(result) > 0:
+        data['data'] = res
+    return json(data)
+
+
+if __name__ == '__main__':
+    app.run(host="127.0.0.1", workers=4, port=12000)

examples/sanic_aiopeewee.py

@@ -0,0 +1,61 @@
+from sanic import Sanic
+from sanic.response import json
+
+from aiopeewee import AioModel, AioMySQLDatabase, model_to_dict
+from peewee import CharField, TextField, DateTimeField
+from peewee import ForeignKeyField, PrimaryKeyField
+
+
+db = AioMySQLDatabase('test', user='root', password='',
+                      host='127.0.0.1', port=3306)
+
+
+class User(AioModel):
+    username = CharField()
+
+    class Meta:
+        database = db
+
+
+class Blog(AioModel):
+    user = ForeignKeyField(User)
+    title = CharField(max_length=25)
+    content = TextField(default='')
+    pub_date = DateTimeField(null=True)
+    pk = PrimaryKeyField()
+
+    class Meta:
+        database = db
+
+
+app = Sanic(__name__)
+
+
+@app.listener('before_server_start')
+async def setup(app, loop):
+    # create connection pool
+    await db.connect(loop)
+    # create table if not exists
+    await db.create_tables([User, Blog], safe=True)
+
+
+@app.listener('before_server_stop')
+async def stop(app, loop):
+    # close connection pool
+    await db.close()
+
+
+@app.post('/users')
+async def add_user(request):
+    user = await User.create(**request.json)
+    return json(await model_to_dict(user))
+
+
+@app.get('/users/count')
+async def user_count(request):
+    count = await User.select().count()
+    return json({'count': count})
+
+
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000)

examples/sanic_aiopg_example.py

@@ -10,8 +10,6 @@ import aiopg
 from sanic import Sanic
 from sanic.response import json
 
-asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
-
 database_name = os.environ['DATABASE_NAME']
 database_host = os.environ['DATABASE_HOST']
 database_user = os.environ['DATABASE_USER']
@@ -21,45 +19,47 @@ connection = 'postgres://{0}:{1}@{2}/{3}'.format(database_user,
                                                  database_password,
                                                  database_host,
                                                  database_name)
-loop = asyncio.get_event_loop()
 
 
 async def get_pool():
     return await aiopg.create_pool(connection)
 
 app = Sanic(name=__name__)
-pool = loop.run_until_complete(get_pool())
-
-
-async def prepare_db():
-    """ Let's create some table and add some data
 
+@app.listener('before_server_start')
+async def prepare_db(app, loop):
     """
-    async with pool.acquire() as conn:
-        async with conn.cursor() as cur:
-            await cur.execute('DROP TABLE IF EXISTS sanic_polls')
-            await cur.execute("""CREATE TABLE sanic_polls (
-                                    id serial primary key,
-                                    question varchar(50),
-                                    pub_date timestamp
-                                );""")
-            for i in range(0, 100):
-                await cur.execute("""INSERT INTO sanic_polls
-                                (id, question, pub_date) VALUES ({}, {}, now())
-                """.format(i, i))
+    Let's create some table and add some data
+    """
+    async with aiopg.create_pool(connection) as pool:
+        async with pool.acquire() as conn:
+            async with conn.cursor() as cur:
+                await cur.execute('DROP TABLE IF EXISTS sanic_polls')
+                await cur.execute("""CREATE TABLE sanic_polls (
+                                        id serial primary key,
+                                        question varchar(50),
+                                        pub_date timestamp
+                                    );""")
+                for i in range(0, 100):
+                    await cur.execute("""INSERT INTO sanic_polls
+                                    (id, question, pub_date) VALUES ({}, {}, now())
+                    """.format(i, i))
 
 
 @app.route("/")
 async def handle(request):
-    async with pool.acquire() as conn:
-        async with conn.cursor() as cur:
-            result = []
-            await cur.execute("SELECT question, pub_date FROM sanic_polls")
-            async for row in cur:
-                result.append({"question": row[0], "pub_date": row[1]})
-            return json({"polls": result})
-
+    result = []
+    async def test_select():
+        async with aiopg.create_pool(connection) as pool:
+            async with pool.acquire() as conn:
+                async with conn.cursor() as cur:
+                    await cur.execute("SELECT question, pub_date FROM sanic_polls")
+                    async for row in cur:
+                        result.append({"question": row[0], "pub_date": row[1]})
+    res = await test_select()
+    return json({'polls': result})
 
 if __name__ == '__main__':
-    loop.run_until_complete(prepare_db())
-    app.run(host='0.0.0.0', port=8000, loop=loop)
+    app.run(host='0.0.0.0',
+            port=8000,
+            debug=True)

examples/sanic_aiopg_sqlalchemy_example.py

@@ -12,8 +12,6 @@ import sqlalchemy as sa
 from sanic import Sanic
 from sanic.response import json
 
-asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
-
 database_name = os.environ['DATABASE_NAME']
 database_host = os.environ['DATABASE_HOST']
 database_user = os.environ['DATABASE_USER']
@@ -23,8 +21,6 @@ connection = 'postgres://{0}:{1}@{2}/{3}'.format(database_user,
                                                  database_password,
                                                  database_host,
                                                  database_name)
-loop = asyncio.get_event_loop()
-
 
 metadata = sa.MetaData()
 
@@ -34,40 +30,38 @@ polls = sa.Table('sanic_polls', metadata,
                  sa.Column("pub_date", sa.DateTime))
 
 
-async def get_engine():
-    return await create_engine(connection)
-
 app = Sanic(name=__name__)
-engine = loop.run_until_complete(get_engine())
 
-
-async def prepare_db():
+@app.listener('before_server_start')
+async def prepare_db(app, loop):
     """ Let's add some data
 
     """
-    async with engine.acquire() as conn:
-        await conn.execute('DROP TABLE IF EXISTS sanic_polls')
-        await conn.execute("""CREATE TABLE sanic_polls (
-                                    id serial primary key,
-                                    question varchar(50),
-                                    pub_date timestamp
-                                );""")
-        for i in range(0, 100):
-            await conn.execute(
-                polls.insert().values(question=i,
-                                      pub_date=datetime.datetime.now())
-                )
+    async with create_engine(connection) as engine:
+        async with engine.acquire() as conn:
+            await conn.execute('DROP TABLE IF EXISTS sanic_polls')
+            await conn.execute("""CREATE TABLE sanic_polls (
+                                        id serial primary key,
+                                        question varchar(50),
+                                        pub_date timestamp
+                                    );""")
+            for i in range(0, 100):
+                await conn.execute(
+                    polls.insert().values(question=i,
+                                          pub_date=datetime.datetime.now())
+                    )
 
 
 @app.route("/")
 async def handle(request):
-    async with engine.acquire() as conn:
-        result = []
-        async for row in conn.execute(polls.select()):
-            result.append({"question": row.question, "pub_date": row.pub_date})
-        return json({"polls": result})
+    async with create_engine(connection) as engine:
+        async with engine.acquire() as conn:
+            result = []
+            async for row in conn.execute(polls.select()):
+                result.append({"question": row.question,
+                               "pub_date": row.pub_date})
+            return json({"polls": result})
 
 
 if __name__ == '__main__':
-    loop.run_until_complete(prepare_db())
-    app.run(host='0.0.0.0', port=8000, loop=loop)
+    app.run(host='0.0.0.0', port=8000)

examples/sanic_aioredis_example.py

@@ -0,0 +1,34 @@
+""" To run this example you need additional aioredis package
+"""
+from sanic import Sanic, response
+import aioredis
+
+app = Sanic(__name__)
+
+
+@app.route("/")
+async def handle(request):
+    async with request.app.redis_pool.get() as redis:
+        await redis.set('test-my-key', 'value')
+        val = await redis.get('test-my-key')
+    return response.text(val.decode('utf-8'))
+
+
+@app.listener('before_server_start')
+async def before_server_start(app, loop):
+    app.redis_pool = await aioredis.create_pool(
+        ('localhost', 6379),
+        minsize=5,
+        maxsize=10,
+        loop=loop
+    )
+
+
+@app.listener('after_server_stop')
+async def after_server_stop(app, loop):
+    app.redis_pool.close()
+    await app.redis_pool.wait_closed()
+
+
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000)

examples/sanic_asyncpg_example.py

@@ -0,0 +1,51 @@
+import os
+import asyncio
+
+import uvloop
+from asyncpg import connect, create_pool
+
+from sanic import Sanic
+from sanic.response import json
+
+DB_CONFIG = {
+    'host': '<host>',
+    'user': '<user>',
+    'password': '<password>',
+    'port': '<port>',
+    'database': '<database>'
+}
+
+
+def jsonify(records):
+    """
+    Parse asyncpg record response into JSON format
+    """
+    return [dict(r.items()) for r in records]
+
+
+app = Sanic(__name__)
+
+
+@app.listener('before_server_start')
+async def register_db(app, loop):
+    app.pool = await create_pool(**DB_CONFIG, loop=loop, max_size=100)
+    async with app.pool.acquire() as connection:
+        await connection.execute('DROP TABLE IF EXISTS sanic_post')
+        await connection.execute("""CREATE TABLE sanic_post (
+                                id serial primary key,
+                                content varchar(50),
+                                post_date timestamp
+                            );""")
+        for i in range(0, 1000):
+            await connection.execute(f"""INSERT INTO sanic_post
+                (id, content, post_date) VALUES ({i}, {i}, now())""")
+
+
+@app.get('/')
+async def root_get(request):
+    async with app.pool.acquire() as connection:
+        results = await connection.fetch('SELECT * FROM sanic_post')
+        return json({'posts': jsonify(results)})
+
+if __name__ == '__main__':
+    app.run(host='127.0.0.1', port=8080)

examples/sanic_motor.py

@@ -0,0 +1,41 @@
+""" sanic motor (async driver for mongodb) example
+Required packages:
+pymongo==3.4.0
+motor==1.1
+sanic==0.2.0
+"""
+from sanic import Sanic
+from sanic import response
+
+
+app = Sanic('motor_mongodb')
+
+
+def get_db():
+    from motor.motor_asyncio import AsyncIOMotorClient
+    mongo_uri = "mongodb://127.0.0.1:27017/test"
+    client = AsyncIOMotorClient(mongo_uri)
+    return client['test']
+
+
+@app.route('/objects', methods=['GET'])
+async def get(request):
+    db = get_db()
+    docs = await db.test_col.find().to_list(length=100)
+    for doc in docs:
+        doc['id'] = str(doc['_id'])
+        del doc['_id']
+    return response.json(docs)
+
+
+@app.route('/post', methods=['POST'])
+async def new(request):
+    doc = request.json
+    print(doc)
+    db = get_db()
+    object_id = await db.test_col.save(doc)
+    return response.json({'object_id': str(object_id)})
+
+
+if __name__ == "__main__":
+    app.run(host='0.0.0.0', port=8000, debug=True)

examples/sanic_peewee.py

@@ -1,3 +1,4 @@
+
 ## You need the following additional packages for this example
 # aiopg
 # peewee_async
@@ -9,52 +10,88 @@ from sanic import Sanic
 from sanic.response import json
 
 ## peewee_async related imports
-import uvloop
 import peewee
-from peewee_async import Manager, PostgresqlDatabase
-
+from peewee import Model, BaseModel
+from peewee_async import Manager, PostgresqlDatabase, execute
+from functools import partial
  # we instantiate a custom loop so we can pass it to our db manager
-loop = uvloop.new_event_loop()
-
-database = PostgresqlDatabase(database='test',
-                              host='127.0.0.1',
-                              user='postgres',
-                              password='mysecretpassword')
-
-objects = Manager(database, loop=loop)
 
 ## from peewee_async docs:
 # Also there’s no need to connect and re-connect before executing async queries
 # with manager! It’s all automatic. But you can run Manager.connect() or
 # Manager.close() when you need it.
 
+class AsyncManager(Manager):
+    """Inherit the peewee_async manager with our own object
+       configuration
+
+       database.allow_sync = False
+    """
+
+    def __init__(self, _model_class, *args, **kwargs):
+        super(AsyncManager, self).__init__(*args, **kwargs)
+        self._model_class = _model_class
+        self.database.allow_sync = False
+
+    def _do_fill(self, method, *args, **kwargs):
+        _class_method = getattr(super(AsyncManager, self), method)
+        pf = partial(_class_method, self._model_class)
+        return pf(*args, **kwargs)
+
+    def new(self, *args, **kwargs):
+        return self._do_fill('create', *args, **kwargs)
+
+    def get(self, *args, **kwargs):
+        return self._do_fill('get', *args, **kwargs)
+
+    def execute(self, query):
+        return execute(query)
+
+
+def _get_meta_db_class(db):
+    """creating a declartive class model for db"""
+    class _BlockedMeta(BaseModel):
+        def __new__(cls, name, bases, attrs):
+            _instance = super(_BlockedMeta, cls).__new__(cls, name, bases, attrs)
+            _instance.objects = AsyncManager(_instance, db)
+            return _instance
+
+    class _Base(Model, metaclass=_BlockedMeta):
+
+        def to_dict(self):
+            return self._data
+
+        class Meta:
+            database=db
+    return _Base
+
+
+def declarative_base(*args, **kwargs):
+    """Returns a new Modeled Class after inheriting meta and Model classes"""
+    db = PostgresqlDatabase(*args, **kwargs)
+    return _get_meta_db_class(db)
+
+
+AsyncBaseModel = declarative_base(database='test',
+                                  host='127.0.0.1',
+                                  user='postgres',
+                                  password='mysecretpassword')
 
 # let's create a simple key value store:
-class KeyValue(peewee.Model):
+class KeyValue(AsyncBaseModel):
     key = peewee.CharField(max_length=40, unique=True)
     text = peewee.TextField(default='')
 
-    class Meta:
-        database = database
-
-# create table synchronously
-KeyValue.create_table(True)
-
-# OPTIONAL: close synchronous connection
-database.close()
-
-# OPTIONAL: disable any future syncronous calls
-objects.database.allow_sync = False # this will raise AssertionError on ANY sync call
-
 
 app = Sanic('peewee_example')
 
+
 @app.route('/post/<key>/<value>')
 async def post(request, key, value):
     """
     Save get parameters to database
     """
-    obj = await objects.create(KeyValue, key=key, text=value)
+    obj = await KeyValue.objects.new(key=key, text=value)
     return json({'object_id': obj.id})
 
 
@@ -63,7 +100,7 @@ async def get(request):
     """
     Load all objects from database
     """
-    all_objects = await objects.execute(KeyValue.select())
+    all_objects = await KeyValue.objects.execute(KeyValue.select())
     serialized_obj = []
     for obj in all_objects:
         serialized_obj.append({
@@ -76,5 +113,4 @@ async def get(request):
 
 
 if __name__ == "__main__":
-    app.run(host='0.0.0.0', port=8000, loop=loop)
-
+    app.run(host='0.0.0.0', port=8000)

examples/simple_server.py

@@ -1,12 +1,13 @@
 from sanic import Sanic
-from sanic.response import json
+from sanic import response
 
 app = Sanic(__name__)
 
 
 @app.route("/")
 async def test(request):
-    return json({"test": True})
+    return response.json({"test": True})
 
 
-app.run(host="0.0.0.0", port=8000)
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000)

examples/try_everything.py

@@ -1,6 +1,8 @@
+import os
+
 from sanic import Sanic
 from sanic.log import log
-from sanic.response import json, text
+from sanic import response
 from sanic.exceptions import ServerError
 
 app = Sanic(__name__)
@@ -8,17 +10,17 @@ app = Sanic(__name__)
 
 @app.route("/")
 async def test_async(request):
-    return json({"test": True})
+    return response.json({"test": True})
 
 
 @app.route("/sync", methods=['GET', 'POST'])
 def test_sync(request):
-    return json({"test": True})
+    return response.json({"test": True})
 
 
 @app.route("/dynamic/<name>/<id:int>")
 def test_params(request, name, id):
-    return text("yeehaww {} {}".format(name, id))
+    return response.text("yeehaww {} {}".format(name, id))
 
 
 @app.route("/exception")
@@ -29,7 +31,11 @@ def exception(request):
 async def test_await(request):
     import asyncio
     await asyncio.sleep(5)
-    return text("I'm feeling sleepy")
+    return response.text("I'm feeling sleepy")
+
+@app.route("/file")
+async def test_file(request):
+    return await response.file(os.path.abspath("setup.py"))
 
 
 # ----------------------------------------------- #
@@ -38,7 +44,7 @@ async def test_await(request):
 
 @app.exception(ServerError)
 async def test(request, exception):
-    return json({"exception": "{}".format(exception), "status": exception.status_code}, status=exception.status_code)
+    return response.json({"exception": "{}".format(exception), "status": exception.status_code}, status=exception.status_code)
 
 
 # ----------------------------------------------- #
@@ -47,29 +53,42 @@ async def test(request, exception):
 
 @app.route("/json")
 def post_json(request):
-    return json({"received": True, "message": request.json})
+    return response.json({"received": True, "message": request.json})
 
 
 @app.route("/form")
 def post_json(request):
-    return json({"received": True, "form_data": request.form, "test": request.form.get('test')})
+    return response.json({"received": True, "form_data": request.form, "test": request.form.get('test')})
 
 
 @app.route("/query_string")
 def query_string(request):
-    return json({"parsed": True, "args": request.args, "url": request.url, "query_string": request.query_string})
+    return response.json({"parsed": True, "args": request.args, "url": request.url, "query_string": request.query_string})
 
 
 # ----------------------------------------------- #
 # Run Server
 # ----------------------------------------------- #
 
-def after_start(loop):
+@app.listener('before_server_start')
+def before_start(app, loop):
+    log.info("SERVER STARTING")
+
+
+@app.listener('after_server_start')
+def after_start(app, loop):
     log.info("OH OH OH OH OHHHHHHHH")
 
 
-def before_stop(loop):
+@app.listener('before_server_stop')
+def before_stop(app, loop):
+    log.info("SERVER STOPPING")
+
+
+@app.listener('after_server_stop')
+def after_stop(app, loop):
     log.info("TRIED EVERYTHING")
 
 
-app.run(host="0.0.0.0", port=8000, debug=True, after_start=after_start, before_stop=before_stop)
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000, debug=True)

examples/url_for_example.py

@@ -0,0 +1,18 @@
+from sanic import Sanic
+from sanic import response
+
+app = Sanic(__name__)
+
+@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 response.redirect(url)
+
+@app.route('/posts/<post_id>')
+async def post_handler(request, post_id):
+    return response.text('Post - {}'.format(post_id))
+    
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000, debug=True)

examples/vhosts.py

@@ -0,0 +1,39 @@
+from sanic import response
+from sanic import Sanic
+from sanic.blueprints import Blueprint
+
+# Usage
+# curl -H "Host: example.com" localhost:8000
+# curl -H "Host: sub.example.com" localhost:8000
+# curl -H "Host: bp.example.com" localhost:8000/question
+# curl -H "Host: bp.example.com" localhost:8000/answer
+
+app = Sanic()
+bp = Blueprint("bp", host="bp.example.com")
+
+@app.route('/', host=["example.com",
+                      "somethingelse.com",
+                      "therestofyourdomains.com"])
+async def hello(request):
+    return response.text("Some defaults")
+
+@app.route('/', host="example.com")
+async def hello(request):
+    return response.text("Answer")
+
+@app.route('/', host="sub.example.com")
+async def hello(request):
+    return response.text("42")
+
+@bp.route("/question")
+async def hello(request):
+    return response.text("What is the meaning of life?")
+
+@bp.route("/answer")
+async def hello(request):
+    return response.text("42")
+
+app.register_blueprint(bp)
+
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000)

examples/websocket.html

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>WebSocket demo</title>
+    </head>
+    <body>
+        <script>
+            var ws = new WebSocket('ws://' + document.domain + ':' + location.port + '/feed'),
+                messages = document.createElement('ul');
+            ws.onmessage = function (event) {
+                var messages = document.getElementsByTagName('ul')[0],
+                    message = document.createElement('li'),
+                    content = document.createTextNode('Received: ' + event.data);
+                message.appendChild(content);
+                messages.appendChild(message);
+            };
+            document.body.appendChild(messages);
+            window.setInterval(function() {
+                data = 'bye!'
+                ws.send(data);
+                var messages = document.getElementsByTagName('ul')[0],
+                    message = document.createElement('li'),
+                    content = document.createTextNode('Sent: ' + data);
+                message.appendChild(content);
+                messages.appendChild(message);
+            }, 1000);
+        </script>
+    </body>
+</html>

examples/websocket.py

@@ -0,0 +1,23 @@
+from sanic import Sanic
+from sanic.response import file
+
+app = Sanic(__name__)
+
+
+@app.route('/')
+async def index(request):
+    return await file('websocket.html')
+
+
+@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()

readthedocs.yml

@@ -0,0 +1,2 @@
+conda:
+    file: environment.yml

requirements-dev.txt

@@ -1,14 +1,11 @@
+aiofiles
+aiohttp==1.3.5
+chardet<=2.3.0
+beautifulsoup4
+coverage
 httptools
+flake8
+pytest
+tox
 ujson
 uvloop
-aiohttp
-aiocache
-pytest
-coverage
-tox
-gunicorn
-bottle
-kyoukai
-falcon
-tornado
-aiofiles

requirements.txt

@@ -1,5 +1,5 @@
+aiofiles
 httptools
 ujson
 uvloop
-aiofiles
-multidict
+websockets

sanic/__init__.py

@@ -1,6 +1,6 @@
-from .sanic import Sanic
-from .blueprints import Blueprint
+from sanic.app import Sanic
+from sanic.blueprints import Blueprint
 
-__version__ = '0.1.9'
+__version__ = '0.5.4'
 
 __all__ = ['Sanic', 'Blueprint']

sanic/__main__.py

@@ -1,13 +1,17 @@
 from argparse import ArgumentParser
 from importlib import import_module
 
-from .log import log
-from .sanic import Sanic
+from sanic.log import log
+from sanic.app import Sanic
 
 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')
@@ -20,17 +24,21 @@ if __name__ == "__main__":
 
         module = import_module(module_name)
         app = getattr(module, app_name, None)
-        if type(app) is not Sanic:
+        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))
+        if args.cert is not None or args.key is not None:
+            ssl = {'cert': args.cert, 'key': args.key}
+        else:
+            ssl = None
 
         app.run(host=args.host, port=args.port,
-                workers=args.workers, debug=args.debug)
-    except ImportError:
+                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(module_name))
+                  .format(e.name))
     except ValueError as e:
         log.error("{}".format(e))

sanic/app.py

@@ -0,0 +1,703 @@
+import logging
+import logging.config
+import re
+import warnings
+from asyncio import get_event_loop, ensure_future, CancelledError
+from collections import deque, defaultdict
+from functools import partial
+from inspect import isawaitable, stack, getmodulename
+from traceback import format_exc
+from urllib.parse import urlencode, urlunparse
+from ssl import create_default_context, Purpose
+
+from sanic.config import Config, LOGGING
+from sanic.constants import HTTP_METHODS
+from sanic.exceptions import ServerError, URLBuildError, SanicException
+from sanic.handlers import ErrorHandler
+from sanic.log import log
+from sanic.response import HTTPResponse, StreamingHTTPResponse
+from sanic.router import Router
+from sanic.server import serve, serve_multiple, HttpProtocol, Signal
+from sanic.static import register as static_register
+from sanic.testing import SanicTestClient
+from sanic.views import CompositionView
+from sanic.websocket import WebSocketProtocol, ConnectionClosed
+
+
+class Sanic:
+
+    def __init__(self, name=None, router=None, error_handler=None,
+                 load_env=True, request_class=None,
+                 log_config=LOGGING):
+        if log_config:
+            logging.config.dictConfig(log_config)
+        # Only set up a default log handler if the
+        # end-user application didn't set anything up.
+        if not logging.root.handlers and log.level == logging.NOTSET:
+            formatter = logging.Formatter(
+                "%(asctime)s: %(levelname)s: %(message)s")
+            handler = logging.StreamHandler()
+            handler.setFormatter(formatter)
+            log.addHandler(handler)
+            log.setLevel(logging.INFO)
+
+        # Get name from previous stack frame
+        if name is None:
+            frame_records = stack()[1]
+            name = getmodulename(frame_records[1])
+
+        self.name = name
+        self.router = router or Router()
+        self.request_class = request_class
+        self.error_handler = error_handler or ErrorHandler()
+        self.config = Config(load_env=load_env)
+        self.log_config = log_config
+        self.request_middleware = deque()
+        self.response_middleware = deque()
+        self.blueprints = {}
+        self._blueprint_order = []
+        self.debug = None
+        self.sock = None
+        self.listeners = defaultdict(list)
+        self.is_running = False
+        self.websocket_enabled = False
+        self.websocket_tasks = []
+
+        # Register alternative method names
+        self.go_fast = self.run
+
+    @property
+    def loop(self):
+        """Synonymous with asyncio.get_event_loop().
+
+        Only supported when using the `app.run` method.
+        """
+        if not self.is_running:
+            raise SanicException(
+                'Loop can only be retrieved after the app has started '
+                'running. Not supported with `create_server` function')
+        return get_event_loop()
+
+    # -------------------------------------------------------------------- #
+    # Registration
+    # -------------------------------------------------------------------- #
+
+    def add_task(self, task):
+        """Schedule a task to run later, after the loop has started.
+        Different from asyncio.ensure_future in that it does not
+        also return a future, and the actual ensure_future call
+        is delayed until before server start.
+
+        :param task: future, couroutine or awaitable
+        """
+        @self.listener('before_server_start')
+        def run(app, loop):
+            if callable(task):
+                loop.create_task(task())
+            else:
+                loop.create_task(task)
+
+    # Decorator
+    def listener(self, event):
+        """Create a listener from a decorated function.
+
+        :param event: event to listen to
+        """
+        def decorator(listener):
+            self.listeners[event].append(listener)
+            return listener
+        return decorator
+
+    # Decorator
+    def route(self, uri, methods=frozenset({'GET'}), host=None,
+              strict_slashes=False):
+        """Decorate a function to be registered as a route
+
+        :param uri: path of the URL
+        :param methods: list or tuple of methods allowed
+        :param host:
+        :return: decorated function
+        """
+
+        # Fix case where the user did not prefix the URL with a /
+        # and will probably get confused as to why it's not working
+        if not uri.startswith('/'):
+            uri = '/' + uri
+
+        def response(handler):
+            self.router.add(uri=uri, methods=methods, handler=handler,
+                            host=host, strict_slashes=strict_slashes)
+            return handler
+
+        return response
+
+    # Shorthand method decorators
+    def get(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=frozenset({"GET"}), host=host,
+                          strict_slashes=strict_slashes)
+
+    def post(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=frozenset({"POST"}), host=host,
+                          strict_slashes=strict_slashes)
+
+    def put(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=frozenset({"PUT"}), host=host,
+                          strict_slashes=strict_slashes)
+
+    def head(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=frozenset({"HEAD"}), host=host,
+                          strict_slashes=strict_slashes)
+
+    def options(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=frozenset({"OPTIONS"}), host=host,
+                          strict_slashes=strict_slashes)
+
+    def patch(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=frozenset({"PATCH"}), host=host,
+                          strict_slashes=strict_slashes)
+
+    def delete(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=frozenset({"DELETE"}), host=host,
+                          strict_slashes=strict_slashes)
+
+    def add_route(self, handler, uri, methods=frozenset({'GET'}), host=None,
+                  strict_slashes=False):
+        """A helper method to register class instance or
+        functions as a handler to the application url
+        routes.
+
+        :param handler: function or class instance
+        :param uri: path of the URL
+        :param methods: list or tuple of methods allowed, these are overridden
+                        if using a HTTPMethodView
+        :param host:
+        :return: function or class instance
+        """
+        # Handle HTTPMethodView differently
+        if hasattr(handler, 'view_class'):
+            methods = set()
+
+            for method in HTTP_METHODS:
+                if getattr(handler.view_class, method.lower(), None):
+                    methods.add(method)
+
+        # handle composition view differently
+        if isinstance(handler, CompositionView):
+            methods = handler.handlers.keys()
+
+        self.route(uri=uri, methods=methods, host=host,
+                   strict_slashes=strict_slashes)(handler)
+        return handler
+
+    # Decorator
+    def websocket(self, uri, host=None, strict_slashes=False):
+        """Decorate a function to be registered as a websocket route
+        :param uri: path of the URL
+        :param host:
+        :return: decorated function
+        """
+        self.enable_websocket()
+
+        # Fix case where the user did not prefix the URL with a /
+        # and will probably get confused as to why it's not working
+        if not uri.startswith('/'):
+            uri = '/' + uri
+
+        def response(handler):
+            async def websocket_handler(request, *args, **kwargs):
+                request.app = self
+                protocol = request.transport.get_protocol()
+                ws = await protocol.websocket_handshake(request)
+
+                # schedule the application handler
+                # its future is kept in self.websocket_tasks in case it
+                # needs to be cancelled due to the server being stopped
+                fut = ensure_future(handler(request, ws, *args, **kwargs))
+                self.websocket_tasks.append(fut)
+                try:
+                    await fut
+                except (CancelledError, ConnectionClosed):
+                    pass
+                self.websocket_tasks.remove(fut)
+                await ws.close()
+
+            self.router.add(uri=uri, handler=websocket_handler,
+                            methods=frozenset({'GET'}), host=host,
+                            strict_slashes=strict_slashes)
+            return handler
+
+        return response
+
+    def add_websocket_route(self, handler, uri, host=None,
+                            strict_slashes=False):
+        """A helper method to register a function as a websocket route."""
+        return self.websocket(uri, host=host,
+                              strict_slashes=strict_slashes)(handler)
+
+    def enable_websocket(self, enable=True):
+        """Enable or disable the support for websocket.
+
+        Websocket is enabled automatically if websocket routes are
+        added to the application.
+        """
+        if not self.websocket_enabled:
+            # if the server is stopped, we want to cancel any ongoing
+            # websocket tasks, to allow the server to exit promptly
+            @self.listener('before_server_stop')
+            def cancel_websocket_tasks(app, loop):
+                for task in self.websocket_tasks:
+                    task.cancel()
+
+        self.websocket_enabled = enable
+
+    def remove_route(self, uri, clean_cache=True, host=None):
+        self.router.remove(uri, clean_cache, host)
+
+    # Decorator
+    def exception(self, *exceptions):
+        """Decorate a function to be registered as a handler for exceptions
+
+        :param exceptions: exceptions
+        :return: decorated function
+        """
+
+        def response(handler):
+            for exception in exceptions:
+                if isinstance(exception, (tuple, list)):
+                    for e in exception:
+                        self.error_handler.add(e, handler)
+                else:
+                    self.error_handler.add(exception, handler)
+            return handler
+
+        return response
+
+    # Decorator
+    def middleware(self, middleware_or_request):
+        """Decorate and register middleware to be called before a request.
+        Can either be called as @app.middleware or @app.middleware('request')
+        """
+        def register_middleware(middleware, attach_to='request'):
+            if attach_to == 'request':
+                self.request_middleware.append(middleware)
+            if attach_to == 'response':
+                self.response_middleware.appendleft(middleware)
+            return middleware
+
+        # Detect which way this was called, @middleware or @middleware('AT')
+        if callable(middleware_or_request):
+            return register_middleware(middleware_or_request)
+
+        else:
+            return partial(register_middleware,
+                           attach_to=middleware_or_request)
+
+    # Static Files
+    def static(self, uri, file_or_directory, pattern=r'/?.+',
+               use_modified_since=True, use_content_range=False):
+        """Register a root to serve files from. The input can either be a
+        file or a directory. See
+        """
+        static_register(self, uri, file_or_directory, pattern,
+                        use_modified_since, use_content_range)
+
+    def blueprint(self, blueprint, **options):
+        """Register a blueprint on the application.
+
+        :param blueprint: Blueprint object
+        :param options: option dictionary with blueprint defaults
+        :return: Nothing
+        """
+        if blueprint.name in self.blueprints:
+            assert self.blueprints[blueprint.name] is blueprint, \
+                'A blueprint with the name "%s" is already registered.  ' \
+                'Blueprint names must be unique.' % \
+                (blueprint.name,)
+        else:
+            self.blueprints[blueprint.name] = blueprint
+            self._blueprint_order.append(blueprint)
+        blueprint.register(self, options)
+
+    def register_blueprint(self, *args, **kwargs):
+        # TODO: deprecate 1.0
+        if self.debug:
+            warnings.simplefilter('default')
+        warnings.warn("Use of register_blueprint will be deprecated in "
+                      "version 1.0.  Please use the blueprint method"
+                      " instead",
+                      DeprecationWarning)
+        return self.blueprint(*args, **kwargs)
+
+    def url_for(self, view_name: str, **kwargs):
+        """Build a URL based on a view name and the values provided.
+
+        In order to build a URL, all request parameters must be supplied as
+        keyword arguments, and each parameter must pass the test for the
+        specified parameter type. If these conditions are not met, a
+        `URLBuildError` will be thrown.
+
+        Keyword arguments that are not request parameters will be included in
+        the output URL's query string.
+
+        :param view_name: string referencing the view name
+        :param \*\*kwargs: keys and values that are used to build request
+            parameters and query string arguments.
+
+        :return: the built URL
+
+        Raises:
+            URLBuildError
+        """
+        # find the route by the supplied view name
+        uri, route = self.router.find_route_by_view_name(view_name)
+
+        if not uri or not route:
+            raise URLBuildError(
+                    'Endpoint with name `{}` was not found'.format(
+                        view_name))
+
+        if uri != '/' and uri.endswith('/'):
+            uri = uri[:-1]
+
+        out = uri
+
+        # find all the parameters we will need to build in the URL
+        matched_params = re.findall(
+            self.router.parameter_pattern, uri)
+
+        # _method is only a placeholder now, don't know how to support it
+        kwargs.pop('_method', None)
+        anchor = kwargs.pop('_anchor', '')
+        # _external need SERVER_NAME in config or pass _server arg
+        external = kwargs.pop('_external', False)
+        scheme = kwargs.pop('_scheme', '')
+        if scheme and not external:
+            raise ValueError('When specifying _scheme, _external must be True')
+
+        netloc = kwargs.pop('_server', None)
+        if netloc is None and external:
+            netloc = self.config.get('SERVER_NAME', '')
+
+        for match in matched_params:
+            name, _type, pattern = self.router.parse_parameter_string(
+                match)
+            # we only want to match against each individual parameter
+            specific_pattern = '^{}$'.format(pattern)
+            supplied_param = None
+
+            if kwargs.get(name):
+                supplied_param = kwargs.get(name)
+                del kwargs[name]
+            else:
+                raise URLBuildError(
+                    'Required parameter `{}` was not passed to url_for'.format(
+                        name))
+
+            supplied_param = str(supplied_param)
+            # determine if the parameter supplied by the caller passes the test
+            # in the URL
+            passes_pattern = re.match(specific_pattern, supplied_param)
+
+            if not passes_pattern:
+                if _type != str:
+                    msg = (
+                        'Value "{}" for parameter `{}` does not '
+                        'match pattern for type `{}`: {}'.format(
+                            supplied_param, name, _type.__name__, pattern))
+                else:
+                    msg = (
+                        'Value "{}" for parameter `{}` '
+                        'does not satisfy pattern {}'.format(
+                            supplied_param, name, pattern))
+                raise URLBuildError(msg)
+
+            # replace the parameter in the URL with the supplied value
+            replacement_regex = '(<{}.*?>)'.format(name)
+
+            out = re.sub(
+                replacement_regex, supplied_param, out)
+
+        # parse the remainder of the keyword arguments into a querystring
+        query_string = urlencode(kwargs, doseq=True) if kwargs else ''
+        # scheme://netloc/path;parameters?query#fragment
+        out = urlunparse((scheme, netloc, out, '', query_string, anchor))
+
+        return out
+
+    # -------------------------------------------------------------------- #
+    # Request Handling
+    # -------------------------------------------------------------------- #
+
+    def converted_response_type(self, response):
+        pass
+
+    async def handle_request(self, request, write_callback, stream_callback):
+        """Take a request from the HTTP Server and return a response object
+        to be sent back The HTTP Server only expects a response object, so
+        exception handling must be done here
+
+        :param request: HTTP Request object
+        :param write_callback: Synchronous response function to be
+            called with the response as the only argument
+        :param stream_callback: Coroutine that handles streaming a
+            StreamingHTTPResponse if produced by the handler.
+
+        :return: Nothing
+        """
+        try:
+            # -------------------------------------------- #
+            # Request Middleware
+            # -------------------------------------------- #
+
+            request.app = self
+            response = await self._run_request_middleware(request)
+            # No middleware results
+            if not response:
+                # -------------------------------------------- #
+                # Execute Handler
+                # -------------------------------------------- #
+
+                # Fetch handler from router
+                handler, args, kwargs, uri = self.router.get(request)
+                request.uri_template = uri
+                if handler is None:
+                    raise ServerError(
+                        ("'None' was returned while requesting a "
+                         "handler from the router"))
+
+                # Run response handler
+                response = handler(request, *args, **kwargs)
+                if isawaitable(response):
+                    response = await response
+        except Exception as e:
+            # -------------------------------------------- #
+            # Response Generation Failed
+            # -------------------------------------------- #
+
+            try:
+                response = self.error_handler.response(request, e)
+                if isawaitable(response):
+                    response = await response
+            except Exception as e:
+                if self.debug:
+                    response = HTTPResponse(
+                        "Error while handling error: {}\nStack: {}".format(
+                            e, format_exc()))
+                else:
+                    response = HTTPResponse(
+                        "An error occurred while handling an error")
+        finally:
+            # -------------------------------------------- #
+            # Response Middleware
+            # -------------------------------------------- #
+            try:
+                response = await self._run_response_middleware(request,
+                                                               response)
+            except:
+                log.exception(
+                    'Exception occured in one of response middleware handlers'
+                )
+
+        # pass the response to the correct callback
+        if isinstance(response, StreamingHTTPResponse):
+            await stream_callback(response)
+        else:
+            write_callback(response)
+
+    # -------------------------------------------------------------------- #
+    # Testing
+    # -------------------------------------------------------------------- #
+
+    @property
+    def test_client(self):
+        return SanicTestClient(self)
+
+    # -------------------------------------------------------------------- #
+    # Execution
+    # -------------------------------------------------------------------- #
+
+    def run(self, host="127.0.0.1", port=8000, debug=False, ssl=None,
+            sock=None, workers=1, protocol=None,
+            backlog=100, stop_event=None, register_sys_signals=True,
+            log_config=LOGGING):
+        """Run the HTTP Server and listen until keyboard interrupt or term
+        signal. On termination, drain connections before closing.
+
+        :param host: Address to host on
+        :param port: Port to host on
+        :param debug: Enables debug output (slows server)
+        :param ssl: SSLContext, or location of certificate and key
+                            for SSL encryption of worker(s)
+        :param sock: Socket for the server to accept connections from
+        :param workers: Number of processes
+                            received before it is respected
+        :param backlog:
+        :param stop_event:
+        :param register_sys_signals:
+        :param protocol: Subclass of asyncio protocol class
+        :return: Nothing
+        """
+        if log_config:
+            logging.config.dictConfig(log_config)
+        if protocol is None:
+            protocol = (WebSocketProtocol if self.websocket_enabled
+                        else HttpProtocol)
+        if stop_event is not None:
+            if debug:
+                warnings.simplefilter('default')
+            warnings.warn("stop_event will be removed from future versions.",
+                          DeprecationWarning)
+        server_settings = self._helper(
+            host=host, port=port, debug=debug, ssl=ssl, sock=sock,
+            workers=workers, protocol=protocol, backlog=backlog,
+            register_sys_signals=register_sys_signals,
+            has_log=log_config is not None)
+
+        try:
+            self.is_running = True
+            if workers == 1:
+                serve(**server_settings)
+            else:
+                serve_multiple(server_settings, workers)
+        except:
+            log.exception(
+                'Experienced exception while trying to serve')
+            raise
+        finally:
+            self.is_running = False
+        log.info("Server Stopped")
+
+    def stop(self):
+        """This kills the Sanic"""
+        get_event_loop().stop()
+
+    def __call__(self):
+        """gunicorn compatibility"""
+        return self
+
+    async def create_server(self, host="127.0.0.1", port=8000, debug=False,
+                            ssl=None, sock=None, protocol=None,
+                            backlog=100, stop_event=None,
+                            log_config=LOGGING):
+        """Asynchronous version of `run`.
+
+        NOTE: This does not support multiprocessing and is not the preferred
+              way to run a Sanic application.
+        """
+        if log_config:
+            logging.config.dictConfig(log_config)
+        if protocol is None:
+            protocol = (WebSocketProtocol if self.websocket_enabled
+                        else HttpProtocol)
+        if stop_event is not None:
+            if debug:
+                warnings.simplefilter('default')
+            warnings.warn("stop_event will be removed from future versions.",
+                          DeprecationWarning)
+        server_settings = self._helper(
+            host=host, port=port, debug=debug, ssl=ssl, sock=sock,
+            loop=get_event_loop(), protocol=protocol,
+            backlog=backlog, run_async=True,
+            has_log=log_config is not None)
+
+        return await serve(**server_settings)
+
+    async def _run_request_middleware(self, request):
+        # The if improves speed.  I don't know why
+        if self.request_middleware:
+            for middleware in self.request_middleware:
+                response = middleware(request)
+                if isawaitable(response):
+                    response = await response
+                if response:
+                    return response
+        return None
+
+    async def _run_response_middleware(self, request, response):
+        if self.response_middleware:
+            for middleware in self.response_middleware:
+                _response = middleware(request, response)
+                if isawaitable(_response):
+                    _response = await _response
+                if _response:
+                    response = _response
+                    break
+        return response
+
+    def _helper(self, host="127.0.0.1", port=8000, debug=False,
+                ssl=None, sock=None, workers=1, loop=None,
+                protocol=HttpProtocol, backlog=100, stop_event=None,
+                register_sys_signals=True, run_async=False, has_log=True):
+        """Helper function used by `run` and `create_server`."""
+
+        if isinstance(ssl, dict):
+            # try common aliaseses
+            cert = ssl.get('cert') or ssl.get('certificate')
+            key = ssl.get('key') or ssl.get('keyfile')
+            if cert is None or key is None:
+                raise ValueError("SSLContext or certificate and key required.")
+            context = create_default_context(purpose=Purpose.CLIENT_AUTH)
+            context.load_cert_chain(cert, keyfile=key)
+            ssl = context
+        if stop_event is not None:
+            if debug:
+                warnings.simplefilter('default')
+            warnings.warn("stop_event will be removed from future versions.",
+                          DeprecationWarning)
+
+        self.error_handler.debug = debug
+        self.debug = debug
+
+        server_settings = {
+            'protocol': protocol,
+            'request_class': self.request_class,
+            'host': host,
+            'port': port,
+            'sock': sock,
+            'ssl': ssl,
+            'signal': Signal(),
+            'debug': debug,
+            'request_handler': self.handle_request,
+            'error_handler': self.error_handler,
+            'request_timeout': self.config.REQUEST_TIMEOUT,
+            'request_max_size': self.config.REQUEST_MAX_SIZE,
+            'keep_alive': self.config.KEEP_ALIVE,
+            'loop': loop,
+            'register_sys_signals': register_sys_signals,
+            'backlog': backlog,
+            'has_log': has_log
+        }
+
+        # -------------------------------------------- #
+        # Register start/stop events
+        # -------------------------------------------- #
+
+        for event_name, settings_name, reverse in (
+                ("before_server_start", "before_start", False),
+                ("after_server_start", "after_start", False),
+                ("before_server_stop", "before_stop", True),
+                ("after_server_stop", "after_stop", True),
+        ):
+            listeners = self.listeners[event_name].copy()
+            if reverse:
+                listeners.reverse()
+            # Prepend sanic to the arguments when listeners are triggered
+            listeners = [partial(listener, self) for listener in listeners]
+            server_settings[settings_name] = listeners
+
+        if debug:
+            log.setLevel(logging.DEBUG)
+        if self.config.LOGO is not None:
+            log.debug(self.config.LOGO)
+
+        if run_async:
+            server_settings['run_async'] = True
+
+        # Serve
+        if host and port:
+            proto = "http"
+            if ssl is not None:
+                proto = "https"
+            log.info('Goin\' Fast @ {}://{}:{}'.format(proto, host, port))
+
+        return server_settings

sanic/blueprints.py

@@ -1,104 +1,156 @@
-from collections import defaultdict
+from collections import defaultdict, namedtuple
 
+from sanic.constants import HTTP_METHODS
+from sanic.views import CompositionView
 
-class BlueprintSetup:
-    """
-    """
-
-    def __init__(self, blueprint, app, options):
-        self.app = app
-        self.blueprint = blueprint
-        self.options = options
-
-        url_prefix = self.options.get('url_prefix')
-        if url_prefix is None:
-            url_prefix = self.blueprint.url_prefix
-
-        #: The prefix that should be used for all URLs defined on the
-        #: blueprint.
-        self.url_prefix = url_prefix
-
-    def add_route(self, handler, uri, methods):
-        """
-        A helper method to register a handler to the application url routes.
-        """
-        if self.url_prefix:
-            uri = self.url_prefix + uri
-
-        self.app.route(uri=uri, methods=methods)(handler)
-
-    def add_exception(self, handler, *args, **kwargs):
-        """
-        Registers exceptions to sanic
-        """
-        self.app.exception(*args, **kwargs)(handler)
-
-    def add_static(self, uri, file_or_directory, *args, **kwargs):
-        """
-        Registers static files to sanic
-        """
-        if self.url_prefix:
-            uri = self.url_prefix + uri
-
-        self.app.static(uri, file_or_directory, *args, **kwargs)
-
-    def add_middleware(self, middleware, *args, **kwargs):
-        """
-        Registers middleware to sanic
-        """
-        if args or kwargs:
-            self.app.middleware(*args, **kwargs)(middleware)
-        else:
-            self.app.middleware(middleware)
+FutureRoute = namedtuple('Route',
+                         ['handler', 'uri', 'methods',
+                          'host', 'strict_slashes'])
+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'])
 
 
 class Blueprint:
-    def __init__(self, name, url_prefix=None):
-        """
-        Creates a new blueprint
-        :param name: Unique name of the blueprint
+    def __init__(self, name, url_prefix=None, host=None):
+        """Create a new blueprint
+
+        :param name: unique name of the blueprint
         :param url_prefix: URL to be prefixed before all route URLs
         """
         self.name = name
         self.url_prefix = url_prefix
-        self.deferred_functions = []
+        self.host = host
+
+        self.routes = []
+        self.websocket_routes = []
+        self.exceptions = []
         self.listeners = defaultdict(list)
-
-    def record(self, func):
-        """
-        Registers a callback function that is invoked when the blueprint is
-        registered on the application.
-        """
-        self.deferred_functions.append(func)
-
-    def make_setup_state(self, app, options):
-        """
-        """
-        return BlueprintSetup(self, app, options)
+        self.middlewares = []
+        self.statics = []
 
     def register(self, app, options):
-        """
-        """
-        state = self.make_setup_state(app, options)
-        for deferred in self.deferred_functions:
-            deferred(state)
+        """Register the blueprint to the sanic app."""
 
-    def route(self, uri, methods=None):
-        """
+        url_prefix = options.get('url_prefix', self.url_prefix)
+
+        # Routes
+        for future in self.routes:
+            # attach the blueprint name to the handler so that it can be
+            # prefixed properly in the router
+            future.handler.__blueprintname__ = self.name
+            # Prepend the blueprint URI prefix if available
+            uri = url_prefix + future.uri if url_prefix else future.uri
+            app.route(
+                uri=uri[1:] if uri.startswith('//') else uri,
+                methods=future.methods,
+                host=future.host or self.host,
+                strict_slashes=future.strict_slashes
+                )(future.handler)
+
+        for future in self.websocket_routes:
+            # attach the blueprint name to the handler so that it can be
+            # prefixed properly in the router
+            future.handler.__blueprintname__ = self.name
+            # Prepend the blueprint URI prefix if available
+            uri = url_prefix + future.uri if url_prefix else future.uri
+            app.websocket(
+                uri=uri,
+                host=future.host or self.host,
+                strict_slashes=future.strict_slashes
+                )(future.handler)
+
+        # Middleware
+        for future in self.middlewares:
+            if future.args or future.kwargs:
+                app.middleware(*future.args,
+                               **future.kwargs)(future.middleware)
+            else:
+                app.middleware(future.middleware)
+
+        # Exceptions
+        for future in self.exceptions:
+            app.exception(*future.args, **future.kwargs)(future.handler)
+
+        # Static Files
+        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)
+
+        # 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):
+        """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.
         """
         def decorator(handler):
-            self.record(lambda s: s.add_route(handler, uri, methods))
+            route = FutureRoute(handler, uri, methods, host, strict_slashes)
+            self.routes.append(route)
             return handler
         return decorator
 
-    def add_route(self, handler, uri, methods=None):
+    def add_route(self, handler, uri, methods=frozenset({'GET'}), host=None,
+                  strict_slashes=False):
+        """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.
+        :return: function or class instance
         """
+        # Handle HTTPMethodView differently
+        if hasattr(handler, 'view_class'):
+            methods = set()
+
+            for method in HTTP_METHODS:
+                if getattr(handler.view_class, method.lower(), None):
+                    methods.add(method)
+
+        # handle composition view differently
+        if isinstance(handler, CompositionView):
+            methods = handler.handlers.keys()
+
+        self.route(uri=uri, methods=methods, host=host,
+                   strict_slashes=strict_slashes)(handler)
+        return handler
+
+    def websocket(self, uri, host=None, strict_slashes=False):
+        """Create a blueprint websocket route from a decorated function.
+
+        :param uri: endpoint at which the route will be accessible.
         """
-        self.record(lambda s: s.add_route(handler, uri, methods))
+        def decorator(handler):
+            route = FutureRoute(handler, uri, [], host, strict_slashes)
+            self.websocket_routes.append(route)
+            return handler
+        return decorator
+
+    def add_websocket_route(self, handler, uri, host=None):
+        """Create a blueprint websocket 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.
+        :return: function or class instance
+        """
+        self.websocket(uri=uri, host=host)(handler)
         return handler
 
     def listener(self, event):
-        """
+        """Create a listener from a decorated function.
+
+        :param event: Event to listen to.
         """
         def decorator(listener):
             self.listeners[event].append(listener)
@@ -106,12 +158,11 @@ class Blueprint:
         return decorator
 
     def middleware(self, *args, **kwargs):
-        """
-        """
-        def register_middleware(middleware):
-            self.record(
-                lambda s: s.add_middleware(middleware, *args, **kwargs))
-            return middleware
+        """Create a blueprint middleware from a decorated function."""
+        def register_middleware(_middleware):
+            future_middleware = FutureMiddleware(_middleware, args, kwargs)
+            self.middlewares.append(future_middleware)
+            return _middleware
 
         # Detect which way this was called, @middleware or @middleware('AT')
         if len(args) == 1 and len(kwargs) == 0 and callable(args[0]):
@@ -122,15 +173,47 @@ class Blueprint:
             return register_middleware
 
     def exception(self, *args, **kwargs):
-        """
-        """
+        """Create a blueprint exception from a decorated function."""
         def decorator(handler):
-            self.record(lambda s: s.add_exception(handler, *args, **kwargs))
+            exception = FutureException(handler, args, kwargs)
+            self.exceptions.append(exception)
             return handler
         return decorator
 
     def static(self, uri, file_or_directory, *args, **kwargs):
+        """Create a blueprint static route from a decorated function.
+
+        :param uri: endpoint at which the route will be accessible.
+        :param file_or_directory: Static asset.
         """
-        """
-        self.record(
-            lambda s: s.add_static(uri, file_or_directory, *args, **kwargs))
+        static = FutureStatic(uri, file_or_directory, args, kwargs)
+        self.statics.append(static)
+
+    # Shorthand method decorators
+    def get(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=["GET"], host=host,
+                          strict_slashes=strict_slashes)
+
+    def post(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=["POST"], host=host,
+                          strict_slashes=strict_slashes)
+
+    def put(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=["PUT"], host=host,
+                          strict_slashes=strict_slashes)
+
+    def head(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=["HEAD"], host=host,
+                          strict_slashes=strict_slashes)
+
+    def options(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=["OPTIONS"], host=host,
+                          strict_slashes=strict_slashes)
+
+    def patch(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=["PATCH"], host=host,
+                          strict_slashes=strict_slashes)
+
+    def delete(self, uri, host=None, strict_slashes=False):
+        return self.route(uri, methods=["DELETE"], host=host,
+                          strict_slashes=strict_slashes)

sanic/config.py

@@ -1,5 +1,124 @@
-class Config:
-    LOGO = """
+from sanic.defaultFilter import DefaultFilter
+import os
+import sys
+import syslog
+import platform
+import types
+
+SANIC_PREFIX = 'SANIC_'
+
+_address_dict = {
+    'Windows': ('localhost', 514),
+    'Darwin': '/var/run/syslog',
+    'Linux': '/dev/log',
+    'FreeBSD': '/dev/log'
+}
+
+LOGGING = {
+    'version': 1,
+    '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'
+        },
+        'accessTimedRotatingFile': {
+            'class': 'logging.handlers.TimedRotatingFileHandler',
+            'filters': ['accessFilter'],
+            'formatter': 'access',
+            'when': 'D',
+            'interval': 1,
+            'backupCount': 7,
+            'filename': 'access.log'
+        },
+        'errorTimedRotatingFile': {
+            'class': 'logging.handlers.TimedRotatingFileHandler',
+            'filters': ['errorFilter'],
+            'when': 'D',
+            'interval': 1,
+            'backupCount': 7,
+            'filename': 'error.log',
+            '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')
+
+
+class Config(dict):
+    def __init__(self, defaults=None, load_env=True, keep_alive=True):
+        super().__init__(defaults or {})
+        self.LOGO = """
                  ▄▄▄▄▄
         ▀▀▀██████▄▄▄       _______________
       ▄▄▄▄▄  █████████▄  /                 \\
@@ -20,6 +139,81 @@ class Config:
 ▌     ▐                ▀▀▄▄▄▀
  ▀▀▄▄▀
 """
-    REQUEST_MAX_SIZE = 100000000  # 100 megababies
-    REQUEST_TIMEOUT = 60  # 60 seconds
-    ROUTER_CACHE_SIZE = 1024
+        self.REQUEST_MAX_SIZE = 100000000  # 100 megababies
+        self.REQUEST_TIMEOUT = 60  # 60 seconds
+        self.KEEP_ALIVE = keep_alive
+
+        if load_env:
+            self.load_environment_vars()
+
+    def __getattr__(self, attr):
+        try:
+            return self[attr]
+        except KeyError as ke:
+            raise AttributeError("Config has no '{}'".format(ke.args[0]))
+
+    def __setattr__(self, attr, value):
+        self[attr] = value
+
+    def from_envvar(self, variable_name):
+        """Load a configuration from an environment variable pointing to
+        a configuration file.
+
+        :param variable_name: name of the environment variable
+        :return: bool. ``True`` if able to load config, ``False`` otherwise.
+        """
+        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)
+        return self.from_pyfile(config_file)
+
+    def from_pyfile(self, filename):
+        """Update the values in the config from a Python file.
+        Only the uppercase variables in that module are stored in the config.
+
+        :param filename: an absolute path to the config file
+        """
+        module = types.ModuleType('config')
+        module.__file__ = filename
+        try:
+            with open(filename) as config_file:
+                exec(compile(config_file.read(), filename, 'exec'),
+                     module.__dict__)
+        except IOError as e:
+            e.strerror = 'Unable to load configuration file (%s)' % e.strerror
+            raise
+        self.from_object(module)
+        return True
+
+    def from_object(self, obj):
+        """Update the values from the given object.
+        Objects are usually either modules or classes.
+
+        Just the uppercase variables in that object are stored in the config.
+        Example usage::
+
+            from yourapplication import default_config
+            app.config.from_object(default_config)
+
+        You should not use this function to load the actual configuration but
+        rather configuration defaults. The actual config should be loaded
+        with :meth:`from_pyfile` and ideally from a location not within the
+        package because the package might be installed system wide.
+
+        :param obj: an object holding the configuration
+        """
+        for key in dir(obj):
+            if key.isupper():
+                self[key] = getattr(obj, key)
+
+    def load_environment_vars(self):
+        """
+        Looks for any SANIC_ 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)
+                self[config_key] = v

sanic/constants.py

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

sanic/cookies.py

@@ -1,4 +1,3 @@
-from datetime import datetime
 import re
 import string
 
@@ -20,7 +19,7 @@ _Translator.update({
 
 
 def _quote(str):
-    r"""Quote a string for use in a cookie header.
+    """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.
@@ -39,11 +38,11 @@ _is_legal_key = re.compile('[%s]+' % re.escape(_LegalChars)).fullmatch
 
 
 class CookieJar(dict):
-    """
-    CookieJar dynamically writes headers as cookies are added and removed
+    """CookieJar dynamically writes headers as cookies are added and removed
     It gets around the limitation of one header per name by using the
-    MultiHeader class to provide a unique key that encodes to Set-Cookie
+    MultiHeader class to provide a unique key that encodes to Set-Cookie.
     """
+
     def __init__(self, headers):
         super().__init__()
         self.headers = headers
@@ -54,6 +53,7 @@ class CookieJar(dict):
         cookie_header = self.cookie_headers.get(key)
         if not cookie_header:
             cookie = Cookie(key, value)
+            cookie['path'] = '/'
             cookie_header = MultiHeader("Set-Cookie")
             self.cookie_headers[key] = cookie_header
             self.headers[cookie_header] = cookie
@@ -62,14 +62,18 @@ class CookieJar(dict):
             self[key].value = value
 
     def __delitem__(self, key):
-        del self.cookie_headers[key]
-        return super().__delitem__(key)
+        if key not in self.cookie_headers:
+            self[key] = ''
+            self[key]['max-age'] = 0
+        else:
+            cookie_header = self.cookie_headers[key]
+            del self.headers[cookie_header]
+            del self.cookie_headers[key]
+            return super().__delitem__(key)
 
 
 class Cookie(dict):
-    """
-    This is a stripped down version of Morsel from SimpleCookie #gottagofast
-    """
+    """A stripped down version of Morsel from SimpleCookie #gottagofast"""
     _keys = {
         "expires": "expires",
         "path": "Path",
@@ -99,15 +103,22 @@ class Cookie(dict):
     def encode(self, encoding):
         output = ['%s=%s' % (self.key, _quote(self.value))]
         for key, value in self.items():
-            if key == 'max-age' and isinstance(value, int):
-                output.append('%s=%d' % (self._keys[key], value))
-            elif key == 'expires' and isinstance(value, datetime):
-                output.append('%s=%s' % (
-                    self._keys[key],
-                    value.strftime("%a, %d-%b-%Y %T GMT")
-                ))
+            if key == 'max-age':
+                try:
+                    output.append('%s=%d' % (self._keys[key], value))
+                except TypeError:
+                    output.append('%s=%s' % (self._keys[key], value))
+            elif key == 'expires':
+                try:
+                    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))
             elif key in self._flags:
-                output.append(self._keys[key])
+                if self[key]:
+                    output.append(self._keys[key])
             else:
                 output.append('%s=%s' % (self._keys[key], value))
 
@@ -119,9 +130,8 @@ class Cookie(dict):
 
 
 class MultiHeader:
-    """
-    Allows us to set a header within response that has a unique key,
-    but may contain duplicate header names
+    """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

sanic/defaultFilter.py

@@ -0,0 +1,13 @@
+import logging
+
+
+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

sanic/exceptions.py

@@ -1,10 +1,125 @@
-from .response import text
-from traceback import format_exc
+TRACEBACK_STYLE = '''
+    <style>
+        body {
+            padding: 20px;
+            font-family: Arial, sans-serif;
+        }
+
+        p {
+            margin: 0;
+        }
+
+        .summary {
+            padding: 10px;
+        }
+
+        h1 {
+            margin-bottom: 0;
+        }
+
+        h3 {
+            margin-top: 10px;
+        }
+
+        h3 code {
+            font-size: 24px;
+        }
+
+        .frame-line > * {
+            padding: 5px 10px;
+        }
+
+        .frame-line {
+            margin-bottom: 5px;
+        }
+
+        .frame-code {
+            font-size: 16px;
+            padding-left: 30px;
+        }
+
+        .tb-wrapper {
+            border: 1px solid #f3f3f3;
+        }
+
+        .tb-header {
+            background-color: #f3f3f3;
+            padding: 5px 10px;
+        }
+
+        .tb-border {
+            padding-top: 20px;
+        }
+
+        .frame-descriptor {
+            background-color: #e2eafb;
+        }
+
+        .frame-descriptor {
+            font-size: 14px;
+        }
+    </style>
+'''
+
+TRACEBACK_WRAPPER_HTML = '''
+    <html>
+        <head>
+            {style}
+        </head>
+        <body>
+            {inner_html}
+            <div class="summary">
+                <p>
+                <b>{exc_name}: {exc_value}</b>
+                    while handling path <code>{path}</code>
+                </p>
+            </div>
+        </body>
+    </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 = '''
+    <div class="tb-border">
+        <b><i>
+            The above exception was the direct cause of the
+            following exception:
+        </i></b>
+    </div>
+'''
+
+TRACEBACK_LINE_HTML = '''
+    <div class="frame-line">
+        <p class="frame-descriptor">
+            File {0.filename}, line <i>{0.lineno}</i>,
+            in <code><b>{0.name}</b></code>
+        </p>
+        <p class="frame-code"><code>{0.line}</code></p>
+    </div>
+'''
+
+INTERNAL_SERVER_ERROR_HTML = '''
+    <h1>Internal Server Error</h1>
+    <p>
+        The server encountered an internal error and cannot complete
+        your request.
+    </p>
+'''
 
 
 class SanicException(Exception):
+
     def __init__(self, message, status_code=None):
         super().__init__(message)
+
         if status_code is not None:
             self.status_code = status_code
 
@@ -21,6 +136,10 @@ class ServerError(SanicException):
     status_code = 500
 
 
+class URLBuildError(SanicException):
+    status_code = 500
+
+
 class FileNotFound(NotFound):
     status_code = 404
 
@@ -38,36 +157,20 @@ class PayloadTooLarge(SanicException):
     status_code = 413
 
 
-class Handler:
-    handlers = None
+class HeaderNotFound(SanicException):
+    status_code = 400
 
-    def __init__(self, sanic):
-        self.handlers = {}
-        self.sanic = sanic
 
-    def add(self, exception, handler):
-        self.handlers[exception] = handler
+class ContentRangeError(SanicException):
+    status_code = 416
 
-    def response(self, request, exception):
-        """
-        Fetches and executes an exception handler and returns a response object
-        :param request: Request
-        :param exception: Exception to handle
-        :return: Response object
-        """
-        handler = self.handlers.get(type(exception), self.default)
-        response = handler(request=request, exception=exception)
-        return response
+    def __init__(self, message, content_range):
+        super().__init__(message)
+        self.headers = {
+            'Content-Type': 'text/plain',
+            "Content-Range": "bytes */%s" % (content_range.total,)
+        }
 
-    def default(self, request, exception):
-        if issubclass(type(exception), SanicException):
-            return text(
-                "Error: {}".format(exception),
-                status=getattr(exception, 'status_code', 500))
-        elif self.sanic.debug:
-            return text(
-                "Error: {}\nException: {}".format(
-                    exception, format_exc()), status=500)
-        else:
-            return text(
-                "An error occurred while generating the request", status=500)
+
+class InvalidRangeType(ContentRangeError):
+    pass

sanic/handlers.py

@@ -0,0 +1,171 @@
+import sys
+from traceback import format_exc, extract_tb
+
+from sanic.exceptions import (
+    ContentRangeError,
+    HeaderNotFound,
+    INTERNAL_SERVER_ERROR_HTML,
+    InvalidRangeType,
+    SanicException,
+    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
+
+
+class ErrorHandler:
+    handlers = None
+    cached_handlers = None
+    _missing = object()
+
+    def __init__(self):
+        self.handlers = []
+        self.cached_handlers = {}
+        self.debug = False
+
+    def _render_exception(self, exception):
+        frames = extract_tb(exception.__traceback__)
+
+        frame_html = []
+        for frame in frames:
+            frame_html.append(TRACEBACK_LINE_HTML.format(frame))
+
+        return TRACEBACK_WRAPPER_INNER_HTML.format(
+            exc_name=exception.__class__.__name__,
+            exc_value=exception,
+            frame_html=''.join(frame_html))
+
+    def _render_traceback_html(self, exception, request):
+        exc_type, exc_value, tb = sys.exc_info()
+        exceptions = []
+
+        while exc_value:
+            exceptions.append(self._render_exception(exc_value))
+            exc_value = exc_value.__cause__
+
+        return TRACEBACK_WRAPPER_HTML.format(
+            style=TRACEBACK_STYLE,
+            exc_name=exception.__class__.__name__,
+            exc_value=exception,
+            inner_html=TRACEBACK_BORDER.join(reversed(exceptions)),
+            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)
+        if handler is self._missing:
+            for exception_class, handler in self.handlers:
+                if isinstance(exception, exception_class):
+                    self.cached_handlers[type(exception)] = handler
+                    return handler
+            self.cached_handlers[type(exception)] = None
+            handler = None
+        return handler
+
+    def response(self, request, exception):
+        """Fetches and executes an exception handler and returns a response
+        object
+
+        :param request: Request
+        :param exception: Exception to handle
+        :return: Response object
+        """
+        handler = self.lookup(exception)
+        response = None
+        try:
+            if handler:
+                response = handler(request=request, exception=exception)
+            if response is None:
+                response = self.default(request=request, exception=exception)
+        except Exception:
+            self.log(format_exc())
+            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)
+            else:
+                return text('An error occurred while handling an error', 500)
+        return response
+
+    def log(self, message, level='error'):
+        """
+        Override this method in an ErrorHandler subclass to prevent
+        logging exceptions.
+        """
+        getattr(log, level)(message)
+
+    def default(self, request, exception):
+        self.log(format_exc())
+        if issubclass(type(exception), SanicException):
+            return text(
+                '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)
+
+
+class ContentRangeHandler:
+    """Class responsible for parsing request header"""
+    __slots__ = ('start', 'end', 'size', 'total', 'headers')
+
+    def __init__(self, request, stats):
+        self.total = stats.st_size
+        _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 InvalidRangeType(
+                '%s is not a valid Range Type' % (unit,), self)
+        start_b, _, end_b = tuple(map(str.strip, value.partition('-')))
+        try:
+            self.start = int(start_b) if start_b else None
+        except ValueError:
+            raise ContentRangeError(
+                '\'%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)
+        if self.end is None:
+            if self.start is None:
+                raise ContentRangeError(
+                    'Invalid for Content Range parameters', self)
+            else:
+                # this case represents `Content-Range: bytes 5-`
+                self.end = self.total
+        else:
+            if self.start is None:
+                # this case represents `Content-Range: bytes -5`
+                self.start = self.total - self.end
+                self.end = self.total
+        if self.start >= self.end:
+            raise ContentRangeError(
+                'Invalid for Content Range parameters', self)
+        self.size = self.end - self.start
+        self.headers = {
+            'Content-Range': "bytes %s-%s/%s" % (
+                self.start, self.end, self.total)}
+
+    def __bool__(self):
+        return self.size > 0

sanic/log.py

@@ -1,5 +1,4 @@
 import logging
 
-logging.basicConfig(
-    level=logging.INFO, format="%(asctime)s: %(levelname)s: %(message)s")
-log = logging.getLogger(__name__)
+log = logging.getLogger('sanic')
+netlog = logging.getLogger('network')