91 lines
2.8 KiB
ReStructuredText
91 lines
2.8 KiB
ReStructuredText
|
Welcome to Sanic's documentation!
|
||
|
|
=================================
|
||
|
|
|
||
|
|
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/>`_.
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
Sanic is developed `on GitHub <https://github.com/channelcat/sanic/>`_. Contributions are welcome!
|
||
|
|
|
||
|
|
Benchmarks
|
||
|
|
----------
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
+-----------+-----------------------+----------------+---------------+
|
||
|
|
| 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
|
||
|
|
-------------------
|
||
|
|
|
||
|
|
.. code:: python
|
||
|
|
|
||
|
|
from sanic import Sanic
|
||
|
|
from sanic.response import json
|
||
|
|
|
||
|
|
|
||
|
|
app = Sanic()
|
||
|
|
|
||
|
|
|
||
|
|
@app.route("/")
|
||
|
|
async def test(request):
|
||
|
|
return json({"hello": "world"})
|
||
|
|
|
||
|
|
if __name__ == "__main__":
|
||
|
|
app.run(host="0.0.0.0", port=8000)
|
||
|
|
|
||
|
|
Installation
|
||
|
|
------------
|
||
|
|
|
||
|
|
- ``python -m pip install sanic``
|
||
|
|
|
||
|
|
Guides
|
||
|
|
======
|
||
|
|
|
||
|
|
.. toctree::
|
||
|
|
:maxdepth: 2
|
||
|
|
|
||
|
|
getting_started
|
||
|
|
request_data
|
||
|
|
routing
|
||
|
|
middleware
|
||
|
|
exceptions
|
||
|
|
blueprints
|
||
|
|
class_based_views
|
||
|
|
cookies
|
||
|
|
static_files
|
||
|
|
testing
|
||
|
|
deploying
|
||
|
|
contributing
|
||
|
|
|
||
|
|
|
||
|
|
Module Documentation
|
||
|
|
====================
|
||
|
|
|
||
|
|
.. toctree::
|
||
|
|
|
||
|
|
Module Reference <sanic>
|
||
|
|
|
||
|
|
* :ref:`genindex`
|
||
|
|
* :ref:`search`
|