flywheel-sdk 21.2.0__py3-none-any.whl

flywheel/models/gear_input_item.py

@@ -0,0 +1,231 @@
+# 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 typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from flywheel.models.gear_directive import GearDirective  # noqa: F401,E501
+
+class GearInputItem(object):
+
+    swagger_types = {
+        'base': 'str',
+        'description': 'str',
+        'optional': 'bool'
+    }
+
+    attribute_map = {
+        'base': 'base',
+        'description': 'description',
+        'optional': 'optional'
+    }
+
+    rattribute_map = {
+        'base': 'base',
+        'description': 'description',
+        'optional': 'optional'
+    }
+
+    def __init__(self, base=None, description=None, optional=None):  # noqa: E501
+        """GearInputItem - a model defined in Swagger"""
+        super(GearInputItem, self).__init__()
+
+        self._base = None
+        self._description = None
+        self._optional = None
+        self.discriminator = None
+        self.alt_discriminator = None
+
+        self.base = base
+        if description is not None:
+            self.description = description
+        if optional is not None:
+            self.optional = optional
+
+    @property
+    def base(self):
+        """Gets the base of this GearInputItem.
+
+        The type of gear input.
+
+        :return: The base of this GearInputItem.
+        :rtype: str
+        """
+        return self._base
+
+    @base.setter
+    def base(self, base):
+        """Sets the base of this GearInputItem.
+
+        The type of gear input.
+
+        :param base: The base of this GearInputItem.  # noqa: E501
+        :type: str
+        """
+
+        self._base = base
+
+    @property
+    def description(self):
+        """Gets the description of this GearInputItem.
+
+        Hackaround for description not technically being a schema directive
+
+        :return: The description of this GearInputItem.
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """Sets the description of this GearInputItem.
+
+        Hackaround for description not technically being a schema directive
+
+        :param description: The description of this GearInputItem.  # noqa: E501
+        :type: str
+        """
+
+        self._description = description
+
+    @property
+    def optional(self):
+        """Gets the optional of this GearInputItem.
+
+        Allow the gear to mark an input file as optional.
+
+        :return: The optional of this GearInputItem.
+        :rtype: bool
+        """
+        return self._optional
+
+    @optional.setter
+    def optional(self, optional):
+        """Sets the optional of this GearInputItem.
+
+        Allow the gear to mark an input file as optional.
+
+        :param optional: The optional of this GearInputItem.  # noqa: E501
+        :type: bool
+        """
+
+        self._optional = optional
+
+
+    @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"""
+        # Import relatives
+        from flywheel.models.gear_file_input import GearFileInput
+        relatives = (
+            GearFileInput,
+        )
+        if not isinstance(other, relatives + (GearInputItem,)):
+            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/gear_inputs.py

@@ -0,0 +1,140 @@
+# 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 typing import TYPE_CHECKING
+
+class GearInputs(object):
+
+    swagger_types = {
+    }
+
+    attribute_map = {
+    }
+
+    rattribute_map = {
+    }
+
+    def __init__(self):  # noqa: E501
+        """GearInputs - a model defined in Swagger"""
+        super(GearInputs, self).__init__()
+        self.discriminator = None
+        self.alt_discriminator = None
+
+
+    @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"""
+        # Import relatives
+        from flywheel.models.gear_file_input import GearFileInput
+        relatives = (
+            GearFileInput,
+        )
+        if not isinstance(other, relatives + (GearInputs,)):
+            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/gear_invocation.py

@@ -0,0 +1,138 @@
+"""Provides gear invocation support"""
+
+from .. import util
+
+
+class GearInvocation(object):
+    """Represents the details necessary to execute a gear as a job"""
+
+    def __init__(self, gear):
+        self.gear = gear
+
+        # Setup default config
+        self.config = gear.get_default_config()
+
+        self.inputs = {}
+        self.destination = None
+        self.analysis_label = None
+        self.tags = []
+        self.priority = "medium"
+
+        self.__context = None
+
+    def _set_context(self, context):
+        self.__context = context
+
+    def update_config(self, *args, **kwargs):
+        """Update configuration values"""
+        body = util.params_to_dict("update_config", args, kwargs)
+        self.config.update(body)
+
+    def set_analysis_label(self, label):
+        """Set the analysis label, if executing an analysis gear"""
+        if not self.gear.is_analysis_gear():
+            raise ValueError("{} is not an analysis gear!".format(self.gear.gear.name))
+        self.analysis_label = label
+
+    def add_tag(self, tag):
+        """Add a tag to the job"""
+        if tag not in self.tags:
+            self.tags.append(tag)
+
+    def add_tags(self, tags):
+        """Add multiple tags to the job"""
+        self.tags += tags
+
+    def set_input(self, key, input):
+        """Add an input"""
+        self.inputs[key] = util.to_ref(input)
+
+    def set_destination(self, dest):
+        """Set the destination container"""
+        self.destination = util.to_ref(dest)
+
+    def set_priority(self, priority):
+        """Set the priority of gear job"""
+        self.priority = priority
+
+    def run(self):
+        """Run the invocation as a single job (or analysis).
+
+        Requires that required inputs and the destination have been set.
+
+        Returns the job id, or the analysis id in the case of an analysis gear.
+        """
+        from flywheel.models import Job
+
+        job = Job(
+            gear_id=self.gear.id,
+            inputs=self.inputs,
+            destination=self.destination,
+            config=self.config,
+            tags=self.tags,
+            priority=self.priority,
+        )
+
+        if self.gear.is_analysis_gear():
+            # Create a new analysis object using label and job object
+            return self._add_analysis(job)
+
+        # Otherwise, just create the job
+        return self.__context.add_job(job)
+
+    def propose_batch(self, containers, optional_input_policy="ignored"):
+        """Create a batch run proposal for the given containers
+
+        :param list containers: The list of containers to run the job on
+        :param str optional_input_policy: The optional input policy (default is ignored)
+        """
+        from flywheel.models import AnalysisInput, BatchProposalInput
+
+        targets = [util.to_ref(input) for input in containers]
+
+        if self.gear.is_analysis_gear():
+            analysis_label = self.analysis_label or self._make_default_label()
+            analysis = AnalysisInput(label=analysis_label)
+        else:
+            analysis = None
+
+        proposal = BatchProposalInput(
+            gear_id=self.gear.id,
+            config=self.config,
+            tags=self.tags,
+            optional_input_policy=optional_input_policy,
+            analysis=analysis,
+            targets=targets,
+            priority=self.priority,
+        )
+
+        return self.__context.propose_batch(proposal)
+
+    def _make_default_label(self):
+        """Create a default label for an analysis run"""
+        from datetime import datetime
+
+        timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+        return "{} {}".format(self.gear.gear.name, timestamp)
+
+    def _add_analysis(self, job):
+        """Add an analysis to the destination container"""
+        from flywheel.models import AnalysisInput
+
+        # Ensure a valid analysis label
+        analysis_label = self.analysis_label or self._make_default_label()
+
+        # Get destination type (from ref)
+        dest_id = self.destination and self.destination.get("id")
+        dest_type = self.destination and self.destination.get("type")
+        if not dest_id or not dest_type:
+            raise ValueError("Must specify a valid destination to create an analysis!")
+
+        fname = "add_{}_analysis".format(dest_type)
+        fn = getattr(self.__context, fname, None)
+        if not fn:
+            raise ValueError("{} is not a function!".format(fname))
+
+        # Ensure destination is unset
+        job.destination = None
+        return fn(dest_id, AnalysisInput(label=analysis_label, job=job))

flywheel/models/gear_key_input.py

@@ -0,0 +1,191 @@
+# 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 typing import TYPE_CHECKING
+
+class GearKeyInput(object):
+
+    swagger_types = {
+        'base': 'str',
+        'read_only': 'bool'
+    }
+
+    attribute_map = {
+        'base': 'base',
+        'read_only': 'read-only'
+    }
+
+    rattribute_map = {
+        'base': 'base',
+        'read-only': 'read_only'
+    }
+
+    def __init__(self, base='api-key', read_only=False):  # noqa: E501
+        """GearKeyInput - a model defined in Swagger"""
+        super(GearKeyInput, self).__init__()
+
+        self._base = None
+        self._read_only = None
+        self.discriminator = None
+        self.alt_discriminator = None
+
+        if base is not None:
+            self.base = base
+        if read_only is not None:
+            self.read_only = read_only
+
+    @property
+    def base(self):
+        """Gets the base of this GearKeyInput.
+
+
+        :return: The base of this GearKeyInput.
+        :rtype: str
+        """
+        return self._base
+
+    @base.setter
+    def base(self, base):
+        """Sets the base of this GearKeyInput.
+
+
+        :param base: The base of this GearKeyInput.  # noqa: E501
+        :type: str
+        """
+
+        self._base = base
+
+    @property
+    def read_only(self):
+        """Gets the read_only of this GearKeyInput.
+
+
+        :return: The read_only of this GearKeyInput.
+        :rtype: bool
+        """
+        return self._read_only
+
+    @read_only.setter
+    def read_only(self, read_only):
+        """Sets the read_only of this GearKeyInput.
+
+
+        :param read_only: The read_only of this GearKeyInput.  # noqa: E501
+        :type: bool
+        """
+
+        self._read_only = read_only
+
+
+    @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, GearKeyInput):
+            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