flywheel-sdk 20.4.4__py2.py3-none-any.whl → 20.5.0__py2.py3-none-any.whl

flywheel/models/mixins.py

@@ -2,7 +2,8 @@ import warnings
 
 from .. import util
 from ..finder import Finder
-from .gear_mixin import GearMixin
+from .gear_mixin import GearMixin  # noqa: F401
+
 
 class ContextBase(object):
     def __init__(self):
@@ -35,9 +36,7 @@ class ContainerBase(object):
         fname = fmt.format(self.container_type)
         fn = getattr(self.__context, fname, None)
         if not fn:
-            raise ValueError(
-                f"Context {self.__context} doesn't have a function {fname}"
-            )
+            raise ValueError(f"Context {self.__context} doesn't have a function {fname}")
         return fn(*args, **kwargs)
 
     def _invoke_file_api(self, fmt, *args, **kwargs):
@@ -51,9 +50,7 @@ class ContainerBase(object):
             if fn:
                 return fn(*args, **kwargs)
             else:
-                raise ValueError(
-                    f"Context {self.__context} doesn't have a function {fname}"
-                )
+                raise ValueError(f"Context {self.__context} doesn't have a function {fname}")
         return None
 
     def _add_child(self, child_type, args, kwargs):
@@ -105,9 +102,7 @@ class ContainerBase(object):
         """Get the modification time in the local timezone"""
         return self._localize_date("modified")
 
