BBBikeDownloader.format_confirmation_prompt¶

classmethod BBBikeDownloader.format_confirmation_prompt(data_name='<data_name>', file_path='<file_path>', update=False, note='')[source]¶

Compose a short message to be printed for confirmation.

Parameters:

data_name (str) – name of the prepacked data. Defaults to '<data_name>'.
file_path (str | os.PathLike) – pathname of the prepacked data file. Defaults to "<file_path>".
update (bool) – whether to (check on and) update the prepacked data. Defaults to False.
note (str) – additional message. Defaults to "".

Returns:

a short message to be printed for confirmation.

Return type:

str

Examples:

>>> from pydriosm.downloader._base import BaseDownloader
>>> BaseDownloader.format_confirmation_prompt()
'Proceed to retrieve/compile data of <data_name>\n?'
>>> BaseDownloader.format_confirmation_prompt(update=True)
'Proceed to update the data of <data_name>\n?'