LICENSE

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

MANIFEST.in

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

README.rst

@@ -31,13 +31,13 @@ Hello World Example
 Installation
 ------------
 
--  ``python -m pip install sanic``
+-  ``pip install sanic``
 
 To install sanic without uvloop or json using bash, you can provide either or both of these environmental variables
 using any truthy string like `'y', 'yes', 't', 'true', 'on', '1'` and setting the NO_X to true will stop that features
 installation.
 
-- ``SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true python -m pip install sanic``
+- ``SANIC_NO_UVLOOP=true SANIC_NO_UJSON=true pip install sanic``
 
 
 Documentation

docs/conf.py

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

docs/sanic/blueprints.md

@@ -93,7 +93,14 @@ def ignore_404s(request, exception):
 Static files can be served globally, under the blueprint prefix.
 
 ```python
-bp.static('/folder/to/serve', '/web/path')
+
+# suppose bp.name == 'bp'
+
+bp.static('/web/path', '/folder/to/serve')
+# also you can pass name parameter to it for url_for
+bp.static('/web/path', '/folder/to/server', name='uploads')
+app.url_for('static', name='bp.uploads', filename='file.txt') == '/bp/web/path/file.txt'
+
 ```
 
 ## Start and stop
@@ -172,7 +179,7 @@ takes the format `<blueprint_name>.<handler_name>`. For example:
 ```python
 @blueprint_v1.route('/')
 async def root(request):
-    url = app.url_for('v1.post_handler', post_id=5) # --> '/v1/post/5'
+    url = request.app.url_for('v1.post_handler', post_id=5) # --> '/v1/post/5'
     return redirect(url)
 
 

docs/sanic/config.md

@@ -29,9 +29,15 @@ In general the convention is to only have UPPERCASE configuration parameters. Th
 
 There are several ways how to load configuration.
 
-### From environment variables.
+### From Environment Variables
 
-Any variables defined with the `SANIC_` prefix will be applied to the sanic config. For example, setting `SANIC_REQUEST_TIMEOUT` will be loaded by the application automatically. You can pass the `load_env` boolean to the Sanic constructor to override that:
+Any variables defined with the `SANIC_` prefix will be applied to the sanic config. For example, setting `SANIC_REQUEST_TIMEOUT` will be loaded by the application automatically and fed into the `REQUEST_TIMEOUT` config variable. You can pass a different prefix to Sanic:
+
+```python
+app = Sanic(load_env='MYAPP_')
+```
+
+Then the above variable would be `MYAPP_REQUEST_TIMEOUT`. If you want to disable loading from environment variables you can set it to `False` instead:
 
 ```python
 app = Sanic(load_env=False)
@@ -79,8 +85,35 @@ DB_USER = 'appuser'
 
 Out of the box there are just a few predefined values which can be overwritten when creating the application.
 
-    | Variable          | Default   | Description                       |
-    | ----------------- | --------- | --------------------------------- |
-    | REQUEST_MAX_SIZE  | 100000000 | How big a request may be (bytes)  |
-    | REQUEST_TIMEOUT   | 60        | How long a request can take (sec) |
-    | KEEP_ALIVE        | True      | Disables keep-alive when False    |
+    | Variable           | Default   | Description                                   |
+    | ------------------ | --------- | --------------------------------------------- |
+    | REQUEST_MAX_SIZE   | 100000000 | How big a request may be (bytes)              |
+    | REQUEST_TIMEOUT    | 60        | How long a request can take to arrive (sec)   |
+    | RESPONSE_TIMEOUT   | 60        | How long a response can take to process (sec) |
+    | KEEP_ALIVE         | True      | Disables keep-alive when False                |
+    | KEEP_ALIVE_TIMEOUT | 5         | How long to hold a TCP connection open (sec)  |
+
+### The different Timeout variables:
+
+A request timeout measures the duration of time between the instant when a new open TCP connection is passed to the Sanic backend server, and the instant when the whole HTTP request is received. If the time taken exceeds the `REQUEST_TIMEOUT` value (in seconds), this is considered a Client Error so Sanic generates a HTTP 408 response and sends that to the client. Adjust this value higher if your clients routinely pass very large request payloads or upload requests very slowly.
+
+A response timeout measures the duration of time between the instant the Sanic server passes the HTTP request to the Sanic App, and the instant a HTTP response is sent to the client. If the time taken exceeds the `RESPONSE_TIMEOUT` value (in seconds), this is considered a Server Error so Sanic generates a HTTP 503 response and sets that to the client. Adjust this value higher if your application is likely to have long-running process that delay the generation of a response.
+
+### What is Keep Alive? And what does the Keep Alive Timeout value do?
+
+Keep-Alive is a HTTP feature indroduced in HTTP 1.1. When sending a HTTP request, the client (usually a web browser application) can set a Keep-Alive header to indicate for the http server (Sanic) to not close the TCP connection after it has send the response. This allows the client to reuse the existing TCP connection to send subsequent HTTP requests, and ensures more efficient network traffic for both the client and the server.
+
+The `KEEP_ALIVE` config variable is set to `True` in Sanic by default. If you don't need this feature in your application, set it to `False` to cause all client connections to close immediately after a response is sent, regardless of the Keep-Alive header on the request.
+
+The amount of time the server holds the TCP connection open is decided by the server itself. In Sanic, that value is configured using the `KEEP_ALIVE_TIMEOUT` value. By default, it is set to 5 seconds, this is the same default setting as the Apache HTTP server and is a good balance between allowing enough time for the client to send a new request, and not holding open too many connections at once. Do not exceed 75 seconds unless you know your clients are using a browser which supports TCP connections held open for that long.
+
+For reference:
+```
+Apache httpd server default keepalive timeout = 5 seconds
+Nginx server default keepalive timeout = 75 seconds
+Nginx performance tuning guidelines uses keepalive = 15 seconds
+IE (5-9) client hard keepalive limit = 60 seconds
+Firefox client hard keepalive limit = 115 seconds
+Opera 11 client hard keepalive limit = 120 seconds
+Chrome 13+ client keepalive limit > 300+ seconds
+```

