flywheel-sdk 21.2.0rc0__py3-none-any.whl

flywheel/models/gear_mixin.py

@@ -0,0 +1,218 @@
+"""Provides gear mixin"""
+
+from .gear_invocation import GearInvocation
+
+
+class GearMixin(object):
+    """Gear mixin that provides additional functionality"""
+
+    def __init__(self):
+        self.__context = None
+
+    def _set_context(self, context):
+        """Set the context object (i.e. flywheel client instance)"""
+        self.__context = context
+
+    def _invoke_gear_api(self, fname, *args, **kwargs):
+        """Invoke gear api"""
+        if self.__context:
+            fn = getattr(self.__context, fname, None)
+            if fn:
+                return fn(self.gear.name, *args, **kwargs)
+        return None
+
+    def create_invocation(self):
+        """Create a job invocation object"""
+        result = GearInvocation(self)
+        result._set_context(self.__context)
+        return result
+
+    def is_analysis_gear(self):
+        """Check if this is an analysis gear"""
+        return self.category == "analysis"
+
+    def print_details(self, width=90):
+        """Print details about a gear to stdout
+
+        :param int width: The maximum line width for printing
+        """
+        import textwrap
+
+        def print_wrap(s, **kwargs):
+            print(textwrap.fill(s, width=width, **kwargs))
+
+        def print_col(label, value):
+            line = "{:<15} {}".format(label + ":", value)
+            print(textwrap.fill(line, width=width, subsequent_indent=(" " * 16)))
+
+        gear = self.gear
+
+        print_wrap(gear.label or gear.name)
+
+        if gear.description:
+            print("")
+            print_wrap(gear.description, subsequent_indent="  ")
+            print("")
+
+        print_col("Name", gear.name)
+        print_col("Version", gear.version)
+        print_col("Category", self.category)
+
+        if gear.author:
+            print_col("Author", gear.author)
+
+        if gear.maintainer:
+            print_col("Maintainer", gear.maintainer)
+
+        if gear.url:
+            print_col("URL", gear.url)
+
+        if gear.source:
+            print_col("Source", gear.source)
+
+        print("")
+
+        if gear.inputs:
+            print("Inputs:")
+            for key, spec in gear.inputs.items():
+                if spec.get("optional", False):
+                    opt = "optional"
+                else:
+                    opt = "required"
+
+                print("  {} ({}, {})".format(key, spec.get("base", "unspecified"), opt))
+                if "type" in spec and "enum" in spec["type"]:
+                    types = ", ".join(spec["type"]["enum"])
+                    print("    Type: {}".format(types))
+                if "description" in spec:
+                    print_wrap(
+                        spec["description"],
+                        initial_indent="    ",
+                        subsequent_indent="      ",
+                    )
+            print("")
+
+        if gear.config:
+            print("Configuration:")
+            for key, spec in gear.config.items():
+                if "default" in spec:
+                    dflt = ", default: {}".format(spec["default"])
+                else:
+                    dflt = ""
+                print("  {} ({}{})".format(key, spec.get("type", "unspecified"), dflt))
+                if "description" in spec:
+                    print_wrap(
+                        spec["description"],
+                        initial_indent="    ",
+                        subsequent_indent="      ",
+                    )
+
+    def get_default_config(self):
+        """Get the default configuration for gear"""
+        config = self.gear.get("config", {})
+        default_config = {}
+        for key, value in config.items():
+            if value.get("default") is not None:
+                default_config[key] = value.get("default")
+        return default_config
+
+    def run(self, config=None, analysis_label=None, tags=None, destination=None, inputs=None, priority=None, **kwargs):
+        """Run the gear.
+
+        :param dict config: The configuration to use, if overriding defaults.
+        :param str analysis_label: The label of the analysis, if running an analysis gear.
+        :param list tags: The list of tags to set for the job.
+        :param object destination: The destination container.
+        :param dict inputs: The list of input containers or files.
+
+        :return: The id of the job that was created (utility gear) or of the analysis container created (analysis gear).
+        """
+        invocation = self.create_invocation()
+
+        if config is not None:
+            invocation.update_config(config)
+        if analysis_label is not None:
+            invocation.set_analysis_label(analysis_label)
+        if tags is not None:
+            invocation.add_tags(tags)
+        if destination is not None:
+            invocation.set_destination(destination)
+        if priority is not None:
+            invocation.set_priority(priority)
+
+        # Combine inputs and kwargs into inputs
+        if inputs is not None:
+            kwargs.update(inputs)
+        for key, input in kwargs.items():
+            invocation.set_input(key, input)
+
+        return invocation.run()
+
+    def propose_batch(
+        self,
+        containers,
+        config=None,
+        analysis_label=None,
+        tags=None,
+        priority=None,
+        optional_input_policy="ignored",
+    ):
+        """Propose a batch run of the gear.
+
+        :param list containers: The list of targets.
+        :param dict config: The configuration to use, if overriding defaults.
+        :param str analysis_label: The label of the analysis, if running an analysis gear.
+        :param list tags: The list of tags to set for the job.
+        :param str priority: The priority of the job.
+        :param str optional_input_policy: The optional input policy, default is 'ignored'
+
+        :return: The batch proposal, which can be started with proposal.run()
+        """
+        invocation = self.create_invocation()
+
+        if config is not None:
+            invocation.update_config(config)
+        if analysis_label is not None:
+            invocation.set_analysis_label(analysis_label)
+        if tags is not None:
+            invocation.add_tags(tags)
+        if priority is not None:
+            invocation.set_priority(priority)
+
+        return invocation.propose_batch(containers, optional_input_policy=optional_input_policy)
+
+    def get_series(self):
+        """Get gear series by gear name."""
+        return self._invoke_gear_api("get_gear_series")
+
+    def add_permission(self, permission_type, permission_id):
+        """Add individual permission to gear."""
+        return self._invoke_gear_api("add_gear_permission", permission_type, permission_id)
+
+    def replace_permissions(self, permissions):
+        """Replace gear permissions."""
+        return self._invoke_gear_api("replace_gear_permissions", permissions)
+
+    def delete_permission(self, permission_type, permission_id):
+        """Delete individual permission by type and id"""
+        self._invoke_gear_api("delete_gear_permission", permission_type, permission_id)
+
+    def delete_all_permissions(self):
+        """
+        Delete gear all permissions. Also sets `is_restricted` on the gear
+            series to `False`.
+        """
+        self._invoke_gear_api("delete_gear_permissions")
+
+    def modify_gear_series(self, gear_series_update):
+        """
+        Modify the gear series attributes such as `is_restricted`
+
+        :param GearSeriesUpdate gear_series_update: the dictionary specifying
+            the updates to make to the gear series
+
+        Example::
+            update_dict = {"is_restricted": True}
+            gear.modify_gear_series(update_dict)
+        """
+        return self._invoke_gear_api("modify_gear_series", gear_series_update)

