Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automated Spec Update #418

Merged
merged 1 commit into from
Mar 3, 2022
Merged

Automated Spec Update #418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 67 additions & 53 deletions dropbox/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -848,31 +848,41 @@ def files_alpha_upload(self,
client_modified=None,
mute=False,
property_groups=None,
strict_conflict=False):
strict_conflict=False,
content_hash=None):
"""
Create a new file with the contents provided in the request. Note that
this endpoint is part of the properties API alpha and is slightly
different from :meth:`files_upload`. Do not use this to upload a file
larger than 150 MB. Instead, create an upload session with
:meth:`files_upload_session_start`.
the behavior of this alpha endpoint is unstable and subject to change.
Do not use this to upload a file larger than 150 MB. Instead, create an
upload session with :meth:`files_upload_session_start`.

Route attributes:
scope: files.content.write

:param bytes f: Contents to upload.
:param Nullable[str] content_hash: A hash of the file content uploaded
in this call. If provided and the uploaded content does not match
this hash, an error will be returned. For more information see our
`Content hash
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
:rtype: :class:`dropbox.files.FileMetadata`
:raises: :class:`.exceptions.ApiError`

If this raises, ApiError will contain:
:class:`dropbox.files.UploadError`
"""
warnings.warn(
'alpha/upload is deprecated. Use alpha/upload.',
'alpha/upload is deprecated. Use upload.',
DeprecationWarning,
)
arg = files.CommitInfoWithProperties(path,
mode,
autorename,
client_modified,
mute,
property_groups,
strict_conflict)
arg = files.UploadArg(path,
mode,
autorename,
client_modified,
mute,
property_groups,
strict_conflict,
content_hash)
r = self.request(
files.alpha_upload,
'files',
Expand Down Expand Up @@ -3157,7 +3167,8 @@ def files_upload(self,
client_modified=None,
mute=False,
property_groups=None,
strict_conflict=False):
strict_conflict=False,
content_hash=None):
"""
Create a new file with the contents provided in the request. Do not use
this to upload a file larger than 150 MB. Instead, create an upload
Expand All @@ -3171,43 +3182,25 @@ def files_upload(self,
scope: files.content.write

:param bytes f: Contents to upload.
:param str path: Path in the user's Dropbox to save the file.
:param mode: Selects what to do if the file already exists.
:type mode: :class:`dropbox.files.WriteMode`
:param bool autorename: If there's a conflict, as determined by
``mode``, have the Dropbox server try to autorename the file to
avoid conflict.
:param Nullable[datetime] client_modified: The value to store as the
``client_modified`` timestamp. Dropbox automatically records the
time at which the file was written to the Dropbox servers. It can
also record an additional timestamp, provided by Dropbox desktop
clients, mobile clients, and API apps of when the file was actually
created or modified.
:param bool mute: Normally, users are made aware of any file
modifications in their Dropbox account via notifications in the
client software. If ``True``, this tells the clients that this
modification shouldn't result in a user notification.
:param Nullable[List[:class:`dropbox.files.PropertyGroup`]]
property_groups: List of custom properties to add to file.
:param bool strict_conflict: Be more strict about how each
:class:`dropbox.files.WriteMode` detects conflict. For example,
always return a conflict error when ``mode`` = ``WriteMode.update``
and the given "rev" doesn't match the existing file's "rev", even if
the existing file has been deleted. This also forces a conflict even
when the target path refers to a file with identical contents.
:param Nullable[str] content_hash: A hash of the file content uploaded
in this call. If provided and the uploaded content does not match
this hash, an error will be returned. For more information see our
`Content hash
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
:rtype: :class:`dropbox.files.FileMetadata`
:raises: :class:`.exceptions.ApiError`

If this raises, ApiError will contain:
:class:`dropbox.files.UploadError`
"""
arg = files.CommitInfo(path,
mode,
autorename,
client_modified,
mute,
property_groups,
strict_conflict)
arg = files.UploadArg(path,
mode,
autorename,
client_modified,
mute,
property_groups,
strict_conflict,
content_hash)
r = self.request(
files.upload,
'files',
Expand All @@ -3219,7 +3212,8 @@ def files_upload(self,
def files_upload_session_append_v2(self,
f,
cursor,
close=False):
close=False,
content_hash=None):
"""
Append more data to an upload session. When the parameter close is set,
this call will close the session. A single request should not upload
Expand All @@ -3240,14 +3234,20 @@ def files_upload_session_append_v2(self,
point you won't be able to call
:meth:`files_upload_session_append_v2` anymore with the current
session.
:param Nullable[str] content_hash: A hash of the file content uploaded
in this call. If provided and the uploaded content does not match
this hash, an error will be returned. For more information see our
`Content hash
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
:rtype: None
:raises: :class:`.exceptions.ApiError`

If this raises, ApiError will contain:
:class:`dropbox.files.UploadSessionLookupError`
:class:`dropbox.files.UploadSessionAppendError`
"""
arg = files.UploadSessionAppendArg(cursor,
close)
close,
content_hash)
r = self.request(
files.upload_session_append_v2,
'files',
Expand Down Expand Up @@ -3282,7 +3282,7 @@ def files_upload_session_append(self,
:raises: :class:`.exceptions.ApiError`

If this raises, ApiError will contain:
:class:`dropbox.files.UploadSessionLookupError`
:class:`dropbox.files.UploadSessionAppendError`
"""
warnings.warn(
'upload_session/append is deprecated. Use upload_session/append.',
Expand All @@ -3301,7 +3301,8 @@ def files_upload_session_append(self,
def files_upload_session_finish(self,
f,
cursor,
commit):
commit,
content_hash=None):
"""
Finish an upload session and save the uploaded data to the given file
path. A single request should not upload more than 150 MB. The maximum
Expand All @@ -3321,14 +3322,20 @@ def files_upload_session_finish(self,
:param commit: Contains the path and other optional modifiers for the
commit.
:type commit: :class:`dropbox.files.CommitInfo`
:param Nullable[str] content_hash: A hash of the file content uploaded
in this call. If provided and the uploaded content does not match
this hash, an error will be returned. For more information see our
`Content hash
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
:rtype: :class:`dropbox.files.FileMetadata`
:raises: :class:`.exceptions.ApiError`

If this raises, ApiError will contain:
:class:`dropbox.files.UploadSessionFinishError`
"""
arg = files.UploadSessionFinishArg(cursor,
commit)
commit,
content_hash)
r = self.request(
files.upload_session_finish,
'files',
Expand Down Expand Up @@ -3447,7 +3454,8 @@ def files_upload_session_finish_batch_check(self,
def files_upload_session_start(self,
f,
close=False,
session_type=None):
session_type=None,
content_hash=None):
"""
Upload sessions allow you to upload a single file in one or more
requests, for example where the size of the file is greater than 150 MB.
Expand Down Expand Up @@ -3495,14 +3503,20 @@ def files_upload_session_start(self,
:param Nullable[:class:`dropbox.files.UploadSessionType`] session_type:
Type of upload session you want to start. If not specified, default
is ``UploadSessionType.sequential``.
:param Nullable[str] content_hash: A hash of the file content uploaded
in this call. If provided and the uploaded content does not match
this hash, an error will be returned. For more information see our
`Content hash
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
:rtype: :class:`dropbox.files.UploadSessionStartResult`
:raises: :class:`.exceptions.ApiError`

If this raises, ApiError will contain:
:class:`dropbox.files.UploadSessionStartError`
"""
arg = files.UploadSessionStartArg(close,
session_type)
session_type,
content_hash)
r = self.request(
files.upload_session_start,
'files',
Expand Down
Loading