validate_shp_layer_names

pydriosm.utils.validate_shp_layer_names(layer_names)

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

Parameters

layer_names (str or list or None) – name of a shapefile layer, e.g. ‘railways’, or names of multiple layers; if None (default), returns an empty list; if 'all', returns a list of all available layers

Returns

valid layer names to be input

Return type

list

Examples:

>>> from pydriosm.utils import validate_shp_layer_names

>>> lyr_names = None
>>> lyr_names_ = validate_shp_layer_names(lyr_names)
>>> print(lyr_names_)
[]

>>> lyr_names = 'point'
>>> lyr_names_ = validate_shp_layer_names(lyr_names)
>>> print(lyr_names_)
['points']

>>> lyr_names = ['point', 'land']
>>> lyr_names_ = validate_shp_layer_names(lyr_names)
>>> print(lyr_names_)
['points', 'landuse']

>>> lyr_names = 'all'
>>> lyr_names_ = validate_shp_layer_names(lyr_names)
>>> print(lyr_names_)
['buildings',
 'landuse',
 'natural',
 'places',
 'points',
 'pofw',
 'pois',
 'railways',
 'roads',
 'traffic',
 'transport',
 'water',
 'waterways']