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.
Methods
Returns the cache directory.
Returns the cache size.
Returns the ini file loaded by QSetting.
Load settings according to current environment variables.
Returns the log file.
Returns the log level.
Returns whether logging to stderr is activated.
Log a summary of settings currently loaded.
Returns the maximum number of cached layers.
Returns the maximum number of threads to use.
Overrides system locale
Returns parallel rendering setting.
Returns the QGS project file to use.
Show group (thousand) separator
-
cacheDirectory
(self) → str¶ Returns the cache directory.
- Return type
str
- Returns
the directory.
-
cacheSize
(self) → int¶ Returns the cache size.
- Return type
int
- Returns
the cache size.
-
iniFile
(self) → str¶ Returns the ini file loaded by QSetting.
- Return type
str
- 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.
- Return type
str
- Returns
the path of the log file or an empty string if none is defined.
-
logLevel
(self) → Qgis.MessageLevel¶ Returns the log level.
- Return type
- Returns
the log level.
-
logStderr
(self) → bool¶ Returns whether logging to stderr is activated.
- Return type
bool
- 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.
- Return type
int
- Returns
the number of cached layers.
-
maxThreads
(self) → int¶ Returns the maximum number of threads to use.
- Return type
int
- Returns
the number of threads.
-
overrideSystemLocale
(self) → str¶ Overrides system locale
- Return type
str
- Returns
the optional override for system locale.
New in version 3.8.
-
parallelRendering
(self) → bool¶ Returns parallel rendering setting.
- Return type
bool
- Returns
TRUE if parallel rendering is activated, FALSE otherwise.
-
projectFile
(self) → str¶ Returns the QGS project file to use.
- Return type
str
- Returns
the path of the QGS project or an empty string if none is defined.
-
showGroupSeparator
(self) → bool¶ Show group (thousand) separator
- Return type
bool
- Returns
if group separator must be shown, default to FALSE.
New in version 3.8.
-