Class: QgsReadWriteContext

A container for the context for various read/write operations on objects.

class qgis.core.QgsReadWriteContext[source]

Bases: object

__init__()

Constructor for QgsReadWriteContext.

__init__(a0: QgsReadWriteContext)
Parameters:

a0 (QgsReadWriteContext)

class ReadWriteMessage

Bases: object

Struct for QgsReadWriteContext error or warning messages

Added in version 3.2.

categories(self) List[str]

Returns the stack of categories of the message

Return type:

List[str]

level(self) Qgis.MessageLevel

Returns the message level

Return type:

Qgis.MessageLevel

message(self) str

Returns the message string

Return type:

str

enterCategory[source]

alias of ReadWriteContextEnterCategory

pathResolver(self) QgsPathResolver

Returns path resolver for conversion between relative and absolute paths

Return type:

QgsPathResolver

projectTranslator(self) QgsProjectTranslator | None[source]

Returns the project translator

Added in version 3.4.

Return type:

Optional[QgsProjectTranslator]

pushMessage(self, message: str | None, level: Qgis.MessageLevel = Qgis.MessageLevel.Warning)[source]

Append a message to the context

Added in version 3.2.

Parameters:
  • message (Optional[str])

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

setPathResolver(self, resolver: QgsPathResolver)[source]

Sets up path resolver for conversion between relative and absolute paths

Parameters:

resolver (QgsPathResolver)

setProjectTranslator(self, projectTranslator: QgsProjectTranslator | None)[source]

Sets the project translator. It’s usually the QgsProject where the function with the context is made and won’t be changed anymore.

Added in version 3.4.

Parameters:

projectTranslator (Optional[QgsProjectTranslator])

setTransformContext(self, transformContext: QgsCoordinateTransformContext)[source]

Sets data coordinate transform context to transformContext

Added in version 3.8.

Parameters:

transformContext (QgsCoordinateTransformContext)

takeMessages(self) List[QgsReadWriteContext.ReadWriteMessage]

Returns the stored messages and remove them

Added in version 3.2.

Return type:

List[QgsReadWriteContext.ReadWriteMessage]

transformContext(self) QgsCoordinateTransformContext[source]

Returns data provider coordinate transform context

Added in version 3.8.

Return type:

QgsCoordinateTransformContext