A class that represents thread-local data.
For more details and extensive examples, see the documentation string of the
- :mod:`_threading_local` module: :source:`Lib/_threading_local.py`.
+ :mod:`!_threading_local` module: :source:`Lib/_threading_local.py`.
.. _thread-objects:
callable object to the constructor, or by overriding the :meth:`~Thread.run`
method in a subclass. No other methods (except for the constructor) should be
overridden in a subclass. In other words, *only* override the
-:meth:`~Thread.__init__` and :meth:`~Thread.run` methods of this class.
+``__init__()`` and :meth:`~Thread.run` methods of this class.
Once a thread object is created, its activity must be started by calling the
thread's :meth:`~Thread.start` method. This invokes the :meth:`~Thread.run`
are:
*group* should be ``None``; reserved for future extension when a
- :class:`ThreadGroup` class is implemented.
+ :class:`!ThreadGroup` class is implemented.
*target* is the callable object to be invoked by the :meth:`run` method.
Defaults to ``None``, meaning nothing is called.
of time has passed --- a timer. :class:`Timer` is a subclass of :class:`Thread`
and as such also functions as an example of creating custom threads.
-Timers are started, as with threads, by calling their :meth:`~Timer.start`
+Timers are started, as with threads, by calling their :meth:`Timer.start <Thread.start>`
method. The timer can be stopped (before its action has begun) by calling the
:meth:`~Timer.cancel` method. The interval the timer will wait before
executing its action may not be exactly the same as the interval specified by
Using locks, conditions, and semaphores in the :keyword:`!with` statement
-------------------------------------------------------------------------
-All of the objects provided by this module that have :meth:`acquire` and
-:meth:`release` methods can be used as context managers for a :keyword:`with`
-statement. The :meth:`acquire` method will be called when the block is
-entered, and :meth:`release` will be called when the block is exited. Hence,
+All of the objects provided by this module that have ``acquire`` and
+``release`` methods can be used as context managers for a :keyword:`with`
+statement. The ``acquire`` method will be called when the block is
+entered, and ``release`` will be called when the block is exited. Hence,
the following snippet::
with some_lock: