replace descriptionAsPythonString

qgis · Sep 24, 2021 · 68f003c · 68f003c
1 parent caad9f2
commit 68f003c
Show file tree

Hide file tree

Showing 9 changed files with 73 additions and 76 deletions.
diff --git a/python/core/auto_generated/processing/qgsprocessingparameters.sip.in b/python/core/auto_generated/processing/qgsprocessingparameters.sip.in
@@ -387,8 +387,6 @@ Returns the description for the parameter. This is the user-visible string
 used to identify this parameter.
 
 .. seealso:: :py:func:`setDescription`
-
-.. seealso:: :py:func:`descriptionAsPythonString`
 %End
 
     void setDescription( const QString &description );
@@ -509,17 +507,6 @@ parameter. Returns ``True`` if the value can be accepted.
 The optional ``context`` parameter can be specified to allow a more stringent
 check to be performed, capable of checking for the presence of required
 layers and other factors within the context.
-%End
-
-    QString descriptionAsPythonString() const;
-%Docstring
-Returns the description of the parameter with quotes around.
-If there are quotes in the description, they are escaped if necessary.
-The around quote could be single or double.
-
-.. seealso:: :py:func:`description`
-
-.. versionadded:: 3.24
 %End
 
     virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const;

diff --git a/src/core/processing/qgsprocessingparameteraggregate.cpp b/src/core/processing/qgsprocessingparameteraggregate.cpp
@@ -74,7 +74,8 @@ QString QgsProcessingParameterAggregate::asPythonString( QgsProcessing::PythonOu
   {
     case QgsProcessing::PythonQgsProcessingAlgorithmSubclass:
     {
-      QString code = QStringLiteral( "QgsProcessingParameterAggregate('%1', %2" ).arg( name(), descriptionAsPythonString() );
+      QString code = QStringLiteral( "QgsProcessingParameterAggregate('%1', %2" )
+                     .arg( name(), QgsProcessingUtils::stringToPythonLiteral( description() ) );
       if ( !mParentLayerParameterName.isEmpty() )
         code += QStringLiteral( ", parentLayerParameterName=%1" ).arg( QgsProcessingUtils::stringToPythonLiteral( mParentLayerParameterName ) );
 

diff --git a/src/core/processing/qgsprocessingparameterdxflayers.cpp b/src/core/processing/qgsprocessingparameterdxflayers.cpp
@@ -145,7 +145,8 @@ QString QgsProcessingParameterDxfLayers::asPythonString( QgsProcessing::PythonOu
   {
     case QgsProcessing::PythonQgsProcessingAlgorithmSubclass:
     {
-      QString code = QStringLiteral( "QgsProcessingParameterDxfLayers('%1', %2)" ).arg( name(), descriptionAsPythonString() );
+      QString code = QStringLiteral( "QgsProcessingParameterDxfLayers('%1', %2)" )
+                     .arg( name(), QgsProcessingUtils::stringToPythonLiteral( description() ) );
       return code;
     }
   }

diff --git a/src/core/processing/qgsprocessingparameterfieldmap.cpp b/src/core/processing/qgsprocessingparameterfieldmap.cpp
@@ -72,7 +72,8 @@ QString QgsProcessingParameterFieldMapping::asPythonString( QgsProcessing::Pytho
   {
     case QgsProcessing::PythonQgsProcessingAlgorithmSubclass:
     {
-      QString code = QStringLiteral( "QgsProcessingParameterFieldMapping('%1', %2" ).arg( name(), descriptionAsPythonString() );
+      QString code = QStringLiteral( "QgsProcessingParameterFieldMapping('%1', %2" )
+                     .arg( name(), QgsProcessingUtils::stringToPythonLiteral( description() ) );
       if ( !mParentLayerParameterName.isEmpty() )
         code += QStringLiteral( ", parentLayerParameterName=%1" ).arg( QgsProcessingUtils::stringToPythonLiteral( mParentLayerParameterName ) );
 

diff --git a/src/core/processing/qgsprocessingparametermeshdataset.cpp b/src/core/processing/qgsprocessingparametermeshdataset.cpp
@@ -62,7 +62,7 @@ QString QgsProcessingParameterMeshDatasetGroups::asPythonString( QgsProcessing::
     case QgsProcessing::PythonQgsProcessingAlgorithmSubclass:
     {
       QString code = QStringLiteral( "QgsProcessingParameterMeshDatasetGroups('%1', %2" )
-                     .arg( name(), descriptionAsPythonString() );
+                     .arg( name(), QgsProcessingUtils::stringToPythonLiteral( description() ) );
       if ( !mMeshLayerParameterName.isEmpty() )
         code += QStringLiteral( ", meshLayerParameterName=%1" ).arg( QgsProcessingUtils::stringToPythonLiteral( mMeshLayerParameterName ) );
 

diff --git a/src/core/processing/qgsprocessingparameters.cpp b/src/core/processing/qgsprocessingparameters.cpp
diff --git a/src/core/processing/qgsprocessingparameters.h b/src/core/processing/qgsprocessingparameters.h
@@ -496,7 +496,6 @@ class CORE_EXPORT QgsProcessingParameterDefinition
      * Returns the description for the parameter. This is the user-visible string
      * used to identify this parameter.
      * \see setDescription()
-     * \see descriptionAsPythonString()
      */
     QString description() const { return mDescription; }
 
@@ -607,16 +606,6 @@ class CORE_EXPORT QgsProcessingParameterDefinition
      */
     virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const;
 
-    /**
-     * Returns the description of the parameter with quotes around.
-     * If there are quotes in the description, they are escaped if necessary.
-     * The around quote could be single or double.
-     * \see description()
-     *
-     * \since QGIS 3.24
-     */
-    QString descriptionAsPythonString() const;
-
     /**
      * Returns a string version of the parameter input \a value, which is suitable for use as an input
      * parameter value when running an algorithm directly from a Python command.

diff --git a/src/core/processing/qgsprocessingparametertininputlayers.cpp b/src/core/processing/qgsprocessingparametertininputlayers.cpp
@@ -91,7 +91,8 @@ QString QgsProcessingParameterTinInputLayers::asPythonString( QgsProcessing::Pyt
   {
     case QgsProcessing::PythonQgsProcessingAlgorithmSubclass:
     {
-      QString code = QStringLiteral( "QgsProcessingParameterTinInputLayers('%1', %2)" ).arg( name(), descriptionAsPythonString() );
+      QString code = QStringLiteral( "QgsProcessingParameterTinInputLayers('%1', %2)" )
+                     .arg( name(), QgsProcessingUtils::stringToPythonLiteral( description() ) );
       return code;
     }
   }

diff --git a/src/core/processing/qgsprocessingparametervectortilewriterlayers.cpp b/src/core/processing/qgsprocessingparametervectortilewriterlayers.cpp
@@ -96,7 +96,8 @@ QString QgsProcessingParameterVectorTileWriterLayers::asPythonString( QgsProcess
   {
     case QgsProcessing::PythonQgsProcessingAlgorithmSubclass:
     {
-      QString code = QStringLiteral( "QgsProcessingParameterVectorTileWriterLayers('%1', %2)" ).arg( name(), descriptionAsPythonString() );
+      QString code = QStringLiteral( "QgsProcessingParameterVectorTileWriterLayers('%1', %2)" )
+                     .arg( name(), QgsProcessingUtils::stringToPythonLiteral( description() ) );
       return code;
     }
   }