fix typo in Asyncio example (#1510)

* fix typo

* args to kwargs

.appveyor.yml

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

.coveragerc

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

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/feature_request.md

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

.github/ISSUE_TEMPLATE/help-wanted.md

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

.gitignore

@@ -14,3 +14,5 @@ settings.py
 docs/_build/
 docs/_api/
 build/*
+.DS_Store
+dist/*

.travis.yml

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

CHANGELOG.md

@@ -1,3 +1,116 @@
+Version 18.12
+-------------
+18.12.0
+  - Changes:
+    - Improved codebase test coverage from 81% to 91%.
+    - Added stream_large_files and host examples in static_file document
+    - Added methods to append and finish body content on Request (#1379)
+    - Integrated with .appveyor.yml for windows ci support
+    - Added documentation for AF_INET6 and AF_UNIX socket usage
+    - Adopt black/isort for codestyle
+    - Cancel task when connection_lost
+    - Simplify request ip and port retrieval logic
+    - Handle config error in load config file.
+    - Integrate with codecov for CI
+    - Add missed documentation for config section.
+    - Deprecate Handler.log
+    - Pinned httptools requirement to version 0.0.10+
+
+  - Fixes:
+    - Fix `remove_entity_headers` helper function (#1415)
+    - Fix TypeError when use Blueprint.group() to group blueprint with default url_prefix, Use os.path.normpath to avoid invalid url_prefix like api//v1
+    f8a6af1 Rename the `http` module to `helpers` to prevent conflicts with the built-in Python http library (fixes #1323)
+    - Fix unittests on windows
+    - Fix Namespacing of sanic logger
+    - Fix missing quotes in decorator example
+    - Fix redirect with quoted param
+    - Fix doc for latest blueprint code
+    - Fix build of latex documentation relating to markdown lists
+    - Fix loop exception handling in app.py
+    - Fix content length mismatch in windows and other platform
+    - Fix Range header handling for static files (#1402)
+    - Fix the logger and make it work (#1397)
+    - Fix type pikcle->pickle in multiprocessing test
+    - Fix pickling blueprints Change the string passed in the "name" section of the namedtuples in Blueprint to match the name of the Blueprint module attribute name. This allows blueprints to be pickled and unpickled, without errors, which is a requirment of running Sanic in multiprocessing mode in Windows. Added a test for pickling and unpickling blueprints Added a test for pickling and unpickling sanic itself Added a test for enabling multiprocessing on an app with a blueprint (only useful to catch this bug if the tests are run on Windows).
+    - Fix document for logging
+
+Version 0.8
+-----------
+0.8.3
+  - Changes:
+    - Ownership changed to org 'huge-success'
+
+0.8.0
+  - Changes:
+    - Add Server-Sent Events extension (Innokenty Lebedev)
+    - Graceful handling of request_handler_task cancellation (Ashley Sommer)
+    - Sanitize URL before redirection (aveao)
+    - Add url_bytes to request (johndoe46)
+    - py37 support for travisci (yunstanford)
+    - Auto reloader support for OSX (garyo)
+    - Add UUID route support (Volodymyr Maksymiv)
+    - Add pausable response streams (Ashley Sommer)
+    - Add weakref to request slots (vopankov)
+    - remove ubuntu 12.04 from test fixture due to deprecation (yunstanford)
+    - Allow streaming handlers in add_route (kinware)
+    - use travis_retry for tox (Raphael Deem)
+    - update aiohttp version for test client (yunstanford)
+    - add redirect import for clarity (yingshaoxo)
+    - Update HTTP Entity headers (Arnulfo Solís)
+    - Add register_listener method (Stephan Fitzpatrick)
+    - Remove uvloop/ujson dependencies for Windows (abuckenheimer)
+    - Content-length header on 204/304 responses (Arnulfo Solís)
+    - Extend WebSocketProtocol arguments and add docs (Bob Olde Hampsink, yunstanford)
+    - Update development status from pre-alpha to beta (Maksim Anisenkov)
+    - KeepAlive Timout log level changed to debug (Arnulfo Solís)
+    - Pin pytest to 3.3.2 because of pytest-dev/pytest#3170 (Maksim Aniskenov)
+    - Install Python 3.5 and 3.6 on docker container for tests (Shahin Azad)
+    - Add support for blueprint groups and nesting (Elias Tarhini)
+    - Remove uvloop for windows setup (Aleksandr Kurlov)
+    - Auto Reload (Yaser Amari)
+    - Documentation updates/fixups (multiple contributors)
+
+  - Fixes:
+    - Fix: auto_reload in Linux (Ashley Sommer)
+    - Fix: broken tests for aiohttp >= 3.3.0 (Ashley Sommer)
+    - Fix: disable auto_reload by default on windows (abuckenheimer)
+    - Fix (1143): Turn off access log with gunicorn (hqy)
+    - Fix (1268): Support status code for file response (Cosmo Borsky)
+    - Fix (1266): Add content_type flag to Sanic.static (Cosmo Borsky)
+    - Fix: subprotocols parameter missing from add_websocket_route (ciscorn)
+    - Fix (1242): Responses for CI header (yunstanford)
+    - Fix (1237): add version constraint for websockets (yunstanford)
+    - Fix (1231): memory leak - always release resource (Phillip Xu)
+    - Fix (1221): make request truthy if transport exists (Raphael Deem)
+    - Fix failing tests for aiohttp>=3.1.0 (Ashley Sommer)
+    - Fix try_everything examples (PyManiacGR, kot83)
+    - Fix (1158): default to auto_reload in debug mode (Raphael Deem)
+    - Fix (1136): ErrorHandler.response handler call too restrictive (Julien Castiaux)
+    - Fix: raw requires bytes-like object (cloudship)
+    - Fix (1120): passing a list in to a route decorator's host arg (Timothy Ebiuwhe)
+    - Fix: Bug in multipart/form-data parser (DirkGuijt)
+    - Fix: Exception for missing parameter when value is null (NyanKiyoshi)
+    - Fix: Parameter check (Howie Hu)
+    - Fix (1089): Routing issue with named parameters and different methods (yunstanford)
+    - Fix (1085): Signal handling in multi-worker mode (yunstanford)
+    - Fix: single quote in readme.rst (Cosven)
+    - Fix: method typos (Dmitry Dygalo)
+    - Fix: log_response correct output for ip and port (Wibowo Arindrarto)
+    - Fix (1042): Exception Handling (Raphael Deem)
+    - Fix: Chinese URIs (Howie Hu)
+    - Fix (1079): timeout bug when self.transport is None (Raphael Deem)
+    - Fix (1074): fix strict_slashes when route has slash (Raphael Deem)
+    - Fix (1050): add samesite cookie to cookie keys (Raphael Deem)
+    - Fix (1065): allow add_task after server starts (Raphael Deem)
+    - Fix (1061): double quotes in unauthorized exception (Raphael Deem)
+    - Fix (1062): inject the app in add_task method (Raphael Deem)
+    - Fix: update environment.yml for readthedocs (Eli Uriegas)
+    - Fix: Cancel request task when response timeout is triggered (Jeong YunWon)
+    - Fix (1052): Method not allowed response for RFC7231 compliance (Raphael Deem)
+    - Fix: IPv6 Address and Socket Data Format (Dan Palmer)
+
+Note: Changelog was unmaintained between 0.1 and 0.7
+
 Version 0.1
 -----------
  - 0.1.7
@@ -5,18 +118,18 @@ Version 0.1
  - 0.1.6
   - Static files
   - Lazy Cookie Loading
- - 0.1.5 
+ - 0.1.5
   - Cookies
   - Blueprint listeners and ordering
   - Faster Router
   - Fix: Incomplete file reads on medium+ sized post requests
   - Breaking: after_start and before_stop now pass sanic as their first argument
- - 0.1.4 
+ - 0.1.4
   - Multiprocessing
  - 0.1.3
   - Blueprint support
   - Faster Response processing
- - 0.1.1 - 0.1.2 
+ - 0.1.1 - 0.1.2
   - Struggling to update pypi via CI
- - 0.1.0 
-  - Released to public
+ - 0.1.0
+  - Released to public

CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sanic-maintainers@googlegroups.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing
+
+Thank you for your interest! Sanic is always looking for contributors. If you
+don't feel comfortable contributing code, adding docstrings to the source files
+is very appreciated.
+
+We are committed to providing a friendly, safe and welcoming environment for all,
+regardless of gender, sexual orientation, disability, ethnicity, religion,
+or similar personal characteristic.
+Our [code of conduct](./CONDUCT.md) sets the standards for behavior.
+
+## Installation
+
+To develop on sanic (and mainly to just run the tests) it is highly recommend to
+install from sources.
+
+So assume you have already cloned the repo and are in the working directory with
+a virtual environment already set up, then run:
+
+```bash
+pip3 install -e . "[.dev]"
+```
+
+# Dependency Changes
+
+`Sanic` doesn't use `requirements*.txt` files to manage any kind of dependencies related to it in order to simplify the
+effort required in managing the dependencies. Please make sure you have read and understood the following section of
+the document that explains the way `sanic` manages dependencies inside the `setup.py` file.
+
+| Dependency Type                           | Usage                                                                      | Installation                 |
+| ------------------------------------------| -------------------------------------------------------------------------- | ---------------------------  |
+| requirements                              | Bare minimum dependencies required for sanic to function                   | pip3 install -e .            |
+| tests_require / extras_require['test']    | Dependencies required to run the Unit Tests for `sanic`                    | pip3 install -e '[.test]'    |
+| extras_require['dev']                     | Additional Development requirements to add contributing                    | pip3 install -e '[.dev]'     |
+| extras_require['docs']                    | Dependencies required to enable building and enhancing sanic documentation | pip3 install -e '[.docs]'    |
+
+## Running 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. All pull requests must be consistent with the existing code.
+5. If you decide to remove/change anything from any common interface
+a deprecation message should accompany it.
+6. If you implement a new feature you should have at least one unit
+test to accompany it.
+7. An example must be one of the following:
+  * Example of how to use Sanic
+  * Example of how to use Sanic extensions
+  * Example of how to use Sanic and asynchronous library
+
+## Documentation
+
+Sanic's documentation is built
+using [sphinx](http://www.sphinx-doc.org/en/1.5.1/). Guides are written in
+Markdown and can be found in the `docs` folder, while the module reference is
+automatically generated using `sphinx-apidoc`.
+
+To generate the documentation from scratch:
+
+```bash
+sphinx-apidoc -fo docs/_api/ sanic
+sphinx-build -b html docs docs/_build
+```
+
+The HTML documentation will be created in the `docs/_build` folder.
+
+## Warning
+
+One of the main goals of Sanic is speed. Code that lowers the performance of
+Sanic without significant gains in usability, security, or features may not be
+merged. Please don't let this intimidate you! If you have any concerns about an
+idea, open an issue for discussion and help.

LICENSE

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

MANIFEST.in

@@ -0,0 +1,15 @@
+# Non Code related contents
+include LICENSE
+include README.rst
+include pyproject.toml
+
+# Setup
+include setup.py
+include Makefile
+
+# Tests
+include .coveragerc
+graft tests
+
+global-exclude __pycache__
+global-exclude *.py[co]

Makefile

@@ -0,0 +1,58 @@
+.PHONY: help test test-coverage install docker-test black fix-import beautify
+
+.DEFAULT: help
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "test"
+	@echo "		Run Sanic Unit Tests"
+	@echo "test-coverage"
+	@echo "		Run Sanic Unit Tests with Coverage"
+	@echo "install"
+	@echo "		Install Sanic"
+	@echo "docker-test"
+	@echo "		Run Sanic Unit Tests using Docker"
+	@echo "black"
+	@echo " 	Analyze and fix linting issues using Black"
+	@echo "fix-import"
+	@echo "		Analyze and fix import order using isort"
+	@echo "beautify [sort_imports=1] [include_tests=1]"
+	@echo " 	Analyze and fix linting issue using black and optionally fix import sort using isort"
+	@echo ""
+
+clean:
+	find . ! -path "./.eggs/*" -name "*.pyc" -exec rm {} \;
+	find . ! -path "./.eggs/*" -name "*.pyo" -exec rm {} \;
+	find . ! -path "./.eggs/*" -name ".coverage" -exec rm {} \;
+	rm -rf build/* > /dev/null 2>&1
+	rm -rf dist/* > /dev/null 2>&1
+
+test: clean
+	python setup.py test
+
+test-coverage: clean
+	python setup.py test --pytest-args="--cov sanic --cov-report term --cov-append "
+
+install:
+	python setup.py install
+
+docker-test: clean
+	docker build -t sanic/test-image -f docker/Dockerfile .
+	docker run -t sanic/test-image tox
+
+beautify: black
+ifdef sort_imports
+ifdef include_tests
+	$(warning It is suggested that you do not run sort import on tests)
+	isort -rc sanic tests
+else
+	$(info Sorting Imports)
+	isort -rc sanic
+endif
+endif
+
+black:
+	black --config ./pyproject.toml sanic tests
+
+fix-import: black
+	isort -rc sanic

README.rst

@@ -1,41 +1,71 @@
-Sanic
-=================================
+.. image:: https://raw.githubusercontent.com/huge-success/sanic-assets/master/png/sanic-framework-logo-400x97.png
+    :alt: Sanic | Build fast. Run fast.
 
-|Join the chat at https://gitter.im/sanic-python/Lobby| |Build Status| |PyPI| |PyPI version|
+Sanic | Build fast. Run fast.
+=============================
 
-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/>`_.
+.. start-badges
 
-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.
+.. list-table::
+    :stub-columns: 1
 
-Sanic is developed `on GitHub <https://github.com/channelcat/sanic/>`_. Contributions are welcome!
+    * - Build
+      - | |Build Status| |AppVeyor Build Status| |Codecov|
+    * - Docs
+      - |Documentation|
+    * - Package
+      - | |PyPI| |PyPI version| |Wheel| |Supported implementations| |Code style black|
+    * - Support
+      - | |Forums| |Join the chat at https://gitter.im/sanic-python/Lobby|
 
-Benchmarks
-----------
+.. |Forums| image:: https://img.shields.io/badge/forums-community-ff0068.svg
+   :target: https://community.sanicframework.org/
+.. |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
+.. |Codecov| image:: https://codecov.io/gh/huge-success/sanic/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/huge-success/sanic
+.. |Build Status| image:: https://travis-ci.org/huge-success/sanic.svg?branch=master
+   :target: https://travis-ci.org/huge-success/sanic
+.. |AppVeyor Build Status| image:: https://ci.appveyor.com/api/projects/status/d8pt3ids0ynexi8c/branch/master?svg=true
+   :target: https://ci.appveyor.com/project/huge-success/sanic
+.. |Documentation| image:: https://readthedocs.org/projects/sanic/badge/?version=latest
+   :target: http://sanic.readthedocs.io/en/latest/?badge=latest
+.. |PyPI| image:: https://img.shields.io/pypi/v/sanic.svg
+   :target: https://pypi.python.org/pypi/sanic/
+.. |PyPI version| image:: https://img.shields.io/pypi/pyversions/sanic.svg
+   :target: https://pypi.python.org/pypi/sanic/
+.. |Code style black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/ambv/black
+.. |Wheel| image:: https://img.shields.io/pypi/wheel/sanic.svg
+    :alt: PyPI Wheel
+    :target: https://pypi.python.org/pypi/sanic
+.. |Supported implementations| image:: https://img.shields.io/pypi/implementation/sanic.svg
+    :alt: Supported implementations
+    :target: https://pypi.python.org/pypi/sanic
 
-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.
+.. end-badges
+
+Sanic is a Python web server and web framework that's written to go fast. It allows the usage of the ``async/await`` syntax added in Python 3.5, which makes your code non-blocking and speedy.
+
+`Source code on GitHub <https://github.com/huge-success/sanic/>`_ | `Help and discussion board <https://community.sanicframework.org/>`_. 
+
+The project is maintained by the community, for the community **Contributions are welcome!**
+
+The goal of the project is to provide a simple way to get up and running a highly performant HTTP server that is easy to build, to expand, and ultimately to scale.
+
+Installation
+------------
+
+``pip3 install sanic``
+
+    Sanic makes use of ``uvloop`` and ``ujson`` to help with performance. If you do not want to use those packages, simply add an environmental variable ``SANIC_NO_UVLOOP=true`` or ``SANIC_NO_UJSON=true`` at install time.
+    
+    .. code:: shell
+    
+       $ export SANIC_NO_UVLOOP=true
+       $ export SANIC_NO_UJSON=true 
+       $ pip3 install sanic
 
-+-----------+-----------------------+----------------+---------------+
-| 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
 -------------------
@@ -47,63 +77,52 @@ Hello World Example
 
     app = Sanic()
 
-    @app.route("/")
+    @app.route('/')
     async def test(request):
-        return json({"hello": "world"})
+        return json({'hello': 'world'})
 
-    if __name__ == "__main__":
-        app.run(host="0.0.0.0", port=8000)
+    if __name__ == '__main__':
+        app.run(host='0.0.0.0', port=8000)
+        
+Sanic can now be easily run using ``python3 hello.py``.
 
-Installation
-------------
+.. code::
+
+    [2018-12-30 11:37:41 +0200] [13564] [INFO] Goin' Fast @ http://0.0.0.0:8000
+    [2018-12-30 11:37:41 +0200] [13564] [INFO] Starting worker [13564]
+
+And, we can verify it is working: ``curl localhost:8000 -i``
+
+.. code::
+
+    HTTP/1.1 200 OK
+    Connection: keep-alive
+    Keep-Alive: 5
+    Content-Length: 17
+    Content-Type: application/json
+
+    {"hello":"world"}
+    
+**Now, let's go build something fast!**
 
--  ``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/
+Changelog
+---------
 
-TODO
-----
-* Streamed file processing
-* http2
-Limitations
------------
-* No wheels for uvloop and httptools on Windows :(
+`Release Changelogs <https://github.com/huge-success/sanic/blob/master/CHANGELOG.md>`_.
 
-Final Thoughts
---------------
+   
+Questions and Discussion
+------------------------
 
-::
+`Ask a question or join the conversation <https://community.sanicframework.org/>`_.
 
-                     ▄▄▄▄▄
-            ▀▀▀██████▄▄▄       _______________
-          ▄▄▄▄▄  █████████▄  /                 \
-         ▀▀▀▀█████▌ ▀▐▄ ▀▐█ |   Gotta go fast!  |
-       ▀▀█████▄▄ ▀██████▄██ | _________________/
-       ▀▄▄▄▄▄  ▀▀█▄▀█════█▀ |/
-            ▀▀▀▄  ▀▀███ ▀       ▄▄
-         ▄███▀▀██▄████████▄ ▄▀▀▀▀▀▀█▌
-       ██▀▄▄▄██▀▄███▀ ▀▀████      ▄██
-    ▄▀▀▀▄██▄▀▀▌████▒▒▒▒▒▒███     ▌▄▄▀
-    ▌    ▐▀████▐███▒▒▒▒▒▐██▌
-    ▀▄▄▄▄▀   ▀▀████▒▒▒▒▄██▀
-              ▀▀█████████▀
-            ▄▄██▀██████▀█
-          ▄██▀     ▀▀▀  █
-         ▄█             ▐▌
-     ▄▄▄▄█▌              ▀█▄▄▄▄▀▀▄
-    ▌     ▐                ▀▀▄▄▄▀
-     ▀▀▄▄▀
+Contribution
+------------
+
+We are always happy to have new contributions. We have `marked issues good for anyone looking to get started <https://github.com/huge-success/sanic/issues?q=is%3Aopen+is%3Aissue+label%3Abeginner>`_, and welcome `questions on the forums <https://community.sanicframework.org/>`_. Please take a look at our `Contribution guidelines <https://github.com/huge-success/sanic/blob/master/CONTRIBUTING.md>`_.

docker/Dockerfile

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

docker/bin/entrypoint.sh

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

docker/bin/install_python.sh

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

docs/Makefile

@@ -1,20 +1,225 @@
-# Minimal makefile for Sphinx documentation
+# Makefile for Sphinx documentation
 #
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = Sanic
-SOURCEDIR     = .
+PAPER         =
 BUILDDIR      = _build
 
-# Put it first so that "make" without argument is like "make help".
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help
 help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  epub3      to make an epub3"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+	@echo "  dummy      to check syntax errors of document sources"
 
-.PHONY: help Makefile
+.PHONY: clean
+clean:
+	rm -rf $(BUILDDIR)/*
 
-# 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)
+.PHONY: html
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+.PHONY: qthelp
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/aiographite.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/aiographite.qhc"
+
+.PHONY: applehelp
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+.PHONY: devhelp
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/aiographite"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/aiographite"
+	@echo "# devhelp"
+
+.PHONY: epub
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: epub3
+epub3:
+	$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+	@echo
+	@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: latex
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+.PHONY: latexpdf
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: latexpdfja
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+.PHONY: info
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+.PHONY: gettext
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+.PHONY: doctest
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+.PHONY: dummy
+dummy:
+	$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
+	@echo
+	@echo "Build finished. Dummy builder generates no files."

docs/conf.py

@@ -13,6 +13,9 @@ import sys
 # Add support for Markdown documentation using Recommonmark
 from recommonmark.parser import CommonMarkParser
 
+# Add support for auto-doc
+from recommonmark.transform import AutoStructify
+
 # Ensure that sanic is present in the path, to allow sphinx-apidoc to
 # autogenerate documentation from docstrings
 root_directory = os.path.dirname(os.getcwd())
@@ -22,7 +25,7 @@ import sanic
 
 # -- General configuration ------------------------------------------------
 
-extensions = []
+extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.asyncio']
 
 templates_path = ['_templates']
 
@@ -35,7 +38,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'Sanic'
-copyright = '2016, Sanic contributors'
+copyright = '2018, Sanic contributors'
 author = 'Sanic contributors'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -68,7 +71,6 @@ 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
@@ -80,13 +82,11 @@ html_theme = 'sphinx_rtd_theme'
 # 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 = {
@@ -110,21 +110,14 @@ latex_elements = {
 # 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'),
-]
-
+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)
-]
-
+man_pages = [(master_doc, 'sanic', 'Sanic Documentation', [author], 1)]
 
 # -- Options for Texinfo output -------------------------------------------
 
@@ -132,13 +125,10 @@ man_pages = [
 # (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'),
+    (master_doc, 'Sanic', 'Sanic Documentation', author, 'Sanic',
+     'One line description of project.', 'Miscellaneous'),
 ]
 
-
-
 # -- Options for Epub output ----------------------------------------------
 
 # Bibliographic Dublin Core info.
@@ -150,8 +140,15 @@ 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']
+
+
+# app setup hook
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        'enable_eval_rst': True,
+        'enable_auto_doc_ref': True,
+    }, True)
+    app.add_transform(AutoStructify)

docs/config.md

@@ -1,78 +0,0 @@
-# Configuration
-
-Any reasonably complex application will need configuration that is not baked into the acutal 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 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) |
-

docs/index.rst

@@ -7,21 +7,33 @@ Guides
    :maxdepth: 2
 
    sanic/getting_started
-   sanic/routing
+   sanic/config
+   sanic/logging
    sanic/request_data
+   sanic/response
+   sanic/cookies
+   sanic/routing
+   sanic/blueprints
    sanic/static_files
+   sanic/versioning
    sanic/exceptions
    sanic/middleware
-   sanic/blueprints
-   sanic/config
-   sanic/cookies
+   sanic/websocket
+   sanic/decorators
+   sanic/streaming
    sanic/class_based_views
    sanic/custom_protocol
+   sanic/sockets
    sanic/ssl
+   sanic/debug_mode
    sanic/testing
    sanic/deploying
    sanic/extensions
+   sanic/examples
+   sanic/changelog
    sanic/contributing
+   sanic/api_reference
+   sanic/asyncio_python37
 
 
 Module Documentation
@@ -30,4 +42,5 @@ Module Documentation
 .. toctree::
 
 * :ref:`genindex`
+* :ref:`modindex`
 * :ref:`search`

docs/make.bat

@@ -1,19 +1,64 @@
 @ECHO OFF
 
-pushd %~dp0
-
 REM Command file for Sphinx documentation
 
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
 set BUILDDIR=_build
-set SPHINXPROJ=Sanic
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
 
 if "%1" == "" goto help
 
-%SPHINXBUILD% >NUL 2>NUL
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  epub3      to make an epub3
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  xml        to make Docutils-native XML files
+	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	echo.  coverage   to run coverage check of the documentation if enabled
+	echo.  dummy      to check syntax errors of document sources
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+
+REM Check if sphinx-build is available and fallback to Python version if any
+%SPHINXBUILD% 1>NUL 2>NUL
+if errorlevel 9009 goto sphinx_python
+goto sphinx_ok
+
+:sphinx_python
+
+set SPHINXBUILD=python -m sphinx.__init__
+%SPHINXBUILD% 2> nul
 if errorlevel 9009 (
 	echo.
 	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
@@ -26,11 +71,211 @@ if errorlevel 9009 (
 	exit /b 1
 )
 
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-goto end
+:sphinx_ok
 
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\aiographite.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\aiographite.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "epub3" (
+	%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdf" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf
+	cd %~dp0
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdfja" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf-ja
+	cd %~dp0
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+if "%1" == "coverage" (
+	%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of coverage in the sources finished, look at the ^
+results in %BUILDDIR%/coverage/python.txt.
+	goto end
+)
+
+if "%1" == "xml" (
+	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The XML files are in %BUILDDIR%/xml.
+	goto end
+)
+
+if "%1" == "pseudoxml" (
+	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+	goto end
+)
+
+if "%1" == "dummy" (
+	%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. Dummy builder generates no files.
+	goto end
+)
 
 :end
-popd

docs/sanic/api_reference.rst

@@ -0,0 +1,159 @@
+API Reference
+=============
+
+Submodules
+----------
+
+sanic.app module
+----------------
+
+.. automodule:: sanic.app
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.blueprints module
+-----------------------
+
+.. automodule:: sanic.blueprints
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.blueprint_group module
+----------------------------
+
+.. automodule:: sanic.blueprint_group
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+sanic.config module
+-------------------
+
+.. automodule:: sanic.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.constants module
+----------------------
+
+.. automodule:: sanic.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.cookies module
+--------------------
+
+.. automodule:: sanic.cookies
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.exceptions module
+-----------------------
+
+.. automodule:: sanic.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.handlers module
+---------------------
+
+.. automodule:: sanic.handlers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.log module
+----------------
+
+.. automodule:: sanic.log
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.request module
+--------------------
+
+.. automodule:: sanic.request
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.response module
+---------------------
+
+.. automodule:: sanic.response
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.router module
+-------------------
+
+.. automodule:: sanic.router
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.server module
+-------------------
+
+.. automodule:: sanic.server
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.static module
+-------------------
+
+.. automodule:: sanic.static
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.testing module
+--------------------
+
+.. automodule:: sanic.testing
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.views module
+------------------
+
+.. automodule:: sanic.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.websocket module
+----------------------
+
+.. automodule:: sanic.websocket
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+sanic.worker module
+-------------------
+
+.. automodule:: sanic.worker
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: sanic
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/sanic/asyncio_python37.rst

@@ -0,0 +1,58 @@
+Python 3.7 AsyncIO examples
+###########################
+
+With Python 3.7 AsyncIO got major update for the following types:
+
+ - asyncio.AbstractEventLoop
+ - asyncio.AnstractServer
+
+
+This example shows how to use sanic with Python 3.7, to be precise: how to retrieve an asyncio server instance:
+
+.. code:: python
+
+    import asyncio
+    import socket
+    import os
+
+    from sanic import Sanic
+    from sanic.response import json
+
+    app = Sanic(__name__)
+
+
+    @app.route("/")
+    async def test(request):
+        return json({"hello": "world"})
+
+
+    server_socket = '/tmp/sanic.sock'
+
+    sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+
+    try:
+        os.remove(server_socket)
+    finally:
+        sock.bind(server_socket)
+
+    if __name__ == "__main__":
+        loop = asyncio.get_event_loop()
+        srv_coro = app.create_server(
+            sock=sock,
+            return_asyncio_server=True,
+            asyncio_server_kwargs=dict(
+                start_serving=False
+            )
+        )
+        srv = loop.run_until_complete(srv_coro)
+        try:
+            assert srv.is_serving() is False
+            loop.run_until_complete(srv.start_serving())
+            assert srv.is_serving() is True
+            loop.run_until_complete(srv.serve_forever())
+        except KeyboardInterrupt:
+            srv.close()
+            loop.close()
+
+
+Please note that uvloop does not support these features yet.

docs/sanic/blueprints.md

@@ -48,20 +48,92 @@ by that blueprint. In this example, the registered routes in the `app.router`
 will look like:
 
 ```python
-[Route(handler=<function bp_root at 0x7f908382f9d8>, methods=None, pattern=re.compile('^/$'), parameters=[])]
+[Route(handler=<function bp_root at 0x7f908382f9d8>, methods=frozenset({'GET'}), pattern=re.compile('^/$'), parameters=[], name='my_blueprint.bp_root', uri='/')]
 ```
 
-## Using blueprints
+## Blueprint groups and nesting
 
-Blueprints have much the same functionality as an application instance.
+Blueprints may also be registered as part of a list or tuple, where the registrar will recursively cycle through any sub-sequences of blueprints and register them accordingly. The `Blueprint.group` method is provided to simplify this process, allowing a 'mock' backend directory structure mimicking what's seen from the front end. Consider this (quite contrived) example:
 
-### Middleware
+```
+api/
+├──content/
+│  ├──authors.py
+│  ├──static.py
+│  └──__init__.py
+├──info.py
+└──__init__.py
+app.py
+```
+
+Initialization of this app's blueprint hierarchy could go as follows:
+
+```python
+# api/content/authors.py
+from sanic import Blueprint
+
+authors = Blueprint('content_authors', url_prefix='/authors')
+```
+```python
+# api/content/static.py
+from sanic import Blueprint
+
+static = Blueprint('content_static', url_prefix='/static')
+```
+```python
+# api/content/__init__.py
+from sanic import Blueprint
+
+from .static import static
+from .authors import authors
+
+content = Blueprint.group(static, authors, url_prefix='/content')
+```
+```python
+# api/info.py
+from sanic import Blueprint
+
+info = Blueprint('info', url_prefix='/info')
+```
+```python
+# api/__init__.py
+from sanic import Blueprint
+
+from .content import content
+from .info import info
+
+api = Blueprint.group(content, info, url_prefix='/api')
+```
+
+And registering these blueprints in `app.py` can now be done like so:
+
+```python
+# app.py
+from sanic import Sanic
+
+from .api import api
+
+app = Sanic(__name__)
+
+app.blueprint(api)
+```
+
+## Using Blueprints
+
+Blueprints have almost the same functionality as an application instance.
+
+### WebSocket routes
+
+WebSocket handlers can be registered on a blueprint using the `@bp.websocket`
+decorator or `bp.add_websocket_route` method.
+
+### Blueprint Middleware
 
 Using blueprints allows you to also register middleware globally.
 
 ```python
 @bp.middleware
-async def halt_request(request):
+async def print_on_request(request):
 	print("I am a spy")
 
 @bp.middleware('request')
@@ -73,6 +145,36 @@ async def halt_response(request, response):
 	return text('I halted the response')
 ```
 
+### Blueprint Group Middleware
+Using this middleware will ensure that you can apply a common middleware to all the blueprints that form the
+current blueprint group under consideration.
+
+```python
+bp1 = Blueprint('bp1', url_prefix='/bp1')
+bp2 = Blueprint('bp2', url_prefix='/bp2')
+
+@bp1.middleware('request')
+async def bp1_only_middleware(request):
+    print('applied on Blueprint : bp1 Only')
+
+@bp1.route('/')
+async def bp1_route(request):
+    return text('bp1')
+
+@bp2.route('/<param>')
+async def bp2_route(request, param):
+    return text(param)
+
+group = Blueprint.group(bp1, bp2)
+
+@group.middleware('request')
+async def group_middleware(request):
+    print('common middleware applied for both bp1 and bp2')
+    
+# Register Blueprint group under the app
+app.blueprint(group)
+```
+
 ### Exceptions
 
 Exceptions can be applied exclusively to blueprints globally.
@@ -88,7 +190,14 @@ def ignore_404s(request, exception):
 Static files can be served globally, under the blueprint prefix.
 
 ```python
-bp.static('/folder/to/serve', '/web/path')
+
+# suppose bp.name == 'bp'
+
+bp.static('/web/path', '/folder/to/serve')
+# also you can pass name parameter to it for url_for
+bp.static('/web/path', '/folder/to/server', name='uploads')
+app.url_for('static', name='bp.uploads', filename='file.txt') == '/bp/web/path/file.txt'
+
 ```
 
 ## Start and stop
@@ -111,7 +220,7 @@ bp = Blueprint('my_blueprint')
 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()
@@ -122,7 +231,7 @@ async def close_connection(app, loop):
 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,
+When a blueprint is initialised, it can take an optional `version` argument,
 which will be prepended to all routes defined on the blueprint. This feature
 can be used to implement our API versioning scheme.
 
@@ -131,19 +240,19 @@ can be used to implement our API versioning scheme.
 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 = Blueprint('v1', url_prefix='/api', version="v1")
+blueprint_v2 = Blueprint('v2', url_prefix='/api', version="v2")
 
 @blueprint_v1.route('/')
 async def api_v1_root(request):
     return text('Welcome to version 1 of our documentation')
-    
+
 @blueprint_v2.route('/')
 async def api_v2_root(request):
     return text('Welcome to version 2 of our documentation')
 ```
 
-When we register our blueprints on the app, the routes `/v1` and `/v2` will now
+When we register our blueprints on the app, the routes `/v1/api` and `/v2/api` will now
 point to the individual blueprints, which allows the creation of *sub-sites*
 for each API version.
 
@@ -153,8 +262,8 @@ 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.blueprint(blueprint_v1)
+app.blueprint(blueprint_v2)
 
 app.run(host='0.0.0.0', port=8000, debug=True)
 ```
@@ -164,10 +273,10 @@ app.run(host='0.0.0.0', port=8000, debug=True)
 If you wish to generate a URL for a route inside of a blueprint, remember that the endpoint name
 takes the format `<blueprint_name>.<handler_name>`. For example:
 
-```
+```python
 @blueprint_v1.route('/')
 async def root(request):
-    url = app.url_for('v1.post_handler', post_id=5) # --> '/v1/post/5'
+    url = request.app.url_for('v1.post_handler', post_id=5) # --> '/v1/api/post/5'
     return redirect(url)
 
 
@@ -175,5 +284,3 @@ async def root(request):
 async def post_handler(request, post_id):
     return text('Post {} in Blueprint V1'.format(post_id))
 ```
-
-

docs/sanic/changelog.md

@@ -0,0 +1,135 @@
+Version 18.12
+-------------
+18.12.0
+  - Changes:
+    - Improved codebase test coverage from 81% to 91%.
+    - Added stream_large_files and host examples in static_file document
+    - Added methods to append and finish body content on Request (#1379)
+    - Integrated with .appveyor.yml for windows ci support
+    - Added documentation for AF_INET6 and AF_UNIX socket usage
+    - Adopt black/isort for codestyle
+    - Cancel task when connection_lost
+    - Simplify request ip and port retrieval logic
+    - Handle config error in load config file.
+    - Integrate with codecov for CI
+    - Add missed documentation for config section.
+    - Deprecate Handler.log
+    - Pinned httptools requirement to version 0.0.10+
+
+  - Fixes:
+    - Fix `remove_entity_headers` helper function (#1415)
+    - Fix TypeError when use Blueprint.group() to group blueprint with default url_prefix, Use os.path.normpath to avoid invalid url_prefix like api//v1
+    f8a6af1 Rename the `http` module to `helpers` to prevent conflicts with the built-in Python http library (fixes #1323)
+    - Fix unittests on windows
+    - Fix Namespacing of sanic logger
+    - Fix missing quotes in decorator example
+    - Fix redirect with quoted param
+    - Fix doc for latest blueprint code
+    - Fix build of latex documentation relating to markdown lists
+    - Fix loop exception handling in app.py
+    - Fix content length mismatch in windows and other platform
+    - Fix Range header handling for static files (#1402)
+    - Fix the logger and make it work (#1397)
+    - Fix type pikcle->pickle in multiprocessing test
+    - Fix pickling blueprints Change the string passed in the "name" section of the namedtuples in Blueprint to match the name of the Blueprint module attribute name. This allows blueprints to be pickled and unpickled, without errors, which is a requirment of running Sanic in multiprocessing mode in Windows. Added a test for pickling and unpickling blueprints Added a test for pickling and unpickling sanic itself Added a test for enabling multiprocessing on an app with a blueprint (only useful to catch this bug if the tests are run on Windows).
+    - Fix document for logging
+
+Version 0.8
+-----------
+0.8.3
+  - Changes:
+    - Ownership changed to org 'huge-success'
+
+0.8.0
+  - Changes:
+    - Add Server-Sent Events extension (Innokenty Lebedev)
+    - Graceful handling of request_handler_task cancellation (Ashley Sommer)
+    - Sanitize URL before redirection (aveao)
+    - Add url_bytes to request (johndoe46)
+    - py37 support for travisci (yunstanford)
+    - Auto reloader support for OSX (garyo)
+    - Add UUID route support (Volodymyr Maksymiv)
+    - Add pausable response streams (Ashley Sommer)
+    - Add weakref to request slots (vopankov)
+    - remove ubuntu 12.04 from test fixture due to deprecation (yunstanford)
+    - Allow streaming handlers in add_route (kinware)
+    - use travis_retry for tox (Raphael Deem)
+    - update aiohttp version for test client (yunstanford)
+    - add redirect import for clarity (yingshaoxo)
+    - Update HTTP Entity headers (Arnulfo Solís)
+    - Add register_listener method (Stephan Fitzpatrick)
+    - Remove uvloop/ujson dependencies for Windows (abuckenheimer)
+    - Content-length header on 204/304 responses (Arnulfo Solís)
+    - Extend WebSocketProtocol arguments and add docs (Bob Olde Hampsink, yunstanford)
+    - Update development status from pre-alpha to beta (Maksim Anisenkov)
+    - KeepAlive Timout log level changed to debug (Arnulfo Solís)
+    - Pin pytest to 3.3.2 because of pytest-dev/pytest#3170 (Maksim Aniskenov)
+    - Install Python 3.5 and 3.6 on docker container for tests (Shahin Azad)
+    - Add support for blueprint groups and nesting (Elias Tarhini)
+    - Remove uvloop for windows setup (Aleksandr Kurlov)
+    - Auto Reload (Yaser Amari)
+    - Documentation updates/fixups (multiple contributors)
+
+  - Fixes:
+    - Fix: auto_reload in Linux (Ashley Sommer)
+    - Fix: broken tests for aiohttp >= 3.3.0 (Ashley Sommer)
+    - Fix: disable auto_reload by default on windows (abuckenheimer)
+    - Fix (1143): Turn off access log with gunicorn (hqy)
+    - Fix (1268): Support status code for file response (Cosmo Borsky)
+    - Fix (1266): Add content_type flag to Sanic.static (Cosmo Borsky)
+    - Fix: subprotocols parameter missing from add_websocket_route (ciscorn)
+    - Fix (1242): Responses for CI header (yunstanford)
+    - Fix (1237): add version constraint for websockets (yunstanford)
+    - Fix (1231): memory leak - always release resource (Phillip Xu)
+    - Fix (1221): make request truthy if transport exists (Raphael Deem)
+    - Fix failing tests for aiohttp>=3.1.0 (Ashley Sommer)
+    - Fix try_everything examples (PyManiacGR, kot83)
+    - Fix (1158): default to auto_reload in debug mode (Raphael Deem)
+    - Fix (1136): ErrorHandler.response handler call too restrictive (Julien Castiaux)
+    - Fix: raw requires bytes-like object (cloudship)
+    - Fix (1120): passing a list in to a route decorator's host arg (Timothy Ebiuwhe)
+    - Fix: Bug in multipart/form-data parser (DirkGuijt)
+    - Fix: Exception for missing parameter when value is null (NyanKiyoshi)
+    - Fix: Parameter check (Howie Hu)
+    - Fix (1089): Routing issue with named parameters and different methods (yunstanford)
+    - Fix (1085): Signal handling in multi-worker mode (yunstanford)
+    - Fix: single quote in readme.rst (Cosven)
+    - Fix: method typos (Dmitry Dygalo)
+    - Fix: log_response correct output for ip and port (Wibowo Arindrarto)
+    - Fix (1042): Exception Handling (Raphael Deem)
+    - Fix: Chinese URIs (Howie Hu)
+    - Fix (1079): timeout bug when self.transport is None (Raphael Deem)
+    - Fix (1074): fix strict_slashes when route has slash (Raphael Deem)
+    - Fix (1050): add samesite cookie to cookie keys (Raphael Deem)
+    - Fix (1065): allow add_task after server starts (Raphael Deem)
+    - Fix (1061): double quotes in unauthorized exception (Raphael Deem)
+    - Fix (1062): inject the app in add_task method (Raphael Deem)
+    - Fix: update environment.yml for readthedocs (Eli Uriegas)
+    - Fix: Cancel request task when response timeout is triggered (Jeong YunWon)
+    - Fix (1052): Method not allowed response for RFC7231 compliance (Raphael Deem)
+    - Fix: IPv6 Address and Socket Data Format (Dan Palmer)
+
+Note: Changelog was unmaintained between 0.1 and 0.7
+
+Version 0.1
+-----------
+ - 0.1.7
+  - Reversed static url and directory arguments to meet spec
+ - 0.1.6
+  - Static files
+  - Lazy Cookie Loading
+ - 0.1.5
+  - Cookies
+  - Blueprint listeners and ordering
+  - Faster Router
+  - Fix: Incomplete file reads on medium+ sized post requests
+  - Breaking: after_start and before_stop now pass sanic as their first argument
+ - 0.1.4
+  - Multiprocessing
+ - 0.1.3
+  - Blueprint support
+  - Faster Response processing
+ - 0.1.1 - 0.1.2
+  - Struggling to update pypi via CI
+ - 0.1.0
+  - Released to public

docs/sanic/class_based_views.md

@@ -48,6 +48,24 @@ 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
@@ -74,10 +92,27 @@ class ViewWithDecorator(HTTPMethodView):
   def get(self, request, name):
     return text('Hello I have a decorator')
 
+  def post(self, request, name):
+    return text("Hello I also have a decorator")
+
 app.add_route(ViewWithDecorator.as_view(), '/url')
 ```
 
-#### URL Building
+But if you just want to decorate some functions and not all functions, you can do as follows:
+
+```python
+class ViewWithSomeDecorator(HTTPMethodView):
+
+    @staticmethod
+    @some_decorator_here
+    def get(request, name):
+        return text("Hello I have a decorator")
+
+    def post(self, request, name):
+        return text("Hello I don't have any decorators")
+```
+
+## URL Building
 
 If you wish to build a URL for an HTTPMethodView, remember that the class name will be the endpoint
 that you will pass into `url_for`. For example:
@@ -128,4 +163,4 @@ view.add(['POST', 'PUT'], lambda request: text('I am a post/put method'))
 app.add_route(view, '/')
 ```
 
-Note: currently you cannot build a URL for a CompositionView using `url_for`. 
+Note: currently you cannot build a URL for a CompositionView using `url_for`.

docs/sanic/config.md

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

docs/sanic/contributing.md

@@ -1,33 +0,0 @@
-# Contributing
-
-Thank you for your interest! Sanic is always looking for contributors. If you
-don't feel comfortable contributing code, adding docstrings to the source files
-is very appreciated.
-
-## Running tests
-
-* `python -m pip install pytest`
-* `python -m pytest tests`
-
-## 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/contributing.rst

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

docs/sanic/cookies.md

@@ -1,75 +0,0 @@
-# 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 `Request` object's `cookie` 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/cookies.rst

@@ -0,0 +1,87 @@
+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.
+
+.. warning::
+
+    Cookies can be freely altered by the client. Therefore you cannot just store
+    data such as login information in cookies as-is, as they can be freely altered
+    by the client. To ensure data you store in cookies is not forged or tampered
+    with by the client, use something like `itsdangerous`_ to cryptographically
+    sign the data.
+
+
+Reading cookies
+---------------
+
+A user's cookies can be accessed via the ``Request`` object's ``cookies`` dictionary.
+
+.. code-block:: 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.
+
+.. code-block:: 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.
+
+.. code-block:: 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.
+
+.. _itsdangerous: https://pythonhosted.org/itsdangerous/

docs/sanic/custom_protocol.md

@@ -1,72 +0,0 @@
-# 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/custom_protocol.rst

@@ -0,0 +1,76 @@
+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``.
+
+.. code:: 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/debug_mode.rst

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

docs/sanic/decorators.md

@@ -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

@@ -15,6 +15,7 @@ keyword arguments:
 - `protocol` *(default `HttpProtocol`)*: Subclass
   of
   [asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.html#protocol-classes).
+- `access_log` *(default `True`)*: Enables log on handling requests (significantly slows server).
 
 ## Workers
 
@@ -44,3 +45,55 @@ directly run by the interpreter.
 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 myapp:app --bind 0.0.0.0:1337 --worker-class sanic.worker.GunicornWorker
+```
+
+If your application suffers from memory leaks, you can configure Gunicorn to gracefully restart a worker
+after it has processed a given number of requests. This can be a convenient way to help limit the effects
+of the memory leak.
+
+See the [Gunicorn Docs](http://docs.gunicorn.org/en/latest/settings.html#max-requests) for more information.
+
+## Disable debug logging
+
+To improve the performance add `debug=False` and `access_log=False` in the `run` arguments.
+
+```python
+app.run(host='0.0.0.0', port=1337, workers=4, debug=False, access_log=False)
+```
+
+Running via Gunicorn you can set Environment variable `SANIC_ACCESS_LOG="False"`
+
+```
+env SANIC_ACCESS_LOG="False" gunicorn myapp:app --bind 0.0.0.0:1337 --worker-class sanic.worker.GunicornWorker --log-level warning
+```
+
+Or you can rewrite app config directly
+
+```python
+app.config.ACCESS_LOG = False
+```
+
+## Asynchronous support
+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/examples.rst

@@ -0,0 +1,167 @@
+Examples
+========
+
+This section of the documentation is a simple collection of example code that can help you get a quick start
+on your application development. Most of these examples are categorized and provide you with a link to the
+working code example in the `Sanic Repository <https://github.com/huge-success/sanic/tree/master/examples>`_
+
+
+Basic Examples
+--------------
+
+This section of the examples are a collection of code that provide a simple use case example of the sanic application.
+
+Simple Apps
+~~~~~~~~~~~~
+
+A simple sanic application with a single ``async`` method with ``text`` and ``json`` type response.
+
+
+.. literalinclude:: ../../examples/teapot.py
+
+.. literalinclude:: ../../examples/simple_server.py
+
+
+Simple App with ``Sanic Views``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Showcasing the simple mechanism of using :class:`sanic.viewes.HTTPMethodView` as well as a way to extend the same
+into providing a custom ``async`` behavior for ``view``.
+
+.. literalinclude:: ../../examples/simple_async_view.py
+
+
+URL Redirect
+~~~~~~~~~~~~
+
+.. literalinclude:: ../../examples/redirect_example.py
+
+
+Named URL redirection
+~~~~~~~~~~~~~~~~~~~~~
+
+``Sanic`` provides an easy to use way of redirecting the requests via a helper method called ``url_for`` that takes a
+unique url name as argument and returns you the actual route assigned for it. This will help in simplifying the
+efforts required in redirecting the user between different section of the application.
+
+.. literalinclude:: ../../examples/url_for_example.py
+
+Blueprints
+~~~~~~~~~~
+``Sanic`` provides an amazing feature to group your APIs and routes under a logical collection that can easily be
+imported and plugged into any of your sanic application and it's called ``blueprints``
+
+.. literalinclude:: ../../examples/blueprints.py
+
+Logging Enhancements
+~~~~~~~~~~~~~~~~~~~~
+
+Even though ``Sanic`` comes with a battery of Logging support it allows the end users to customize the way logging
+is handled in the application runtime.
+
+.. literalinclude:: ../../examples/override_logging.py
+
+The following sample provides an example code that demonstrates the usage of :func:`sanic.app.Sanic.middleware` in order
+to provide a mechanism to assign a unique request ID for each of the incoming requests and log them via
+`aiotask-context <https://github.com/Skyscanner/aiotask-context>`_.
+
+
+.. literalinclude:: ../../examples/log_request_id.py
+
+Sanic Streaming Support
+~~~~~~~~~~~~~~~~~~~~~~~
+
+``Sanic`` framework comes with in-built support for streaming large files and the following code explains the process
+to setup a ``Sanic`` application with streaming support.
+
+.. literalinclude:: ../../examples/request_stream/server.py
+
+Sample Client app to show the usage of streaming application by a client code.
+
+.. literalinclude:: ../../examples/request_stream/client.py
+
+Sanic Concurrency Support
+~~~~~~~~~~~~~~~~~~~~~~~~~
+``Sanic`` supports the ability to start an app with multiple worker support. However, it's important to be able to limit
+the concurrency per process/loop in order to ensure an efficient execution. The following section of the code provides a
+brief example of how to limit the concurrency with the help of :class:`asyncio.Semaphore`
+
+.. literalinclude:: ../../examples/limit_concurrency.py
+
+
+Sanic Deployment via Docker
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Deploying a ``sanic`` app via ``docker`` and ``docker-compose`` is an easy task to achieve and the following example
+provides a deployment of the sample ``simple_server.py``
+
+.. literalinclude:: ../../examples/Dockerfile
+
+.. literalinclude:: ../../examples/docker-compose.yml
+
+
+Monitoring and Error Handling
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``Sanic`` provides an extendable bare minimum implementation of a global exception handler via
+:class:`sanic.handlers.ErrorHandler`. This example shows how to extend it to enable some custom behaviors.
+
+.. literalinclude:: ../../examples/exception_monitoring.py
+
+Monitoring using external Service Providers
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* `LogDNA <https://logdna.com/>`_
+
+.. literalinclude:: ../../examples/logdna_example.py
+
+* `RayGun <https://raygun.com/>`_
+
+.. literalinclude:: ../../examples/raygun_example.py
+
+* `Rollbar <https://rollbar.com>`_
+
+.. literalinclude:: ../../examples/rollbar_example.py
+
+* `Sentry <http://sentry.io>`_
+
+.. literalinclude:: ../../examples/sentry_example.py
+
+
+Security
+~~~~~~~~
+
+The following sample code shows a simple decorator based authentication and authorization mechanism that can be setup
+to secure your ``sanic`` api endpoints.
+
+.. literalinclude:: ../../examples/authorized_sanic.py
+
+Sanic Websocket
+~~~~~~~~~~~~~~~
+
+``Sanic`` provides an ability to easily add a route and map it to a ``websocket`` handlers.
+
+.. literalinclude:: ../../examples/websocket.html
+.. literalinclude:: ../../examples/websocket.py
+
+vhost Suppport
+~~~~~~~~~~~~~~
+
+.. literalinclude:: ../../examples/vhosts.py
+
+Unit Testing With Parallel Test Run Support
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following example shows you how to get up and running with unit testing ``sanic`` application with parallel test
+execution support provided by the ``pytest-xdist`` plugin.
+
+.. literalinclude:: ../../examples/pytest_xdist.py
+
+
+Amending Request Object
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``request`` object in ``Sanic`` is a kind of ``dict`` object, this means that ``reqeust`` object can be manipulated as a regular ``dict`` object.
+
+.. literalinclude:: ../../examples/amending_request_object.py
+
+For more examples and useful samples please visit the `Huge-Sanic's GitHub Page <https://github.com/huge-success/sanic/tree/master/examples>`_

docs/sanic/exceptions.md

@@ -13,10 +13,23 @@ To throw an exception, simply `raise` the relevant exception from the
 from sanic.exceptions import ServerError
 
 @app.route('/killme')
-def i_am_ready_to_die(request):
+async def i_am_ready_to_die(request):
 	raise ServerError("Something bad happened", status_code=500)
 ```
 
+You can also use the `abort` function with the appropriate status code:
+
+```python
+from sanic.exceptions import abort
+from sanic.response import text
+
+@app.route('/youshallnotpass')
+async def no_no(request):
+        abort(401)
+        # this won't happen
+        text("OK")
+```
+
 ## Handling exceptions
 
 To override Sanic's default handling of an exception, the `@app.exception`
@@ -30,10 +43,40 @@ from sanic.response import text
 from sanic.exceptions import NotFound
 
 @app.exception(NotFound)
-def ignore_404s(request, exception):
+async def ignore_404s(request, exception):
 	return text("Yep, I totally found the page: {}".format(request.url))
 ```
 
+You can also add an exception handler as such:
+
+```python
+from sanic import Sanic
+
+async def server_error_handler(request, exception):
+	return text("Oops, server error", status=500)
+
+app = Sanic()
+app.error_handler.add(Exception, server_error_handler)
+```
+
+In some cases, you might want to add some more error handling
+functionality to what is provided by default. In that case, you 
+can subclass Sanic's default error handler as such:
+
+```python
+from sanic import Sanic
+from sanic.handlers import ErrorHandler
+
+class CustomErrorHandler(ErrorHandler):
+	def default(self, request, exception):
+		''' handles errors that have no error handlers assigned '''
+		# You custom error handling logic...
+		return super().default(request, exception)
+		
+app = Sanic()
+app.error_handler = CustomErrorHandler()
+```
+
 ## Useful exceptions
 
 Some of the most useful exceptions are presented below:

docs/sanic/extensions.md

@@ -2,13 +2,74 @@
 
 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.
+
+## Extension and Plugin Development
+
+- [Sanic-Plugins-Framework](https://github.com/ashleysommer/sanicpluginsframework): Library for easily creating and using Sanic plugins.
+- [sanic-script](https://github.com/tim2anna/sanic-script): An extension for Sanic that adds support for writing commands to your application.
+
+## Security
+
+- [Sanic JWT](https://github.com/ahopkins/sanic-jwt): Authentication, JWT, and permission scoping for Sanic.
+- [Secure](https://github.com/cakinney/secure): Secure 🔒 is a lightweight package that adds optional security headers and cookie attributes for Python web frameworks.
+- [Sessions](https://github.com/subyraman/sanic_session): Support for sessions. Allows using redis, memcache or an in memory store.
 - [CORS](https://github.com/ashleysommer/sanic-cors): A port of flask-cors.
-- [Compress](https://github.com/subyraman/sanic_compress): Allows you to easily gzip Sanic responses. A port of Flask-Compress.
-- [Jinja2](https://github.com/lixxu/sanic-jinja2): Support for Jinja2 template.
+- [Sanic-JWT-Extended](https://github.com/devArtoria/Sanic-JWT-Extended): Provides extended JWT support for 
+- [UserAgent](https://github.com/lixxu/sanic-useragent): Add `user_agent` to request
+- [Limiter](https://github.com/bohea/sanic-limiter): Rate limiting for sanic.
+- [sanic-oauth](https://gitlab.com/SirEdvin/sanic-oauth): OAuth Library with many provider and OAuth1/OAuth2 support.
+- [Sanic-Auth](https://github.com/pyx/sanic-auth): A minimal backend agnostic session-based user authentication mechanism for Sanic.
+- [Sanic-CookieSession](https://github.com/pyx/sanic-cookiesession): A client-side only, cookie-based session, similar to the built-in session in Flask.
+
+## Documentation
+
 - [OpenAPI/Swagger](https://github.com/channelcat/sanic-openapi): OpenAPI support, plus a Swagger UI.
-- [Pagination](https://github.com/lixxu/python-paginate): Simple pagination support.
+- [Sanic-RestPlus](https://github.com/ashleysommer/sanic-restplus): A port of Flask-RestPlus for Sanic. Full-featured REST API with SwaggerUI generation.
+- [sanic-transmute](https://github.com/yunstanford/sanic-transmute): A Sanic extension that generates APIs from python function and classes, and also generates Swagger UI/documentation automatically.
+
+## ORM and Database Integration
+
 - [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
+- [sanic-graphql](https://github.com/graphql-python/sanic-graphql): GraphQL integration with Sanic
+- [GINO](https://github.com/fantix/gino): An asyncio ORM on top of SQLAlchemy core, delivered with a Sanic extension. ([Documentation](https://python-gino.readthedocs.io/))
+- [Databases](https://github.com/encode/databases): Async database access for SQLAlchemy core, with support for PostgreSQL, MySQL, and SQLite.
+
+## Unit Testing
+
+- [pytest-sanic](https://github.com/yunstanford/pytest-sanic): A pytest plugin for Sanic. It helps you to test your code asynchronously.
+
+## Project Creation Template
+
+- [cookiecutter-sanic](https://github.com/harshanarayana/cookiecutter-sanic): Get your sanic application up and running in a matter of second in a well defined project structure.
+    Batteries included for deployment, unit testing, automated release management and changelog generation.
+
+## Templating
+
+- [Sanic-WTF](https://github.com/pyx/sanic-wtf): Sanic-WTF makes using WTForms with Sanic and CSRF (Cross-Site Request Forgery) protection a little bit easier.
+- [Jinja2](https://github.com/lixxu/sanic-jinja2): Support for Jinja2 template.
+- [jinja2-sanic](https://github.com/yunstanford/jinja2-sanic): a jinja2 template renderer for Sanic.([Documentation](http://jinja2-sanic.readthedocs.io/en/latest/)) 
+
+## API Helper Utilities
+
+- [sanic-sse](https://github.com/inn0kenty/sanic_sse): [Server-Sent Events](https://en.wikipedia.org/wiki/Server-sent_events) implementation for Sanic.
+- [Compress](https://github.com/subyraman/sanic_compress): Allows you to easily gzip Sanic responses. A port of Flask-Compress.
+- [Pagination](https://github.com/lixxu/python-paginate): Simple pagination support.
+- [Sanic EnvConfig](https://github.com/jamesstidard/sanic-envconfig): Pull environment variables into your sanic config.
+
+## i18n/l10n Support
+- [Babel](https://github.com/lixxu/sanic-babel): Adds i18n/l10n support to Sanic applications with the help of the `Babel` library
+  
+## Custom Middlewares
+
+- [Dispatch](https://github.com/ashleysommer/sanic-dispatcher): A dispatcher inspired by `DispatcherMiddleware` in werkzeug. Can act as a Sanic-to-WSGI adapter.
+
+## Monitoring and Reporting
+
+- [sanic-prometheus](https://github.com/dkruchinin/sanic-prometheus): Prometheus metrics for Sanic
+- [sanic-zipkin](https://github.com/kevinqqnj/sanic-zipkin): Easily report request/function/RPC traces to zipkin/jaeger, through aiozipkin.
+
+
+## Sample Applications
+
+- [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.

docs/sanic/getting_started.md

@@ -4,24 +4,45 @@ Make sure you have both [pip](https://pip.pypa.io/en/stable/installing/) and at
 least version 3.5 of Python before starting. Sanic uses the new `async`/`await`
 syntax, so earlier versions of python won't work.
 
-1. Install Sanic: `python3 -m pip install sanic`
-2. Create a file called `main.py` with the following code:
+## 1. Install Sanic
+
+  ```
+  pip3 install sanic
+  ```
+
+To install sanic without `uvloop` or `ujson` using bash, you can provide either or both of these environmental variables
+using any truthy string like `'y', 'yes', 't', 'true', 'on', '1'` and setting the `SANIC_NO_X` (`X` = `UVLOOP`/`UJSON`) 
+to true will stop that features installation.
+
+```bash
+SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true pip3 install sanic
+```
+
+##  2. Create a file called `main.py`
 
   ```python
   from sanic import Sanic
-  from sanic.response import text
+  from sanic.response import json
 
-  app = Sanic(__name__)
+  app = Sanic()
 
   @app.route("/")
   async def test(request):
-      return text('Hello world!')
+      return json({"hello": "world"})
 
-  app.run(host="0.0.0.0", port=8000, debug=True)
+  if __name__ == "__main__":
+      app.run(host="0.0.0.0", port=8000)
   ```
-  
-3. Run the server: `python3 main.py`
-4. Open the address `http://0.0.0.0:8000` in your web browser. You should see
-   the message *Hello world!*.
+
+## 3. Run the server
+
+  ```
+  python3 main.py
+  ```
+
+## 4. Check your browser
+
+Open the address `http://0.0.0.0:8000` in your web browser. You should see
+the message *Hello world!*.
 
 You now have a working Sanic server!

docs/sanic/index.rst

@@ -7,8 +7,8 @@ On top of being Flask-like, Sanic supports async request handlers.  This means y
 
 Sanic is developed `on GitHub <https://github.com/channelcat/sanic/>`_. Contributions are welcome!
 
-Sanic aspires to be simple:
--------------------
+Sanic aspires to be simple
+---------------------------
 
 .. code:: python
 

docs/sanic/logging.rst

@@ -0,0 +1,103 @@
+Logging
+=======
+
+Sanic allows you to do different types of logging (access log, error
+log) on the requests based on the `python3 logging API`_. You should
+have some basic knowledge on python3 logging if you want to create a new
+configuration.
+
+Quick Start
+~~~~~~~~~~~
+
+A simple example using default settings would be like this:
+
+.. code:: python
+
+   from sanic import Sanic
+   from sanic.log import logger
+   from sanic.response import text
+
+   app = Sanic('test')
+
+   @app.route('/')
+   async def test(request):
+       logger.info('Here is your log')
+       return text('Hello World!')
+
+   if __name__ == "__main__":
+     app.run(debug=True, access_log=True)
+
+After the server is running, you can see some messages looks like:
+
+::
+
+   [2018-11-06 21:16:53 +0800] [24622] [INFO] Goin' Fast @ http://127.0.0.1:8000
+   [2018-11-06 21:16:53 +0800] [24667] [INFO] Starting worker [24667]
+
+You can send a request to server and it will print the log messages:
+
+::
+
+   [2018-11-06 21:18:53 +0800] [25685] [INFO] Here is your log
+   [2018-11-06 21:18:53 +0800] - (sanic.access)[INFO][127.0.0.1:57038]: GET http://localhost:8000/  200 12
+
+To use your own logging config, simply use
+``logging.config.dictConfig``, or pass ``log_config`` when you
+initialize ``Sanic`` app:
+
+.. code:: python
+
+   app = Sanic('test', log_config=LOGGING_CONFIG)
+
+And to close logging, simply assign access_log=False:
+
+.. code:: python
+
+   if __name__ == "__main__":
+     app.run(access_log=False)
+
+This would skip calling logging functions when handling requests. And
+you could even do further in production to gain extra speed:
+
+.. code:: python
+
+   if __name__ == "__main__":
+     # disable debug messages
+     app.run(debug=False, access_log=False)
+
+Configuration
+~~~~~~~~~~~~~
+
+By default, ``log_config`` parameter is set to use
+``sanic.log.LOGGING_CONFIG_DEFAULTS`` dictionary for configuration.
+
+There are three ``loggers`` used in sanic, and **must be defined if you
+want to create your own logging configuration**:
+
+================ ==============================
+Logger Name      Usecase
+================ ==============================
+``sanic.root``   Used to log internal messages.
+``sanic.error``  Used to log error logs.
+``sanic.access`` Used to log access logs.
+================ ==============================
+
+Log format:
+^^^^^^^^^^^
+
+In addition to default parameters provided by python (``asctime``,
+``levelname``, ``message``), Sanic provides additional parameters for
+access logger with:
+
+===================== ========================================== ========
+Log Context Parameter Parameter Value                            Datatype
+===================== ========================================== ========
+``host``              ``request.ip``                             str
+``request``           ``request.method`` + " " + ``request.url`` str
+``status``            ``response.status``                        int
+``byte``              ``len(response.body)``                     int
+===================== ========================================== ========
+
+The default access log format is ``%(asctime)s - (%(name)s)[%(levelname)s][%(host)s]: %(request)s %(message)s %(status)d %(byte)d``
+
+.. _python3 logging API: https://docs.python.org/3/howto/logging.html

docs/sanic/middleware.md

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

docs/sanic/request_data.md

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

docs/sanic/response.md

@@ -0,0 +1,112 @@
+# 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')
+```
+
+## File Streaming
+For large files, a combination of File and Streaming above
+```python
+from sanic import response
+
+@app.route('/big_file.png')
+async def handle_request(request):
+    return await response.file_stream('/srv/www/whatever.png')
+```
+
+## Redirect
+
+```python
+from sanic import response
+
+
+@app.route('/redirect')
+def handle_request(request):
+    return response.redirect('/json')
+```
+
+## Raw
+
+Response without encoding the body
+
+```python
+from sanic import response
+
+
+@app.route('/raw')
+def handle_request(request):
+    return response.raw(b'raw data')
+```
+
+## Modify headers or status
+
+To modify headers or status code, pass the `headers` or `status` argument to those functions:
+
+```python
+from sanic import response
+
+
+@app.route('/json')
+def handle_request(request):
+    return response.json(
+        {'message': 'Hello world!'},
+        headers={'X-Served-By': 'sanic'},
+        status=200
+    )
+```

docs/sanic/routing.md

@@ -52,7 +52,7 @@ async def integer_handler(request, integer_arg):
 async def number_handler(request, number_arg):
 	return text('Number - {}'.format(number_arg))
 
-@app.route('/person/<name:[A-z]>')
+@app.route('/person/<name:[A-z]+>')
 async def person_handler(request, name):
 	return text('Person - {}'.format(name))
 
@@ -138,13 +138,14 @@ app.add_route(person_handler2, '/person/<name:[A-z]>', methods=['GET'])
 Sanic provides a `url_for` method, to generate URLs based on the handler method name. This is useful if you want to avoid hardcoding url paths into your app; instead, you can just reference the handler name. For example:
 
 ```python
+from sanic.response import redirect
+
 @app.route('/')
 async def index(request):
     # generate a URL for the endpoint `post_handler`
     url = app.url_for('post_handler', post_id=5)
     # the URL is `/posts/5`, redirect to it
-    return redirect(url)
-
+    return redirect(url)    
 
 @app.route('/posts/<post_id>')
 async def post_handler(request, post_id):
@@ -163,21 +164,173 @@ url = app.url_for('post_handler', post_id=5, arg_one='one', arg_two='two')
 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:
+- Also some special arguments (`_anchor`, `_external`, `_scheme`, `_method`, `_server`) passed to `url_for` will have special url building (`_method` is not supported now and will be ignored). For example:
 ```python
 url = app.url_for('post_handler', post_id=5, arg_one='one', _anchor='anchor')
 # /posts/5?arg_one=one#anchor
 
 url = app.url_for('post_handler', post_id=5, arg_one='one', _external=True)
 # //server/posts/5?arg_one=one
-# _external requires passed argument _server or SERVER_NAME in app.config or url will be same as no _external
+# _external requires you to pass an argument _server or set SERVER_NAME in app.config if not url will be same as no _external
 
 url = app.url_for('post_handler', post_id=5, arg_one='one', _scheme='http', _external=True)
 # http://server/posts/5?arg_one=one
 # when specifying _scheme, _external must be True
 
-# you can pass all special arguments one time
+# you can pass all special arguments at once
 url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two'], arg_two=2, _anchor='anchor', _scheme='http', _external=True, _server='another_server:8888')
 # http://another_server:8888/posts/5?arg_one=one&arg_one=two&arg_two=2#anchor
 ```
-- All valid parameters must be passed to `url_for` to build a URL. If a parameter is not supplied, or if a parameter does not match the specified type, a `URLBuildError` will be thrown.
+- All valid parameters must be passed to `url_for` to build a URL. If a parameter is not supplied, or if a parameter does not match the specified type, a `URLBuildError` will be raised.
+
+## WebSocket routes
+
+Routes for the WebSocket protocol can be defined with the `@app.websocket`
+decorator:
+
+```python
+@app.websocket('/feed')
+async def feed(request, ws):
+    while True:
+        data = 'hello!'
+        print('Sending: ' + data)
+        await ws.send(data)
+        data = await ws.recv()
+        print('Received: ' + data)
+```
+
+Alternatively, the `app.add_websocket_route` method can be used instead of the
+decorator:
+
+```python
+async def feed(request, ws):
+    pass
+
+app.add_websocket_route(my_websocket_handler, '/feed')
+```
+
+Handlers to a WebSocket route are invoked with the request as first argument, and a
+WebSocket protocol object as second argument. The protocol object has `send`
+and `recv` methods to send and receive data respectively.
+
+WebSocket support requires the [websockets](https://github.com/aaugustin/websockets)
+package by Aymeric Augustin.
+
+
+## About `strict_slashes`
+
+You can make `routes` strict to trailing slash or not, it's configurable.
+
+```python
+
+# provide default strict_slashes value for all routes
+app = Sanic('test_route_strict_slash', strict_slashes=True)
+
+# you can also overwrite strict_slashes value for specific route
+@app.get('/get', strict_slashes=False)
+def handler(request):
+    return text('OK')
+
+# It also works for blueprints
+bp = Blueprint('test_bp_strict_slash', strict_slashes=True)
+
+@bp.get('/bp/get', strict_slashes=False)
+def handler(request):
+    return text('OK')
+
+app.blueprint(bp)
+```
+
+## User defined route name
+
+A custom route name can be used by passing a `name` argument while registering the route which will
+override the default route name generated using the `handler.__name__` attribute.
+
+```python
+
+app = Sanic('test_named_route')
+
+@app.get('/get', name='get_handler')
+def handler(request):
+    return text('OK')
+
+# then you need use `app.url_for('get_handler')`
+# instead of # `app.url_for('handler')`
+
+# It also works for blueprints
+bp = Blueprint('test_named_bp')
+
+@bp.get('/bp/get', name='get_handler')
+def handler(request):
+    return text('OK')
+
+app.blueprint(bp)
+
+# then you need use `app.url_for('test_named_bp.get_handler')`
+# instead of `app.url_for('test_named_bp.handler')`
+
+# different names can be used for same url with different methods
+
+@app.get('/test', name='route_test')
+def handler(request):
+    return text('OK')
+
+@app.post('/test', name='route_post')
+def handler2(request):
+    return text('OK POST')
+
+@app.put('/test', name='route_put')
+def handler3(request):
+    return text('OK PUT')
+
+# below url are the same, you can use any of them
+# '/test'
+app.url_for('route_test')
+# app.url_for('route_post')
+# app.url_for('route_put')
+
+# for same handler name with different methods
+# you need specify the name (it's url_for issue)
+@app.get('/get')
+def handler(request):
+    return text('OK')
+
+@app.post('/post', name='post_handler')
+def handler(request):
+    return text('OK')
+
+# then
+# app.url_for('handler') == '/get'
+# app.url_for('post_handler') == '/post'
+```
+
+## Build URL for static files
+
+Sanic supports using `url_for` method to build static file urls. In case if the static url
+is pointing to a directory, `filename` parameter to the `url_for` can be ignored.   q
+
+```python
+
+app = Sanic('test_static')
+app.static('/static', './static')
+app.static('/uploads', './uploads', name='uploads')
+app.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
+
+bp = Blueprint('bp', url_prefix='bp')
+bp.static('/static', './static')
+bp.static('/uploads', './uploads', name='uploads')
+bp.static('/the_best.png', '/home/ubuntu/test.png', name='best_png')
+app.blueprint(bp)
+
+# then build the url
+app.url_for('static', filename='file.txt') == '/static/file.txt'
+app.url_for('static', name='static', filename='file.txt') == '/static/file.txt'
+app.url_for('static', name='uploads', filename='file.txt') == '/uploads/file.txt'
+app.url_for('static', name='best_png') == '/the_best.png'
+
+# blueprint url building
+app.url_for('static', name='bp.static', filename='file.txt') == '/bp/static/file.txt'
+app.url_for('static', name='bp.uploads', filename='file.txt') == '/bp/uploads/file.txt'
+app.url_for('static', name='bp.best_png') == '/bp/static/the_best.png'
+
+```

docs/sanic/sockets.rst

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

docs/sanic/ssl.rst

@@ -9,4 +9,12 @@ Optionally pass in an SSLContext:
   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)
+  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

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

docs/sanic/streaming.md

@@ -0,0 +1,119 @@
+# Streaming
+
+## Request Streaming
+
+Sanic allows you to get request data by stream, as below. When the request ends, `await request.stream.read()` returns `None`. Only post, put and patch decorator have stream argument.
+
+```python
+from sanic import Sanic
+from sanic.views import CompositionView
+from sanic.views import HTTPMethodView
+from sanic.views import stream as stream_decorator
+from sanic.blueprints import Blueprint
+from sanic.response import stream, text
+
+bp = Blueprint('blueprint_request_stream')
+app = Sanic('request_stream')
+
+
+class SimpleView(HTTPMethodView):
+
+    @stream_decorator
+    async def post(self, request):
+        result = ''
+        while True:
+            body = await request.stream.read()
+            if body is None:
+                break
+            result += body.decode('utf-8')
+        return text(result)
+
+
+@app.post('/stream', stream=True)
+async def handler(request):
+    async def streaming(response):
+        while True:
+            body = await request.stream.read()
+            if body is None:
+                break
+            body = body.decode('utf-8').replace('1', 'A')
+            await response.write(body)
+    return stream(streaming)
+
+
+@bp.put('/bp_stream', stream=True)
+async def bp_put_handler(request):
+    result = ''
+    while True:
+        body = await request.stream.read()
+        if body is None:
+            break
+        result += body.decode('utf-8').replace('1', 'A')
+    return text(result)
+
+
+# You can also use `bp.add_route()` with stream argument
+async def bp_post_handler(request):
+    result = ''
+    while True:
+        body = await request.stream.read()
+        if body is None:
+            break
+        result += body.decode('utf-8').replace('1', 'A')
+    return text(result)
+
+bp.add_route(bp_post_handler, '/bp_stream', methods=['POST'], stream=True)
+
+
+async def post_handler(request):
+    result = ''
+    while True:
+        body = await request.stream.read()
+        if body is None:
+            break
+        result += body.decode('utf-8')
+    return text(result)
+
+app.blueprint(bp)
+app.add_route(SimpleView.as_view(), '/method_view')
+view = CompositionView()
+view.add(['POST'], post_handler, stream=True)
+app.add_route(view, '/composition_view')
+
+
+if __name__ == '__main__':
+    app.run(host='127.0.0.1', port=8000)
+```
+
+## Response Streaming
+
+Sanic allows you to stream content to the client with the `stream` method. This method accepts a coroutine callback which is passed a `StreamingHTTPResponse` object that is written to. A simple example is like follows:
+
+```python
+from sanic import Sanic
+from sanic.response import stream
+
+app = Sanic(__name__)
+
+@app.route("/")
+async def test(request):
+    async def sample_streaming_fn(response):
+        await response.write('foo,')
+        await response.write('bar')
+
+    return stream(sample_streaming_fn, content_type='text/csv')
+```
+
+This is useful in situations where you want to stream content to the client that originates in an external service, like a database. For example, you can stream database records to the client with the asynchronous cursor that `asyncpg` provides:
+
+```python
+@app.route("/")
+async def index(request):
+    async def stream_from_db(response):
+        conn = await asyncpg.connect(database='test')
+        async with conn.transaction():
+            async for record in conn.cursor('SELECT generate_series(0, 10)'):
+                await response.write(record[0])
+
+    return stream(stream_from_db)
+```

docs/sanic/testing.md

@@ -20,7 +20,7 @@ def test_index_put_not_allowed():
     assert response.status == 405
 ```
 
-Internally, each time you call one of the `test_client` methods, the Sanic app is run at `127.0.01:42101` and 
+Internally, each time you call one of the `test_client` methods, the Sanic app is run at `127.0.0.1:42101` and 
 your test request is executed against your application, using `aiohttp`. 
 
 The `test_client` methods accept the following arguments and keyword arguments:
@@ -59,15 +59,86 @@ the available arguments to aiohttp can be found
 [in the documentation for ClientSession](https://aiohttp.readthedocs.io/en/stable/client_reference.html#client-session).
 
 
-### Deprecated: `sanic_endpoint_test`
+## Using a random port
 
-Prior to version 0.3.2, testing was provided through the `sanic_endpoint_test` method. This method will be deprecated in the next major version after 0.4.0; please use the `test_client` instead.
+If you need to test using a free unpriveleged port chosen by the kernel
+instead of the default with `SanicTestClient`, you can do so by specifying
+`port=None`. On most systems the port will be in the range 1024 to 65535.
 
-```
-from sanic.utils import sanic_endpoint_test
+```python
+# Import the Sanic app, usually created with Sanic(__name__)
+from external_server import app
+from sanic.testing import SanicTestClient
 
 def test_index_returns_200():
-    request, response = sanic_endpoint_test(app)
+    request, response = SanicTestClient(app, port=None).get('/')
     assert response.status == 200
 ```
 
+
+## pytest-sanic
+
+[pytest-sanic](https://github.com/yunstanford/pytest-sanic) is a pytest plugin, it helps you to test your code asynchronously.
+Just write tests like,
+
+```python
+async def test_sanic_db_find_by_id(app):
+    """
+    Let's assume that, in db we have,
+        {
+            "id": "123",
+            "name": "Kobe Bryant",
+            "team": "Lakers",
+        }
+    """
+    doc = await app.db["players"].find_by_id("123")
+    assert doc.name == "Kobe Bryant"
+    assert doc.team == "Lakers"
+```
+
+[pytest-sanic](https://github.com/yunstanford/pytest-sanic) also provides some useful fixtures, like loop, unused_port,
+test_server, test_client.
+
+```python
+@pytest.yield_fixture
+def app():
+    app = Sanic("test_sanic_app")
+
+    @app.route("/test_get", methods=['GET'])
+    async def test_get(request):
+        return response.json({"GET": True})
+
+    @app.route("/test_post", methods=['POST'])
+    async def test_post(request):
+        return response.json({"POST": True})
+
+    yield app
+
+
+@pytest.fixture
+def test_cli(loop, app, test_client):
+    return loop.run_until_complete(test_client(app, protocol=WebSocketProtocol))
+
+
+#########
+# Tests #
+#########
+
+async def test_fixture_test_client_get(test_cli):
+    """
+    GET request
+    """
+    resp = await test_cli.get('/test_get')
+    assert resp.status == 200
+    resp_json = await resp.json()
+    assert resp_json == {"GET": True}
+
+async def test_fixture_test_client_post(test_cli):
+    """
+    POST request
+    """
+    resp = await test_cli.post('/test_post')
+    assert resp.status == 200
+    resp_json = await resp.json()
+    assert resp_json == {"POST": True}
+```

docs/sanic/versioning.md

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

docs/sanic/websocket.rst

@@ -0,0 +1,52 @@
+WebSocket
+=========
+
+Sanic provides an easy to user abstraction on top of `websockets`. To setup a WebSocket:
+
+.. code:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+    from sanic.websocket import WebSocketProtocol
+
+    app = Sanic()
+
+    @app.websocket('/feed')
+    async def feed(request, ws):
+        while True:
+            data = 'hello!'
+            print('Sending: ' + data)
+            await ws.send(data)
+            data = await ws.recv()
+            print('Received: ' + data)
+
+    if __name__ == "__main__":
+        app.run(host="0.0.0.0", port=8000, protocol=WebSocketProtocol)
+
+
+Alternatively, the ``app.add_websocket_route`` method can be used instead of the
+decorator:
+
+.. code:: python
+
+    async def feed(request, ws):
+        pass
+
+    app.add_websocket_route(feed, '/feed')
+
+
+Handlers for a WebSocket route is invoked with the request as first argument, and a
+WebSocket protocol object as second argument. The protocol object has ``send``
+and ``recv`` methods to send and receive data respectively.
+
+
+You could setup your own WebSocket configuration through ``app.config``, like
+
+.. code:: python
+
+    app.config.WEBSOCKET_MAX_SIZE = 2 ** 20
+    app.config.WEBSOCKET_MAX_QUEUE = 32
+    app.config.WEBSOCKET_READ_LIMIT = 2 ** 16
+    app.config.WEBSOCKET_WRITE_LIMIT = 2 ** 16
+
+Find more in ``Configuration`` section.

environment.yml

@@ -1,18 +1,18 @@
-name: py35
+name: py36
 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=18.1=py36_0
+- python=3.6=0
+- setuptools=40.4.3=py36_0
 - pip:
+  - httptools>=0.0.10
   - uvloop>=0.5.3
-  - httptools>=0.0.9
   - ujson>=1.35
   - aiofiles>=0.3.0
-  - https://github.com/channelcat/docutils-fork/zipball/master
+  - websockets>=6.0,<7.0
+  - multidict>=4.0,<5.0
+  - sphinx==1.8.3
+  - sphinx_rtd_theme==0.4.2
+  - recommonmark==0.5.0
+  - sphinxcontrib-asyncio>=0.2.0
+  - docutils==0.14
+  - pygments==2.3.1

examples/add_task_sanic.py

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+import asyncio
+
+from sanic import Sanic
+
+app = Sanic()
+
+
+async def notify_server_started_after_five_seconds():
+    await asyncio.sleep(5)
+    print('Server successfully started!')
+
+app.add_task(notify_server_started_after_five_seconds())
+
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000)

examples/aiohttp_example.py

@@ -1,28 +0,0 @@
-from sanic import Sanic
-from sanic.response import json
-
-import aiohttp
-
-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()
-
-
-@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 fetch(session, url)
-        return json(response)
-
-
-app.run(host="0.0.0.0", port=8000, workers=2)

examples/amending_request_object.py

@@ -0,0 +1,30 @@
+from sanic import Sanic
+from sanic.response import text
+from random import randint
+
+app = Sanic()
+
+
+@app.middleware('request')
+def append_request(request):
+    # Add new key with random value
+    request['num'] = randint(0, 100)
+
+
+@app.get('/pop')
+def pop_handler(request):
+    # Pop key from request object
+    num = request.pop('num')
+    return text(num)
+
+
+@app.get('/key_exist')
+def key_exist_handler(request):
+    # Check the key is exist or not
+    if 'num' in request:
+        return text('num exist in request')
+
+    return text('num does not exist in reqeust')
+
+
+app.run(host="0.0.0.0", port=8000, debug=True)

examples/authorized_sanic.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+
+from sanic import Sanic
+from functools import wraps
+from sanic.response import json
+
+app = Sanic()
+
+
+def check_request_for_authorization_status(request):
+    # Note: Define your check, for instance cookie, session.
+    flag = True
+    return flag
+
+
+def authorized():
+    def decorator(f):
+        @wraps(f)
+        async def decorated_function(request, *args, **kwargs):
+            # run some method that checks the request
+            # for the client's authorization status
+            is_authorized = check_request_for_authorization_status(request)
+
+            if is_authorized:
+                # the user is authorized.
+                # run the handler method and return the response
+                response = await f(request, *args, **kwargs)
+                return response
+            else:
+                # the user is not authorized.
+                return json({'status': 'not_authorized'}, 403)
+        return decorated_function
+    return decorator
+
+
+@app.route("/")
+@authorized()
+async def test(request):
+    return json({'status': 'authorized'})
+
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=8000)

examples/blueprints.py

@@ -1,11 +1,10 @@
-from sanic import Sanic
-from sanic import Blueprint
-from sanic.response import json, text
-
+from sanic import Blueprint, Sanic
+from sanic.response import file, json
 
 app = Sanic(__name__)
 blueprint = Blueprint('name', url_prefix='/my_blueprint')
-blueprint2 = Blueprint('name', url_prefix='/my_blueprint2')
+blueprint2 = Blueprint('name2', url_prefix='/my_blueprint2')
+blueprint3 = Blueprint('name3', url_prefix='/my_blueprint3')
 
 
 @blueprint.route('/foo')
@@ -18,7 +17,22 @@ async def foo2(request):
     return json({'msg': 'hi from blueprint2'})
 
 
-app.register_blueprint(blueprint)
-app.register_blueprint(blueprint2)
+@blueprint3.route('/foo')
+async def index(request):
+    return await file('websocket.html')
+
+
+@app.websocket('/feed')
+async def foo3(request, ws):
+    while True:
+        data = 'hello!'
+        print('Sending: ' + data)
+        await ws.send(data)
+        data = await ws.recv()
+        print('Received: ' + data)
+
+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,46 +0,0 @@
-"""
-Example of caching using aiocache package. To run it you will need a Redis
-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.
-
-If you want more info about the package check
-https://github.com/argaen/aiocache
-"""
-
-import asyncio
-import aiocache
-
-from sanic import Sanic
-from sanic.response import json
-from sanic.log import log
-from aiocache import cached
-from aiocache.serializers import JsonSerializer
-
-app = Sanic(__name__)
-
-
-@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())
-async def expensive_call():
-    log.info("Expensive has been called")
-    await asyncio.sleep(3)
-    return {"test": True}
-
-
-@app.route("/")
-async def test(request):
-    log.info("Received GET /")
-    return json(await expensive_call())
-
-
-app.run(host="0.0.0.0", port=8000)

examples/exception_monitoring.py

@@ -1,22 +1,21 @@
 """
 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.exceptions import Handler, SanicException
+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)
 """
 
 
-class CustomHandler(Handler):
+class CustomHandler(ErrorHandler):
 
     def default(self, request, exception):
         # Here, we have access to the exception object
@@ -38,11 +37,10 @@ server's error_handler to an instance of our CustomHandler
 """
 
 from sanic import Sanic
-from sanic.response import json
 
 app = Sanic(__name__)
 
-handler = CustomHandler(sanic=app)
+handler = CustomHandler()
 app.error_handler = handler
 
 
@@ -50,8 +48,7 @@ app.error_handler = handler
 async def test(request):
     # Here, something occurs which causes an unexpected exception
     # This exception will flow to our custom handler.
-    1 / 0
-    return json({"test": True})
+    raise SanicException('You Broke It!')
 
-
-app.run(host="0.0.0.0", port=8000, debug=True)
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000, debug=True)

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/limit_concurrency.py

@@ -8,11 +8,12 @@ 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)
+    concurrency_per_worker = 4
+    sem = asyncio.Semaphore(concurrency_per_worker, loop=loop)
 
 async def bounded_fetch(session, url):
     """

examples/log_request_id.py

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

examples/logdna_example.py

@@ -0,0 +1,61 @@
+import logging
+import socket
+from os import getenv
+from platform import node
+from uuid import getnode as get_mac
+
+from logdna import LogDNAHandler
+
+from sanic import Sanic
+from sanic.response import json
+from sanic.request import Request
+
+log = logging.getLogger('logdna')
+log.setLevel(logging.INFO)
+
+
+def get_my_ip_address(remote_server="google.com"):
+    with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as s:
+        s.connect((remote_server, 80))
+        return s.getsockname()[0]
+
+
+def get_mac_address():
+    h = iter(hex(get_mac())[2:].zfill(12))
+    return ":".join(i + next(h) for i in h)
+
+
+logdna_options = {
+    "app": __name__,
+    "index_meta": True,
+    "hostname": node(),
+    "ip": get_my_ip_address(),
+    "mac": get_mac_address()
+}
+
+logdna_handler = LogDNAHandler(getenv("LOGDNA_API_KEY"), options=logdna_options)
+
+logdna = logging.getLogger(__name__)
+logdna.setLevel(logging.INFO)
+logdna.addHandler(logdna_handler)
+
+app = Sanic(__name__)
+
+
+@app.middleware
+def log_request(request: Request):
+    logdna.info("I was Here with a new Request to URL: {}".format(request.url))
+
+
+@app.route("/")
+def default(request):
+    return json({
+        "response": "I was here"
+    })
+
+
+if __name__ == "__main__":
+    app.run(
+        host="0.0.0.0",
+        port=getenv("PORT", 8080)
+    )

examples/modify_header_example.py

@@ -0,0 +1,28 @@
+"""
+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

@@ -1,6 +1,5 @@
 from sanic import Sanic
-from sanic.response import text
-import json
+from sanic import response
 import logging
 
 logging_format = "[%(asctime)s] %(process)d-%(levelname)s "
@@ -15,9 +14,11 @@ log = logging.getLogger()
 
 # Set logger to override default basicConfig
 sanic = Sanic()
+
+
 @sanic.route("/")
 def test(request):
     log.info("received request; responding with 'hey'")
-    return text("hey")
+    return response.text("hey")
 
 sanic.run(host="0.0.0.0", port=8000)

examples/pytest_xdist.py

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

examples/raygun_example.py

@@ -0,0 +1,37 @@
+from os import getenv
+
+from raygun4py.raygunprovider import RaygunSender
+
+from sanic import Sanic
+from sanic.exceptions import SanicException
+from sanic.handlers import ErrorHandler
+
+
+class RaygunExceptionReporter(ErrorHandler):
+
+    def __init__(self, raygun_api_key=None):
+        super().__init__()
+        if raygun_api_key is None:
+            raygun_api_key = getenv("RAYGUN_API_KEY")
+
+        self.sender = RaygunSender(raygun_api_key)
+
+    def default(self, request, exception):
+        self.sender.send_exception(exception=exception)
+        return super().default(request, exception)
+
+
+raygun_error_reporter = RaygunExceptionReporter()
+app = Sanic(__name__, error_handler=raygun_error_reporter)
+
+
+@app.route("/raise")
+async def test(request):
+    raise SanicException('You Broke It!')
+
+
+if __name__ == '__main__':
+    app.run(
+        host="0.0.0.0",
+        port=getenv("PORT", 8080)
+    )

examples/redirect_example.py

@@ -0,0 +1,18 @@
+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_stream/client.py

@@ -0,0 +1,10 @@
+import requests
+
+# Warning: This is a heavy process.
+
+data = ""
+for i in range(1, 250000):
+    data += str(i)
+
+r = requests.post('http://0.0.0.0:8000/stream', data=data)
+print(r.text)

examples/request_stream/server.py

@@ -0,0 +1,65 @@
+from sanic import Sanic
+from sanic.views import CompositionView
+from sanic.views import HTTPMethodView
+from sanic.views import stream as stream_decorator
+from sanic.blueprints import Blueprint
+from sanic.response import stream, text
+
+bp = Blueprint('blueprint_request_stream')
+app = Sanic('request_stream')
+
+
+class SimpleView(HTTPMethodView):
+
+    @stream_decorator
+    async def post(self, request):
+        result = ''
+        while True:
+            body = await request.stream.get()
+            if body is None:
+                break
+            result += body.decode('utf-8')
+        return text(result)
+
+
+@app.post('/stream', stream=True)
+async def handler(request):
+    async def streaming(response):
+        while True:
+            body = await request.stream.get()
+            if body is None:
+                break
+            body = body.decode('utf-8').replace('1', 'A')
+            await response.write(body)
+    return stream(streaming)
+
+
+@bp.put('/bp_stream', stream=True)
+async def bp_handler(request):
+    result = ''
+    while True:
+        body = await request.stream.get()
+        if body is None:
+            break
+        result += body.decode('utf-8').replace('1', 'A')
+    return text(result)
+
+
+async def post_handler(request):
+    result = ''
+    while True:
+        body = await request.stream.get()
+        if body is None:
+            break
+        result += body.decode('utf-8')
+    return text(result)
+
+app.blueprint(bp)
+app.add_route(SimpleView.as_view(), '/method_view')
+view = CompositionView()
+view.add(['POST'], post_handler, stream=True)
+app.add_route(view, '/composition_view')
+
+
+if __name__ == '__main__':
+    app.run(host='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)

examples/rollbar_example.py

@@ -0,0 +1,30 @@
+import rollbar
+
+from sanic.handlers import ErrorHandler
+from sanic import Sanic
+from sanic.exceptions import SanicException
+from os import getenv
+
+rollbar.init(getenv("ROLLBAR_API_KEY"))
+
+
+class RollbarExceptionHandler(ErrorHandler):
+
+    def default(self, request, exception):
+        rollbar.report_message(str(exception))
+        return super().default(request, exception)
+
+
+app = Sanic(__name__, error_handler=RollbarExceptionHandler())
+
+
+@app.route("/raise")
+def create_error(request):
+    raise SanicException("I was here and I don't like where I am")
+
+
+if __name__ == "__main__":
+    app.run(
+        host="0.0.0.0",
+        port=getenv("PORT", 8080)
+    )

examples/run_async.py

@@ -1,18 +1,18 @@
 from sanic import Sanic
-from sanic.response import json
-from multiprocessing import Event
+from sanic import response
 from signal import signal, SIGINT
 import asyncio
 import uvloop
 
 app = Sanic(__name__)
 
+
 @app.route("/")
 async def test(request):
-    return json({"answer": "42"})
+    return response.json({"answer": "42"})
 
 asyncio.set_event_loop(uvloop.new_event_loop())
-server = app.create_server(host="0.0.0.0", port=8001)
+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())

examples/sanic_aiopg_example.py

@@ -1,65 +0,0 @@
-""" To run this example you need additional aiopg package
-
-"""
-import os
-import asyncio
-
-import uvloop
-import aiopg
-
-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']
-
-connection = 'postgres://{0}:{1}@{2}/{3}'.format(database_user,
-                                                 database_password,
-                                                 database_host,
-                                                 database_name)
-
-
-async def get_pool():
-    return await aiopg.create_pool(connection)
-
-app = Sanic(name=__name__)
-
-@app.listener('before_server_start')
-async def prepare_db(app, loop):
-    """
-    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):
-    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__':
-    app.run(host='0.0.0.0',
-            port=8000,
-            debug=True)

examples/sanic_aiopg_sqlalchemy_example.py

@@ -1,67 +0,0 @@
-""" To run this example you need additional aiopg package
-
-"""
-import os
-import asyncio
-import datetime
-
-import uvloop
-from aiopg.sa import create_engine
-import sqlalchemy as sa
-
-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']
-
-connection = 'postgres://{0}:{1}@{2}/{3}'.format(database_user,
-                                                 database_password,
-                                                 database_host,
-                                                 database_name)
-
-metadata = sa.MetaData()
-
-polls = sa.Table('sanic_polls', metadata,
-                 sa.Column('id', sa.Integer, primary_key=True),
-                 sa.Column('question', sa.String(50)),
-                 sa.Column("pub_date", sa.DateTime))
-
-
-app = Sanic(name=__name__)
-
-@app.listener('before_server_start')
-async def prepare_db(app, loop):
-    """ Let's add some data
-
-    """
-    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 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__':
-    app.run(host='0.0.0.0', port=8000)

examples/sanic_asyncpg_example.py

@@ -1,59 +0,0 @@
-""" To run this example you need additional asyncpg package
-
-"""
-import os
-import asyncio
-
-import uvloop
-from asyncpg import create_pool
-
-from sanic import Sanic
-from sanic.response import json
-
-DB_CONFIG = {
-    'host': '<host>',
-    'user': '<username>',
-    'password': '<password>',
-    'port': '<port>',
-    'database': '<database>'
-}
-
-def jsonify(records):
-    """
-    Parse asyncpg record response into JSON format
-    """
-    return [{key: value for key, value in
-             zip(r.keys(), r.values())} for r in records]
-
-app = Sanic(__name__)
-
-@app.listener('before_server_start')
-async def create_db(app, loop):
-    """
-    Create some table and add some data
-    """
-    async with create_pool(**DB_CONFIG) as pool:
-        async with pool.acquire() as connection:
-            async with connection.transaction():
-                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, 100):
-                    await connection.execute(f"""INSERT INTO sanic_post
-                        (id, content, post_date) VALUES ({i}, {i}, now())""")
-
-
-@app.route("/")
-async def handler(request):
-    async with create_pool(**DB_CONFIG) as pool:
-        async with pool.acquire() as connection:
-            async with connection.transaction():
-                results = await connection.fetch('SELECT * FROM sanic_post')
-                return json({'posts': jsonify(results)})
-
-
-if __name__ == '__main__':
-    app.run(host='0.0.0.0', port=8000)

examples/sanic_motor.py

@@ -1,41 +0,0 @@
-""" 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.response import json
-
-
-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 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 json({'object_id': str(object_id)})
-
-
-if __name__ == "__main__":
-    app.run(host='127.0.0.1', port=8000)

examples/sanic_peewee.py

@@ -1,79 +0,0 @@
-## You need the following additional packages for this example
-# aiopg
-# peewee_async
-# peewee
-
-
-## sanic imports
-from sanic import Sanic
-from sanic.response import json
-
-## peewee_async related imports
-import peewee
-from peewee_async import Manager, PostgresqlDatabase
-
- # we instantiate a custom loop so we can pass it to our db manager
-
-## 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.
-
-
-# let's create a simple key value store:
-class KeyValue(peewee.Model):
-    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.listener('before_server_start')
-def setup(app, loop):
-    database = PostgresqlDatabase(database='test',
-                                  host='127.0.0.1',
-                                  user='postgres',
-                                  password='mysecretpassword')
-
-    objects = Manager(database, loop=loop)
-
-@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)
-    return json({'object_id': obj.id})
-
-
-@app.route('/get')
-async def get(request):
-    """
-    Load all objects from database
-    """
-    all_objects = await objects.execute(KeyValue.select())
-    serialized_obj = []
-    for obj in all_objects:
-        serialized_obj.append({
-            'id': obj.id,
-            'key': obj.key,
-            'value': obj.text}
-        )
-
-    return json({'objects': serialized_obj})
-
-
-if __name__ == "__main__":
-    app.run(host='0.0.0.0', port=8000)

examples/sentry_example.py

@@ -0,0 +1,35 @@
+from os import getenv
+
+from sentry_sdk import init as sentry_init
+from sentry_sdk.integrations.sanic import SanicIntegration
+
+from sanic import Sanic
+from sanic.response import json
+
+sentry_init(
+    dsn=getenv("SENTRY_DSN"),
+    integrations=[SanicIntegration()],
+)
+
+app = Sanic(__name__)
+
+
+# noinspection PyUnusedLocal
+@app.route("/working")
+async def working_path(request):
+    return json({
+        "response": "Working API Response"
+    })
+
+
+# noinspection PyUnusedLocal
+@app.route("/raise-error")
+async def raise_error(request):
+    raise Exception("Testing Sentry Integration")
+
+
+if __name__ == '__main__':
+    app.run(
+        host="0.0.0.0",
+        port=getenv("PORT", 8080)
+    )

examples/simple_async_view.py

@@ -0,0 +1,42 @@
+from sanic import Sanic
+from sanic.views import HTTPMethodView
+from sanic.response import text
+
+app = Sanic('some_name')
+
+
+class SimpleView(HTTPMethodView):
+
+    def get(self, request):
+        return text('I am get method')
+
+    def post(self, request):
+        return text('I am post method')
+
+    def put(self, request):
+        return text('I am put method')
+
+    def patch(self, request):
+        return text('I am patch method')
+
+    def delete(self, request):
+        return text('I am delete method')
+
+
+class SimpleAsyncView(HTTPMethodView):
+
+    async def get(self, request):
+        return text('I am async get method')
+
+    async def post(self, request):
+        return text('I am async post method')
+
+    async def put(self, request):
+        return text('I am async put method')
+
+
+app.add_route(SimpleView.as_view(), '/')
+app.add_route(SimpleAsyncView.as_view(), '/async')
+
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000, debug=True)

examples/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/teapot.py

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

examples/try_everything.py

@@ -1,8 +1,8 @@
 import os
 
 from sanic import Sanic
-from sanic.log import log
-from sanic.response import json, text, file
+from sanic.log import logger as log
+from sanic import response
 from sanic.exceptions import ServerError
 
 app = Sanic(__name__)
@@ -10,41 +10,50 @@ 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))
+@app.route("/dynamic/<name>/<i:int>")
+def test_params(request, name, i):
+    return response.text("yeehaww {} {}".format(name, i))
 
 
 @app.route("/exception")
 def exception(request):
     raise ServerError("It's dead jim")
 
+
 @app.route("/await")
 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 file(os.path.abspath("setup.py"))
+    return await response.file(os.path.abspath("setup.py"))
 
 
+@app.route("/file_stream")
+async def test_file_stream(request):
+    return await response.file_stream(os.path.abspath("setup.py"),
+                                      chunk_size=1024)
+
 # ----------------------------------------------- #
 # Exceptions
 # ----------------------------------------------- #
 
+
 @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)
 
 
 # ----------------------------------------------- #
@@ -53,23 +62,29 @@ 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')})
+def post_form_json(request):
+    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
 # ----------------------------------------------- #
 
+@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")
@@ -77,7 +92,13 @@ def after_start(app, 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)
+if __name__ == '__main__':
+    app.run(host="0.0.0.0", port=8000, debug=True)

examples/unix_socket.py

@@ -0,0 +1,23 @@
+from sanic import Sanic
+from sanic import response
+import socket
+import os
+
+app = Sanic(__name__)
+
+
+@app.route("/test")
+async def test(request):
+    return response.text("OK")
+
+if __name__ == '__main__':
+    server_address = './uds_socket'
+    # Make sure the socket does not already exist
+    try:
+            os.unlink(server_address)
+    except OSError:
+            if os.path.exists(server_address):
+                        raise
+    sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+    sock.bind(server_address)
+    app.run(sock=sock)

examples/url_for_example.py

@@ -0,0 +1,20 @@
+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

@@ -1,4 +1,4 @@
-from sanic.response import text
+from sanic import response
 from sanic import Sanic
 from sanic.blueprints import Blueprint
 
@@ -11,29 +11,29 @@ from sanic.blueprints import Blueprint
 app = Sanic()
 bp = Blueprint("bp", host="bp.example.com")
 
+
 @app.route('/', host=["example.com",
                       "somethingelse.com",
                       "therestofyourdomains.com"])
 async def hello(request):
-    return text("Some defaults")
+    return response.text("Some defaults")
 
-@app.route('/', host="example.com")
-async def hello(request):
-    return text("Answer")
 
 @app.route('/', host="sub.example.com")
 async def hello(request):
-    return text("42")
+    return response.text("42")
+
 
 @bp.route("/question")
 async def hello(request):
-    return text("What is the meaning of life?")
+    return response.text("What is the meaning of life?")
+
 
 @bp.route("/answer")
 async def hello(request):
-    return text("42")
+    return response.text("42")
 
-app.register_blueprint(bp)
+app.blueprint(bp)
 
 if __name__ == '__main__':
-    app.run(host="0.0.0.0", port=8000)
+    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,24 @@
+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(host="0.0.0.0", port=8000, debug=True)
+

pyproject.toml

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

release.py

@@ -0,0 +1,304 @@
+#!/usr/bin/env python
+
+from argparse import ArgumentParser, Namespace
+from collections import OrderedDict
+from configparser import RawConfigParser
+from datetime import datetime
+from json import dumps
+from os import path
+from subprocess import Popen, PIPE
+
+from jinja2 import Environment, BaseLoader
+from requests import patch
+
+GIT_COMMANDS = {
+    "get_tag": ["git describe --tags --abbrev=0"],
+    "commit_version_change": [
+        "git add . && git commit -m 'Bumping up version from "
+        "{current_version} to {new_version}'"
+    ],
+    "create_new_tag": [
+        "git tag -a {new_version} -m 'Bumping up version from "
+        "{current_version} to {new_version}'"
+    ],
+    "push_tag": ["git push origin {new_version}"],
+    "get_change_log": [
+        'git log --no-merges --pretty=format:"%h::: %cn::: %s" '
+        "{current_version}.."
+    ],
+}
+
+
+RELEASE_NOTE_TEMPLATE = """
+# {{ release_name }} - {% now 'utc', '%Y-%m-%d' %}
+
+To see the exhaustive list of pull requests included in this release see:
+https://github.com/huge-success/sanic/milestone/{{milestone}}?closed=1
+
+# Changelog
+{% for row in changelogs %}
+* {{ row -}}
+{% endfor %}
+
+# Credits
+{% for author in authors %}
+* {{ author -}}
+{% endfor %}
+"""
+
+JINJA_RELEASE_NOTE_TEMPLATE = Environment(
+    loader=BaseLoader, extensions=["jinja2_time.TimeExtension"]
+).from_string(RELEASE_NOTE_TEMPLATE)
+
+RELEASE_NOTE_UPDATE_URL = (
+    "https://api.github.com/repos/huge-success/sanic/releases/tags/"
+    "{new_version}?access_token={token}"
+)
+
+
+def _run_shell_command(command: list):
+    try:
+        process = Popen(
+            command, stderr=PIPE, stdout=PIPE, stdin=PIPE, shell=True
+        )
+        output, error = process.communicate()
+        return_code = process.returncode
+        return output.decode("utf-8"), error, return_code
+    except:
+        return None, None, -1
+
+
+def _fetch_default_calendar_release_version():
+    return datetime.now().strftime("%y.%m.0")
+
+
+def _fetch_current_version(config_file: str) -> str:
+    if path.isfile(config_file):
+        config_parser = RawConfigParser()
+        with open(config_file) as cfg:
+            config_parser.read_file(cfg)
+            return (
+                config_parser.get("version", "current_version")
+                or _fetch_default_calendar_release_version()
+            )
+    else:
+        return _fetch_default_calendar_release_version()
+
+
+def _change_micro_version(current_version: str):
+    version_string = current_version.split(".")
+    version_string[-1] = str((int(version_string[-1]) + 1))
+    return ".".join(version_string)
+
+
+def _get_new_version(
+    config_file: str = "./setup.cfg",
+    current_version: str = None,
+    micro_release: bool = False,
+):
+    if micro_release:
+        if current_version:
+            return _change_micro_version(current_version)
+        elif config_file:
+            return _change_micro_version(_fetch_current_version(config_file))
+        else:
+            return _fetch_default_calendar_release_version()
+    else:
+        return _fetch_default_calendar_release_version()
+
+
+def _get_current_tag(git_command_name="get_tag"):
+    global GIT_COMMANDS
+    command = GIT_COMMANDS.get(git_command_name)
+    out, err, ret = _run_shell_command(command)
+    if len(str(out)):
+        return str(out).split("\n")[0]
+    else:
+        return None
+
+
+def _update_release_version_for_sanic(
+    current_version, new_version, config_file
+):
+    config_parser = RawConfigParser()
+    with open(config_file) as cfg:
+        config_parser.read_file(cfg)
+    config_parser.set("version", "current_version", new_version)
+
+    version_file = config_parser.get("version", "file")
+    current_version_line = config_parser.get(
+        "version", "current_version_pattern"
+    ).format(current_version=current_version)
+    new_version_line = config_parser.get(
+        "version", "new_version_pattern"
+    ).format(new_version=new_version)
+
+    with open(version_file) as init_file:
+        data = init_file.read()
+
+    new_data = data.replace(current_version_line, new_version_line)
+    with open(version_file, "w") as init_file:
+        init_file.write(new_data)
+
+    with open(config_file, "w") as config:
+        config_parser.write(config)
+
+    command = GIT_COMMANDS.get("commit_version_change")
+    command[0] = command[0].format(
+        new_version=new_version, current_version=current_version
+    )
+    _, err, ret = _run_shell_command(command)
+    if int(ret) != 0:
+        print(
+            "Failed to Commit Version upgrade changes to Sanic: {}".format(
+                err.decode("utf-8")
+            )
+        )
+        exit(1)
+
+
+def _generate_change_log(current_version: str = None):
+    global GIT_COMMANDS
+    command = GIT_COMMANDS.get("get_change_log")
+    command[0] = command[0].format(current_version=current_version)
+    output, error, ret = _run_shell_command(command=command)
+    if not len(str(output)):
+        print("Unable to Fetch Change log details to update the Release Note")
+        exit(1)
+
+    commit_details = OrderedDict()
+    commit_details["authors"] = dict()
+    commit_details["commits"] = list()
+
+    for line in str(output).split("\n"):
+        commit, author, description = line.split(":::")
+        if "GitHub" not in author:
+            commit_details["authors"][author] = 1
+        commit_details["commits"].append(" - ".join([commit, description]))
+
+    return commit_details
+
+
+def _generate_markdown_document(
+    milestone, release_name, current_version, release_version
+):
+    global JINJA_RELEASE_NOTE_TEMPLATE
+    release_name = release_name or release_version
+    change_log = _generate_change_log(current_version=current_version)
+    return JINJA_RELEASE_NOTE_TEMPLATE.render(
+        release_name=release_name,
+        milestone=milestone,
+        changelogs=change_log["commits"],
+        authors=change_log["authors"].keys(),
+    )
+
+
+def _tag_release(new_version, current_version, milestone, release_name, token):
+    global GIT_COMMANDS
+    global RELEASE_NOTE_UPDATE_URL
+    for command_name in ["create_new_tag", "push_tag"]:
+        command = GIT_COMMANDS.get(command_name)
+        command[0] = command[0].format(
+            new_version=new_version, current_version=current_version
+        )
+        out, error, ret = _run_shell_command(command=command)
+        if int(ret) != 0:
+            print("Failed to execute the command: {}".format(command[0]))
+            exit(1)
+
+    change_log = _generate_markdown_document(
+        milestone, release_name, current_version, new_version
+    )
+
+    body = {"name": release_name or new_version, "body": change_log}
+
+    headers = {"content-type": "application/json"}
+
+    response = patch(
+        RELEASE_NOTE_UPDATE_URL.format(new_version=new_version, token=token),
+        data=dumps(body),
+        headers=headers,
+    )
+    response.raise_for_status()
+
+
+def release(args: Namespace):
+    current_tag = _get_current_tag()
+    current_version = _fetch_current_version(args.config)
+    if current_tag and current_version not in current_tag:
+        print(
+            "Tag mismatch between what's in git and what was provided by "
+            "--current-version. Existing: {}, Give: {}".format(
+                current_tag, current_version
+            )
+        )
+        exit(1)
+    new_version = args.release_version or _get_new_version(
+        args.config, current_version, args.micro_release
+    )
+    _update_release_version_for_sanic(
+        current_version=current_version,
+        new_version=new_version,
+        config_file=args.config,
+    )
+    _tag_release(
+        current_version=current_version,
+        new_version=new_version,
+        milestone=args.milestone,
+        release_name=args.release_name,
+        token=args.token,
+    )
+
+
+if __name__ == "__main__":
+    cli = ArgumentParser(description="Sanic Release Manager")
+    cli.add_argument(
+        "--release-version",
+        "-r",
+        help="New Version to use for Release",
+        default=_fetch_default_calendar_release_version(),
+        required=False,
+    )
+    cli.add_argument(
+        "--current-version",
+        "-cv",
+        help="Current Version to default in case if you don't want to "
+        "use the version configuration files",
+        default=None,
+        required=False,
+    )
+    cli.add_argument(
+        "--config",
+        "-c",
+        help="Configuration file used for release",
+        default="./setup.cfg",
+        required=False,
+    )
+    cli.add_argument(
+        "--token",
+        "-t",
+        help="Git access token with necessary access to Huge Sanic Org",
+        required=True,
+    )
+    cli.add_argument(
+        "--milestone",
+        "-ms",
+        help="Git Release milestone information to include in relase note",
+        required=True,
+    )
+    cli.add_argument(
+        "--release-name",
+        "-n",
+        help="Release Name to use if any",
+        required=False,
+    )
+    cli.add_argument(
+        "--micro-release",
+        "-m",
+        help="Micro Release with patches only",
+        default=False,
+        action="store_true",
+        required=False,
+    )
+    args = cli.parse_args()
+    release(args)

requirements-dev.txt

@@ -1,18 +0,0 @@
-aiocache
-aiofiles
-aiohttp
-beautifulsoup4
-bottle
-coverage
-falcon
-gunicorn
-httptools
-kyoukai
-pytest
-recommonmark
-sphinx
-sphinx_rtd_theme
-tornado
-tox
-ujson
-uvloop

requirements.txt

@@ -1,4 +0,0 @@
-aiofiles
-httptools
-ujson
-uvloop

sanic/__init__.py

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

sanic/__main__.py

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

sanic/blueprint_group.py

@@ -0,0 +1,120 @@
+from collections import MutableSequence
+
+
+class BlueprintGroup(MutableSequence):
+    """
+    This class provides a mechanism to implement a Blueprint Group
+    using the `Blueprint.group` method. To avoid having to re-write
+    some of the existing implementation, this class provides a custom
+    iterator implementation that will let you use the object of this
+    class as a list/tuple inside the existing implementation.
+    """
+
+    __slots__ = ("_blueprints", "_url_prefix")
+
+    def __init__(self, url_prefix=None):
+        """
+        Create a new Blueprint Group
+
+        :param url_prefix: URL: to be prefixed before all the Blueprint Prefix
+        """
+        self._blueprints = []
+        self._url_prefix = url_prefix
+
+    @property
+    def url_prefix(self):
+        """
+        Retrieve the URL prefix being used for the Current Blueprint Group
+        :return: string with url prefix
+        """
+        return self._url_prefix
+
+    @property
+    def blueprints(self):
+        """
+        Retrieve a list of all the available blueprints under this group.
+        :return: List of Blueprint instance
+        """
+        return self._blueprints
+
+    def __iter__(self):
+        """Tun the class Blueprint Group into an Iterable item"""
+        return iter(self._blueprints)
+
+    def __getitem__(self, item):
+        """
+        This method returns a blueprint inside the group specified by
+        an index value. This will enable indexing, splice and slicing
+        of the blueprint group like we can do with regular list/tuple.
+
+        This method is provided to ensure backward compatibility with
+        any of the pre-existing usage that might break.
+
+        :param item: Index of the Blueprint item in the group
+        :return: Blueprint object
+        """
+        return self._blueprints[item]
+
+    def __setitem__(self, index: int, item: object) -> None:
+        """
+        Abstract method implemented to turn the `BlueprintGroup` class
+        into a list like object to support all the existing behavior.
+
+        This method is used to perform the list's indexed setter operation.
+
+        :param index: Index to use for inserting a new Blueprint item
+        :param item: New `Blueprint` object.
+        :return: None
+        """
+        self._blueprints[index] = item
+
+    def __delitem__(self, index: int) -> None:
+        """
+        Abstract method implemented to turn the `BlueprintGroup` class
+        into a list like object to support all the existing behavior.
+
+        This method is used to delete an item from the list of blueprint
+        groups like it can be done on a regular list with index.
+
+        :param index: Index to use for removing a new Blueprint item
+        :return: None
+        """
+        del self._blueprints[index]
+
+    def __len__(self) -> int:
+        """
+        Get the Length of the blueprint group object.
+        :return: Length of Blueprint group object
+        """
+        return len(self._blueprints)
+
+    def insert(self, index: int, item: object) -> None:
+        """
+        The Abstract class `MutableSequence` leverages this insert method to
+        perform the `BlueprintGroup.append` operation.
+
+        :param index: Index to use for removing a new Blueprint item
+        :param item: New `Blueprint` object.
+        :return: None
+        """
+        self._blueprints.insert(index, item)
+
+    def middleware(self, *args, **kwargs):
+        """
+        A decorator that can be used to implement a Middleware plugin to
+        all of the Blueprints that belongs to this specific Blueprint Group.
+
+        In case of nested Blueprint Groups, the same middleware is applied
+        across each of the Blueprints recursively.
+
+        :param args: Optional positional Parameters to be use middleware
+        :param kwargs: Optional Keyword arg to use with Middleware
+        :return: Partial function to apply the middleware
+        """
+        kwargs["bp_group"] = True
+
+        def register_middleware_for_blueprints(fn):
+            for blueprint in self.blueprints:
+                blueprint.middleware(fn, *args, **kwargs)
+
+        return register_middleware_for_blueprints