log module

Class	Description
binaryninja.log.Logger

Function	Description
binaryninja.log.close_logs	close_logs close all log files.
binaryninja.log.is_output_redirected_to_log
binaryninja.log.log	log writes messages to the log console for the given log level.
binaryninja.log.log_alert	log_alert Logs message console and to a pop up window if run through the GUI.
binaryninja.log.log_alert_for_exception	log_alert_for_exception Logs message console, including a stack trace for the current exception.
binaryninja.log.log_alert_with_traceback	log_alert_with_traceback Logs message console, including the current stack trace.
binaryninja.log.log_debug	log_debug Logs debugging information messages to the console.
binaryninja.log.log_debug_for_exception	log_debug_for_exception Logs debugging information messages to the console, including a…
binaryninja.log.log_debug_with_traceback	log_debug_with_traceback Logs debugging information messages to the console, including the…
binaryninja.log.log_error	log_error Logs message to console, if run through the GUI it logs with Error icon,…
binaryninja.log.log_error_for_exception	log_error_for_exception Logs message to console, including a stack trace for the current…
binaryninja.log.log_error_with_traceback	log_error_with_traceback Logs message to console, including the current stack trace.
binaryninja.log.log_for_exception	log_for_exception writes messages to the log console for the given log level, including a…
binaryninja.log.log_info	log_info Logs general information messages to the console.
binaryninja.log.log_info_for_exception	log_info_for_exception Logs general information messages to the console, including a stack…
binaryninja.log.log_info_with_traceback	log_info_with_traceback Logs general information messages to the console, including the…
binaryninja.log.log_to_file	log_to_file redirects minimum log level to a file named path, optionally appending…
binaryninja.log.log_to_stderr	log_to_stderr redirects minimum log level to standard error.
binaryninja.log.log_to_stdout	log_to_stdout redirects minimum log level to standard out.
binaryninja.log.log_warn	log_warn Logs message to console, if run through the GUI it logs with Warning icon.
binaryninja.log.log_warn_for_exception	log_warn_for_exception Logs message to console, including a stack trace for the current…
binaryninja.log.log_warn_with_traceback	log_warn_with_traceback Logs message to console, including the current stack trace.
binaryninja.log.log_with_traceback	log_with_traceback writes messages to the log console for the given log level, including the…
binaryninja.log.redirect_output_to_log

Logger

class Logger

Bases: object

__init__(session_id: int, logger_name: str)

Parameters:

• session_id (int) –

• logger_name (str) –

log(level: LogLevel, message: str) → None

Parameters:

• level (LogLevel) –

• message (str) –

Return type:

None

log_alert(message: str) → None

Parameters:

message (str) –

Return type:

None

log_alert_for_exception(message: str) → None

Parameters:

message (str) –

Return type:

None

log_alert_with_traceback(message: str) → None

Parameters:

message (str) –

Return type:

None

log_debug(message: str) → None

Parameters:

message (str) –

Return type:

None

log_debug_for_exception(message: str) → None

Parameters:

message (str) –

Return type:

None

log_debug_with_traceback(message: str) → None

Parameters:

message (str) –

Return type:

None

log_error(message: str) → None

Parameters:

message (str) –

Return type:

None

log_error_for_exception(message: str) → None

Parameters:

message (str) –

Return type:

None

log_error_with_traceback(message: str) → None

Parameters:

message (str) –

Return type:

None

log_for_exception(level: LogLevel, message: str) → None

Parameters:

• level (LogLevel) –

• message (str) –

Return type:

None

log_info(message: str) → None

Parameters:

message (str) –

Return type:

None

log_info_for_exception(message: str) → None

Parameters:

message (str) –

Return type:

None

log_info_with_traceback(message: str) → None

Parameters:

message (str) –

Return type:

None

log_warn(message: str) → None

Parameters:

message (str) –

Return type:

None

log_warn_for_exception(message: str) → None

Parameters:

message (str) –

Return type:

None

log_warn_with_traceback(message: str) → None

Parameters:

message (str) –

Return type:

None

log_with_traceback(level: LogLevel, message: str) → None

Parameters:

• level (LogLevel) –

• message (str) –

Return type:

None

close_logs

close_logs()

close_logs close all log files.

Return type:

None

is_output_redirected_to_log

is_output_redirected_to_log()

log

log(level: LogLevel, text: Any, logger: str = '', session: int = 0)

log writes messages to the log console for the given log level.

LogLevelName	LogLevel	Description
DebugLog	0	Logs debugging information messages to the console.
InfoLog	1	Logs general information messages to the console.
WarningLog	2	Logs message to console with Warning icon.
ErrorLog	3	Logs message to console with Error icon, focusing the error console.
AlertLog	4	Logs message to pop up window.

Parameters:

• level (LogLevel) – Log level to use

• text (str) – message to print

• logger (str) –

• session (int) –

Return type:

None

log_alert

log_alert(text: Any, logger: str = '')

log_alert Logs message console and to a pop up window if run through the GUI.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

Example:

>>> log_to_stdout(LogLevel.DebugLog)
>>> log_alert("Kielbasa!")
Kielbasa!
>>>

log_alert_for_exception

log_alert_for_exception(text: Any, logger: str = '')

log_alert_for_exception Logs message console, including a stack trace for the current exception. A pop up window is created if run through the GUI.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_alert_with_traceback

log_alert_with_traceback(text: Any, logger: str = '')

log_alert_with_traceback Logs message console, including the current stack trace. A pop up window is created if run through the GUI.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_debug

log_debug(text: Any, logger: str = '')

log_debug Logs debugging information messages to the console.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

Example:

>>> log_to_stdout(LogLevel.DebugLog)
>>> log_debug("Hotdogs!")
Hotdogs!

log_debug_for_exception

log_debug_for_exception(text: Any, logger: str = '')

log_debug_for_exception Logs debugging information messages to the console, including a stack trace for the current exception.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_debug_with_traceback

log_debug_with_traceback(text: Any, logger: str = '')

log_debug_with_traceback Logs debugging information messages to the console, including the current stack trace.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_error

log_error(text: Any, logger: str = '')

log_error Logs message to console, if run through the GUI it logs with Error icon, focusing the error console.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

Example:

>>> log_to_stdout(LogLevel.DebugLog)
>>> log_error("Spanferkel!")
Spanferkel!
>>>

log_error_for_exception

log_error_for_exception(text: Any, logger: str = '')

log_error_for_exception Logs message to console, including a stack trace for the current exception. When run through the GUI it logs with Error icon, focusing the error console.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_error_with_traceback

log_error_with_traceback(text: Any, logger: str = '')

log_error_with_traceback Logs message to console, including the current stack trace. When run through the GUI it logs with Error icon, focusing the error console.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_for_exception

log_for_exception(level: LogLevel, text: Any, logger: str = '', session: int = 0)

log_for_exception writes messages to the log console for the given log level, including a stack trace for the current exception.

LogLevelName	LogLevel	Description
DebugLog	0	Logs debugging information messages to the console.
InfoLog	1	Logs general information messages to the console.
WarningLog	2	Logs message to console with Warning icon.
ErrorLog	3	Logs message to console with Error icon, focusing the error console.
AlertLog	4	Logs message to pop up window.

Parameters:

• level (LogLevel) – Log level to use

• text (str) – message to print

• logger (str) –

• session (int) –

Return type:

None

log_info

log_info(text: Any, logger: str = '')

log_info Logs general information messages to the console.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

Example:

>>> log_info("Saucisson!")
Saucisson!
>>>

log_info_for_exception

log_info_for_exception(text: Any, logger: str = '')

log_info_for_exception Logs general information messages to the console, including a stack trace for the current exception.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_info_with_traceback

log_info_with_traceback(text: Any, logger: str = '')

log_info_with_traceback Logs general information messages to the console, including the current stack trace.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_to_file

log_to_file(min_level: LogLevel, path: str, append: bool = False)

log_to_file redirects minimum log level to a file named path, optionally appending rather than overwriting.

Parameters:

• min_level (enums.Log_Level) – minimum level to log

• path (str) – path to log to

• append (bool) – optional flag for specifying appending. True = append, False = overwrite.

Return type:

None

log_to_stderr

log_to_stderr(min_level: LogLevel)

log_to_stderr redirects minimum log level to standard error.

Parameters:

min_level (LogLevel) – minimum level to log to

Return type:

None

log_to_stdout

log_to_stdout(min_level: LogLevel = LogLevel.InfoLog)

log_to_stdout redirects minimum log level to standard out.

Parameters:

min_level (LogLevel) – minimum level to log to

Return type:

None

Example:

>>> log_debug("Hotdogs!")
>>> log_to_stdout(LogLevel.DebugLog)
>>> log_debug("Hotdogs!")
Hotdogs!
>>>

log_warn

log_warn(text: Any, logger: str = '')

log_warn Logs message to console, if run through the GUI it logs with Warning icon.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

Example:

>>> log_to_stdout(LogLevel.DebugLog)
>>> log_warn("Chilidogs!")
Chilidogs!
>>>

log_warn_for_exception

log_warn_for_exception(text: Any, logger: str = '')

log_warn_for_exception Logs message to console, including a stack trace for the current exception. When run through the GUI it logs with Warning icon.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_warn_with_traceback

log_warn_with_traceback(text: Any, logger: str = '')

log_warn_with_traceback Logs message to console, including the current stack trace. When run through the GUI it logs with Warning icon.

Parameters:

• text (str) – message to print

• logger (str) –

Return type:

None

log_with_traceback

log_with_traceback(level: LogLevel, text: Any, logger: str = '', session: int = 0)

log_with_traceback writes messages to the log console for the given log level, including the current stack trace.

LogLevelName	LogLevel	Description
DebugLog	0	Logs debugging information messages to the console.
InfoLog	1	Logs general information messages to the console.
WarningLog	2	Logs message to console with Warning icon.
ErrorLog	3	Logs message to console with Error icon, focusing the error console.
AlertLog	4	Logs message to pop up window.

Parameters:

• level (LogLevel) – Log level to use

• text (str) – message to print

• logger (str) –

• session (int) –

Return type:

None

redirect_output_to_log

redirect_output_to_log()