development-framework-cli 1.7.3__py3-none-any.whl

dm_cli/dmss_api/models/__init__.py

@@ -0,0 +1,29 @@
+# flake8: noqa
+
+# import all models into this package
+# if you have many models here with many references from one model to another this may
+# raise a RecursionError
+# to avoid this, import only the models that you directly need like:
+# from from dm_cli.dmss_api.model.pet import Pet
+# or import this package, but before doing it, use:
+# import sys
+# sys.setrecursionlimit(n)
+
+from dm_cli.dmss_api.model.access_control_list import AccessControlList
+from dm_cli.dmss_api.model.access_level import AccessLevel
+from dm_cli.dmss_api.model.data_source_information import DataSourceInformation
+from dm_cli.dmss_api.model.data_source_request import DataSourceRequest
+from dm_cli.dmss_api.model.dependency import Dependency
+from dm_cli.dmss_api.model.entity import Entity
+from dm_cli.dmss_api.model.error_response import ErrorResponse
+from dm_cli.dmss_api.model.export_meta_response import ExportMetaResponse
+from dm_cli.dmss_api.model.get_blueprint_response import GetBlueprintResponse
+from dm_cli.dmss_api.model.lookup import Lookup
+from dm_cli.dmss_api.model.pat_data import PATData
+from dm_cli.dmss_api.model.recipe import Recipe
+from dm_cli.dmss_api.model.recipe_attribute import RecipeAttribute
+from dm_cli.dmss_api.model.repository import Repository
+from dm_cli.dmss_api.model.repository_type import RepositoryType
+from dm_cli.dmss_api.model.storage_attribute import StorageAttribute
+from dm_cli.dmss_api.model.storage_data_types import StorageDataTypes
+from dm_cli.dmss_api.model.storage_recipe import StorageRecipe

dm_cli/dmss_api/rest.py

