Added QgsFields::names method to get a list of all the names of fields

qgis · Oct 6, 2017 · 1c63522 · 1c63522
1 parent 5dce8ed
commit 1c63522
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 1 deletion.
diff --git a/python/core/qgsfields.sip b/python/core/qgsfields.sip
@@ -115,6 +115,13 @@ Return number of items
  :rtype: int
 %End
 
+    QStringList names() const;
+%Docstring
+ Returns a list with field names
+.. versionadded:: 3.0
+ :rtype: list of str
+%End
+
     bool exists( int i ) const;
 %Docstring
  Return if a field index is valid

diff --git a/src/core/qgsfields.cpp b/src/core/qgsfields.cpp
@@ -122,6 +122,16 @@ int QgsFields::size() const
   return d->fields.count();
 }
 
+QStringList QgsFields::names() const
+{
+  QStringList lst;
+  for ( int i = 0; i < d->fields.count(); ++i )
+  {
+    lst.append( d->fields[i].field.name() );
+  }
+  return lst;
+}
+
 bool QgsFields::exists( int i ) const
 {
   return i >= 0 && i < d->fields.count();

diff --git a/src/core/qgsfields.h b/src/core/qgsfields.h
@@ -138,6 +138,12 @@ class CORE_EXPORT QgsFields
     //! Return number of items
     int size() const;
 
+    /**
+     * Returns a list with field names
+     * \since QGIS 3.0
+     */
+    QStringList names() const;
+
     /**
      * Return if a field index is valid
      * \param i  Index of the field which needs to be checked

diff --git a/tests/src/python/CMakeLists.txt b/tests/src/python/CMakeLists.txt
@@ -60,7 +60,7 @@ ADD_PYTHON_TEST(PyQgsFillSymbolLayers test_qgsfillsymbollayers.py)
 ADD_PYTHON_TEST(PyQgsProject test_qgsproject.py)
 ADD_PYTHON_TEST(PyQgsFeatureIterator test_qgsfeatureiterator.py)
 ADD_PYTHON_TEST(PyQgsFeedback test_qgsfeedback.py)
-ADD_PYTHON_TEST(PyQgsField test_qgsfield.py)
+ADD_PYTHON_TEST(PyQgsFields test_qgsfields.py)
 ADD_PYTHON_TEST(PyQgsFieldModel test_qgsfieldmodel.py)
 ADD_PYTHON_TEST(PyQgsFilterLineEdit test_qgsfilterlineedit.py)
 ADD_PYTHON_TEST(PyQgsFloatingWidget test_qgsfloatingwidget.py)

diff --git a/tests/src/python/test_qgsfield.py → tests/src/python/test_qgsfields.py b/tests/src/python/test_qgsfield.py → tests/src/python/test_qgsfields.py
@@ -91,6 +91,25 @@ def test_exceptions(self):
         with self.assertRaises(KeyError):
             fields.iconForField(111)
 
+    def test_names(self):
+        ml = QgsVectorLayer(
+            "Point?crs=epsg:4236" +
+            "&field=id:integer" +
+            "&field=value:double" +
+            "&field=crazy:double",
+            "test_data",
+            "memory")
+
+        assert ml.isValid()
+        fields = ml.fields()
+
+        expected_fields = ['id', 'value', 'crazy']
+
+        self.assertEquals(fields.names(), expected_fields)
+        fields.remove(1)
+        expected_fields = ['id', 'crazy']
+        self.assertEquals(fields.names(), expected_fields)
+
 
 if __name__ == '__main__':
     unittest.main()