def thumbnail(self, from_path, size="large", format="JPEG"):
"""Download a thumbnail for an image.
Unlike most other calls, thumbnail returns a raw HTTPResponse with the connection open.
You should call .read() and perform any processing you need, then close the HTTPResponse.
Args:
from_path: The path to the file to be thumbnailed.
size: A string describing the desired thumbnail size.
At this time, 'small', 'medium', and 'large' are
officially supported sizes (32x32, 64x64, and 128x128
respectively), though others may be available. Check
https://www.dropbox.com/developers/reference/api#thumbnails for
more details.
Returns:
An httplib.HTTPResponse that is the result of the request.
Raises:
A dropbox.rest.ErrorResponse with an HTTP status of
- 400: Bad request (may be due to many things; check e.error for details)
- 404: No file was found at the given from_path, or files of that type cannot be thumbnailed.
- 415: Image is invalid and cannot be thumbnailed.
"""
assert format in ["JPEG", "PNG"], "expected a thumbnail format of 'JPEG' or 'PNG', got %s" % format
path = "/thumbnails/%s%s" % (self.session.root, format_path(from_path))
url, params, headers = self.request(path, {"size": size, "format": format}, method="GET", content_server=True)
return RESTClient.request("GET", url, headers=headers, raw_response=True)
def get_file(self, from_path, rev=None):
"""Download a file.
Unlike most other calls, get_file returns a raw HTTPResponse with the connection open.
You should call .read() and perform any processing you need, then close the HTTPResponse.
Args:
from_path: The path to the file to be downloaded.
rev: A previous rev value of the file to be downloaded. [optional]
Returns:
An httplib.HTTPResponse that is the result of the request.
Raises:
A dropbox.rest.ErrorResponse with an HTTP status of
400: Bad request (may be due to many things; check e.error for details)
404: No file was found at the given path, or the file that was there was deleted.
200: Request was okay but response was malformed in some way.
"""
path = "/files/%s%s" % (self.session.root, format_path(from_path))
params = {}
if rev is not None:
params["rev"] = rev
url, params, headers = self.request(path, params, method="GET", content_server=True)
return RESTClient.request("GET", url, headers=headers, raw_response=True)
def get_file(self, from_path, rev=None):
"""Download a file.
Unlike most other calls, get_file returns a raw HTTPResponse with the connection open.
You should call .read() and perform any processing you need, then close the HTTPResponse.
Args:
from_path: The path to the file to be downloaded.
rev: A previous rev value of the file to be downloaded. [optional]
Returns:
An httplib.HTTPResponse that is the result of the request.
Raises:
A dropbox.rest.ErrorResponse with an HTTP status of
400: Bad request (may be due to many things; check e.error for details)
404: No file was found at the given path, or the file that was there was deleted.
200: Request was okay but response was malformed in some way.
"""
path = "/files/%s%s" % (self.session.root, format_path(from_path))
params = {}
if rev is not None:
params['rev'] = rev
url, params, headers = self.request(path,
params,
method='GET',
content_server=True)
return RESTClient.request("GET",
url,
headers=headers,
raw_response=True)
def thumbnail(self, from_path, size='large', format='JPEG'):
"""Download a thumbnail for an image.
Unlike most other calls, thumbnail returns a raw HTTPResponse with the connection open.
You should call .read() and perform any processing you need, then close the HTTPResponse.
Args:
from_path: The path to the file to be thumbnailed.
size: A string describing the desired thumbnail size.
At this time, 'small', 'medium', and 'large' are
officially supported sizes (32x32, 64x64, and 128x128
respectively), though others may be available. Check
https://www.dropbox.com/developers/reference/api#thumbnails for
more details.
Returns:
An httplib.HTTPResponse that is the result of the request.
Raises:
A dropbox.rest.ErrorResponse with an HTTP status of
- 400: Bad request (may be due to many things; check e.error for details)
- 404: No file was found at the given from_path, or files of that type cannot be thumbnailed.
- 415: Image is invalid and cannot be thumbnailed.
"""
assert format in [
'JPEG', 'PNG'
], "expected a thumbnail format of 'JPEG' or 'PNG', got %s" % format
path = "/thumbnails/%s%s" % (self.session.root, format_path(from_path))
url, params, headers = self.request(path, {
'size': size,
'format': format
},
method='GET',
content_server=True)
return RESTClient.request("GET",
url,
headers=headers,
raw_response=True)
