Skip to content

Commit

Permalink
Move FieldMapper parameter type to c++
Browse files Browse the repository at this point in the history 
Fixes sip "forgeting" about Python overrides for the type definition

Refs #36706
  • Loading branch information
@nyalldawson
nyalldawson committed Jun 1, 2020
1 parent 95387cf commit 191e362
Show file tree
Hide file tree
Showing 11 changed files with 111 additions and 109 deletions.
7 changes: 4 additions & 3 deletions python/core/auto_generated/processing/qgsprocessingparameterfieldmap.sip.in
View file
Expand Up @@ -8,7 +8,6 @@




class QgsProcessingParameterFieldMapping : QgsProcessingParameterDefinition
{
%Docstring
Expand All @@ -24,7 +23,7 @@ class QgsProcessingParameterFieldMapping : QgsProcessingParameterDefinition
#include "qgsprocessingparameterfieldmap.h"
%End
public:
QgsProcessingParameterFieldMapping( const QString &name, const QString &description = QString(), const QString &parentLayerParameterName = QString() );
QgsProcessingParameterFieldMapping( const QString &name, const QString &description = QString(), const QString &parentLayerParameterName = QString(), bool optional = false );
%Docstring
Constructor for QgsProcessingParameterFieldMapping.
%End
Expand All @@ -33,7 +32,7 @@ Constructor for QgsProcessingParameterFieldMapping.

virtual QString type() const;

virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context ) const;
virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = 0 ) const;

virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const;

Expand All @@ -43,6 +42,8 @@ Constructor for QgsProcessingParameterFieldMapping.

virtual bool fromVariantMap( const QVariantMap &map );

virtual QStringList dependsOnOtherParameters() const;


static QString typeName();
%Docstring
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/processing/qgsprocessingparametervectortilewriterlayers.sip.in
View file
Expand Up @@ -48,7 +48,7 @@ Constructor for QgsProcessingParameterVectorTileWriterLayers.

virtual QString type() const;

virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context ) const;
virtual bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = 0 ) const;

virtual QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const;

Expand Down
1 change: 1 addition & 0 deletions python/core/core_auto.sip
View file
Expand Up @@ -451,6 +451,7 @@
%Include auto_generated/processing/qgsprocessingcontext.sip
%Include auto_generated/processing/qgsprocessingfeedback.sip
%Include auto_generated/processing/qgsprocessingoutputs.sip
%Include auto_generated/processing/qgsprocessingparameterfieldmap.sip
%Include auto_generated/processing/qgsprocessingparameters.sip
%Include auto_generated/processing/qgsprocessingparametertype.sip
%Include auto_generated/processing/qgsprocessingparametervectortilewriterlayers.sip
Expand Down
82 changes: 5 additions & 77 deletions python/plugins/processing/algs/qgis/FieldsMapper.py
View file
Expand Up @@ -28,12 +28,9 @@
QgsFields,
QgsProcessing,
QgsProcessingException,
QgsProcessingParameterDefinition,
QgsProcessingParameterType,
QgsProcessingParameterFieldMapping,
NULL)

from qgis.PyQt.QtCore import QCoreApplication

from processing.algs.qgis.QgisAlgorithm import QgisFeatureBasedAlgorithm


Expand All @@ -52,8 +49,9 @@ def tags(self):
return self.tr('attributes,table').split(',')

def initParameters(self, config=None):
fields_mapping = FieldsMapper.ParameterFieldsMapping(self.FIELDS_MAPPING,
description=self.tr('Fields mapping'))
fields_mapping = QgsProcessingParameterFieldMapping(self.FIELDS_MAPPING,
description=self.tr('Fields mapping'),
parentLayerParameterName='INPUT')
fields_mapping.setMetadata({
'widget_wrapper': 'processing.algs.qgis.ui.FieldsMappingPanel.FieldsMappingWidgetWrapper'
})
Expand Down Expand Up @@ -108,7 +106,7 @@ def prepareAlgorithm(self, parameters, context, feedback):
if expression.hasParserError():
feedback.reportError(
self.tr('Parser error for field "{}" with expression "{}": {}')
.format(
.format(
field_def['name'],
expression.expression(),
expression.parserErrorString()),
Expand Down Expand Up @@ -147,73 +145,3 @@ def processFeature(self, feature, context, feedback):
feature.setAttributes(attributes)
self._row_number += 1
return [feature]

class ParameterFieldsMappingType(QgsProcessingParameterType):

def __init__(self):
super().__init__()

def create(self, name):
return FieldsMapper.ParameterFieldsMapping(name)

def metadata(self):
return {'widget_wrapper': 'processing.algs.qgis.ui.FieldsMappingPanel.FieldsMappingWidgetWrapper'}

def name(self):
return QCoreApplication.translate('Processing', 'Fields Mapper')

def id(self):
return 'fields_mapping'

def pythonImportString(self):
return 'from processing.algs.qgis.FieldsMapper import FieldsMapper'

def className(self):
return 'FieldsMapper.ParameterFieldsMapping'

def description(self):
return QCoreApplication.translate('Processing', 'A mapping of field names to field type definitions and expressions. Used for the refactor fields algorithm.')

class ParameterFieldsMapping(QgsProcessingParameterDefinition):

def __init__(self, name, description='', parentLayerParameterName='INPUT'):
super().__init__(name, description)
self._parentLayerParameter = parentLayerParameterName

def clone(self):
copy = FieldsMapper.ParameterFieldsMapping(self.name(), self.description(), self._parentLayerParameter)
return copy

def type(self):
return self.typeName()

@staticmethod
def typeName():
return 'fields_mapping'

def checkValueIsAcceptable(self, value, context=None):
if not isinstance(value, list):
return False
for field_def in value:
if not isinstance(field_def, dict):
return False
if 'name' not in field_def.keys():
return False
if 'type' not in field_def.keys():
return False
if 'expression' not in field_def.keys():
return False
return True

def valueAsPythonString(self, value, context):
return str(value)

def asScriptCode(self):
raise NotImplementedError()

@classmethod
def fromScriptCode(cls, name, description, isOptional, definition):
raise NotImplementedError()

def parentLayerParameter(self):
return self._parentLayerParameter
13 changes: 1 addition & 12 deletions python/plugins/processing/algs/qgis/QgisAlgorithmProvider.py
View file
Expand Up @@ -100,8 +100,6 @@ class QgisAlgorithmProvider(QgsProcessingProvider):

def __init__(self):
super().__init__()
self.algs = []
self.externalAlgs = []
QgsApplication.processingRegistry().addAlgorithmAlias('qgis:rectanglesovalsdiamondsfixed', 'native:rectanglesovalsdiamonds')

def getAlgs(self):
Expand Down Expand Up @@ -190,26 +188,17 @@ def svgIconPath(self):
return QgsApplication.iconPath("providerQgis.svg")

def loadAlgorithms(self):
self.algs = self.getAlgs()
for a in self.algs:
self.addAlgorithm(a)
for a in self.externalAlgs:
for a in self.getAlgs():
self.addAlgorithm(a)

def load(self):
with QgsRuntimeProfiler.profile('QGIS Python Provider'):
success = super().load()

if success:
self.parameterTypeFieldsMapping = FieldsMapper.ParameterFieldsMappingType()
QgsApplication.instance().processingRegistry().addParameterType(self.parameterTypeFieldsMapping)

return success

def unload(self):
super().unload()

QgsApplication.instance().processingRegistry().removeParameterType(self.parameterTypeFieldsMapping)

def supportsNonFileBasedOutput(self):
return True
2 changes: 1 addition & 1 deletion python/plugins/processing/algs/qgis/ui/FieldsMappingPanel.py
View file
Expand Up @@ -214,7 +214,7 @@ def updatePanelEnabledState():

def postInitialize(self, wrappers):
for wrapper in wrappers:
if wrapper.parameterDefinition().name() == self.parameterDefinition().parentLayerParameter():
if wrapper.parameterDefinition().name() == self.parameterDefinition().parentLayerParameterName():
if wrapper.parameterValue():
self.setLayer(wrapper.parameterValue())
wrapper.widgetValueHasChanged.connect(self.parentLayerChanged)
Expand Down
36 changes: 25 additions & 11 deletions src/core/processing/qgsprocessingparameterfieldmap.cpp
View file
Expand Up @@ -18,8 +18,8 @@
#include "qgsvectorlayer.h"


QgsProcessingParameterFieldMapping::QgsProcessingParameterFieldMapping( const QString &name, const QString &description, const QString &parentLayerParameterName )
: QgsProcessingParameterDefinition( name, description, QVariant(), false )
QgsProcessingParameterFieldMapping::QgsProcessingParameterFieldMapping( const QString &name, const QString &description, const QString &parentLayerParameterName, bool optional )
: QgsProcessingParameterDefinition( name, description, QVariant(), optional )
, mParentLayerParameterName( parentLayerParameterName )
{
}
Expand All @@ -34,7 +34,7 @@ QString QgsProcessingParameterFieldMapping::type() const
return typeName();
}

bool QgsProcessingParameterFieldMapping::checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context ) const
bool QgsProcessingParameterFieldMapping::checkValueIsAcceptable( const QVariant &input, QgsProcessingContext * ) const
{
if ( !input.isValid() )
return mFlags & FlagOptional;
Expand All @@ -61,13 +61,9 @@ bool QgsProcessingParameterFieldMapping::checkValueIsAcceptable( const QVariant
return true;
}

QString QgsProcessingParameterFieldMapping::valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const
QString QgsProcessingParameterFieldMapping::valueAsPythonString( const QVariant &value, QgsProcessingContext & ) const
{
QStringList parts;

// TODO

return parts.join( ',' ).prepend( '[' ).append( ']' );
return QgsProcessingUtils::variantToPythonLiteral( value );
}

QString QgsProcessingParameterFieldMapping::asPythonString( QgsProcessing::PythonOutputType outputType ) const
Expand All @@ -76,7 +72,13 @@ QString QgsProcessingParameterFieldMapping::asPythonString( QgsProcessing::Pytho
{
case QgsProcessing::PythonQgsProcessingAlgorithmSubclass:
{
QString code = QStringLiteral( "QgsProcessingParameterVectorTileWriterLayers('%1', '%2')" ).arg( name(), description() );
QString code = QStringLiteral( "QgsProcessingParameterFieldMapping('%1', '%2'" ).arg( name(), description() );
if ( !mParentLayerParameterName.isEmpty() )
code += QStringLiteral( ", parentLayerParameterName=%1" ).arg( QgsProcessingUtils::stringToPythonLiteral( mParentLayerParameterName ) );

if ( mFlags & FlagOptional )
code += QStringLiteral( ", optional=True" );
code += ')';
return code;
}
}
Expand All @@ -85,12 +87,24 @@ QString QgsProcessingParameterFieldMapping::asPythonString( QgsProcessing::Pytho

QVariantMap QgsProcessingParameterFieldMapping::toVariantMap() const
{

QVariantMap map = QgsProcessingParameterDefinition::toVariantMap();
map.insert( QStringLiteral( "parent_layer" ), mParentLayerParameterName );
return map;
}

bool QgsProcessingParameterFieldMapping::fromVariantMap( const QVariantMap &map )
{
QgsProcessingParameterDefinition::fromVariantMap( map );
mParentLayerParameterName = map.value( QStringLiteral( "parent_layer" ) ).toString();
return true;
}

QStringList QgsProcessingParameterFieldMapping::dependsOnOtherParameters() const
{
QStringList depends;
if ( !mParentLayerParameterName.isEmpty() )
depends << mParentLayerParameterName;
return depends;
}

QString QgsProcessingParameterFieldMapping::parentLayerParameterName() const
Expand Down
5 changes: 2 additions & 3 deletions src/core/processing/qgsprocessingparameterfieldmap.h
View file
Expand Up @@ -18,8 +18,6 @@

#include "qgsprocessingparameters.h"
#include "qgsprocessingparametertype.h"
#include "qgsvectortilewriter.h"


/**
* \ingroup core
Expand All @@ -30,7 +28,7 @@ class CORE_EXPORT QgsProcessingParameterFieldMapping : public QgsProcessingParam
{
public:
//! Constructor for QgsProcessingParameterFieldMapping.
QgsProcessingParameterFieldMapping( const QString &name, const QString &description = QString(), const QString &parentLayerParameterName = QString() );
QgsProcessingParameterFieldMapping( const QString &name, const QString &description = QString(), const QString &parentLayerParameterName = QString(), bool optional = false );

QgsProcessingParameterDefinition *clone() const override;
QString type() const override;
Expand All @@ -39,6 +37,7 @@ class CORE_EXPORT QgsProcessingParameterFieldMapping : public QgsProcessingParam
QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;
QVariantMap toVariantMap() const override;
bool fromVariantMap( const QVariantMap &map ) override;
QStringList dependsOnOtherParameters() const override;

//! Returns the type name for the parameter class.
static QString typeName() { return QStringLiteral( "fields_mapping" ); }
Expand Down
1 change: 1 addition & 0 deletions src/core/processing/qgsprocessingparameters.cpp
View file
Expand Up @@ -1959,6 +1959,7 @@ QgsProcessingParameterDefinition *QgsProcessingParameters::parameterFromVariantM
def.reset( new QgsProcessingParameterColor( name ) );
else if ( type == QgsProcessingParameterCoordinateOperation::typeName() )
def.reset( new QgsProcessingParameterCoordinateOperation( name ) );
else
{
QgsProcessingParameterType *paramType = QgsApplication::instance()->processingRegistry()->parameterType( type );
if ( paramType )
Expand Down
2 changes: 1 addition & 1 deletion src/core/processing/qgsprocessingparametervectortilewriterlayers.h
View file
Expand Up @@ -50,7 +50,7 @@ class CORE_EXPORT QgsProcessingParameterVectorTileWriterLayers : public QgsProce

QgsProcessingParameterDefinition *clone() const override;
QString type() const override;
bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context ) const override;
bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
QString asPythonString( QgsProcessing::PythonOutputType outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass ) const override;

Expand Down

0 comments on commit 191e362

Please sign in to comment.