4.7.5. Tools

• 4.7.5.1. Data classes
  • BaseEnum
    • BaseEnum._enums()
    • BaseEnum.value_matches()
    • BaseEnum.get_value()
    • BaseEnum.get_obj_by_value()
    • BaseEnum.get_name_by_value()
    • BaseEnum.get_value_by_value()
    • BaseEnum.keys()
    • BaseEnum.values()
    • BaseEnum.to_dict()
  • BaseData
    • BaseData.to_dict()
    • BaseData.replace()
    • BaseData._human_key()
    • BaseData.get_fields()
  • PropsData
    • PropsData.raw
    • PropsData.__str__()
    • PropsData.__repr__()
    • PropsData.to_str_properties()
    • PropsData.to_dict()
    • PropsData._human_key()
    • PropsData.get_fields()
    • PropsData.replace()
• 4.7.5.2. Exceptions and warnings
  • get_exc_str()
  • AxonWarning
    • AxonWarning.__init__()
    • AxonWarning.args
    • AxonWarning.with_traceback()
  • ApiWarning
    • ApiWarning.__init__()
    • ApiWarning.args
    • ApiWarning.with_traceback()
  • GuiQueryWizardWarning
    • GuiQueryWizardWarning.__init__()
    • GuiQueryWizardWarning.args
    • GuiQueryWizardWarning.with_traceback()
  • ExtraAttributeWarning
    • ExtraAttributeWarning.__init__()
    • ExtraAttributeWarning.args
    • ExtraAttributeWarning.with_traceback()
  • UnknownFieldSchema
    • UnknownFieldSchema.__init__()
    • UnknownFieldSchema.args
    • UnknownFieldSchema.with_traceback()
  • AxonError
    • AxonError.__init__()
    • AxonError.args
    • AxonError.with_traceback()
  • AxonTypeError
    • AxonTypeError.__init__()
    • AxonTypeError.args
    • AxonTypeError.with_traceback()
  • ApiError
    • ApiError.__init__()
    • ApiError.args
    • ApiError.with_traceback()
  • ConfirmNotTrue
    • ConfirmNotTrue.__init__()
    • ConfirmNotTrue.args
    • ConfirmNotTrue.with_traceback()
  • NotAllowedError
    • NotAllowedError.__init__()
    • NotAllowedError.args
    • NotAllowedError.with_traceback()
  • ToolsError
    • ToolsError.__init__()
    • ToolsError.args
    • ToolsError.with_traceback()
  • AuthError
    • AuthError.__init__()
    • AuthError.args
    • AuthError.with_traceback()
  • NotFoundError
    • NotFoundError.__init__()
    • NotFoundError.args
    • NotFoundError.with_traceback()
  • SavedQueryNotFoundError
    • SavedQueryNotFoundError.__init__()
    • SavedQueryNotFoundError.args
    • SavedQueryNotFoundError.with_traceback()
  • SavedQueryTagsNotFoundError
    • SavedQueryTagsNotFoundError.__init__()
    • SavedQueryTagsNotFoundError.args
    • SavedQueryTagsNotFoundError.with_traceback()
  • AlreadyExists
    • AlreadyExists.__init__()
    • AlreadyExists.args
    • AlreadyExists.with_traceback()
  • NotLoggedIn
    • NotLoggedIn.__init__()
    • NotLoggedIn.args
    • NotLoggedIn.with_traceback()
  • AlreadyLoggedIn
    • AlreadyLoggedIn.__init__()
    • AlreadyLoggedIn.args
    • AlreadyLoggedIn.with_traceback()
  • ConnectError
    • ConnectError.__init__()
    • ConnectError.args
    • ConnectError.with_traceback()
  • HttpError
    • HttpError.__init__()
    • HttpError.args
    • HttpError.with_traceback()
  • ConfigError
    • ConfigError.__init__()
    • ConfigError.args
    • ConfigError.with_traceback()
  • ConfigInvalidValue
    • ConfigInvalidValue.__init__()
    • ConfigInvalidValue.args
    • ConfigInvalidValue.with_traceback()
  • ConfigUnchanged
    • ConfigUnchanged.__init__()
    • ConfigUnchanged.args
    • ConfigUnchanged.with_traceback()
  • ConfigUnknown
    • ConfigUnknown.__init__()
    • ConfigUnknown.args
    • ConfigUnknown.with_traceback()
  • ConfigRequired
    • ConfigRequired.__init__()
    • ConfigRequired.args
    • ConfigRequired.with_traceback()
  • CnxError
    • CnxError.__init__()
    • CnxError.args
    • CnxError.with_traceback()
  • CnxGoneError
    • CnxGoneError.__init__()
    • CnxGoneError.args
    • CnxGoneError.with_traceback()
  • CnxUpdateError
    • CnxUpdateError.__init__()
    • CnxUpdateError.args
    • CnxUpdateError.with_traceback()
  • CnxTestError
    • CnxTestError.__init__()
    • CnxTestError.args
    • CnxTestError.with_traceback()
  • CnxAddError
    • CnxAddError.cnx_new
    • CnxAddError.__init__()
    • CnxAddError.args
    • CnxAddError.with_traceback()
  • ResponseError
    • ResponseError.__init__()
    • ResponseError.build_errmsg()
    • ResponseError.args
    • ResponseError.with_traceback()
  • InvalidCredentials
    • InvalidCredentials.__init__()
    • InvalidCredentials.args
    • InvalidCredentials.build_errmsg()
    • InvalidCredentials.with_traceback()
    • InvalidCredentials.response
    • InvalidCredentials.exc
    • InvalidCredentials.msg
    • InvalidCredentials.errmsg
  • ResponseNotOk
    • ResponseNotOk.__init__()
    • ResponseNotOk.args
    • ResponseNotOk.build_errmsg()
    • ResponseNotOk.with_traceback()
    • ResponseNotOk.response
    • ResponseNotOk.exc
    • ResponseNotOk.msg
    • ResponseNotOk.errmsg
  • JsonInvalidError
    • JsonInvalidError.__init__()
    • JsonInvalidError.args
    • JsonInvalidError.build_errmsg()
    • JsonInvalidError.with_traceback()
    • JsonInvalidError.response
    • JsonInvalidError.exc
    • JsonInvalidError.msg
    • JsonInvalidError.errmsg
  • JsonError
    • JsonError.__init__()
    • JsonError.args
    • JsonError.build_errmsg()
    • JsonError.with_traceback()
    • JsonError.response
    • JsonError.exc
    • JsonError.msg
    • JsonError.errmsg
  • WizardError
    • WizardError.__init__()
    • WizardError.args
    • WizardError.with_traceback()
  • ApiAttributeExtraWarning
    • ApiAttributeExtraWarning.__init__()
    • ApiAttributeExtraWarning.args
    • ApiAttributeExtraWarning.with_traceback()
  • ApiAttributeError
    • ApiAttributeError.__init__()
    • ApiAttributeError.args
    • ApiAttributeError.with_traceback()
  • ApiAttributeTypeError
    • ApiAttributeTypeError.__init__()
    • ApiAttributeTypeError.args
    • ApiAttributeTypeError.with_traceback()
  • ApiAttributeMissingError
    • ApiAttributeMissingError.__init__()
    • ApiAttributeMissingError.args
    • ApiAttributeMissingError.with_traceback()
  • NoTriggerDefinedError
    • NoTriggerDefinedError.__init__()
    • NoTriggerDefinedError.args
    • NoTriggerDefinedError.with_traceback()
  • StopFetch
    • StopFetch.__init__()
    • StopFetch.args
    • StopFetch.with_traceback()
  • SchemaError
    • SchemaError.__init__()
    • SchemaError.args
    • SchemaError.with_traceback()
  • RequestError
    • RequestError.__init__()
    • RequestError.args
    • RequestError.with_traceback()
  • RequestMissingArgsError
    • RequestMissingArgsError.__init__()
    • RequestMissingArgsError.args
    • RequestMissingArgsError.with_traceback()
  • RequestObjectTypeError
    • RequestObjectTypeError.__init__()
    • RequestObjectTypeError.args
    • RequestObjectTypeError.with_traceback()
  • RequestFormatError
    • RequestFormatError.__init__()
    • RequestFormatError.args
    • RequestFormatError.with_traceback()
  • RequestFormatPathError
    • RequestFormatPathError.__init__()
    • RequestFormatPathError.args
    • RequestFormatPathError.with_traceback()
  • RequestFormatObjectError
    • RequestFormatObjectError.__init__()
    • RequestFormatObjectError.args
    • RequestFormatObjectError.with_traceback()
  • RequestLoadObjectError
    • RequestLoadObjectError.__init__()
    • RequestLoadObjectError.args
    • RequestLoadObjectError.with_traceback()
  • ResponseLoadObjectError
    • ResponseLoadObjectError.__init__()
    • ResponseLoadObjectError.args
    • ResponseLoadObjectError.with_traceback()
  • FeatureNotEnabledError
    • FeatureNotEnabledError.__init__()
    • FeatureNotEnabledError.args
    • FeatureNotEnabledError.with_traceback()
  • RunnerError
    • RunnerError.__init__()
    • RunnerError.args
    • RunnerError.with_traceback()
  • RunnerWarning
    • RunnerWarning.__init__()
    • RunnerWarning.args
    • RunnerWarning.with_traceback()
  • GrabberError
    • GrabberError.__init__()
    • GrabberError.args
    • GrabberError.with_traceback()
  • GrabberWarning
    • GrabberWarning.__init__()
    • GrabberWarning.args
    • GrabberWarning.with_traceback()
  • FolderAlreadyExistsError
    • FolderAlreadyExistsError.__init__()
    • FolderAlreadyExistsError.args
    • FolderAlreadyExistsError.with_traceback()
  • FolderNotFoundError
    • FolderNotFoundError.__init__()
    • FolderNotFoundError.args
    • FolderNotFoundError.with_traceback()
  • SearchError
    • SearchError.__init__()
    • SearchError.args
    • SearchError.with_traceback()
  • SearchUnmatchedError
    • SearchUnmatchedError.__init__()
    • SearchUnmatchedError.args
    • SearchUnmatchedError.with_traceback()
  • SearchNoMatchesError
    • SearchNoMatchesError.__init__()
    • SearchNoMatchesError.args
    • SearchNoMatchesError.with_traceback()
  • SearchNoObjectsError
    • SearchNoObjectsError.__init__()
    • SearchNoObjectsError.args
    • SearchNoObjectsError.with_traceback()
  • DecodeError
    • DecodeError.value
    • DecodeError.encoding_format
    • DecodeError.encoding_errors
    • DecodeError.__init__()
    • DecodeError.args
    • DecodeError.with_traceback()
  • InvalidObjectIdError
    • InvalidObjectIdError.value
    • InvalidObjectIdError.__init__()
    • InvalidObjectIdError.args
    • InvalidObjectIdError.with_traceback()
  • InvalidTypeError
    • InvalidTypeError.value
    • InvalidTypeError.allowed_types
    • InvalidTypeError.__init__()
    • InvalidTypeError.args
    • InvalidTypeError.with_traceback()
  • FormatError
    • FormatError.__init__()
    • FormatError.args
    • FormatError.with_traceback()
• 4.7.5.3. HTTP Client
  • is_headers()
  • is_cookies()
  • Http
    • Http.LOG_REQUEST_ATTRS
    • Http.LOG_RESPONSE_ATTRS
    • Http.URL_CERT
    • Http.URL_CERT_CHAIN
    • Http.CLIENT
    • Http.__init__()
    • Http.session
    • Http.LOG_LEVEL
    • Http.LOG
    • Http.HISTORY
    • Http.LAST_REQUEST
    • Http.LAST_RESPONSE
    • Http.LOG_BODY_LINES
    • Http.LOG_HIDE_HEADERS
    • Http.LOG_HIDE_STR
    • Http.LOG_LEVEL_URLLIB
    • Http.LOG_REQUEST_BODY
    • Http.LOG_RESPONSE_BODY
    • Http.URLPARSED
    • Http.url
    • Http.HTTP_HEADERS
    • Http.HTTP_COOKIES
    • Http.CERT_PATH
    • Http.CERT_WARN
    • Http.CERT_VERIFY
    • Http.CERT_CLIENT_BOTH
    • Http.CERT_CLIENT_CERT
    • Http.CERT_CLIENT_KEY
    • Http.CONNECT_TIMEOUT
    • Http.RESPONSE_TIMEOUT
    • Http.HTTP_PROXY
    • Http.HTTPS_PROXY
    • Http.SAVE_HISTORY
    • Http.SAVE_LAST
    • Http.MAX_RETRIES
    • Http.RETRY_BACKOFF
    • Http.set_cf_token()
    • Http.safe_request()
    • Http.get_cert()
    • Http.get_cert_chain()
    • Http.parse_url()
    • Http.new_session()
    • Http.set_session_headers()
    • Http.set_session_cookies()
    • Http.set_session_proxies()
    • Http.set_session_verify()
    • Http.set_session_cert()
    • Http.set_urllib_warnings()
    • Http.set_urllib_log()
    • Http.__call__()
    • Http.__str__()
    • Http.__repr__()
    • Http.user_agent
    • Http._do_log_request()
    • Http._clean_headers()
    • Http._do_log_response()
    • Http.log_request_attrs
    • Http.log_response_attrs
    • Http._get_log_attrs()
    • Http._set_log_attrs()
    • Http.log_body()
    • Http._init()
