5.5. constants

Constants.

axonius_api_client.constants.load_dotenv(ax_env='/home/docs/checkouts/readthedocs.org/user_builds/axonius-api-client/checkouts/develop/docs', reenv=False, verbose=False)[source]

Pass.

axonius_api_client.constants.PY36 = True

python version is 3.6 or higher

Type:bool
axonius_api_client.constants.PY37 = True

python version is 3.7 or higher

Type:bool
axonius_api_client.constants.COMPLEX = (<class 'dict'>, <class 'list'>, <class 'tuple'>)

types that are considered as complex.

Type:tuple of type
axonius_api_client.constants.SIMPLE = (<class 'str'>, <class 'int'>, <class 'bool'>, <class 'float'>)

types that are considered as simple

Type:tuple of type
axonius_api_client.constants.EMPTY = [None, '', [], {}, ()]

values that should be considered as empty

Type:list of type
axonius_api_client.constants.YES = [True, 1, '1', 'true', 't', 'yes', 'y']

values that should be considered as truthy

Type:list of type
axonius_api_client.constants.NO = [False, 0, '0', 'false', 'f', 'no', 'n']

values that should be considered as falsey

Type:list of type
axonius_api_client.constants.MAX_PAGE_SIZE = 2000

maximum page size that REST API allows

Type:int
axonius_api_client.constants.GUI_PAGE_SIZES = [25, 50, 100]

valid page sizes for GUI paging

Type:list of int
axonius_api_client.constants.LOG_REQUEST_ATTRS_BRIEF = ['request to {request.url!r}', 'method={request.method!r}', 'size={size}']

request attributes to log when verbose=False

Type:list of str
axonius_api_client.constants.TIMEOUT_CONNECT = 5

seconds to wait for connection to API.

Type:int
axonius_api_client.constants.TIMEOUT_RESPONSE = 900

seconds to wait for response from API.

Type:int
axonius_api_client.constants.LOG_FMT_CONSOLE = '%(levelname)-8s [%(name)s] %(message)s'

default logging format to use for console logs

Type:str
axonius_api_client.constants.LOG_FMT_FILE = '%(asctime)s %(levelname)-8s [%(name)s:%(funcName)s:%(lineno)d] %(message)s'

default logging format to use for file logs

Type:str
axonius_api_client.constants.LOG_DATEFMT_CONSOLE = '%m/%d/%Y %I:%M:%S %p %Z'

default datetime format to use for console logs

Type:str
axonius_api_client.constants.LOG_DATEFMT_FILE = '%m/%d/%Y %I:%M:%S %p %Z'

default datetime format to use for file logs

Type:str
axonius_api_client.constants.LOG_LEVEL_CONSOLE = 'debug'

default logging level to use for console log handlers

Type:str
axonius_api_client.constants.LOG_LEVEL_FILE = 'debug'

default logging level to use for file log handlers

Type:str
axonius_api_client.constants.LOG_LEVEL_HTTP = 'debug'

default logging level to use for axonius_api_client.http.Http

Type:str
axonius_api_client.constants.LOG_LEVEL_AUTH = 'debug'

default logging level to use for axonius_api_client.auth.Mixins

Type:str
axonius_api_client.constants.LOG_LEVEL_API = 'debug'

default logging level to use for axonius_api_client.api.mixins.Mixins

Type:str
axonius_api_client.constants.LOG_LEVEL_PACKAGE = 'debug'

default logging level to use for axonius_api_client

Type:str
axonius_api_client.constants.LOG_LEVELS_STR = ['debug', 'info', 'warning', 'error', 'fatal']

valid logging level strs

Type:list of str
axonius_api_client.constants.LOG_LEVELS_STR_CSV = 'debug, info, warning, error, fatal'

csv of valid logging level strs

Type:str
axonius_api_client.constants.LOG_LEVELS_INT = [10, 20, 30, 40, 50]

valid logging level ints

Type:list of int
axonius_api_client.constants.LOG_LEVELS_INT_CSV = '10, 20, 30, 40, 50'

csv of valid logging level ints

Type:str
axonius_api_client.constants.LOG_FILE_PATH = '/home/docs/checkouts/readthedocs.org/user_builds/axonius-api-client/checkouts/develop/docs'

default path to use for log files

Type:str
axonius_api_client.constants.LOG_FILE_PATH_MODE = 448

default permisisons to use when creating directories

Type:str
axonius_api_client.constants.LOG_FILE_NAME = 'axonius_api_client.log'

default log file name to use

Type:str
axonius_api_client.constants.LOG_FILE_MAX_MB = 5

default rollover trigger in MB

Type:int
axonius_api_client.constants.LOG_FILE_MAX_FILES = 5

default max rollovers to keep

Type:int
axonius_api_client.constants.LOG_NAME_STDERR = 'handler_stderr'

default handler name to use for STDERR log

Type:str
axonius_api_client.constants.LOG_NAME_STDOUT = 'handler_stdout'

default handler name to use for STDOUT log

Type:str
axonius_api_client.constants.LOG_NAME_FILE = 'handler_file'

default handler name to use for file log

Type:str
axonius_api_client.constants.SETTING_UNCHANGED = ['unchanged']

ref used by REST API when supplying a password field that should remain the same as what is already in the database

Type:list of str
axonius_api_client.constants.DEFAULT_NODE = 'Master'

default node name to use

Type:str
axonius_api_client.constants.CSV_ADAPTER = 'csv'

name of csv adapter

Type:str
axonius_api_client.constants.DEFAULT_PERM = 'ReadOnly'

default user permission to use

Type:str
axonius_api_client.constants.VALID_PERMS = ['Restricted', 'ReadWrite', 'ReadOnly']

valid user permissions

Type:list of str
axonius_api_client.constants.AGG_ADAPTER_ALTS = ['generic', 'general', 'specific', 'agg', 'aggregated']

list of alternatives for ‘generic’ adapter.

Type:list of str