FileSystem.Rename

Description

This Task takes files and folders and renames them.

FileSystem.Rename optionally uses the datetime module from Python’s standard library to prefix a timestamp.

Note: If the name is already in use a counter will be appended.

Arguments

  • name (required) is a string specifying the new name (including extension) of the file or folder.
name = '_logfiles'
  • timestamp_prefix (optional) is a boolean that controls if the name should be prefixed with a timestamp.
# timestamp_prefix = False  # default
timestamp_prefix = True
  • timestamp_pattern (optional) is a string specifying how the date and time should be formatted if timestamp_prefix is set to True. For a nice list of available directives see strftime.org.
# timestamp_pattern = '%Y-%m-%d_%H%M%S'  # default
timestamp_pattern = '%Y-%m'

Requirements

Python (Non-Standard-Library Packages)

None.

External Executables

None.

API Credentials

None.

Resources