flywheel/models/gear_node.py

@@ -0,0 +1,355 @@
+# 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_category import GearCategory  # noqa: F401,E501
+    from flywheel.models.gear_document import GearDocument  # noqa: F401,E501
+    from flywheel.models.gear_exchange import GearExchange  # noqa: F401,E501
+    from flywheel.models.gear_manifest import GearManifest  # noqa: F401,E501
+    from flywheel.models.resolver_node import ResolverNode  # noqa: F401,E501
+
+from .mixins import GearMixin
+class GearNode(GearMixin):
+
+    swagger_types = {
+        'container_type': 'str',
+        'category': 'GearCategory',
+        'gear': 'GearManifest',
+        'exchange': 'GearExchange',
+        'created': 'datetime',
+        'modified': 'datetime',
+        'disabled': 'datetime',
+        'id': 'str'
+    }
+
+    attribute_map = {
+        'container_type': 'container_type',
+        'category': 'category',
+        'gear': 'gear',
+        'exchange': 'exchange',
+        'created': 'created',
+        'modified': 'modified',
+        'disabled': 'disabled',
+        'id': '_id'
+    }
+
+    rattribute_map = {
+        'container_type': 'container_type',
+        'category': 'category',
+        'gear': 'gear',
+        'exchange': 'exchange',
+        'created': 'created',
+        'modified': 'modified',
+        'disabled': 'disabled',
+        '_id': 'id'
+    }
+
+    def __init__(self, container_type=None, category=None, gear=None, exchange=None, created=None, modified=None, disabled=None, id=None):  # noqa: E501
+        """GearNode - a model defined in Swagger"""
+        super(GearNode, self).__init__()
+
+        self._container_type = None
+        self._category = None
+        self._gear = None
+        self._exchange = None
+        self._created = None
+        self._modified = None
+        self._disabled = None
+        self._id = None
+        self.discriminator = None
+        self.alt_discriminator = None
+
+        self.container_type = container_type
+        if category is not None:
+            self.category = category
+        self.gear = gear
+        self.exchange = exchange
+        self.created = created
+        self.modified = modified
+        if disabled is not None:
+            self.disabled = disabled
+        self.id = id
+
+    @property
+    def container_type(self):
+        """Gets the container_type of this GearNode.
+
+
+        :return: The container_type of this GearNode.
+        :rtype: str
+        """
+        return self._container_type
+
+    @container_type.setter
+    def container_type(self, container_type):
+        """Sets the container_type of this GearNode.
+
+
+        :param container_type: The container_type of this GearNode.  # noqa: E501
+        :type: str
+        """
+
+        self._container_type = container_type
+
+    @property
+    def category(self):
+        """Gets the category of this GearNode.
+
+
+        :return: The category of this GearNode.
+        :rtype: GearCategory
+        """
+        return self._category
+
+    @category.setter
+    def category(self, category):
+        """Sets the category of this GearNode.
+
+
+        :param category: The category of this GearNode.  # noqa: E501
+        :type: GearCategory
+        """
+
+        self._category = category
+
+    @property
+    def gear(self):
+        """Gets the gear of this GearNode.
+
+
+        :return: The gear of this GearNode.
+        :rtype: GearManifest
+        """
+        return self._gear
+
+    @gear.setter
+    def gear(self, gear):
+        """Sets the gear of this GearNode.
+
+
+        :param gear: The gear of this GearNode.  # noqa: E501
+        :type: GearManifest
+        """
+
+        self._gear = gear
+
+    @property
+    def exchange(self):
+        """Gets the exchange of this GearNode.
+
+
+        :return: The exchange of this GearNode.
+        :rtype: GearExchange
+        """
+        return self._exchange
+
+    @exchange.setter
+    def exchange(self, exchange):
+        """Sets the exchange of this GearNode.
+
+
+        :param exchange: The exchange of this GearNode.  # noqa: E501
+        :type: GearExchange
+        """
+
+        self._exchange = exchange
+
+    @property
+    def created(self):
+        """Gets the created of this GearNode.
+
+
+        :return: The created of this GearNode.
+        :rtype: datetime
+        """
+        return self._created
+
+    @created.setter
+    def created(self, created):
+        """Sets the created of this GearNode.
+
+
+        :param created: The created of this GearNode.  # noqa: E501
+        :type: datetime
+        """
+
+        self._created = created
+
+    @property
+    def modified(self):
+        """Gets the modified of this GearNode.
+
+
+        :return: The modified of this GearNode.
+        :rtype: datetime
+        """
+        return self._modified
+
+    @modified.setter
+    def modified(self, modified):
+        """Sets the modified of this GearNode.
+
+
+        :param modified: The modified of this GearNode.  # noqa: E501
+        :type: datetime
+        """
+
+        self._modified = modified
+
+    @property
+    def disabled(self):
+        """Gets the disabled of this GearNode.
+
+
+        :return: The disabled of this GearNode.
+        :rtype: datetime
+        """
+        return self._disabled
+
+    @disabled.setter
+    def disabled(self, disabled):
+        """Sets the disabled of this GearNode.
+
+
+        :param disabled: The disabled of this GearNode.  # noqa: E501
+        :type: datetime
+        """
+
+        self._disabled = disabled
+
+    @property
+    def id(self):
+        """Gets the id of this GearNode.
+
+
+        :return: The id of this GearNode.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this GearNode.
+
+
+        :param id: The id of this GearNode.  # noqa: E501
+        :type: str
+        """
+
+        self._id = id
+
+
+    @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, GearNode):
+            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