threaded-order 1.3.1__tar.gz

threaded_order-1.3.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

threaded_order-1.3.1/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: threaded-order
+Version: 1.3.1
+Summary: A lightweight framework for running functions concurrently across multiple threads while maintaining a defined execution order.
+Author-email: Emilio Reyes <soda480@gmail.com>
+Project-URL: Homepage, https://github.com/soda480/threaded-order
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mock; extra == "dev"
+Requires-Dist: radon; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: coverage-badge; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+[![ci](https://github.com/soda480/threaded-order/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/soda480/threaded-order/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/threaded-order.svg)](https://badge.fury.io/py/threaded-order)
+
+# 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
+
+![graph](https://github.com/soda480/threaded-order/blob/main/docs/images/graph.png?raw=true)
+
+```Python
+from threaded_order import Scheduler, ThreadProxyLogger
+import time
+import random
+
+s = Scheduler(workers=3, setup_logging=True)
+logger = ThreadProxyLogger()
+
+def run(name):
+    time.sleep(random.uniform(.5, 3.5))
+    logger.info(f'{name} completed')
+
+@s.dregister()
+def a(): run('a')
+
+@s.dregister(after=['a'])
+def b(): run('b')
+
+@s.dregister(after=['a'])
+def c(): run('c')
+
+@s.dregister(after=['c'])
+def d(): run('d')
+
+@s.dregister(after=['c'])
+def e(): run('e')
+
+@s.dregister(after=['b', 'd'])
+def f(): run('f')
+
+if __name__ == '__main__':
+    s.on_scheduler_done(lambda s: print(f"Passed:{len(s['passed'])} Failed:{len(s['failed'])}"))
+    s.start()
+```
+
+![example4](https://github.com/soda480/threaded-order/blob/main/docs/images/example4.gif?raw=true)
+
+### ProgressBar Integration Example
+
+Can be done by using the `on_task_done` callback. See [example5](https://github.com/soda480/threaded-order/blob/main/examples/example5.py)
+
+![example5](https://github.com/soda480/threaded-order/blob/main/docs/images/example5.gif?raw=true)
+
+
+See examples in examples folder. To run examples, follow instructions below to build and run the Docker container then execute:
+
+## API Overview
+`class Scheduler(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:
+```sh
+docker image build \
+-t threaded-order:latest .
+```
+
+Run the Docker container:
+```sh
+docker container run \
+--rm \
+-it \
+-v $PWD:/code \
+threaded-order:latest \
+bash
+```
+
+Execute the dev pipeline:
+```sh
+make dev
+```

threaded_order-1.3.1/README.md

@@ -0,0 +1,125 @@
+[![ci](https://github.com/soda480/threaded-order/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/soda480/threaded-order/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/threaded-order.svg)](https://badge.fury.io/py/threaded-order)
+
+# 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
+
+![graph](https://github.com/soda480/threaded-order/blob/main/docs/images/graph.png?raw=true)
+
+```Python
+from threaded_order import Scheduler, ThreadProxyLogger
+import time
+import random
+
+s = Scheduler(workers=3, setup_logging=True)
+logger = ThreadProxyLogger()
+
+def run(name):
+    time.sleep(random.uniform(.5, 3.5))
+    logger.info(f'{name} completed')
+
+@s.dregister()
+def a(): run('a')
+
+@s.dregister(after=['a'])
+def b(): run('b')
+
+@s.dregister(after=['a'])
+def c(): run('c')
+
+@s.dregister(after=['c'])
+def d(): run('d')
+
+@s.dregister(after=['c'])
+def e(): run('e')
+
+@s.dregister(after=['b', 'd'])
+def f(): run('f')
+
+if __name__ == '__main__':
+    s.on_scheduler_done(lambda s: print(f"Passed:{len(s['passed'])} Failed:{len(s['failed'])}"))
+    s.start()
+```
+
+![example4](https://github.com/soda480/threaded-order/blob/main/docs/images/example4.gif?raw=true)
+
+### ProgressBar Integration Example
+
+Can be done by using the `on_task_done` callback. See [example5](https://github.com/soda480/threaded-order/blob/main/examples/example5.py)
+
+![example5](https://github.com/soda480/threaded-order/blob/main/docs/images/example5.gif?raw=true)
+
+
+See examples in examples folder. To run examples, follow instructions below to build and run the Docker container then execute:
+
+## API Overview
+`class Scheduler(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:
+```sh
+docker image build \
+-t threaded-order:latest .
+```
+
+Run the Docker container:
+```sh
+docker container run \
+--rm \
+-it \
+-v $PWD:/code \
+threaded-order:latest \
+bash
+```
+
+Execute the dev pipeline:
+```sh
+make dev
+```

threaded_order-1.3.1/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "threaded-order"
+dynamic = ["version"]
+authors = [
+  { name="Emilio Reyes", email="soda480@gmail.com" },
+]
+description = "A lightweight framework for running functions concurrently across multiple threads while maintaining a defined execution order."
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+dependencies = [
+]
+
+[tool.setuptools]
+packages = ["threaded_order"]
+
+[project.urls]
+"Homepage" = "https://github.com/soda480/threaded-order"
+
+[project.optional-dependencies]
+dev = [
+    "build",
+    "flake8",
+    "mock",
+    "radon",
+    "bandit",
+    "coverage",
+    "coverage-badge",
+    "twine"
+]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+version = {attr = "threaded_order.__version__"}

threaded_order-1.3.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

threaded_order-1.3.1/threaded_order/__init__.py

@@ -0,0 +1,32 @@
+from importlib import metadata as _metadata
+from os import getenv
+
+__all__ = [
+    'Scheduler',
+    'DAGraph',
+    'configure_logging',
+    'ThreadProxyLogger',
+    '__version__']
+
+def __getattr__(name):
+    if name == 'Scheduler':
+        from .scheduler import Scheduler
+        return Scheduler
+    if name == 'DAGraph':
+        from .graph import DAGraph
+        return DAGraph
+    if name == 'configure_logging':
+        from .logger import configure_logging
+        return configure_logging
+    if name == 'ThreadProxyLogger':
+        from .logger import ThreadProxyLogger
+        return ThreadProxyLogger
+    raise AttributeError(name)
+
+try:
+    __version__ = _metadata.version(__name__)
+except _metadata.PackageNotFoundError:
+    __version__ = '1.3.1'
+
+if getenv('DEV'):
+    __version__ = f'{__version__}+dev'

threaded_order-1.3.1/threaded_order/graph.py

@@ -0,0 +1,119 @@
+import threading
+import logging
+from collections import defaultdict
+
+def log_candidates(candidates, number):
+    """ log a debug message describing how many candidate nodes were found
+    """
+    logger = logging.getLogger(threading.current_thread().name)
+    count = len(candidates)
+    if not candidates:
+        message = 'but found no candidates eligible for submission'
+    else:
+        base = f"and found {count} candidate{'s' if count != 1 else ''} eligible for submission"
+        message = f"{base} {', '.join(candidates)}"
+    logger.debug(f'requested {number} {message}')
+
+class DAGraph:
+
+    def __init__(self):
+        """ initialize an empty DAG with parent and child adjacency mappings
+        """
+        self._parents = defaultdict(list)
+        self._children = defaultdict(set)
+
+    def add(self, name, after=None):
+        """ add a new node with optional dependencies
+
+            All items in `after` must already exist in the DAG.
+            Raises ValueError if the node already exists, dependencies are unknown,
+            or the addition would introduce a cycle.
+        """
+        logger = logging.getLogger(threading.current_thread().name)
+        after = after or []
+        logger.debug(f'add {name} dependent on {after}')
+        if name in self._parents:
+            raise ValueError(f'{name} has already been added')
+        unknowns = [dep for dep in after if dep not in self._parents]
+        if unknowns:
+            raise ValueError(f'{name} depends on unknown {unknowns}')
+        self._parents[name] = []
+        for dep in after:
+            self._parents[name].append(dep)
+            self._children[dep].add(name)
+        if self._has_cycle():
+            # rollback this node to keep DAG consistent
+            for dep in after:
+                self._children[dep].discard(name)
+            self._parents.pop(name, None)
+            raise ValueError(f'adding {name} will create a cycle')
+
+    def remove(self, name):
+        """ remove a completed node and detach it from all dependent children
+
+            Cleans up parent and child relationships and drops the node completely
+            once it has no remaining edges.
+        """
+        logger = logging.getLogger(threading.current_thread().name)
+        for child in self._children.pop(name, ()):
+            logger.debug(f'removing {name} as a dependency from {child}')
+            try:
+                self._parents[child].remove(name)
+            except ValueError:
+                # defensive: graph might already be partially cleaned
+                pass
+
+        if name in self._parents and not self._parents[name]:
+            logger.debug(f'removing {name} from dependency graph')
+            self._parents.pop(name, None)
+
+    def ready(self, active=None):
+        """ return a list of nodes whose dependencies are satisfied and not active
+        """
+        if active is None:
+            active = set()
+        return [name for name, deps in self._parents.items() if not deps and name not in active]
+
+    def get_candidates(self, active, number, sort=True):
+        """ return up to `number` ready nodes, optionally sorted for stable scheduling
+
+            Also logs the candidate list for visibility.
+        """
+        candidates = self.ready(active)
+        if sort:
+            candidates = sorted(candidates)
+        log_candidates(candidates, number)
+        return candidates[:number]
+
+    def _has_cycle(self):
+        """ return True if DAGraph contains a cycle
+        """
+        visited = set()
+        stack = set()
+
+        def visit(node):
+            if node in stack:
+                return True
+            if node in visited:
+                return False
+            visited.add(node)
+            stack.add(node)
+            for neighbor in self._parents[node]:
+                if visit(neighbor):
+                    return True
+            stack.remove(node)
+            return False
+        return any(visit(node) for node in self._parents)
+
+    def is_empty(self):
+        """ return True if the DAGraph has no nodes
+        """
+        return not self._parents and not self._children
+
+    def __repr__(self):
+        """ return a human-readable representation of the dependency graph
+        """
+        parents = '\n'.join(f'{n}: {self._parents[n]}' for n in sorted(self._parents))
+        children = '\n'.join(
+            f'{n}: {sorted(list(self._children[n]))}' for n in sorted(self._children))
+        return f'Parents:\n{parents}\nChildren:\n{children}'

threaded_order-1.3.1/threaded_order/logger.py

@@ -0,0 +1,45 @@
+import os
+import sys
+import threading
+import logging
+
+class ThreadProxyLogger:
+    def __getattr__(self, name):
+        return getattr(logging.getLogger(threading.current_thread().name), name)
+
+def configure_logging(workers, prefix='thread', add_stream_handler=False):
+    if add_stream_handler:
+        shandler = logging.StreamHandler(sys.stderr)
+        shandler.setLevel(logging.INFO)
+        shandler.setFormatter(
+            logging.Formatter(
+                "%(asctime)s [%(threadName)s]: %(message)s", "%Y-%m-%d %H:%M:%S"))
+
+        root = logging.getLogger()
+        root.setLevel(logging.DEBUG)
+        root.handlers.clear()
+        root.addHandler(shandler)
+
+    base = os.path.splitext(os.path.basename(sys.argv[0]))[0]
+    formatter = logging.Formatter(
+        "%(asctime)s %(levelname)-5s [%(threadName)s] %(funcName)s: %(message)s",
+        "%Y-%m-%d %H:%M:%S")
+
+    def add_handler(name):
+        filename = f'{base}_{name}.log'
+        logger = logging.getLogger(name)
+        if not any(
+            isinstance(handler, logging.FileHandler)
+            and getattr(handler, 'baseFilename', '').endswith(filename)
+            for handler in logger.handlers
+        ):
+            fhandler = logging.FileHandler(filename, mode='a', encoding='utf-8')
+            fhandler.setLevel(logging.DEBUG)
+            fhandler.setFormatter(formatter)
+            logger.addHandler(fhandler)
+        logger.setLevel(logging.DEBUG)
+        return logger
+
+    add_handler(threading.current_thread().name)
+    for index in range(workers):
+        add_handler(f'{prefix}_{index}')

threaded_order-1.3.1/threaded_order/scheduler.py

@@ -0,0 +1,341 @@
+import os
+import time
+import queue
+import threading
+import logging
+from collections import Counter
+from concurrent.futures import ThreadPoolExecutor, CancelledError
+from functools import wraps
+from .graph import DAGraph
+from .logger import configure_logging
+
+class Scheduler:
+    """ run functions concurrently across multiple threads while maintaining a defined
+        execution order
+    """
+    max_workers = min(8, os.cpu_count())
+
+    def __init__(self, workers=max_workers, setup_logging=False, add_stream_handler=True):
+        """ initialize scheduler with thread pool size, logging, and callback placeholders
+        """
+        # number of concurrent worker threads in the pool
+        self._workers = workers
+        # task name → callable object to execute
+        self._run_map = {}
+        # direct acyclic graph
+        self._dagraph = DAGraph()
+        # protects access to _futures (shared by scheduler and worker threads)
+        self._lock = threading.Lock()
+        # currently running task names
+        self._active = set()
+        # future → task name mapping for cancellation and error recovery
+        self._futures = {}
+        # signals scheduler when all tasks have completed
+        self._completed = threading.Event()
+        # ThreadPoolExecutor instance (managed inside start())
+        self._executor = None
+        # thread-safe queue for passing start/done events from workers to scheduler
+        self._events = queue.Queue()
+        # wall-clock start time (UTC seconds)
+        self._started_wall = 0.0
+        # wall-clock finish time (UTC seconds)
+        self._finished_wall = 0.0
+        # monotonic clock start time (for precise duration measurement)
+        self._started_mono = 0.0
+        # monotonic clock finish time (for precise duration measurement)
+        self._finished_mono = 0.0
+        # list of task names that have run (in order of completion)
+        self._ran = []
+        # task name → result details (ok, error_type, error)
+        self._results = {}
+        # list of task names that failed
+        self._failed = []
+        # user callback fired when a task is about to start
+        self._on_task_start = None
+        # user callback fired when a task is running on thread
+        self._on_task_run = None
+        # user callback fired when a task completes
+        self._on_task_done = None
+        # user callback fired when the scheduler begins execution
+        self._on_scheduler_start = None
+        # user callback fired when the scheduler finishes all tasks
+        self._on_scheduler_done = None
+        self._prefix = 'thread'
+        if setup_logging:
+            configure_logging(workers, prefix=self._prefix, add_stream_handler=add_stream_handler)
+
+    def register(self, obj, name, after=None):
+        """ register a callable for execution, optionally dependent on other tasks
+        """
+        if not callable(obj):
+            raise ValueError('object must be callable')
+        self._dagraph.add(name, after=after)
+        self._run_map[name] = obj
+
+    def dregister(self, after=None):
+        """ decorator form of register() for convenient inline task definition
+        """
+        def decorator(function):
+            @wraps(function)
+            def wrapper(*args, **kwargs):
+                return function(*args, **kwargs)
+            # register at decoration time so start() can discover it
+            self.register(wrapper, function.__name__, after=after)
+            # keep a pointer to the original
+            wrapper.__original__ = function
+            return wrapper
+        return decorator
+
+    def _handle_event(self):
+        """ process queued task and scheduler events on the scheduler thread
+        """
+        logger = logging.getLogger(threading.current_thread().name)
+        while True:
+            try:
+                kind, payload = self._events.get_nowait()
+            except queue.Empty:
+                break
+
+            if kind == 'start':
+                name = payload
+                self._callback(self._on_task_start, name)
+
+            elif kind == 'run':
+                name, thread = payload
+                self._callback(self._on_task_run, name, thread)
+
+            elif kind == 'done':
+                name, ok, error_type, error = payload
+                logger.debug(f'removing {name!r} from active futures')
+                self._active.discard(name)
+                self._dagraph.remove(name)
+
+                self._ran.append(name)
+                self._results[name] = {
+                    'ok': ok,
+                    'error_type': error_type,
+                    'error': error
+                }
+                if not ok:
+                    self._failed.append(name)
+
+                self._callback(self._on_task_done, name, ok)
+                # schedule next candidate
+                free = max(0, self._workers - len(self._active))
+                if free:
+                    # keep pool full after dependency 'burst' - several tasks unblock at once
+                    for cand in self._dagraph.get_candidates(self._active, free):
+                        self._submit(cand)
+                if self._dagraph.is_empty() and not self._active:
+                    logger.debug(
+                        'nothing more to run and no active futures remain - signaling all done')
+                    self._completed.set()
+
+    def _build_summary(self):
+        """ assemble concise run summary from collected results and timings
+        """
+        ran = list(self._ran)
+        passed = [name for name, result in self._results.items() if result["ok"]]
+        failed = list(self._failed)
+        failures = {
+            name: {
+                'error_type': self._results[name]['error_type'],
+                'error': self._results[name]['error']
+            } for name in failed
+        }
+        failure_counts = Counter(
+            result['error_type'] for result in self._results.values() if not result['ok']
+        )
+        return {
+            'ran': ran,
+            'passed': passed,
+            'failed': failed,
+            'failures': failures,
+            'failure_counts': dict(failure_counts),
+            'started_at': self._started_wall,
+            'finished_at': self._finished_wall,
+            'duration': self._finished_mono - self._started_mono
+        }
+
+    def _handle_interrupt(self, logger):
+        """ cancel in-flight work, drain events, and mark remaining tasks as cancelled
+        """
+        logger.error('interrupt received; cancelling remaining tasks')
+
+        # cancel all futures we still track
+        with self._lock:
+            futures = list(self._futures.keys())
+        for future in futures:
+            try:
+                future.cancel()
+            except (CancelledError, RuntimeError) as exception:
+                logger.debug(f'cancel() ignored for completed future: {exception}')
+
+        # drain anything already completed and queued
+        self._handle_event()
+
+        # mark any still-active tasks as cancelled (these never emitted a 'done' event)
+        still_active = list(self._active)
+        self._active.clear()
+        for name in still_active:
+            # remove from graph so completion logic won't wait on them
+            self._dagraph.remove(name)
+            # record cancellation
+            self._ran.append(name)
+            self._results[name] = {
+                'ok': False,
+                'error_type': 'CancelledError',
+                'error': 'cancelled'
+            }
+            self._failed.append(name)
+
+        # signal completion so the loop (if resumed) would exit
+        self._completed.set()
+
+    def start(self):
+        """ run all registered tasks respecting dependencies, collect results, and trigger callbacks
+        """
+        logger = logging.getLogger(threading.current_thread().name)
+        self._ran.clear()
+        self._results.clear()
+        self._failed.clear()
+        self._completed.clear()
+        self._futures.clear()
+
+        # drain any stale events
+        try:
+            while True:
+                self._events.get_nowait()
+        except queue.Empty:
+            pass
+
+        self._started_wall = time.time()
+        self._started_mono = time.perf_counter()
+        meta = {
+            'total_tasks': len(self._run_map),
+            'workers': self._workers,
+            'started_at': self._started_wall
+        }
+        self._callback(self._on_scheduler_start, meta)
+
+        try:
+            with ThreadPoolExecutor(max_workers=self._workers,
+                                    thread_name_prefix=self._prefix) as executor:
+                self._executor = executor
+                logger.info(f'starting thread pool with {self._workers} threads')
+                # initial seeding
+                for name in self._dagraph.get_candidates(self._active, self._workers):
+                    self._submit(name)
+
+                # main loop of scheduler thread
+                while not self._completed.wait(timeout=0.1):
+                    self._handle_event()
+
+                # final drain
+                self._handle_event()
+                logger.info('all work completed')
+
+        except KeyboardInterrupt:
+            self._handle_interrupt(logger)
+
+        finally:
+            self._finished_wall = time.time()
+            self._finished_mono = time.perf_counter()
+            duration = self._finished_mono - self._started_mono
+            logger.info(f'duration: {duration:.2f}s')
+            summary = self._build_summary()
+            self._callback(self._on_scheduler_done, summary)
+            return summary
+
+    def _submit(self, name):
+        """ submit a ready task to the thread pool and queue its start event
+        """
+        logger = logging.getLogger(threading.current_thread().name)
+        logger.debug(f'submitting {name!r} to thread pool')
+
+        self._events.put(('start', name))
+
+        future = self._executor.submit(self._run, name)
+        logger.debug(f'adding {name} to active futures')
+        self._active.add(name)
+        with self._lock:
+            # track future to name
+            self._futures[future] = name
+        future.add_done_callback(self._done)
+
+    def _done(self, future):
+        """ enqueue a 'done' event for a finished Future
+            safely extracts the task result or synthesizes a failure if the Future raised
+        """
+        try:
+            payload = future.result()
+        except Exception as exception:
+            # worker failed before building payload - recover name and emit synthetic failure
+            name = self._futures.get(future, '<unknown>')
+            payload = (name, False, type(exception).__name__, str(exception))
+        finally:
+            # cleanup no matter what
+            with self._lock:
+                self._futures.pop(future, '<unknown>')
+        self._events.put(('done', payload))
+
+    def _run(self, name):
+        """ execute a task callable, capture errors, and return its result tuple
+        """
+        thread = threading.current_thread().name
+        logger = logging.getLogger(thread)
+        payload = (name, thread)
+        self._events.put(('run', payload))
+        logger.debug(f'run {name!r}')
+        ok = True
+        error_type = None
+        error = None
+        try:
+            self._run_map[name]()
+        except Exception as exception:
+            ok = False
+            error_type = type(exception).__name__
+            error = str(exception)
+            logger.error(f'{name!r} failed: {error_type}: {error}')
+        return (name, ok, error_type, error)
+
+    def _callback(self, callback, *args):
+        """ safely invoke a user callback, logging any exceptions raised
+        """
+        if not callback:
+            return
+        logger = logging.getLogger(threading.current_thread().name)
+        try:
+            if isinstance(callback, tuple):
+                function, user_args, user_kwargs = callback
+                function(*args, *user_args, **user_kwargs)
+            else:
+                callback(*args)
+        except Exception:
+            callback_name = getattr(callback, '__name__', callback)
+            logger.debug(f'callback {callback_name!r} failed', exc_info=True)
+
+    def on_task_start(self, function, *args, **kwargs):
+        """ register callback fired when a task is about to start
+        """
+        self._on_task_start = (function, args, kwargs)
+
+    def on_task_run(self, function, *args, **kwargs):
+        """ register callback fired when a task is running on thread
+        """
+        self._on_task_run = (function, args, kwargs)
+
+    def on_task_done(self, function, *args, **kwargs):
+        """ register callback fired when a task finishes execution
+        """
+        self._on_task_done = (function, args, kwargs)
+
+    def on_scheduler_start(self, function, *args, **kwargs):
+        """ register callback fired when the scheduler begins execution
+        """
+        self._on_scheduler_start = (function, args, kwargs)
+
+    def on_scheduler_done(self, function, *args, **kwargs):
+        """ register callback fired when the scheduler completes all tasks
+        """
+        self._on_scheduler_done = (function, args, kwargs)

threaded_order-1.3.1/threaded_order.egg-info/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: threaded-order
+Version: 1.3.1
+Summary: A lightweight framework for running functions concurrently across multiple threads while maintaining a defined execution order.
+Author-email: Emilio Reyes <soda480@gmail.com>
+Project-URL: Homepage, https://github.com/soda480/threaded-order
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mock; extra == "dev"
+Requires-Dist: radon; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: coverage-badge; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+[![ci](https://github.com/soda480/threaded-order/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/soda480/threaded-order/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/threaded-order.svg)](https://badge.fury.io/py/threaded-order)
+
+# 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
+
+![graph](https://github.com/soda480/threaded-order/blob/main/docs/images/graph.png?raw=true)
+
+```Python
+from threaded_order import Scheduler, ThreadProxyLogger
+import time
+import random
+
+s = Scheduler(workers=3, setup_logging=True)
+logger = ThreadProxyLogger()
+
+def run(name):
+    time.sleep(random.uniform(.5, 3.5))
+    logger.info(f'{name} completed')
+
+@s.dregister()
+def a(): run('a')
+
+@s.dregister(after=['a'])
+def b(): run('b')
+
+@s.dregister(after=['a'])
+def c(): run('c')
+
+@s.dregister(after=['c'])
+def d(): run('d')
+
+@s.dregister(after=['c'])
+def e(): run('e')
+
+@s.dregister(after=['b', 'd'])
+def f(): run('f')
+
+if __name__ == '__main__':
+    s.on_scheduler_done(lambda s: print(f"Passed:{len(s['passed'])} Failed:{len(s['failed'])}"))
+    s.start()
+```
+
+![example4](https://github.com/soda480/threaded-order/blob/main/docs/images/example4.gif?raw=true)
+
+### ProgressBar Integration Example
+
+Can be done by using the `on_task_done` callback. See [example5](https://github.com/soda480/threaded-order/blob/main/examples/example5.py)
+
+![example5](https://github.com/soda480/threaded-order/blob/main/docs/images/example5.gif?raw=true)
+
+
+See examples in examples folder. To run examples, follow instructions below to build and run the Docker container then execute:
+
+## API Overview
+`class Scheduler(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:
+```sh
+docker image build \
+-t threaded-order:latest .
+```
+
+Run the Docker container:
+```sh
+docker container run \
+--rm \
+-it \
+-v $PWD:/code \
+threaded-order:latest \
+bash
+```
+
+Execute the dev pipeline:
+```sh
+make dev
+```

threaded_order-1.3.1/threaded_order.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+threaded_order/__init__.py
+threaded_order/graph.py
+threaded_order/logger.py
+threaded_order/scheduler.py
+threaded_order.egg-info/PKG-INFO
+threaded_order.egg-info/SOURCES.txt
+threaded_order.egg-info/dependency_links.txt
+threaded_order.egg-info/requires.txt
+threaded_order.egg-info/top_level.txt

threaded_order-1.3.1/threaded_order.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

threaded_order-1.3.1/threaded_order.egg-info/requires.txt

@@ -0,0 +1,10 @@
+
+[dev]
+build
+flake8
+mock
+radon
+bandit
+coverage
+coverage-badge
+twine

threaded_order-1.3.1/threaded_order.egg-info/top_level.txt

@@ -0,0 +1 @@
+threaded_order