.. _f-bufferfileswriting:

module ``helpers.buffer_files_writing``
=======================================





.. inheritance-diagram:: pymmails.helpers.buffer_files_writing


Short summary
+++++++++++++

module ``pymmails.helpers.buffer_files_writing``

Buffer files writing


:githublink:`%|py|5`




Classes
+++++++

+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| class                                                                                  | truncated documentation                                                                                                |
+========================================================================================+========================================================================================================================+
| :class:`BufferFilesWriting <pymmails.helpers.buffer_files_writing.BufferFilesWriting>` | this class aims at delaying writing files, method *open* returns a buffer, method *flush* actually writes the file ... |
+----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                     | truncated documentation                                                                                                    |
+============================================================================================================+============================================================================================================================+
| :py:meth:`__del__ <pymmails.helpers.buffer_files_writing.BufferFilesWriting.__del__>`                      | destructor, check everything was flushed                                                                                   |
+------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <pymmails.helpers.buffer_files_writing.BufferFilesWriting.__init__>`                    | constructor                                                                                                                |
+------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__len__ <pymmails.helpers.buffer_files_writing.BufferFilesWriting.__len__>`                      | return the number of buffered files                                                                                        |
+------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`exists <pymmails.helpers.buffer_files_writing.BufferFilesWriting.exists>`                           | tells if a file was already written                                                                                        |
+------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`flush <pymmails.helpers.buffer_files_writing.BufferFilesWriting.flush>`                             | flush a file (actually write it) and make it disappear from the list of buffered files, if the folder does not exists, ... |
+------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`listfiles <pymmails.helpers.buffer_files_writing.BufferFilesWriting.listfiles>`                     | returns the list of flushed and opened files, does not preserved order                                                     |
+------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`open <pymmails.helpers.buffer_files_writing.BufferFilesWriting.open>`                               | open a file and returns a buffer                                                                                           |
+------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :meth:`read_binary_content <pymmails.helpers.buffer_files_writing.BufferFilesWriting.read_binary_content>` | return the content of file (binary format)                                                                                 |
+------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pymmails.helpers.buffer_files_writing
    :members:
    :special-members: __init__
    :show-inheritance: