threaded

Decorators for running functions in Thread/ThreadPool/IOLoop

These details have not been verified by PyPI

Project links

Project description

threaded

https://coveralls.io/repos/github/python-useful-helpers/threaded/badge.svg?branch=master

https://img.shields.io/pypi/v/threaded.svg

https://img.shields.io/pypi/pyversions/threaded.svg

https://img.shields.io/pypi/status/threaded.svg

https://img.shields.io/github/license/python-useful-helpers/threaded.svg

https://img.shields.io/badge/code%20style-black-000000.svg

threaded is a set of decorators, which wrap functions in:

concurrent.futures.ThreadPool

threading.Thread

asyncio.Task in Python 3.

Why? Because copy-paste of loop.create_task, threading.Thread and thread_pool.submit is boring, especially if target functions is used by this way only.

Pros:

Free software: Apache license
Open Source: https://github.com/python-useful-helpers/threaded
PyPI packaged: https://pypi-hypernode.com/pypi/threaded
Tested: see bages on top
Support multiple Python versions:

Python 3.4
Python 3.5
Python 3.6
Python 3.7
PyPy3 3.5+

Decorators:

ThreadPooled - native concurrent.futures.ThreadPool.
threadpooled is alias for ThreadPooled.
Threaded - wrap in threading.Thread.
threaded is alias for Threaded.
AsyncIOTask - wrap in asyncio.Task. Uses the same API, as ThreadPooled.
asynciotask is alias for AsyncIOTask.

Usage

ThreadPooled

Mostly it is required decorator: submit function to ThreadPoolExecutor on call.

threaded.ThreadPooled.configure(max_workers=3)

@threaded.ThreadPooled
def func():
    pass

concurrent.futures.wait([func()])

Python 3.5+ usage with asyncio:

loop = asyncio.get_event_loop()
@threaded.ThreadPooled(loop_getter=loop, loop_getter_need_context=False)
def func():
    pass

loop.run_until_complete(asyncio.wait_for(func(), timeout))

Python 3.5+ usage with asyncio and loop extraction from call arguments:

loop_getter = lambda tgt_loop: tgt_loop
@threaded.ThreadPooled(loop_getter=loop_getter, loop_getter_need_context=True)  # loop_getter_need_context is required
def func(*args, **kwargs):
    pass

loop = asyncio.get_event_loop()
loop.run_until_complete(asyncio.wait_for(func(loop), timeout))

During application shutdown, pool can be stopped (while it will be recreated automatically, if some component will request).

threaded.ThreadPooled.shutdown()

Threaded

Classic threading.Thread. Useful for running until close and self-closing threads without return.

Usage example:

@threaded.Threaded
def func(*args, **kwargs):
    pass

thread = func()
thread.start()
thread.join()

Without arguments, thread name will use pattern: 'Threaded: ' + func.__name__

Override name can be don via corresponding argument:

@threaded.Threaded(name='Function in thread')
def func(*args, **kwargs):
    pass

Thread can be daemonized automatically:

@threaded.Threaded(daemon=True)
def func(*args, **kwargs):
    pass

Also, if no any addition manipulations expected before thread start, it can be started automatically before return:

@threaded.Threaded(started=True)
def func(*args, **kwargs):
    pass

AsyncIOTask

Wrap in asyncio.Task.

usage with asyncio:

@threaded.AsyncIOTask
def func():
    pass

loop = asyncio.get_event_loop()
loop.run_until_complete(asyncio.wait_for(func(), timeout))

Provide event loop directly:

loop = asyncio.get_event_loop()
@threaded.AsyncIOTask(loop_getter=loop)
def func():
    pass

loop.run_until_complete(asyncio.wait_for(func(), timeout))

Usage with loop extraction from call arguments:

loop_getter = lambda tgt_loop: tgt_loop
@threaded.AsyncIOTask(loop_getter=loop_getter, loop_getter_need_context=True)
def func(*args, **kwargs):
    pass

loop = asyncio.get_event_loop()
loop.run_until_complete(asyncio.wait_for(func(loop), timeout))

Testing

The main test mechanism for the package threaded is using tox. Available environments can be collected via tox -l

CI systems

For code checking several CI systems is used in parallel:

Travis CI: is used for checking: PEP8, pylint, bandit, installation possibility and unit tests. Also it’s publishes coverage on coveralls.
GitHub actions: is used for checking: PEP8, pylint, bandit, installation possibility and unit tests.
coveralls: is used for coverage display.

CD system

Travis CI: is used for package delivery on PyPI.

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

4.2.0

Nov 22, 2023

This version

4.1.0

Nov 17, 2020

4.0.9.post0

Nov 16, 2020

4.0.9

Nov 16, 2020

4.0.8

Nov 7, 2019

4.0.5

Oct 18, 2019

4.0.4

Oct 16, 2019

4.0.3

Apr 16, 2019

4.0.1

Feb 18, 2019

4.0.0

Jan 2, 2019

3.0.3

Apr 29, 2019

3.0.2

Feb 18, 2019

3.0.1

Jan 2, 2019

3.0.0

Dec 6, 2018

2.1.1

Nov 21, 2018

2.0.3

Sep 21, 2018

2.0.2

Sep 5, 2018

2.0.1

Aug 9, 2018

2.0.0

Aug 8, 2018

1.1.3

Apr 29, 2019

1.1.2

Feb 18, 2019

1.1.1

Jan 28, 2019

1.1.0

Jan 28, 2019

1.0.7

Sep 5, 2018

1.0.6

Jul 18, 2018

1.0.5

Jul 4, 2018

1.0.4

Jun 8, 2018

1.0.3

May 24, 2018

1.0.2

May 1, 2018

1.0.0

Mar 23, 2018

0.9.1

Mar 19, 2018

0.9.0

Mar 16, 2018

0.8.0

Sep 6, 2017

0.7.0

Sep 5, 2017

0.6.0

Sep 4, 2017

0.5.0

Sep 2, 2017

0.4.1

Sep 1, 2017

0.4.0

Sep 1, 2017

0.3.1

Aug 30, 2017

Download files

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

Source Distribution

threaded-4.1.0.tar.gz (28.1 kB view details)

Uploaded Nov 17, 2020 Source

Built Distributions

threaded-4.1.0-py3-none-any.whl (17.9 kB view details)

Uploaded Nov 17, 2020 Python 3

threaded-4.1.0-cp39-cp39-win_amd64.whl (190.3 kB view details)

Uploaded Nov 17, 2020 CPython 3.9 Windows x86-64

threaded-4.1.0-cp39-cp39-win32.whl (167.2 kB view details)

Uploaded Nov 17, 2020 CPython 3.9 Windows x86

threaded-4.1.0-cp39-cp39-manylinux2014_x86_64.whl (862.5 kB view details)

Uploaded Nov 17, 2020 CPython 3.9

threaded-4.1.0-cp39-cp39-manylinux2014_i686.whl (825.4 kB view details)

Uploaded Nov 17, 2020 CPython 3.9

threaded-4.1.0-cp39-cp39-manylinux2014_aarch64.whl (863.7 kB view details)

Uploaded Nov 17, 2020 CPython 3.9

threaded-4.1.0-cp39-cp39-manylinux2010_x86_64.whl (869.1 kB view details)

Uploaded Nov 17, 2020 CPython 3.9 manylinux: glibc 2.12+ x86-64

threaded-4.1.0-cp39-cp39-manylinux2010_i686.whl (833.7 kB view details)

Uploaded Nov 17, 2020 CPython 3.9 manylinux: glibc 2.12+ i686

threaded-4.1.0-cp39-cp39-manylinux1_x86_64.whl (869.1 kB view details)

Uploaded Nov 17, 2020 CPython 3.9

threaded-4.1.0-cp39-cp39-manylinux1_i686.whl (825.4 kB view details)

Uploaded Nov 17, 2020 CPython 3.9

threaded-4.1.0-cp38-cp38-win_amd64.whl (191.5 kB view details)

Uploaded Nov 17, 2020 CPython 3.8 Windows x86-64

threaded-4.1.0-cp38-cp38-win32.whl (168.9 kB view details)

Uploaded Nov 17, 2020 CPython 3.8 Windows x86

threaded-4.1.0-cp38-cp38-manylinux2014_x86_64.whl (961.2 kB view details)