mac_maker.utilities.mixins.text_file

TextFile mixin classes.

class mac_maker.utilities.mixins.text_file.TextFileReader[source]

TextFileReader mixin class.

read_text_file(text_file_location)[source]

Load a text file from the file system and return it as a string.

Parameters

text_file_location (Union[Path, str]) – The path to the source file.

Return type

str

Returns

The loaded string object.

class mac_maker.utilities.mixins.text_file.TextFileWriter[source]

TextFileWriter mixin class.

write_text_file(text_file_content, text_file_location)[source]

Load a text file from the file system and return it as a string.

Parameters
  • text_file_content (str) – The content to write to the file.

  • text_file_location (Union[Path, str]) – The path to the source file.

Return type

None