• 4.7.5.4. Logging utilities
  • HideFormatter
    • HideFormatter.HIDE_ENABLED
    • HideFormatter.HIDE_REGEX
    • HideFormatter.HIDE_REPLACE
    • HideFormatter.format()
    • HideFormatter.__init__()
    • HideFormatter.converter()
    • HideFormatter.default_msec_format
    • HideFormatter.default_time_format
    • HideFormatter.formatException()
    • HideFormatter.formatMessage()
    • HideFormatter.formatStack()
    • HideFormatter.formatTime()
    • HideFormatter.usesTime()
  • get_echoer()
  • get_log_method()
  • gmtime()
  • localtime()
  • get_obj_log()
  • set_log_level()
  • str_level()
  • add_stderr()
  • add_stdout()
  • add_file()
  • add_null()
  • add_handler()
  • del_stderr()
  • del_stdout()
  • del_file()
  • del_null()
  • del_handler()
  • find_handlers()
  • handle_unhandled_exception()
• 4.7.5.5. Setup environment variables
  • LOGGER
  • YES
  • NO
  • CF_PRE
  • KEY_DEFAULT_PATH
  • KEY_ENV_FILE
  • KEY_ENV_PATH
  • KEY_OVERRIDE
  • KEY_URL
  • KEY_KEY
  • KEY_SECRET
  • KEY_FEATURES
  • KEY_CERTWARN
  • KEY_CERTPATH
  • KEY_DEBUG
  • KEY_DEBUG_PRINT
  • KEY_USER_AGENT
  • DEFAULT_DEBUG
  • DEFAULT_DEBUG_PRINT
  • DEFAULT_OVERRIDE
  • DEFAULT_CERTWARN
  • DEFAULT_ENV_FILE
  • KEYS_HIDDEN
  • KEY_MATCHES
  • HIDDEN
  • is_empty_object()
  • is_empty_string()
  • is_empty()
  • Results
    • Results.supplied
    • Results.env_path
    • Results.default_path
    • Results.find_dotenv_cwd
    • Results.find_dotenv_script
    • Results.not_found
  • spew()
  • get_file_or_dir_with_file()
  • find_dotenv()
  • MSG
    • MSG.not_found
    • MSG.already_loaded
    • MSG.loading
  • load_dotenv()
  • get_env_ax_env()
  • get_env_str()
  • get_env_bool()
  • get_env_extra_warn()
  • get_env_path()
  • get_env_csv()
  • get_env_user_agent()
  • load_schema()
  • get_env_connect()
  • get_env_features()
  • hide_value()
  • hide_values()
  • get_env_ax()
  • set_env()
  • bytes_to_str()
  • DEBUG_PRINT
  • DEBUG
  • DEFAULT_PATH
