renamerename.executor.encoder_decoder

Serialization and Deserialization utility classes for FileTransformation

Module Contents

Classes

TransformationEncoder	Serialization utility class for FileTransformation instance
TransformationDecoder	Deserialization utility class for FileTransformation instance

class renamerename.executor.encoder_decoder.TransformationEncoder

Serialization utility class for FileTransformation instance

static encode_to_json_file(filetransformation: renamerename.handlers.filetransformation.FileTransformation, path: str)

Serialize FileTransformation instance to JSON file.

Parameters

• filetransformation (FileTransformation) – FileTransformation instance

• path (str) – serialization file path

static save_transformation_to_json(directory: str, filetransformation: renamerename.handlers.filetransformation.FileTransformation)

Serialize FileTransformation instance to JSON file named renaming_DATE_TIME.json.

Parameters

• directory (str) – parent directory where JSON file is saved

• filetransformation – FileTransformation instance

class renamerename.executor.encoder_decoder.TransformationDecoder

Deserialization utility class for FileTransformation instance

static decode_from_json_file(path: str) → renamerename.handlers.filetransformation.FileTransformation

Deserialize JSON file into FileTransformation instance.

Parameters

path (str) – path to JSON file

Returns

FileTransformation instance

Return type

FileTransformation