Class: QgsError

A container for error messages.

It may contain a chain (e.g. a traceback) of error messages (e.g. GDAL - provider - layer). Higher level messages are appended at the end.

class qgis.core.QgsError[source]

Bases: object

__init__()
__init__(message: str | None, tag: str | None)

Constructor with single message.

Parameters:

  • message (Optional[str]) – error message

  • tag (Optional[str]) – short description, e.g. GDAL, Provider, Layer

__init__(a0: QgsError)
Parameters:

a0 (QgsError)

append(self, message: str | None, tag: str | None)[source]

Append new error message.

Parameters:

  • message (Optional[str]) – error message string

  • tag (Optional[str]) – error label, for example GDAL, GDAL Provider, Raster layer

append(self, message: QgsErrorMessage) Append new error message.

Parameters:

message – error message

clear(self)[source]

Clear error messages

isEmpty(self) → bool[source]

Test if no error is set.

Return type:

bool

Returns:

False if contains error

message(self, format: QgsErrorMessage.Format = QgsErrorMessage.Html) → str[source]

Full error messages description

Parameters:

format (QgsErrorMessage.Format = QgsErrorMessage.Html) – output format

Return type:

str

Returns:

error report

messageList(self) → List[QgsErrorMessage]

messageList return the list of current error messages

Return type:

List[QgsErrorMessage]

Returns:

current list of error messages

summary(self) → str[source]

Short error description, usually the first error in chain, the real error.

Return type:

str

Returns:

error description