def retrieve(sha1, **kwargs):
"""
Retrieve the most up-to-date copy of the plot-schema wrt the given hash.
:param (str) sha1: The last-known hash of the plot-schema (or '').
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE)
params = make_params(sha1=sha1)
return request("get", url, params=params, **kwargs)
def retrieve(sha1, **kwargs):
"""
Retrieve the most up-to-date copy of the plot-schema wrt the given hash.
:param (str) sha1: The last-known hash of the plot-schema (or '').
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE)
params = make_params(sha1=sha1)
return request('get', url, params=params, **kwargs)
def retrieve(fid, share_key=None):
"""
Retrieve a folder from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid)
params = make_params(share_key=share_key)
return request("get", url, params=params)
def retrieve(fid, share_key=None):
"""
Retrieve a plot from Plotly.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid)
params = make_params(share_key=share_key)
return request('get', url, params=params)
def content(fid, share_key=None):
"""
Retrieve full content for the grid (normal retrieve only yields preview)
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='content')
params = make_params(share_key=share_key)
return request('get', url, params=params)
def col_delete(fid, uid):
"""
Permanently delete a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='col')
params = make_params(uid=uid)
return request('delete', url, params=params)
def col_update(fid, uid, body):
"""
Update a column (or columns) from a grid.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) uid: A ','-concatenated string of column uids in the grid.
:param (dict) body: A mapping of body param names to values.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='col')
params = make_params(uid=uid)
return request('put', url, json=body, params=params)
def lookup(path, parent=None, user=None, exists=None):
"""
Retrieve a folder file from Plotly without needing a fid.
:param (str) path: The '/'-delimited path specifying the file location.
:param (int) parent: Parent id, an integer, which the path is relative to.
:param (str) user: The username to target files for. Defaults to requestor.
:param (bool) exists: If True, don't return the full file, just a flag.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, route="lookup")
params = make_params(path=path, parent=parent, user=user, exists=exists)
return request("get", url, params=params)
def lookup(path, parent=None, user=None, exists=None):
"""
Retrieve a plot file from Plotly without needing a fid.
:param (str) path: The '/'-delimited path specifying the file location.
:param (int) parent: Parent id, an integer, which the path is relative to.
:param (str) user: The username to target files for. Defaults to requestor.
:param (bool) exists: If True, don't return the full file, just a flag.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, route='lookup')
params = make_params(path=path, parent=parent, user=user, exists=exists)
return request('get', url, params=params)
def content(fid, share_key=None, inline_data=None, map_data=None):
"""
Retrieve the *figure* for a Plotly plot file.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:param (bool) inline_data: If True, include the data arrays with the plot.
:param (str) map_data: Currently only accepts 'unreadable' to return a
mapping of grid-fid: grid. This is useful if you
want to maintain structure between the plot and
referenced grids when you have READ access to the
plot, but you don't have READ access to the
underlying grids.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route='content')
params = make_params(share_key=share_key, inline_data=inline_data,
map_data=map_data)
return request('get', url, params=params)
def content(fid, share_key=None, inline_data=None, map_data=None):
"""
Retrieve the *figure* for a Plotly plot file.
:param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`.
:param (str) share_key: The secret key granting 'read' access if private.
:param (bool) inline_data: If True, include the data arrays with the plot.
:param (str) map_data: Currently only accepts 'unreadable' to return a
mapping of grid-fid: grid. This is useful if you
want to maintain structure between the plot and
referenced grids when you have READ access to the
plot, but you don't have READ access to the
underlying grids.
:returns: (requests.Response) Returns response directly from requests.
"""
url = build_url(RESOURCE, id=fid, route="content")
params = make_params(share_key=share_key,
inline_data=inline_data,
map_data=map_data)
return request("get", url, params=params)
def test_make_params_empty(self):
params = utils.make_params(foo=None, bar=None)
self.assertEqual(params, {})
def test_make_params(self):
params = utils.make_params(foo='FOO', bar=None)
self.assertEqual(params, {'foo': 'FOO'})
def test_make_params(self):
params = utils.make_params(foo="FOO", bar=None)
self.assertEqual(params, {"foo": "FOO"})
def test_make_params_empty(self):
params = utils.make_params(foo=None, bar=None)
self.assertEqual(params, {})
def test_make_params(self):
params = utils.make_params(foo='FOO', bar=None)
self.assertEqual(params, {'foo': 'FOO'})
