Vasanko/sanic
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Add return type to Sanic.create_server for type hinting and docs (#1724)

Browse Source 
* add type hint and doc when create_server returns AsyncioServer

* fix linting
This commit is contained in:
Adam Bannister 2019-12-12 17:25:13 +01:00 committed by Stephen Sadowski
parent 4c45d30400
commit 2d72874b0b
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sanic/app.py
View File

@ -24,7 +24,13 @@ from sanic.handlers import ErrorHandler
from sanic.log import LOGGING_CONFIG_DEFAULTS, error_logger, logger from sanic.log import LOGGING_CONFIG_DEFAULTS, error_logger, logger
from sanic.response import HTTPResponse, StreamingHTTPResponse from sanic.response import HTTPResponse, StreamingHTTPResponse
from sanic.router import Router from sanic.router import Router
from sanic.server import HttpProtocol, Signal, serve, serve_multiple from sanic.server import (
AsyncioServer,
HttpProtocol,
Signal,
serve,
serve_multiple,
)
from sanic.static import register as static_register from sanic.static import register as static_register
from sanic.testing import SanicASGITestClient, SanicTestClient from sanic.testing import SanicASGITestClient, SanicTestClient
from sanic.views import CompositionView from sanic.views import CompositionView
@ -1166,7 +1172,7 @@ class Sanic:
access_log: Optional[bool] = None, access_log: Optional[bool] = None,
return_asyncio_server=False, return_asyncio_server=False,
asyncio_server_kwargs=None, asyncio_server_kwargs=None,
) -> None: ) -> Optional[AsyncioServer]:
""" """
Asynchronous version of :func:`run`. Asynchronous version of :func:`run`.
@ -1206,7 +1212,7 @@ class Sanic:
:param asyncio_server_kwargs: key-value arguments for :param asyncio_server_kwargs: key-value arguments for
asyncio/uvloop create_server method asyncio/uvloop create_server method
:type asyncio_server_kwargs: dict :type asyncio_server_kwargs: dict
:return: Nothing :return: AsyncioServer if return_asyncio_server is true, else Nothing
""" """
if sock is None: if sock is None: