Do not remove id_field from properties (#2100)

* don't remove id property

* Preserve id_field col in properties

* Fix tests to include id_field in properties

* Fix flake8

* Fix tests

---------

Co-authored-by: Benjamin Webb <benjamin.miller.webb@gmail.com>

Author: dblodgett-usgs

pygeoapi/provider/csv_.py

@@ -159,7 +159,7 @@ def _load(self, offset=0, limit=10, resulttype='results',
                     coordinates = None
 
                 feature = {'type': 'Feature'}
-                feature['id'] = row.pop(self.id_field)
+                feature['id'] = row[self.id_field]
                 if not skip_geometry:
                     feature['geometry'] = {
                         'type': 'Point',

pygeoapi/provider/oracle.py

@@ -1070,7 +1070,7 @@ def _response_feature(self, row_data):
                 for (key, value) in row_data.items()
                 if key != "GEOMETRY"
             }
-            feature["id"] = feature["properties"].pop(self.id_field)
+            feature["id"] = feature["properties"][self.id_field]
 
             return feature
         else:

pygeoapi/provider/sensorthings.py

@@ -305,7 +305,7 @@ def _make_feature(self, feature, select_properties=[], skip_geometry=False,
 
         :returns: dict of GeoJSON Feature
         """
-        _ = feature.pop(self.id_field)
+        _ = feature[self.id_field]
         id = f"'{_}'" if isinstance(_, str) else str(_)
         f = {
             'type': 'Feature', 'id': id, 'properties': {}, 'geometry': None

pygeoapi/provider/socrata.py

@@ -138,7 +138,7 @@ def query(self, offset=0, limit=10, resulttype='results',
         params['limit'] = limit
 
         def make_feature(f):
-            f['id'] = f['properties'].pop(self.id_field)
+            f['id'] = f['properties'][self.id_field]
             if skip_geometry:
                 f['geometry'] = None
             return f
@@ -178,7 +178,7 @@ def get(self, identifier, **kwargs):
         LOGGER.debug('Sending query')
         fc = self.client.get(self.resource_id, **params)
         f = fc.get('features').pop()
-        f['id'] = f['properties'].pop(self.id_field)
+        f['id'] = f['properties'][self.id_field]
         return f
 
     def _make_fields(self, select_properties=[]):

pygeoapi/provider/sql.py

@@ -487,8 +487,6 @@ def _sqlalchemy_to_feature(self, item, crs_transform_out=None,
             if key in item_dict:
                 feature['properties'][key] = item_dict[key]
 
-        feature['properties'].pop(self.id_field, None)
-
         return feature
 
     def _feature_to_sqlalchemy(self, json_data, identifier=None):

pygeoapi/provider/sqlite.py

@@ -162,7 +162,7 @@ def __response_feature(self, row_data, skip_geometry=False):
                 LOGGER.warning('Missing geometry')
 
             feature['properties'] = rd
-            feature['id'] = feature['properties'].pop(self.id_field)
+            feature['id'] = feature['properties'][self.id_field]
 
             return feature
         else:

tests/provider/test_csv__provider.py

@@ -112,7 +112,7 @@ def test_query(config):
     assert len(results['features']) == 1
     assert results['features'][0]['id'] == '238'
 
-    assert len(results['features'][0]['properties']) == 3
+    assert len(results['features'][0]['properties']) == 4
 
     results = p.query(select_properties=['value'])
     assert len(results['features'][0]['properties']) == 1

tests/provider/test_oracle_provider.py

@@ -621,8 +621,7 @@ def test_query_can_mandate_properties_which_are_not_returned(config):
     result = p.query(properties=[("name", "Aral Sea")])
 
     (feature,) = result['features']
-    # id is handled separately, so only wiki link and not name must be here
-    assert feature['properties'].keys() == {"wiki_link"}
+    assert feature['properties'].keys() == {"id", "wiki_link"}
 
 
 def test_query_mandatory_properties_must_be_specified(config):

tests/provider/test_postgresql_provider.py

@@ -172,8 +172,8 @@ def test_query(config):
     assert properties is not None
 
     properties_order = [
-        'name', 'waterway', 'covered', 'width', 'depth', 'layer', 'blockage',
-        'tunnel', 'natural', 'water', 'z_index'
+        'osm_id', 'name', 'waterway', 'covered', 'width', 'depth', 'layer',
+        'blockage', 'tunnel', 'natural', 'water', 'z_index'
     ]
 
     assert list(properties.keys()) == properties_order
@@ -239,6 +239,7 @@ def test_query_with_config_properties(config):
     """
     properties_subset = ['name', 'waterway', 'width', 'does_not_exist']
     config.update({'properties': properties_subset})
+    properties_subset.append('osm_id')  # id_field is always included
     provider = PostgreSQLProvider(config)
     assert provider.properties == properties_subset
     result = provider.query()

tests/provider/test_sensorthings_provider.py

@@ -91,7 +91,7 @@ def test_query_datastreams(config):
     assert len(results['features']) == 1
     assert results['features'][0]['id'] == '3'
 
-    assert len(results['features'][0]['properties']) == 18
+    assert len(results['features'][0]['properties']) == 19
 
     results = p.query(bbox=[-109, 36, -106, 37])
     assert results['numberReturned'] == 8