Skip to content
Cannot retrieve contributors at this time
# coding: utf-8
mParticle Event API
OpenAPI spec version: 1.0.1
Generated by:
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
from __future__ import absolute_import
import base64
import urllib3
import httplib
except ImportError:
# for python3
import http.client as httplib
import sys
import logging
from six import iteritems
class Configuration(object):
def __init__(self):
# Default Base url = ""
# Default api client
self.api_client = None
# Temp file folder for downloading files
self.temp_folder_path = None
# Authentication Settings
# dict to store API key(s)
self.api_key_store = {}
# dict to store API prefix (e.g. Bearer)
self.api_key_prefix = {}
# API key for HTTP basic authentication
self.api_key = ""
# API secret for HTTP basic authentication
self.api_secret = ""
# Logging Settings
self.logger = {}
self.logger["package_logger"] = logging.getLogger("mparticle")
self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler
self.logger_stream_handler = None
# Log file handler
self.logger_file_handler = None
# Debug file location
self.logger_file = None
# Debug switch
self.debug = False
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API from https server.
self.verify_ssl = True
# Set this to customize the certificate file to verify the peer.
self.ssl_ca_cert = None
# client certificate file
self.cert_file = None
# client key file
self.key_file = None
# number of simultaneous connection to maintain
self.connection_pool_size = 1
def logger_file(self):
Gets the logger_file.
return self.__logger_file
def logger_file(self, value):
Sets the logger_file.
If the logger_file is None, then add stream handler and remove file handler.
Otherwise, add file handler and remove stream handler.
:param value: The logger_file path.
:type: str
self.__logger_file = value
if self.__logger_file:
# If set logging file,
# then add file handler and remove stream handler.
self.logger_file_handler = logging.FileHandler(self.__logger_file)
for _, logger in iteritems(self.logger):
if self.logger_stream_handler:
# If not set logging file,
# then add stream handler and remove file handler.
self.logger_stream_handler = logging.StreamHandler()
for _, logger in iteritems(self.logger):
if self.logger_file_handler:
def debug(self):
Gets the debug status.
return self.__debug
def debug(self, value):
Sets the debug status.
:param value: The debug status, True or False.
:type: bool
self.__debug = value
if self.__debug:
# if debug status is True, turn on debug logging
for _, logger in iteritems(self.logger):
# turn on httplib debug
httplib.HTTPConnection.debuglevel = 1
# if debug status is False, turn off debug logging,
# setting log level to default `logging.WARNING`
for _, logger in iteritems(self.logger):
# turn off httplib debug
httplib.HTTPConnection.debuglevel = 0
def logger_format(self):
Gets the logger_format.
return self.__logger_format
def logger_format(self, value):
Sets the logger_format.
The logger_formatter will be updated when sets logger_format.
:param value: The format string.
:type: str
self.__logger_format = value
self.logger_formatter = logging.Formatter(self.__logger_format)
def get_api_key_with_prefix(self, identifier):
Gets API key (with prefix if set).
:param identifier: The identifier of apiKey.
:return: The token for api key authentication.
if self.api_key_store.get(identifier) and self.api_key_prefix.get(identifier):
return self.api_key_prefix[identifier] + ' ' + self.api_key_store[identifier]
elif self.api_key_store.get(identifier):
return self.api_key_store[identifier]
def get_basic_auth_token(self):
Gets HTTP basic authentication header (string).
:return: The token for basic HTTP authentication.
return urllib3.util.make_headers(basic_auth=self.api_key + ':' + self.api_secret)\
def auth_settings(self):
Gets Auth Settings dict for api client.
:return: The Auth Settings information dict.
return {
'type': 'basic',
'in': 'header',
'key': 'Authorization',
'value': self.get_basic_auth_token()
def to_debug_report(self):
Gets the essential information for debugging.
:return: The report for debugging.
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 0.9.1\n"\
"SDK Package Version: 0.9.1".\
format(env=sys.platform, pyversion=sys.version)