pyevr.openapi_client package

Subpackages

Submodules

pyevr.openapi_client.api_client module

EVR API

OpenAPI Generator’i jaoks kohandatud EVR API kirjeldus. Kasuta seda juhul, kui spetsifikatsioonile vastava EVR API kirjeldusega ei õnnestu klienti genereerida. # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class pyevr.openapi_client.api_client.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None, pool_threads=1)[source]

Bases: object

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.

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech Do not edit the class manually.

Parameters:
  • configuration – .Configuration object for this client
  • header_name – a header to pass when making calls to the API.
  • header_value – a header value to pass when making calls to the API.
  • cookie – a cookie to include in the header when making calls to the API
  • pool_threads – The number of threads to use for async requests to the API. More threads means more concurrent API requests.
NATIVE_TYPES_MAPPING = {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}
PRIMITIVE_TYPES = (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)
call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None, _host=None)[source]

Makes the HTTP request (synchronous) and returns deserialized data.

To make an async_req request, set the async_req parameter.

Parameters:
  • resource_path – Path to method endpoint.
  • method – Method to call.
  • path_params – Path parameters in the url.
  • query_params – Query parameters in the url.
  • header_params – Header parameters to be placed in the request header.
  • body – Request body.
  • dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.
  • list (auth_settings) – Auth Settings names for the request.
  • response – Response data type.
  • dict – key -> filename, value -> filepath, for multipart/form-data.
  • bool (async_req) – execute request asynchronously
  • _return_http_data_only – response data without head status code and headers
  • collection_formats – dict of collection formats for path, query, header, and post parameters.
  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
  • _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.
Returns:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.
deserialize(response, response_type)[source]

Deserializes response into an object.

Parameters:
  • response – RESTResponse object to be deserialized.
  • response_type – class literal for deserialized object, or string of class name.
Returns:

deserialized object.
files_parameters(files=None)[source]

Builds form parameters.

Parameters:files – File parameters.
Returns:Form parameters with files.
parameters_to_tuples(params, collection_formats)[source]

Get parameters as list of tuples, formatting collections.

Parameters:
  • params – Parameters as dict or list of two-tuples
  • collection_formats (dict) – Parameter collection formats
Returns:

Parameters as list of tuples, collections formatted
pool

Create thread pool on first request avoids instantiating unused threadpool for blocking clients.

request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)[source]

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:obj – The data to serialize.
Returns:The serialized form of data.
select_header_accept(accepts)[source]

Returns Accept based on an array of accepts provided.

Parameters:accepts – List of headers.
Returns:Accept (e.g. application/json).
select_header_content_type(content_types)[source]

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

Parameters:content_types – List of content-types.
Returns:Content-Type (e.g. application/json).
set_default_header(header_name, header_value)[source]
update_params_for_auth(headers, querys, auth_settings)[source]

Updates header and query params based on authentication setting.

Parameters:
  • headers – Header parameters dict to be updated.
  • querys – Query parameters tuple list to be updated.
  • auth_settings – Authentication setting identifiers list.
user_agent

User agent for this API client

pyevr.openapi_client.configuration module

EVR API

OpenAPI Generator’i jaoks kohandatud EVR API kirjeldus. Kasuta seda juhul, kui spetsifikatsioonile vastava EVR API kirjeldusega ei õnnestu klienti genereerida. # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class pyevr.openapi_client.configuration.Configuration(host='https://evr-test.azurewebsites.net', api_key={}, api_key_prefix={}, username='', password='')[source]

Bases: object

NOTE: This class is auto generated by OpenAPI Generator

Ref: https://openapi-generator.tech Do not edit the class manually.

Parameters:
  • host – Base url
  • api_key – Dict to store API key(s)
  • api_key_prefix – Dict to store API prefix (e.g. Bearer)
  • username – Username for HTTP basic authentication
  • password – Password for HTTP basic authentication
api_key = None

dict to store API key(s)

api_key_prefix = None

dict to store API prefix (e.g. Bearer)

assert_hostname = None

Set this to True/False to enable/disable SSL hostname verification.

auth_settings()[source]

Gets Auth Settings dict for api client.

Returns:The Auth Settings information dict.
cert_file = None

client certificate file

connection_pool_maxsize = None

