EdinburghGenomics / pyclarity-lims

Python interface to the GenoLogics LIMS server via its REST API.
MIT License
11 stars 5 forks source link

all_inputs documentat - list vs dict_values #50

Closed EGCGDanForth closed 5 years ago

EGCGDanForth commented 5 years ago

The documentation for "Process.all_inputs" infers that the output is always a list type variable but the output variable type can be list or dict_values

Process.all_inputs(self, unique=True, resolve=False) produces a list type variable Process.all_inputs(self, uniqued=True, resolve=True) produces a dict_values

def all_inputs(self, unique=True, resolve=False): """Retrieving all input artifacts from input_output_maps. If unique is true, no duplicates are returned.

    :param unique: boolean specifying if the list of artifacts should be uniqued
    :param resolve: boolean specifying if the artifacts entities should be resolved through a batch query.
    :return: list of input artifacts._