dtlpy 1.114.17__py3-none-any.whl → 1.116.6__py3-none-any.whl

dtlpy/entities/gis_item.py

@@ -1,108 +1,108 @@
-import json
-from typing import List
-import logging
-import os
-
-logger = logging.getLogger(name='dtlpy')
-
-
-class Layer:
-    def __init__(self, name, layer_type, url):
-        self.name = name
-        self.type = layer_type
-        self.url = url
-
-
-class ItemGis:
-    def __init__(self,
-                 name: str,
-                 data: dict = None,
-                 layer: Layer = None,
-                 optional_layers: List[Layer] = None,
-                 zoom: int = None,
-                 min_zoom: int = None,
-                 max_zoom: int = None,
-                 epsg: str = None,
-                 bounds: list = None,
-                 aoi: list = None):
-        self.name = name
-
-        self.layer = layer or Layer(name=data.get('name', None), layer_type=data.get('type', None),
-                                    url=data.get('url', None))
-        if self.layer is None:
-            raise ValueError('layer is required')
-        elif self.layer is not None and isinstance(self.layer, dict):
-            self.layer = Layer(name=self.layer.get('name', None), layer_type=self.layer.get('type', None), url=self.layer.get('url', None))
-
-
-        self.optional_layers = optional_layers or [
-            Layer(name=layer.get('name', None), layer_type=layer.get('type', None), url=layer.get('url', None)) for
-            layer in data.get('optionalLayers', [])]
-
-        if self.optional_layers is not None and isinstance(optional_layers, list):
-            new_optional_layers = []
-            for op_layer in self.optional_layers:
-                if isinstance(op_layer, dict):
-                    new_optional_layers.append(Layer(name=op_layer.get('name', None), layer_type=op_layer.get('type', None), url=op_layer.get('url', None)))
-                else:
-                    new_optional_layers.append(op_layer)
-            self.optional_layers = new_optional_layers
-
-        self.epsg = epsg or data.get('epsg', None)
-        if self.epsg is None:
-            raise ValueError('epsg is required')
-
-        self.zoom = zoom or data.get('zoom', None)
-        self.min_zoom = min_zoom or data.get('minZoom', None)
-        self.max_zoom = max_zoom or data.get('maxZoom', None)
-        self.bounds = bounds or data.get('bounds', None)
-        self.aoi = aoi or data.get('aoi', None)
-
-    def to_json(self):
-        _json = {
-            "type": "gis",
-            "shebang": "dataloop",
-            "metadata": {
-                "dltype": "gis"
-            },
-            'layer': {
-                'name': self.layer.name,
-                'type': self.layer.type,
-                'url': self.layer.url
-            },
-            "epsg": self.epsg
-        }
-        if self.optional_layers is not None:
-            _json['optionalLayers'] = [
-                {
-                    'name': layer.name,
-                    'type': layer.type,
-                    'url': layer.url
-                } for layer in self.optional_layers
-            ]
-        if self.zoom is not None:
-            _json['zoom'] = self.zoom
-        if self.min_zoom is not None:
-            _json['minZoom'] = self.min_zoom
-        if self.max_zoom is not None:
-            _json['maxZoom'] = self.max_zoom
-        if self.bounds is not None:
-            _json['bounds'] = self.bounds
-        if self.aoi is not None:
-            _json['aoi'] = self.aoi
-        return _json
-
-    @classmethod
-    def from_local_file(cls, filepath):
-        """
-        Create a new prompt item from a file
-        :param filepath: path to the file
-        :return: PromptItem object
-        """
-        if os.path.exists(filepath) is False:
-            raise FileNotFoundError(f'File does not exists: {filepath}')
-        if 'json' not in os.path.splitext(filepath)[-1]:
-            raise ValueError(f'Expected path to json item, got {os.path.splitext(filepath)[-1]}')
-        with open(filepath, 'r', encoding='utf-8') as f:
-            data = json.load(f)
+import json
+from typing import List
+import logging
+import os
+
+logger = logging.getLogger(name='dtlpy')
+
+
+class Layer:
+    def __init__(self, name, layer_type, url):
+        self.name = name
+        self.type = layer_type
+        self.url = url
+
+
+class ItemGis:
+    def __init__(self,
+                 name: str,
+                 data: dict = None,
+                 layer: Layer = None,
+                 optional_layers: List[Layer] = None,
+                 zoom: int = None,
+                 min_zoom: int = None,
+                 max_zoom: int = None,
+                 epsg: str = None,
+                 bounds: list = None,
+                 aoi: list = None):
+        self.name = name
+
+        self.layer = layer or Layer(name=data.get('name', None), layer_type=data.get('type', None),
+                                    url=data.get('url', None))
+        if self.layer is None:
+            raise ValueError('layer is required')
+        elif self.layer is not None and isinstance(self.layer, dict):
+            self.layer = Layer(name=self.layer.get('name', None), layer_type=self.layer.get('type', None), url=self.layer.get('url', None))
+
+
+        self.optional_layers = optional_layers or [
+            Layer(name=layer.get('name', None), layer_type=layer.get('type', None), url=layer.get('url', None)) for
+            layer in data.get('optionalLayers', [])]
+
+        if self.optional_layers is not None and isinstance(optional_layers, list):
+            new_optional_layers = []
+            for op_layer in self.optional_layers:
+                if isinstance(op_layer, dict):
+                    new_optional_layers.append(Layer(name=op_layer.get('name', None), layer_type=op_layer.get('type', None), url=op_layer.get('url', None)))
+                else:
+                    new_optional_layers.append(op_layer)
+            self.optional_layers = new_optional_layers
+
+        self.epsg = epsg or data.get('epsg', None)
+        if self.epsg is None:
+            raise ValueError('epsg is required')
+
+        self.zoom = zoom or data.get('zoom', None)
+        self.min_zoom = min_zoom or data.get('minZoom', None)
+        self.max_zoom = max_zoom or data.get('maxZoom', None)
+        self.bounds = bounds or data.get('bounds', None)
+        self.aoi = aoi or data.get('aoi', None)
+
+    def to_json(self):
+        _json = {
+            "type": "gis",
+            "shebang": "dataloop",
+            "metadata": {
+                "dltype": "gis"
+            },
+            'layer': {
+                'name': self.layer.name,
+                'type': self.layer.type,
+                'url': self.layer.url
+            },
+            "epsg": self.epsg
+        }
+        if self.optional_layers is not None:
+            _json['optionalLayers'] = [
+                {
+                    'name': layer.name,
+                    'type': layer.type,
+                    'url': layer.url
+                } for layer in self.optional_layers
+            ]
+        if self.zoom is not None:
+            _json['zoom'] = self.zoom
+        if self.min_zoom is not None:
+            _json['minZoom'] = self.min_zoom
+        if self.max_zoom is not None:
+            _json['maxZoom'] = self.max_zoom
+        if self.bounds is not None:
+            _json['bounds'] = self.bounds
+        if self.aoi is not None:
+            _json['aoi'] = self.aoi
+        return _json
+
+    @classmethod
+    def from_local_file(cls, filepath):
+        """
+        Create a new prompt item from a file
+        :param filepath: path to the file
+        :return: PromptItem object
+        """
+        if os.path.exists(filepath) is False:
+            raise FileNotFoundError(f'File does not exists: {filepath}')
+        if 'json' not in os.path.splitext(filepath)[-1]:
+            raise ValueError(f'Expected path to json item, got {os.path.splitext(filepath)[-1]}')
+        with open(filepath, 'r', encoding='utf-8') as f:
+            data = json.load(f)
         return cls(name=os.path.basename(filepath), data=data)

