BBBikeDownloader.get_valid_subregion_names

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

Get a list of names of all geographic (sub)regions.

This can be an alternative to the method get_names_of_cities().

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:

a list of geographic (sub)region names available on BBBike free download server

Return type:

list | None

Examples:

>>> from pydriosm.downloader import BBBikeDownloader

>>> bbd = BBBikeDownloader()

>>> # A list of names of all BBBike geographic (sub)regions
>>> subrgn_names = bbd.get_valid_subregion_names()

>>> type(subrgn_names)
list