docs/sanic/extensions.md

@@ -1,12 +1,13 @@
 # Extensions
 
 A list of Sanic extensions created by the community.
-
+- [Sanic-Plugins-Framework](https://github.com/ashleysommer/sanicpluginsframework): Library for easily creating and using Sanic plugins.
 - [Sessions](https://github.com/subyraman/sanic_session): Support for sessions.
   Allows using redis, memcache or an in memory store.
 - [CORS](https://github.com/ashleysommer/sanic-cors): A port of flask-cors.
 - [Compress](https://github.com/subyraman/sanic_compress): Allows you to easily gzip Sanic responses. A port of Flask-Compress.
 - [Jinja2](https://github.com/lixxu/sanic-jinja2): Support for Jinja2 template.
+- [JWT](https://github.com/ahopkins/sanic-jwt): Authentication extension for JSON Web Tokens (JWT).
 - [OpenAPI/Swagger](https://github.com/channelcat/sanic-openapi): OpenAPI support, plus a Swagger UI.
 - [Pagination](https://github.com/lixxu/python-paginate): Simple pagination support.
 - [Motor](https://github.com/lixxu/sanic-motor): Simple motor wrapper.

docs/sanic/getting_started.md

@@ -9,15 +9,16 @@ syntax, so earlier versions of python won't work.
 
   ```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`

docs/sanic/logging.md

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

docs/sanic/middleware.md

@@ -4,7 +4,7 @@ Middleware are functions which are executed before or after requests to the
 server. They can be used to modify the *request to* or *response from*
 user-defined handler functions.
 
-Additionally, Sanic providers listeners which allow you to run code at various points of your application's lifecycle.
+Additionally, Sanic provides listeners which allow you to run code at various points of your application's lifecycle.
 
 ## Middleware
 

docs/sanic/request_data.md

@@ -71,8 +71,14 @@ The following variables are accessible as properties on `Request` objects:
       return text("You are trying to create a user with the following POST: %s" % request.body)
   ```
 
+- `headers` (dict) - A case-insensitive dictionary that contains the request headers.
+
 - `ip` (str) - IP address of the requester.
 
+- `port` (str) - Port address of the requester.
+
+- `socket` (tuple) - (IP, port) of the requester.
+
 - `app` - a reference to the Sanic application object that is handling this request. This is useful when inside blueprints or other handlers in modules that do not have access to the global `app` object.
 
   ```python
@@ -95,6 +101,7 @@ The following variables are accessible as properties on `Request` objects:
 - `path`: The path of the request: `/posts/1/`
 - `query_string`: The query string of the request: `foo=bar` or a blank string `''`
 - `uri_template`: Template for matching route handler: `/posts/<id>/`
+- `token`: The value of Authorization header: `Basic YWRtaW46YWRtaW4=`
 
 
 ## Accessing values using `get` and `getlist`