dtlpy/entities/integration.py

@@ -1,184 +1,184 @@
-from enum import Enum
-import logging
-import attr
-
-from .. import entities, exceptions, repositories
-from ..services.api_client import ApiClient
-
-logger = logging.getLogger(name='dtlpy')
-
-
-class IntegrationType(str, Enum):
-    """ The type of the Integration.
-
-    .. list-table::
-       :widths: 15 150
-       :header-rows: 1
-
-       * - State
-         - Description
-       * - S3
-         - S3 Integration - for S3 drivers
-       * - AWS_CROSS_ACCOUNT
-         - AWS CROSS ACCOUNT Integration - for S3 drivers
-       * - AWS_STS
-         - AWS STS Integration - for S3 drivers
-       * - GCS
-         - GCS Integration - for GCS drivers
-       * - GCP_CROSS_PROJECT
-         - GCP CROSS PROJECT Integration - for GCP drivers
-       * - AZUREBLOB
-         - AZURE BLOB Integration - for S3 AZUREBLOB and AZURE_DATALAKE_GEN2 drivers
-       * - KEY_VALUE
-         - KEY VALUE Integration - for save secrets in the platform
-       * - GCP_WORKLOAD_IDENTITY_FEDERATION
-         - GCP Workload Identity Federation Integration - for GCP drivers
-       * - PRIVATE_REGISTRY
-         - PRIVATE REGISTRY Integration - for private registry drivers
-    """
-    S3 = "s3"
-    AWS_CROSS_ACCOUNT = 'aws-cross'
-    AWS_STS = 'aws-sts'
-    GCS = "gcs"
-    GCS_CROSS = "gcp-cross"
-    AZUREBLOB = "azureblob"
-    KEY_VALUE = "key_value"
-    GCP_WORKLOAD_IDENTITY_FEDERATION = "gcp-workload-identity-federation",
-    PRIVATE_REGISTRY = "private-registry"
-
-
-@attr.s
-class Integration(entities.BaseEntity):
-    """
-    Integration object
-    """
-    id = attr.ib()
-    name = attr.ib()
-    type = attr.ib()
-    org = attr.ib()
-    created_at = attr.ib()
-    creator = attr.ib()
-    update_at = attr.ib()
-    url = attr.ib()
-    _client_api = attr.ib(type=ApiClient, repr=False)
-    metadata = attr.ib(default=None, repr=False)
-    _project = attr.ib(default=None, repr=False)
-
-    @classmethod
-    def from_json(cls,
-                  _json: dict,
-                  client_api: ApiClient,
-                  is_fetched=True):
-        """
-        Build a Integration entity object from a json
-
-        :param _json: _json response from host
-        :param client_api: ApiClient entity
-        :param is_fetched: is Entity fetched from Platform
-        :return: Integration object
-        """
-        inst = cls(id=_json.get('id', None),
-                   name=_json.get('name', None),
-                   creator=_json.get('creator', None),
-                   created_at=_json.get('createdAt', None),
-                   update_at=_json.get('updatedAt', None),
-                   type=_json.get('type', None),
-                   org=_json.get('org', None),
-                   client_api=client_api,
-                   metadata=_json.get('metadata', None),
-                   url=_json.get('url', None))
-        inst.is_fetched = is_fetched
-        return inst
-
-    def to_json(self):
-        """
-        Returns platform _json format of object
-
-        :return: platform json format of object
-        :rtype: dict
-        """
-        _json = attr.asdict(self, filter=attr.filters.exclude(attr.fields(Integration)._client_api,
-                                                              attr.fields(Integration)._project))
-        return _json
-
-    @property
-    def project(self):
-        return self._project
-
-    @project.setter
-    def project(self, project):
-        if not isinstance(project, entities.Project):
-            raise ValueError('Must input a valid Project entity')
-        self._project = project
-
-    def update(
-            self,
-            new_name: str = None,
-            new_options: dict = None,
-            reload_services: bool = None
-    ):
-        """
-        Update the integration's name.
-
-        **Prerequisites**: You must be an *owner* in the organization.
-
-        :param str new_name: new name
-        :param dict new_options: new value
-        :param bool reload_services: reload services associated with this integration
-        :return: Integration object
-        :rtype: dtlpy.entities.integration.Integration
-
-        **Examples for options include**:
-        s3 - {key: "", secret: ""};
-        gcs - {key: "", secret: "", content: ""};
-        azureblob - {key: "", secret: "", clientId: "", tenantId: ""};
-        key_value - {key: "", value: ""}
-        aws-sts - {key: "", secret: "", roleArns: ""}
-        aws-cross - {roleArns: ""}
-
-        **Example**:
-
-        .. code-block:: python
-
-            project.integrations.update(integrations_id='integrations_id', new_name="new_integration_name")
-        """
-        if self.project is not None:
-            identifier = self.project
-        elif self.org is not None:
-            identifier = repositories.organizations.Organizations(client_api=self._client_api).get(
-                organization_id=self.org)
-        else:
-            raise exceptions.PlatformException(
-                error='400',
-                message='Must provide an identifier in inputs')
-
-        identifier.integrations.update(
-            new_name=new_name,
-            integrations_id=self.id,
-            integration=self,
-            new_options=new_options,
-            reload_services=reload_services
-        )
-
-    def delete(self,
-               sure: bool = False,
-               really: bool = False) -> bool:
-        """
-        Delete integrations from the Organization
-
-        :param bool sure: are you sure you want to delete?
-        :param bool really: really really?
-        :return: True
-        :rtype: bool
-        """
-        if self.project is not None:
-            identifier = self.project
-        elif self.org is not None:
-            identifier = repositories.organizations.Organizations(client_api=self._client_api).get(
-                organization_id=self.org)
-        else:
-            raise exceptions.PlatformException(
-                error='400',
-                message='Must provide an identifier in inputs')
-
-        return identifier.integrations.delete(integrations_id=self.id, sure=sure, really=really)
+from enum import Enum
+import logging
+import attr
+
+from .. import entities, exceptions, repositories
+from ..services.api_client import ApiClient
+
+logger = logging.getLogger(name='dtlpy')
+
+
+class IntegrationType(str, Enum):
+    """ The type of the Integration.
+
+    .. list-table::
+       :widths: 15 150
+       :header-rows: 1
+
+       * - State
+         - Description
+       * - S3
+         - S3 Integration - for S3 drivers
+       * - AWS_CROSS_ACCOUNT
+         - AWS CROSS ACCOUNT Integration - for S3 drivers
+       * - AWS_STS
+         - AWS STS Integration - for S3 drivers
+       * - GCS
+         - GCS Integration - for GCS drivers
+       * - GCP_CROSS_PROJECT
+         - GCP CROSS PROJECT Integration - for GCP drivers
+       * - AZUREBLOB
+         - AZURE BLOB Integration - for S3 AZUREBLOB and AZURE_DATALAKE_GEN2 drivers
+       * - KEY_VALUE
+         - KEY VALUE Integration - for save secrets in the platform
+       * - GCP_WORKLOAD_IDENTITY_FEDERATION
+         - GCP Workload Identity Federation Integration - for GCP drivers
+       * - PRIVATE_REGISTRY
+         - PRIVATE REGISTRY Integration - for private registry drivers
+    """
+    S3 = "s3"
+    AWS_CROSS_ACCOUNT = 'aws-cross'
+    AWS_STS = 'aws-sts'
+    GCS = "gcs"
+    GCS_CROSS = "gcp-cross"
+    AZUREBLOB = "azureblob"
+    KEY_VALUE = "key_value"
+    GCP_WORKLOAD_IDENTITY_FEDERATION = "gcp-workload-identity-federation",
+    PRIVATE_REGISTRY = "private-registry"
+
+
+@attr.s
+class Integration(entities.BaseEntity):
+    """
+    Integration object
+    """
+    id = attr.ib()
+    name = attr.ib()
+    type = attr.ib()
+    org = attr.ib()
+    created_at = attr.ib()
+    creator = attr.ib()
+    update_at = attr.ib()
+    url = attr.ib()
+    _client_api = attr.ib(type=ApiClient, repr=False)
+    metadata = attr.ib(default=None, repr=False)
+    _project = attr.ib(default=None, repr=False)
+
+    @classmethod
+    def from_json(cls,
+                  _json: dict,
+                  client_api: ApiClient,
+                  is_fetched=True):
+        """
+        Build a Integration entity object from a json
+
+        :param _json: _json response from host
+        :param client_api: ApiClient entity
+        :param is_fetched: is Entity fetched from Platform
+        :return: Integration object
+        """
+        inst = cls(id=_json.get('id', None),
+                   name=_json.get('name', None),
+                   creator=_json.get('creator', None),
+                   created_at=_json.get('createdAt', None),
+                   update_at=_json.get('updatedAt', None),
+                   type=_json.get('type', None),
+                   org=_json.get('org', None),
+                   client_api=client_api,
+                   metadata=_json.get('metadata', None),
+                   url=_json.get('url', None))
+        inst.is_fetched = is_fetched
+        return inst
+
+    def to_json(self):
+        """
+        Returns platform _json format of object
+
+        :return: platform json format of object
+        :rtype: dict
+        """
+        _json = attr.asdict(self, filter=attr.filters.exclude(attr.fields(Integration)._client_api,
+                                                              attr.fields(Integration)._project))
+        return _json
+
+    @property
+    def project(self):
+        return self._project
+
+    @project.setter
+    def project(self, project):
+        if not isinstance(project, entities.Project):
+            raise ValueError('Must input a valid Project entity')
+        self._project = project
+
+    def update(
+            self,
+            new_name: str = None,
+            new_options: dict = None,
+            reload_services: bool = None
+    ):
+        """
+        Update the integration's name.
+
+        **Prerequisites**: You must be an *owner* in the organization.
+
+        :param str new_name: new name
+        :param dict new_options: new value
+        :param bool reload_services: reload services associated with this integration
+        :return: Integration object
+        :rtype: dtlpy.entities.integration.Integration
+
+        **Examples for options include**:
+        s3 - {key: "", secret: ""};
+        gcs - {key: "", secret: "", content: ""};
+        azureblob - {key: "", secret: "", clientId: "", tenantId: ""};
+        key_value - {key: "", value: ""}
+        aws-sts - {key: "", secret: "", roleArns: ""}
+        aws-cross - {roleArns: ""}
+
+        **Example**:
+
+        .. code-block:: python
+
+            project.integrations.update(integrations_id='integrations_id', new_name="new_integration_name")
+        """
+        if self.project is not None:
+            identifier = self.project
+        elif self.org is not None:
+            identifier = repositories.organizations.Organizations(client_api=self._client_api).get(
+                organization_id=self.org)
+        else:
+            raise exceptions.PlatformException(
+                error='400',
+                message='Must provide an identifier in inputs')
+
+        identifier.integrations.update(
+            new_name=new_name,
+            integrations_id=self.id,
+            integration=self,
+            new_options=new_options,
+            reload_services=reload_services
+        )
+
+    def delete(self,
+               sure: bool = False,
+               really: bool = False) -> bool:
+        """
+        Delete integrations from the Organization
+
+        :param bool sure: are you sure you want to delete?
+        :param bool really: really really?
+        :return: True
+        :rtype: bool
+        """
+        if self.project is not None:
+            identifier = self.project
+        elif self.org is not None:
+            identifier = repositories.organizations.Organizations(client_api=self._client_api).get(
+                organization_id=self.org)
+        else:
+            raise exceptions.PlatformException(
+                error='400',
+                message='Must provide an identifier in inputs')
+
+        return identifier.integrations.delete(integrations_id=self.id, sure=sure, really=really)