GeofabrikDownloader.get_valid_subregion_names

GeofabrikDownloader.get_valid_subregion_names(update=False, confirmation_required=True, verbose=False)[source]

Get names of all available geographic (sub)regions.

Parameters:

  • update (bool) – whether to (check on and) update the prepacked data, defaults to False

  • confirmation_required (bool) – whether asking for confirmation to proceed, defaults to True

  • verbose (bool | int) – whether to print relevant information in console, defaults to False

Returns:

names of all geographic (sub)regions available on Geofabrik free download server

Return type:

set | None

Examples:

>>> from pydriosm.downloader import GeofabrikDownloader

>>> gfd = GeofabrikDownloader()

>>> # A list of the names of available geographic (sub)regions
>>> valid_subrgn_names = gfd.get_valid_subregion_names()
>>> type(valid_subrgn_names)
set