Class: QgsMessageLog

Interface for logging messages from QGIS in GUI independent way.

This class provides abstraction of a tabbed window for showing messages to the user. By default QgsMessageLogOutput will be used if not overridden with another message log creator function.

QGIS application uses QgsMessageLog class for logging messages in a dockable window for the user.

QgsMessageLog is not usually directly created, but rather accessed through QgsApplication.messageLog().

Class Hierarchy

Inheritance diagram of qgis.core.QgsMessageLog

Base classes

QObject
class qgis.core.QgsMessageLog[source]

Bases: QObject

static logMessage(message: str | None, tag: str | None = '', level: Qgis.MessageLevel = Qgis.MessageLevel.Warning, notifyUser: bool = True, file: str | None = __builtin_FILE(), function: str | None = __builtin_FUNCTION(), line: int = __builtin_LINE())[source]

Adds a message to the log instance (and creates it if necessary).

If notifyUser is True, then the message should be brought to the user’s attention by various UI hints. If it is False, the message should appear in logs silently. Note that log viewer implementations may only respect notification hints for certain message levels.

Parameters:

  • message (Optional[str])

  • tag (Optional[str] = '')

  • level (Qgis.MessageLevel = Qgis.MessageLevel.Warning)

  • notifyUser (bool = True)

  • file (Optional[str] = __builtin_FILE())

  • function (Optional[str] = __builtin_FUNCTION())

  • line (int = __builtin_LINE())

signal messageReceived[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.