api_client

😸 Cheshire-Cat API

Production ready AI assistant framework

The version of the OpenAPI document: 1.3.1 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

ApiClient

Generic API client for OpenAPI client library builds.

OpenAPI generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the OpenAPI templates.

Parameters:

Name	Type	Description	Default
configuration		.Configuration object for this client	None
header_name		a header to pass when making calls to the API.	None
header_value		a header value to pass when making calls to the API.	None
cookie		a cookie to include in the header when making calls to the API	None

Source code in cheshire_cat_api/api_client.py

class ApiClient:
    """Generic API client for OpenAPI client library builds.

    OpenAPI generic API client. This client handles the client-
    server communication, and is invariant across implementations. Specifics of
    the methods and models for each application are generated from the OpenAPI
    templates.

    :param configuration: .Configuration object for this client
    :param header_name: a header to pass when making calls to the API.
    :param header_value: a header value to pass when making calls to
        the API.
    :param cookie: a cookie to include in the header when making calls
        to the API
    """

    PRIMITIVE_TYPES = (float, bool, bytes, str, int)
    NATIVE_TYPES_MAPPING = {
        'int': int,
        'long': int, # TODO remove as only py3 is supported?
        'float': float,
        'str': str,
        'bool': bool,
        'date': datetime.date,
        'datetime': datetime.datetime,
        'object': object,
    }
    _pool = None

    def __init__(
        self,
        configuration=None,
        header_name=None,
        header_value=None,
        cookie=None
    ) -> None:
        # use default configuration if none is provided
        if configuration is None:
            configuration = Configuration.get_default()
        self.configuration = configuration

        self.rest_client = rest.RESTClientObject(configuration)
        self.default_headers = {}
        if header_name is not None:
            self.default_headers[header_name] = header_value
        self.cookie = cookie
        # Set default User-Agent.
        self.user_agent = 'OpenAPI-Generator/1.0.0/python'
        self.client_side_validation = configuration.client_side_validation

    def __enter__(self):
        return self

    def __exit__(self, exc_type, exc_value, traceback):
        pass

    @property
    def user_agent(self):
        """User agent for this API client"""
        return self.default_headers['User-Agent']

    @user_agent.setter
    def user_agent(self, value):
        self.default_headers['User-Agent'] = value

    def set_default_header(self, header_name, header_value):
        self.default_headers[header_name] = header_value


    _default = None

    @classmethod
    def get_default(cls):
        """Return new instance of ApiClient.

        This method returns newly created, based on default constructor,
        object of ApiClient class or returns a copy of default
        ApiClient.

        :return: The ApiClient object.
        """
        if cls._default is None:
            cls._default = ApiClient()
        return cls._default

    @classmethod
    def set_default(cls, default):
        """Set default instance of ApiClient.

        It stores default ApiClient.

        :param default: object of ApiClient.
        """
        cls._default = default

    def param_serialize(
        self,
        method,
        resource_path,
        path_params=None,
        query_params=None,
        header_params=None,
        body=None,
        post_params=None,
        files=None, auth_settings=None,
        collection_formats=None,
        _host=None,
        _request_auth=None
    ) -> Tuple:

        """Builds the HTTP request params needed by the request.
        :param method: Method to call.
        :param resource_path: Path to method endpoint.
        :param path_params: Path parameters in the url.
        :param query_params: Query parameters in the url.
        :param header_params: Header parameters to be
            placed in the request header.
        :param body: Request body.
        :param post_params dict: Request post form parameters,
            for `application/x-www-form-urlencoded`, `multipart/form-data`.
        :param auth_settings list: Auth Settings names for the request.
        :param files dict: key -> filename, value -> filepath,
            for `multipart/form-data`.
        :param collection_formats: dict of collection formats for path, query,
            header, and post parameters.
        :param _request_auth: set to override the auth_settings for an a single
                              request; this effectively ignores the authentication
                              in the spec for a single request.
        :return: tuple of form (path, http_method, query_params, header_params,
            body, post_params, files)
        """

        config = self.configuration

        # header parameters
        header_params = header_params or {}
        header_params.update(self.default_headers)
        if self.cookie:
            header_params['Cookie'] = self.cookie
        if header_params:
            header_params = self.sanitize_for_serialization(header_params)
            header_params = dict(
                self.parameters_to_tuples(header_params,collection_formats)
            )

        # path parameters
        if path_params:
            path_params = self.sanitize_for_serialization(path_params)
            path_params = self.parameters_to_tuples(
                path_params,
                collection_formats
            )
            for k, v in path_params:
                # specified safe chars, encode everything
                resource_path = resource_path.replace(
                    '{%s}' % k,
                    quote(str(v), safe=config.safe_chars_for_path_param)
                )

        # post parameters
        if post_params or files:
            post_params = post_params if post_params else []
            post_params = self.sanitize_for_serialization(post_params)
            post_params = self.parameters_to_tuples(
                post_params,
                collection_formats
            )
            post_params.extend(self.files_parameters(files))

        # auth setting
        self.update_params_for_auth(
            header_params,
            query_params,
            auth_settings,
            resource_path,
            method,
            body,
            request_auth=_request_auth
        )

        # body
        if body:
            body = self.sanitize_for_serialization(body)

        # request url
        if _host is None:
            url = self.configuration.host + resource_path
        else:
            # use server/host defined in path or operation instead
            url = _host + resource_path

        # query parameters
        if query_params:
            query_params = self.sanitize_for_serialization(query_params)
            url_query = self.parameters_to_url_query(
                query_params,
                collection_formats
            )
            url += "?" + url_query

        return method, url, header_params, body, post_params


    def call_api(
        self,
        method,
        url,
        header_params=None,
        body=None,
        post_params=None,
        _request_timeout=None
    ) -> rest.RESTResponse:
        """Makes the HTTP request (synchronous)
        :param method: Method to call.
        :param url: Path to method endpoint.
        :param header_params: Header parameters to be
            placed in the request header.
        :param body: Request body.
        :param post_params dict: Request post form parameters,
            for `application/x-www-form-urlencoded`, `multipart/form-data`.
        :param _request_timeout: timeout setting for this request.
        :return: RESTResponse
        """

        try:
            # perform request and return response
            response_data = self.rest_client.request(
                method, url,
                headers=header_params,
                body=body, post_params=post_params,
                _request_timeout=_request_timeout
            )

        except ApiException as e:
            if e.body:
                e.body = e.body.decode('utf-8')
            raise e

        return response_data

    def response_deserialize(
        self,
        response_data=None,
        response_types_map=None
    ) -> ApiResponse:
        """Deserializes response into an object.
        :param response_data: RESTResponse object to be deserialized.
        :param response_types_map: dict of response types.
        :return: ApiResponse
        """


        response_type = response_types_map.get(str(response_data.status), None)
        if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599:
            # if not found, look for '1XX', '2XX', etc.
            response_type = response_types_map.get(str(response_data.status)[0] + "XX", None)

        if not 200 <= response_data.status <= 299:
            if response_data.status == 400:
                raise BadRequestException(http_resp=response_data)

            if response_data.status == 401:
                raise UnauthorizedException(http_resp=response_data)

            if response_data.status == 403:
                raise ForbiddenException(http_resp=response_data)

            if response_data.status == 404:
                raise NotFoundException(http_resp=response_data)

            if 500 <= response_data.status <= 599:
                raise ServiceException(http_resp=response_data)
            raise ApiException(http_resp=response_data)

        # deserialize response data

        if response_type == "bytearray":
            return_data = response_data.data
        elif response_type is None:
            return_data = None
        elif response_type == "file":
            return_data = self.__deserialize_file(response_data)
        else:
            match = None
            content_type = response_data.getheader('content-type')
            if content_type is not None:
                match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type)
            encoding = match.group(1) if match else "utf-8"
            response_text = response_data.data.decode(encoding)
            return_data = self.deserialize(response_text, response_type)

        return ApiResponse(
            status_code = response_data.status,
            data = return_data,
            headers = response_data.getheaders(),
            raw_data = response_data.data
        )

    def sanitize_for_serialization(self, obj):
        """Builds a JSON POST object.

        If obj is None, return None.
        If obj is str, int, long, float, bool, return directly.
        If obj is datetime.datetime, datetime.date
            convert to string in iso8601 format.
        If obj is list, sanitize each element in the list.
        If obj is dict, return the dict.
        If obj is OpenAPI model, return the properties dict.

        :param obj: The data to serialize.
        :return: The serialized form of data.
        """
        if obj is None:
            return None
        elif isinstance(obj, self.PRIMITIVE_TYPES):
            return obj
        elif isinstance(obj, list):
            return [
                self.sanitize_for_serialization(sub_obj) for sub_obj in obj
            ]
        elif isinstance(obj, tuple):
            return tuple(
                self.sanitize_for_serialization(sub_obj) for sub_obj in obj
            )
        elif isinstance(obj, (datetime.datetime, datetime.date)):
            return obj.isoformat()

        elif isinstance(obj, dict):
            obj_dict = obj
        else:
            # Convert model obj to dict except
            # attributes `openapi_types`, `attribute_map`
            # and attributes which value is not None.
            # Convert attribute name to json key in
            # model definition for request.
            obj_dict = obj.to_dict()

        return {
            key: self.sanitize_for_serialization(val)
            for key, val in obj_dict.items()
        }

    def deserialize(self, response_text, response_type):
        """Deserializes response into an object.

        :param response: RESTResponse object to be deserialized.
        :param response_type: class literal for
            deserialized object, or string of class name.

        :return: deserialized object.
        """

        # fetch data from response object
        try:
            data = json.loads(response_text)
        except ValueError:
            data = response_text

        return self.__deserialize(data, response_type)

    def __deserialize(self, data, klass):
        """Deserializes dict, list, str into an object.

        :param data: dict, list or str.
        :param klass: class literal, or string of class name.

        :return: object.
        """
        if data is None:
            return None

        if isinstance(klass, str):
            if klass.startswith('List['):
                sub_kls = re.match(r'List\[(.*)]', klass).group(1)
                return [self.__deserialize(sub_data, sub_kls)
                        for sub_data in data]

            if klass.startswith('Dict['):
                sub_kls = re.match(r'Dict\[([^,]*), (.*)]', klass).group(2)
                return {k: self.__deserialize(v, sub_kls)
                        for k, v in data.items()}

            # convert str to class
            if klass in self.NATIVE_TYPES_MAPPING:
                klass = self.NATIVE_TYPES_MAPPING[klass]
            else:
                klass = getattr(cheshire_cat_api.models, klass)

        if klass in self.PRIMITIVE_TYPES:
            return self.__deserialize_primitive(data, klass)
        elif klass == object:
            return self.__deserialize_object(data)
        elif klass == datetime.date:
            return self.__deserialize_date(data)
        elif klass == datetime.datetime:
            return self.__deserialize_datetime(data)
        else:
            return self.__deserialize_model(data, klass)

    def parameters_to_tuples(self, params, collection_formats):
        """Get parameters as list of tuples, formatting collections.

        :param params: Parameters as dict or list of two-tuples
        :param dict collection_formats: Parameter collection formats
        :return: Parameters as list of tuples, collections formatted
        """
        new_params = []
        if collection_formats is None:
            collection_formats = {}
        for k, v in params.items() if isinstance(params, dict) else params:
            if k in collection_formats:
                collection_format = collection_formats[k]
                if collection_format == 'multi':
                    new_params.extend((k, value) for value in v)
                else:
                    if collection_format == 'ssv':
                        delimiter = ' '
                    elif collection_format == 'tsv':
                        delimiter = '\t'
                    elif collection_format == 'pipes':
                        delimiter = '|'
                    else:  # csv is the default
                        delimiter = ','
                    new_params.append(
                        (k, delimiter.join(str(value) for value in v)))
            else:
                new_params.append((k, v))
        return new_params

    def parameters_to_url_query(self, params, collection_formats):
        """Get parameters as list of tuples, formatting collections.

        :param params: Parameters as dict or list of two-tuples
        :param dict collection_formats: Parameter collection formats
        :return: URL query string (e.g. a=Hello%20World&b=123)
        """
        new_params = []
        if collection_formats is None:
            collection_formats = {}
        for k, v in params.items() if isinstance(params, dict) else params:
            if isinstance(v, bool):
                v = str(v).lower()
            if isinstance(v, (int, float)):
                v = str(v)
            if isinstance(v, dict):
                v = json.dumps(v)

            if k in collection_formats:
                collection_format = collection_formats[k]
                if collection_format == 'multi':
                    new_params.extend((k, value) for value in v)
                else:
                    if collection_format == 'ssv':
                        delimiter = ' '
                    elif collection_format == 'tsv':
                        delimiter = '\t'
                    elif collection_format == 'pipes':
                        delimiter = '|'
                    else:  # csv is the default
                        delimiter = ','
                    new_params.append(
                        (k, delimiter.join(quote(str(value)) for value in v))
                    )
            else:
                new_params.append((k, quote(str(v))))

        return "&".join(["=".join(item) for item in new_params])

    def files_parameters(self, files=None):
        """Builds form parameters.

        :param files: File parameters.
        :return: Form parameters with files.
        """
        params = []

        if files:
            for k, v in files.items():
                if not v:
                    continue
                file_names = v if type(v) is list else [v]
                for n in file_names:
                    with open(n, 'rb') as f:
                        filename = os.path.basename(f.name)
                        filedata = f.read()
                        mimetype = (
                            mimetypes.guess_type(filename)[0]
                            or 'application/octet-stream'
                        )
                        params.append(
                            tuple([k, tuple([filename, filedata, mimetype])])
                        )

        return params

    def select_header_accept(self, accepts: List[str]) -> Optional[str]:
        """Returns `Accept` based on an array of accepts provided.

        :param accepts: List of headers.
        :return: Accept (e.g. application/json).
        """
        if not accepts:
            return None

        for accept in accepts:
            if re.search('json', accept, re.IGNORECASE):
                return accept

        return accepts[0]

    def select_header_content_type(self, content_types):
        """Returns `Content-Type` based on an array of content_types provided.

        :param content_types: List of content-types.
        :return: Content-Type (e.g. application/json).
        """
        if not content_types:
            return None

        for content_type in content_types:
            if re.search('json', content_type, re.IGNORECASE):
                return content_type

        return content_types[0]

    def update_params_for_auth(
        self,
        headers,
        queries,
        auth_settings,
        resource_path,
        method,
        body,
        request_auth=None
    ) -> None:
        """Updates header and query params based on authentication setting.

        :param headers: Header parameters dict to be updated.
        :param queries: Query parameters tuple list to be updated.
        :param auth_settings: Authentication setting identifiers list.
        :resource_path: A string representation of the HTTP request resource path.
        :method: A string representation of the HTTP request method.
        :body: A object representing the body of the HTTP request.
        The object type is the return value of sanitize_for_serialization().
        :param request_auth: if set, the provided settings will
                             override the token in the configuration.
        """
        if not auth_settings:
            return

        if request_auth:
            self._apply_auth_params(
                headers,
                queries,
                resource_path,
                method,
                body,
                request_auth
            )
        else:
            for auth in auth_settings:
                auth_setting = self.configuration.auth_settings().get(auth)
                if auth_setting:
                    self._apply_auth_params(
                        headers,
                        queries,
                        resource_path,
                        method,
                        body,
                        auth_setting
                    )

    def _apply_auth_params(
        self,
        headers,
        queries,
        resource_path,
        method,
        body,
        auth_setting
    ) -> None:
        """Updates the request parameters based on a single auth_setting

        :param headers: Header parameters dict to be updated.
        :param queries: Query parameters tuple list to be updated.
        :resource_path: A string representation of the HTTP request resource path.
        :method: A string representation of the HTTP request method.
        :body: A object representing the body of the HTTP request.
        The object type is the return value of sanitize_for_serialization().
        :param auth_setting: auth settings for the endpoint
        """
        if auth_setting['in'] == 'cookie':
            headers['Cookie'] = auth_setting['value']
        elif auth_setting['in'] == 'header':
            if auth_setting['type'] != 'http-signature':
                headers[auth_setting['key']] = auth_setting['value']
        elif auth_setting['in'] == 'query':
            queries.append((auth_setting['key'], auth_setting['value']))
        else:
            raise ApiValueError(
                'Authentication token must be in `query` or `header`'
            )

    def __deserialize_file(self, response):
        """Deserializes body to file

        Saves response body into a file in a temporary folder,
        using the filename from the `Content-Disposition` header if provided.

        handle file downloading
        save response body into a tmp file and return the instance

        :param response:  RESTResponse.
        :return: file path.
        """
        fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path)
        os.close(fd)
        os.remove(path)

        content_disposition = response.getheader("Content-Disposition")
        if content_disposition:
            filename = re.search(
                r'filename=[\'"]?([^\'"\s]+)[\'"]?',
                content_disposition
            ).group(1)
            path = os.path.join(os.path.dirname(path), filename)

        with open(path, "wb") as f:
            f.write(response.data)

        return path

    def __deserialize_primitive(self, data, klass):
        """Deserializes string to primitive type.

        :param data: str.
        :param klass: class literal.

        :return: int, long, float, str, bool.
        """
        try:
            return klass(data)
        except UnicodeEncodeError:
            return str(data)
        except TypeError:
            return data

    def __deserialize_object(self, value):
        """Return an original value.

        :return: object.
        """
        return value

    def __deserialize_date(self, string):
        """Deserializes string to date.

        :param string: str.
        :return: date.
        """
        try:
            return parse(string).date()
        except ImportError:
            return string
        except ValueError:
            raise rest.ApiException(
                status=0,
                reason="Failed to parse `{0}` as date object".format(string)
            )

    def __deserialize_datetime(self, string):
        """Deserializes string to datetime.

        The string should be in iso8601 datetime format.

        :param string: str.
        :return: datetime.
        """
        try:
            return parse(string)
        except ImportError:
            return string
        except ValueError:
            raise rest.ApiException(
                status=0,
                reason=(
                    "Failed to parse `{0}` as datetime object"
                    .format(string)
                )
            )

    def __deserialize_model(self, data, klass):
        """Deserializes list or dict to model.

        :param data: dict, list.
        :param klass: class literal.
        :return: model object.
        """

        return klass.from_dict(data)

