.. _f-filesstatus:

module ``filehelper.files_status``
==================================





.. inheritance-diagram:: pyquickhelper.filehelper.files_status


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

module ``pyquickhelper.filehelper.files_status``

keep the status of a folder, assuming this folder is not moved


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| class                                                                    | truncated documentation                                                                                              |
+==========================================================================+======================================================================================================================+
| :class:`FilesStatus <pyquickhelper.filehelper.files_status.FilesStatus>` | This class maintains a list of files and does some verifications in order to check if a file was modified or not ... |
+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| method                                                                                                                | truncated documentation                                                                  |
+=======================================================================================================================+==========================================================================================+
| :py:meth:`__init__ <pyquickhelper.filehelper.files_status.FilesStatus.__init__>`                                      | file which will contains the status                                                      |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :py:meth:`__iter__ <pyquickhelper.filehelper.files_status.FilesStatus.__iter__>`                                      | Iterates on all files stored in the current file, yield a couple *(filename, FileInfo)*. |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :meth:`add_if_modified <pyquickhelper.filehelper.files_status.FilesStatus.add_if_modified>`                           | Adds a file to self.modifiedList if it was modified.                                     |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :meth:`add_modified_file <pyquickhelper.filehelper.files_status.FilesStatus.add_modified_file>`                       | Adds a file the modified list of files.                                                  |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :meth:`difference <pyquickhelper.filehelper.files_status.FilesStatus.difference>`                                     | Goes through the list of files and tells which one has changed.                          |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :meth:`has_been_modified_and_reason <pyquickhelper.filehelper.files_status.FilesStatus.has_been_modified_and_reason>` | Returns *(True, reason)* if a file was modified or *(False, None)* if not.               |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :meth:`iter_modified <pyquickhelper.filehelper.files_status.FilesStatus.iter_modified>`                               | Iterates on all modified files yield a couple *(filename, reason)*.                      |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :meth:`save_dates <pyquickhelper.filehelper.files_status.FilesStatus.save_dates>`                                     | Saves the status of the copy.                                                            |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+
| :meth:`update_copied_file <pyquickhelper.filehelper.files_status.FilesStatus.update_copied_file>`                     | Updates the file in copyFiles (before saving), update all fields.                        |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+


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

.. automodule:: pyquickhelper.filehelper.files_status
    :members:
    :special-members: __init__
    :show-inheritance: