arkouda.core

Submodules

• arkouda.core.client
• arkouda.core.infoclass
• arkouda.core.logger
• arkouda.core.security

Classes

LogLevel

Enum for defining valid log levels used by ArkoudaLogger.

Functions

disable_verbose(→ None)	Disables verbose logging.
enable_verbose(→ None)	Enable verbose logging (DEBUG log level) for all ArkoudaLoggers.
write_log(log_msg[, tag, log_lvl])	Allow the user to write custom logs.

Package Contents

class arkouda.core.LogLevel(*args, **kwds)

Bases: enum.Enum

Enum for defining valid log levels used by ArkoudaLogger.

Members

INFOstr

Confirmation that things are working as expected.

DEBUGstr

Detailed information, typically of interest only when diagnosing problems.

WARNstr

An indication that something unexpected happened, or indicative of some problem.

ERRORstr

A more serious problem, the software has not been able to perform some function.

CRITICALstr

An extremely serious error, indicating the program itself may be unable to continue.

Notes

This enum provides a controlled vocabulary for setting log levels on ArkoudaLogger instances. These are mapped internally to the standard Python logging levels.

CRITICAL = 'CRITICAL'

DEBUG = 'DEBUG'

ERROR = 'ERROR'

INFO = 'INFO'

WARN = 'WARN'

arkouda.core.disable_verbose(logLevel: LogLevel = LogLevel.INFO) → None

Disables verbose logging.

Disables verbose logging (DEBUG log level) for all ArkoudaLoggers, setting the log level for each to the logLevel parameter.

Parameters:

logLevel (LogLevel) – The new log level, defaultts to LogLevel.INFO

Raises:

TypeError – Raised if logLevel is not a LogLevel enum

arkouda.core.enable_verbose() → None

Enable verbose logging (DEBUG log level) for all ArkoudaLoggers.

arkouda.core.write_log(log_msg: str, tag: str = 'ClientGeneratedLog', log_lvl: LogLevel = LogLevel.INFO)

Allow the user to write custom logs.

Parameters:

• log_msg (str) – The message to be added to the server log

• tag (str) – The tag to use in the log. This takes the place of the server function name. Allows for easy identification of custom logs. Defaults to “ClientGeneratedLog”

• log_lvl (LogLevel) – The type of log to be written Defaults to LogLevel.INFO

See also

LogLevel