Skip to main content

A lightweight framework for running functions concurrently across multiple threads while maintaining a defined execution order.

Project description

ci PyPI version

threaded-order

A lightweight Python framework for running functions concurrently across multiple threads while maintaining defined execution order. It lets you declare dependencies between tasks—so some run only after others complete—without complex orchestration code.

Ideal for dependency-aware test execution, build pipelines, and automation workflows that benefit from controlled concurrency.

Key Features

  • Concurrent task execution using Python threads
  • Dependency graph automatically determines order
  • Simple registration and decorator API
  • Thread-safe logging, callbacks, and run summary
  • Graceful shutdown on interrupt

Installation

pip install threaded-order

Simple Example

from threaded_order import ThreadedOrder, ThreadProxyLogger
from time import sleep

to = ThreadedOrder(workers=3, setup_logging=True)
logger = ThreadProxyLogger()

@to.dregister()
def a(): sleep(1); logger.info("a")

@to.dregister(after=['a'])
def b(): sleep(1); logger.info("b")

@to.dregister(after=['a'])
def c(): sleep(1); logger.info("c")

@to.dregister(after=['b', 'c'])
def d(): sleep(1); logger.info("d")

if __name__ == '__main__':
    to.on_scheduler_done(lambda s: print(f"Passed:{len(s['passed'])} Failed:{len(s['failed'])}"))
    to.start()

Output:

2025-11-11 22:07:33 [MainThread]: starting thread pool with 3 threads
2025-11-11 22:07:34 [thread_0]: a
2025-11-11 22:07:35 [thread_1]: c
2025-11-11 22:07:35 [thread_0]: b
2025-11-11 22:07:36 [thread_1]: d
2025-11-11 22:07:36 [MainThread]: all work completed
2025-11-11 22:07:36 [MainThread]: duration: 3.01s
Passed:4 Failed:0

See examples in examples folder. To run examples, follow instructions below to build and run the Docker container then execute:

API Overview

class ThreadedOrder(workers=None, setup_logging=False, add_stream_handler=True)

Runs registered callables across multiple threads while respecting declared dependencies.

Core Methods

Method Description
register(obj, name, after=None) Register a callable for execution. after defines dependencies by name.
dregister(after=None) Decorator variant of register() for inline task definitions.
start() Start execution, respecting dependencies. Returns a summary dictionary.

Callbacks

All are optional and run on the scheduler thread (never worker threads).

Callback When Fired Signature
on_task_start(fn) Before a task starts (name)
on_task_done(fn) After a task finishes (name, ok)
on_scheduler_start(fn) Before scheduler starts running tasks (meta)
on_scheduler_done(fn) After all tasks complete (summary)

Interrupt Handling

Press Ctrl-C during execution to gracefully cancel outstanding work:

  • Running tasks finish naturally or are marked as cancelled
  • Remaining queued tasks are discarded
  • Final summary reflects all results

Development

Clone the repository and ensure the latest version of Docker is installed on your development server.

Build the Docker image:

docker image build \
-t threaded-order:latest .

Run the Docker container:

docker container run \
--rm \
-it \
-v $PWD:/code \
threaded-order:latest \
bash

Execute the dev pipeline:

make dev

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

threaded_order-1.1.0.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

threaded_order-1.1.0-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file threaded_order-1.1.0.tar.gz.

File metadata

  • Download URL: threaded_order-1.1.0.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for threaded_order-1.1.0.tar.gz
Algorithm Hash digest
SHA256 32d3e08697558cded13eb0f50bf341aa02c616a1753329d8cd72e2ea08a12447
MD5 c58692c4aba868e77bac849cf15dc39a
BLAKE2b-256 90c443df1b3c6d9df00a7d035268b94b4efc60cf2e17a81cde921df2dce2dc23

See more details on using hashes here.

File details

Details for the file threaded_order-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: threaded_order-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for threaded_order-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ac571ab03dcd79ad049f79816d0381e7e2ddfbf2297af4946508658d794e3cc
MD5 c76b1a2549ca39e85cd6f9c715dddc82
BLAKE2b-256 61e5ddf2266b57196fe3aa1b52f518055c380afb6a857d34655760efd0921ee0

See more details on using hashes here.

Supported by

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