GeofabrikDownloader.validate_subregion_name

GeofabrikDownloader.validate_subregion_name(subregion_name, valid_names=None, raise_error=False, **kwargs)[source]

Validate an input name of a geographic (sub)region.

The validation is done by matching the input to a name of a geographic (sub)region available on Geofabrik free download server.

Parameters:

  • subregion_name (str) – name/URL of a (sub)region available on Geofabrik free download server

  • valid_names (Iterable) – names of all (sub)regions available on a free download server

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

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

Returns:

valid subregion name that matches (or is the most similar to) the input

Return type:

str

Examples:

>>> from pydriosm.downloader import GeofabrikDownloader
>>> gfd = GeofabrikDownloader()
>>> subregion_name = 'london'
>>> gfd.validate_subregion_name(subregion_name)
'Greater London'
>>> subregion_name = 'https://download.geofabrik.de/europe/united-kingdom.html'
>>> gfd.validate_subregion_name(subregion_name)
'United Kingdom'