user_agent property writable

User agent for this API client

__deserialize(data, klass)

Deserializes dict, list, str into an object.

Parameters:

Name	Type	Description	Default
data		dict, list or str.	required
klass		class literal, or string of class name.	required

Returns:

Type	Description
	object.

Source code in cheshire_cat_api/api_client.py

def __deserialize(self, data, klass):
    """Deserializes dict, list, str into an object.

    :param data: dict, list or str.
    :param klass: class literal, or string of class name.

    :return: object.
    """
    if data is None:
        return None

    if isinstance(klass, str):
        if klass.startswith('List['):
            sub_kls = re.match(r'List\[(.*)]', klass).group(1)
            return [self.__deserialize(sub_data, sub_kls)
                    for sub_data in data]

        if klass.startswith('Dict['):
            sub_kls = re.match(r'Dict\[([^,]*), (.*)]', klass).group(2)
            return {k: self.__deserialize(v, sub_kls)
                    for k, v in data.items()}

        # convert str to class
        if klass in self.NATIVE_TYPES_MAPPING:
            klass = self.NATIVE_TYPES_MAPPING[klass]
        else:
            klass = getattr(cheshire_cat_api.models, klass)

    if klass in self.PRIMITIVE_TYPES:
        return self.__deserialize_primitive(data, klass)
    elif klass == object:
        return self.__deserialize_object(data)
    elif klass == datetime.date:
        return self.__deserialize_date(data)
    elif klass == datetime.datetime:
        return self.__deserialize_datetime(data)
    else:
        return self.__deserialize_model(data, klass)

