Merged revisions 64125 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r64125 | benjamin.peterson | 2008-06-11 12:27:50 -0500 (Wed, 11 Jun 2008) | 2 lines
give the threading API PEP 8 names
........
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
index 22c174b..f37c73b 100644
--- a/Doc/library/threading.rst
+++ b/Doc/library/threading.rst
@@ -15,7 +15,7 @@
This module defines the following functions and objects:
-.. function:: activeCount()
+.. function:: active_count()
Return the number of :class:`Thread` objects currently alive. The returned
count is equal to the length of the list returned by :func:`enumerate`.
@@ -29,7 +29,7 @@
thread.
-.. function:: currentThread()
+.. function:: current_thread()
Return the current :class:`Thread` object, corresponding to the caller's thread
of control. If the caller's thread of control was not created through the
@@ -39,10 +39,10 @@
.. function:: enumerate()
- Return a list of all :class:`Thread` objects currently alive. The list includes
- daemonic threads, dummy thread objects created by :func:`currentThread`, and the
- main thread. It excludes terminated threads and threads that have not yet been
- started.
+ Return a list of all :class:`Thread` objects currently alive. The list
+ includes daemonic threads, dummy thread objects created by
+ :func:`current_thread`, and the main thread. It excludes terminated threads
+ and threads that have not yet been started.
.. function:: Event()
@@ -387,7 +387,7 @@
lock, its caller should.
-.. method:: Condition.notifyAll()
+.. method:: Condition.notify_all()
Wake up all threads waiting on this condition. This method acts like
:meth:`notify`, but wakes up all waiting threads instead of one. If the calling
@@ -544,12 +544,12 @@
thread until the thread whose :meth:`join` method is called is terminated.
A thread has a name. The name can be passed to the constructor, set with the
-:meth:`setName` method, and retrieved with the :meth:`getName` method.
+:meth:`set_name` method, and retrieved with the :meth:`get_name` method.
A thread can be flagged as a "daemon thread". The significance of this flag is
that the entire Python program exits when only daemon threads are left. The
initial value is inherited from the creating thread. The flag can be set with
-the :meth:`setDaemon` method and retrieved with the :meth:`isDaemon` method.
+the :meth:`set_daemon` method and retrieved with the :meth:`is_daemon` method.
There is a "main thread" object; this corresponds to the initial thread of
control in the Python program. It is not a daemon thread.
@@ -629,12 +629,12 @@
raises the same exception.
-.. method:: Thread.getName()
+.. method:: Thread.get_name()
Return the thread's name.
-.. method:: Thread.setName(name)
+.. method:: Thread.set_name(name)
Set the thread's name.
@@ -643,18 +643,16 @@
constructor.
-.. method:: Thread.getIdent()
+.. method:: Thread.get_ident()
Return the 'thread identifier' of this thread or None if the thread has not
- been started. This is a nonzero integer. See the :mod:`thread` module's
- :func:`get_ident()` function. Thread identifiers may be recycled when a
- thread exits and another thread is created. The identifier is returned
- even after the thread has exited.
-
- .. versionadded:: 2.6
+ been started. This is a nonzero integer. See the :func:`thread.get_ident()`
+ function. Thread identifiers may be recycled when a thread exits and another
+ thread is created. The identifier is returned even after the thread has
+ exited.
-.. method:: Thread.isAlive()
+.. method:: Thread.is_alive()
Return whether the thread is alive.
@@ -663,12 +661,12 @@
returns a list of all alive threads.
-.. method:: Thread.isDaemon()
+.. method:: Thread.is_daemon()
Return the thread's daemon flag.
-.. method:: Thread.setDaemon(daemonic)
+.. method:: Thread.set_daemon(daemonic)
Set the thread's daemon flag to the Boolean value *daemonic*. This must be
called before :meth:`start` is called, otherwise :exc:`RuntimeError` is raised.