BBBikeDownloader.validate_input_subregion_name

BBBikeDownloader.validate_input_subregion_name(subregion_name)

Validate an input name of a geographic region.

The validation is done by matching the input subregion_name to a name of a geographic region available on BBBike’s free download server.

Parameters

subregion_name (str) – name of a geographic region (case-insensitive)

Returns

valid subregion name that matches, or is the most similar to, the input subregion_name

Return type

str

Example:

>>> from pydriosm.downloader import BBBikeDownloader

>>> bbbike_downloader = BBBikeDownloader()

>>> sr_name = 'leeds'

>>> sr_name_ = bbbike_downloader.validate_input_subregion_name(sr_name)

>>> print(sr_name_)
Leeds