BBBikeDownloader.get_valid_subregion_names

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

Get a list of names of all 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

  • raise_error (bool) – Whether to raise the provided exception; if raise_error=False (default), the error will be suppressed.

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
>>> subregion_names = bbd.get_valid_subregion_names()
>>> type(subregion_names)
list
>>> len(subregion_names)
237