urllib3 connection pool’s maximum number of connections saved per pool. urllib3 uses 1 connection as default value, but this is not the best value when you are making a lot of possibly parallel requests to the same host, which is often the case here. cpu_count * 5 is used as default value to increase performance.

debug

Debug switch

get_api_key_with_prefix(identifier)[source]

Gets API key (with prefix if set).

Parameters:identifier – The identifier of apiKey.
Returns:The token for api key authentication.
get_basic_auth_token()[source]

Gets HTTP basic authentication header (string).

Returns:The token for basic HTTP authentication.
get_host_from_settings(index, variables={})[source]

Gets host URL based on the index and variables :param index: array index of the host settings :param variables: hash of variable and the corresponding value :return: URL based on host settings

get_host_settings()[source]

Gets an array of host settings

Returns:An array of host settings
host = None

Default Base url

key_file = None

client key file

logger = None

Logging Settings

logger_file

Debug file location

logger_file_handler = None

Log file handler

logger_format

Log format

logger_stream_handler = None

Log stream handler

password = None

Password for HTTP basic authentication

proxy = None

Proxy URL

proxy_headers = None

Proxy headers

refresh_api_key_hook = None

function hook to refresh API key if expired

retries = None

Adding retries to override urllib3 default value 3

safe_chars_for_path_param = None

Safe chars for path_param

ssl_ca_cert = None

Set this to customize the certificate file to verify the peer.

temp_folder_path = None

Temp file folder for downloading files

to_debug_report()[source]

Gets the essential information for debugging.

Returns:The report for debugging.
username = None

Username for HTTP basic authentication

verify_ssl = None

SSL/TLS verification Set this to false to skip verifying SSL certificate when calling API from https server.

class pyevr.openapi_client.configuration.TypeWithDefault(name, bases, dct)[source]

Bases: type

set_default(default)[source]

pyevr.openapi_client.exceptions module

EVR API

OpenAPI Generator’i jaoks kohandatud EVR API kirjeldus. Kasuta seda juhul, kui spetsifikatsioonile vastava EVR API kirjeldusega ei õnnestu klienti genereerida. # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

exception pyevr.openapi_client.exceptions.ApiException(status=None, reason=None, http_resp=None)[source]

Bases: pyevr.openapi_client.exceptions.OpenApiException

exception pyevr.openapi_client.exceptions.ApiKeyError(msg, path_to_item=None)[source]

Bases: pyevr.openapi_client.exceptions.OpenApiException, KeyError

exception pyevr.openapi_client.exceptions.ApiTypeError(msg, path_to_item=None, valid_classes=None, key_type=None)[source]

Bases: pyevr.openapi_client.exceptions.OpenApiException, TypeError

exception pyevr.openapi_client.exceptions.ApiValueError(msg, path_to_item=None)[source]

Bases: pyevr.openapi_client.exceptions.OpenApiException, ValueError

exception pyevr.openapi_client.exceptions.OpenApiException[source]

Bases: Exception

The base exception class for all OpenAPIExceptions

pyevr.openapi_client.exceptions.render_path(path_to_item)[source]

Returns a string representation of a path

pyevr.openapi_client.rest module

EVR API

OpenAPI Generator’i jaoks kohandatud EVR API kirjeldus. Kasuta seda juhul, kui spetsifikatsioonile vastava EVR API kirjeldusega ei õnnestu klienti genereerida. # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class pyevr.openapi_client.rest.RESTClientObject(configuration, pools_size=4, maxsize=None)[source]

Bases: object

DELETE(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)[source]
GET(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)[source]
HEAD(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)[source]
OPTIONS(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]
PATCH(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]
POST(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]
PUT(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]
request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)[source]

Perform requests.

Parameters:
  • method – http request method
  • url – http request url
  • query_params – query parameters in the url
  • headers – http request headers
  • body – request json body, for application/json
  • post_params – request post parameters, application/x-www-form-urlencoded and multipart/form-data
  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
  • _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.
class pyevr.openapi_client.rest.RESTResponse(resp)[source]

Bases: io.IOBase

getheader(name, default=None)[source]

Returns a given response header.

getheaders()[source]

Returns a dictionary of the response headers.

Module contents

EVR API

OpenAPI Generator’i jaoks kohandatud EVR API kirjeldus. Kasuta seda juhul, kui spetsifikatsioonile vastava EVR API kirjeldusega ei õnnestu klienti genereerida. # noqa: E501

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech