GeofabrikDownloader.validate_file_format

GeofabrikDownloader.validate_file_format(osm_file_format, valid_file_formats=None, raise_err=True, **kwargs)[source]

Validate an input file format of OSM data.

The validation is done by matching the input to a filename extension available on Geofabrik free download server.

Parameters:
  • osm_file_format (str) – file format/extension of the OSM data on the free download server

  • valid_file_formats (Iterable) – fil extensions of the data available on a free download server

  • raise_err (bool) – (if the input fails to match a valid name) whether to raise the error pydriosm.downloader.InvalidFileFormatError, defaults to True

  • kwargs – [optional] parameters of pyhelpers.text.find_similar_str()

Returns:

formal file format

Return type:

str

Examples:

>>> from pydriosm.downloader import GeofabrikDownloader

>>> gfd = GeofabrikDownloader()

>>> input_file_format = ".pbf"
>>> valid_file_format = gfd.validate_file_format(osm_file_format=input_file_format)
>>> valid_file_format
'.osm.pbf'

>>> input_file_format = "shp"
>>> valid_file_format = gfd.validate_file_format(osm_file_format=input_file_format)
>>> valid_file_format
'.shp.zip'