The Official Dropbox API V2 SDK for Python

Hi, I'm receiving an InternalServerError everytime I call files_move or files_copy. I'm currently working around the issue from downloading and re-uploading each file instead. Here is my traceback

File "C:\Python27\lib\custom\dropbox_backup.py", line 69, in move_sequential_files self.dropbox.rename(file_path, this_path) File "C:\Python27\lib\custom\dropbox\dropbox_wrapper.py", line 113, in rename self.client.files_move(old_path, new_path) File "C:\Python27\lib\site-packages\dropbox\base.py", line 544, in files_move None) File "C:\Python27\lib\site-packages\dropbox\dropbox.py", line 175, in request request_binary) File "C:\Python27\lib\site-packages\dropbox\dropbox.py", line 256, in request_json_string_with_retry request_binary) File "C:\Python27\lib\site-packages\dropbox\dropbox.py", line 320, in request_json_string raise InternalServerError(r.status_code, r.text) InternalServerError

This change adds ca_certs str argument for oauth and dropbox client classes. It may be used with applications that packed into executable archives (like python par or py2exe). It also may be useful with some security related scenarios.

Checklist

General Contributing

• [x] Have you read the Code of Conduct and signed the CLA?

Is This a Code Change?

• [x] Non-code related change (markdown/git settings etc)
• [x] SDK Code Change
• [x] Example/Test Code Change

Validation

• [x] Does tox pass?
• [x] Do the tests pass? (no integration tests)

Hello,

I'm use dbx.files_upload_session_append_v2 to upload large file But the speed is very unstable. I used 30MB as CHUNK_SIZE. My server has a 1Gbps internet and very idle. so I suspect it is sometimes connected to a bad dropbox server node or a very high load dropbox server node.

I checked the sdk source code and wanted to find out the server address of each connection to it into dbx.files_upload_session_append_v2. No solution found at this time

uploading: 1 of media/m002.mp4
uploaded: 31457280 of media/m002.mp4 used time 6.745985269546509
uploading: 31457280 of media/m002.mp4
uploaded: 62914560 of media/m002.mp4 used time 3.0077970027923584
uploading: 62914560 of media/m002.mp4
uploaded: 94371840 of media/m002.mp4 used time 2.6795079708099365
uploading: 94371840 of media/m002.mp4
uploaded: 125829120 of media/m002.mp4 used time 2.5502266883850098
uploading: 125829120 of media/m002.mp4
uploaded: 157286400 of media/m002.mp4 used time 30.76577353477478
uploading: 157286400 of media/m002.mp4
uploaded: 188743680 of media/m002.mp4 used time 4.496345520019531
uploading: 188743680 of media/m002.mp4
uploaded: 220200960 of media/m002.mp4 used time 2.933668375015259
uploading: 220200960 of media/m002.mp4
uploaded: 251658240 of media/m002.mp4 used time 2.999969959259033
uploading: 251658240 of media/m002.mp4
uploaded: 283115520 of media/m002.mp4 used time 39.48408651351929
uploading: 283115520 of media/m002.mp4
uploaded: 314572800 of media/m002.mp4 used time 6.2456958293914795
uploading: 314572800 of media/m002.mp4
uploaded: 346030080 of media/m002.mp4 used time 3.3357770442962646
uploading: 346030080 of media/m002.mp4
uploaded: 377487360 of media/m002.mp4 used time 2.5063118934631348
uploading: 377487360 of media/m002.mp4

If the host machine that the Dropbox client SDK is running on misses a FIN packet while it's waiting for a response from the server it will hang forever by default. This can happen if an intermediate router transiently goes down, or if the host is suspended via ACPI power management. This problem is common and widespread and documented here:

https://en.wikipedia.org/wiki/TCP_half-open#RFC_793

A thorough description of the problem can be found here:

http://blog.stephencleary.com/2009/05/detection-of-half-open-dropped.html

This change makes all HTTP API requests instead use a default timeout of 30 seconds instead of unconditionally blocking forever. It adds a special case for files_list_folder_longpoll which may have a user-defined timeout.

I've just installed version 7.1.1 from pip. When my script tries to import dropbox I end up with the following error:

Traceback (most recent call last):
  File "dropbox_backup.py", line 4, in <module>
    import dropbox
  File "/home/ianwscott/lib/python2.7/dropbox/__init__.py", line 3, in <module>
    from .dropbox import __version__, Dropbox, DropboxTeam, create_session
  File "/home/ianwscott/lib/python2.7/dropbox/dropbox.py", line 34, in <module>
    from .session import pinned_session
  File "/home/ianwscott/lib/python2.7/dropbox/session.py", line 44, in <module>
    from . import rest
  File "/home/ianwscott/lib/python2.7/dropbox/rest.py", line 29, in <module>
    if six.PY3:
AttributeError: 'module' object has no attribute 'PY3'

I tried upgrading the six module, but I'm being told that the module is already up-to-date (version 1.10.0). So why is dropbox raising the error?

I'm working on a server running CentOS 6.8. I don't have root access, since it's a shared server, which is why I'm installing the modules locally.

As I can see in dropbox/dropbox.py, line 393 and so on, you always decode the resp using utf-8 which I don't think it works properly in case the user has a non-utf8 file name.

Should we use chardet to decode the resp to reduce error?

After issue #31 was solved, I get the following error when running the example-code from the docs with version 3.42:

Traceback (most recent call last):
  File "test.py", line 15, in <module>
    access_token, user_id = auth_flow.finish(auth_code)
  File "/usr/local/lib/python2.7/dist-packages/dropbox/oauth.py", line 178, in finish
    return self._finish(code, None)
  File "/usr/local/lib/python2.7/dist-packages/dropbox/oauth.py", line 60, in _finish
    resp.raise_for_status()
  File "/usr/local/lib/python2.7/dist-packages/requests/models.py", line 837, in raise_for_status
    raise HTTPError(http_error_msg, response=self)
HTTPError: 400 Client Error: Bad Request for url: https://www.dropbox.com/1/oauth2/token

$ git clone git://github.com/dropbox/dropbox-sdk-python.git
$ cd dropbox-sdk-python
$ python setup.py install
>>> import dropbox
>>> dbx = dropbox.Dropbox("YOUR_ACCESS_TOKEN")
>>> dbx.users_get_current_account()
Traceback (most recent call last):
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/urllib3-1.21.1-py3.6.egg/urllib3/util/timeout.py", line 124, in _validate_timeout
    float(value)
TypeError: float() argument must be a string or a number, not 'Timeout'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/debian8/dropbox-sdk-python/dropbox/base.py", line 3277, in users_get_current_account
    None,
  File "/home/debian8/dropbox-sdk-python/dropbox/dropbox.py", line 234, in request
    timeout=timeout)
  File "/home/debian8/dropbox-sdk-python/dropbox/dropbox.py", line 325, in request_json_string_with_retry
    timeout=timeout)
  File "/home/debian8/dropbox-sdk-python/dropbox/dropbox.py", line 409, in request_json_string
    timeout=timeout,
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/requests/sessions.py", line 565, in post
    return self.request('POST', url, data=data, json=json, **kwargs)
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/requests/sessions.py", line 518, in request
    resp = self.send(prep, **send_kwargs)
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/requests/sessions.py", line 639, in send
    r = adapter.send(request, **kwargs)
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/requests/adapters.py", line 438, in send
    timeout=timeout
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/urllib3-1.21.1-py3.6.egg/urllib3/connectionpool.py", line 587, in urlopen
    timeout_obj = self._get_timeout(timeout)
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/urllib3-1.21.1-py3.6.egg/urllib3/connectionpool.py", line 302, in _get_timeout
    return Timeout.from_float(timeout)
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/urllib3-1.21.1-py3.6.egg/urllib3/util/timeout.py", line 154, in from_float
    return Timeout(read=timeout, connect=timeout)
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/urllib3-1.21.1-py3.6.egg/urllib3/util/timeout.py", line 94, in __init__
    self._connect = self._validate_timeout(connect, 'connect')
  File "/home/debian8/anaconda3/lib/python3.6/site-packages/urllib3-1.21.1-py3.6.egg/urllib3/util/timeout.py", line 127, in _validate_timeout
    "int, float or None." % (name, value))
ValueError: Timeout value connect was Timeout(connect=30, read=30, total=None), but it must be an int, float or None.

Sorry to raise this issue, but I've given them a good try, and still can't make sense of them. I've checked out your examples, and I've read your documentation: http://dropbox-sdk-python.readthedocs.org/en/master/moduledoc.html#dropbox.files.ListFolderError

I think you need a lot more examples of usual errors that might crop up whilst using your API.

Since I'm here anyway, can anyone point me in the right direction on how to handle the following scenario: I want to check if a folder exists, and if it is not found, I want to create that folder.

Other than that, its pretty good stuff!

I am using the team_log_get_events and team_log_get_events_continue APIs to retrieve user activity for a Dropbox account. I seem to be able to retrieve most events fine, but I get a validation error from the library for login success events and receive this error:

