address review

python/core/auto_generated/processing/qgsprocessingcontext.sip.in

@@ -611,28 +611,38 @@ for all temporary files created during algorithm execution.
 .. versionadded:: 3.32
 %End
 
-    int numberOfThreads() const;
+    int maximumThreads() const;
 %Docstring
 Returns the (optional) number of threads to use when running algorithms.
 
-If set, this overrides the standard global Processing number of threads setting.
-Note that if algorithm implementation does not support multhreaded execution, this
-setting will be ignored.
+.. warning::
 
-.. seealso:: :py:func:`setNumberOfThreads`
+   Not all algorithms which support multithreaded execution will
+   respect this setting, depending on the multi-threading framework in use.
+   Multithreaded algorithms must check this value and adapt their thread
+   handling accordingly -- the setting will not be automatically applied.
+
+.. seealso:: :py:func:`setMaximumThreads`
 
 .. versionadded:: 3.32
 %End
 
-    void setNumberOfThreads( int threads );
+    void setMaximumThreads( int threads );
 %Docstring
 Sets the (optional) number of ``threads`` to use when running algorithms.
 
 If set, this overrides the standard global Processing number of threads setting.
 Note that if algorithm implementation does not support multhreaded execution, this
 setting will be ignored.
 
-.. seealso:: :py:func:`numberOfThreads`
+.. warning::
+
+   Not all algorithms which support multithreaded execution will
+   respect this setting, depending on the multi-threading framework in use.
+   Multithreaded algorithms must check this value and adapt their thread
+   handling accordingly -- the setting will not be automatically applied.
+
+.. seealso:: :py:func:`maximumThreads`
 
 .. versionadded:: 3.32
 %End

python/plugins/processing/algs/qgis/TilesXYZ.py

@@ -252,7 +252,7 @@ def generate(self, writer, parameters, context, feedback):
         self.tile_format = self.formats[self.parameterAsEnum(parameters, self.TILE_FORMAT, context)]
         self.quality = self.parameterAsInt(parameters, self.QUALITY, context)
         self.metatilesize = self.parameterAsInt(parameters, self.METATILESIZE, context)
-        self.maxThreads = context.numThreads()
+        self.maxThreads = context.maximumThreads()
         try:
             self.tile_width = self.parameterAsInt(parameters, self.TILE_WIDTH, context)
             self.tile_height = self.parameterAsInt(parameters, self.TILE_HEIGHT, context)

src/analysis/processing/pdal/qgspdalalgorithmbase.cpp

