[Python-modules-commits] [python-dropbox] 02/08: New upstream version 8.5.1
Michael Fladischer
fladi at moszumanska.debian.org
Mon Jan 8 20:38:52 UTC 2018
This is an automated email from the git hooks/post-receive script.
fladi pushed a commit to branch debian/master
in repository python-dropbox.
commit aa22ee5c797aa17baab9dce6fb9821a26e0ba8e3
Author: Michael Fladischer <FladischerMichael at fladi.at>
Date: Mon Jan 8 18:55:08 2018 +0100
New upstream version 8.5.1
---
PKG-INFO | 4 +-
README.rst | 2 +-
dropbox.egg-info/PKG-INFO | 4 +-
dropbox/async.py | 2 +-
dropbox/auth.py | 2 +-
dropbox/base.py | 563 +-
dropbox/base_team.py | 216 +-
dropbox/common.py | 24 +-
dropbox/dropbox.py | 2 +-
dropbox/file_properties.py | 2 +-
dropbox/file_requests.py | 10 +-
dropbox/files.py | 272 +-
dropbox/paper.py | 4 +-
dropbox/sharing.py | 4 +-
dropbox/stone_base.py | 2 +-
dropbox/stone_serializers.py | 2 +-
dropbox/team.py | 4 +-
dropbox/team_common.py | 4 +-
dropbox/team_log.py | 46500 ++++++++++++++++++++++++++++-------------
dropbox/team_policies.py | 2 +-
dropbox/users.py | 4 +-
dropbox/users_common.py | 2 +-
22 files changed, 32575 insertions(+), 15056 deletions(-)
diff --git a/PKG-INFO b/PKG-INFO
index f606cab..87d162e 100644
--- a/PKG-INFO
+++ b/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: dropbox
-Version: 8.5.0
+Version: 8.5.1
Summary: Official Dropbox API Client
Home-page: http://www.dropbox.com/developers
Author: Dropbox
@@ -9,7 +9,7 @@ License: MIT License
Description: Dropbox for Python
==================
- .. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v8.5.0
+ .. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v8.5.1
:target: https://travis-ci.org/dropbox/dropbox-sdk-python
.. image:: https://readthedocs.org/projects/dropbox-sdk-python/badge/?version=stable
diff --git a/README.rst b/README.rst
index 7e98966..6295b08 100644
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,7 @@
Dropbox for Python
==================
-.. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v8.5.0
+.. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v8.5.1
:target: https://travis-ci.org/dropbox/dropbox-sdk-python
.. image:: https://readthedocs.org/projects/dropbox-sdk-python/badge/?version=stable
diff --git a/dropbox.egg-info/PKG-INFO b/dropbox.egg-info/PKG-INFO
index f606cab..87d162e 100644
--- a/dropbox.egg-info/PKG-INFO
+++ b/dropbox.egg-info/PKG-INFO
@@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: dropbox
-Version: 8.5.0
+Version: 8.5.1
Summary: Official Dropbox API Client
Home-page: http://www.dropbox.com/developers
Author: Dropbox
@@ -9,7 +9,7 @@ License: MIT License
Description: Dropbox for Python
==================
- .. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v8.5.0
+ .. image:: https://travis-ci.org/dropbox/dropbox-sdk-python.svg?branch=v8.5.1
:target: https://travis-ci.org/dropbox/dropbox-sdk-python
.. image:: https://readthedocs.org/projects/dropbox-sdk-python/badge/?version=stable
diff --git a/dropbox/async.py b/dropbox/async.py
index 8436beb..85fa127 100644
--- a/dropbox/async.py
+++ b/dropbox/async.py
@@ -6,7 +6,7 @@
try:
from . import stone_validators as bv
from . import stone_base as bb
-except (SystemError, ValueError):
+except (ImportError, SystemError, ValueError):
# Catch errors raised when importing a relative module when not in a package.
# This makes testing this file directly (outside of a package) easier.
import stone_validators as bv
diff --git a/dropbox/auth.py b/dropbox/auth.py
index e8200de..add52e6 100644
--- a/dropbox/auth.py
+++ b/dropbox/auth.py
@@ -6,7 +6,7 @@
try:
from . import stone_validators as bv
from . import stone_base as bb
-except (SystemError, ValueError):
+except (ImportError, SystemError, ValueError):
# Catch errors raised when importing a relative module when not in a package.
# This makes testing this file directly (outside of a package) easier.
import stone_validators as bv
diff --git a/dropbox/base.py b/dropbox/base.py
index 0ae3982..3310a4a 100644
--- a/dropbox/base.py
+++ b/dropbox/base.py
@@ -45,9 +45,9 @@ class DropboxBase(object):
:param str oauth1_token_secret: The token secret associated with the
supplied access token.
:rtype: :class:`dropbox.auth.TokenFromOAuth1Result`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.auth.TokenFromOAuth1Error`
"""
arg = auth.TokenFromOAuth1Arg(oauth1_token,
@@ -90,9 +90,9 @@ class DropboxBase(object):
:param list property_groups: The property groups which are to be added
to a Dropbox file.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.AddPropertiesError`
"""
arg = file_properties.AddPropertiesArg(path,
@@ -120,9 +120,9 @@ class DropboxBase(object):
:param list property_groups: The property groups "snapshot" updates to
force apply.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.InvalidPropertyGroupError`
"""
arg = file_properties.OverwritePropertyGroupArg(path,
@@ -151,9 +151,9 @@ class DropboxBase(object):
created by :meth:`file_properties_templates_add_for_user` or
:meth:`file_properties_templates_add_for_team`.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.RemovePropertiesError`
"""
arg = file_properties.RemovePropertiesArg(path,
@@ -177,9 +177,9 @@ class DropboxBase(object):
associated with these template IDs.
:type template_filter: :class:`dropbox.file_properties.TemplateFilter`
:rtype: :class:`dropbox.file_properties.PropertiesSearchResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.PropertiesSearchError`
"""
arg = file_properties.PropertiesSearchArg(queries,
@@ -203,9 +203,9 @@ class DropboxBase(object):
:meth:`file_properties_properties_search` or
:meth:`file_properties_properties_search_continue`.
:rtype: :class:`dropbox.file_properties.PropertiesSearchResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.PropertiesSearchContinueError`
"""
arg = file_properties.PropertiesSearchContinueArg(cursor)
@@ -233,9 +233,9 @@ class DropboxBase(object):
:param list update_property_groups: The property groups "delta" updates
to apply.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.UpdatePropertiesError`
"""
arg = file_properties.UpdatePropertiesArg(path,
@@ -258,9 +258,9 @@ class DropboxBase(object):
folder. Note: this endpoint will create team-owned templates.
:rtype: :class:`dropbox.file_properties.AddTemplateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.ModifyTemplateError`
"""
arg = file_properties.AddTemplateArg(name,
@@ -284,9 +284,9 @@ class DropboxBase(object):
endpoint can't be called on a team member or admin's behalf.
:rtype: :class:`dropbox.file_properties.AddTemplateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.ModifyTemplateError`
"""
arg = file_properties.AddTemplateArg(name,
@@ -309,9 +309,9 @@ class DropboxBase(object):
:meth:`file_properties_templates_add_for_user` or
:meth:`file_properties_templates_add_for_team`.
:rtype: :class:`dropbox.file_properties.GetTemplateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.TemplateError`
"""
arg = file_properties.GetTemplateArg(template_id)
@@ -333,9 +333,9 @@ class DropboxBase(object):
:meth:`file_properties_templates_add_for_user` or
:meth:`file_properties_templates_add_for_team`.
:rtype: :class:`dropbox.file_properties.GetTemplateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.TemplateError`
"""
arg = file_properties.GetTemplateArg(template_id)
@@ -353,9 +353,9 @@ class DropboxBase(object):
template use :meth:`file_properties_templates_get_for_team`.
:rtype: :class:`dropbox.file_properties.ListTemplateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.TemplateError`
"""
arg = None
@@ -374,9 +374,9 @@ class DropboxBase(object):
endpoint can't be called on a team member or admin's behalf.
:rtype: :class:`dropbox.file_properties.ListTemplateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.TemplateError`
"""
arg = None
@@ -400,9 +400,9 @@ class DropboxBase(object):
:meth:`file_properties_templates_add_for_user` or
:meth:`file_properties_templates_add_for_team`.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.TemplateError`
"""
arg = file_properties.RemoveTemplateArg(template_id)
@@ -426,9 +426,9 @@ class DropboxBase(object):
:meth:`file_properties_templates_add_for_user` or
:meth:`file_properties_templates_add_for_team`.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.TemplateError`
"""
arg = file_properties.RemoveTemplateArg(template_id)
@@ -461,9 +461,9 @@ class DropboxBase(object):
group template. There can be up to 32 properties in a single
template.
:rtype: :class:`dropbox.file_properties.UpdateTemplateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.ModifyTemplateError`
"""
arg = file_properties.UpdateTemplateArg(template_id,
@@ -500,9 +500,9 @@ class DropboxBase(object):
group template. There can be up to 32 properties in a single
template.
:rtype: :class:`dropbox.file_properties.UpdateTemplateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_properties.ModifyTemplateError`
"""
arg = file_properties.UpdateTemplateArg(template_id,
@@ -538,9 +538,9 @@ class DropboxBase(object):
file request is closed, it will not accept any file submissions, but
it can be opened later.
:rtype: :class:`dropbox.file_requests.FileRequest`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.file_requests.CreateFileRequestError`
"""
arg = file_requests.CreateFileRequestArgs(title,
@@ -642,9 +642,9 @@ class DropboxBase(object):
template IDs, ``FileMetadata.property_groups`` is set for files with
custom properties.
:rtype: :class:`dropbox.files.Metadata`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.AlphaGetMetadataError`
"""
warnings.warn(
@@ -682,10 +682,6 @@ class DropboxBase(object):
:param bytes f: Contents to upload.
:rtype: :class:`dropbox.files.FileMetadata`
- :raises: :class:`dropbox.exceptions.ApiError`
-
- If this raises, ApiError.reason is of type:
- :class:`dropbox.files.UploadErrorWithProperties`
"""
warnings.warn(
'alpha/upload is deprecated. Use alpha/upload.',
@@ -726,9 +722,9 @@ class DropboxBase(object):
would result in an ownership transfer for the content being moved.
This does not apply to copies.
:rtype: :class:`dropbox.files.Metadata`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.RelocationError`
"""
warnings.warn(
@@ -798,9 +794,9 @@ class DropboxBase(object):
:param str async_job_id: Id of the asynchronous job. This is the value
of a response returned from the method that launched the job.
:rtype: :class:`dropbox.files.RelocationBatchJobStatus`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.PollError`
"""
arg = async.PollArg(async_job_id)
@@ -822,9 +818,9 @@ class DropboxBase(object):
:param str path: The path to the file or folder you want to get a copy
reference to.
:rtype: :class:`dropbox.files.GetCopyReferenceResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.GetCopyReferenceError`
"""
arg = files.GetCopyReferenceArg(path)
@@ -847,9 +843,9 @@ class DropboxBase(object):
:meth:`files_copy_reference_get`.
:param str path: Path in the user's Dropbox that is the destination.
:rtype: :class:`dropbox.files.SaveCopyReferenceResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.SaveCopyReferenceError`
"""
arg = files.SaveCopyReferenceArg(copy_reference,
@@ -883,9 +879,9 @@ class DropboxBase(object):
would result in an ownership transfer for the content being moved.
This does not apply to copies.
:rtype: :class:`dropbox.files.RelocationResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.RelocationError`
"""
arg = files.RelocationArg(from_path,
@@ -911,9 +907,9 @@ class DropboxBase(object):
:param bool autorename: If there's a conflict, have the Dropbox server
try to autorename the folder to avoid the conflict.
:rtype: :class:`dropbox.files.FolderMetadata`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.CreateFolderError`
"""
warnings.warn(
@@ -940,9 +936,9 @@ class DropboxBase(object):
:param bool autorename: If there's a conflict, have the Dropbox server
try to autorename the folder to avoid the conflict.
:rtype: :class:`dropbox.files.CreateFolderResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.CreateFolderError`
"""
arg = files.CreateFolderArg(path,
@@ -967,9 +963,9 @@ class DropboxBase(object):
:param str path: Path in the user's Dropbox to delete.
:rtype: :class:`dropbox.files.Metadata`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.DeleteError`
"""
warnings.warn(
@@ -1014,9 +1010,9 @@ class DropboxBase(object):
:param str async_job_id: Id of the asynchronous job. This is the value
of a response returned from the method that launched the job.
:rtype: :class:`dropbox.files.DeleteBatchJobStatus`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.PollError`
"""
arg = async.PollArg(async_job_id)
@@ -1040,9 +1036,9 @@ class DropboxBase(object):
:param str path: Path in the user's Dropbox to delete.
:rtype: :class:`dropbox.files.DeleteResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.DeleteError`
"""
arg = files.DeleteArg(path)
@@ -1064,9 +1060,9 @@ class DropboxBase(object):
:param Nullable rev: Please specify revision in ``path`` instead.
:rtype: (:class:`dropbox.files.FileMetadata`,
:class:`requests.models.Response`)
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.DownloadError`
If you do not consume the entire response body, then you must call close
@@ -1095,11 +1091,10 @@ class DropboxBase(object):
:param str download_path: Path on local machine to save file.
:param str path: The path of the file to download.
:param Nullable rev: Please specify revision in ``path`` instead.
- :rtype: (:class:`dropbox.files.FileMetadata`,
- :class:`requests.models.Response`)
- :raises: :class:`dropbox.exceptions.ApiError`
+ :rtype: :class:`dropbox.files.FileMetadata`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.DownloadError`
"""
arg = files.DownloadArg(path,
@@ -1113,6 +1108,62 @@ class DropboxBase(object):
self._save_body_to_file(download_path, r[1])
return r[0]
+ def files_download_zip(self,
+ path):
+ """
+ Download a folder from the user's Dropbox, as a zip file. The folder
+ must be less than 1 GB in size and have fewer than 10,000 total files.
+ The input cannot be a single file.
+
+ :param str path: The path of the folder to download.
+ :rtype: (:class:`dropbox.files.DownloadZipResult`,
+ :class:`requests.models.Response`)
+ :raises: :class:`.exceptions.ApiError`
+
+ If this raises, ApiError will contain:
+ :class:`dropbox.files.DownloadZipError`
+
+ If you do not consume the entire response body, then you must call close
+ on the response object, otherwise you will max out your available
+ connections. We recommend using the `contextlib.closing
+ <https://docs.python.org/2/library/contextlib.html#contextlib.closing>`_
+ context manager to ensure this.
+ """
+ arg = files.DownloadZipArg(path)
+ r = self.request(
+ files.download_zip,
+ 'files',
+ arg,
+ None,
+ )
+ return r
+
+ def files_download_zip_to_file(self,
+ download_path,
+ path):
+ """
+ Download a folder from the user's Dropbox, as a zip file. The folder
+ must be less than 1 GB in size and have fewer than 10,000 total files.
+ The input cannot be a single file.
+
+ :param str download_path: Path on local machine to save file.
+ :param str path: The path of the folder to download.
+ :rtype: :class:`dropbox.files.DownloadZipResult`
+ :raises: :class:`.exceptions.ApiError`
+
+ If this raises, ApiError will contain:
+ :class:`dropbox.files.DownloadZipError`
+ """
+ arg = files.DownloadZipArg(path)
+ r = self.request(
+ files.download_zip,
+ 'files',
+ arg,
+ None,
+ )
+ self._save_body_to_file(download_path, r[1])
+ return r[0]
+
def files_get_metadata(self,
path,
include_media_info=False,
@@ -1138,9 +1189,9 @@ class DropboxBase(object):
exists property data associated with the file and each of the listed
templates.
:rtype: :class:`dropbox.files.Metadata`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.GetMetadataError`
"""
arg = files.GetMetadataArg(path,
@@ -1170,9 +1221,9 @@ class DropboxBase(object):
:param Nullable rev: Please specify revision in ``path`` instead.
:rtype: (:class:`dropbox.files.FileMetadata`,
:class:`requests.models.Response`)
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.PreviewError`
If you do not consume the entire response body, then you must call close
@@ -1205,11 +1256,10 @@ class DropboxBase(object):
:param str download_path: Path on local machine to save file.
:param str path: The path of the file to preview.
:param Nullable rev: Please specify revision in ``path`` instead.
- :rtype: (:class:`dropbox.files.FileMetadata`,
- :class:`requests.models.Response`)
- :raises: :class:`dropbox.exceptions.ApiError`
+ :rtype: :class:`dropbox.files.FileMetadata`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.PreviewError`
"""
arg = files.PreviewArg(path,
@@ -1232,9 +1282,9 @@ class DropboxBase(object):
:param str path: The path to the file you want a temporary link to.
:rtype: :class:`dropbox.files.GetTemporaryLinkResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.GetTemporaryLinkError`
"""
arg = files.GetTemporaryLinkArg(path)
@@ -1265,9 +1315,9 @@ class DropboxBase(object):
:type size: :class:`dropbox.files.ThumbnailSize`
:rtype: (:class:`dropbox.files.FileMetadata`,
:class:`requests.models.Response`)
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.ThumbnailError`
If you do not consume the entire response body, then you must call close
@@ -1306,11 +1356,10 @@ class DropboxBase(object):
:type format: :class:`dropbox.files.ThumbnailFormat`
:param size: The size for the thumbnail image.
:type size: :class:`dropbox.files.ThumbnailSize`
- :rtype: (:class:`dropbox.files.FileMetadata`,
- :class:`requests.models.Response`)
- :raises: :class:`dropbox.exceptions.ApiError`
+ :rtype: :class:`dropbox.files.FileMetadata`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.ThumbnailError`
"""
arg = files.ThumbnailArg(path,
@@ -1335,9 +1384,9 @@ class DropboxBase(object):
:param list entries: List of files to get thumbnails.
:rtype: :class:`dropbox.files.GetThumbnailBatchResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.GetThumbnailBatchError`
"""
arg = files.GetThumbnailBatchArg(entries)
@@ -1412,9 +1461,9 @@ class DropboxBase(object):
exists property data associated with the file and each of the listed
templates.
:rtype: :class:`dropbox.files.ListFolderResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.ListFolderError`
"""
arg = files.ListFolderArg(path,
@@ -1444,9 +1493,9 @@ class DropboxBase(object):
:param str cursor: The cursor returned by your last call to
:meth:`files_list_folder` or :meth:`files_list_folder_continue`.
:rtype: :class:`dropbox.files.ListFolderResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.ListFolderContinueError`
"""
arg = files.ListFolderContinueArg(cursor)
@@ -1502,9 +1551,9 @@ class DropboxBase(object):
exists property data associated with the file and each of the listed
templates.
:rtype: :class:`dropbox.files.ListFolderGetLatestCursorResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.ListFolderError`
"""
arg = files.ListFolderArg(path,
@@ -1545,9 +1594,9 @@ class DropboxBase(object):
when using this parameter, as some network infrastructure does not
support long timeouts.
:rtype: :class:`dropbox.files.ListFolderLongpollResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.ListFolderLongpollError`
"""
arg = files.ListFolderLongpollArg(cursor,
@@ -1581,9 +1630,9 @@ class DropboxBase(object):
:type mode: :class:`dropbox.files.ListRevisionsMode`
:param long limit: The maximum number of revision entries returned.
:rtype: :class:`dropbox.files.ListRevisionsResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.ListRevisionsError`
"""
arg = files.ListRevisionsArg(path,
@@ -1618,9 +1667,9 @@ class DropboxBase(object):
would result in an ownership transfer for the content being moved.
This does not apply to copies.
:rtype: :class:`dropbox.files.Metadata`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.RelocationError`
"""
warnings.warn(
@@ -1687,9 +1736,9 @@ class DropboxBase(object):
:param str async_job_id: Id of the asynchronous job. This is the value
of a response returned from the method that launched the job.
:rtype: :class:`dropbox.files.RelocationBatchJobStatus`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.PollError`
"""
arg = async.PollArg(async_job_id)
@@ -1722,9 +1771,9 @@ class DropboxBase(object):
would result in an ownership transfer for the content being moved.
This does not apply to copies.
:rtype: :class:`dropbox.files.RelocationResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.RelocationError`
"""
arg = files.RelocationArg(from_path,
@@ -1749,9 +1798,9 @@ class DropboxBase(object):
:param str path: Path in the user's Dropbox to delete.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.DeleteError`
"""
arg = files.DeleteArg(path)
@@ -1771,9 +1820,9 @@ class DropboxBase(object):
:param list property_groups: The property groups which are to be added
to a Dropbox file.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.AddPropertiesError`
"""
warnings.warn(
@@ -1798,9 +1847,9 @@ class DropboxBase(object):
:param list property_groups: The property groups "snapshot" updates to
force apply.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.InvalidPropertyGroupError`
"""
warnings.warn(
@@ -1826,9 +1875,9 @@ class DropboxBase(object):
created by :meth:`files_templates_add_for_user` or
:meth:`files_templates_add_for_team`.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.RemovePropertiesError`
"""
warnings.warn(
@@ -1852,9 +1901,9 @@ class DropboxBase(object):
:meth:`files_templates_add_for_user` or
:meth:`files_templates_add_for_team`.
:rtype: :class:`dropbox.files.GetTemplateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.TemplateError`
"""
warnings.warn(
@@ -1892,9 +1941,9 @@ class DropboxBase(object):
:param list update_property_groups: The property groups "delta" updates
to apply.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.UpdatePropertiesError`
"""
warnings.warn(
@@ -1920,9 +1969,9 @@ class DropboxBase(object):
:param str path: The path to the file you want to restore.
:param str rev: The revision to restore for the file.
:rtype: :class:`dropbox.files.FileMetadata`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.RestoreError`
"""
arg = files.RestoreArg(path,
@@ -1946,9 +1995,9 @@ class DropboxBase(object):
:param str path: The path in Dropbox where the URL will be saved to.
:param str url: The URL to be saved.
:rtype: :class:`dropbox.files.SaveUrlResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.SaveUrlError`
"""
arg = files.SaveUrlArg(path,
@@ -1969,9 +2018,9 @@ class DropboxBase(object):
:param str async_job_id: Id of the asynchronous job. This is the value
of a response returned from the method that launched the job.
:rtype: :class:`dropbox.files.SaveUrlJobStatus`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.PollError`
"""
arg = async.PollArg(async_job_id)
@@ -2007,9 +2056,9 @@ class DropboxBase(object):
available for Dropbox Business accounts.
:type mode: :class:`dropbox.files.SearchMode`
:rtype: :class:`dropbox.files.SearchResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.SearchError`
"""
arg = files.SearchArg(path,
@@ -2058,9 +2107,9 @@ class DropboxBase(object):
:param Nullable property_groups: List of custom properties to add to
file.
:rtype: :class:`dropbox.files.FileMetadata`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.UploadError`
"""
arg = files.CommitInfo(path,
@@ -2092,9 +2141,9 @@ class DropboxBase(object):
use this to make sure upload data isn't lost or duplicated in the
event of a network error.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.UploadSessionLookupError`
"""
warnings.warn(
@@ -2128,9 +2177,9 @@ class DropboxBase(object):
:meth:`files_upload_session_append_v2` anymore with the current
session.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.UploadSessionLookupError`
"""
arg = files.UploadSessionAppendArg(cursor,
@@ -2158,9 +2207,9 @@ class DropboxBase(object):
commit.
:type commit: :class:`dropbox.files.CommitInfo`
:rtype: :class:`dropbox.files.FileMetadata`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.UploadSessionFinishError`
"""
arg = files.UploadSessionFinishArg(cursor,
@@ -2214,9 +2263,9 @@ class DropboxBase(object):
:param str async_job_id: Id of the asynchronous job. This is the value
of a response returned from the method that launched the job.
:rtype: :class:`dropbox.files.UploadSessionFinishBatchJobStatus`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.files.PollError`
"""
arg = async.PollArg(async_job_id)
@@ -2271,9 +2320,9 @@ class DropboxBase(object):
:param str doc_id: The Paper doc ID.
:rtype: None
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.paper.DocLookupError`
"""
arg = paper.RefPaperDoc(doc_id)
@@ -2299,9 +2348,9 @@ class DropboxBase(object):
:param import_format: The format of provided data.
:type import_format: :class:`dropbox.paper.ImportFormat`
:rtype: :class:`dropbox.paper.PaperDocCreateUpdateResult`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.paper.PaperDocCreateError`
"""
arg = paper.PaperDocCreateArgs(import_format,
@@ -2323,9 +2372,9 @@ class DropboxBase(object):
:type export_format: :class:`dropbox.paper.ExportFormat`
:rtype: (:class:`dropbox.paper.PaperDocExportResult`,
:class:`requests.models.Response`)
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.paper.DocLookupError`
If you do not consume the entire response body, then you must call close
@@ -2353,11 +2402,10 @@ class DropboxBase(object):
:param str download_path: Path on local machine to save file.
:type export_format: :class:`dropbox.paper.ExportFormat`
- :rtype: (:class:`dropbox.paper.PaperDocExportResult`,
- :class:`requests.models.Response`)
- :raises: :class:`dropbox.exceptions.ApiError`
+ :rtype: :class:`dropbox.paper.PaperDocExportResult`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.paper.DocLookupError`
"""
arg = paper.PaperDocExport(doc_id,
@@ -2384,9 +2432,9 @@ class DropboxBase(object):
can be retrieved per batch is 1000. Higher value results in invalid
arguments error.
:rtype: :class:`dropbox.paper.ListUsersOnFolderResponse`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
- If this raises, ApiError.reason is of type:
+ If this raises, ApiError will contain:
:class:`dropbox.paper.DocLookupError`
"""
arg = paper.ListUsersOnFolderArgs(doc_id,
@@ -2412,9 +2460,9 @@ class DropboxBase(object):
:meth:`paper_docs_folder_users_list_continue`. Allows for
pagination.
:rtype: :class:`dropbox.paper.ListUsersOnFolderResponse`
- :raises: :class:`dropbox.exceptions.ApiError`
+ :raises: :class:`.exceptions.ApiError`
... 59398 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-dropbox.git
More information about the Python-modules-commits
mailing list