.. _f-eventprofilerccpython-39-x8664-linux-gnu:

module ``profiling._event_profiler_c``
======================================







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

module ``cpyquickhelper.profiling._event_profiler_c``

Event Profiler with the C Python API.

:githublink:`%|py|0`






Functions
+++++++++

+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                           | truncated documentation                                                                                                     |
+====================================================================================================================+=============================================================================================================================+
| :func:`_profiling_delete <cpyquickhelper.profiling._event_profiler_c._profiling_delete>`                           | Release all references on stored python objects.                                                                            |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`_profiling_dump_and_clear <cpyquickhelper.profiling._event_profiler_c._profiling_dump_and_clear>`           | Copies the buffer into another one allocated before calling this method.The function does not lock the :epkg:`GIL`.         |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`_profiling_get_saved_maps <cpyquickhelper.profiling._event_profiler_c._profiling_get_saved_maps>`           | Returns a tuple with two dictionaries. One for all the event frames, a second one for the event arguments.                  |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`_profiling_log_event <cpyquickhelper.profiling._event_profiler_c._profiling_log_event>`                     | Logs an event.                                                                                                              |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`_profiling_n_columns <cpyquickhelper.profiling._event_profiler_c._profiling_n_columns>`                     | Returns the number of informations stored per event. Total size must be multiplied `sizeof(int64_t)`.                       |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`_profiling_register_pyinstance <cpyquickhelper.profiling._event_profiler_c._profiling_register_pyinstance>` | Registers an object called when the buffer is full. This one should call @see fn _profiling_dump_and_clear to empty the ... |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`_profiling_start <cpyquickhelper.profiling._event_profiler_c._profiling_start>`                             | Starts the profiler. One instance is stored in a static pointer.                                                            |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`_profiling_stop <cpyquickhelper.profiling._event_profiler_c._profiling_stop>`                               | Stops the profiler. The function checks that the profiler was emptied. The static instance is removed.                      |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`dummy_capsule <cpyquickhelper.profiling._event_profiler_c.dummy_capsule>`                                   | Returns a dummy capsule with 128 uint32_t.                                                                                  |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`get_memory_content <cpyquickhelper.profiling._event_profiler_c.get_memory_content>`                         | Returns the content of the memory between addresses [ptr, ptr+size[ where ptr is the pointer held by the capsule.           |
+--------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+








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

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