Streaming parser for multipart/form-data
Project description
streaming_form_data
provides a Python parser for parsing
multipart/form-data input chunks. Chunk size is determined by the API user, but
currently there are no restrictions on what the size should be, since the parser
works byte-by-byte. Although, this also means that passing the entire input as a
single chunk should also work.
The main entry point is the StreamingFormDataParser
class, which expects
a dictionary of request headers
.
The parser is fed chunks of (byte) input, and takes action depending on what the
current byte is. In case it notices input that’s expected, it passes on the
input to the configured Target
, which then decides what to do with it.
In case there’s a part that we don’t need, this input is simply discarded using
a NullTarget
object.
Currently three targets are included with this library - ValueTarget
,
FileTarget
, and SHA256Target
. ValueTarget
stores the
input in memory, and FileTarget
pipes the input to a file on disk. Any
new targets should inherit streaming_form_data.targets.BaseTarget
and
define a data_received
function.
Please note, that this library has only been tested with Python 3 (specifically, versions 3.3, 3.4, 3.5, and 3.6). Python 2.7 is not supported yet, but pull requests are always welcome!
Usage
>>> from streaming_form_data import StreamingFormDataParser
>>> from streaming_form_data.targets import ValueTarget, FileTarget
>>>
>>> headers = {'Content-Type': 'multipart/form-data; boundary=boundary'}
>>>
>>> parser = StreamingFormDataParser(headers=headers)
>>>
>>> parser.register('name', ValueTarget())
>>> parser.register('file', FileTarget('/tmp/file.txt'))
>>>
>>> parser.data_received(chunk)
Development
To work on this package, please make sure you have a working Python 3 installation on your system.
Create a virtualenv -
python -m venv venv && source venv/bin/activate
.Git clone the repository -
git clone https://github.com/siddhantgoel/streaming-form-data
Install the packages required for development -
pip install -r requirements.dev.txt
Install this package -
pip install .
.You should now be able to run the test suite -
py.test tests/
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for streaming_form_data-0.4.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9951226b51a74def1814097e9f6153a751be3113e2a523084fe913ebe680f336 |
|
MD5 | b2670af536d736255f6f98064b35ec33 |
|
BLAKE2b-256 | a371691f4568ecbf95eab95d40c144dcdc1088a29b9aec849fa81aabf481a98c |
Hashes for streaming_form_data-0.4.3-py3.6-linux-x86_64.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c3e3fd7691210f7b7cdaed510854956d01266c5fef8136539338bf8c2dbb29c |
|
MD5 | 1da1c825ec189621f5f42e571235dd9c |
|
BLAKE2b-256 | d54877a1526090b8f38ea655b8a0d528fbc7bab320a1c3fcb0db04b9065ba933 |