Class: QgsProjectMetadata

class qgis.core.QgsProjectMetadata

Bases: QgsAbstractMetadataBase

A structured metadata store for a map layer.

QgsProjectMetadata handles storage and management of the metadata for a QgsProject. This class is an internal QGIS format with a common metadata structure, which allows for code to access the metadata properties for projects in a uniform way.

The metadata store is designed to be compatible with the Dublin Core metadata specifications, and will be expanded to allow compatibility with ISO specifications in future releases. However, the QGIS internal schema does not represent a superset of all existing metadata schemas and accordingly conversion from specific metadata formats to QgsProjectMetadata may result in a loss of information.

This class is designed to follow the specifications detailed in the schema definition available at resources/qgis-project-metadata.xsd within the QGIS source code.

Metadata can be validated through the use of QgsLayerMetadataValidator subclasses. E.g. validating against the native QGIS metadata schema can be performed using QgsNativeProjectMetadataValidator.

New in version 3.2.

QgsProjectMetadata() Constructor for QgsProjectMetadata.

QgsProjectMetadata(QgsProjectMetadata)

Methods

author

Returns the project author string.

clone

rtype:

QgsProjectMetadata

combine

param other:

creationDateTime

Returns the project's creation date/timestamp.

equals

Tests whether the common metadata fields in this object are equal to other.

readMetadataXml

param metadataElement:

setAuthor

Sets the project author string

setCreationDateTime

Sets the project's creation date/timestamp.

writeMetadataXml

param metadataElement:

author(self) str

Returns the project author string.

See also

setAuthor()

Return type:

str

clone(self) QgsProjectMetadata
Return type:

QgsProjectMetadata

combine(self, other: QgsAbstractMetadataBase)
Parameters:

other (QgsAbstractMetadataBase) –

creationDateTime(self) QDateTime

Returns the project’s creation date/timestamp.

Return type:

QDateTime

equals(self, other: QgsAbstractMetadataBase) bool

Tests whether the common metadata fields in this object are equal to other.

Subclasses should utilize this method from their equality operators to test equality of base class members.

New in version 3.2.

readMetadataXml(self, metadataElement: QDomElement) bool
Parameters:

metadataElement (QDomElement) –

Return type:

bool

setAuthor(self, author: str)

Sets the project author string

See also

author()

Parameters:

author (str) –

setCreationDateTime(self, creationDateTime: QDateTime | datetime.datetime)

Sets the project’s creation date/timestamp.

Parameters:

creationDateTime (Union[QDateTime) –

writeMetadataXml(self, metadataElement: QDomElement, document: QDomDocument) bool
Parameters:
  • metadataElement (QDomElement) –

  • document (QDomDocument) –

Return type:

bool