threading :: Thread :: Class Thread
[hide private]
[frames] | no frames]

Class Thread

source code

object --+    
         |    
  _Verbose --+
             |
            Thread
Known Subclasses:

A class that represents a thread of control.

This class can be safely subclassed in a limited fashion.

Instance Methods [hide private]
(type, value, traceback)
__exc_info()
Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.
None
__exc_clear()
Clear global information on the current exception.
 
__init__(self, group=None, target=None, name=None, args=(), kwargs=None, verbose=None)
This constructor should always be called with keyword arguments.
source code
 
_reset_internal_locks(self) source code
 
_set_daemon(self) source code
 
__repr__(self)
repr(x)
source code
 
start(self)
Start the thread's activity.
source code
 
run(self)
Method representing the thread's activity.
source code
 
__bootstrap(self) source code
 
_set_ident(self) source code
 
__bootstrap_inner(self) source code
 
__stop(self) source code
 
__delete(self)
Remove current thread from the dict of currently running threads.
source code
 
join(self, timeout=None)
Wait until the thread terminates.
source code
 
isAlive(self)
Return whether the thread is alive.
source code
 
is_alive(self)
Return whether the thread is alive.
source code
 
isDaemon(self) source code
 
setDaemon(self, daemonic) source code
 
getName(self) source code
 
setName(self, name) source code

Inherited from _Verbose (private): _note

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  __initialized = False
Properties [hide private]
  _block
  name
A string used for identification purposes only.
  ident
Thread identifier of this thread or None if it has not been started.
  daemon
A boolean value indicating whether this thread is a daemon thread (True) or not (False).

Inherited from object: __class__

Method Details [hide private]

__exc_clear()

 

Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

Returns: None

__init__(self, group=None, target=None, name=None, args=(), kwargs=None, verbose=None)
(Constructor)

source code 

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.

Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)

start(self)

source code 

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.

run(self)

source code 

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.

join(self, timeout=None)

source code 

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

isAlive(self)

source code 

Return whether the thread is alive.

This method returns True just before the run() method starts until just after the run() method terminates. The module function enumerate() returns a list of all alive threads.

is_alive(self)

source code 

Return whether the thread is alive.

This method returns True just before the run() method starts until just after the run() method terminates. The module function enumerate() returns a list of all alive threads.


Property Details [hide private]

_block

Get Method:
unreachable._block(self)

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.

Get Method:
unreachable.name(self) - A string used for identification purposes only.
Set Method:
unreachable.name(self, name)

ident

Thread identifier of this thread or None if it has not been started.

This is a nonzero integer. See the thread.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.

Get Method:
unreachable.ident(self) - Thread identifier of this thread or None if it has not been started.

daemon

A boolean value indicating whether this thread is a daemon thread (True) or not (False).

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 no alive non-daemon threads are left.

Get Method:
unreachable.daemon(self) - A boolean value indicating whether this thread is a daemon thread (True) or not (False).
Set Method:
unreachable.daemon(self, daemonic)