Merge pull request SciLifeLab#213 from Galithil/master

Update queues

genologics/descriptors.py

@@ -531,9 +531,35 @@ def __get__(self, instance, cls):
  rootnode = rootnode.find(rootkey)
  for node in rootnode.findall(self.tag):
  result.append(self.klass(instance.lims, uri=node.attrib['uri']))
+
+ return result
+
+class MultiPageNestedEntityListDescriptor(EntityListDescriptor):
+ """same as NestedEntityListDescriptor, but works on multiple pages, for Queues"""
+
+ def __init__(self, tag, klass, *args):
+ super(EntityListDescriptor, self).__init__(tag, klass)
+ self.klass = klass
+ self.tag = tag
+ self.rootkeys = args
+ self.max_depth = 10
+
+ def __get__(self, instance, cls):
+ instance.get()
+ result = []
+ rootnode = instance.root
+ for rootkey in self.rootkeys:
+ rootnode = rootnode.find(rootkey)
+ for node in rootnode.findall(self.tag):
+ result.append(self.klass(instance.lims, uri=node.attrib['uri']))
+
+ if instance.root.find('next-page') is not None:
+ next_queue_page = instance.__class__(instance.lims, uri=instance.root.find('next-page').attrib.get('uri'))
+ result.extend(next_queue_page.artifacts)
  return result
 
 
+
 class DimensionDescriptor(TagDescriptor):
  """An instance attribute containing a dictionary specifying
  the properties of a dimension of a container type.
@@ -544,7 +570,8 @@ def __get__(self, instance, cls):
  node = instance.root.find(self.tag)
  return dict(is_alpha=node.find('is-alpha').text.lower() == 'true',
  offset=int(node.find('offset').text),
- size=int(node.find('size').text))
+ size=int(node.find('size').text)
+ )
 
 
 class LocationDescriptor(TagDescriptor):

genologics/entities.py

@@ -12,7 +12,7 @@
  StringAttributeDescriptor, StringListDescriptor, DimensionDescriptor, IntegerDescriptor, \
  PlacementDictionaryDescriptor, InputOutputMapList, LocationDescriptor, ReagentLabelList, NestedEntityListDescriptor, \
  NestedStringListDescriptor, NestedAttributeListDescriptor, IntegerAttributeDescriptor, NestedStringDescriptor, \
- NestedBooleanDescriptor
+ NestedBooleanDescriptor, MultiPageNestedEntityListDescriptor
 
 try:
  from urllib.parse import urlsplit, urlparse, parse_qs, urlunparse
@@ -1080,12 +1080,13 @@ def __init__(self, lims, uri=None, id=None):
 
 
 class Queue(Entity):
- """Queue of a given step"""
+ """Queue of a given step. Will recursively get all the pages of artifacts, and therefore, can be quite slow to load"""
  _URI = "queues"
  _TAG= "queue"
  _PREFIX = "que"
 
- artifacts=NestedEntityListDescriptor("artifact", Artifact, "artifacts")
+
+ artifacts = MultiPageNestedEntityListDescriptor("artifact", Artifact, "artifacts")
 
 Sample.artifact = EntityDescriptor('artifact', Artifact)
 StepActions.step = EntityDescriptor('step', Step)

genologics/version.py

@@ -1 +1 @@
-__version__="0.3.21"
+__version__="0.3.22"