.. _f-threadhelper:

module ``parallel.threadhelper``
================================





.. inheritance-diagram:: cpyquickhelper.parallel.threadhelper


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

module ``cpyquickhelper.parallel.threadhelper``

Shortcut to *parallel*.


:githublink:`%|py|5`




Classes
+++++++

+-----------------------------------------------------------------+-----------------------------------------------------+
| class                                                           | truncated documentation                             |
+=================================================================+=====================================================+
| :class:`KThread <cpyquickhelper.parallel.threadhelper.KThread>` | Add methods *kill* to :epkg:`*py:threading:Thread`. |
+-----------------------------------------------------------------+-----------------------------------------------------+






Properties
++++++++++

+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| property                                                                   | truncated documentation                                                                                                     |
+============================================================================+=============================================================================================================================+
| :meth:`daemon <cpyquickhelper.parallel.threadhelper.KThread.daemon>`       | A boolean value indicating whether this thread is a daemon thread. This must be set before start() is called, otherwise ... |
+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`ident <cpyquickhelper.parallel.threadhelper.KThread.ident>`         | Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() ...     |
+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`name <cpyquickhelper.parallel.threadhelper.KThread.name>`           | A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. ...       |
+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :meth:`native_id <cpyquickhelper.parallel.threadhelper.KThread.native_id>` | Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. ...           |
+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| method                                                           | truncated documentation                                                                                                                           |
+==================================================================+===================================================================================================================================================+
| :meth:`kill <cpyquickhelper.parallel.threadhelper.KThread.kill>` | Kills the thread if not alreayd finished. Source: `Python-Kill-Thread-Extension <https://github.com/munawarb/Python-Kill-Thread-Extension>`_. ... |
+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+


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

.. automodule:: cpyquickhelper.parallel.threadhelper
    :members:
    :special-members: __init__
    :show-inheritance: