Skip to main content

Streaming parser for multipart/form-data

Project description

https://travis-ci.org/siddhantgoel/streaming-form-data.svg?branch=master https://readthedocs.org/projects/streaming-form-data/badge/?version=latest

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!

Installation

$ pip install streaming-form-data

In case you prefer cloning the Github repository and installing manually, please note that master is the development branch, so stable is what you should be cloning.

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.

  1. Create a virtualenv - python -m venv venv && source venv/bin/activate.
  2. Git clone the repository - git clone https://github.com/siddhantgoel/streaming-form-data
  3. Install the packages required for development - pip install -r requirements.dev.txt
  4. Install this package - pip install ..
  5. You should now be able to run the test suite - py.test tests/.

Project details


Release history Release notifications

This version
History Node

0.5.0

History Node

0.4.5

History Node

0.4.4

History Node

0.4.3

History Node

0.4.2

History Node

0.4.1

History Node

0.4.0

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
streaming_form_data-0.5.0.tar.gz (51.2 kB) Copy SHA256 hash SHA256 Source None May 21, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page