.. _f-eventprofiler:

module ``profiling.event_profiler``
===================================





.. inheritance-diagram:: cpyquickhelper.profiling.event_profiler


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

module ``cpyquickhelper.profiling.event_profiler``

Profiling class.


:githublink:`%|py|0`




Classes
+++++++

+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                    | truncated documentation                                                                                                                  |
+==========================================================================================+==========================================================================================================================================+
| :class:`EventProfiler <cpyquickhelper.profiling.event_profiler.EventProfiler>`           | This profiler profiles both memory and function calls. It stores events and produces a timeline. See :ref:`l-example-event-profling` ... |
+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`EventProfilerDebug <cpyquickhelper.profiling.event_profiler.EventProfilerDebug>` | One class to measure time wasted by profiling.                                                                                           |
+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`WithEventProfiler <cpyquickhelper.profiling.event_profiler.WithEventProfiler>`   | Enables profiling with the following syntax:                                                                                             |
+------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| property                                                                                 | truncated documentation                                                                                                     |
+==========================================================================================+=============================================================================================================================+
| :meth:`n_columns <cpyquickhelper.profiling.event_profiler.EventProfiler.n_columns>`      | Returns the number of stored informations by the profiler in memory. This corresponds to the number of columns returned ... |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`n_columns <cpyquickhelper.profiling.event_profiler.EventProfilerDebug.n_columns>` | Returns the number of stored informations by the profiler in memory. This corresponds to the number of columns returned ... |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`report <cpyquickhelper.profiling.event_profiler.WithEventProfiler.report>`        | Returns the profiling report as a dataframe.                                                                                |
+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                         | truncated documentation                                                                                                |
+================================================================================================================+========================================================================================================================+
| :py:meth:`__enter__ <cpyquickhelper.profiling.event_profiler.WithEventProfiler.__enter__>`                     |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__exit__ <cpyquickhelper.profiling.event_profiler.WithEventProfiler.__exit__>`                       |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <cpyquickhelper.profiling.event_profiler.EventProfiler.__init__>`                           |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <cpyquickhelper.profiling.event_profiler.EventProfilerDebug.__init__>`                      |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <cpyquickhelper.profiling.event_profiler.WithEventProfiler.__init__>`                       |                                                                                                                        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_choose <cpyquickhelper.profiling.event_profiler.EventProfiler._choose>`                             | Returns a string which represents the called function. When the function is built-in, frame contains the function ...  |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_choose <cpyquickhelper.profiling.event_profiler.EventProfilerDebug._choose>`                        | Returns a string which represents the called function. When the function is built-in, frame contains the function ...  |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_choose_mod <cpyquickhelper.profiling.event_profiler.EventProfiler._choose_mod>`                     | Returns a string which represents the module of the called function. When the function is built-in, frame contains ... |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_choose_mod <cpyquickhelper.profiling.event_profiler.EventProfilerDebug._choose_mod>`                | Returns a string which represents the module of the called function. When the function is built-in, frame contains ... |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_empty_cache <cpyquickhelper.profiling.event_profiler.EventProfiler._empty_cache>`                   | Empties the cache. This function logs a couple of events. The cache must contains enough place to log them. ...        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_empty_cache <cpyquickhelper.profiling.event_profiler.EventProfilerDebug._empty_cache>`              | Empties the cache. This function logs a couple of events. The cache must contains enough place to log them. ...        |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_restore_profiler <cpyquickhelper.profiling.event_profiler.EventProfiler._restore_profiler>`         | This relies on :func:`sys.setprofile` and :func:`sys.getprofile`.                                                      |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_restore_profiler <cpyquickhelper.profiling.event_profiler.EventProfilerDebug._restore_profiler>`    | This relies on :func:`sys.setprofile` and :func:`sys.getprofile`.                                                      |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_setup_profiler <cpyquickhelper.profiling.event_profiler.EventProfiler._setup_profiler>`             | This relies on :func:`sys.setprofile` and :func:`sys.getprofile`.                                                      |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :py:meth:`_setup_profiler <cpyquickhelper.profiling.event_profiler.EventProfilerDebug._setup_profiler>`        | This relies on :func:`sys.setprofile` and :func:`sys.getprofile`.                                                      |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`log_event <cpyquickhelper.profiling.event_profiler.EventProfiler.log_event>`                            | Logs an event in the database.                                                                                         |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`log_event <cpyquickhelper.profiling.event_profiler.EventProfilerDebug.log_event>`                       | Logs an event in the database.                                                                                         |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`retrieve_raw_results <cpyquickhelper.profiling.event_profiler.EventProfiler.retrieve_raw_results>`      | Retrieves the raw results. Difficult to interpret.                                                                     |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`retrieve_raw_results <cpyquickhelper.profiling.event_profiler.EventProfilerDebug.retrieve_raw_results>` | Retrieves the raw results. Difficult to interpret.                                                                     |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`retrieve_results <cpyquickhelper.profiling.event_profiler.EventProfiler.retrieve_results>`              | Retrieves the raw results. Difficult to interpret.                                                                     |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`retrieve_results <cpyquickhelper.profiling.event_profiler.EventProfilerDebug.retrieve_results>`         | Retrieves the raw results. Difficult to interpret.                                                                     |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`start <cpyquickhelper.profiling.event_profiler.EventProfiler.start>`                                    | Starts the profiling.                                                                                                  |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`start <cpyquickhelper.profiling.event_profiler.EventProfilerDebug.start>`                               | Starts the profiling without enabling it.                                                                              |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`stop <cpyquickhelper.profiling.event_profiler.EventProfiler.stop>`                                      | Stops the profiling.                                                                                                   |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :meth:`stop <cpyquickhelper.profiling.event_profiler.EventProfilerDebug.stop>`                                 | Stops the unstarted profiling.                                                                                         |
+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+


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

.. automodule:: cpyquickhelper.profiling.event_profiler
    :members:
    :special-members: __init__
    :show-inheritance: