def test_parse_serialization_params():
view, default_view = 'a', 'b'
keys = 'foo'
serialized = parse_serialization_params(view, keys, default_view)
assert serialized['view'] == view
assert serialized['default_view'] == default_view
assert serialized['keys'] == [keys]
keys = 'foo,bar,baz'
serialized = parse_serialization_params(view, keys, default_view)
assert serialized['keys'] == ['foo', 'bar', 'baz']
def test_parse_serialization_params():
view, default_view = 'a', 'b'
keys = 'foo'
serialized = parse_serialization_params(view, keys, default_view)
assert serialized.view == view
assert serialized.default_view == default_view
assert serialized.keys == [keys]
keys = 'foo,bar,baz'
serialized = parse_serialization_params(view, keys, default_view)
assert serialized.keys == ['foo', 'bar', 'baz']
serialized = parse_serialization_params(default_view=default_view)
assert serialized.view is None
assert serialized.keys is None
assert serialized.default_view == default_view
def delete(self, trans, id, **kwd):
"""
DELETE /api/histories/{id}
delete the history with the given ``id``
.. note:: Stops all active jobs in the history if purge is set.
:type id: str
:param id: the encoded id of the history to delete
:type kwd: dict
:param kwd: (optional) dictionary structure containing extra parameters
You can purge a history, removing all it's datasets from disk (if unshared),
by passing in ``purge=True`` in the url.
:param keys: same as the use of `keys` in the `index` function above
:param view: same as the use of `view` in the `index` function above
:rtype: dict
:returns: the deleted or purged history
"""
history_id = id
# a request body is optional here
purge = string_as_bool(kwd.get('purge', False))
# for backwards compat, keep the payload sub-dictionary
if kwd.get('payload', None):
purge = string_as_bool(kwd['payload'].get('purge', purge))
serialization_params = parse_serialization_params(**kwd)
return self.service.delete(trans, history_id, serialization_params,
purge)
def show(self, trans, id, deleted='False', **kwd):
"""
show( trans, id, deleted='False' )
* GET /api/histories/{id}:
return the history with ``id``
* GET /api/histories/deleted/{id}:
return the deleted history with ``id``
* GET /api/histories/most_recently_used:
return the most recently used history
:type id: an encoded id string
:param id: the encoded id of the history to query or the string 'most_recently_used'
:type deleted: boolean
:param deleted: if True, allow information on a deleted history to be shown.
:param keys: same as the use of `keys` in the `index` function above
:param view: same as the use of `view` in the `index` function above
:rtype: dictionary
:returns: detailed history information
"""
history_id = id
if history_id == "most_recently_used":
history_id = None # Will default to the most recently used
serialization_params = parse_serialization_params(**kwd)
return self.service.show(trans, serialization_params, history_id)
def shared_with_me(self, trans, **kwd):
"""
shared_with_me( self, trans, **kwd )
* GET /api/histories/shared_with_me:
return all histories that are shared with the current user
:rtype: list
:returns: list of dictionaries containing summary history information
Follows the same filtering logic as the index() method above.
"""
serialization_params = parse_serialization_params(**kwd)
filter_parameters = HistoryFilterQueryParams(**kwd)
return self.service.shared_with_me(trans, serialization_params,
filter_parameters)
def published(self, trans, **kwd):
"""
GET /api/histories/published
return all histories that are published
:rtype: list
:returns: list of dictionaries containing summary history information
Follows the same filtering logic as the index() method above.
"""
serialization_params = parse_serialization_params(**kwd)
filter_parameters = HistoryFilterQueryParams(**kwd)
return self.service.published(trans, serialization_params,
filter_parameters)
def undelete(self, trans, id, **kwd):
"""
undelete( self, trans, id, **kwd )
* POST /api/histories/deleted/{id}/undelete:
undelete history (that hasn't been purged) with the given ``id``
:type id: str
:param id: the encoded id of the history to undelete
:param keys: same as the use of `keys` in the `index` function above
:param view: same as the use of `view` in the `index` function above
:rtype: str
:returns: 'OK' if the history was undeleted
"""
serialization_params = parse_serialization_params(**kwd)
return self.service.undelete(trans, id, serialization_params)
def create(self, trans, payload, **kwd):
"""
create( trans, payload )
* POST /api/histories:
create a new history
:type payload: dict
:param payload: (optional) dictionary structure containing:
* name: the new history's name
* history_id: the id of the history to copy
* all_datasets: copy deleted hdas/hdcas? 'True' or 'False', defaults to True
* archive_source: the url that will generate the archive to import
* archive_type: 'url' (default)
:param keys: same as the use of `keys` in the `index` function above
:param view: same as the use of `view` in the `index` function above
:rtype: dict
:returns: element view of new history
"""
create_payload = CreateHistoryPayload(**payload)
serialization_params = parse_serialization_params(**kwd)
return self.service.create(trans, create_payload, serialization_params)
def update(self, trans, id, payload, **kwd):
"""
update( self, trans, id, payload, **kwd )
* PUT /api/histories/{id}
updates the values for the history with the given ``id``
:type id: str
:param id: the encoded id of the history to update
:type payload: dict
:param payload: a dictionary containing any or all the
fields in :func:`galaxy.model.History.to_dict` and/or the following:
* annotation: an annotation for the history
:param keys: same as the use of `keys` in the `index` function above
:param view: same as the use of `view` in the `index` function above
:rtype: dict
:returns: an error object if an error occurred or a dictionary containing
any values that were different from the original and, therefore, updated
"""
# TODO: PUT /api/histories/{encoded_history_id} payload = { rating: rating } (w/ no security checks)
serialization_params = parse_serialization_params(**kwd)
return self.service.update(trans, id, payload, serialization_params)
def index(self, trans, deleted='False', **kwd):
"""
GET /api/histories
return undeleted histories for the current user
GET /api/histories/deleted
return deleted histories for the current user
.. note:: Anonymous users are allowed to get their current history
:type deleted: boolean
:param deleted: if True, show only deleted histories, if False, non-deleted
:rtype: list
:returns: list of dictionaries containing summary history information
The following are optional parameters:
view: string, one of ('summary','detailed'), defaults to 'summary'
controls which set of properties to return
keys: comma separated strings, unused by default
keys/names of individual properties to return
all: boolean, defaults to 'false', admin-only
returns all histories, not just current user's
If neither keys or views are sent, the default view (set of keys) is returned.
If both a view and keys are sent, the key list and the view's keys are
combined.
If keys are send and no view, only those properties in keys are returned.
For which properties are available see
galaxy/managers/histories/HistorySerializer
The list returned can be filtered by using two optional parameters:
:q:
string, generally a property name to filter by followed
by an (often optional) hyphen and operator string.
:qv:
string, the value to filter by
..example::
To filter the list to only those created after 2015-01-29,
the query string would look like:
'?q=create_time-gt&qv=2015-01-29'
Multiple filters can be sent in using multiple q/qv pairs:
'?q=create_time-gt&qv=2015-01-29&q=tag-has&qv=experiment-1'
The list returned can be paginated using two optional parameters:
limit: integer, defaults to no value and no limit (return all)
how many items to return
offset: integer, defaults to 0 and starts at the beginning
skip the first ( offset - 1 ) items and begin returning
at the Nth item
..example:
limit and offset can be combined. Skip the first two and return five:
'?limit=5&offset=3'
The list returned can be ordered using the optional parameter:
order: string containing one of the valid ordering attributes followed
(optionally) by '-asc' or '-dsc' for ascending and descending
order respectively. Orders can be stacked as a comma-
separated list of values.
..example:
To sort by name descending then create time descending:
'?order=name-dsc,create_time'
The ordering attributes and their default orders are:
create_time defaults to 'create_time-dsc'
update_time defaults to 'update_time-dsc'
name defaults to 'name-asc'
'order' defaults to 'create_time-dsc'
"""
deleted_only = util.string_as_bool(deleted)
all_histories = util.string_as_bool(kwd.get('all', False))
serialization_params = parse_serialization_params(**kwd)
filter_parameters = HistoryFilterQueryParams(**kwd)
return self.service.index(trans, serialization_params,
filter_parameters, deleted_only,
all_histories)
