.. _f-customlog:

module ``loghelper.custom_log``
===============================





.. inheritance-diagram:: pyquickhelper.loghelper.custom_log


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

module ``pyquickhelper.loghelper.custom_log``

Creates a custom log (open a text file and flushes everything in it).


:githublink:`%|py|6`




Classes
+++++++

+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| class                                                             | truncated documentation                                                                          |
+===================================================================+==================================================================================================+
| :class:`CustomLog <pyquickhelper.loghelper.custom_log.CustomLog>` | Implements a custom logging function. This class is not protected against multithreading. Usage: |
+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+






Properties
++++++++++

+--------------------------------------------------------------------------+-------------------------+
| property                                                                 | truncated documentation |
+==========================================================================+=========================+
| :meth:`filename <pyquickhelper.loghelper.custom_log.CustomLog.filename>` | returns *_filename*     |
+--------------------------------------------------------------------------+-------------------------+
| :meth:`fullpath <pyquickhelper.loghelper.custom_log.CustomLog.fullpath>` | returns *_fullpath*     |
+--------------------------------------------------------------------------+-------------------------+






Methods
+++++++

+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| method                                                                      | truncated documentation                                                         |
+=============================================================================+=================================================================================+
| :py:meth:`__call__ <pyquickhelper.loghelper.custom_log.CustomLog.__call__>` | Log anything.                                                                   |
+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| :py:meth:`__del__ <pyquickhelper.loghelper.custom_log.CustomLog.__del__>`   | Closes the stream if needed.                                                    |
+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| :py:meth:`__init__ <pyquickhelper.loghelper.custom_log.CustomLog.__init__>` | initialisation                                                                  |
+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+
| :meth:`fLOG <pyquickhelper.loghelper.custom_log.CustomLog.fLOG>`            | Builds a message on a single line with the date, it deals with encoding issues. |
+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------+


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

.. automodule:: pyquickhelper.loghelper.custom_log
    :members:
    :special-members: __init__
    :show-inheritance: