From c708e8425f34d6764e43625a1a20c0c4da89b03f Mon Sep 17 00:00:00 2001 From: Adam Hopkins Date: Fri, 26 Oct 2018 11:29:53 +0300 Subject: [PATCH] Fix documentation build errors --- docs/_static/.gitkeep | 0 docs/index.rst | 2 ++ docs/sanic/middleware.md | 24 ++++++++++++------------ docs/sanic/websocket.rst | 1 + sanic/__main__.py | 2 +- sanic/app.py | 7 +++---- sanic/cookies.py | 2 +- sanic/testing.py | 2 +- 8 files changed, 21 insertions(+), 19 deletions(-) create mode 100644 docs/_static/.gitkeep diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/docs/index.rst b/docs/index.rst index fb8a45c4..7d440e27 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,6 +24,8 @@ Guides sanic/sockets sanic/ssl sanic/logging + sanic/versioning + sanic/debug_mode sanic/testing sanic/deploying sanic/extensions diff --git a/docs/sanic/middleware.md b/docs/sanic/middleware.md index e041d452..823d3916 100644 --- a/docs/sanic/middleware.md +++ b/docs/sanic/middleware.md @@ -17,7 +17,7 @@ string representing its type: `'request'` or `'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") @@ -33,7 +33,7 @@ Middleware can modify the request or response parameter it is given, *as long as it does not return it*. The following example shows a practical use-case for this. -```python +``` app = Sanic(__name__) @app.middleware('response') @@ -60,7 +60,7 @@ and the response will be returned. If this occurs to a request before the relevant user route handler is reached, the handler will never be called. Returning a response will also prevent any further middleware from running. -```python +``` @app.middleware('request') async def halt_request(request): return text('I halted the request') @@ -79,11 +79,11 @@ If you want to execute startup/teardown code as your server starts or closes, yo - `before_server_stop` - `after_server_stop` -These listeners are implemented as decorators on functions which accept the app object as well as the asyncio loop. +These listeners are implemented as decorators on functions which accept the app object as well as the asyncio loop. For example: -```python +``` @app.listener('before_server_start') async def setup_db(app, loop): app.db = await db_setup() @@ -101,16 +101,16 @@ async def close_db(app, loop): await app.db.close() ``` -It's also possible to register a listener using the `register_listener` method. +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. -```python +``` app = Sanic() - + async def setup_db(app, loop): app.db = await db_setup() - + app.register_listener(setup_db, 'before_server_start') ``` @@ -118,7 +118,7 @@ app.register_listener(setup_db, 'before_server_start') If you want to schedule a background task to run after the loop has started, Sanic provides the `add_task` method to easily do so. -```python +``` async def notify_server_started_after_five_seconds(): await asyncio.sleep(5) print('Server successfully started!') @@ -128,7 +128,7 @@ 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: -```python +``` async def notify_server_started_after_five_seconds(app): await asyncio.sleep(5) print(app.name) @@ -138,7 +138,7 @@ app.add_task(notify_server_started_after_five_seconds) Or you can pass the app explicitly for the same effect: -```python +``` async def notify_server_started_after_five_seconds(app): await asyncio.sleep(5) print(app.name) diff --git a/docs/sanic/websocket.rst b/docs/sanic/websocket.rst index 8b813bf8..133e73da 100644 --- a/docs/sanic/websocket.rst +++ b/docs/sanic/websocket.rst @@ -43,6 +43,7 @@ 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 diff --git a/sanic/__main__.py b/sanic/__main__.py index 9bef96fc..73de3265 100644 --- a/sanic/__main__.py +++ b/sanic/__main__.py @@ -52,5 +52,5 @@ if __name__ == "__main__": " Example File: project/sanic_server.py -> app\n" " Example Module: project.sanic_server.app".format(e.name) ) - except ValueError as e: + except ValueError: logger.exception("Failed to run app") diff --git a/sanic/app.py b/sanic/app.py index 7c0a3612..8d9cf5b0 100644 --- a/sanic/app.py +++ b/sanic/app.py @@ -371,8 +371,7 @@ class Sanic: ): """Decorate a function to be registered as a websocket route :param uri: path of the URL - :param subprotocols: optional list of strings with the supported - subprotocols + :param subprotocols: optional list of str with supported subprotocols :param host: :return: decorated function """ @@ -568,7 +567,7 @@ class Sanic: return self.blueprint(*args, **kwargs) def url_for(self, view_name: str, **kwargs): - """Build a URL based on a view name and the values provided. + r"""Build a URL based on a view name and the values provided. In order to build a URL, all request parameters must be supplied as keyword arguments, and each parameter must pass the test for the @@ -579,7 +578,7 @@ class Sanic: the output URL's query string. :param view_name: string referencing the view name - :param \*\*kwargs: keys and values that are used to build request + :param \**kwargs: keys and values that are used to build request parameters and query string arguments. :return: the built URL diff --git a/sanic/cookies.py b/sanic/cookies.py index fc49ecfd..8210d8f4 100644 --- a/sanic/cookies.py +++ b/sanic/cookies.py @@ -18,7 +18,7 @@ _Translator.update({ord('"'): '\\"', ord("\\"): "\\\\"}) def _quote(str): - """Quote a string for use in a cookie header. + r"""Quote a string for use in a cookie header. If the string does not need to be double-quoted, then just return the string. Otherwise, surround the string in doublequotes and quote (with a \) special characters. diff --git a/sanic/testing.py b/sanic/testing.py index 6658f7e1..eda52d61 100644 --- a/sanic/testing.py +++ b/sanic/testing.py @@ -34,7 +34,7 @@ class SanicTestClient: ) as response: try: response.text = await response.text() - except UnicodeDecodeError as e: + except UnicodeDecodeError: response.text = None try: