.from_features does not retrieve feature 'id'

Problem

geopandas: 0.6.1

The GeoJSON spec says a feature object can include an id property. Ref Section 3.3.3:

If a feature has a commonly used identifier, that identifier should be included as a member of the feature object with the name “id”.

However, when loading data into a GeoDataFrame using from_features, this data is not retrieved.

Example:

df = gpd.GeoDataFrame.from_features(
        {
            "type": "FeatureCollection",
            "features": [
                {
                    "id": "ST0",
                    "type": "Feature",
                    "properties": {
                        "atco_code": "300000492FZ",
                        "bearing": 8,
                        "feature_name": "Demand Responsive Area",
                        "type": "BCT",
                    },
                    "geometry": {
                        "type": "Point",
                        "coordinates": (-1.1372773238238423, 52.346655194010665),
                    },
                },
                {
                    "id": "ST1",
                    "type": "Feature",
                    "properties": {
                        "atco_code": "0600CR19133",
                        "bearing": 2,
                        "feature_name": "Station View (E-bound)",
                        "type": "BCT",
                    },
                    "geometry": {
                        "type": "Point",
                        "coordinates": (-2.518177475249135, 53.063122731640604),
                    },
                },
            ],
        }
    )

Output:

Out[8]: 
                    geometry    atco_code  bearing            feature_name type
0  POINT (-1.13728 52.34666)  300000492FZ        8  Demand Responsive Area  BCT
1  POINT (-2.51818 53.06312)  0600CR19133        2  Station View (E-bound)  BCT

Expected

The id property is returned as a column in the GeoDataFrame:

Out[10]: 
                    geometry    atco_code  bearing            feature_name type   id
0  POINT (-1.13728 52.34666)  300000492FZ        8  Demand Responsive Area  BCT  ST0
1  POINT (-2.51818 53.06312)  0600CR19133        2  Station View (E-bound)  BCT  ST1

[gregbrowndev]

Hi @jorisvandenbossche No problem at all!

Ah I see, that is a potential issue! I would be happy to help and contribute a pull request if a decision could be made on how to proceed.

How about having an additional function parameter to extract the ID? E.g.

def from_features(cls, features, crs=None, columns=None, use_feature_id=False):
    ...

This wouldn’t help making it work with all file formats but could provide an opt-in, best-try attempt.

[guibar]

I too would like the ‘id’ to get read by .from_features.