SHP.validate_layer_names¶

classmethod SHP.validate_layer_names(layer_names)[source]¶

Validate the input of layer name(s) for reading shapefiles.

Parameters:: layer_names (str | list | None) – name of a shapefile layer, e.g. ‘railways’, or names of multiple layers; if None (default), returns an empty list; if layer_names='all', the function returns a list of all available layers
Returns:: valid layer names to be input
Return type:: list

Examples:

>>> from pydriosm.reader._shp import SHP

>>> SHP.validate_layer_names(None)
[]

>>> SHP.validate_layer_names('point')
['points']

>>> SHP.validate_layer_names(['point', 'land'])
['points', 'landuse']

>>> SHP.validate_layer_names('all')
['buildings',
 'landuse',
 'natural',
 'places',
 'pofw',
 'points',
 'pois',
 'railways',
 'roads',
 'traffic',
 'transport',
 'water',
 'waterways']