sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-30 00:29:39 -05:00
Code Issues Packages Projects Releases Wiki Activity

address review

Browse Source
This commit is contained in:
Alexander Bruy 2023-04-24 09:52:13 +03:00 committed by Nyall Dawson
parent a44bfaceef
commit 1c1e46029a
8 changed files with 72 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
python/core/auto_generated/processing/qgsprocessingcontext.sip.in
View File

@ -611,20 +611,23 @@ 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.
@ -632,7 +635,14 @@ 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

2
python/plugins/processing/algs/qgis/TilesXYZ.py
View File

@ -252,7 +252,7 @@ class TilesXYZAlgorithmBase(QgisAlgorithm):
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)

2
src/analysis/processing/pdal/qgspdalalgorithmbase.cpp
View File

@ -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 )
{

8
src/core/processing/qgsprocessingcontext.cpp
View File

@ -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

24
src/core/processing/qgsprocessingcontext.h
View File

@ -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 );

8
src/gui/processing/qgsprocessingalgorithmdialogbase.cpp
View File

@ -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();
}

4
src/gui/processing/qgsprocessingalgorithmdialogbase.h
View File

@ -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

56
tests/src/analysis/testqgsprocessingpdalalgs.cpp
View File

@ -107,7 +107,7 @@ void TestQgsProcessingPdalAlgs::convertFormat()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -124,7 +124,7 @@ void TestQgsProcessingPdalAlgs::convertFormat()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "translate" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -139,7 +139,7 @@ void TestQgsProcessingPdalAlgs::reproject()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -158,7 +158,7 @@ void TestQgsProcessingPdalAlgs::reproject()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "translate" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -174,7 +174,7 @@ void TestQgsProcessingPdalAlgs::fixProjection()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -193,7 +193,7 @@ void TestQgsProcessingPdalAlgs::fixProjection()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "translate" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -209,7 +209,7 @@ void TestQgsProcessingPdalAlgs::thin()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -272,7 +272,7 @@ void TestQgsProcessingPdalAlgs::thin()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "thin" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -291,7 +291,7 @@ void TestQgsProcessingPdalAlgs::boundary()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -345,7 +345,7 @@ void TestQgsProcessingPdalAlgs::boundary()
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "boundary" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -364,7 +364,7 @@ void TestQgsProcessingPdalAlgs::density()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -453,7 +453,7 @@ void TestQgsProcessingPdalAlgs::density()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "density" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -474,7 +474,7 @@ void TestQgsProcessingPdalAlgs::exportRasterTin()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -563,7 +563,7 @@ void TestQgsProcessingPdalAlgs::exportRasterTin()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "to_raster_tin" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -584,7 +584,7 @@ void TestQgsProcessingPdalAlgs::tile()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -637,7 +637,7 @@ void TestQgsProcessingPdalAlgs::tile()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "tile" )
<< QStringLiteral( "--length=150" )
@ -655,7 +655,7 @@ void TestQgsProcessingPdalAlgs::exportRaster()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -761,7 +761,7 @@ void TestQgsProcessingPdalAlgs::exportRaster()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "to_raster" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -783,7 +783,7 @@ void TestQgsProcessingPdalAlgs::exportVector()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -831,7 +831,7 @@ void TestQgsProcessingPdalAlgs::exportVector()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "to_vector" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -849,7 +849,7 @@ void TestQgsProcessingPdalAlgs::merge()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -899,7 +899,7 @@ void TestQgsProcessingPdalAlgs::merge()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "merge" )
<< QStringLiteral( "--output=%1" ).arg( outputFile )
@ -917,7 +917,7 @@ void TestQgsProcessingPdalAlgs::buildVpc()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -979,7 +979,7 @@ void TestQgsProcessingPdalAlgs::buildVpc()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "build_vpc" )
<< QStringLiteral( "--output=%1" ).arg( outputFile )
@ -998,7 +998,7 @@ void TestQgsProcessingPdalAlgs::clip()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -1039,7 +1039,7 @@ void TestQgsProcessingPdalAlgs::clip()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "clip" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )
@ -1057,7 +1057,7 @@ void TestQgsProcessingPdalAlgs::filter()
std::unique_ptr< QgsProcessingContext > context = std::make_unique< QgsProcessingContext >();
context->setProject( QgsProject::instance() );
context->setNumberOfThreads( 0 );
context->setMaximumThreads( 0 );
QgsProcessingFeedback feedback;
@ -1091,7 +1091,7 @@ void TestQgsProcessingPdalAlgs::filter()
);
// set max threads to 2, a --threads argument should be added
context->setNumberOfThreads( 2 );
context->setMaximumThreads( 2 );
args = alg->createArgumentLists( parameters, *context, &feedback );
QCOMPARE( args, QStringList() << QStringLiteral( "translate" )
<< QStringLiteral( "--input=%1" ).arg( mPointCloudLayerPath )