• 4.7.5.6. Utilities
  • type_str()
  • pathify()
  • is_existing_file()
  • listify()
  • grouper()
  • coerce_int()
  • coerce_int_float()
  • coerce_bool()
  • is_str()
  • is_email()
  • is_int()
  • join_url()
  • strip_right()
  • strip_left()
  • AxJSONEncoder
    • AxJSONEncoder.__init__()
    • AxJSONEncoder.default()
    • AxJSONEncoder.encode()
    • AxJSONEncoder.item_separator
    • AxJSONEncoder.iterencode()
    • AxJSONEncoder.key_separator
  • has_to_dict()
  • json_dump()
  • lens()
  • tlens()
  • json_load()
  • is_file_like()
  • csv_load()
  • jsonl_loader()
  • jsonl_load()
  • json_log()
  • json_reload()
  • text_load()
  • dt_parse_uuid()
  • dt_parse()
  • dt_parse_tmpl()
  • dt_now()
  • dt_now_file()
  • dt_sec_ago()
  • dt_days_ago()
  • dt_min_ago()
  • dt_days_left()
  • dt_within_min()
  • get_path()
  • path_read()
  • get_backup_filename()
  • get_backup_path()
  • check_path_is_not_dir()
  • path_create_parent_dir()
  • path_backup_file()
  • auto_suffix()
  • path_write()
  • longest_str()
  • split_str()
  • echo_debug()
  • echo_ok()
  • echo_warn()
  • echo_error()
  • echo()
  • sysinfo()
  • calc_percent()
  • trim_float()
  • join_kv()
  • get_type_str()
  • check_type()
  • check_empty()
  • get_raw_version()
  • coerce_str_to_csv()
  • parse_ip_address()
  • parse_ip_network()
  • kv_dump()
  • bom_strip()
  • read_stream()
  • check_gui_page_size()
  • calc_gb()
  • calc_perc_gb()
  • get_subcls()
  • prettify_obj()
  • token_parse()
  • combo_dicts()
  • is_url()
  • bytes_to_str()
  • strip_str()
  • coerce_str()
  • str_trim()
  • get_cls_path()
  • csv_writer()
  • parse_int_min_max()
  • safe_replace()
  • safe_format()
  • get_paths_format()
  • int_days_map()
  • lowish()
  • log_or_exc()
  • coerce_io()
  • is_json_dict()
  • extract_kvs_auto()
  • trype()
  • extract_kvs_json()
  • is_callable()
  • extract_kvs_csv()
  • tilde_re()
  • coerce_str_re()
  • human_size()
  • is_pattern()
  • is_tty()
  • check_tty()
  • check_tty_stdin()
  • get_secho_args()
  • confirm()
  • coerce_prompt_confirm()
  • check_confirm_prompt()
  • csv_able()
  • is_list()
  • style_switch()
  • add_source()
  • parse_value_copy()
  • parse_refresh()
  • get_diff_seconds()
  • score_prefix()
  • get_mm_field()
  • get_mm_description()
  • is_nested_schema()
  • get_nested_schema()
  • get_hint_type()
  • is_subclass()
  • get_query_id()
  • jdump()
  • is_subclass_safe()
  • trim_value_repr()
  • coerce_seconds()
  • coerce_delta()
  • coerce_date_delta()