dropbox.stone_validators.ValidationError: events.details.password_login_success_details: missing required field 'is_emm_managed'

From http://dropbox-sdk-python.readthedocs.io/en/latest/moduledoc.html#dropbox.team_log.DeviceLogInfo.is_emm_managed, it seems as if this field is normally expected, but could be missing.

Perhaps this validation constraint needs to be relaxed?

The following sample code:

#!/usr/bin/python
import dropbox, os
dbx = dropbox.Dropbox(os.environ['DROPBOX_TOKEN'])
root = dbx.files_list_folder('')
print dbx.files_list_folder_longpoll(root.cursor, timeout=30)

returns:

Traceback (most recent call last):
  File "longpoll_test.py", line 7, in <module>
    print dbx.files_list_folder_longpoll(root.cursor, timeout=30)
  File "/home/rrerolle/Workspace/Code/rembox/venv/local/lib/python2.7/site-packages/dropbox/base.py", line 89, in files_list_folder_longpoll
    None)
  File "/home/rrerolle/Workspace/Code/rembox/venv/local/lib/python2.7/site-packages/dropbox/dropbox.py", line 175, in request
    request_binary)
  File "/home/rrerolle/Workspace/Code/rembox/venv/local/lib/python2.7/site-packages/dropbox/dropbox.py", line 256, in request_json_string_with_retry
    request_binary)
  File "/home/rrerolle/Workspace/Code/rembox/venv/local/lib/python2.7/site-packages/dropbox/dropbox.py", line 337, in request_json_string
    r.headers.get('content-type'))
AssertionError: Expected content-type to be application/json, got 'text/plain'

It appears the request succeeds, but returns a "text/plain" content-type, while the dropbox v2 client explicitly expects "application/json", as demonstrated in https://github.com/dropbox/dropbox-sdk-python/blob/002e6df32a6c9446554f6f53b2510d284adc9943/dropbox/dropbox.py#L335-L337

This is probably an overlook in the v2 API server itself so I'm not sure there is anything to do client wise. Still, for now, using it requires either catching the AssertionError, or running python with -O to disable the asserts.

Bumps actions/setup-python from 2.2.2 to 4.4.0.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

As mentioned in https://github.com/pypa/pip-audit/issues/445#issuecomment-1363101453:

PEP 440 doesn't say it directly, but the language implies that the .* is only valid on exact comparison operators (e.g. == and !=), nor ordered comparisons (e.g. >=).

In particular, a comparison like >=3.5.* is redundant: it has the exact same meaning as >=3.5.

This is causing pip-audit to fail, like so: https://github.com/frappe/frappe/actions/runs/3811860090/jobs/6484759800#step:4:183

Checklist

General Contributing

• [x] Have you read the Code of Conduct and signed the CLA?

Is This a Code Change?

• [x] Non-code related change (markdown/git settings etc)
• [ ] SDK Code Change
• [ ] Example/Test Code Change

Validation

• [x] Does tox pass?
• [x] Do the tests pass?

Bumps peter-evans/create-pull-request from 3.8.2 to 4.2.3.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

adding param explanations for files_upload

Checklist

General Contributing

• [x] Have you read the Code of Conduct and signed the CLA?

Is This a Code Change?

• [x] Non-code related change (markdown/git settings etc)
• [ ] SDK Code Change
• [ ] Example/Test Code Change

Validation

• [x] Does tox pass?
• [x] Do the tests pass?

Bumps codecov/codecov-action from 1.3.2 to 3.1.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Looks like dropbox is one of the only handfull modules whch still is using six

[tkloczko@devel-g2v dropbox-sdk-python-11.30.0]$ grep -rw six
dropbox/dropbox_client.py:import six
dropbox/dropbox_client.py:        assert isinstance(obj_result, six.string_types), \
dropbox/dropbox_client.py:        if not isinstance(request_binary, (six.binary_type, type(None))):
dropbox/oauth.py:import six
dropbox/oauth.py:if six.PY3:
dropbox/oauth.py:        if six.PY2 and isinstance(target, six.text_type):
dropbox/oauth.py:        if isinstance(o, six.binary_type):
dropbox/oauth.py:            if isinstance(o, six.text_type):
dropbox/oauth.py:    utf8_params = {encode(k): encode(v) for k, v in six.iteritems(params)}
example/updown.py:import six
example/updown.py:            if not isinstance(name, six.text_type):
requirements.txt:six >= 1.12.0
setup.py:    'six >= 1.12.0',

It would be good to rewrite thise parts to drop use six 😃