qml.logging

This module enables support for log-level messaging throughout PennyLane, following the native Python logging framework interface. Please see the PennyLane logging development guidelines, and the official Python documentation for details on usage https://docs.python.org/3/library/logging.html

Functions

config_path()

This method returns the full absolute path to the the log_config.toml configuration file.

edit_system_config([wait_on_close])

This function opens the log configuration file using OS-specific editors.

enable_logging([config_file])

This method allows to selectively enable logging throughout PennyLane, following the configuration options defined in the log_config.toml file.

Classes

DebugOnlyFilter([name])

Filters logs that are less verbose than the DEBUG level (CRITICAL, ERROR, WARN & INFO).

DefaultFormatter([fmt, datefmt, style, validate])

This formatter has the default rules used for formatting PennyLane log messages.

LocalProcessFilter()

Filters logs not originating from the current executing Python process ID.

SimpleFormatter([fmt, datefmt, style, validate])

This formatter has a simplified layout and rules used for formatting PennyLane log messages.

Variables

debug_logger(func, *[, log_level, …])

This decorator utility generates a string containing the called function, the passed arguments, and the source of the function call.

debug_logger_init(func, *[, log_level, …])

This decorator utility generates a string containing the called function, the passed arguments, and the source of the function call.