__deserialize_date(string)

Deserializes string to date.

Parameters:

Name	Type	Description	Default
string		str.	required

Returns:

Type	Description
	date.

Source code in cheshire_cat_api/api_client.py

def __deserialize_date(self, string):
    """Deserializes string to date.

    :param string: str.
    :return: date.
    """
    try:
        return parse(string).date()
    except ImportError:
        return string
    except ValueError:
        raise rest.ApiException(
            status=0,
            reason="Failed to parse `{0}` as date object".format(string)
        )

__deserialize_datetime(string)

Deserializes string to datetime.

The string should be in iso8601 datetime format.

Parameters:

Name	Type	Description	Default
string		str.	required

Returns:

Type	Description
	datetime.

Source code in cheshire_cat_api/api_client.py

def __deserialize_datetime(self, string):
    """Deserializes string to datetime.

    The string should be in iso8601 datetime format.

    :param string: str.
    :return: datetime.
    """
    try:
        return parse(string)
    except ImportError:
        return string
    except ValueError:
        raise rest.ApiException(
            status=0,
            reason=(
                "Failed to parse `{0}` as datetime object"
                .format(string)
            )
        )

__deserialize_file(response)

Deserializes body to file

Saves response body into a file in a temporary folder, using the filename from the Content-Disposition header if provided.

