arkouda.core¶
Submodules¶
Classes¶
Enum for defining valid log levels used by ArkoudaLogger. |
Functions¶
|
Deprecated alias for |
|
Disables verbose logging. |
Deprecated alias for |
|
|
Enable verbose logging (DEBUG log level) for all ArkoudaLoggers. |
|
Allow the user to write custom logs. |
Package Contents¶
- class arkouda.core.LogLevel(*args, **kwds)[source]¶
Bases:
enum.EnumEnum 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.disableVerbose(logLevel: LogLevel = LogLevel.INFO)[source]¶
Deprecated alias for
disable_verbose().This function exists for backward compatibility only. Use
disable_verbose()instead.- Parameters:
logLevel (LogLevel, default LogLevel.INFO) – The log level to apply to all ArkoudaLoggers, disabling verbose (DEBUG-level) output.
- Return type:
None
- Warns:
DeprecationWarning – Always raised.
disableVerboseis deprecated and will be removed in a future release.
See also
disable_verboseDisable verbose logging for all loggers.
enable_verboseEnable verbose logging for all loggers.
- arkouda.core.disable_verbose(logLevel: LogLevel = LogLevel.INFO) None[source]¶
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.enableVerbose()[source]¶
Deprecated alias for
enable_verbose().This function exists for backward compatibility only. Use
enable_verbose()instead.- Return type:
None
- Warns:
DeprecationWarning – Always raised.
enableVerboseis deprecated and will be removed in a future release.
See also
enable_verboseEnable verbose (DEBUG-level) logging for all loggers.
- arkouda.core.enable_verbose() None[source]¶
Enable verbose logging (DEBUG log level) for all ArkoudaLoggers.
- arkouda.core.write_log(log_msg: str, tag: str = 'ClientGeneratedLog', log_lvl: LogLevel = LogLevel.INFO)[source]¶
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