Merge pull request #42954 from domi4484/settingsRegistryQep124PartThree

Settings registry (QEP 124) part three
qgis · Apr 30, 2021 · 4e9932c · 4e9932c
2 parents 8d0d677 + 810af98
commit 4e9932c
Show file tree

Hide file tree

Showing 90 changed files with 995 additions and 637 deletions.
diff --git a/python/core/__init__.py.in b/python/core/__init__.py.in
@@ -34,7 +34,7 @@ from .additions.qgsfeature import mapping_feature
 from .additions.qgsfunction import register_function, qgsfunction
 from .additions.qgsgeometry import _geometryNonZero, mapping_geometry
 from .additions.qgssettings import _qgssettings_enum_value, _qgssettings_set_enum_value, _qgssettings_flag_value
-from .additions.qgssettingsentry import PyQgsSettingsEntryEnum, PyQgsSettingsEntryFlag
+from .additions.qgssettingsentry import PyQgsSettingsEntryEnumFlag
 from .additions.qgstaskwrapper import QgsTaskWrapper
 from .additions.readwritecontextentercategory import ReadWriteContextEnterCategory
 from .additions.runtimeprofiler import ScopedRuntimeProfileContextManager
@@ -59,8 +59,7 @@ QgsDateTimeRange.__repr__ = datetime_range_repr
 QgsDateRange.__repr__ = date_range_repr
 
 # Classes patched
-QgsSettingsEntryEnum = PyQgsSettingsEntryEnum
-QgsSettingsEntryFlag = PyQgsSettingsEntryFlag
+QgsSettingsEntryEnumFlag = PyQgsSettingsEntryEnumFlag
 
 # Classes patched using a derived class
 QgsProviderMetadata = PyProviderMetadata

diff --git a/python/core/additions/qgssettingsentry.py b/python/core/additions/qgssettingsentry.py
@@ -22,76 +22,73 @@
 import qgis  # required to get base class of enums
 
 
-class _PyQgsSettingsEntryEnumFlag(QgsSettingsEntryBase):
-    """ class QgsSettingsEntryEnum
-        ingroup core
-        An enum settings entry.
-        since QGIS 3.20
+class PyQgsSettingsEntryEnumFlag(QgsSettingsEntryBase):
+    """ class PyQgsSettingsEntryEnumFlag
+    ingroup core
+    An enum settings entry.
+    since QGIS 3.20
     """
 
     def __init__(self, key, pluginName, defaultValue, description=str()):
-        """ Constructor for _PyQgsSettingsEntryEnumFlag.
+        """ Constructor for PyQgsSettingsEntryEnumFlag.
 
-            :param self: the QgsSettingsEntryEnum object
-            :param key: argument specifies the final part of the settings key.
-            :param pluginName: argument is inserted in the key after the section.
-            :param defaultValue: argument specifies the default value for the settings entry.
-            :param description: argument specifies a description for the settings entry.
-
-            .. note::  This constructor should not be used. Use PyQgsSettingsEntryEnum
-                       or PyQgsSettingsEntryFlag instead.
+        :param self: the PyQgsSettingsEntryEnumFlag object
+        :param key: argument specifies the final part of the settings key.
+        :param pluginName: argument is inserted in the key after the section.
+        :param defaultValue: argument specifies the default value for the settings entry.
+        :param description: argument specifies a description for the settings entry.
         """
 
         defaultValueStr = str()
         self.__metaEnum = metaEnumFromValue(defaultValue)
         if self.__metaEnum is None or not self.__metaEnum.isValid():
             QgsLogger.debug("Invalid metaenum. Enum/Flag probably misses Q_ENUM/Q_FLAG declaration. Settings key: '{0}'".format(self.key()))
         else:
-            if self.settingsType() is self.SettingsType.Enum:
-                defaultValueStr = self.__metaEnum.valueToKey(defaultValue)
-            else:
+            if self.__metaEnum.isFlag():
                 defaultValueStr = self.__metaEnum.valueToKeys(defaultValue)
+            else:
+                defaultValueStr = self.__metaEnum.valueToKey(defaultValue)
             self.__enumFlagClass = defaultValue.__class__
 
         super().__init__(key, pluginName, defaultValueStr, description)
 
     def value(self, dynamicKeyPart=None, useDefaultValueOverride=False, defaultValueOverride=None):
         """ Get settings value.
 
-            :param self: the _PyQgsSettingsEntryEnumFlag object
-            :param dynamicKeyPart: argument specifies the dynamic part of the settings key.
-            :param useDefaultValueOverride: argument specifies if defaultValueOverride should be used.
-            :param defaultValueOverride: argument if valid is used instead of the normal default value.
+        :param self: the PyQgsSettingsEntryEnumFlag object
+        :param dynamicKeyPart: argument specifies the dynamic part of the settings key.
+        :param useDefaultValueOverride: argument specifies if defaultValueOverride should be used.
+        :param defaultValueOverride: argument if valid is used instead of the normal default value.
         """
 
         defaultValue = self.defaultValue()
         if useDefaultValueOverride:
             defaultValue = defaultValueOverride
 
-        if self.settingsType() is self.SettingsType.Enum:
-            return QgsSettings().enumValue(self.key(dynamicKeyPart),
+        if self.__metaEnum.isFlag():
+            return QgsSettings().flagValue(self.key(dynamicKeyPart),
                                            defaultValue,
                                            self.section())
         else:
-            return QgsSettings().flagValue(self.key(dynamicKeyPart),
+            return QgsSettings().enumValue(self.key(dynamicKeyPart),
                                            defaultValue,
                                            self.section())
 
     def defaultValue(self):
         """ Get settings default value.
 
-            :param self: the _PyQgsSettingsEntryEnumFlag object
+        :param self: the PyQgsSettingsEntryEnumFlag object
         """
 
         if self.__metaEnum is None or not self.__metaEnum.isValid():
             QgsLogger.debug("Invalid metaenum. Enum/Flag probably misses Q_ENUM/Q_FLAG declaration. Settings key: '{0}'".format(self.key()))
             return -1
 
         defaultValueString = self.defaultValueAsVariant()
-        if self.settingsType() is self.SettingsType.Enum:
-            (defaultValue, ok) = self.__metaEnum.keyToValue(defaultValueString)
-        else:
+        if self.__metaEnum.isFlag():
             (defaultValue, ok) = self.__metaEnum.keysToValue(defaultValueString)
+        else:
+            (defaultValue, ok) = self.__metaEnum.keyToValue(defaultValueString)
         if not ok:
             QgsLogger.debug("Invalid enum/flag key/s '{0}'.".format(self.defaultValueAsVariant()))
             return -1
@@ -103,81 +100,29 @@ def defaultValue(self):
     def setValue(self, value, dynamicKeyPart=None):
         """ Set settings value.
 
-            :param self: the _PyQgsSettingsEntryEnumFlag object
-            :param dynamicKeyPart: argument specifies the dynamic part of the settings key.
+        :param self: the PyQgsSettingsEntryEnumFlag object
+        :param dynamicKeyPart: argument specifies the dynamic part of the settings key.
         """
 
         if self.__metaEnum is None or not self.__metaEnum.isValid():
             QgsLogger.debug("Invalid metaenum. Enum/Flag probably misses Q_ENUM/Q_FLAG declaration. Settings key: '{0}'".format(self.key()))
             return False
 
         enumFlagKey = str()
-        if self.settingsType() is self.SettingsType.Enum:
-            enumFlagKey = self.__metaEnum.valueToKey(value)
-        else:
+        if self.__metaEnum.isFlag():
             enumFlagKey = self.__metaEnum.valueToKeys(value)
+        else:
+            enumFlagKey = self.__metaEnum.valueToKey(value)
         if not enumFlagKey:
             QgsLogger.debug("Invalid enum/flag value '{0}'.".format(value))
             return False
 
         return super().setVariantValue(enumFlagKey, dynamicKeyPart)
 
-
-class PyQgsSettingsEntryEnum(_PyQgsSettingsEntryEnumFlag):
-    """ class QgsSettingsEntryEnum
-        ingroup core
-        An enum settings entry.
-        since QGIS 3.20
-    """
-
-    def __init__(self, key, pluginName, defaultValue, description=str()):
-        """ Constructor for QgsSettingsEntryEnum.
-
-            :param self: the QgsSettingsEntryEnum object
-            :param key: argument specifies the final part of the settings key.
-            :param pluginName: argument is inserted in the key after the section.
-            :param defaultValue: argument specifies the default value for the settings entry.
-            :param description: argument specifies a description for the settings entry.
-
-            .. note::  The enum needs to be declared with Q_ENUM.
-        """
-
-        super().__init__(key, pluginName, defaultValue, description)
-
-    def settingsType(self):
-        """ Get the settings entry type.
-
-            :param self: the QgsSettingsEntryEnum object
-        """
-
-        return self.SettingsType.Enum
-
-
-class PyQgsSettingsEntryFlag(_PyQgsSettingsEntryEnumFlag):
-    """ class QgsSettingsEntryFlag
-        ingroup core
-        A flag settings entry.
-        since QGIS 3.20
-    """
-
-    def __init__(self, key, pluginName, defaultValue, description=str()):
-        """ Constructor for QgsSettingsEntryFlag.
-
-            :param self: the QgsSettingsEntryFlag object
-            :param key: argument specifies the final part of the settings key.
-            :param pluginName: argument is inserted in the key after the section.
-            :param defaultValue: argument specifies the default value for the settings entry.
-            :param description: argument specifies a description for the settings entry.
-
-            .. note::  The flag needs to be declared with Q_FLAG (not Q_FLAGS).
-        """
-
-        super().__init__(key, pluginName, defaultValue, description)
-
     def settingsType(self):
         """ Get the settings entry type.
 
-            :param self: the QgsSettingsEntryFlag object
+        :param self: the PyQgsSettingsEntryEnumFlag object
         """
 
-        return self.SettingsType.Flag
+        return self.SettingsType.EnumFlag
diff --git a/python/core/auto_additions/qgssettingsentry.py b/python/core/auto_additions/qgssettingsentry.py
@@ -6,7 +6,7 @@
 QgsSettingsEntryBase.SettingsType.Bool.__doc__ = ""
 QgsSettingsEntryBase.SettingsType.Integer.__doc__ = ""
 QgsSettingsEntryBase.SettingsType.Double.__doc__ = ""
-QgsSettingsEntryBase.SettingsType.Enum.__doc__ = ""
-QgsSettingsEntryBase.SettingsType.Flag.__doc__ = ""
-QgsSettingsEntryBase.SettingsType.__doc__ = '\n\n' + '* ``Variant``: ' + QgsSettingsEntryBase.SettingsType.Variant.__doc__ + '\n' + '* ``String``: ' + QgsSettingsEntryBase.SettingsType.String.__doc__ + '\n' + '* ``StringList``: ' + QgsSettingsEntryBase.SettingsType.StringList.__doc__ + '\n' + '* ``Bool``: ' + QgsSettingsEntryBase.SettingsType.Bool.__doc__ + '\n' + '* ``Integer``: ' + QgsSettingsEntryBase.SettingsType.Integer.__doc__ + '\n' + '* ``Double``: ' + QgsSettingsEntryBase.SettingsType.Double.__doc__ + '\n' + '* ``Enum``: ' + QgsSettingsEntryBase.SettingsType.Enum.__doc__ + '\n' + '* ``Flag``: ' + QgsSettingsEntryBase.SettingsType.Flag.__doc__
+QgsSettingsEntryBase.SettingsType.EnumFlag.__doc__ = ""
+QgsSettingsEntryBase.SettingsType.Color.__doc__ = ""
+QgsSettingsEntryBase.SettingsType.__doc__ = '\n\n' + '* ``Variant``: ' + QgsSettingsEntryBase.SettingsType.Variant.__doc__ + '\n' + '* ``String``: ' + QgsSettingsEntryBase.SettingsType.String.__doc__ + '\n' + '* ``StringList``: ' + QgsSettingsEntryBase.SettingsType.StringList.__doc__ + '\n' + '* ``Bool``: ' + QgsSettingsEntryBase.SettingsType.Bool.__doc__ + '\n' + '* ``Integer``: ' + QgsSettingsEntryBase.SettingsType.Integer.__doc__ + '\n' + '* ``Double``: ' + QgsSettingsEntryBase.SettingsType.Double.__doc__ + '\n' + '* ``EnumFlag``: ' + QgsSettingsEntryBase.SettingsType.EnumFlag.__doc__ + '\n' + '* ``Color``: ' + QgsSettingsEntryBase.SettingsType.Color.__doc__
 # --
diff --git a/python/core/auto_generated/layout/qgslayout.sip.in b/python/core/auto_generated/layout/qgslayout.sip.in
@@ -614,7 +614,6 @@ should be canceled.
 .. versionadded:: 3.10
 %End
 
-    const QgsSettingsEntryStringList settingsSearchPathForTemplates;
 
   public slots:
 

diff --git a/python/core/auto_generated/locator/qgslocator.sip.in b/python/core/auto_generated/locator/qgslocator.sip.in
@@ -141,9 +141,6 @@ This list is updated when preparing the search
 .. versionadded:: 3.16
 %End
 
-    const QgsSettingsEntryBool settingsLocatorFilterEnabled;
-    const QgsSettingsEntryBool settingsLocatorFilterDefault;
-    const QgsSettingsEntryString settingsLocatorFilterPrefix;
 
   signals:
 

diff --git a/python/core/auto_generated/network/qgsnetworkaccessmanager.sip.in b/python/core/auto_generated/network/qgsnetworkaccessmanager.sip.in
@@ -343,6 +343,8 @@ Forwards an external browser login closure request to the authentication handler
 .. versionadded:: 3.20
 %End
 
+
+
   signals:
 
  void requestAboutToBeCreated( QNetworkAccessManager::Operation, const QNetworkRequest &, QIODevice * ) /Deprecated/;

diff --git a/python/core/auto_generated/network/qgsnewsfeedparser.sip.in b/python/core/auto_generated/network/qgsnewsfeedparser.sip.in
@@ -93,6 +93,7 @@ Returns the authentication configuration for the parser.
 Returns the settings key used for a feed with the given ``baseUrl``.
 %End
 
+
   public slots:
 
     void fetch();

diff --git a/python/core/auto_generated/processing/qgsprocessing.sip.in b/python/core/auto_generated/processing/qgsprocessing.sip.in
@@ -52,6 +52,7 @@ Converts a source ``type`` to a string representation.
 %End
 
     static const QString TEMPORARY_OUTPUT;
+
 };
 
 /************************************************************************

diff --git a/python/core/auto_generated/qgsapplication.sip.in b/python/core/auto_generated/qgsapplication.sip.in
@@ -1003,6 +1003,7 @@ Emits the signal to collect all the strings of .qgs to be included in ts file
 .. versionadded:: 3.4
 %End
 
+
 %If (ANDROID)
     //dummy method to workaround sip generation issue
     bool x11EventFilter( XEvent *event );

diff --git a/python/core/auto_generated/qgsgeometryoptions.sip.in b/python/core/auto_generated/qgsgeometryoptions.sip.in
@@ -118,6 +118,7 @@ Read the geometry options from ``node``.
 .. versionadded:: 3.4
 %End
 
+
   signals:
 
     void checkConfigurationChanged();

diff --git a/python/core/auto_generated/qgslocalizeddatapathregistry.sip.in b/python/core/auto_generated/qgslocalizeddatapathregistry.sip.in
@@ -60,6 +60,7 @@ Since the paths are stored by order of preference, lower positions in the list t
 Unregisters a localized path
 %End
 
+
   private:
     QgsLocalizedDataPathRegistry( const QgsLocalizedDataPathRegistry &other );
 };

diff --git a/python/core/auto_generated/qgsmaprendererjob.sip.in b/python/core/auto_generated/qgsmaprendererjob.sip.in
@@ -157,6 +157,7 @@ Returns map settings with which this job was started.
 
 
 
+
   signals:
 
     void renderingLayersFinished();