navigate.controller.thread_pool.SelfLockThread

class navigate.controller.thread_pool.SelfLockThread(group=None, target=None, name=None, args=(), kwargs={}, *, daemon=None)

Bases: Thread

A custom thread class with self-locking capabilities.

This class extends the functionality of the Python threading.Thread class by providing the ability to lock and unlock the thread explicitly. It is useful in scenarios where thread synchronization and control are required.

Note

• This class provides additional control over thread execution using the wait() and unlock() methods.

• It allows checking whether the thread is currently locked using the isLocked() method.

__init__(group=None, target=None, name=None, args=(), kwargs={}, *, daemon=None)

Initialize the SelfLockThread.

Parameters:

• group (ThreadGroup, optional) – The thread group, by default None

• target (callable, optional) – The target function of the thread, by default None

• name (str, optional) – The name of the thread, by default None

• args (tuple, optional) – The arguments of the target function, by default ()

• kwargs (dict, optional) – The keyword arguments of the target function, by default {}

• daemon (bool, optional) – Whether the thread is daemon, by default None

Methods

__init__([group, target, name, args, ...])	Initialize the SelfLockThread.
getName()	Return a string used for identification purposes only.
isDaemon()	Return whether this thread is a daemon.
isLocked()	Check if the thread is locked.
is_alive()	Return whether the thread is alive.
join([timeout])	Wait until the thread terminates.
run()	Run the thread.
setDaemon(daemonic)	Set whether this thread is a daemon.
setName(name)	Set the name string for this thread.
start()	Start the thread's activity.
unlock()	Unlock the thread.
wait()	Wait for the thread to finish.

Attributes

daemon	A boolean value indicating whether this thread is a daemon thread.
ident	Thread identifier of this thread or None if it has not been started.
name	A string used for identification purposes only.
native_id	Native integral thread ID of this thread, or None if it has not been started.
selfLock	The lock of the thread.

getName()

Return a string used for identification purposes only.

This method is deprecated, use the name attribute instead.

isDaemon()

Return whether this thread is a daemon.

This method is deprecated, use the daemon attribute instead.

isLocked()

Check if the thread is locked.

Returns:

Whether the thread is locked.

Return type:

bool

is_alive()

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(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()

Run the thread.

setDaemon(daemonic)

Set whether this thread is a daemon.

This method is deprecated, use the .daemon property instead.

setName(name)

Set the name string for this thread.

This method is deprecated, use the name attribute instead.

start()

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.

unlock()

Unlock the thread.

wait()

Wait for the thread to finish.

property 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.

property 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.

property 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.

property 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.

selfLock

The lock of the thread.

Type:

threading.Lock