@@ -90,7 +90,7 @@ void QgsPdalAlgorithmBase::applyCommonParameters( QStringList &arguments, QgsCoo
 
 void QgsPdalAlgorithmBase::applyThreadsParameter( QStringList &arguments, QgsProcessingContext &context )
 {
-  const int numThreads = context.numberOfThreads();
+  const int numThreads = context.maximumThreads();
 
   if ( numThreads )
   {

src/core/processing/qgsprocessingcontext.cpp

@@ -157,14 +157,14 @@ void QgsProcessingContext::setTemporaryFolder( const QString &folder )
   mTemporaryFolderOverride = folder;
 }
 
-int QgsProcessingContext::numberOfThreads() const
+int QgsProcessingContext::maximumThreads() const
 {
-  return mThreadsToUse;
+  return mMaximumThreads;
 }
 
-void QgsProcessingContext::setNumberOfThreads( int threads )
+void QgsProcessingContext::setMaximumThreads( int threads )
 {
-  mThreadsToUse = threads;
+  mMaximumThreads = threads;
 }
 
 QVariantMap QgsProcessingContext::exportToMap() const

src/core/processing/qgsprocessingcontext.h

@@ -101,7 +101,7 @@ class CORE_EXPORT QgsProcessingContext
       mAreaUnit = other.mAreaUnit;
       mLogLevel = other.mLogLevel;
       mTemporaryFolderOverride = other.mTemporaryFolderOverride;
-      mThreadsToUse = other.mThreadsToUse;
+      mMaximumThreads = other.mMaximumThreads;
     }
 
     /**
@@ -684,14 +684,15 @@ class CORE_EXPORT QgsProcessingContext
     /**
      * Returns the (optional) number of threads to use when running algorithms.
      *
-     * If set, this overrides the standard global Processing number of threads setting.
-     * Note that if algorithm implementation does not support multhreaded execution, this
-     * setting will be ignored.
+     * \warning Not all algorithms which support multithreaded execution will
+     * respect this setting, depending on the multi-threading framework in use.
+     * Multithreaded algorithms must check this value and adapt their thread
+     * handling accordingly -- the setting will not be automatically applied.
      *
-     * \see setNumberOfThreads()
+     * \see setMaximumThreads()
      * \since QGIS 3.32
      */
-    int numberOfThreads() const;
+    int maximumThreads() const;
 
     /**
      * Sets the (optional) number of \a threads to use when running algorithms.
@@ -700,10 +701,15 @@ class CORE_EXPORT QgsProcessingContext
      * Note that if algorithm implementation does not support multhreaded execution, this
      * setting will be ignored.
      *
-     * \see numberOfThreads()
+     * \warning Not all algorithms which support multithreaded execution will
+     * respect this setting, depending on the multi-threading framework in use.
+     * Multithreaded algorithms must check this value and adapt their thread
+     * handling accordingly -- the setting will not be automatically applied.
+     *
+     * \see maximumThreads()
      * \since QGIS 3.32
      */
-    void setNumberOfThreads( int threads );
+    void setMaximumThreads( int threads );
 
     /**
      * Exports the context's settings to a variant map.
@@ -762,7 +768,7 @@ class CORE_EXPORT QgsProcessingContext
     LogLevel mLogLevel = DefaultLevel;
 
     QString mTemporaryFolderOverride;
-    int mThreadsToUse = QThread::idealThreadCount();
+    int mMaximumThreads = QThread::idealThreadCount();
 
 #ifdef SIP_RUN
     QgsProcessingContext( const QgsProcessingContext &other );

src/gui/processing/qgsprocessingalgorithmdialogbase.cpp

@@ -160,7 +160,7 @@ QgsProcessingAlgorithmDialogBase::QgsProcessingAlgorithmDialogBase( QWidget *par
               mDistanceUnits = mContextOptionsWidget->distanceUnit();
               mAreaUnits = mContextOptionsWidget->areaUnit();
               mTemporaryFolderOverride = mContextOptionsWidget->temporaryFolder();
-              mNumberOfThreads = mContextOptionsWidget->numberOfThreads();
+              mMaximumThreads = mContextOptionsWidget->maximumThreads();
             } );
           }
         }
@@ -870,7 +870,7 @@ void QgsProcessingAlgorithmDialogBase::applyContextOverrides( QgsProcessingConte
     context->setDistanceUnit( mDistanceUnits );
     context->setAreaUnit( mAreaUnits );
     context->setTemporaryFolder( mTemporaryFolderOverride );
-    context->setNumberOfThreads( mNumberOfThreads );
+    context->setMaximumThreads( mMaximumThreads );
   }
 }
 
@@ -1027,7 +1027,7 @@ void QgsProcessingContextOptionsWidget::setFromContext( const QgsProcessingConte
   whileBlocking( mDistanceUnitsCombo )->setCurrentIndex( mDistanceUnitsCombo->findData( QVariant::fromValue( context->distanceUnit() ) ) );
   whileBlocking( mAreaUnitsCombo )->setCurrentIndex( mAreaUnitsCombo->findData( QVariant::fromValue( context->areaUnit() ) ) );
   whileBlocking( mTemporaryFolderWidget )->setFilePath( context->temporaryFolder() );
-  whileBlocking( mThreadsSpinBox )->setValue( context->numberOfThreads() );
+  whileBlocking( mThreadsSpinBox )->setValue( context->maximumThreads() );
 }
 
 QgsFeatureRequest::InvalidGeometryCheck QgsProcessingContextOptionsWidget::invalidGeometryCheck() const
@@ -1050,7 +1050,7 @@ QString QgsProcessingContextOptionsWidget::temporaryFolder()
   return mTemporaryFolderWidget->filePath();
 }
 
-int QgsProcessingContextOptionsWidget::numberOfThreads() const
+int QgsProcessingContextOptionsWidget::maximumThreads() const
 {
   return mThreadsSpinBox->value();
 }

src/gui/processing/qgsprocessingalgorithmdialogbase.h

@@ -477,7 +477,7 @@ class GUI_EXPORT QgsProcessingAlgorithmDialogBase : public QDialog, public QgsPr
     Qgis::DistanceUnit mDistanceUnits = Qgis::DistanceUnit::Unknown;
     Qgis::AreaUnit mAreaUnits = Qgis::AreaUnit::Unknown;
     QString mTemporaryFolderOverride;
-    int mNumberOfThreads = QThread::idealThreadCount();
+    int mMaximumThreads = QThread::idealThreadCount();
 
     QString formatHelp( QgsProcessingAlgorithm *algorithm );
     void scrollToBottomOfLog();
@@ -570,7 +570,7 @@ class GUI_EXPORT QgsProcessingContextOptionsWidget : public QgsPanelWidget, priv
     /**
      * Returns the number of threads to use selected in the widget.
      */
-    int numberOfThreads() const;
+    int maximumThreads() const;
 };
 
 #endif