Thread (version 0.0.1)
index
Thread.html

This package implements tools to build python package and tools.
 
>>> from time import sleep
>>> def sleep_and_print(time=2, text="end"): sleep(time) or print(text)
...
>>> SimpleThread(sleep_and_print, 3, text="Hello World")
>>> @threadify
... def sleep_and_print(time=2, text="end"): sleep(time) or print(text)
...
>>> sleep_and_print()
>>> join_all()
end
Hello World
>>>

 
Classes
       
threading.Thread(builtins.object)
SimpleThread

 
class SimpleThread(threading.Thread)
    SimpleThread(function: collections.abc.Callable, *args, **kwargs)
 
This class implements a simple Thread calls.
 
 
Method resolution order:
SimpleThread
threading.Thread
builtins.object

Methods defined here:
__init__(self, function: collections.abc.Callable, *args, **kwargs)
This constructor should always be called with keyword arguments. Arguments are:
 
*group* should be None; reserved for future extension when a ThreadGroup
class is implemented.
 
*target* is the callable object to be invoked by the run()
method. Defaults to None, meaning nothing is called.
 
*name* is the thread name. By default, a unique name is constructed of
the form "Thread-N" where N is a small decimal number.
 
*args* is the argument tuple for the target invocation. Defaults to ().
 
*kwargs* is a dictionary of keyword arguments for the target
invocation. Defaults to {}.
 
If a subclass overrides the constructor, it must make sure to invoke
the base class constructor (Thread.__init__()) before doing anything
else to the thread.

Methods inherited from threading.Thread:
__repr__(self)
Return repr(self).
getName(self)
Return a string used for identification purposes only.
 
This method is deprecated, use the name attribute instead.
isDaemon(self)
Return whether this thread is a daemon.
 
This method is deprecated, use the daemon attribute instead.
is_alive(self)
Return whether the thread is alive.
 
This method returns True just before the run() method starts until just
after the run() method terminates. See also the module function
enumerate().
join(self, timeout=None)
Wait until the thread terminates.
 
This blocks the calling thread until the thread whose join() method is
called terminates -- either normally or through an unhandled exception
or until the optional timeout occurs.
 
When the timeout argument is present and not None, it should be a
floating point number specifying a timeout for the operation in seconds
(or fractions thereof). As join() always returns None, you must call
is_alive() after join() to decide whether a timeout happened -- if the
thread is still alive, the join() call timed out.
 
When the timeout argument is not present or None, the operation will
block until the thread terminates.
 
A thread can be join()ed many times.
 
join() raises a RuntimeError if an attempt is made to join the current
thread as that would cause a deadlock. It is also an error to join() a
thread before it has been started and attempts to do so raises the same
exception.
run(self)
Method representing the thread's activity.
 
You may override this method in a subclass. The standard run() method
invokes the callable object passed to the object's constructor as the
target argument, if any, with sequential and keyword arguments taken
from the args and kwargs arguments, respectively.
setDaemon(self, daemonic)
Set whether this thread is a daemon.
 
This method is deprecated, use the .daemon property instead.
setName(self, name)
Set the name string for this thread.
 
This method is deprecated, use the name attribute instead.
start(self)
Start the thread's activity.
 
It must be called at most once per thread object. It arranges for the
object's run() method to be invoked in a separate thread of control.
 
This method will raise a RuntimeError if called more than once on the
same thread object.

Readonly properties inherited from threading.Thread:
ident
Thread identifier of this thread or None if it has not been started.
 
This is a nonzero integer. See the get_ident() function. Thread
identifiers may be recycled when a thread exits and another thread is
created. The identifier is available even after the thread has exited.
native_id
Native integral thread ID of this thread, or None if it has not been started.
 
This is a non-negative integer. See the get_native_id() function.
This represents the Thread ID as reported by the kernel.

Data descriptors inherited from threading.Thread:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
daemon
A boolean value indicating whether this thread is a daemon thread.
 
This must be set before start() is called, otherwise RuntimeError is
raised. Its initial value is inherited from the creating thread; the
main thread is not a daemon thread and therefore all threads created in
the main thread default to daemon = False.
 
The entire Python program exits when only daemon threads are left.
name
A string used for identification purposes only.
 
It has no semantics. Multiple threads may be given the same name. The
initial name is set by the constructor.

 
Functions
       
join_all()
This function get all threads and join it.
 
The current thread and the main thread are exclude.
threadify(function: collections.abc.Callable) -> collections.abc.Callable
This decorator implements a simple way to
call a function in a new thread.

 
Data
        __all__ = ['SimpleThread', 'threadify', 'join_all']
__author_email__ = 'mauricelambert434@gmail.com'
__copyright__ = '\nPythonToolsKit Copyright (C) 2022 Maurice Lam...ome to redistribute it\nunder certain conditions.\n'
__description__ = '\nThis package implements tools to build python package and tools.\n'
__license__ = 'GPL-3.0 License'
__maintainer__ = 'Maurice Lambert'
__maintainer_email__ = 'mauricelambert434@gmail.com'
__url__ = 'https://github.com/mauricelambert/PythonToolsKit'

 
Author
        Maurice Lambert