Allow where() and __contains__ with Tags. Closes #168.

onecodex/models/__init__.py

@@ -80,6 +80,9 @@ def __eq__(self, other):
         # two ResourceLists are equal if they refer to the same underlying Resource
         return id(self._resource) == id(other._resource)
 
+    def __contains__(self, other):
+        return other.__hash__() in [x.__hash__() for x in self._res_list]
+
     @property
     def __repr__(self):
         return self._res_list.__repr__

onecodex/models/misc.py

@@ -26,6 +26,9 @@ def __repr__(self):
         return '<{} {}: "{}">'.format(self.__class__.__name__, self.id,
                                       truncate_string(self.name, 24))
 
+    def __hash__(self):
+        return hash(self.name)
+
 
 class Users(OneCodexBase):
     _resource_path = '/api/v1/users'

onecodex/models/sample.py

@@ -6,7 +6,7 @@
 
 from onecodex.exceptions import OneCodexException
 from onecodex.lib.upload import upload
-from onecodex.models import OneCodexBase, Projects
+from onecodex.models import OneCodexBase, Projects, Tags
 from onecodex.models.helpers import truncate_string
 
 
@@ -25,6 +25,40 @@ def where(cls, *filters, **keyword_filters):
         instances_route = 'instances' if not public else 'instances_public'
         limit = keyword_filters.get('limit', None if not public else 1000)
 
+        # handle conversion of tag UUIDs or names to Tags objects
+        tags = keyword_filters.pop('tags', [])
+
+        if not isinstance(tags, list):
+            tags = [tags]
+
+        new_tags = []
+
+        for t in tags:
+            if isinstance(t, Tags):
+                new_tags.append(t)
+            else:
+                # is it a uuid?
+                if len(t) == 16:
+                    tag_obj = Tags.get(t)
+
+                    if tag_obj is not None:
+                        new_tags.append(tag_obj)
+                        continue
+
+                # is it a name?
+                tag_obj = Tags.where(name=t)
+
+                if len(tag_obj) == 1:
+                    new_tags.append(tag_obj[0])
+                    continue
+                elif len(tag_obj) > 1:
+                    raise OneCodexException('Multiple tags matched query: {}'.format(t))
+
+                raise OneCodexException('Unknown tag specified: {}'.format(t))
+
+        if new_tags:
+            keyword_filters['tags'] = new_tags
+
         # we can only search metadata on our own samples currently
         # FIXME: we need to add `instances_public` and `instances_project` metadata routes to
         # mirror the ones on the samples
@@ -175,6 +209,9 @@ def download(self, path=None):
                 raise OneCodexException('Download failed with an HTTP status code {}.'.format(
                                         exc.response.status_code))
 
+    def __hash__(self):
+        return hash(self.id)
+
 
 class Metadata(OneCodexBase):
     _resource_path = '/api/v1/metadata'