_Reader.validate_shp_layer_names

_Reader.validate_shp_layer_names(layer_names_, extract_dir, shp_zip_pathname, subregion_name, osm_file_format, data_dir, update, download, verbose)

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

Parameters
  • layer_names (list) – names of shapefile layers

  • extract_dir (str) – pathname of a directory to which the .shp.zip file is extracted

  • shp_zip_pathname (str) – pathname of a .shp.zip file

  • subregion_name (str) – name of a geographic (sub)region (case-insensitive) that is available on Geofabrik free download server

  • osm_file_format (str) – format (file extension) of OSM data

  • data_dir (str or os.PathLike[str]) – name or pathname of the data directory

  • update (bool) – whether to check to update pickle backup (if available), defaults to False

  • download (bool) – whether to download/update the PBF data file of the given subregion, if it is not available at the specified path, defaults to True

  • verbose (bool or int) – whether to print relevant information in console as the function runs, defaults to False

Returns

validated shapefile layer names

Return type

list

See examples for the methods GeofabrikReader.read_shp_zip() and BBBikeReader.read_shp_zip().