handle file downloading save response body into a tmp file and return the instance

Parameters:

Name	Type	Description	Default
response		RESTResponse.	required

Returns:

Type	Description
	file path.

Source code in cheshire_cat_api/api_client.py

def __deserialize_file(self, response):
    """Deserializes body to file

    Saves response body into a file in a temporary folder,
    using the filename from the `Content-Disposition` header if provided.

    handle file downloading
    save response body into a tmp file and return the instance

    :param response:  RESTResponse.
    :return: file path.
    """
    fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path)
    os.close(fd)
    os.remove(path)

    content_disposition = response.getheader("Content-Disposition")
    if content_disposition:
        filename = re.search(
            r'filename=[\'"]?([^\'"\s]+)[\'"]?',
            content_disposition
        ).group(1)
        path = os.path.join(os.path.dirname(path), filename)

    with open(path, "wb") as f:
        f.write(response.data)

    return path

__deserialize_model(data, klass)

Deserializes list or dict to model.

Parameters:

Name	Type	Description	Default
data		dict, list.	required
klass		class literal.	required

Returns:

Type	Description
	model object.

Source code in cheshire_cat_api/api_client.py

def __deserialize_model(self, data, klass):
    """Deserializes list or dict to model.

    :param data: dict, list.
    :param klass: class literal.
    :return: model object.
    """

    return klass.from_dict(data)