@@ -0,0 +1,358 @@
+"""
+    Data Modelling Storage Service
+
+    API for basic data modelling interaction  # noqa: E501
+
+    The version of the OpenAPI document: 1.3.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import io
+import ipaddress
+import json
+import logging
+import re
+import ssl
+from urllib.parse import urlencode, urlparse
+from urllib.request import proxy_bypass_environment
+
+import urllib3
+
+from dm_cli.dmss_api.exceptions import (
+    ApiException,
+    ApiValueError,
+    ForbiddenException,
+    NotFoundException,
+    ServiceException,
+    UnauthorizedException,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp):
+        self.urllib3_response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = resp.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.urllib3_response.getheaders()
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.urllib3_response.getheader(name, default)
+
+
+class RESTClientObject(object):
+
+    def __init__(self, configuration, pools_size=4, maxsize=None):
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # maxsize is the number of requests to host that are allowed in parallel  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        addition_pool_args = {}
+        if configuration.assert_hostname is not None:
+            addition_pool_args['assert_hostname'] = configuration.assert_hostname  # noqa: E501
+
+        if configuration.retries is not None:
+            addition_pool_args['retries'] = configuration.retries
+
+        if configuration.socket_options is not None:
+            addition_pool_args['socket_options'] = configuration.socket_options
+
+        if maxsize is None:
+            if configuration.connection_pool_maxsize is not None:
+                maxsize = configuration.connection_pool_maxsize
+            else:
+                maxsize = 4
+
+        # https pool manager
+        if configuration.proxy and not should_bypass_proxies(
+                configuration.host, no_proxy=configuration.no_proxy or ''):
+            self.pool_manager = urllib3.ProxyManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=configuration.ssl_ca_cert,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                proxy_url=configuration.proxy,
+                proxy_headers=configuration.proxy_headers,
+                **addition_pool_args
+            )
+        else:
+            self.pool_manager = urllib3.PoolManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=configuration.ssl_ca_cert,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                **addition_pool_args
+            )
+
+    def request(self, method, url, query_params=None, headers=None,
+                body=None, post_params=None, _preload_content=True,
+                _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param query_params: query parameters in the url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
+                          'PATCH', 'OPTIONS']
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):  # noqa: E501,F821
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (isinstance(_request_timeout, tuple) and
+                  len(_request_timeout) == 2):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0], read=_request_timeout[1])
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+                # Only set a default Content-Type for POST, PUT, PATCH and OPTIONS requests
+                if (method != 'DELETE') and ('Content-Type' not in headers):
+                    headers['Content-Type'] = 'application/json'
+                if query_params:
+                    url += '?' + urlencode(query_params)
+                if ('Content-Type' not in headers) or (re.search('json',
+                                                                 headers['Content-Type'], re.IGNORECASE)):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                # Pass a `string` parameter directly in the body to support
+                # other content types than Json when `body` argument is
+                # provided in serialized form
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    request_body = body
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(method, url,
+                                              fields=query_params,
+                                              preload_content=_preload_content,
+                                              timeout=timeout,
+                                              headers=headers)
+        except urllib3.exceptions.SSLError as e:
+            msg = "{0}\n{1}".format(type(e).__name__, str(e))
+            raise ApiException(status=0, reason=msg)
+
+        if _preload_content:
+            r = RESTResponse(r)
+
+            # log response body
+            logger.debug("response body: %s", r.data)
+
+        if not 200 <= r.status <= 299:
+            if r.status == 401:
+                raise UnauthorizedException(http_resp=r)
+
+            if r.status == 403:
+                raise ForbiddenException(http_resp=r)
+
+            if r.status == 404:
+                raise NotFoundException(http_resp=r)
+
+            if 500 <= r.status <= 599:
+                raise ServiceException(http_resp=r)
+
+            raise ApiException(http_resp=r)
+
+        return r
+
+    def GET(self, url, headers=None, query_params=None, _preload_content=True,
+            _request_timeout=None):
+        return self.request("GET", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def HEAD(self, url, headers=None, query_params=None, _preload_content=True,
+             _request_timeout=None):
+        return self.request("HEAD", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def OPTIONS(self, url, headers=None, query_params=None, post_params=None,
+                body=None, _preload_content=True, _request_timeout=None):
+        return self.request("OPTIONS", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def DELETE(self, url, headers=None, query_params=None, body=None,
+               _preload_content=True, _request_timeout=None):
+        return self.request("DELETE", url,
+                            headers=headers,
+                            query_params=query_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def POST(self, url, headers=None, query_params=None, post_params=None,
+             body=None, _preload_content=True, _request_timeout=None):
+        return self.request("POST", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def PUT(self, url, headers=None, query_params=None, post_params=None,
+            body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PUT", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def PATCH(self, url, headers=None, query_params=None, post_params=None,
+              body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PATCH", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+# end of class RESTClientObject
+
+
+def is_ipv4(target):
+    """ Test if IPv4 address or not
+    """
+    try:
+        chk = ipaddress.IPv4Address(target)
+        return True
+    except ipaddress.AddressValueError:
+        return False
+
+
+def in_ipv4net(target, net):
+    """ Test if target belongs to given IPv4 network
+    """
+    try:
+        nw = ipaddress.IPv4Network(net)
+        ip = ipaddress.IPv4Address(target)
+        if ip in nw:
+            return True
+        return False
+    except ipaddress.AddressValueError:
+        return False
+    except ipaddress.NetmaskValueError:
+        return False
+
+
+def should_bypass_proxies(url, no_proxy=None):
+    """ Yet another requests.should_bypass_proxies
+    Test if proxies should not be used for a particular url.
+    """
+
+    parsed = urlparse(url)
+
+    # special cases
+    if parsed.hostname in [None, '']:
+        return True
+
+    # special cases
+    if no_proxy in [None, '']:
+        return False
+    if no_proxy == '*':
+        return True
+
+    no_proxy = no_proxy.lower().replace(' ', '');
+    entries = (
+        host for host in no_proxy.split(',') if host
+    )
+
+    if is_ipv4(parsed.hostname):
+        for item in entries:
+            if in_ipv4net(parsed.hostname, item):
+                return True
+    return proxy_bypass_environment(parsed.hostname, {'no': no_proxy})

dm_cli/domain.py

@@ -0,0 +1,166 @@
+import io
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Callable, List, Literal, NewType, Union
+from uuid import UUID, uuid4
+
+from .enums import SIMOS, ReferenceTypes
+
+
+@dataclass(frozen=True)
+class File:
+    """Class for a file"""
+
+    content: io.BytesIO
+    path: Path
+    name: str = ""
+    uid: str = ""
+
+    def __getitem__(self, item):
+        return self.__getattribute__(item)
+
+
+class Package:
+    def __init__(
+        self,
+        name: str,
+        description: str = "",
+        uid: UUID = None,
+        is_root: bool = False,
+        meta: dict = None,
+        parent: "Package" = None,
+    ):
+        self.name = name
+        self.description = description
+        self.uid = uid if uid else uuid4()
+        self.is_root = is_root
+        self.content: List[Union[Package, dict, File]] = []
+        self.meta: Union[dict, None] = meta if meta else {}
+        self.parent = parent if parent else None
+
+    def __str__(self):
+        return f"Name: {self.name}, Content: {len(self.content)}"
+
+    def __getitem__(self, item):
+        return self.__getattribute__(item)
+
+    def search(self, filename: str) -> Union["Package", dict]:
+        return next((child for child in self.content if child["name"] == filename), None)
+
+    def to_dict(self):
+        return {
+            "_id": str(self.uid),
+            "type": self.type,
+            "name": self.name,
+            "description": self.description,
+            "isRoot": self.is_root,
+            "_meta_": self.meta,
+            "content": self._content_to_ref_dict(),
+        }
+
+    def path(self):
+        if not self.parent:
+            return self.name
+        return f"{self.parent.path()}/{self.name}"
+
+    def traverse_documents(self, func: Callable, update: bool = False, **kwargs) -> None:
+        """
+        Traverses the Package structure, calling the passed function on every non-Package node.
+
+        @param func: A function that takes the document node as it's first parameter
+        @param update: Whether to set the tree node to be the return value from the passed function
+        @param kwargs: Keyword arguments to be passed to 'func'
+        """
+        for i, child in enumerate(self.content):
+            if isinstance(child, Package):
+                child.traverse_documents(func, update=update, **kwargs)
+            else:
+                child_file_path = self.path()  # The file's path in the package is needed to resolve dotted references
+                if update:
+                    self.content[i] = func(child, file_path=child_file_path, **kwargs)
+                else:
+                    func(child, file_path=child_file_path, **kwargs)
+
+    def traverse_package(self, func: Callable, update: bool = False, **kwargs) -> None:
+        """
+        Traverses the Package structure, calling the passed function on every Package node.
+
+        @param func: A function that takes the Package node as it's first parameter
+        @param update: Whether to set the tree node to be the return value from the passed function
+        @param kwargs: Keyword arguments to be passed to 'func'
+        """
+        for i, child in enumerate(self.content):
+            if isinstance(child, Package):
+                if update:
+                    self.content[i] = func(child, **kwargs)
+                else:
+                    func(child, **kwargs)
+                child.traverse_package(func, update, **kwargs)
+
+    @property
+    def type(self):
+        return SIMOS.PACKAGE.value
+
+    def _content_to_ref_dict(self):
+        result = []
+        for child in self.content:
+            if isinstance(child, File):
+                result.append(
+                    {
+                        "address": f"${str(child.uid)}",
+                        "type": SIMOS.REFERENCE.value,
+                        "referenceType": ReferenceTypes.STORAGE.value,
+                    }
+                )
+            elif isinstance(child, Package):
+                result.append(
+                    {
+                        "address": f"${str(child.uid)}",
+                        "type": SIMOS.REFERENCE.value,
+                        "referenceType": ReferenceTypes.STORAGE.value,
+                    }
+                )
+            else:  # Assume the child is a dict
+                if "name" in child:
+                    result.append(
+                        {
+                            "address": f"${child['_id']}",
+                            "type": SIMOS.REFERENCE.value,
+                            "referenceType": ReferenceTypes.STORAGE.value,
+                        }
+                    )
+
+                else:
+                    result.append(
+                        {
+                            "address": f"${child['_id']}",
+                            "type": SIMOS.REFERENCE.value,
+                            "referenceType": ReferenceTypes.STORAGE.value,
+                        }
+                    )
+        return result
+
+
+TDependencyProtocol = NewType("TDependencyProtocol", Literal["dmss", "http"])
+
+
+@dataclass(frozen=True)
+class Dependency:
+    """Class for any dependencies (external types) a entity references"""
+
+    alias: str
+    # Different ways we support to fetch dependencies.
+    # dmss: Internally within the DMSS instance
+    # http: A public HTTP GET call
+    protocol: TDependencyProtocol
+    address: str
+    version: str = ""
+    type: str = ""
+
+    def __eq__(self, other):
+        return (
+            self.alias == other.alias
+            and self.protocol == other.protocol
+            and self.address == other.address
+            and self.version == other.version
+        )

dm_cli/enums.py

@@ -0,0 +1,48 @@
+from enum import Enum
+
+
+class StorageDataTypes(Enum):
+    DEFAULT = "default"
+    LARGE = "large"
+    VERY_LARGE = "veryLarge"
+    VIDEO = "video"
+    BLOB = "blob"
+
+
+class BuiltinDataTypes(Enum):
+    STR = "string"
+    NUM = "number"
+    INT = "integer"
+    BOOL = "boolean"
+    OBJECT = "object"  # Any complex type (i.e. any blueprint type)
+    BINARY = "binary"
+    ANY = "any"
+
+    def to_py_type(self):
+        if self is BuiltinDataTypes.BOOL:
+            return bool
+        elif self is BuiltinDataTypes.INT:
+            return int
+        elif self is BuiltinDataTypes.NUM:
+            return float
+        elif self is BuiltinDataTypes.STR:
+            return str
+        elif self is BuiltinDataTypes.OBJECT:
+            return dict
+
+
+class SIMOS(Enum):
+    BLOB = "dmss://system/SIMOS/Blob"
+    PACKAGE = "dmss://system/SIMOS/Package"
+    REFERENCE = "dmss://system/SIMOS/Reference"
+    FILE = "dmss://system/SIMOS/File"
+    DEPENDENCY = "dmss://system/SIMOS/Dependency"
+    ATTRIBUTE = "dmss://system/SIMOS/BlueprintAttribute"
+    BLUEPRINT = "dmss://system/SIMOS/Blueprint"
+    RECIPE_LINK = "dmss://system/SIMOS/RecipeLink"
+
+
+class ReferenceTypes(Enum):
+    LINK = "link"
+    POINTER = "pointer"
+    STORAGE = "storage"