renamerename.executor.executor

Utility classes for executing renaming on filesystem.

Module Contents

Classes

RenameExecutor

Renaming executor on the filesystem.
exception renamerename.executor.executor.DuplicateFilenamesError

Bases: RuntimeError

RuntimeError wrapper for loaded mapping with common values

Initialize self. See help(type(self)) for accurate signature.

class renamerename.executor.executor.RenameExecutor(directory: str, save_renaming=False)

Renaming executor on the filesystem.

Constructor

Parameters

  • directory (str) – directory containing the files to be renamed

  • save_renaming (bool, optional) – save source and target filenames to disk , defaults to False

execute(self, names: List[str], filetransformation: renamerename.handlers.handlers.FileTransformation)

Rename files on filesystem based on provided specification.

Parameters

  • names (List[str]) – list of all filenames in directory

  • filetransformation (FileTransformation) – FileTransformation instance

Raises

  • FileNotFoundError – source filename does not exist

  • FileExistsError – target filename already exists

display_output(self, names: List[str], filetransformation: renamerename.handlers.handlers.FileTransformation)

Display output of renaming to STDOUT without actual execution.

Parameters

  • names (List[str]) – list of all filenames in directory

  • filetransformation (FileTransformation) – FileTransformation instance

adjust_duplicates(self, names: List[str], filetransformation: renamerename.handlers.handlers.FileTransformation) → renamerename.handlers.handlers.FileTransformation

Resolve duplicate filenames in list of target filenames.

Parameters

  • names (List[str]) – list of all filenames in directory

  • filetransformation (FileTransformation) – FileTransformation instance

Returns

FileTransformation instance

Return type

FileTransformation

execute_from_file(self, names: List[str], filepath: str, undo: Optional[bool] = False)

Rename files on filesystem based on provided mapping from file.

Parameters

  • names (List[str]) – list of all filenames in directory

  • filepath (str) – path to file with source to target filename mapping

  • undo (bool, optional) – reverse loaded mapping, defaults to False

Raises

DuplicateFilenamesError – found duplicated among target filenames in loaded file

property actual_transformation(self) → renamerename.handlers.handlers.FileTransformation

Getter for actual renaming as FileTransformation.

Returns

Actual transformation

Return type

FileTransformation