__deserialize_object(value)

Return an original value.

Returns:

Type	Description
	object.

Source code in cheshire_cat_api/api_client.py

def __deserialize_object(self, value):
    """Return an original value.

    :return: object.
    """
    return value

__deserialize_primitive(data, klass)

Deserializes string to primitive type.

Parameters:

Name	Type	Description	Default
data		str.	required
klass		class literal.	required

Returns:

Type	Description
	int, long, float, str, bool.

Source code in cheshire_cat_api/api_client.py

def __deserialize_primitive(self, data, klass):
    """Deserializes string to primitive type.

    :param data: str.
    :param klass: class literal.

    :return: int, long, float, str, bool.
    """
    try:
        return klass(data)
    except UnicodeEncodeError:
        return str(data)
    except TypeError:
        return data

call_api(method, url, header_params=None, body=None, post_params=None, _request_timeout=None)

Makes the HTTP request (synchronous)

Parameters:

Name	Type	Description	Default
method		Method to call.	required
url		Path to method endpoint.	required
header_params		Header parameters to be placed in the request header.	None
body		Request body.	None
dict	post_params	Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.	required
_request_timeout		timeout setting for this request.	None

Returns:

Type	Description
RESTResponse	RESTResponse

Source code in cheshire_cat_api/api_client.py

def call_api(
    self,
    method,
    url,
    header_params=None,
    body=None,
    post_params=None,
    _request_timeout=None
) -> rest.RESTResponse:
    """Makes the HTTP request (synchronous)
    :param method: Method to call.
    :param url: Path to method endpoint.
    :param header_params: Header parameters to be
        placed in the request header.
    :param body: Request body.
    :param post_params dict: Request post form parameters,
        for `application/x-www-form-urlencoded`, `multipart/form-data`.
    :param _request_timeout: timeout setting for this request.
    :return: RESTResponse
    """

    try:
        # perform request and return response
        response_data = self.rest_client.request(
            method, url,
            headers=header_params,
            body=body, post_params=post_params,
            _request_timeout=_request_timeout
        )

    except ApiException as e:
        if e.body:
            e.body = e.body.decode('utf-8')
        raise e

    return response_data

deserialize(response_text, response_type)

Deserializes response into an object.

Parameters:

Name	Type	Description	Default
response		RESTResponse object to be deserialized.	required
response_type		class literal for deserialized object, or string of class name.	required

Returns:

Type	Description
	deserialized object.

Source code in cheshire_cat_api/api_client.py

def deserialize(self, response_text, response_type):
    """Deserializes response into an object.

    :param response: RESTResponse object to be deserialized.
    :param response_type: class literal for
        deserialized object, or string of class name.

    :return: deserialized object.
    """

    # fetch data from response object
    try:
        data = json.loads(response_text)
    except ValueError:
        data = response_text

    return self.__deserialize(data, response_type)

files_parameters(files=None)

Builds form parameters.

Parameters:

Name	Type	Description	Default
files		File parameters.	None

Returns:

Type	Description
	Form parameters with files.

Source code in cheshire_cat_api/api_client.py

def files_parameters(self, files=None):
    """Builds form parameters.

    :param files: File parameters.
    :return: Form parameters with files.
    """
    params = []

    if files:
        for k, v in files.items():
            if not v:
                continue
            file_names = v if type(v) is list else [v]
            for n in file_names:
                with open(n, 'rb') as f:
                    filename = os.path.basename(f.name)
                    filedata = f.read()
                    mimetype = (
                        mimetypes.guess_type(filename)[0]
                        or 'application/octet-stream'
                    )
                    params.append(
                        tuple([k, tuple([filename, filedata, mimetype])])
                    )

    return params

get_default() classmethod

Return new instance of ApiClient.

This method returns newly created, based on default constructor, object of ApiClient class or returns a copy of default ApiClient.

Returns:

Type	Description
	The ApiClient object.

Source code in cheshire_cat_api/api_client.py

@classmethod
def get_default(cls):
    """Return new instance of ApiClient.

    This method returns newly created, based on default constructor,
    object of ApiClient class or returns a copy of default
    ApiClient.

    :return: The ApiClient object.
    """
    if cls._default is None:
        cls._default = ApiClient()
    return cls._default

param_serialize(method, resource_path, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, auth_settings=None, collection_formats=None, _host=None, _request_auth=None)

Builds the HTTP request params needed by the request.

Parameters:

Name	Type	Description	Default
method		Method to call.	required
resource_path		Path to method endpoint.	required
path_params		Path parameters in the url.	None
query_params		Query parameters in the url.	None
header_params		Header parameters to be placed in the request header.	None
body		Request body.	None
dict	post_params	Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.	required
list	auth_settings	Auth Settings names for the request.	required
collection_formats		dict of collection formats for path, query, header, and post parameters.	None
_request_auth		set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.	None

Returns:

Type	Description
Tuple	tuple of form (path, http_method, query_params, header_params, body, post_params, files)

Source code in cheshire_cat_api/api_client.py

def param_serialize(
    self,
    method,
    resource_path,
    path_params=None,
    query_params=None,
    header_params=None,
    body=None,
    post_params=None,
    files=None, auth_settings=None,
    collection_formats=None,
    _host=None,
    _request_auth=None
) -> Tuple:

    """Builds the HTTP request params needed by the request.
    :param method: Method to call.
    :param resource_path: Path to method endpoint.
    :param path_params: Path parameters in the url.
    :param query_params: Query parameters in the url.
    :param header_params: Header parameters to be
        placed in the request header.
    :param body: Request body.
    :param post_params dict: Request post form parameters,
        for `application/x-www-form-urlencoded`, `multipart/form-data`.
    :param auth_settings list: Auth Settings names for the request.
    :param files dict: key -> filename, value -> filepath,
        for `multipart/form-data`.
    :param collection_formats: dict of collection formats for path, query,
        header, and post parameters.
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the authentication
                          in the spec for a single request.
    :return: tuple of form (path, http_method, query_params, header_params,
        body, post_params, files)
    """

    config = self.configuration

    # header parameters
    header_params = header_params or {}
    header_params.update(self.default_headers)
    if self.cookie:
        header_params['Cookie'] = self.cookie
    if header_params:
        header_params = self.sanitize_for_serialization(header_params)
        header_params = dict(
            self.parameters_to_tuples(header_params,collection_formats)
        )

    # path parameters
    if path_params:
        path_params = self.sanitize_for_serialization(path_params)
        path_params = self.parameters_to_tuples(
            path_params,
            collection_formats
        )
        for k, v in path_params:
            # specified safe chars, encode everything
            resource_path = resource_path.replace(
                '{%s}' % k,
                quote(str(v), safe=config.safe_chars_for_path_param)
            )

    # post parameters
    if post_params or files:
        post_params = post_params if post_params else []
        post_params = self.sanitize_for_serialization(post_params)
        post_params = self.parameters_to_tuples(
            post_params,
            collection_formats
        )
        post_params.extend(self.files_parameters(files))

    # auth setting
    self.update_params_for_auth(
        header_params,
        query_params,
        auth_settings,
        resource_path,
        method,
        body,
        request_auth=_request_auth
    )

    # body
    if body:
        body = self.sanitize_for_serialization(body)

    # request url
    if _host is None:
        url = self.configuration.host + resource_path
    else:
        # use server/host defined in path or operation instead
        url = _host + resource_path

    # query parameters
    if query_params:
        query_params = self.sanitize_for_serialization(query_params)
        url_query = self.parameters_to_url_query(
            query_params,
            collection_formats
        )
        url += "?" + url_query

    return method, url, header_params, body, post_params

