dtlpy 1.113.10__py3-none-any.whl → 1.114.13__py3-none-any.whl

dtlpy/entities/app.py

@@ -1,220 +1,220 @@
-from collections import namedtuple
-import traceback
-import logging
-from enum import Enum
-
-import attr
-
-from .. import entities, repositories
-from ..services.api_client import ApiClient
-
-logger = logging.getLogger(name='dtlpy')
-
-
-class AppScope(str, Enum):
-    """ The scope of the app.
-
-    .. list-table::
-       :widths: 15 150
-       :header-rows: 1
-
-       * - State
-         - Description
-       * - SYSTEM
-         - Dataloop internal app
-       * - PROJECT
-         - Project app
-    """
-    SYSTEM = 'system'
-    PROJECT = 'project'
-
-
-@attr.s
-class App(entities.BaseEntity):
-    id = attr.ib(type=str)
-    name = attr.ib(type=str)
-    url = attr.ib(type=str)
-    created_at = attr.ib(type=str)
-    updated_at = attr.ib(type=str)
-    creator = attr.ib(type=str)
-    project_id = attr.ib(type=str)
-    org_id = attr.ib(type=str)
-    dpk_name = attr.ib(type=str)
-    dpk_version = attr.ib(type=str)
-    composition_id = attr.ib(type=str)
-    scope = attr.ib(type=str)
-    routes = attr.ib(type=dict)
-    custom_installation = attr.ib(type=dict)
-    metadata = attr.ib(type=dict)
-    status = attr.ib(type=entities.CompositionStatus)
-    settings = attr.ib(type=dict)
-
-    # sdk
-    _project = attr.ib(type=entities.Project, repr=False)
-    _client_api = attr.ib(type=ApiClient, repr=False)
-    _repositories = attr.ib(repr=False)
-    integrations = attr.ib(type=list, default=None)
-
-    @_repositories.default
-    def set_repositories(self):
-        reps = namedtuple('repositories', field_names=['projects', 'apps', 'compositions'])
-        return reps(
-            projects=repositories.Projects(client_api=self._client_api),
-            apps=repositories.Apps(client_api=self._client_api, project=self._project, project_id=self.project_id),
-            compositions=repositories.Compositions(client_api=self._client_api, project=self._project)
-        )
-
-    @property
-    def project(self):
-        if self._project is None:
-            self._project = self.projects.get(project_id=self.project_id)
-        return self._project
-
-    @property
-    def projects(self):
-        assert isinstance(self._repositories.projects, repositories.Projects)
-        return self._repositories.projects
-
-    @property
-    def apps(self):
-        assert isinstance(self._repositories.apps, repositories.Apps)
-        return self._repositories.apps
-
-    @property
-    def compositions(self):
-        assert isinstance(self._repositories.compositions, repositories.Compositions)
-        return self._repositories.compositions
-
-    def uninstall(self):
-        """
-        Uninstall an app installed app from the project.
-
-        **Example**
-        .. code-block:: python
-            succeed = app.uninstall()
-        """
-        return self.apps.uninstall(self.id)
-
-    def update(self):
-        """
-        Update the current app to the new configuration
-
-        :return bool whether the operation ran successfully or not
-
-        **Example**
-        .. code-block:: python
-            succeed = app.update()
-        """
-        return self.apps.update(self)
-
-    def resume(self):
-        """
-        Resume the current app
-
-        :return bool whether the operation ran successfully or not
-
-        **Example**
-        .. code-block:: python
-            succeed = app.resume()
-        """
-        return self.apps.resume(self)
-
-    def pause(self):
-        """
-        Pause the current app
-
-        :return bool whether the operation ran successfully or not
-
-        **Example**
-        .. code-block:: python
-            succeed = app.pause()
-        """
-        return self.apps.pause(self)
-
-    @staticmethod
-    def _protected_from_json(_json, client_api, project=None, is_fetched=True):
-        """
-        Same as from_json but with try-except to catch if error
-
-        :param _json:  platform json
-        :param client_api: ApiClient entity
-        :return:
-        """
-        try:
-            package = App.from_json(_json=_json,
-                                    client_api=client_api,
-                                    project=project,
-                                    is_fetched=is_fetched)
-            status = True
-        except Exception:
-            package = traceback.format_exc()
-            status = False
-        return status, package
-
-    def to_json(self):
-        _json = {}
-        if self.id is not None:
-            _json['id'] = self.id
-        if self.name is not None:
-            _json['name'] = self.name
-        if self.url is not None:
-            _json['url'] = self.url
-        if self.created_at is not None:
-            _json['createdAt'] = self.created_at
-        if self.updated_at is not None:
-            _json['updatedAt'] = self.updated_at
-        if self.creator is not None:
-            _json['creator'] = self.creator
-        if self.project_id is not None:
-            _json['projectId'] = self.project_id
-        if self.org_id is not None:
-            _json['orgId'] = self.org_id
-        if self.dpk_name is not None:
-            _json['dpkName'] = self.dpk_name
-        if self.dpk_version is not None:
-            _json['dpkVersion'] = self.dpk_version
-        if self.composition_id is not None:
-            _json['compositionId'] = self.composition_id
-        if self.scope is not None:
-            _json['scope'] = self.scope
-        if self.routes != {}:
-            _json['routes'] = self.routes
-        if self.custom_installation != {}:
-            _json['customInstallation'] = self.custom_installation
-        if self.metadata is not None:
-            _json['metadata'] = self.metadata
-        if self.status is not None:
-            _json['status'] = self.status
-        if self.settings != {}:
-            _json['settings'] = self.settings
-        if self.integrations is not None:
-            _json['integrations'] = self.integrations
-
-        return _json
-
-    @classmethod
-    def from_json(cls, _json, client_api: ApiClient, project: entities.Project=None, is_fetched=True):
-        app = cls(
-            id=_json.get('id', None),
-            name=_json.get('name', None),
-            url=_json.get('url', None),
-            created_at=_json.get('createdAt', None),
-            updated_at=_json.get('updatedAt', None),
-            creator=_json.get('creator', None),
-            project_id=_json.get('projectId', None),
-            org_id=_json.get('orgId', None),
-            dpk_name=_json.get('dpkName', None),
-            dpk_version=_json.get('dpkVersion', None),
-            composition_id=_json.get('compositionId', None),
-            scope=_json.get('scope', None),
-            routes=_json.get('routes', {}),
-            custom_installation=_json.get('customInstallation', {}),
-            client_api=client_api,
-            project=project,
-            metadata=_json.get('metadata', None),
-            status=_json.get('status', None),
-            settings=_json.get('settings', {}),
-            integrations=_json.get('integrations', None)
-        )
-        app.is_fetched = is_fetched
-        return app
+from collections import namedtuple
+import traceback
+import logging
+from enum import Enum
+
+import attr
+
+from .. import entities, repositories
+from ..services.api_client import ApiClient
+
+logger = logging.getLogger(name='dtlpy')
+
+
+class AppScope(str, Enum):
+    """ The scope of the app.
+
+    .. list-table::
+       :widths: 15 150
+       :header-rows: 1
+
+       * - State
+         - Description
+       * - SYSTEM
+         - Dataloop internal app
+       * - PROJECT
+         - Project app
+    """
+    SYSTEM = 'system'
+    PROJECT = 'project'
+
+
+@attr.s
+class App(entities.BaseEntity):
+    id = attr.ib(type=str)
+    name = attr.ib(type=str)
+    url = attr.ib(type=str)
+    created_at = attr.ib(type=str)
+    updated_at = attr.ib(type=str)
+    creator = attr.ib(type=str)
+    project_id = attr.ib(type=str)
+    org_id = attr.ib(type=str)
+    dpk_name = attr.ib(type=str)
+    dpk_version = attr.ib(type=str)
+    composition_id = attr.ib(type=str)
+    scope = attr.ib(type=str)
+    routes = attr.ib(type=dict)
+    custom_installation = attr.ib(type=dict)
+    metadata = attr.ib(type=dict)
+    status = attr.ib(type=entities.CompositionStatus)
+    settings = attr.ib(type=dict)
+
+    # sdk
+    _project = attr.ib(type=entities.Project, repr=False)
+    _client_api = attr.ib(type=ApiClient, repr=False)
+    _repositories = attr.ib(repr=False)
+    integrations = attr.ib(type=list, default=None)
+
+    @_repositories.default
+    def set_repositories(self):
+        reps = namedtuple('repositories', field_names=['projects', 'apps', 'compositions'])
+        return reps(
+            projects=repositories.Projects(client_api=self._client_api),
+            apps=repositories.Apps(client_api=self._client_api, project=self._project, project_id=self.project_id),
+            compositions=repositories.Compositions(client_api=self._client_api, project=self._project)
+        )
+
+    @property
+    def project(self):
+        if self._project is None:
+            self._project = self.projects.get(project_id=self.project_id)
+        return self._project
+
+    @property
+    def projects(self):
+        assert isinstance(self._repositories.projects, repositories.Projects)
+        return self._repositories.projects
+
+    @property
+    def apps(self):
+        assert isinstance(self._repositories.apps, repositories.Apps)
+        return self._repositories.apps
+
+    @property
+    def compositions(self):
+        assert isinstance(self._repositories.compositions, repositories.Compositions)
+        return self._repositories.compositions
+
+    def uninstall(self):
+        """
+        Uninstall an app installed app from the project.
+
+        **Example**
+        .. code-block:: python
+            succeed = app.uninstall()
+        """
+        return self.apps.uninstall(self.id)
+
+    def update(self):
+        """
+        Update the current app to the new configuration
+
+        :return bool whether the operation ran successfully or not
+
+        **Example**
+        .. code-block:: python
+            succeed = app.update()
+        """
+        return self.apps.update(self)
+
+    def resume(self):
+        """
+        Resume the current app
+
+        :return bool whether the operation ran successfully or not
+
+        **Example**
+        .. code-block:: python
+            succeed = app.resume()
+        """
+        return self.apps.resume(self)
+
+    def pause(self):
+        """
+        Pause the current app
+
+        :return bool whether the operation ran successfully or not
+
+        **Example**
+        .. code-block:: python
+            succeed = app.pause()
+        """
+        return self.apps.pause(self)
+
+    @staticmethod
+    def _protected_from_json(_json, client_api, project=None, is_fetched=True):
+        """
+        Same as from_json but with try-except to catch if error
+
+        :param _json:  platform json
+        :param client_api: ApiClient entity
+        :return:
+        """
+        try:
+            package = App.from_json(_json=_json,
+                                    client_api=client_api,
+                                    project=project,
+                                    is_fetched=is_fetched)
+            status = True
+        except Exception:
+            package = traceback.format_exc()
+            status = False
+        return status, package
+
+    def to_json(self):
+        _json = {}
+        if self.id is not None:
+            _json['id'] = self.id
+        if self.name is not None:
+            _json['name'] = self.name
+        if self.url is not None:
+            _json['url'] = self.url
+        if self.created_at is not None:
+            _json['createdAt'] = self.created_at
+        if self.updated_at is not None:
+            _json['updatedAt'] = self.updated_at
+        if self.creator is not None:
+            _json['creator'] = self.creator
+        if self.project_id is not None:
+            _json['projectId'] = self.project_id
+        if self.org_id is not None:
+            _json['orgId'] = self.org_id
+        if self.dpk_name is not None:
+            _json['dpkName'] = self.dpk_name
+        if self.dpk_version is not None:
+            _json['dpkVersion'] = self.dpk_version
+        if self.composition_id is not None:
+            _json['compositionId'] = self.composition_id
+        if self.scope is not None:
+            _json['scope'] = self.scope
+        if self.routes != {}:
+            _json['routes'] = self.routes
+        if self.custom_installation != {}:
+            _json['customInstallation'] = self.custom_installation
+        if self.metadata is not None:
+            _json['metadata'] = self.metadata
+        if self.status is not None:
+            _json['status'] = self.status
+        if self.settings != {}:
+            _json['settings'] = self.settings
+        if self.integrations is not None:
+            _json['integrations'] = self.integrations
+
+        return _json
+
+    @classmethod
+    def from_json(cls, _json, client_api: ApiClient, project: entities.Project=None, is_fetched=True):
+        app = cls(
+            id=_json.get('id', None),
+            name=_json.get('name', None),
+            url=_json.get('url', None),
+            created_at=_json.get('createdAt', None),
+            updated_at=_json.get('updatedAt', None),
+            creator=_json.get('creator', None),
+            project_id=_json.get('projectId', None),
+            org_id=_json.get('orgId', None),
+            dpk_name=_json.get('dpkName', None),
+            dpk_version=_json.get('dpkVersion', None),
+            composition_id=_json.get('compositionId', None),
+            scope=_json.get('scope', None),
+            routes=_json.get('routes', {}),
+            custom_installation=_json.get('customInstallation', {}),
+            client_api=client_api,
+            project=project,
+            metadata=_json.get('metadata', None),
+            status=_json.get('status', None),
+            settings=_json.get('settings', {}),
+            integrations=_json.get('integrations', None)
+        )
+        app.is_fetched = is_fetched
+        return app

