rename_files
rename_files#
- atomate2.common.files.rename_files(filenames: dict[str | Path, str | Path], directory: str | Path | None = None, host: str | None = None, allow_missing: bool = False, file_client: FileClient | None = None)[source]#
Delete files in a directory.
- Parameters
- filenames
dict
Files to rename. Given as a dictionary of
{old_name: new_name}
. File names should be given relative todirectory
. Glob matches are not supported.- directory
str
orPath
orNone
Directory in which to rename files. If
None
, the current directory will be used (or home folder if specifying a remote host).- host
str
orNone
The hostname used to specify a remote filesystem. Can be given as either “username@host” or just “host” in which case the username will be inferred from the current user. If
None
, the local filesystem will be used.- allow_missingbool
Whether to error if a file in
include_files
is not present in the directory.- file_client
FileClient
A file client to use for performing file operations.
- filenames