-    def _find_children(
-        self, child_type, filters, find_first=False, find_one=False, **kwargs
-    ):
+    def _find_children(self, child_type, filters, find_first=False, find_one=False, **kwargs):
         fname = "get_{}_{}".format(self.container_type, child_type)
         return self.__context._find(
             fname,
@@ -134,7 +129,6 @@ class ContainerBase(object):
 
 
 class InfoMethods(object):
-
     def _warn_if_keys_will_be_sanitized(self, key):
         """Log warning message for offending characters"""
         if "$" in key:
@@ -212,9 +206,7 @@ class PermissionMethods(object):
 
     def update_permission(self, user_id, permission, **kwargs):
         """Update a user's permission on container"""
-        return self._invoke_container_api(
-            "modify_{}_user_permission", self.id, user_id, permission, **kwargs
-        )
+        return self._invoke_container_api("modify_{}_user_permission", self.id, user_id, permission, **kwargs)
 
     def delete_permission(self, user_id, **kwargs):
         """Delete a user's permission from container"""
@@ -231,12 +223,7 @@ class DownloadMethods(object):
         :return: A summary of the download
         """
         return self._invoke_container_api(
-            "download_tar",
-            self,
-            dest_file,
-            include_types=include_types,
-            exclude_types=exclude_types,
-            **kwargs
+            "download_tar", self, dest_file, include_types=include_types, exclude_types=exclude_types, **kwargs
         )
 
     def download_zip(self, dest_file, include_types=None, exclude_types=None, **kwargs):
@@ -248,16 +235,10 @@ class DownloadMethods(object):
         :return: A summary of the download
         """
         return self._invoke_container_api(
-            "download_zip",
-            self,
-            dest_file,
-            include_types=include_types,
-            exclude_types=exclude_types,
-            **kwargs
+            "download_zip", self, dest_file, include_types=include_types, exclude_types=exclude_types, **kwargs
         )
 
 
-
 class AnalysisMethods(object):
     def add_analysis(self, *args, **kwargs):
         """Add an analysis to this container"""
@@ -303,9 +284,7 @@ class FileMethods(object):
 
     def download_file(self, file_name, dest_file, **kwargs):
         """Download file to the given path"""
-        return self._invoke_file_api(
-            "download_file_from_{}", self.id, file_name, dest_file, **kwargs
-        )
+        return self._invoke_file_api("download_file_from_{}", self.id, file_name, dest_file, **kwargs)
 
     def get_file_download_url(self, file_name, **kwargs):
         """Get a ticketed download url for the file"""
@@ -313,9 +292,7 @@ class FileMethods(object):
 
     def read_file(self, file_name, **kwargs):
         """Read the contents of the file"""
-        return self._invoke_file_api(
-            "download_file_from_{}_as_data", self.id, file_name, **kwargs
-        )
+        return self._invoke_file_api("download_file_from_{}_as_data", self.id, file_name, **kwargs)
 
     def update_file(self, file_name, *args, **kwargs):
         """Update a file's type and/or modality"""
@@ -349,24 +326,18 @@ class FileMethods(object):
     def delete_file_info(self, file_name, *args, **kwargs):
         """Delete the file info fields listed in args"""
         body = util.params_to_list(args)
-        return self._invoke_file_api(
-            "delete_{}_file_info_fields", self.id, file_name, body, **kwargs
-        )
+        return self._invoke_file_api("delete_{}_file_info_fields", self.id, file_name, body, **kwargs)
 
     def replace_file_classification(self, file_name, classification, modality=None, **kwargs):
         """Fully replace a file's modality and classification"""
         body = {"replace": classification}
         if modality is not None:
             body["modality"] = modality
-        return self._invoke_file_api(
-            "modify_{}_file_classification", self.id, file_name, body, **kwargs
-        )
+        return self._invoke_file_api("modify_{}_file_classification", self.id, file_name, body, **kwargs)
 
     def update_file_classification(self, file_name, classification, **kwargs):
         """Update a file's classification"""
-        return self._invoke_file_api(
-            "set_{}_file_classification", self.id, file_name, classification, **kwargs
-        )
+        return self._invoke_file_api("set_{}_file_classification", self.id, file_name, classification, **kwargs)
 
     def delete_file_classification(self, file_name, classification, **kwargs):
         """Delete a file's classification fields"""
@@ -409,9 +380,7 @@ class FileMethods(object):
 
     def read_file_zip_member(self, file_name, member_path, **kwargs):
         """Read contents of file's zip member"""
-        return self._invoke_file_api(
-            "download_file_from_{}_as_data", self.id, file_name, member=member_path, **kwargs
-        )
+        return self._invoke_file_api("download_file_from_{}_as_data", self.id, file_name, member=member_path, **kwargs)
 
 
 class TimestampMethods(object):
@@ -445,15 +414,11 @@ class GroupMixin(ContainerBase, TagMethods, PermissionMethods):
 
     def add_permission_template(self, permission, **kwargs):
         """Add a permission template for a group"""
-        return self._invoke_container_api(
-            "add_group_permission_template", self.id, permission, **kwargs
-        )
+        return self._invoke_container_api("add_group_permission_template", self.id, permission, **kwargs)
 
     def get_permission_template(self, user_id, **kwargs):
         """Get a user's permission template for a group"""
-        return self._invoke_container_api(
-            "get_group_user_permission_template", self.id, user_id, **kwargs
-        )
+        return self._invoke_container_api("get_group_user_permission_template", self.id, user_id, **kwargs)
 
     def update_permission_template(self, user_id, permission, **kwargs):
         """Update a user's permission template for a group"""
@@ -467,9 +432,7 @@ class GroupMixin(ContainerBase, TagMethods, PermissionMethods):
 
     def delete_permission_template(self, user_id, **kwargs):
         """Delete a user's permission template from a group"""
-        return self._invoke_container_api(
-            "delete_group_user_permission_template", self.id, user_id, **kwargs
-        )
+        return self._invoke_container_api("delete_group_user_permission_template", self.id, user_id, **kwargs)
 
 
 class ProjectMixin(
@@ -494,9 +457,7 @@ class ProjectMixin(
         return self._add_child("session", args, kwargs)
 
 
-class SubjectMixin(
-    ContainerBase, TagMethods, NoteMethods, FileMethods, InfoMethods, AnalysisMethods
-):
+class SubjectMixin(ContainerBase, TagMethods, NoteMethods, FileMethods, InfoMethods, AnalysisMethods):
     container_type = "subject"
     child_types = ["sessions", "analyses", "files"]
 
@@ -573,9 +534,7 @@ class AcquisitionMixin(
     child_types = ["analyses", "files"]
 
 
-class AnalysisMixin(
-    ContainerBase, NoteMethods, TagMethods, FileMethods, InfoMethods, DownloadMethods
-):
+class AnalysisMixin(ContainerBase, NoteMethods, TagMethods, FileMethods, InfoMethods, DownloadMethods):
     container_type = "analysis"
     child_types = ["files"]
     _file_group = "output"
@@ -587,7 +546,7 @@ class AnalysisMixin(
     def upload_output(self, file, **kwargs):
         """Upload an output file to analysis"""
         return self._invoke_container_api("upload_output_to_analysis", self.id, file, **kwargs)
- 
+
     def update_file_info(self, file_name, *args, **kwargs):
         """Update the file's info with the passed in arguments"""
         body = util.params_to_dict("update_file_info", args, kwargs)
@@ -607,9 +566,7 @@ class CollectionMixin(ContainerBase, NoteMethods, TagMethods, FileMethods, InfoM
             else:
                 session_ids.append(arg.id)
 
-        return self._invoke_container_api(
-            "add_sessions_to_{}", self.id, session_ids, **kwargs
-        )
+        return self._invoke_container_api("add_sessions_to_{}", self.id, session_ids, **kwargs)
 
     def add_acquisitions(self, *args, **kwargs):
         acquisition_ids = []
@@ -619,9 +576,7 @@ class CollectionMixin(ContainerBase, NoteMethods, TagMethods, FileMethods, InfoM
             else:
                 acquisition_ids.append(arg.id)
 
-        return self._invoke_container_api(
-            "add_acquisitions_to_{}", self.id, acquisition_ids, **kwargs
-        )
+        return self._invoke_container_api("add_acquisitions_to_{}", self.id, acquisition_ids, **kwargs)
 
 
 class FileMixin(ContainerBase):
@@ -635,9 +590,7 @@ class FileMixin(ContainerBase):
     @property
     def parent(self, **kwargs):
         if self._parent is None:
-            self._parent = self._invoke_container_api(
-                f"get_{self._parent_ref.type}", self.parent_ref.id, **kwargs
-            )
+            self._parent = self._invoke_container_api(f"get_{self._parent_ref.type}", self.parent_ref.id, **kwargs)
         return self._parent
 
     @property
@@ -675,9 +628,7 @@ class FileMixin(ContainerBase):
 
     def replace_classification(self, classification, modality=None, **kwargs):
         """Fully replace a file's modality and classification"""
-        return self.parent.replace_file_classification(
-            self.name, classification, modality=modality, **kwargs
-        )
+        return self.parent.replace_file_classification(self.name, classification, modality=modality, **kwargs)
 
     def update_classification(self, classification, **kwargs):
         """Update a file's classification"""
@@ -723,9 +674,7 @@ class FileMixin(ContainerBase):
 
     def reload(self, **kwargs):
         """Reload the file."""
-        return self._invoke_container_api(
-            "get_file", self.file_id, version=self.version, **kwargs
-        )
+        return self._invoke_container_api("get_file", self.file_id, version=self.version, **kwargs)
 
     def get_zip_info(self, **kwargs):
         """Get zip member information for this file"""

flywheel/models/search_parent_acquisition.py

@@ -21,6 +21,7 @@ import six
 from flywheel.models.acquisition_output import AcquisitionOutput  # noqa: F401,E501
 from flywheel.models.acquisition_parents import AcquisitionParents  # noqa: F401,E501
 from flywheel.models.container_type import ContainerType  # noqa: F401,E501
+from flywheel.models.copy_status import CopyStatus  # noqa: F401,E501
 from flywheel.models.file_output import FileOutput  # noqa: F401,E501
 from flywheel.models.join_origins import JoinOrigins  # noqa: F401,E501
 from flywheel.models.note import Note  # noqa: F401,E501

flywheel/models/session_upsert_input.py

@@ -33,7 +33,8 @@ class SessionUpsertInput(object):
         'age': 'int',
         'weight': 'float',
         'operator': 'str',
-        'info': 'object'
+        'info': 'object',
+        'tags': 'list[str]'
     }
 
     attribute_map = {
@@ -47,7 +48,8 @@ class SessionUpsertInput(object):
         'age': 'age',
         'weight': 'weight',
         'operator': 'operator',
-        'info': 'info'
+        'info': 'info',
+        'tags': 'tags'
     }
 
     rattribute_map = {
@@ -61,10 +63,11 @@ class SessionUpsertInput(object):
         'age': 'age',
         'weight': 'weight',
         'operator': 'operator',
-        'info': 'info'
+        'info': 'info',
+        'tags': 'tags'
     }
 
-    def __init__(self, id=None, uid=None, routing_field=None, label=None, source=None, timestamp=None, timezone=None, age=None, weight=None, operator=None, info=None):  # noqa: E501
+    def __init__(self, id=None, uid=None, routing_field=None, label=None, source=None, timestamp=None, timezone=None, age=None, weight=None, operator=None, info=None, tags=None):  # noqa: E501
         """SessionUpsertInput - a model defined in Swagger"""
         super(SessionUpsertInput, self).__init__()
 
@@ -79,6 +82,7 @@ class SessionUpsertInput(object):
         self._weight = None
         self._operator = None
         self._info = None
+        self._tags = None
         self.discriminator = None
         self.alt_discriminator = None
 
@@ -104,6 +108,8 @@ class SessionUpsertInput(object):
             self.operator = operator
         if info is not None:
             self.info = info
+        if tags is not None:
+            self.tags = tags
 
     @property
     def id(self):
@@ -336,6 +342,27 @@ class SessionUpsertInput(object):
 
         self._info = info
 
+    @property
+    def tags(self):
+        """Gets the tags of this SessionUpsertInput.
+
+
+        :return: The tags of this SessionUpsertInput.
+        :rtype: list[str]
+        """
+        return self._tags
+
+    @tags.setter
+    def tags(self, tags):
+        """Sets the tags of this SessionUpsertInput.
+
+
+        :param tags: The tags of this SessionUpsertInput.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._tags = tags
+
 
     @staticmethod
     def positional_to_model(value):

flywheel/models/subject.py

@@ -18,6 +18,14 @@ import pprint
 import re  # noqa: F401
 import six
 
+from flywheel.models.cohort import Cohort  # noqa: F401,E501
+from flywheel.models.copy_status import CopyStatus  # noqa: F401,E501
+from flywheel.models.ml_type import MLType  # noqa: F401,E501
+from flywheel.models.note import Note  # noqa: F401,E501
+from flywheel.models.role_permission import RolePermission  # noqa: F401,E501
+from flywheel.models.subject_parents import SubjectParents  # noqa: F401,E501
+from flywheel.models.subject_state import SubjectState  # noqa: F401,E501
+
 
 from flywheel.models.subject_output import SubjectOutput
 

flywheel/models/subject_copy_input.py

@@ -0,0 +1,221 @@
+# coding: utf-8
+
+"""
+    Flywheel
+
+    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
+
+    OpenAPI spec version: 0.0.1
+    
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+## NOTE: This file is auto generated by the swagger code generator program.
+## Do not edit the file manually.
+
+import pprint
+import re  # noqa: F401
+import six
+
+from flywheel.models.copy_filter import CopyFilter  # noqa: F401,E501
+
+class SubjectCopyInput(object):
+
+    swagger_types = {
+        'dst_subject_label': 'str',
+        'dst_project_id': 'str',
+        'filter': 'CopyFilter'
+    }
+
+    attribute_map = {
+        'dst_subject_label': 'dst_subject_label',
+        'dst_project_id': 'dst_project_id',
+        'filter': 'filter'
+    }
+
+    rattribute_map = {
+        'dst_subject_label': 'dst_subject_label',
+        'dst_project_id': 'dst_project_id',
+        'filter': 'filter'
+    }
+
+    def __init__(self, dst_subject_label=None, dst_project_id=None, filter=None):  # noqa: E501
+        """SubjectCopyInput - a model defined in Swagger"""
+        super(SubjectCopyInput, self).__init__()
+
+        self._dst_subject_label = None
+        self._dst_project_id = None
+        self._filter = None
+        self.discriminator = None
+        self.alt_discriminator = None
+
+        if dst_subject_label is not None:
+            self.dst_subject_label = dst_subject_label
+        self.dst_project_id = dst_project_id
+        self.filter = filter
+
+    @property
+    def dst_subject_label(self):
+        """Gets the dst_subject_label of this SubjectCopyInput.
+
+        Label to apply to the copied subject
+
+        :return: The dst_subject_label of this SubjectCopyInput.
+        :rtype: str
+        """
+        return self._dst_subject_label
+
+    @dst_subject_label.setter
+    def dst_subject_label(self, dst_subject_label):
+        """Sets the dst_subject_label of this SubjectCopyInput.
+
+        Label to apply to the copied subject
+
+        :param dst_subject_label: The dst_subject_label of this SubjectCopyInput.  # noqa: E501
+        :type: str
+        """
+
+        self._dst_subject_label = dst_subject_label
+
+    @property
+    def dst_project_id(self):
+        """Gets the dst_project_id of this SubjectCopyInput.
+
+        Project to copy to
+
+        :return: The dst_project_id of this SubjectCopyInput.
+        :rtype: str
+        """
+        return self._dst_project_id
+
+    @dst_project_id.setter
+    def dst_project_id(self, dst_project_id):
+        """Sets the dst_project_id of this SubjectCopyInput.
+
+        Project to copy to
+
+        :param dst_project_id: The dst_project_id of this SubjectCopyInput.  # noqa: E501
+        :type: str
+        """
+
+        self._dst_project_id = dst_project_id
+
+    @property
+    def filter(self):
+        """Gets the filter of this SubjectCopyInput.
+
+
+        :return: The filter of this SubjectCopyInput.
+        :rtype: CopyFilter
+        """
+        return self._filter
+
+    @filter.setter
+    def filter(self, filter):
+        """Sets the filter of this SubjectCopyInput.
+
+
+        :param filter: The filter of this SubjectCopyInput.  # noqa: E501
+        :type: CopyFilter
+        """
+
+        self._filter = filter
+
+
+    @staticmethod
+    def positional_to_model(value):
+        """Converts a positional argument to a model value"""
+        return value
+
+    def return_value(self):
+        """Unwraps return value from model"""
+        return self
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, SubjectCopyInput):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other
+
+    # Container emulation
+    def __getitem__(self, key):
+        """Returns the value of key"""
+        key = self._map_key(key)
+        return getattr(self, key)
+
+    def __setitem__(self, key, value):
+        """Sets the value of key"""
+        key = self._map_key(key)
+        setattr(self, key, value)
+
+    def __contains__(self, key):
+        """Checks if the given value is a key in this object"""
+        key = self._map_key(key, raise_on_error=False)
+        return key is not None
+
+    def keys(self):
+        """Returns the list of json properties in the object"""
+        return self.__class__.rattribute_map.keys()
+
+    def values(self):
+        """Returns the list of values in the object"""
+        for key in self.__class__.attribute_map.keys():
+            yield getattr(self, key)
+
+    def items(self):
+        """Returns the list of json property to value mapping"""
+        for key, prop in self.__class__.rattribute_map.items():
+            yield key, getattr(self, prop)
+
+    def get(self, key, default=None):
+        """Get the value of the provided json property, or default"""
+        key = self._map_key(key, raise_on_error=False)
+        if key:
+            return getattr(self, key, default)
+        return default
+
+    def _map_key(self, key, raise_on_error=True):
+        result = self.__class__.rattribute_map.get(key)
+        if result is None:
+            if raise_on_error:
+                raise AttributeError('Invalid attribute name: {}'.format(key))
+            return None
+        return '_' + result

flywheel/models/subject_upsert_input.py

@@ -38,7 +38,8 @@ class SubjectUpsertInput(object):
         'species': 'str',
         'strain': 'str',
         'info': 'object',
-        'state': 'SubjectState'
+        'state': 'SubjectState',
+        'tags': 'list[str]'
     }
 
     attribute_map = {
@@ -56,7 +57,8 @@ class SubjectUpsertInput(object):
         'species': 'species',
         'strain': 'strain',
         'info': 'info',
-        'state': 'state'
+        'state': 'state',
+        'tags': 'tags'
     }
 
     rattribute_map = {
@@ -74,10 +76,11 @@ class SubjectUpsertInput(object):
         'species': 'species',
         'strain': 'strain',
         'info': 'info',
-        'state': 'state'
+        'state': 'state',
+        'tags': 'tags'
     }
 
-    def __init__(self, date_of_birth=None, id=None, routing_field=None, label=None, source=None, firstname=None, lastname=None, sex=None, type=None, race=None, ethnicity=None, species=None, strain=None, info=None, state=None):  # noqa: E501
+    def __init__(self, date_of_birth=None, id=None, routing_field=None, label=None, source=None, firstname=None, lastname=None, sex=None, type=None, race=None, ethnicity=None, species=None, strain=None, info=None, state=None, tags=None):  # noqa: E501
         """SubjectUpsertInput - a model defined in Swagger"""
         super(SubjectUpsertInput, self).__init__()
 
@@ -96,6 +99,7 @@ class SubjectUpsertInput(object):
         self._strain = None
         self._info = None
         self._state = None
+        self._tags = None
         self.discriminator = None
         self.alt_discriminator = None
 
@@ -129,6 +133,8 @@ class SubjectUpsertInput(object):
             self.info = info
         if state is not None:
             self.state = state
+        if tags is not None:
+            self.tags = tags
 
     @property
     def date_of_birth(self):
@@ -445,6 +451,27 @@ class SubjectUpsertInput(object):
 
         self._state = state
 
+    @property
+    def tags(self):
+        """Gets the tags of this SubjectUpsertInput.
+
+
+        :return: The tags of this SubjectUpsertInput.
+        :rtype: list[str]
+        """
+        return self._tags
+
+    @tags.setter
+    def tags(self, tags):
+        """Sets the tags of this SubjectUpsertInput.
+
+
+        :param tags: The tags of this SubjectUpsertInput.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._tags = tags
+
 
     @staticmethod
     def positional_to_model(value):