Subgroup: Server

Class: QgsServerSettings

class qgis.server.QgsServerSettings

Bases: sip.wrapper

Constructor.

QgsServerSettings(QgsServerSettings)

Provides a way to retrieve settings by prioritizing according to environment variables, ini file and default values.

New in version 3.0: Methods

cacheDirectory Returns the cache directory.
cacheSize Returns the cache size.
iniFile Returns the ini file loaded by QSetting.
load Load settings according to current environment variables.
logFile Returns the log file.
logLevel Returns the log level.
logStderr Returns whether logging to stderr is activated.
logSummary Log a summary of settings currently loaded.
maxCacheLayers Returns the maximum number of cached layers.
maxThreads Returns the maximum number of threads to use.
parallelRendering Returns parallel rendering setting.
projectFile Returns the QGS project file to use.

Signals

Attributes

cacheDirectory(self) → str

Returns the cache directory.

Returns:the directory.
cacheSize(self) → int

Returns the cache size.

Returns:the cache size.
iniFile(self) → str

Returns the ini file loaded by QSetting.

Returns:the path of the ini file or an empty string if none is loaded.
load(self)

Load settings according to current environment variables.

load(self, envVarName: str) -> bool Load setting for a specific environment variable name.

Returns:true if loading is successful, false in case of an invalid name.
logFile(self) → str

Returns the log file.

Returns:the path of the log file or an empty string if none is defined.
logLevel(self) → Qgis.MessageLevel

Returns the log level.

Returns:the log level.
logStderr(self) → bool

Returns whether logging to stderr is activated.

Returns:true if logging to stderr is activated, false otherwise.

New in version 3.4.

logSummary(self)

Log a summary of settings currently loaded.

maxCacheLayers(self) → int

Returns the maximum number of cached layers.

Returns:the number of cached layers.
maxThreads(self) → int

Returns the maximum number of threads to use.

Returns:the number of threads.
parallelRendering(self) → bool

Returns parallel rendering setting.

Returns:true if parallel rendering is activated, false otherwise.
projectFile(self) → str

Returns the QGS project file to use.

Returns:the path of the QGS project or an empty string if none is defined.