parameters_to_tuples(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters:

Name	Type	Description	Default
params		Parameters as dict or list of two-tuples	required
collection_formats	dict	Parameter collection formats	required

Returns:

Type	Description
	Parameters as list of tuples, collections formatted

Source code in cheshire_cat_api/api_client.py

def parameters_to_tuples(self, params, collection_formats):
    """Get parameters as list of tuples, formatting collections.

    :param params: Parameters as dict or list of two-tuples
    :param dict collection_formats: Parameter collection formats
    :return: Parameters as list of tuples, collections formatted
    """
    new_params = []
    if collection_formats is None:
        collection_formats = {}
    for k, v in params.items() if isinstance(params, dict) else params:
        if k in collection_formats:
            collection_format = collection_formats[k]
            if collection_format == 'multi':
                new_params.extend((k, value) for value in v)
            else:
                if collection_format == 'ssv':
                    delimiter = ' '
                elif collection_format == 'tsv':
                    delimiter = '\t'
                elif collection_format == 'pipes':
                    delimiter = '|'
                else:  # csv is the default
                    delimiter = ','
                new_params.append(
                    (k, delimiter.join(str(value) for value in v)))
        else:
            new_params.append((k, v))
    return new_params

parameters_to_url_query(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters:

Name	Type	Description	Default
params		Parameters as dict or list of two-tuples	required
collection_formats	dict	Parameter collection formats	required

Returns:

Type	Description
	URL query string (e.g. a=Hello%20World&b=123)

Source code in cheshire_cat_api/api_client.py

def parameters_to_url_query(self, params, collection_formats):
    """Get parameters as list of tuples, formatting collections.

    :param params: Parameters as dict or list of two-tuples
    :param dict collection_formats: Parameter collection formats
    :return: URL query string (e.g. a=Hello%20World&b=123)
    """
    new_params = []
    if collection_formats is None:
        collection_formats = {}
    for k, v in params.items() if isinstance(params, dict) else params:
        if isinstance(v, bool):
            v = str(v).lower()
        if isinstance(v, (int, float)):
            v = str(v)
        if isinstance(v, dict):
            v = json.dumps(v)

        if k in collection_formats:
            collection_format = collection_formats[k]
            if collection_format == 'multi':
                new_params.extend((k, value) for value in v)
            else:
                if collection_format == 'ssv':
                    delimiter = ' '
                elif collection_format == 'tsv':
                    delimiter = '\t'
                elif collection_format == 'pipes':
                    delimiter = '|'
                else:  # csv is the default
                    delimiter = ','
                new_params.append(
                    (k, delimiter.join(quote(str(value)) for value in v))
                )
        else:
            new_params.append((k, quote(str(v))))

    return "&".join(["=".join(item) for item in new_params])

response_deserialize(response_data=None, response_types_map=None)

Deserializes response into an object.

Parameters:

Name	Type	Description	Default
response_data		RESTResponse object to be deserialized.	None
response_types_map		dict of response types.	None

Returns:

Type	Description
ApiResponse	ApiResponse

Source code in cheshire_cat_api/api_client.py

def response_deserialize(
    self,
    response_data=None,
    response_types_map=None
) -> ApiResponse:
    """Deserializes response into an object.
    :param response_data: RESTResponse object to be deserialized.
    :param response_types_map: dict of response types.
    :return: ApiResponse
    """


    response_type = response_types_map.get(str(response_data.status), None)
    if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599:
        # if not found, look for '1XX', '2XX', etc.
        response_type = response_types_map.get(str(response_data.status)[0] + "XX", None)

    if not 200 <= response_data.status <= 299:
        if response_data.status == 400:
            raise BadRequestException(http_resp=response_data)

        if response_data.status == 401:
            raise UnauthorizedException(http_resp=response_data)

        if response_data.status == 403:
            raise ForbiddenException(http_resp=response_data)

        if response_data.status == 404:
            raise NotFoundException(http_resp=response_data)

        if 500 <= response_data.status <= 599:
            raise ServiceException(http_resp=response_data)
        raise ApiException(http_resp=response_data)

    # deserialize response data

    if response_type == "bytearray":
        return_data = response_data.data
    elif response_type is None:
        return_data = None
    elif response_type == "file":
        return_data = self.__deserialize_file(response_data)
    else:
        match = None
        content_type = response_data.getheader('content-type')
        if content_type is not None:
            match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type)
        encoding = match.group(1) if match else "utf-8"
        response_text = response_data.data.decode(encoding)
        return_data = self.deserialize(response_text, response_type)

    return ApiResponse(
        status_code = response_data.status,
        data = return_data,
        headers = response_data.getheaders(),
        raw_data = response_data.data
    )

sanitize_for_serialization(obj)

Builds a JSON POST object.

If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date convert to string in iso8601 format. If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is OpenAPI model, return the properties dict.

Parameters:

Name	Type	Description	Default
obj		The data to serialize.	required

Returns:

Type	Description
	The serialized form of data.

Source code in cheshire_cat_api/api_client.py

def sanitize_for_serialization(self, obj):
    """Builds a JSON POST object.

    If obj is None, return None.
    If obj is str, int, long, float, bool, return directly.
    If obj is datetime.datetime, datetime.date
        convert to string in iso8601 format.
    If obj is list, sanitize each element in the list.
    If obj is dict, return the dict.
    If obj is OpenAPI model, return the properties dict.

    :param obj: The data to serialize.
    :return: The serialized form of data.
    """
    if obj is None:
        return None
    elif isinstance(obj, self.PRIMITIVE_TYPES):
        return obj
    elif isinstance(obj, list):
        return [
            self.sanitize_for_serialization(sub_obj) for sub_obj in obj
        ]
    elif isinstance(obj, tuple):
        return tuple(
            self.sanitize_for_serialization(sub_obj) for sub_obj in obj
        )
    elif isinstance(obj, (datetime.datetime, datetime.date)):
        return obj.isoformat()

    elif isinstance(obj, dict):
        obj_dict = obj
    else:
        # Convert model obj to dict except
        # attributes `openapi_types`, `attribute_map`
        # and attributes which value is not None.
        # Convert attribute name to json key in
        # model definition for request.
        obj_dict = obj.to_dict()

    return {
        key: self.sanitize_for_serialization(val)
        for key, val in obj_dict.items()
    }

select_header_accept(accepts)

Returns Accept based on an array of accepts provided.

Parameters:

Name	Type	Description	Default
accepts	List[str]	List of headers.	required

Returns:

Type	Description
Optional[str]	Accept (e.g. application/json).

Source code in cheshire_cat_api/api_client.py

def select_header_accept(self, accepts: List[str]) -> Optional[str]:
    """Returns `Accept` based on an array of accepts provided.

    :param accepts: List of headers.
    :return: Accept (e.g. application/json).
    """
    if not accepts:
        return None

    for accept in accepts:
        if re.search('json', accept, re.IGNORECASE):
            return accept

    return accepts[0]

select_header_content_type(content_types)

Returns Content-Type based on an array of content_types provided.

Parameters:

Name	Type	Description	Default
content_types		List of content-types.	required

Returns:

Type	Description
	Content-Type (e.g. application/json).

Source code in cheshire_cat_api/api_client.py

def select_header_content_type(self, content_types):
    """Returns `Content-Type` based on an array of content_types provided.

    :param content_types: List of content-types.
    :return: Content-Type (e.g. application/json).
    """
    if not content_types:
        return None

    for content_type in content_types:
        if re.search('json', content_type, re.IGNORECASE):
            return content_type

    return content_types[0]

set_default(default) classmethod

Set default instance of ApiClient.

It stores default ApiClient.

Parameters:

Name	Type	Description	Default
default		object of ApiClient.	required

Source code in cheshire_cat_api/api_client.py

@classmethod
def set_default(cls, default):
    """Set default instance of ApiClient.

    It stores default ApiClient.

    :param default: object of ApiClient.
    """
    cls._default = default

update_params_for_auth(headers, queries, auth_settings, resource_path, method, body, request_auth=None)

Updates header and query params based on authentication setting.

:resource_path: A string representation of the HTTP request resource path. :method: A string representation of the HTTP request method. :body: A object representing the body of the HTTP request. The object type is the return value of sanitize_for_serialization().

Parameters:

Name	Type	Description	Default
headers		Header parameters dict to be updated.	required
queries		Query parameters tuple list to be updated.	required
auth_settings		Authentication setting identifiers list.	required
request_auth		if set, the provided settings will override the token in the configuration.	None

Source code in cheshire_cat_api/api_client.py

def update_params_for_auth(
    self,
    headers,
    queries,
    auth_settings,
    resource_path,
    method,
    body,
    request_auth=None
) -> None:
    """Updates header and query params based on authentication setting.

    :param headers: Header parameters dict to be updated.
    :param queries: Query parameters tuple list to be updated.
    :param auth_settings: Authentication setting identifiers list.
    :resource_path: A string representation of the HTTP request resource path.
    :method: A string representation of the HTTP request method.
    :body: A object representing the body of the HTTP request.
    The object type is the return value of sanitize_for_serialization().
    :param request_auth: if set, the provided settings will
                         override the token in the configuration.
    """
    if not auth_settings:
        return

    if request_auth:
        self._apply_auth_params(
            headers,
            queries,
            resource_path,
            method,
            body,
            request_auth
        )
    else:
        for auth in auth_settings:
            auth_setting = self.configuration.auth_settings().get(auth)
            if auth_setting:
                self._apply_auth_params(
                    headers,
                    queries,
                    resource_path,
                    method,
                    body,
                    auth_setting
                )