113 lines
2.6 KiB
ReStructuredText
113 lines
2.6 KiB
ReStructuredText
API Reference
|
|
=============
|
|
|
|
``microdot`` module
|
|
-------------------
|
|
|
|
The ``microdot`` module defines a few classes that help implement HTTP-based
|
|
servers for MicroPython and standard Python, with multithreading support for
|
|
Python interpreters that support it.
|
|
|
|
``Microdot`` class
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot.Microdot
|
|
:members:
|
|
|
|
``Request`` class
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot.Request
|
|
:members:
|
|
|
|
``Response`` class
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot.Response
|
|
:members:
|
|
|
|
``MultiDict`` class
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot.MultiDict
|
|
:members:
|
|
|
|
``microdot_asyncio`` module
|
|
---------------------------
|
|
|
|
The ``microdot_asyncio`` module defines a few classes that help implement
|
|
HTTP-based servers for MicroPython and standard Python that use ``asyncio``
|
|
and coroutines.
|
|
|
|
``Microdot`` class
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot_asyncio.Microdot
|
|
:inherited-members:
|
|
:members:
|
|
|
|
``Request`` class
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot_asyncio.Request
|
|
:inherited-members:
|
|
:members:
|
|
|
|
``Response`` class
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot_asyncio.Response
|
|
:inherited-members:
|
|
:members:
|
|
|
|
``microdot_test_client`` module
|
|
-------------------------------
|
|
|
|
The ``microdot_test_client`` module defines a test client that can be used to
|
|
create automated tests for the Microdot server.
|
|
|
|
``TestClient`` class
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot_test_client.TestClient
|
|
:members:
|
|
|
|
``TestResponse`` class
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot_test_client.TestResponse
|
|
:members:
|
|
|
|
``microdot_wsgi`` module
|
|
------------------------
|
|
|
|
The ``microdot_wsgi`` module provides an extended ``Microdot`` class that
|
|
implements the WSGI protocol and can be used with a compliant WSGI web server
|
|
such as `Gunicorn <https://gunicorn.org/>`_ or
|
|
`uWSGI <https://uwsgi-docs.readthedocs.io/en/latest/>`_. Since there are
|
|
no WSGI web servers available for MicroPython, this support is currently
|
|
limited to standard Python.
|
|
|
|
``Microdot`` class
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot_wsgi.Microdot
|
|
:members:
|
|
:exclude-members: shutdown, run
|
|
|
|
``microdot_asgi`` module
|
|
------------------------
|
|
|
|
The ``microdot_asgi`` module provides an extended ``Microdot`` class that
|
|
implements the ASGI protocol and can be used with a compliant ASGI server such
|
|
as `Uvicorn <https://www.uvicorn.org/>`_. Since there are no ASGI web servers
|
|
available for MicroPython, this support is currently limited to standard
|
|
Python.
|
|
|
|
``Microdot`` class
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: microdot_asgi.Microdot
|
|
:members:
|
|
:exclude-members: shutdown, run
|