make release script black compliant and tweak documentation with inde…

…xing and format

Signed-off-by: Harsha Narayana <[email protected]>

docs/index.rst

@@ -7,24 +7,24 @@ 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/websocket
-   sanic/config
-   sanic/cookies
    sanic/decorators
    sanic/streaming
    sanic/class_based_views
    sanic/custom_protocol
    sanic/sockets
    sanic/ssl
-   sanic/logging
-   sanic/versioning
    sanic/debug_mode
    sanic/testing
    sanic/deploying

docs/sanic/blueprints.md

@@ -118,9 +118,9 @@ app = Sanic(__name__)
 app.blueprint(api)
 ```
 
-## Using blueprints
+## Using Blueprints
 
-Blueprints have much the same functionality as an application instance.
+Blueprints have almost the same functionality as an application instance.
 
 ### WebSocket routes
 
@@ -201,7 +201,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.
 
@@ -210,8 +210,8 @@ 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):
@@ -222,7 +222,7 @@ 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.
 
@@ -232,8 +232,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)
 ```
@@ -246,7 +246,7 @@ takes the format `<blueprint_name>.<handler_name>`. For example:
 ```python
 @blueprint_v1.route('/')
 async def root(request):
-    url = request.app.url_for('v1.post_handler', post_id=5) # --> '/v1/post/5'
+    url = request.app.url_for('v1.post_handler', post_id=5) # --> '/v1/api/post/5'
     return redirect(url)
 
 

docs/sanic/config.md

@@ -85,29 +85,52 @@ 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 to arrive (sec)            |
-    | RESPONSE_TIMEOUT          | 60        | How long a response can take to process (sec)          |
-    | KEEP_ALIVE                | True      | Disables keep-alive when False                         |
-    | KEEP_ALIVE_TIMEOUT        | 5         | How long to hold a TCP connection open (sec)           |
-    | GRACEFUL_SHUTDOWN_TIMEOUT | 15.0      | How long take to force close non-idle connection (sec) |
-    | ACCESS_LOG                | True      | Disable or enable access log                           |
+    | Variable                  | Default   | Description                                               |
+    | ------------------------- | --------- | --------------------------------------------------------- |
+    | REQUEST_MAX_SIZE          | 100000000 | How big a request may be (bytes)                          |
+    | REQUEST_TIMEOUT           | 60        | How long a request can take to arrive (sec)               |
+    | RESPONSE_TIMEOUT          | 60        | How long a response can take to process (sec)             |
+    | KEEP_ALIVE                | True      | Disables keep-alive when False                            |
+    | KEEP_ALIVE_TIMEOUT        | 5         | How long to hold a TCP connection open (sec)              |
+    | GRACEFUL_SHUTDOWN_TIMEOUT | 15.0      | How long to wait to force close non-idle connection (sec) |
+    | ACCESS_LOG                | True      | Disable or enable access log                              |
 
 ### The different Timeout variables:
 
-A request timeout measures the duration of time between the instant when a new open TCP connection is passed to the Sanic backend server, and the instant when the whole HTTP request is received. If the time taken exceeds the `REQUEST_TIMEOUT` value (in seconds), this is considered a Client Error so Sanic generates a HTTP 408 response and sends that to the client. Adjust this value higher if your clients routinely pass very large request payloads or upload requests very slowly.
+#### `REQUEST_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 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.
+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.
 
-### What is Keep Alive? And what does the Keep Alive Timeout value do?
+#### `RESPONSE_TIMEOUT`
 
-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.
+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.
 
-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.
+#### `KEEP_ALIVE_TIMEOUT`
 
-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.
+##### 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:
 ```

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/extensions.md

@@ -11,6 +11,7 @@ A list of Sanic extensions created by the community.
 ## 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.
 - [Sanic-JWT-Extended](https://github.com/devArtoria/Sanic-JWT-Extended): Provides extended JWT support for