Metadata-Version: 2.1
Name: hanging-threads
Version: 2.0.7
Summary: Deadlocks? Detect where your threads hang in Python with one import.
Home-page: https://github.com/niccokunzmann/hanging_threads
Author: Nicco Kunzmann
Author-email: niccokunzmann@gmail.com
License: MIT
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
License-File: LICENSE

hanging_threads
===============

Deadlocks? Detect where your threads hang in Python.

.. image:: https://travis-ci.org/niccokunzmann/hanging_threads.svg
   :target: https://travis-ci.org/niccokunzmann/hanging_threads
   :alt: Build Status

.. image:: https://badge.fury.io/py/hanging_threads.svg
   :target: https://pypi.python.org/pypi/hanging_threads
   :alt: Python Package Index

Installation
------------

Install the module with pip:

.. code:: bash

    pip install hanging_threads


If installing with **Windows**, open the command line program "cmd" and type

.. code:: bash

    py -m pip install hanging_threads


Usage
-----

Monitoring is as simple as calling the start_monitoring() function.

.. code:: python

    from hanging_threads import start_monitoring
    monitoring_thread = start_monitoring()

You may also pass additional parameters.

.. code:: python

    monitoring_thread = start_monitoring(seconds_frozen=10, test_interval=100)

The values in the example are defaults. This mean the check will happen 10
times per second. If a thread is frozen for at least 10 seconds then the stack
is dumped into standard error stream. This happens again every 10 seconds
while there is no changes in the stack registered during checks. Checks are done in
intervals of 100ms.

Note that it makes sense to save the thread object into variable so that you or
somebody else can stop the annoying dumps if needed.
For example, you may want to do this in the Python shell.

.. code:: python

    monitoring_thread.stop()

Changelog
---------

- v2.0.7: Start changelog, fix crash when line number is not known.

New Releases
------------

To release a new version:

1. Edit the ``README.md`` file in the Changelog Section and add the changes. Increase the ``hanging_threads.py`` version.

   .. code:: bash

       git add README.rst hanging_threads.py
       git commit -m"v2.0.7"
       git push

2. Create a tag for the version.

   .. code:: bash

       git tag v2.0.7
       git push origin v2.0.7

3. Notify solved issues about the release.


Further Reading
---------------

- `GIL-deadlocks are not covered by this <http://stackoverflow.com/questions/10014481/python-threads-hang#comment33263430_17744731>`__
- `Package requested, so this was created <http://stackoverflow.com/questions/3443607/how-can-i-tell-where-my-python-script-is-hanging/17744556#comment69129716_17744556>`__
- `faulthandler since Python 3.3 allows dumping stack traces <https://docs.python.org/3/library/faulthandler.html>`__
- `Discussion and the source GitHub Gist <https://gist.github.com/niccokunzmann/6038331>`__


