Skip to main content

A utility to manage and kill threads in Python applications

Project description

PyThreadKiller

A utility to manage and kill threads in Python applications.


GitHub Repo GitHub License GitHub Forks GitHub Stars GitHub Contributors

Build Status codecov PyPI Version Test PyPI Version

GitHub Image


Overview

PyThreadKiller is a utility designed to manage and kill threads in Python applications. This package provides a simple and effective way to terminate threads safely and retrieve return values from target functions.

Directory Structure

PyThreadKiller/
    ├── PyThreadKiller/
    │   ├── __init__.py
    │   ├── main.py
    ├── tests/
    │   ├── TestPyThreadKiller.py
    ├── CHANGELOG.md
    ├── README.md
    ├── requirements.txt
    ├── .github/
    │   └── workflows/
    │       └── python-app.yml
    └── setup.py

Installation

You can install the package using pip:

pip install PyThreadKiller

Usage

  • Here is an example of how to use PyThreadKiller:
import time
from PyThreadKiller import PyThreadKiller

def example_target():
    for i in range(5):
        print(f"Thread is running... {i}")
        time.sleep(1)
    return True

# Create an instance of PyThreadKiller
thread = PyThreadKiller(target=example_target)
thread.start()

# Allow the thread to run for 3 seconds
time.sleep(3)

# Kill the thread
result = thread.kill()
print(f"Return value after killing the thread: {result}")

# Output:
# Thread is running... 0
# Thread is running... 1
# Thread is running... 2
# Thread killed successfully
# Return value after killing the thread: None

License:

  • This project is licensed under the MIT License - see the LICENSE file for details.

  • This updated README.md includes the new project name, badges, a brief overview, the directory structure, installation instructions, usage example, changelog, and the main code for the PyThreadKiller class. Make sure to adjust any URLs and links to point to the correct resources for your project.

Changelog

[0.1] - 2024-05-19

Added

  • Initial draft of PyThreadKiller with basic thread management and killing functionality.

[3.0.4] - 2024-07-20

Fix

  • Test file for PyThreadKiller to test the package itself.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyThreadKiller-3.0.5.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

PyThreadKiller-3.0.5-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file PyThreadKiller-3.0.5.tar.gz.

File metadata

  • Download URL: PyThreadKiller-3.0.5.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for PyThreadKiller-3.0.5.tar.gz
Algorithm Hash digest
SHA256 99ca7678feec027f725b4275e7dfdf81c49b247f0fb29ae850f2f6fe3285a77d
MD5 0389c1cdb395fe204be3af064baf3097
BLAKE2b-256 49edf78dbc8fb815ea9cde4bd9411e2fd2df4a75912a59ba2f8b05f6532ac0a5

See more details on using hashes here.

File details

Details for the file PyThreadKiller-3.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for PyThreadKiller-3.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8a1511c033de6e81704aa96eac2a0b5cdb1689d637821afb5617262c85ee5bcc
MD5 ce785c15660d33d87d141aa0d83bc2cd
BLAKE2b-256 d2f9a8eebd8c08f734483be3b9f0b9023441fb69a14cb6537f466b20d18eb087

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page