renamerename.handlers.handlers¶
Utility classes for filename manipulators.
Module Contents¶
Classes¶
Utility class for manipulating a filename. |
|
Utility class for basic actions on a set of filenames. |
- class renamerename.handlers.handlers.FilenameHandler¶
Utility class for manipulating a filename.
- static add_prefix(name: str, prefix: str) str¶
Add a prefix to a filename.
- Parameters
name (str) – filename with extension
prefix (str) – prefix to be prepended to filename
- Returns
filename with prepended prefix
- Return type
str
- static add_suffix(name: str, suffix: str) str¶
Add a suffix to a filename.
- Parameters
name (str) – filename with extension
suffix (str) – suffix to be appended to filename
- Returns
filename with appended suffix
- Return type
str
- static change_extension(name: str, new_ext: str) str¶
Change the extension of a filename.
- Parameters
name – filename with extension
new_ext – desired extension of filename
- Returns
filename with new extension
- Return type
str
- static change_name(name: str, new_filename: str) str¶
Change filename to new name.
- Parameters
name (str) – filename with extension
new_filename (str) – desired filename
- Returns
changed filename (while preserving extension)
- Return type
str
- static get_components(name: str) Tuple[str]¶
Split pure filename and extension.
- Parameters
name (str) – filename with extension
- Returns
tuple of pure filename and extension
- Return type
Tuple[str]
- class renamerename.handlers.handlers.FileListHandler(names: List[str])¶
Utility class for basic actions on a set of filenames.
Constructor
- Parameters
names (List[str]) – list of filenames
- filter_names(self, filter: Optional[str] = None)¶
Filter filenames based on a Unix pattern filter.
- Parameters
filter (str) – pattern by which filenames are filtered out, defaults to None
- add_prefix(self, prefix: str)¶
Add prefixes to filtered filenames.
- Parameters
prefix (str) – prefix to be prepended to filtered filenames
- add_suffix(self, suffix: str)¶
Add suffixes to filtered filenames.
- Parameters
suffix (str) – suffix to be appended to filtered filenames
- change_extension(self, new_ext: str)¶
Change extensions of filtered filenames.
- Parameters
new_ext (str) – extension to be set for filtered filenames
- add_numbering(self, prefix: str)¶
Change filtered filenames to same name with numbered suffixes.
- Parameters
prefix (str) – new filename prepended to counter
- property filetransformations(self) renamerename.handlers.filetransformation.FileTransformation¶
Getter for mapping of source to target filenames.
- Returns
FileTransformation instance
- Return type
- property filenames(self) List[str]¶
Getter for filtered filenames.
- Returns
filtered filenames
- Return type
List[str]