dtlpy/entities/app_module.py

@@ -1,107 +1,107 @@
-import logging
-import typing
-from enum import Enum
-
-from .. import entities, utilities
-
-logger = logging.getLogger(name='dtlpy')
-
-
-class AppModule(entities.PackageModule, utilities.BaseServiceRunner):
-    def __init__(self, name, description):
-        super(AppModule, self).__init__()
-        self.name = name
-        self.description = description
-
-    def init(self):
-        """
-        Default init function
-        :return:
-        """
-        ...
-
-    ###############
-    # Decorators #
-    ###############
-    def set_init(self, inputs=None):
-        def decorator(func: typing.Callable):
-            setattr(self, 'init', func)
-            setattr(self, func.__name__, func)
-            init_inputs, _ = self._function_io_from_def(func=func, inputs=inputs, outputs=None)
-            self.init_inputs = AppModule._parse_io(io_list=init_inputs)
-            return func
-
-        return decorator
-
-    def add_function(self, display_name=None, inputs=None, outputs=None):
-        """
-        Add a function to the instance to be able to run in the FaaS.
-
-        :param display_name: Display name of the function
-        :param inputs: function inputs variable definitions. dictionary with strings for name and type {name: type}
-        :param outputs: function output variable definitions. dictionary with strings for name and type {name: type}
-        :return:
-        """
-
-        def decorator(func: typing.Callable):
-            if display_name is None:
-                d_name = func.__name__
-            else:
-                d_name = display_name
-            module_inputs, module_outputs = self._function_io_from_def(func=func, inputs=inputs, outputs=outputs)
-            defs = {"name": func.__name__,
-                    "displayName": d_name,
-                    "input": AppModule._parse_io(io_list=module_inputs),
-                    "output": AppModule._parse_io(io_list=module_outputs)}
-            func.__dtlpy__ = defs
-            setattr(self, func.__name__, func)
-            self.functions.append(entities.PackageFunction.from_json(defs))
-            return func
-
-        return decorator
-
-    #########
-    # Utils #
-    #########
-    @staticmethod
-    def _function_io_from_def(func, inputs, outputs):
-        input_types = typing.get_type_hints(func)
-        hint_outputs = input_types.pop('return', None)
-
-        if outputs is None:
-            if hint_outputs is not None:
-                func_outputs = {'output': hint_outputs}
-            else:
-                func_outputs = dict()
-        else:
-            func_outputs = outputs
-        if inputs is None:
-            func_inputs = {name: t for name, t in input_types.items()}
-        else:
-            func_inputs = inputs
-        return func_inputs, func_outputs
-
-    @staticmethod
-    def _function_type_mapping(io_type):
-        mapping = {'str': entities.PackageInputType.STRING}
-        if io_type in mapping:
-            return mapping[io_type]
-        else:
-            return io_type
-
-    @staticmethod
-    def _parse_io(io_list: dict):
-        output = list()
-        if io_list is not None:
-            for io_name, io_type in io_list.items():
-                if isinstance(io_type, Enum):
-                    io_type = io_type.name
-                if hasattr(io_type, '__args__'):
-                    io_type = io_type.__args__[0]
-                if isinstance(io_type, type):
-                    io_type = io_type.__name__
-                else:
-                    io_type = str(io_type)
-                output.append({"name": io_name,
-                               "type": AppModule._function_type_mapping(str(io_type))})
-        return output
+import logging
+import typing
+from enum import Enum
+
+from .. import entities, utilities
+
+logger = logging.getLogger(name='dtlpy')
+
+
+class AppModule(entities.PackageModule, utilities.BaseServiceRunner):
+    def __init__(self, name, description):
+        super(AppModule, self).__init__()
+        self.name = name
+        self.description = description
+
+    def init(self):
+        """
+        Default init function
+        :return:
+        """
+        ...
+
+    ###############
+    # Decorators #
+    ###############
+    def set_init(self, inputs=None):
+        def decorator(func: typing.Callable):
+            setattr(self, 'init', func)
+            setattr(self, func.__name__, func)
+            init_inputs, _ = self._function_io_from_def(func=func, inputs=inputs, outputs=None)
+            self.init_inputs = AppModule._parse_io(io_list=init_inputs)
+            return func
+
+        return decorator
+
+    def add_function(self, display_name=None, inputs=None, outputs=None):
+        """
+        Add a function to the instance to be able to run in the FaaS.
+
+        :param display_name: Display name of the function
+        :param inputs: function inputs variable definitions. dictionary with strings for name and type {name: type}
+        :param outputs: function output variable definitions. dictionary with strings for name and type {name: type}
+        :return:
+        """
+
+        def decorator(func: typing.Callable):
+            if display_name is None:
+                d_name = func.__name__
+            else:
+                d_name = display_name
+            module_inputs, module_outputs = self._function_io_from_def(func=func, inputs=inputs, outputs=outputs)
+            defs = {"name": func.__name__,
+                    "displayName": d_name,
+                    "input": AppModule._parse_io(io_list=module_inputs),
+                    "output": AppModule._parse_io(io_list=module_outputs)}
+            func.__dtlpy__ = defs
+            setattr(self, func.__name__, func)
+            self.functions.append(entities.PackageFunction.from_json(defs))
+            return func
+
+        return decorator
+
+    #########
+    # Utils #
+    #########
+    @staticmethod
+    def _function_io_from_def(func, inputs, outputs):
+        input_types = typing.get_type_hints(func)
+        hint_outputs = input_types.pop('return', None)
+
+        if outputs is None:
+            if hint_outputs is not None:
+                func_outputs = {'output': hint_outputs}
+            else:
+                func_outputs = dict()
+        else:
+            func_outputs = outputs
+        if inputs is None:
+            func_inputs = {name: t for name, t in input_types.items()}
+        else:
+            func_inputs = inputs
+        return func_inputs, func_outputs
+
+    @staticmethod
+    def _function_type_mapping(io_type):
+        mapping = {'str': entities.PackageInputType.STRING}
+        if io_type in mapping:
+            return mapping[io_type]
+        else:
+            return io_type
+
+    @staticmethod
+    def _parse_io(io_list: dict):
+        output = list()
+        if io_list is not None:
+            for io_name, io_type in io_list.items():
+                if isinstance(io_type, Enum):
+                    io_type = io_type.name
+                if hasattr(io_type, '__args__'):
+                    io_type = io_type.__args__[0]
+                if isinstance(io_type, type):
+                    io_type = io_type.__name__
+                else:
+                    io_type = str(io_type)
+                output.append({"name": io_name,
+                               "type": AppModule._function_type_mapping(str(io_type))})
+        return output