pyufunc.add_date_in_filename#

pyufunc.add_date_in_filename(filename, date='', *, dt_fmt='%Y-%m-%d', as_prefix=False, as_suffix=True, verbose=True)#

Add date str in filename.

Parameters:

  • filename (str) – filename string

  • date (str | datetime.datetime, optional) – specify the date to add. Defaults to “”.

  • dt_fmt (str, optional) – format the date in filename. Defaults to “%Y-%m-%d”.

  • as_prefix (bool, optional) – if True, add date as prefix. Defaults to False.

  • as_suffix (bool, optional) – if True, add date as suffix. Defaults to True.

  • verbose (bool, optional) – if True, print out processing message. Defaults to True.

Raises:

ValueError – date should be str or datetime

Returns:

filename with date

Return type:

str

Example

>>> from pyufunc import add_date_in_filename
>>> add_date_in_filename("test.txt", date="2024-05-16", as_prefix=True)
"2024_05_16_test.txt"

>>> add_date_in_filename("test.txt", date="2024-05-16", as_suffix=True)
"test_2024_05_16.txt"

>>> add_date_in_filename("test.txt", date="2024-05-16", dt_fmt="%m-%d-%Y")
"test_05_16_2024.txt"