dropbox / dropbox/dropbox-sdk-python

Allow chunked uploads (and maybe even streaming uploads)

Open
#459 4 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
983
Forks
330
Avg merge
3m
Merged PRs (30d)
10

Description

**Why is this feature valuable to you? Does it solve a problem you're having?**
The requests library allows both streaming and chunked uploads (see https://requests.readthedocs.io/en/latest/user/advanced/#streaming-uploads and https://requests.readthedocs.io/en/latest/user/advanced/#chunk-encoded-requests). This has two benefits:

1. It is sufficient to only load small parts of a file into memory before upload.
2. It is possible to limit bandwidth usage by using a generator that provides chunks at a limited rate.

The Dropbox API of course already requires upload sessions (`files/upload_session_start`, `files/upload_session_append` and `files/upload_session_finish`) to upload files > 150 MB. However, this approach by itself does not replace chunked or streaming uploads because:

1. The request body should be ideally >= 4 MB to reduce the total number of API calls (both for efficiency and to not exhaust data transport API call limits).
2. Bandwidth control will be very coarse when performed on chunks of 4 MB compared for example 2 kB.
4. Memory usage will still be larger compared to 1 kB or 2 kB chunks, especially for parallel uploads.

**Describe the solution you'd like**
Requests supports streaming uploads by passing a file-like object as the request body and chunked uploads by passing a generator as the request body. However, the Python SDK explicitly prevents both by requiring the request body to be of type `bytes`:

https://github.com/dropbox/dropbox-sdk-python/blob/9895d705317583cedb9fc11e5aa1f17f6bea303a/dropbox/dropbox_client.py#L533-L539

It would be good to either completely drop this limitation, with appropriate warnings in the doc string, or at least allow chunked uploads (where requests handles retry / rewind logic) even when disallowing streaming uploads.

**Describe alternatives you've considered**
Not at present.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.