Compare commits
35 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f23c78533e | ||
|
|
d29ed6aaa1 | ||
|
|
8e5fb92ff1 | ||
|
|
06015934b8 | ||
|
|
568cd51fd2 | ||
|
|
2fe9793389 | ||
|
|
de9c991a9a | ||
|
|
d75449eb32 | ||
|
|
e508abc333 | ||
|
|
5003a5b3d9 | ||
|
|
4ed101dfc6 | ||
|
|
833fecb105 | ||
|
|
d527bdb7c3 | ||
|
|
2516b296a7 | ||
|
|
5061145f5c | ||
|
|
122c638bae | ||
|
|
bd74bcab74 | ||
|
|
5cd3ace516 | ||
|
|
da32f23e35 | ||
|
|
0641466faa | ||
|
|
dd3fc20507 | ||
|
|
46963ba464 | ||
|
|
1a8db51cb3 | ||
|
|
d903c42370 | ||
|
|
8b4ebbd953 | ||
|
|
a82ed55f56 | ||
|
|
ac87f0542f | ||
|
|
2de57498a8 | ||
|
|
b7b881e3c7 | ||
|
|
9955ac99a6 | ||
|
|
4b101d1597 | ||
|
|
097cd9cf02 | ||
|
|
b0c25a1a72 | ||
|
|
b7b8e58d6a | ||
|
|
12cd60305b |
4
.github/workflows/tests.yml
vendored
4
.github/workflows/tests.yml
vendored
@@ -2,10 +2,10 @@ name: build
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
- main
|
||||
jobs:
|
||||
lint:
|
||||
name: lint
|
||||
|
||||
82
CHANGES.md
Normal file
82
CHANGES.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# Microdot change log
|
||||
|
||||
**Release 0.7.2** - 2021-09-28
|
||||
|
||||
- Document a security risk in the send_file function ([commit](https://github.com/miguelgrinberg/microdot/commit/d29ed6aaa1f2080fcf471bf6ae0f480f95ff1716)) (thanks **Ky Tran**!)
|
||||
- Validate redirect URLs ([commit](https://github.com/miguelgrinberg/microdot/commit/8e5fb92ff1ccd50972b0c1cb5a6c3bd5eb54d86b)) (thanks **Ky Tran**!)
|
||||
- Return a 400 error when request object could not be created ([commit](https://github.com/miguelgrinberg/microdot/commit/06015934b834622d39f52b3e13d16bfee9dc8e5a))
|
||||
|
||||
**Release 0.7.1** - 2021-09-27
|
||||
|
||||
- Breaking change: Limit the size of each request line to 2KB. A different maximum can be set in `Request.max_readline`. ([commit](https://github.com/miguelgrinberg/microdot/commit/de9c991a9ab836d57d5c08bf4282f99f073b502a)) (thanks **Ky Tran**!)
|
||||
|
||||
**Release 0.7.0** - 2021-09-27
|
||||
|
||||
- Breaking change: Limit the size of the request body to 16KB. A different maximum can be set in `Request.max_content_length`. ([commit](https://github.com/miguelgrinberg/microdot/commit/5003a5b3d948a7cf365857b419bebf6e388593a1))
|
||||
- Add documentation for `request.client_addr` [#27](https://github.com/miguelgrinberg/microdot/issues/27) ([commit](https://github.com/miguelgrinberg/microdot/commit/833fecb105ce456b95f1d2a6ea96dceca1075814)) (thanks **Mark Blakeney**!)
|
||||
- Added documentation for reason argument in the Response object ([commit](https://github.com/miguelgrinberg/microdot/commit/d527bdb7c32ab918a1ecf6956cf3a9f544504354))
|
||||
|
||||
**Release 0.6.0** - 2021-08-11
|
||||
|
||||
- Better handling of content types in form and json methods [#24](https://github.com/miguelgrinberg/microdot/issues/24) ([commit](https://github.com/miguelgrinberg/microdot/commit/da32f23e35f871470a40638e7000e84b0ff6d17f))
|
||||
- Accept a custom reason phrase for the HTTP response [#25](https://github.com/miguelgrinberg/microdot/issues/25) ([commit](https://github.com/miguelgrinberg/microdot/commit/bd74bcab74f283c89aadffc8f9c20d6ff0f771ce))
|
||||
- Make mime type check for form submissions more robust ([commit](https://github.com/miguelgrinberg/microdot/commit/dd3fc20507715a23d0fa6fa3aae3715c8fbc0351))
|
||||
- Copy client headers to avoid write back [#23](https://github.com/miguelgrinberg/microdot/issues/23) ([commit](https://github.com/miguelgrinberg/microdot/commit/0641466faa9dda0c54f78939ac05993c0812e84a)) (thanks **Mark Blakeney**!)
|
||||
- Work around a bug in uasyncio's create_server() function ([commit](https://github.com/miguelgrinberg/microdot/commit/46963ba4644d7abc8dc653c99bc76222af526964))
|
||||
- More unit tests ([commit](https://github.com/miguelgrinberg/microdot/commit/5cd3ace5166ec549579b0b1149ae3d7be195974a))
|
||||
- Installation instructions ([commit](https://github.com/miguelgrinberg/microdot/commit/1a8db51cb3754308da6dcc227512dcdeb4ce4557))
|
||||
- Run tests with pytest ([commit](https://github.com/miguelgrinberg/microdot/commit/8b4ebbd9535b3c083fb2a955284609acba07f05e))
|
||||
- Deprecated the microdot-asyncio package ([commit](https://github.com/miguelgrinberg/microdot/commit/a82ed55f56e14fbcea93e8171af86ab42657fa96))
|
||||
|
||||
**Release 0.5.0** - 2021-06-06
|
||||
|
||||
- [Documentation](https://microdot.readthedocs.io/en/latest/) site ([commit](https://github.com/miguelgrinberg/microdot/commit/12cd60305b7b48ab151da52661fc5988684dbcd8))
|
||||
- Support duplicate arguments in query string and form submissions [#21](https://github.com/miguelgrinberg/microdot/issues/21) ([commit](https://github.com/miguelgrinberg/microdot/commit/b0c25a1a7298189373be5df1668e0afb5532cdaf))
|
||||
- Merge `microdot-asyncio` package with `microdot` ([commit](https://github.com/miguelgrinberg/microdot/commit/b7b881e3c7f1c6ede6546e498737e93928425c30))
|
||||
- Added a change log ([commit](https://github.com/miguelgrinberg/microdot/commit/9955ac99a6ac20308644f02d6e6e32847d28b70c))
|
||||
- Improve project structure ([commit](https://github.com/miguelgrinberg/microdot/commit/4b101d15971fa2883d187f0bab0be999ae30b583))
|
||||
|
||||
**Release v0.4.0** - 2021-06-04
|
||||
|
||||
- Add HTTP method-specific route decorators ([commit](https://github.com/miguelgrinberg/microdot/commit/a3288a63ed45f700f79b67d0b57fc4dd20e844c1))
|
||||
- Server shutdown [#19](https://github.com/miguelgrinberg/microdot/issues/19) ([commit](https://github.com/miguelgrinberg/microdot/commit/0ad538df91f8b6b8a3885aa602c014ee7fe4526b))
|
||||
- Update microypthon binary for tests to 1.15 ([commit](https://github.com/miguelgrinberg/microdot/commit/3bd7fe8cea4598a7dbd0efcb9c6ce57ec2b79f9c))
|
||||
|
||||
**Release v0.3.1** - 2021-02-06
|
||||
|
||||
- Support large downloads in send_file [#3](https://github.com/miguelgrinberg/microdot/issues/3) ([commit](https://github.com/miguelgrinberg/microdot/commit/3e29af57753dbb7961ff98719a4fc4f71c0b4e3e))
|
||||
- Move socket import and add simple hello example [#12](https://github.com/miguelgrinberg/microdot/issues/12) ([commit](https://github.com/miguelgrinberg/microdot/commit/c5e1873523b609680ff67d7abfada72568272250)) (thanks **Damien George**!)
|
||||
- Update python versions to build ([commit](https://github.com/miguelgrinberg/microdot/commit/dfbe2edd797153fc9be40bc1928d93bdee7e7be5))
|
||||
- Handle Chrome preconnect [#8](https://github.com/miguelgrinberg/microdot/issues/8) ([commit](https://github.com/miguelgrinberg/microdot/commit/125af4b4a92b1d78acfa9d57ad2f507e759b6938)) (thanks **Ricardo Mendonça Ferreira**!)
|
||||
- Readme update ([commit](https://github.com/miguelgrinberg/microdot/commit/1aacb3cf46bd0b634ec3bc852ff9439f3c5dd773))
|
||||
- Switch to GitHub actions for builds ([commit](https://github.com/miguelgrinberg/microdot/commit/4c0afa2beca0c3b0f167fd25c6849d6937c412ba))
|
||||
|
||||
**Release v0.3.0** - 2019-05-05
|
||||
|
||||
- g, before_request and after_request ([commit](https://github.com/miguelgrinberg/microdot/commit/8aa50f171d2d04bc15c472ab1d9b3288518f7a21))
|
||||
- Threaded mode ([commit](https://github.com/miguelgrinberg/microdot/commit/494800ff9ff474c38644979086057e3584573969))
|
||||
- Optional asyncio support ([commit](https://github.com/miguelgrinberg/microdot/commit/3d9b5d7084d52e749553ca79206ed7060f963f9d))
|
||||
- Debug mode ([commit](https://github.com/miguelgrinberg/microdot/commit/4c83cb75636572066958ef2cc0802909deafe542))
|
||||
- Print exceptions ([commit](https://github.com/miguelgrinberg/microdot/commit/491202de1fce232b9629b7f1db63594fd13f84a3))
|
||||
- Flake8 ([commit](https://github.com/miguelgrinberg/microdot/commit/92edc17522d7490544c7186d62a2964caf35c861))
|
||||
- Unit testing framework ([commit](https://github.com/miguelgrinberg/microdot/commit/f741ed7cf83320d25ce16a1a29796af6fdfb91e9))
|
||||
- More robust header checking in tests ([commit](https://github.com/miguelgrinberg/microdot/commit/03efe46a26e7074f960dd4c9a062c53d6f72bfa0))
|
||||
- Response unit tests ([commit](https://github.com/miguelgrinberg/microdot/commit/cd71986a5042dcc308617a3db89476f28dd13ecf))
|
||||
- Request unit tests ([commit](https://github.com/miguelgrinberg/microdot/commit/0b95feafc96dc91d7d34528ff2d8931a8aa3d612))
|
||||
- More unit tests ([commit](https://github.com/miguelgrinberg/microdot/commit/76ab1fa6d72dd9deaa24aeaf4895a0c6fc883bcb))
|
||||
- Async request and response unit tests ([commit](https://github.com/miguelgrinberg/microdot/commit/89f7f09b9a2d0dfccefabebbe9b83307133bd97c))
|
||||
- More asyncio unit tests ([commit](https://github.com/miguelgrinberg/microdot/commit/ba986a89ff72ebbd9a65307b81ee769879961594))
|
||||
- Improve code structure ([commit](https://github.com/miguelgrinberg/microdot/commit/b16466f1a9432a608eb23769907e8952fe304a9a))
|
||||
- URL pattern matching unit tests ([commit](https://github.com/miguelgrinberg/microdot/commit/0a373775d54df571ceddaac090094bb62dbe6c72))
|
||||
- Rename microdot_async to microdot_asyncio ([commit](https://github.com/miguelgrinberg/microdot/commit/e5525c5c485ae8901c9602da7e4582b58fb2da40))
|
||||
|
||||
**Release 0.2.0** - 2019-04-19
|
||||
|
||||
- Error handlers ([commit](https://github.com/miguelgrinberg/microdot/commit/0f2c749f6d1b9edbf124523160e10449c932ea45))
|
||||
- Fleshed out example GPIO application ([commit](https://github.com/miguelgrinberg/microdot/commit/52f2d0c4918d00d1a7e46cc7fd9a909ef6d259c1))
|
||||
- More robust parsing of cookie header ([commit](https://github.com/miguelgrinberg/microdot/commit/2f58c41cc89946d51646df83d4f9ae0e24e447b9))
|
||||
|
||||
**Release 0.1.1** - 2019-04-17
|
||||
|
||||
- Minor fixes for micropython ([commit](https://github.com/miguelgrinberg/microdot/commit/e4ff70cf8fe839f5b5297157bf028569188b9031))
|
||||
- Initial commit ([commit](https://github.com/miguelgrinberg/microdot/commit/311a82a44430d427948866b09cb6136e60a5b1c9))
|
||||
@@ -1,8 +1,9 @@
|
||||
# microdot
|
||||
[](https://github.com/miguelgrinberg/microdot/actions) [](https://codecov.io/gh/miguelgrinberg/microdot)
|
||||
[](https://github.com/miguelgrinberg/microdot/actions) [](https://codecov.io/gh/miguelgrinberg/microdot)
|
||||
|
||||
A minimalistic Python web framework for microcontrollers inspired by Flask
|
||||
|
||||
## Documentation
|
||||
## Resources
|
||||
|
||||
Coming soon!
|
||||
- [Documentation](https://microdot.readthedocs.io/en/latest/)
|
||||
- [Change Log](https://github.com/miguelgrinberg/microdot/blob/main/CHANGES.md)
|
||||
|
||||
9
SECURITY.md
Normal file
9
SECURITY.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Security Policy
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
If you think you've found a vulnerability on this project, please send me (Miguel Grinberg) an email at miguel.grinberg@gmail.com with a description of the problem. I will personally review the issue and respond to you with next steps.
|
||||
|
||||
If the issue is highly sensitive, you are welcome to encrypt your message. Here is my [PGP key](https://keyserver.ubuntu.com/pks/lookup?search=miguel.grinberg%40gmail.com&fingerprint=on&op=index).
|
||||
|
||||
Please do not disclose vulnerabilities publicly before discussing how to proceed with me.
|
||||
20
docs/Makefile
Normal file
20
docs/Makefile
Normal file
@@ -0,0 +1,20 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
3
docs/_static/css/custom.css
vendored
Normal file
3
docs/_static/css/custom.css
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
.py .class, .py .method, .py .property {
|
||||
margin-top: 20px;
|
||||
}
|
||||
62
docs/api.rst
Normal file
62
docs/api.rst
Normal file
@@ -0,0 +1,62 @@
|
||||
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:
|
||||
|
||||
70
docs/conf.py
Normal file
70
docs/conf.py
Normal file
@@ -0,0 +1,70 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('../src'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'Microdot'
|
||||
copyright = '2021, Miguel Grinberg'
|
||||
author = 'Miguel Grinberg'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
html_css_files = [
|
||||
'css/custom.css',
|
||||
]
|
||||
|
||||
html_theme_options = {
|
||||
'github_user': 'miguelgrinberg',
|
||||
'github_repo': 'microdot',
|
||||
'github_banner': True,
|
||||
'github_button': True,
|
||||
'github_type': 'star',
|
||||
'fixed_sidebar': True,
|
||||
}
|
||||
|
||||
autodoc_default_options = {
|
||||
'member-order': 'bysource',
|
||||
}
|
||||
21
docs/index.rst
Normal file
21
docs/index.rst
Normal file
@@ -0,0 +1,21 @@
|
||||
.. Microdot documentation master file, created by
|
||||
sphinx-quickstart on Fri Jun 4 17:40:19 2021.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Microdot
|
||||
========
|
||||
|
||||
Microdot is a minimalistic Python web framework inspired by
|
||||
`Flask <https://flask.palletsprojects.com/>`_, and designed to run on
|
||||
systems with limited resources such as microcontrollers. It runs on standard
|
||||
Python and on `MicroPython <https://micropython.org>`_.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
intro
|
||||
api
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`search`
|
||||
39
docs/intro.rst
Normal file
39
docs/intro.rst
Normal file
@@ -0,0 +1,39 @@
|
||||
Installation
|
||||
------------
|
||||
|
||||
Microdot can be installed with ``pip``::
|
||||
|
||||
pip install microdot
|
||||
|
||||
For platforms that do not support or cannot run ``pip``, you can also manually
|
||||
copy and install the ``microdot.py`` and ``microdot_asyncio.py`` source files.
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
The following is an example of a standard single or multi-threaded web
|
||||
server::
|
||||
|
||||
from microdot import Microdot
|
||||
|
||||
app = Microdot()
|
||||
|
||||
@app.route('/')
|
||||
def hello(request):
|
||||
return 'Hello, world!'
|
||||
|
||||
app.run()
|
||||
|
||||
Microdot also supports the asynchronous model and can be used under
|
||||
``asyncio``. The example that follows is equivalent to the one above, but uses
|
||||
coroutines for concurrency::
|
||||
|
||||
from microdot_asyncio import Microdot
|
||||
|
||||
app = Microdot()
|
||||
|
||||
@app.route('/')
|
||||
async def hello(request):
|
||||
return 'Hello, world!'
|
||||
|
||||
app.run()
|
||||
35
docs/make.bat
Normal file
35
docs/make.bat
Normal file
@@ -0,0 +1,35 @@
|
||||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
echo.
|
||||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||
echo.may add the Sphinx directory to PATH.
|
||||
echo.
|
||||
echo.If you don't have Sphinx installed, grab it from
|
||||
echo.http://sphinx-doc.org/
|
||||
exit /b 1
|
||||
)
|
||||
|
||||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
goto end
|
||||
|
||||
:help
|
||||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||
|
||||
:end
|
||||
popd
|
||||
5
legacy/README.md
Normal file
5
legacy/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
microdot-asyncio
|
||||
================
|
||||
|
||||
This package has been merged with the ``microdot`` package. It currently
|
||||
installs as an empty package that depends on it.
|
||||
6
legacy/pyproject.toml
Normal file
6
legacy/pyproject.toml
Normal file
@@ -0,0 +1,6 @@
|
||||
[build-system]
|
||||
requires = [
|
||||
"setuptools>=42",
|
||||
"wheel"
|
||||
]
|
||||
build-backend = "setuptools.build_meta"
|
||||
24
legacy/setup.cfg
Normal file
24
legacy/setup.cfg
Normal file
@@ -0,0 +1,24 @@
|
||||
[metadata]
|
||||
name = microdot-asyncio
|
||||
version = 0.5.0
|
||||
author = Miguel Grinberg
|
||||
author_email = miguel.grinberg@gmail.com
|
||||
description = AsyncIO support for the Microdot web framework'
|
||||
long_description = file: README.md
|
||||
long_description_content_type = text/markdown
|
||||
url = https://github.com/miguelgrinberg/microdot
|
||||
project_urls =
|
||||
Bug Tracker = https://github.com/miguelgrinberg/microdot/issues
|
||||
classifiers =
|
||||
Environment :: Web Environment
|
||||
Intended Audience :: Developers
|
||||
Programming Language :: Python :: 3
|
||||
Programming Language :: Python :: Implementation :: MicroPython
|
||||
License :: OSI Approved :: MIT License
|
||||
Operating System :: OS Independent
|
||||
[options]
|
||||
zip_safe = False
|
||||
include_package_data = True
|
||||
py_modules =
|
||||
install_requires =
|
||||
microdot
|
||||
3
legacy/setup.py
Normal file
3
legacy/setup.py
Normal file
@@ -0,0 +1,3 @@
|
||||
import setuptools
|
||||
|
||||
setuptools.setup()
|
||||
@@ -1,173 +0,0 @@
|
||||
try:
|
||||
import uasyncio as asyncio
|
||||
except ImportError:
|
||||
import asyncio
|
||||
from microdot import Microdot as BaseMicrodot
|
||||
from microdot import print_exception
|
||||
from microdot import Request as BaseRequest
|
||||
from microdot import Response as BaseResponse
|
||||
|
||||
|
||||
def _iscoroutine(coro):
|
||||
return hasattr(coro, 'send') and hasattr(coro, 'throw')
|
||||
|
||||
|
||||
class Request(BaseRequest):
|
||||
@staticmethod
|
||||
async def create(app, stream, client_addr):
|
||||
# request line
|
||||
line = (await stream.readline()).strip().decode()
|
||||
if not line: # pragma: no cover
|
||||
return None
|
||||
method, url, http_version = line.split()
|
||||
http_version = http_version.split('/', 1)[1]
|
||||
|
||||
# headers
|
||||
headers = {}
|
||||
content_length = 0
|
||||
while True:
|
||||
line = (await stream.readline()).strip().decode()
|
||||
if line == '':
|
||||
break
|
||||
header, value = line.split(':', 1)
|
||||
value = value.strip()
|
||||
headers[header] = value
|
||||
if header == 'Content-Length':
|
||||
content_length = int(value)
|
||||
|
||||
# body
|
||||
body = await stream.read(content_length) \
|
||||
if content_length else b''
|
||||
|
||||
return Request(app, client_addr, method, url, http_version, headers,
|
||||
body)
|
||||
|
||||
|
||||
class Response(BaseResponse):
|
||||
async def write(self, stream):
|
||||
self.complete()
|
||||
|
||||
# status code
|
||||
await stream.awrite('HTTP/1.0 {status_code} {reason}\r\n'.format(
|
||||
status_code=self.status_code,
|
||||
reason='OK' if self.status_code == 200 else 'N/A').encode())
|
||||
|
||||
# headers
|
||||
for header, value in self.headers.items():
|
||||
values = value if isinstance(value, list) else [value]
|
||||
for value in values:
|
||||
await stream.awrite('{header}: {value}\r\n'.format(
|
||||
header=header, value=value).encode())
|
||||
await stream.awrite(b'\r\n')
|
||||
|
||||
# body
|
||||
if self.body:
|
||||
if hasattr(self.body, 'read'):
|
||||
while True:
|
||||
buf = self.body.read(self.send_file_buffer_size)
|
||||
if len(buf):
|
||||
await stream.awrite(buf)
|
||||
if len(buf) < self.send_file_buffer_size:
|
||||
break
|
||||
if hasattr(self.body, 'close'):
|
||||
self.body.close()
|
||||
else:
|
||||
await stream.awrite(self.body)
|
||||
|
||||
|
||||
class Microdot(BaseMicrodot):
|
||||
async def start_server(self, host='0.0.0.0', port=5000, debug=False):
|
||||
self.debug = debug
|
||||
|
||||
async def serve(reader, writer):
|
||||
if not hasattr(writer, 'awrite'): # pragma: no cover
|
||||
# CPython provides the awrite and aclose methods in 3.8+
|
||||
async def awrite(self, data):
|
||||
self.write(data)
|
||||
await self.drain()
|
||||
|
||||
async def aclose(self):
|
||||
self.close()
|
||||
await self.wait_closed()
|
||||
|
||||
from types import MethodType
|
||||
writer.awrite = MethodType(awrite, writer)
|
||||
writer.aclose = MethodType(aclose, writer)
|
||||
|
||||
await self.dispatch_request(reader, writer)
|
||||
|
||||
if self.debug: # pragma: no cover
|
||||
print('Starting async server on {host}:{port}...'.format(
|
||||
host=host, port=port))
|
||||
|
||||
self.server = await asyncio.start_server(serve, host, port)
|
||||
await self.server.wait_closed()
|
||||
|
||||
def run(self, host='0.0.0.0', port=5000, debug=False):
|
||||
asyncio.run(self.start_server(host=host, port=port, debug=debug))
|
||||
|
||||
def shutdown(self):
|
||||
self.server.close()
|
||||
|
||||
async def dispatch_request(self, reader, writer):
|
||||
req = await Request.create(self, reader,
|
||||
writer.get_extra_info('peername'))
|
||||
if req:
|
||||
f = self.find_route(req)
|
||||
try:
|
||||
res = None
|
||||
if f:
|
||||
for handler in self.before_request_handlers:
|
||||
res = await self._invoke_handler(handler, req)
|
||||
if res:
|
||||
break
|
||||
if res is None:
|
||||
res = await self._invoke_handler(
|
||||
f, req, **req.url_args)
|
||||
if isinstance(res, tuple):
|
||||
res = Response(*res)
|
||||
elif not isinstance(res, Response):
|
||||
res = Response(res)
|
||||
for handler in self.after_request_handlers:
|
||||
res = await self._invoke_handler(
|
||||
handler, req, res) or res
|
||||
elif 404 in self.error_handlers:
|
||||
res = await self._invoke_handler(
|
||||
self.error_handlers[404], req)
|
||||
else:
|
||||
res = 'Not found', 404
|
||||
except Exception as exc:
|
||||
print_exception(exc)
|
||||
res = None
|
||||
if exc.__class__ in self.error_handlers:
|
||||
try:
|
||||
res = await self._invoke_handler(
|
||||
self.error_handlers[exc.__class__], req, exc)
|
||||
except Exception as exc2: # pragma: no cover
|
||||
print_exception(exc2)
|
||||
if res is None:
|
||||
if 500 in self.error_handlers:
|
||||
res = await self._invoke_handler(
|
||||
self.error_handlers[500], req)
|
||||
else:
|
||||
res = 'Internal server error', 500
|
||||
if isinstance(res, tuple):
|
||||
res = Response(*res)
|
||||
elif not isinstance(res, Response):
|
||||
res = Response(res)
|
||||
await res.write(writer)
|
||||
await writer.aclose()
|
||||
if self.debug and req: # pragma: no cover
|
||||
print('{method} {path} {status_code}'.format(
|
||||
method=req.method, path=req.path,
|
||||
status_code=res.status_code))
|
||||
|
||||
async def _invoke_handler(self, f_or_coro, *args, **kwargs):
|
||||
ret = f_or_coro(*args, **kwargs)
|
||||
if _iscoroutine(ret):
|
||||
ret = await ret
|
||||
return ret
|
||||
|
||||
|
||||
redirect = Response.redirect
|
||||
send_file = Response.send_file
|
||||
@@ -1,35 +0,0 @@
|
||||
"""
|
||||
Microdot-AsyncIO
|
||||
----------------
|
||||
|
||||
AsyncIO support for the Microdot web framework.
|
||||
"""
|
||||
from setuptools import setup
|
||||
|
||||
setup(
|
||||
name='microdot-asyncio',
|
||||
version="0.4.0",
|
||||
url='http://github.com/miguelgrinberg/microdot/',
|
||||
license='MIT',
|
||||
author='Miguel Grinberg',
|
||||
author_email='miguel.grinberg@gmail.com',
|
||||
description='AsyncIO support for the Microdot web framework',
|
||||
long_description=__doc__,
|
||||
py_modules=['microdot_asyncio'],
|
||||
platforms='any',
|
||||
install_requires=[
|
||||
'microdot',
|
||||
'micropython-uasyncio;implementation_name=="micropython"'
|
||||
],
|
||||
classifiers=[
|
||||
'Environment :: Web Environment',
|
||||
'Intended Audience :: Developers',
|
||||
'License :: OSI Approved :: MIT License',
|
||||
'Operating System :: OS Independent',
|
||||
'Programming Language :: Python',
|
||||
'Programming Language :: Python :: 3',
|
||||
'Programming Language :: Python :: Implementation :: MicroPython',
|
||||
'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
|
||||
'Topic :: Software Development :: Libraries :: Python Modules'
|
||||
]
|
||||
)
|
||||
@@ -1,452 +0,0 @@
|
||||
try:
|
||||
from sys import print_exception
|
||||
except ImportError: # pragma: no cover
|
||||
import traceback
|
||||
|
||||
def print_exception(exc):
|
||||
traceback.print_exc()
|
||||
try:
|
||||
import uerrno as errno
|
||||
except ImportError:
|
||||
import errno
|
||||
|
||||
concurrency_mode = 'threaded'
|
||||
|
||||
try: # pragma: no cover
|
||||
import threading
|
||||
|
||||
def create_thread(f, *args, **kwargs):
|
||||
"""Use the threading module."""
|
||||
threading.Thread(target=f, args=args, kwargs=kwargs).start()
|
||||
except ImportError: # pragma: no cover
|
||||
try:
|
||||
import _thread
|
||||
|
||||
def create_thread(f, *args, **kwargs):
|
||||
"""Use MicroPython's _thread module."""
|
||||
def run():
|
||||
f(*args, **kwargs)
|
||||
|
||||
_thread.start_new_thread(run, ())
|
||||
except ImportError:
|
||||
def create_thread(f, *args, **kwargs):
|
||||
"""No threads available, call function synchronously."""
|
||||
f(*args, **kwargs)
|
||||
|
||||
concurrency_mode = 'sync'
|
||||
try:
|
||||
import ujson as json
|
||||
except ImportError:
|
||||
import json
|
||||
|
||||
try:
|
||||
import ure as re
|
||||
except ImportError:
|
||||
import re
|
||||
|
||||
try:
|
||||
import usocket as socket
|
||||
except ImportError:
|
||||
try:
|
||||
import socket
|
||||
except ImportError: # pragma: no cover
|
||||
socket = None
|
||||
|
||||
|
||||
def urldecode(string):
|
||||
string = string.replace('+', ' ')
|
||||
parts = string.split('%')
|
||||
if len(parts) == 1:
|
||||
return string
|
||||
result = [parts[0]]
|
||||
for item in parts[1:]:
|
||||
if item == '':
|
||||
result.append('%')
|
||||
else:
|
||||
code = item[:2]
|
||||
result.append(chr(int(code, 16)))
|
||||
result.append(item[2:])
|
||||
return ''.join(result)
|
||||
|
||||
|
||||
class Request():
|
||||
class G:
|
||||
pass
|
||||
|
||||
def __init__(self, app, client_addr, method, url, http_version, headers,
|
||||
body):
|
||||
self.app = app
|
||||
self.client_addr = client_addr
|
||||
self.method = method
|
||||
self.path = url
|
||||
self.http_version = http_version
|
||||
if '?' in self.path:
|
||||
self.path, self.query_string = self.path.split('?', 1)
|
||||
self.args = self._parse_urlencoded(self.query_string)
|
||||
else:
|
||||
self.query_string = None
|
||||
self.args = {}
|
||||
self.headers = headers
|
||||
self.cookies = {}
|
||||
self.content_length = 0
|
||||
self.content_type = None
|
||||
for header, value in self.headers.items():
|
||||
if header == 'Content-Length':
|
||||
self.content_length = int(value)
|
||||
elif header == 'Content-Type':
|
||||
self.content_type = value
|
||||
elif header == 'Cookie':
|
||||
for cookie in value.split(';'):
|
||||
name, value = cookie.strip().split('=', 1)
|
||||
self.cookies[name] = value
|
||||
self.body = body
|
||||
self._json = None
|
||||
self._form = None
|
||||
self.g = Request.G()
|
||||
|
||||
@staticmethod
|
||||
def create(app, client_stream, client_addr):
|
||||
# request line
|
||||
line = client_stream.readline().strip().decode()
|
||||
if not line: # pragma: no cover
|
||||
return None
|
||||
method, url, http_version = line.split()
|
||||
http_version = http_version.split('/', 1)[1]
|
||||
|
||||
# headers
|
||||
headers = {}
|
||||
content_length = 0
|
||||
while True:
|
||||
line = client_stream.readline().strip().decode()
|
||||
if line == '':
|
||||
break
|
||||
header, value = line.split(':', 1)
|
||||
value = value.strip()
|
||||
headers[header] = value
|
||||
if header == 'Content-Length':
|
||||
content_length = int(value)
|
||||
|
||||
# body
|
||||
body = client_stream.read(content_length) if content_length else b''
|
||||
|
||||
return Request(app, client_addr, method, url, http_version, headers,
|
||||
body)
|
||||
|
||||
def _parse_urlencoded(self, urlencoded):
|
||||
return {
|
||||
urldecode(key): urldecode(value) for key, value in [
|
||||
pair.split('=', 1) for pair in
|
||||
urlencoded.split('&')]}
|
||||
|
||||
@property
|
||||
def json(self):
|
||||
if self.content_type != 'application/json':
|
||||
return None
|
||||
if self._json is None:
|
||||
self._json = json.loads(self.body.decode())
|
||||
return self._json
|
||||
|
||||
@property
|
||||
def form(self):
|
||||
if self.content_type != 'application/x-www-form-urlencoded':
|
||||
return None
|
||||
if self._form is None:
|
||||
self._form = self._parse_urlencoded(self.body.decode())
|
||||
return self._form
|
||||
|
||||
|
||||
class Response():
|
||||
types_map = {
|
||||
'css': 'text/css',
|
||||
'gif': 'image/gif',
|
||||
'html': 'text/html',
|
||||
'jpg': 'image/jpeg',
|
||||
'js': 'application/javascript',
|
||||
'json': 'application/json',
|
||||
'png': 'image/png',
|
||||
'txt': 'text/plain',
|
||||
}
|
||||
send_file_buffer_size = 1024
|
||||
|
||||
def __init__(self, body='', status_code=200, headers=None):
|
||||
self.status_code = status_code
|
||||
self.headers = headers or {}
|
||||
if isinstance(body, (dict, list)):
|
||||
self.body = json.dumps(body).encode()
|
||||
self.headers['Content-Type'] = 'application/json'
|
||||
elif isinstance(body, str):
|
||||
self.body = body.encode()
|
||||
else:
|
||||
# this applies to bytes or file-like objects
|
||||
self.body = body
|
||||
|
||||
def set_cookie(self, cookie, value, path=None, domain=None, expires=None,
|
||||
max_age=None, secure=False, http_only=False):
|
||||
http_cookie = '{cookie}={value}'.format(cookie=cookie, value=value)
|
||||
if path:
|
||||
http_cookie += '; Path=' + path
|
||||
if domain:
|
||||
http_cookie += '; Domain=' + domain
|
||||
if expires:
|
||||
http_cookie += '; Expires=' + expires.strftime(
|
||||
"%a, %d %b %Y %H:%M:%S GMT")
|
||||
if max_age:
|
||||
http_cookie += '; Max-Age=' + str(max_age)
|
||||
if secure:
|
||||
http_cookie += '; Secure'
|
||||
if http_only:
|
||||
http_cookie += '; HttpOnly'
|
||||
if 'Set-Cookie' in self.headers:
|
||||
self.headers['Set-Cookie'].append(http_cookie)
|
||||
else:
|
||||
self.headers['Set-Cookie'] = [http_cookie]
|
||||
|
||||
def complete(self):
|
||||
if isinstance(self.body, bytes) and \
|
||||
'Content-Length' not in self.headers:
|
||||
self.headers['Content-Length'] = str(len(self.body))
|
||||
if 'Content-Type' not in self.headers:
|
||||
self.headers['Content-Type'] = 'text/plain'
|
||||
|
||||
def write(self, stream):
|
||||
self.complete()
|
||||
|
||||
# status code
|
||||
stream.write('HTTP/1.0 {status_code} {reason}\r\n'.format(
|
||||
status_code=self.status_code,
|
||||
reason='OK' if self.status_code == 200 else 'N/A').encode())
|
||||
|
||||
# headers
|
||||
for header, value in self.headers.items():
|
||||
values = value if isinstance(value, list) else [value]
|
||||
for value in values:
|
||||
stream.write('{header}: {value}\r\n'.format(
|
||||
header=header, value=value).encode())
|
||||
stream.write(b'\r\n')
|
||||
|
||||
# body
|
||||
if self.body:
|
||||
if hasattr(self.body, 'read'):
|
||||
while True:
|
||||
buf = self.body.read(self.send_file_buffer_size)
|
||||
if len(buf):
|
||||
stream.write(buf)
|
||||
if len(buf) < self.send_file_buffer_size:
|
||||
break
|
||||
if hasattr(self.body, 'close'): # pragma: no close
|
||||
self.body.close()
|
||||
else:
|
||||
stream.write(self.body)
|
||||
|
||||
@classmethod
|
||||
def redirect(cls, location, status_code=302):
|
||||
return cls(status_code=status_code, headers={'Location': location})
|
||||
|
||||
@classmethod
|
||||
def send_file(cls, filename, status_code=200, content_type=None):
|
||||
if content_type is None:
|
||||
ext = filename.split('.')[-1]
|
||||
if ext in Response.types_map:
|
||||
content_type = Response.types_map[ext]
|
||||
else:
|
||||
content_type = 'application/octet-stream'
|
||||
f = open(filename, 'rb')
|
||||
return cls(body=f, status_code=status_code,
|
||||
headers={'Content-Type': content_type})
|
||||
|
||||
|
||||
class URLPattern():
|
||||
def __init__(self, url_pattern):
|
||||
self.pattern = ''
|
||||
self.args = []
|
||||
use_regex = False
|
||||
for segment in url_pattern.lstrip('/').split('/'):
|
||||
if segment and segment[0] == '<':
|
||||
if segment[-1] != '>':
|
||||
raise ValueError('invalid URL pattern')
|
||||
segment = segment[1:-1]
|
||||
if ':' in segment:
|
||||
type_, name = segment.rsplit(':', 1)
|
||||
else:
|
||||
type_ = 'string'
|
||||
name = segment
|
||||
if type_ == 'string':
|
||||
pattern = '[^/]+'
|
||||
elif type_ == 'int':
|
||||
pattern = '\\d+'
|
||||
elif type_ == 'path':
|
||||
pattern = '.+'
|
||||
elif type_.startswith('re:'):
|
||||
pattern = type_[3:]
|
||||
else:
|
||||
raise ValueError('invalid URL segment type')
|
||||
use_regex = True
|
||||
self.pattern += '/({pattern})'.format(pattern=pattern)
|
||||
self.args.append({'type': type_, 'name': name})
|
||||
else:
|
||||
self.pattern += '/{segment}'.format(segment=segment)
|
||||
if use_regex:
|
||||
self.pattern = re.compile('^' + self.pattern + '$')
|
||||
|
||||
def match(self, path):
|
||||
if isinstance(self.pattern, str):
|
||||
if path != self.pattern:
|
||||
return
|
||||
return {}
|
||||
g = self.pattern.match(path)
|
||||
if not g:
|
||||
return
|
||||
args = {}
|
||||
i = 1
|
||||
for arg in self.args:
|
||||
value = g.group(i)
|
||||
if arg['type'] == 'int':
|
||||
value = int(value)
|
||||
args[arg['name']] = value
|
||||
i += 1
|
||||
return args
|
||||
|
||||
|
||||
class Microdot():
|
||||
def __init__(self):
|
||||
self.url_map = []
|
||||
self.before_request_handlers = []
|
||||
self.after_request_handlers = []
|
||||
self.error_handlers = {}
|
||||
self.shutdown_requested = False
|
||||
self.debug = False
|
||||
self.server = None
|
||||
|
||||
def route(self, url_pattern, methods=None):
|
||||
def decorated(f):
|
||||
self.url_map.append(
|
||||
(methods or ['GET'], URLPattern(url_pattern), f))
|
||||
return f
|
||||
return decorated
|
||||
|
||||
def get(self, url_pattern):
|
||||
return self.route(url_pattern, methods=['GET'])
|
||||
|
||||
def post(self, url_pattern):
|
||||
return self.route(url_pattern, methods=['POST'])
|
||||
|
||||
def put(self, url_pattern):
|
||||
return self.route(url_pattern, methods=['PUT'])
|
||||
|
||||
def patch(self, url_pattern):
|
||||
return self.route(url_pattern, methods=['PATCH'])
|
||||
|
||||
def delete(self, url_pattern):
|
||||
return self.route(url_pattern, methods=['DELETE'])
|
||||
|
||||
def before_request(self, f):
|
||||
self.before_request_handlers.append(f)
|
||||
return f
|
||||
|
||||
def after_request(self, f):
|
||||
self.after_request_handlers.append(f)
|
||||
return f
|
||||
|
||||
def errorhandler(self, status_code_or_exception_class):
|
||||
def decorated(f):
|
||||
self.error_handlers[status_code_or_exception_class] = f
|
||||
return f
|
||||
return decorated
|
||||
|
||||
def run(self, host='0.0.0.0', port=5000, debug=False):
|
||||
self.debug = debug
|
||||
self.shutdown_requested = False
|
||||
|
||||
self.server = socket.socket()
|
||||
ai = socket.getaddrinfo(host, port)
|
||||
addr = ai[0][-1]
|
||||
|
||||
if self.debug: # pragma: no cover
|
||||
print('Starting {mode} server on {host}:{port}...'.format(
|
||||
mode=concurrency_mode, host=host, port=port))
|
||||
self.server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
||||
self.server.bind(addr)
|
||||
self.server.listen(5)
|
||||
|
||||
while not self.shutdown_requested:
|
||||
try:
|
||||
sock, addr = self.server.accept()
|
||||
except OSError as exc:
|
||||
if exc.args[0] == errno.ECONNABORTED:
|
||||
break
|
||||
else:
|
||||
raise
|
||||
create_thread(self.dispatch_request, sock, addr)
|
||||
|
||||
def shutdown(self):
|
||||
self.shutdown_requested = True
|
||||
|
||||
def find_route(self, req):
|
||||
f = None
|
||||
for route_methods, route_pattern, route_handler in self.url_map:
|
||||
if req.method in route_methods:
|
||||
req.url_args = route_pattern.match(req.path)
|
||||
if req.url_args is not None:
|
||||
f = route_handler
|
||||
break
|
||||
return f
|
||||
|
||||
def dispatch_request(self, sock, addr):
|
||||
if not hasattr(sock, 'readline'): # pragma: no cover
|
||||
stream = sock.makefile("rwb")
|
||||
else:
|
||||
stream = sock
|
||||
|
||||
req = Request.create(self, stream, addr)
|
||||
if req:
|
||||
f = self.find_route(req)
|
||||
try:
|
||||
res = None
|
||||
if f:
|
||||
for handler in self.before_request_handlers:
|
||||
res = handler(req)
|
||||
if res:
|
||||
break
|
||||
if res is None:
|
||||
res = f(req, **req.url_args)
|
||||
if isinstance(res, tuple):
|
||||
res = Response(*res)
|
||||
elif not isinstance(res, Response):
|
||||
res = Response(res)
|
||||
for handler in self.after_request_handlers:
|
||||
res = handler(req, res) or res
|
||||
elif 404 in self.error_handlers:
|
||||
res = self.error_handlers[404](req)
|
||||
else:
|
||||
res = 'Not found', 404
|
||||
except Exception as exc:
|
||||
print_exception(exc)
|
||||
res = None
|
||||
if exc.__class__ in self.error_handlers:
|
||||
try:
|
||||
res = self.error_handlers[exc.__class__](req, exc)
|
||||
except Exception as exc2: # pragma: no cover
|
||||
print_exception(exc2)
|
||||
if res is None:
|
||||
if 500 in self.error_handlers:
|
||||
res = self.error_handlers[500](req)
|
||||
else:
|
||||
res = 'Internal server error', 500
|
||||
if isinstance(res, tuple):
|
||||
res = Response(*res)
|
||||
elif not isinstance(res, Response):
|
||||
res = Response(res)
|
||||
res.write(stream)
|
||||
stream.close()
|
||||
if stream != sock: # pragma: no cover
|
||||
sock.close()
|
||||
if self.shutdown_requested: # pragma: no cover
|
||||
self.server.close()
|
||||
if self.debug and req: # pragma: no cover
|
||||
print('{method} {path} {status_code}'.format(
|
||||
method=req.method, path=req.path,
|
||||
status_code=res.status_code))
|
||||
|
||||
|
||||
redirect = Response.redirect
|
||||
send_file = Response.send_file
|
||||
@@ -1,31 +0,0 @@
|
||||
"""
|
||||
Microdot
|
||||
--------
|
||||
|
||||
The impossibly small web framework for MicroPython.
|
||||
"""
|
||||
from setuptools import setup
|
||||
|
||||
setup(
|
||||
name='microdot',
|
||||
version="0.4.0",
|
||||
url='http://github.com/miguelgrinberg/microdot/',
|
||||
license='MIT',
|
||||
author='Miguel Grinberg',
|
||||
author_email='miguel.grinberg@gmail.com',
|
||||
description='The impossibly small web framework for MicroPython',
|
||||
long_description=__doc__,
|
||||
py_modules=['microdot'],
|
||||
platforms='any',
|
||||
classifiers=[
|
||||
'Environment :: Web Environment',
|
||||
'Intended Audience :: Developers',
|
||||
'License :: OSI Approved :: MIT License',
|
||||
'Operating System :: OS Independent',
|
||||
'Programming Language :: Python',
|
||||
'Programming Language :: Python :: 3',
|
||||
'Programming Language :: Python :: Implementation :: MicroPython',
|
||||
'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
|
||||
'Topic :: Software Development :: Libraries :: Python Modules'
|
||||
]
|
||||
)
|
||||
6
pyproject.toml
Normal file
6
pyproject.toml
Normal file
@@ -0,0 +1,6 @@
|
||||
[build-system]
|
||||
requires = [
|
||||
"setuptools>=42",
|
||||
"wheel"
|
||||
]
|
||||
build-backend = "setuptools.build_meta"
|
||||
@@ -1,7 +1,6 @@
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, 'microdot')
|
||||
sys.path.insert(1, 'microdot-asyncio')
|
||||
sys.path.insert(0, 'src')
|
||||
sys.path.insert(2, 'tests/libs')
|
||||
|
||||
import unittest
|
||||
|
||||
27
setup.cfg
Normal file
27
setup.cfg
Normal file
@@ -0,0 +1,27 @@
|
||||
[metadata]
|
||||
name = microdot
|
||||
version = 0.7.2
|
||||
author = Miguel Grinberg
|
||||
author_email = miguel.grinberg@gmail.com
|
||||
description = The impossibly small web framework for MicroPython
|
||||
long_description = file: README.md
|
||||
long_description_content_type = text/markdown
|
||||
url = https://github.com/miguelgrinberg/microdot
|
||||
project_urls =
|
||||
Bug Tracker = https://github.com/miguelgrinberg/microdot/issues
|
||||
classifiers =
|
||||
Environment :: Web Environment
|
||||
Intended Audience :: Developers
|
||||
Programming Language :: Python :: 3
|
||||
Programming Language :: Python :: Implementation :: MicroPython
|
||||
License :: OSI Approved :: MIT License
|
||||
Operating System :: OS Independent
|
||||
|
||||
[options]
|
||||
zip_safe = False
|
||||
include_package_data = True
|
||||
package_dir =
|
||||
= src
|
||||
py_modules =
|
||||
microdot
|
||||
microdot_asyncio
|
||||
867
src/microdot.py
Normal file
867
src/microdot.py
Normal file
@@ -0,0 +1,867 @@
|
||||
"""
|
||||
microdot
|
||||
--------
|
||||
|
||||
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.
|
||||
"""
|
||||
try:
|
||||
from sys import print_exception
|
||||
except ImportError: # pragma: no cover
|
||||
import traceback
|
||||
|
||||
def print_exception(exc):
|
||||
traceback.print_exc()
|
||||
try:
|
||||
import uerrno as errno
|
||||
except ImportError:
|
||||
import errno
|
||||
|
||||
concurrency_mode = 'threaded'
|
||||
|
||||
try: # pragma: no cover
|
||||
import threading
|
||||
|
||||
def create_thread(f, *args, **kwargs):
|
||||
# use the threading module
|
||||
threading.Thread(target=f, args=args, kwargs=kwargs).start()
|
||||
except ImportError: # pragma: no cover
|
||||
try:
|
||||
import _thread
|
||||
|
||||
def create_thread(f, *args, **kwargs):
|
||||
# use MicroPython's _thread module
|
||||
def run():
|
||||
f(*args, **kwargs)
|
||||
|
||||
_thread.start_new_thread(run, ())
|
||||
except ImportError:
|
||||
def create_thread(f, *args, **kwargs):
|
||||
# no threads available, call function synchronously
|
||||
f(*args, **kwargs)
|
||||
|
||||
concurrency_mode = 'sync'
|
||||
try:
|
||||
import ujson as json
|
||||
except ImportError:
|
||||
import json
|
||||
|
||||
try:
|
||||
import ure as re
|
||||
except ImportError:
|
||||
import re
|
||||
|
||||
try:
|
||||
import usocket as socket
|
||||
except ImportError:
|
||||
try:
|
||||
import socket
|
||||
except ImportError: # pragma: no cover
|
||||
socket = None
|
||||
|
||||
|
||||
def urldecode(string):
|
||||
string = string.replace('+', ' ')
|
||||
parts = string.split('%')
|
||||
if len(parts) == 1:
|
||||
return string
|
||||
result = [parts[0]]
|
||||
for item in parts[1:]:
|
||||
if item == '':
|
||||
result.append('%')
|
||||
else:
|
||||
code = item[:2]
|
||||
result.append(chr(int(code, 16)))
|
||||
result.append(item[2:])
|
||||
return ''.join(result)
|
||||
|
||||
|
||||
class MultiDict(dict):
|
||||
"""A subclass of dictionary that can hold multiple values for the same
|
||||
key. It is used to hold key/value pairs decoded from query strings and
|
||||
form submissions.
|
||||
|
||||
:param initial_dict: an initial dictionary of key/value pairs to
|
||||
initialize this object with.
|
||||
|
||||
Example::
|
||||
|
||||
>>> d = MultiDict()
|
||||
>>> d['sort'] = 'name'
|
||||
>>> d['sort'] = 'email'
|
||||
>>> print(d['sort'])
|
||||
'name'
|
||||
>>> print(d.getlist('sort'))
|
||||
['name', 'email']
|
||||
"""
|
||||
def __init__(self, initial_dict=None):
|
||||
super().__init__()
|
||||
if initial_dict:
|
||||
for key, value in initial_dict.items():
|
||||
self[key] = value
|
||||
|
||||
def __setitem__(self, key, value):
|
||||
if key not in self:
|
||||
super().__setitem__(key, [])
|
||||
super().__getitem__(key).append(value)
|
||||
|
||||
def __getitem__(self, key):
|
||||
return super().__getitem__(key)[0]
|
||||
|
||||
def get(self, key, default=None, type=None):
|
||||
"""Return the value for a given key.
|
||||
|
||||
:param key: The key to retrieve.
|
||||
:param default: A default value to use if the key does not exist.
|
||||
:param type: A type conversion callable to apply to the value.
|
||||
|
||||
If the multidict contains more than one value for the requested key,
|
||||
this method returns the first value only.
|
||||
|
||||
Example::
|
||||
|
||||
>>> d = MultiDict()
|
||||
>>> d['age'] = '42'
|
||||
>>> d.get('age')
|
||||
'42'
|
||||
>>> d.get('age', type=int)
|
||||
42
|
||||
>>> d.get('name', default='noname')
|
||||
'noname'
|
||||
"""
|
||||
if key not in self:
|
||||
return default
|
||||
value = self[key]
|
||||
if type is not None:
|
||||
value = type(value)
|
||||
return value
|
||||
|
||||
def getlist(self, key, type=None):
|
||||
"""Return all the values for a given key.
|
||||
|
||||
:param key: The key to retrieve.
|
||||
:param type: A type conversion callable to apply to the values.
|
||||
|
||||
If the requested key does not exist in the dictionary, this method
|
||||
returns an empty list.
|
||||
|
||||
Example::
|
||||
|
||||
>>> d = MultiDict()
|
||||
>>> d.getlist('items')
|
||||
[]
|
||||
>>> d['items'] = '3'
|
||||
>>> d.getlist('items')
|
||||
['3']
|
||||
>>> d['items'] = '56'
|
||||
>>> d.getlist('items')
|
||||
['3', '56']
|
||||
>>> d.getlist('items', type=int)
|
||||
[3, 56]
|
||||
"""
|
||||
if key not in self:
|
||||
return []
|
||||
values = super().__getitem__(key)
|
||||
if type is not None:
|
||||
values = [type(value) for value in values]
|
||||
return values
|
||||
|
||||
|
||||
class Request():
|
||||
"""An HTTP request class.
|
||||
|
||||
:var app: The application instance to which this request belongs.
|
||||
:var client_addr: The address of the client, as a tuple (host, port).
|
||||
:var method: The HTTP method of the request.
|
||||
:var path: The path portion of the URL.
|
||||
:var query_string: The query string portion of the URL.
|
||||
:var args: The parsed query string, as a :class:`MultiDict` object.
|
||||
:var headers: A dictionary with the headers included in the request.
|
||||
:var cookies: A dictionary with the cookies included in the request.
|
||||
:var content_length: The parsed ``Content-Length`` header.
|
||||
:var content_type: The parsed ``Content-Type`` header.
|
||||
:var body: A stream from where the body can be read.
|
||||
:var json: The parsed JSON body, as a dictionary or list, or ``None`` if
|
||||
the request does not have a JSON body.
|
||||
:var form: The parsed form submission body, as a :class:`MultiDict` object,
|
||||
or ``None`` if the request does not have a form submission.
|
||||
:var g: A general purpose container for applications to store data during
|
||||
the life of the request.
|
||||
"""
|
||||
#: Specify the maximum payload size that is accepted. Requests with larger
|
||||
#: payloads will be rejected with a 413 status code. Applications can
|
||||
#: change this maximum as necessary.
|
||||
#:
|
||||
#: Example::
|
||||
#:
|
||||
#: Request.max_content_length = 1 * 1024 * 1024 # 1MB requests allowed
|
||||
max_content_length = 16 * 1024
|
||||
|
||||
#: Specify the maximum length allowed for a line in the request. Requests
|
||||
#: with longer lines will not be correctly interpreted. Applications can
|
||||
#: change this maximum as necessary.
|
||||
#:
|
||||
#: Example::
|
||||
#:
|
||||
#: Request.max_readline = 16 * 1024 # 16KB lines allowed
|
||||
max_readline = 2 * 1024
|
||||
|
||||
class G:
|
||||
pass
|
||||
|
||||
def __init__(self, app, client_addr, method, url, http_version, headers,
|
||||
body):
|
||||
self.app = app
|
||||
self.client_addr = client_addr
|
||||
self.method = method
|
||||
self.path = url
|
||||
self.http_version = http_version
|
||||
if '?' in self.path:
|
||||
self.path, self.query_string = self.path.split('?', 1)
|
||||
self.args = self._parse_urlencoded(self.query_string)
|
||||
else:
|
||||
self.query_string = None
|
||||
self.args = {}
|
||||
self.headers = headers
|
||||
self.cookies = {}
|
||||
self.content_length = 0
|
||||
self.content_type = None
|
||||
for header, value in self.headers.items():
|
||||
if header == 'Content-Length':
|
||||
self.content_length = int(value)
|
||||
elif header == 'Content-Type':
|
||||
self.content_type = value
|
||||
elif header == 'Cookie':
|
||||
for cookie in value.split(';'):
|
||||
name, value = cookie.strip().split('=', 1)
|
||||
self.cookies[name] = value
|
||||
self.body = body
|
||||
self._json = None
|
||||
self._form = None
|
||||
self.g = Request.G()
|
||||
|
||||
@staticmethod
|
||||
def create(app, client_stream, client_addr):
|
||||
"""Create a request object.
|
||||
|
||||
:param app: The Microdot application instance.
|
||||
:param client_stream: An input stream from where the request data can
|
||||
be read.
|
||||
:param client_addr: The address of the client, as a tuple.
|
||||
|
||||
This method returns a newly created ``Request`` object.
|
||||
"""
|
||||
# request line
|
||||
line = Request._safe_readline(client_stream).strip().decode()
|
||||
if not line:
|
||||
return None
|
||||
method, url, http_version = line.split()
|
||||
http_version = http_version.split('/', 1)[1]
|
||||
|
||||
# headers
|
||||
headers = {}
|
||||
content_length = 0
|
||||
while True:
|
||||
line = Request._safe_readline(client_stream).strip().decode()
|
||||
if line == '':
|
||||
break
|
||||
header, value = line.split(':', 1)
|
||||
value = value.strip()
|
||||
headers[header] = value
|
||||
if header == 'Content-Length':
|
||||
content_length = int(value)
|
||||
|
||||
# body
|
||||
body = client_stream.read(content_length) if content_length and \
|
||||
content_length <= Request.max_content_length else b''
|
||||
|
||||
return Request(app, client_addr, method, url, http_version, headers,
|
||||
body)
|
||||
|
||||
def _parse_urlencoded(self, urlencoded):
|
||||
data = MultiDict()
|
||||
for k, v in [pair.split('=', 1) for pair in urlencoded.split('&')]:
|
||||
data[urldecode(k)] = urldecode(v)
|
||||
return data
|
||||
|
||||
@property
|
||||
def json(self):
|
||||
if self._json is None:
|
||||
if self.content_type is None:
|
||||
return None
|
||||
mime_type = self.content_type.split(';')[0]
|
||||
if mime_type != 'application/json':
|
||||
return None
|
||||
self._json = json.loads(self.body.decode())
|
||||
return self._json
|
||||
|
||||
@property
|
||||
def form(self):
|
||||
if self._form is None:
|
||||
if self.content_type is None:
|
||||
return None
|
||||
mime_type = self.content_type.split(';')[0]
|
||||
if mime_type != 'application/x-www-form-urlencoded':
|
||||
return None
|
||||
self._form = self._parse_urlencoded(self.body.decode())
|
||||
return self._form
|
||||
|
||||
@staticmethod
|
||||
def _safe_readline(stream):
|
||||
line = stream.readline(Request.max_readline + 1)
|
||||
if len(line) > Request.max_readline:
|
||||
raise ValueError('line too long')
|
||||
return line
|
||||
|
||||
|
||||
class Response():
|
||||
"""An HTTP response class.
|
||||
|
||||
:param body: The body of the response. If a dictionary or list is given,
|
||||
a JSON formatter is used to generate the body.
|
||||
:param status_code: The numeric HTTP status code of the response. The
|
||||
default is 200.
|
||||
:param headers: A dictionary of headers to include in the response.
|
||||
:param reason: A custom reason phrase to add after the status code. The
|
||||
default is "OK" for responses with a 200 status code and
|
||||
"N/A" for any other status codes.
|
||||
"""
|
||||
types_map = {
|
||||
'css': 'text/css',
|
||||
'gif': 'image/gif',
|
||||
'html': 'text/html',
|
||||
'jpg': 'image/jpeg',
|
||||
'js': 'application/javascript',
|
||||
'json': 'application/json',
|
||||
'png': 'image/png',
|
||||
'txt': 'text/plain',
|
||||
}
|
||||
send_file_buffer_size = 1024
|
||||
|
||||
def __init__(self, body='', status_code=200, headers=None, reason=None):
|
||||
self.status_code = status_code
|
||||
self.headers = headers.copy() if headers else {}
|
||||
self.reason = reason
|
||||
if isinstance(body, (dict, list)):
|
||||
self.body = json.dumps(body).encode()
|
||||
self.headers['Content-Type'] = 'application/json'
|
||||
elif isinstance(body, str):
|
||||
self.body = body.encode()
|
||||
else:
|
||||
# this applies to bytes or file-like objects
|
||||
self.body = body
|
||||
|
||||
def set_cookie(self, cookie, value, path=None, domain=None, expires=None,
|
||||
max_age=None, secure=False, http_only=False):
|
||||
"""Add a cookie to the response.
|
||||
|
||||
:param cookie: The cookie's name.
|
||||
:param value: The cookie's value.
|
||||
:param path: The cookie's path.
|
||||
:param domain: The cookie's domain.
|
||||
:param expires: The cookie expiration time, as a ``datetime`` object.
|
||||
:param max_age: The cookie's ``Max-Age`` value.
|
||||
:param secure: The cookie's ``secure`` flag.
|
||||
:param http_only: The cookie's ``HttpOnly`` flag.
|
||||
"""
|
||||
http_cookie = '{cookie}={value}'.format(cookie=cookie, value=value)
|
||||
if path:
|
||||
http_cookie += '; Path=' + path
|
||||
if domain:
|
||||
http_cookie += '; Domain=' + domain
|
||||
if expires:
|
||||
http_cookie += '; Expires=' + expires.strftime(
|
||||
"%a, %d %b %Y %H:%M:%S GMT")
|
||||
if max_age:
|
||||
http_cookie += '; Max-Age=' + str(max_age)
|
||||
if secure:
|
||||
http_cookie += '; Secure'
|
||||
if http_only:
|
||||
http_cookie += '; HttpOnly'
|
||||
if 'Set-Cookie' in self.headers:
|
||||
self.headers['Set-Cookie'].append(http_cookie)
|
||||
else:
|
||||
self.headers['Set-Cookie'] = [http_cookie]
|
||||
|
||||
def complete(self):
|
||||
if isinstance(self.body, bytes) and \
|
||||
'Content-Length' not in self.headers:
|
||||
self.headers['Content-Length'] = str(len(self.body))
|
||||
if 'Content-Type' not in self.headers:
|
||||
self.headers['Content-Type'] = 'text/plain'
|
||||
|
||||
def write(self, stream):
|
||||
self.complete()
|
||||
|
||||
# status code
|
||||
reason = self.reason if self.reason is not None else \
|
||||
('OK' if self.status_code == 200 else 'N/A')
|
||||
stream.write('HTTP/1.0 {status_code} {reason}\r\n'.format(
|
||||
status_code=self.status_code, reason=reason).encode())
|
||||
|
||||
# headers
|
||||
for header, value in self.headers.items():
|
||||
values = value if isinstance(value, list) else [value]
|
||||
for value in values:
|
||||
stream.write('{header}: {value}\r\n'.format(
|
||||
header=header, value=value).encode())
|
||||
stream.write(b'\r\n')
|
||||
|
||||
# body
|
||||
if self.body:
|
||||
if hasattr(self.body, 'read'):
|
||||
while True:
|
||||
buf = self.body.read(self.send_file_buffer_size)
|
||||
if len(buf):
|
||||
stream.write(buf)
|
||||
if len(buf) < self.send_file_buffer_size:
|
||||
break
|
||||
if hasattr(self.body, 'close'): # pragma: no cover
|
||||
self.body.close()
|
||||
else:
|
||||
stream.write(self.body)
|
||||
|
||||
@classmethod
|
||||
def redirect(cls, location, status_code=302):
|
||||
"""Return a redirect response.
|
||||
|
||||
:param location: The URL to redirect to.
|
||||
:param status_code: The 3xx status code to use for the redirect. The
|
||||
default is 302.
|
||||
"""
|
||||
if '\x0d' in location or '\x0a' in location:
|
||||
raise ValueError('invalid redirect URL')
|
||||
return cls(status_code=status_code, headers={'Location': location})
|
||||
|
||||
@classmethod
|
||||
def send_file(cls, filename, status_code=200, content_type=None):
|
||||
"""Send file contents in a response.
|
||||
|
||||
:param filename: The filename of the file.
|
||||
:param status_code: The 3xx status code to use for the redirect. The
|
||||
default is 302.
|
||||
:param content_type: The ``Content-Type`` header to use in the
|
||||
response. If omitted, it is generated
|
||||
automatically from the file extension.
|
||||
|
||||
Security note: The filename is assumed to be trusted. Never pass
|
||||
filenames provided by the user before validating and sanitizing them
|
||||
first.
|
||||
"""
|
||||
if content_type is None:
|
||||
ext = filename.split('.')[-1]
|
||||
if ext in Response.types_map:
|
||||
content_type = Response.types_map[ext]
|
||||
else:
|
||||
content_type = 'application/octet-stream'
|
||||
f = open(filename, 'rb')
|
||||
return cls(body=f, status_code=status_code,
|
||||
headers={'Content-Type': content_type})
|
||||
|
||||
|
||||
class URLPattern():
|
||||
def __init__(self, url_pattern):
|
||||
self.pattern = ''
|
||||
self.args = []
|
||||
use_regex = False
|
||||
for segment in url_pattern.lstrip('/').split('/'):
|
||||
if segment and segment[0] == '<':
|
||||
if segment[-1] != '>':
|
||||
raise ValueError('invalid URL pattern')
|
||||
segment = segment[1:-1]
|
||||
if ':' in segment:
|
||||
type_, name = segment.rsplit(':', 1)
|
||||
else:
|
||||
type_ = 'string'
|
||||
name = segment
|
||||
if type_ == 'string':
|
||||
pattern = '[^/]+'
|
||||
elif type_ == 'int':
|
||||
pattern = '\\d+'
|
||||
elif type_ == 'path':
|
||||
pattern = '.+'
|
||||
elif type_.startswith('re:'):
|
||||
pattern = type_[3:]
|
||||
else:
|
||||
raise ValueError('invalid URL segment type')
|
||||
use_regex = True
|
||||
self.pattern += '/({pattern})'.format(pattern=pattern)
|
||||
self.args.append({'type': type_, 'name': name})
|
||||
else:
|
||||
self.pattern += '/{segment}'.format(segment=segment)
|
||||
if use_regex:
|
||||
self.pattern = re.compile('^' + self.pattern + '$')
|
||||
|
||||
def match(self, path):
|
||||
if isinstance(self.pattern, str):
|
||||
if path != self.pattern:
|
||||
return
|
||||
return {}
|
||||
g = self.pattern.match(path)
|
||||
if not g:
|
||||
return
|
||||
args = {}
|
||||
i = 1
|
||||
for arg in self.args:
|
||||
value = g.group(i)
|
||||
if arg['type'] == 'int':
|
||||
value = int(value)
|
||||
args[arg['name']] = value
|
||||
i += 1
|
||||
return args
|
||||
|
||||
|
||||
class Microdot():
|
||||
"""An HTTP application class.
|
||||
|
||||
This class implements an HTTP application instance and is heavily
|
||||
influenced by the ``Flask`` class of the Flask framework. It is typically
|
||||
declared near the start of the main application script.
|
||||
|
||||
Example::
|
||||
|
||||
from microdot import Microdot
|
||||
|
||||
app = Microdot()
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.url_map = []
|
||||
self.before_request_handlers = []
|
||||
self.after_request_handlers = []
|
||||
self.error_handlers = {}
|
||||
self.shutdown_requested = False
|
||||
self.debug = False
|
||||
self.server = None
|
||||
|
||||
def route(self, url_pattern, methods=None):
|
||||
"""Decorator that is used to register a function as a request handler
|
||||
for a given URL.
|
||||
|
||||
:param url_pattern: The URL pattern that will be compared against
|
||||
incoming requests.
|
||||
:param methods: The list of HTTP methods to be handled by the
|
||||
decorated function. If omitted, only ``GET`` requests
|
||||
are handled.
|
||||
|
||||
The URL pattern can be a static path (for example, ``/users`` or
|
||||
``/api/invoices/search``) or a path with dynamic components enclosed
|
||||
in ``<`` and ``>`` (for example, ``/users/<id>`` or
|
||||
``/invoices/<number>/products``). Dynamic path components can also
|
||||
include a type prefix, separated from the name with a colon (for
|
||||
example, ``/users/<int:id>``). The type can be ``string`` (the
|
||||
default), ``int``, ``path`` or ``re:[regular-expression]``.
|
||||
|
||||
The first argument of the decorated function must be
|
||||
the request object. Any path arguments that are specified in the URL
|
||||
pattern are passed as keyword arguments. The return value of the
|
||||
function must be a :class:`Response` instance, or the arguments to
|
||||
be passed to this class.
|
||||
|
||||
Example::
|
||||
|
||||
@app.route('/')
|
||||
def index(request):
|
||||
return 'Hello, world!'
|
||||
"""
|
||||
def decorated(f):
|
||||
self.url_map.append(
|
||||
(methods or ['GET'], URLPattern(url_pattern), f))
|
||||
return f
|
||||
return decorated
|
||||
|
||||
def get(self, url_pattern):
|
||||
"""Decorator that is used to register a function as a ``GET`` request
|
||||
handler for a given URL.
|
||||
|
||||
:param url_pattern: The URL pattern that will be compared against
|
||||
incoming requests.
|
||||
|
||||
This decorator can be used as an alias to the ``route`` decorator with
|
||||
``methods=['GET']``.
|
||||
|
||||
Example::
|
||||
|
||||
@app.get('/users/<int:id>')
|
||||
def get_user(request, id):
|
||||
# ...
|
||||
"""
|
||||
return self.route(url_pattern, methods=['GET'])
|
||||
|
||||
def post(self, url_pattern):
|
||||
"""Decorator that is used to register a function as a ``POST`` request
|
||||
handler for a given URL.
|
||||
|
||||
:param url_pattern: The URL pattern that will be compared against
|
||||
incoming requests.
|
||||
|
||||
This decorator can be used as an alias to the``route`` decorator with
|
||||
``methods=['POST']``.
|
||||
|
||||
Example::
|
||||
|
||||
@app.post('/users')
|
||||
def create_user(request):
|
||||
# ...
|
||||
"""
|
||||
return self.route(url_pattern, methods=['POST'])
|
||||
|
||||
def put(self, url_pattern):
|
||||
"""Decorator that is used to register a function as a ``PUT`` request
|
||||
handler for a given URL.
|
||||
|
||||
:param url_pattern: The URL pattern that will be compared against
|
||||
incoming requests.
|
||||
|
||||
This decorator can be used as an alias to the ``route`` decorator with
|
||||
``methods=['PUT']``.
|
||||
|
||||
Example::
|
||||
|
||||
@app.put('/users/<int:id>')
|
||||
def edit_user(request, id):
|
||||
# ...
|
||||
"""
|
||||
return self.route(url_pattern, methods=['PUT'])
|
||||
|
||||
def patch(self, url_pattern):
|
||||
"""Decorator that is used to register a function as a ``PATCH`` request
|
||||
handler for a given URL.
|
||||
|
||||
:param url_pattern: The URL pattern that will be compared against
|
||||
incoming requests.
|
||||
|
||||
This decorator can be used as an alias to the ``route`` decorator with
|
||||
``methods=['PATCH']``.
|
||||
|
||||
Example::
|
||||
|
||||
@app.patch('/users/<int:id>')
|
||||
def edit_user(request, id):
|
||||
# ...
|
||||
"""
|
||||
return self.route(url_pattern, methods=['PATCH'])
|
||||
|
||||
def delete(self, url_pattern):
|
||||
"""Decorator that is used to register a function as a ``DELETE``
|
||||
request handler for a given URL.
|
||||
|
||||
:param url_pattern: The URL pattern that will be compared against
|
||||
incoming requests.
|
||||
|
||||
This decorator can be used as an alias to the ``route`` decorator with
|
||||
``methods=['DELETE']``.
|
||||
|
||||
Example::
|
||||
|
||||
@app.delete('/users/<int:id>')
|
||||
def delete_user(request, id):
|
||||
# ...
|
||||
"""
|
||||
return self.route(url_pattern, methods=['DELETE'])
|
||||
|
||||
def before_request(self, f):
|
||||
"""Decorator to register a function to run before each request is
|
||||
handled. The decorated function must take a single argument, the
|
||||
request object.
|
||||
|
||||
Example::
|
||||
|
||||
@app.before_request
|
||||
def func(request):
|
||||
# ...
|
||||
"""
|
||||
self.before_request_handlers.append(f)
|
||||
return f
|
||||
|
||||
def after_request(self, f):
|
||||
"""Decorator to register a function to run after each request is
|
||||
handled. The decorated function must take two arguments, the request
|
||||
and response objects. The return value of the function must be an
|
||||
updated response object.
|
||||
|
||||
Example::
|
||||
|
||||
@app.before_request
|
||||
def func(request, response):
|
||||
# ...
|
||||
"""
|
||||
self.after_request_handlers.append(f)
|
||||
return f
|
||||
|
||||
def errorhandler(self, status_code_or_exception_class):
|
||||
"""Decorator to register a function as an error handler. Error handler
|
||||
functions for numeric HTTP status codes must accept a single argument,
|
||||
the request object. Error handler functions for Python exceptions
|
||||
must accept two arguments, the request object and the exception
|
||||
object.
|
||||
|
||||
:param status_code_or_exception_class: The numeric HTTP status code or
|
||||
Python exception class to
|
||||
handle.
|
||||
|
||||
Examples::
|
||||
|
||||
@app.errorhandler(404)
|
||||
def not_found(request):
|
||||
return 'Not found'
|
||||
|
||||
@app.errorhandler(RuntimeError)
|
||||
def runtime_error(request, exception):
|
||||
return 'Runtime error'
|
||||
"""
|
||||
def decorated(f):
|
||||
self.error_handlers[status_code_or_exception_class] = f
|
||||
return f
|
||||
return decorated
|
||||
|
||||
def run(self, host='0.0.0.0', port=5000, debug=False):
|
||||
"""Start the web server. This function does not normally return, as
|
||||
the server enters an endless listening loop. The :func:`shutdown`
|
||||
function provides a method for terminating the server gracefully.
|
||||
|
||||
:param host: The hostname or IP address of the network interface that
|
||||
will be listening for requests. A value of ``'0.0.0.0'``
|
||||
(the default) indicates that the server should listen for
|
||||
requests on all the available interfaces, and a value of
|
||||
``127.0.0.1`` indicates that the server should listen
|
||||
for requests only on the internal networking interface of
|
||||
the host.
|
||||
:param port: The port number to listen for requests. The default is
|
||||
port 5000.
|
||||
:param debug: If ``True``, the server logs debugging information. The
|
||||
default is ``False``.
|
||||
|
||||
Example::
|
||||
|
||||
from microdot import Microdot
|
||||
|
||||
app = Microdot()
|
||||
|
||||
@app.route('/')
|
||||
def index():
|
||||
return 'Hello, world!'
|
||||
|
||||
app.run(debug=True)
|
||||
"""
|
||||
self.debug = debug
|
||||
self.shutdown_requested = False
|
||||
|
||||
self.server = socket.socket()
|
||||
ai = socket.getaddrinfo(host, port)
|
||||
addr = ai[0][-1]
|
||||
|
||||
if self.debug: # pragma: no cover
|
||||
print('Starting {mode} server on {host}:{port}...'.format(
|
||||
mode=concurrency_mode, host=host, port=port))
|
||||
self.server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
||||
self.server.bind(addr)
|
||||
self.server.listen(5)
|
||||
|
||||
while not self.shutdown_requested:
|
||||
try:
|
||||
sock, addr = self.server.accept()
|
||||
except OSError as exc: # pragma: no cover
|
||||
if exc.args[0] == errno.ECONNABORTED:
|
||||
break
|
||||
else:
|
||||
raise
|
||||
create_thread(self.dispatch_request, sock, addr)
|
||||
|
||||
def shutdown(self):
|
||||
"""Request a server shutdown. The server will then exit its request
|
||||
listening loop and the :func:`run` function will return. This function
|
||||
can be safely called from a route handler, as it only schedules the
|
||||
server to terminate as soon as the request completes.
|
||||
|
||||
Example::
|
||||
|
||||
@app.route('/shutdown')
|
||||
def shutdown(request):
|
||||
request.app.shutdown()
|
||||
return 'The server is shutting down...'
|
||||
"""
|
||||
self.shutdown_requested = True
|
||||
|
||||
def find_route(self, req):
|
||||
f = None
|
||||
for route_methods, route_pattern, route_handler in self.url_map:
|
||||
if req.method in route_methods:
|
||||
req.url_args = route_pattern.match(req.path)
|
||||
if req.url_args is not None:
|
||||
f = route_handler
|
||||
break
|
||||
return f
|
||||
|
||||
def dispatch_request(self, sock, addr):
|
||||
if not hasattr(sock, 'readline'): # pragma: no cover
|
||||
stream = sock.makefile("rwb")
|
||||
else:
|
||||
stream = sock
|
||||
|
||||
req = None
|
||||
try:
|
||||
req = Request.create(self, stream, addr)
|
||||
except Exception as exc: # pragma: no cover
|
||||
print_exception(exc)
|
||||
if req:
|
||||
if req.content_length > req.max_content_length:
|
||||
if 413 in self.error_handlers:
|
||||
res = self.error_handlers[413](req)
|
||||
else:
|
||||
res = 'Payload too large', 413
|
||||
else:
|
||||
f = self.find_route(req)
|
||||
try:
|
||||
res = None
|
||||
if f:
|
||||
for handler in self.before_request_handlers:
|
||||
res = handler(req)
|
||||
if res:
|
||||
break
|
||||
if res is None:
|
||||
res = f(req, **req.url_args)
|
||||
if isinstance(res, tuple):
|
||||
res = Response(*res)
|
||||
elif not isinstance(res, Response):
|
||||
res = Response(res)
|
||||
for handler in self.after_request_handlers:
|
||||
res = handler(req, res) or res
|
||||
elif 404 in self.error_handlers:
|
||||
res = self.error_handlers[404](req)
|
||||
else:
|
||||
res = 'Not found', 404
|
||||
except Exception as exc:
|
||||
print_exception(exc)
|
||||
res = None
|
||||
if exc.__class__ in self.error_handlers:
|
||||
try:
|
||||
res = self.error_handlers[exc.__class__](req, exc)
|
||||
except Exception as exc2: # pragma: no cover
|
||||
print_exception(exc2)
|
||||
if res is None:
|
||||
if 500 in self.error_handlers:
|
||||
res = self.error_handlers[500](req)
|
||||
else:
|
||||
res = 'Internal server error', 500
|
||||
else:
|
||||
res = 'Bad request', 400
|
||||
if isinstance(res, tuple):
|
||||
res = Response(*res)
|
||||
elif not isinstance(res, Response):
|
||||
res = Response(res)
|
||||
res.write(stream)
|
||||
stream.close()
|
||||
if stream != sock: # pragma: no cover
|
||||
sock.close()
|
||||
if self.shutdown_requested: # pragma: no cover
|
||||
self.server.close()
|
||||
if self.debug and req: # pragma: no cover
|
||||
print('{method} {path} {status_code}'.format(
|
||||
method=req.method, path=req.path,
|
||||
status_code=res.status_code))
|
||||
|
||||
|
||||
redirect = Response.redirect
|
||||
send_file = Response.send_file
|
||||
294
src/microdot_asyncio.py
Normal file
294
src/microdot_asyncio.py
Normal file
@@ -0,0 +1,294 @@
|
||||
"""
|
||||
microdot_asyncio
|
||||
----------------
|
||||
|
||||
The ``microdot_asyncio`` module defines a few classes that help implement
|
||||
HTTP-based servers for MicroPython and standard Python that use ``asyncio``
|
||||
and coroutines.
|
||||
"""
|
||||
try:
|
||||
import uasyncio as asyncio
|
||||
except ImportError:
|
||||
import asyncio
|
||||
from microdot import Microdot as BaseMicrodot
|
||||
from microdot import print_exception
|
||||
from microdot import Request as BaseRequest
|
||||
from microdot import Response as BaseResponse
|
||||
|
||||
|
||||
def _iscoroutine(coro):
|
||||
return hasattr(coro, 'send') and hasattr(coro, 'throw')
|
||||
|
||||
|
||||
class Request(BaseRequest):
|
||||
@staticmethod
|
||||
async def create(app, client_stream, client_addr):
|
||||
"""Create a request object.
|
||||
|
||||
:param app: The Microdot application instance.
|
||||
:param client_stream: An input stream from where the request data can
|
||||
be read.
|
||||
:param client_addr: The address of the client, as a tuple.
|
||||
|
||||
This method is a coroutine. It returns a newly created ``Request``
|
||||
object.
|
||||
"""
|
||||
# request line
|
||||
line = (await Request._safe_readline(client_stream)).strip().decode()
|
||||
if not line: # pragma: no cover
|
||||
return None
|
||||
method, url, http_version = line.split()
|
||||
http_version = http_version.split('/', 1)[1]
|
||||
|
||||
# headers
|
||||
headers = {}
|
||||
content_length = 0
|
||||
while True:
|
||||
line = (await Request._safe_readline(
|
||||
client_stream)).strip().decode()
|
||||
if line == '':
|
||||
break
|
||||
header, value = line.split(':', 1)
|
||||
value = value.strip()
|
||||
headers[header] = value
|
||||
if header == 'Content-Length':
|
||||
content_length = int(value)
|
||||
|
||||
# body
|
||||
body = await client_stream.read(content_length) if content_length and \
|
||||
content_length <= Request.max_content_length else b''
|
||||
|
||||
return Request(app, client_addr, method, url, http_version, headers,
|
||||
body)
|
||||
|
||||
@staticmethod
|
||||
async def _safe_readline(stream):
|
||||
line = (await stream.readline())
|
||||
if len(line) > Request.max_readline:
|
||||
raise ValueError('line too long')
|
||||
return line
|
||||
|
||||
|
||||
class Response(BaseResponse):
|
||||
"""An HTTP response class.
|
||||
|
||||
:param body: The body of the response. If a dictionary or list is given,
|
||||
a JSON formatter is used to generate the body.
|
||||
:param status_code: The numeric HTTP status code of the response. The
|
||||
default is 200.
|
||||
:param headers: A dictionary of headers to include in the response.
|
||||
:param reason: A custom reason phrase to add after the status code. The
|
||||
default is "OK" for responses with a 200 status code and
|
||||
"N/A" for any other status codes.
|
||||
"""
|
||||
async def write(self, stream):
|
||||
self.complete()
|
||||
|
||||
# status code
|
||||
reason = self.reason if self.reason is not None else \
|
||||
('OK' if self.status_code == 200 else 'N/A')
|
||||
await stream.awrite('HTTP/1.0 {status_code} {reason}\r\n'.format(
|
||||
status_code=self.status_code, reason=reason).encode())
|
||||
|
||||
# headers
|
||||
for header, value in self.headers.items():
|
||||
values = value if isinstance(value, list) else [value]
|
||||
for value in values:
|
||||
await stream.awrite('{header}: {value}\r\n'.format(
|
||||
header=header, value=value).encode())
|
||||
await stream.awrite(b'\r\n')
|
||||
|
||||
# body
|
||||
if self.body:
|
||||
if hasattr(self.body, 'read'):
|
||||
while True:
|
||||
buf = self.body.read(self.send_file_buffer_size)
|
||||
if len(buf):
|
||||
await stream.awrite(buf)
|
||||
if len(buf) < self.send_file_buffer_size:
|
||||
break
|
||||
if hasattr(self.body, 'close'): # pragma: no cover
|
||||
self.body.close()
|
||||
else:
|
||||
await stream.awrite(self.body)
|
||||
|
||||
|
||||
class Microdot(BaseMicrodot):
|
||||
async def start_server(self, host='0.0.0.0', port=5000, debug=False):
|
||||
"""Start the Microdot web server as a coroutine. This coroutine does
|
||||
not normally return, as the server enters an endless listening loop.
|
||||
The :func:`shutdown` function provides a method for terminating the
|
||||
server gracefully.
|
||||
|
||||
:param host: The hostname or IP address of the network interface that
|
||||
will be listening for requests. A value of ``'0.0.0.0'``
|
||||
(the default) indicates that the server should listen for
|
||||
requests on all the available interfaces, and a value of
|
||||
``127.0.0.1`` indicates that the server should listen
|
||||
for requests only on the internal networking interface of
|
||||
the host.
|
||||
:param port: The port number to listen for requests. The default is
|
||||
port 5000.
|
||||
:param debug: If ``True``, the server logs debugging information. The
|
||||
default is ``False``.
|
||||
|
||||
This method is a coroutine.
|
||||
|
||||
Example::
|
||||
|
||||
import asyncio
|
||||
from microdot_asyncio import Microdot
|
||||
|
||||
app = Microdot()
|
||||
|
||||
@app.route('/')
|
||||
async def index():
|
||||
return 'Hello, world!'
|
||||
|
||||
async def main():
|
||||
await app.start_server(debug=True)
|
||||
|
||||
asyncio.run(main())
|
||||
"""
|
||||
self.debug = debug
|
||||
|
||||
async def serve(reader, writer):
|
||||
if not hasattr(writer, 'awrite'): # pragma: no cover
|
||||
# CPython provides the awrite and aclose methods in 3.8+
|
||||
async def awrite(self, data):
|
||||
self.write(data)
|
||||
await self.drain()
|
||||
|
||||
async def aclose(self):
|
||||
self.close()
|
||||
await self.wait_closed()
|
||||
|
||||
from types import MethodType
|
||||
writer.awrite = MethodType(awrite, writer)
|
||||
writer.aclose = MethodType(aclose, writer)
|
||||
|
||||
await self.dispatch_request(reader, writer)
|
||||
|
||||
if self.debug: # pragma: no cover
|
||||
print('Starting async server on {host}:{port}...'.format(
|
||||
host=host, port=port))
|
||||
|
||||
self.server = await asyncio.start_server(serve, host, port)
|
||||
while True:
|
||||
try:
|
||||
await self.server.wait_closed()
|
||||
break
|
||||
except AttributeError: # pragma: no cover
|
||||
# the task hasn't been initialized in the server object yet
|
||||
# wait a bit and try again
|
||||
await asyncio.sleep(0.1)
|
||||
|
||||
def run(self, host='0.0.0.0', port=5000, debug=False):
|
||||
"""Start the web server. This function does not normally return, as
|
||||
the server enters an endless listening loop. The :func:`shutdown`
|
||||
function provides a method for terminating the server gracefully.
|
||||
|
||||
:param host: The hostname or IP address of the network interface that
|
||||
will be listening for requests. A value of ``'0.0.0.0'``
|
||||
(the default) indicates that the server should listen for
|
||||
requests on all the available interfaces, and a value of
|
||||
``127.0.0.1`` indicates that the server should listen
|
||||
for requests only on the internal networking interface of
|
||||
the host.
|
||||
:param port: The port number to listen for requests. The default is
|
||||
port 5000.
|
||||
:param debug: If ``True``, the server logs debugging information. The
|
||||
default is ``False``.
|
||||
|
||||
Example::
|
||||
|
||||
from microdot_asyncio import Microdot
|
||||
|
||||
app = Microdot()
|
||||
|
||||
@app.route('/')
|
||||
async def index():
|
||||
return 'Hello, world!'
|
||||
|
||||
app.run(debug=True)
|
||||
"""
|
||||
asyncio.run(self.start_server(host=host, port=port, debug=debug))
|
||||
|
||||
def shutdown(self):
|
||||
self.server.close()
|
||||
|
||||
async def dispatch_request(self, reader, writer):
|
||||
req = None
|
||||
try:
|
||||
req = await Request.create(self, reader,
|
||||
writer.get_extra_info('peername'))
|
||||
except Exception as exc: # pragma: no cover
|
||||
print_exception(exc)
|
||||
if req:
|
||||
if req.content_length > req.max_content_length:
|
||||
if 413 in self.error_handlers:
|
||||
res = await self._invoke_handler(
|
||||
self.error_handlers[413], req)
|
||||
else:
|
||||
res = 'Payload too large', 413
|
||||
else:
|
||||
f = self.find_route(req)
|
||||
try:
|
||||
res = None
|
||||
if f:
|
||||
for handler in self.before_request_handlers:
|
||||
res = await self._invoke_handler(handler, req)
|
||||
if res:
|
||||
break
|
||||
if res is None:
|
||||
res = await self._invoke_handler(
|
||||
f, req, **req.url_args)
|
||||
if isinstance(res, tuple):
|
||||
res = Response(*res)
|
||||
elif not isinstance(res, Response):
|
||||
res = Response(res)
|
||||
for handler in self.after_request_handlers:
|
||||
res = await self._invoke_handler(
|
||||
handler, req, res) or res
|
||||
elif 404 in self.error_handlers:
|
||||
res = await self._invoke_handler(
|
||||
self.error_handlers[404], req)
|
||||
else:
|
||||
res = 'Not found', 404
|
||||
except Exception as exc:
|
||||
print_exception(exc)
|
||||
res = None
|
||||
if exc.__class__ in self.error_handlers:
|
||||
try:
|
||||
res = await self._invoke_handler(
|
||||
self.error_handlers[exc.__class__], req, exc)
|
||||
except Exception as exc2: # pragma: no cover
|
||||
print_exception(exc2)
|
||||
if res is None:
|
||||
if 500 in self.error_handlers:
|
||||
res = await self._invoke_handler(
|
||||
self.error_handlers[500], req)
|
||||
else:
|
||||
res = 'Internal server error', 500
|
||||
else:
|
||||
res = 'Bad request', 400
|
||||
if isinstance(res, tuple):
|
||||
res = Response(*res)
|
||||
elif not isinstance(res, Response):
|
||||
res = Response(res)
|
||||
await res.write(writer)
|
||||
await writer.aclose()
|
||||
if self.debug and req: # pragma: no cover
|
||||
print('{method} {path} {status_code}'.format(
|
||||
method=req.method, path=req.path,
|
||||
status_code=res.status_code))
|
||||
|
||||
async def _invoke_handler(self, f_or_coro, *args, **kwargs):
|
||||
ret = f_or_coro(*args, **kwargs)
|
||||
if _iscoroutine(ret):
|
||||
ret = await ret
|
||||
return ret
|
||||
|
||||
|
||||
redirect = Response.redirect
|
||||
send_file = Response.send_file
|
||||
@@ -1,3 +1,4 @@
|
||||
from tests.microdot.test_multidict import TestMultiDict
|
||||
from tests.microdot.test_request import TestRequest
|
||||
from tests.microdot.test_response import TestResponse
|
||||
from tests.microdot.test_url_pattern import TestURLPattern
|
||||
|
||||
@@ -65,6 +65,52 @@ class TestMicrodot(unittest.TestCase):
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\nbar'))
|
||||
|
||||
def test_empty_request(self):
|
||||
app = Microdot()
|
||||
|
||||
mock_socket.clear_requests()
|
||||
fd = mock_socket.FakeStream(b'\n')
|
||||
mock_socket._requests.append(fd)
|
||||
self._add_shutdown(app)
|
||||
app.run()
|
||||
self.assertTrue(fd.response.startswith(b'HTTP/1.0 400 N/A\r\n'))
|
||||
self.assertIn(b'Content-Length: 11\r\n', fd.response)
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\nBad request'))
|
||||
|
||||
def test_method_decorators(self):
|
||||
app = Microdot()
|
||||
|
||||
@app.get('/get')
|
||||
def get(req):
|
||||
return 'GET'
|
||||
|
||||
@app.post('/post')
|
||||
def post(req):
|
||||
return 'POST'
|
||||
|
||||
@app.put('/put')
|
||||
def put(req):
|
||||
return 'PUT'
|
||||
|
||||
@app.patch('/patch')
|
||||
def patch(req):
|
||||
return 'PATCH'
|
||||
|
||||
@app.delete('/delete')
|
||||
def delete(req):
|
||||
return 'DELETE'
|
||||
|
||||
methods = ['GET', 'POST', 'PUT', 'PATCH', 'DELETE']
|
||||
mock_socket.clear_requests()
|
||||
fds = [mock_socket.add_request(method, '/' + method.lower())
|
||||
for method in methods]
|
||||
self._add_shutdown(app)
|
||||
app.run()
|
||||
for fd, method in zip(fds, methods):
|
||||
self.assertTrue(fd.response.endswith(
|
||||
b'\r\n\r\n' + method.encode()))
|
||||
|
||||
def test_before_after_request(self):
|
||||
app = Microdot()
|
||||
|
||||
@@ -149,6 +195,42 @@ class TestMicrodot(unittest.TestCase):
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\n404'))
|
||||
|
||||
def test_413(self):
|
||||
app = Microdot()
|
||||
|
||||
@app.route('/')
|
||||
def index(req):
|
||||
return 'foo'
|
||||
|
||||
mock_socket.clear_requests()
|
||||
fd = mock_socket.add_request('GET', '/foo', body='x' * 17000)
|
||||
self._add_shutdown(app)
|
||||
app.run()
|
||||
self.assertTrue(fd.response.startswith(b'HTTP/1.0 413 N/A\r\n'))
|
||||
self.assertIn(b'Content-Length: 17\r\n', fd.response)
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\nPayload too large'))
|
||||
|
||||
def test_413_handler(self):
|
||||
app = Microdot()
|
||||
|
||||
@app.route('/')
|
||||
def index(req):
|
||||
return 'foo'
|
||||
|
||||
@app.errorhandler(413)
|
||||
def handle_413(req):
|
||||
return '413', 400
|
||||
|
||||
mock_socket.clear_requests()
|
||||
fd = mock_socket.add_request('GET', '/foo', body='x' * 17000)
|
||||
self._add_shutdown(app)
|
||||
app.run()
|
||||
self.assertTrue(fd.response.startswith(b'HTTP/1.0 400 N/A\r\n'))
|
||||
self.assertIn(b'Content-Length: 3\r\n', fd.response)
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\n413'))
|
||||
|
||||
def test_500(self):
|
||||
app = Microdot()
|
||||
|
||||
|
||||
31
tests/microdot/test_multidict.py
Normal file
31
tests/microdot/test_multidict.py
Normal file
@@ -0,0 +1,31 @@
|
||||
import unittest
|
||||
from microdot import MultiDict
|
||||
|
||||
|
||||
class TestMultiDict(unittest.TestCase):
|
||||
def test_multidict(self):
|
||||
d = MultiDict()
|
||||
|
||||
assert dict(d) == {}
|
||||
assert d.get('zero') is None
|
||||
assert d.get('zero', default=0) == 0
|
||||
assert d.getlist('zero') == []
|
||||
assert d.getlist('zero', type=int) == []
|
||||
|
||||
d['one'] = 1
|
||||
assert d['one'] == 1
|
||||
assert d.get('one') == 1
|
||||
assert d.get('one', default=2) == 1
|
||||
assert d.get('one', type=int) == 1
|
||||
assert d.get('one', type=str) == '1'
|
||||
|
||||
d['two'] = 1
|
||||
d['two'] = 2
|
||||
assert d['two'] == 1
|
||||
assert d.get('two') == 1
|
||||
assert d.get('two', default=2) == 1
|
||||
assert d.get('two', type=int) == 1
|
||||
assert d.get('two', type=str) == '1'
|
||||
assert d.getlist('two') == [1, 2]
|
||||
assert d.getlist('two', type=int) == [1, 2]
|
||||
assert d.getlist('two', type=str) == ['1', '2']
|
||||
@@ -1,5 +1,5 @@
|
||||
import unittest
|
||||
from microdot import Request
|
||||
from microdot import Request, MultiDict
|
||||
from tests.mock_socket import get_request_fd
|
||||
|
||||
|
||||
@@ -42,7 +42,8 @@ class TestRequest(unittest.TestCase):
|
||||
fd = get_request_fd('GET', '/?foo=bar&abc=def&x=%2f%%')
|
||||
req = Request.create('app', fd, 'addr')
|
||||
self.assertEqual(req.query_string, 'foo=bar&abc=def&x=%2f%%')
|
||||
self.assertEqual(req.args, {'foo': 'bar', 'abc': 'def', 'x': '/%%'})
|
||||
self.assertEqual(req.args, MultiDict(
|
||||
{'foo': 'bar', 'abc': 'def', 'x': '/%%'}))
|
||||
|
||||
def test_json(self):
|
||||
fd = get_request_fd('GET', '/foo', headers={
|
||||
@@ -68,7 +69,8 @@ class TestRequest(unittest.TestCase):
|
||||
body='foo=bar&abc=def&x=%2f%%')
|
||||
req = Request.create('app', fd, 'addr')
|
||||
form = req.form
|
||||
self.assertEqual(form, {'foo': 'bar', 'abc': 'def', 'x': '/%%'})
|
||||
self.assertEqual(form, MultiDict(
|
||||
{'foo': 'bar', 'abc': 'def', 'x': '/%%'}))
|
||||
self.assertTrue(req.form is form)
|
||||
|
||||
fd = get_request_fd('GET', '/foo', headers={
|
||||
@@ -76,3 +78,27 @@ class TestRequest(unittest.TestCase):
|
||||
body='foo=bar&abc=def&x=%2f%%')
|
||||
req = Request.create('app', fd, 'addr')
|
||||
self.assertIsNone(req.form)
|
||||
|
||||
def test_large_line(self):
|
||||
saved_max_readline = Request.max_readline
|
||||
Request.max_readline = 16
|
||||
|
||||
fd = get_request_fd('GET', '/foo', headers={
|
||||
'Content-Type': 'application/x-www-form-urlencoded'},
|
||||
body='foo=bar&abc=def&x=y')
|
||||
with self.assertRaises(ValueError):
|
||||
Request.create('app', fd, 'addr')
|
||||
|
||||
Request.max_readline = saved_max_readline
|
||||
|
||||
def test_large_payload(self):
|
||||
saved_max_content_length = Request.max_content_length
|
||||
Request.max_content_length = 16
|
||||
|
||||
fd = get_request_fd('GET', '/foo', headers={
|
||||
'Content-Type': 'application/x-www-form-urlencoded'},
|
||||
body='foo=bar&abc=def&x=y')
|
||||
req = Request.create('app', fd, 'addr')
|
||||
self.assertEqual(req.body, b'')
|
||||
|
||||
Request.max_content_length = saved_max_content_length
|
||||
|
||||
@@ -112,6 +112,28 @@ class TestResponse(unittest.TestCase):
|
||||
self.assertEqual(res.headers, {'X-Test': 'Foo'})
|
||||
self.assertEqual(res.body, b'foo')
|
||||
|
||||
def test_create_with_reason(self):
|
||||
res = Response('foo', reason='ALL GOOD!')
|
||||
self.assertEqual(res.status_code, 200)
|
||||
self.assertEqual(res.headers, {})
|
||||
self.assertEqual(res.reason, 'ALL GOOD!')
|
||||
self.assertEqual(res.body, b'foo')
|
||||
fd = io.BytesIO()
|
||||
res.write(fd)
|
||||
response = fd.getvalue()
|
||||
self.assertIn(b'HTTP/1.0 200 ALL GOOD!\r\n', response)
|
||||
|
||||
def test_create_with_status_and_reason(self):
|
||||
res = Response('not found', 404, reason='NOT FOUND')
|
||||
self.assertEqual(res.status_code, 404)
|
||||
self.assertEqual(res.headers, {})
|
||||
self.assertEqual(res.reason, 'NOT FOUND')
|
||||
self.assertEqual(res.body, b'not found')
|
||||
fd = io.BytesIO()
|
||||
res.write(fd)
|
||||
response = fd.getvalue()
|
||||
self.assertIn(b'HTTP/1.0 404 NOT FOUND\r\n', response)
|
||||
|
||||
def test_cookies(self):
|
||||
res = Response('ok')
|
||||
res.set_cookie('foo1', 'bar1')
|
||||
|
||||
@@ -76,6 +76,19 @@ class TestMicrodotAsync(unittest.TestCase):
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd2.response)
|
||||
self.assertTrue(fd2.response.endswith(b'\r\n\r\nbar-async'))
|
||||
|
||||
def test_empty_request(self):
|
||||
app = Microdot()
|
||||
|
||||
mock_socket.clear_requests()
|
||||
fd = mock_socket.FakeStream(b'\n')
|
||||
mock_socket._requests.append(fd)
|
||||
self._add_shutdown(app)
|
||||
app.run()
|
||||
self.assertTrue(fd.response.startswith(b'HTTP/1.0 400 N/A\r\n'))
|
||||
self.assertIn(b'Content-Length: 11\r\n', fd.response)
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\nBad request'))
|
||||
|
||||
def test_before_after_request(self):
|
||||
app = Microdot()
|
||||
|
||||
@@ -160,6 +173,42 @@ class TestMicrodotAsync(unittest.TestCase):
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\n404'))
|
||||
|
||||
def test_413(self):
|
||||
app = Microdot()
|
||||
|
||||
@app.route('/')
|
||||
def index(req):
|
||||
return 'foo'
|
||||
|
||||
mock_socket.clear_requests()
|
||||
fd = mock_socket.add_request('GET', '/foo', body='x' * 17000)
|
||||
self._add_shutdown(app)
|
||||
app.run()
|
||||
self.assertTrue(fd.response.startswith(b'HTTP/1.0 413 N/A\r\n'))
|
||||
self.assertIn(b'Content-Length: 17\r\n', fd.response)
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\nPayload too large'))
|
||||
|
||||
def test_413_handler(self):
|
||||
app = Microdot()
|
||||
|
||||
@app.route('/')
|
||||
def index(req):
|
||||
return 'foo'
|
||||
|
||||
@app.errorhandler(413)
|
||||
async def handle_413(req):
|
||||
return '413', 400
|
||||
|
||||
mock_socket.clear_requests()
|
||||
fd = mock_socket.add_request('GET', '/foo', body='x' * 17000)
|
||||
self._add_shutdown(app)
|
||||
app.run()
|
||||
self.assertTrue(fd.response.startswith(b'HTTP/1.0 400 N/A\r\n'))
|
||||
self.assertIn(b'Content-Length: 3\r\n', fd.response)
|
||||
self.assertIn(b'Content-Type: text/plain\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\n413'))
|
||||
|
||||
def test_500(self):
|
||||
app = Microdot()
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@ except ImportError:
|
||||
import asyncio
|
||||
|
||||
import unittest
|
||||
from microdot import MultiDict
|
||||
from microdot_asyncio import Request
|
||||
from tests.mock_socket import get_async_request_fd
|
||||
|
||||
@@ -51,7 +52,8 @@ class TestRequestAsync(unittest.TestCase):
|
||||
fd = get_async_request_fd('GET', '/?foo=bar&abc=def&x=%2f%%')
|
||||
req = _run(Request.create('app', fd, 'addr'))
|
||||
self.assertEqual(req.query_string, 'foo=bar&abc=def&x=%2f%%')
|
||||
self.assertEqual(req.args, {'foo': 'bar', 'abc': 'def', 'x': '/%%'})
|
||||
self.assertEqual(req.args, MultiDict(
|
||||
{'foo': 'bar', 'abc': 'def', 'x': '/%%'}))
|
||||
|
||||
def test_json(self):
|
||||
fd = get_async_request_fd('GET', '/foo', headers={
|
||||
@@ -77,7 +79,8 @@ class TestRequestAsync(unittest.TestCase):
|
||||
body='foo=bar&abc=def&x=%2f%%')
|
||||
req = _run(Request.create('app', fd, 'addr'))
|
||||
form = req.form
|
||||
self.assertEqual(form, {'foo': 'bar', 'abc': 'def', 'x': '/%%'})
|
||||
self.assertEqual(form, MultiDict(
|
||||
{'foo': 'bar', 'abc': 'def', 'x': '/%%'}))
|
||||
self.assertTrue(req.form is form)
|
||||
|
||||
fd = get_async_request_fd('GET', '/foo', headers={
|
||||
@@ -85,3 +88,27 @@ class TestRequestAsync(unittest.TestCase):
|
||||
body='foo=bar&abc=def&x=%2f%%')
|
||||
req = _run(Request.create('app', fd, 'addr'))
|
||||
self.assertIsNone(req.form)
|
||||
|
||||
def test_large_line(self):
|
||||
saved_max_readline = Request.max_readline
|
||||
Request.max_readline = 16
|
||||
|
||||
fd = get_async_request_fd('GET', '/foo', headers={
|
||||
'Content-Type': 'application/x-www-form-urlencoded'},
|
||||
body='foo=bar&abc=def&x=y')
|
||||
with self.assertRaises(ValueError):
|
||||
_run(Request.create('app', fd, 'addr'))
|
||||
|
||||
Request.max_readline = saved_max_readline
|
||||
|
||||
def test_large_payload(self):
|
||||
saved_max_content_length = Request.max_content_length
|
||||
Request.max_content_length = 16
|
||||
|
||||
fd = get_async_request_fd('GET', '/foo', headers={
|
||||
'Content-Type': 'application/x-www-form-urlencoded'},
|
||||
body='foo=bar&abc=def&x=y')
|
||||
req = _run(Request.create('app', fd, 'addr'))
|
||||
self.assertEqual(req.body, b'')
|
||||
|
||||
Request.max_content_length = saved_max_content_length
|
||||
|
||||
@@ -85,6 +85,26 @@ class TestResponseAsync(unittest.TestCase):
|
||||
self.assertIn(b'Content-Type: application/json\r\n', fd.response)
|
||||
self.assertTrue(fd.response.endswith(b'\r\n\r\n[1, "2"]'))
|
||||
|
||||
def test_create_with_reason(self):
|
||||
res = Response('foo', reason='ALL GOOD!')
|
||||
self.assertEqual(res.status_code, 200)
|
||||
self.assertEqual(res.headers, {})
|
||||
self.assertEqual(res.reason, 'ALL GOOD!')
|
||||
self.assertEqual(res.body, b'foo')
|
||||
fd = FakeStreamAsync()
|
||||
_run(res.write(fd))
|
||||
self.assertIn(b'HTTP/1.0 200 ALL GOOD!\r\n', fd.response)
|
||||
|
||||
def test_create_with_status_and_reason(self):
|
||||
res = Response('not found', 404, reason='NOT FOUND')
|
||||
self.assertEqual(res.status_code, 404)
|
||||
self.assertEqual(res.headers, {})
|
||||
self.assertEqual(res.reason, 'NOT FOUND')
|
||||
self.assertEqual(res.body, b'not found')
|
||||
fd = FakeStreamAsync()
|
||||
_run(res.write(fd))
|
||||
self.assertIn(b'HTTP/1.0 404 NOT FOUND\r\n', fd.response)
|
||||
|
||||
def test_send_file(self):
|
||||
res = Response.send_file('tests/files/test.txt',
|
||||
content_type='text/html')
|
||||
|
||||
12
tox.ini
12
tox.ini
@@ -13,17 +13,17 @@ python =
|
||||
|
||||
[testenv]
|
||||
commands=
|
||||
pip install -e microdot
|
||||
pip install -e microdot-asyncio
|
||||
coverage run --branch --include="microdot*.py" -m unittest tests
|
||||
coverage report --show-missing
|
||||
deps=coverage
|
||||
pip install -e .
|
||||
pytest -p no:logging --cov=src --cov-branch --cov-report=term-missing
|
||||
deps=
|
||||
pytest
|
||||
pytest-cov
|
||||
|
||||
[testenv:flake8]
|
||||
deps=
|
||||
flake8
|
||||
commands=
|
||||
flake8 --ignore=W503 --exclude tests/libs microdot microdot-asyncio tests
|
||||
flake8 --ignore=W503 --exclude tests/libs src tests
|
||||
|
||||
[testenv:upy]
|
||||
whitelist_externals=sh
|
||||
|
||||
Reference in New Issue
Block a user