_Downloader.compose_cfm_msg

classmethod _Downloader.compose_cfm_msg(data_name='<data_name>', file_path='<file_path>', update=False, note='')

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 or os.PathLike[str]) – 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

Tests:

>>> from pydriosm.downloader import _Downloader

>>> _Downloader.compose_cfm_msg()
'To compile data of <data_name>\n?'

>>> _Downloader.compose_cfm_msg(update=True)
'To update the data of <data_name>\n?'