Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 257060a

Browse files
committed
change references to Queue module to queue in multiprocessing docs
1 parent 5289b2b commit 257060a

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

Doc/library/multiprocessing.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ processes:
5050

5151
**Queues**
5252

53-
The :class:`Queue` class is a near clone of :class:`Queue.Queue`. For
53+
The :class:`Queue` class is a near clone of :class:`queue.Queue`. For
5454
example::
5555

5656
from multiprocessing import Process, Queue
@@ -414,10 +414,10 @@ For passing messages one can use :func:`Pipe` (for a connection between two
414414
processes) or a queue (which allows multiple producers and consumers).
415415

416416
The :class:`Queue` and :class:`JoinableQueue` types are multi-producer,
417-
multi-consumer FIFO queues modelled on the :class:`Queue.Queue` class in the
417+
multi-consumer FIFO queues modelled on the :class:`queue.Queue` class in the
418418
standard library. They differ in that :class:`Queue` lacks the
419-
:meth:`~Queue.Queue.task_done` and :meth:`~Queue.Queue.join` methods introduced
420-
into Python 2.5's :class:`Queue.Queue` class.
419+
:meth:`~queue.Queue.task_done` and :meth:`~queue.Queue.join` methods introduced
420+
into Python 2.5's :class:`queue.Queue` class.
421421

422422
If you use :class:`JoinableQueue` then you **must** call
423423
:meth:`JoinableQueue.task_done` for each task removed from the queue or else the
@@ -429,10 +429,10 @@ Note that one can also create a shared queue by using a manager object -- see
429429

430430
.. note::
431431

432-
:mod:`multiprocessing` uses the usual :exc:`Queue.Empty` and
433-
:exc:`Queue.Full` exceptions to signal a timeout. They are not available in
432+
:mod:`multiprocessing` uses the usual :exc:`queue.Empty` and
433+
:exc:`queue.Full` exceptions to signal a timeout. They are not available in
434434
the :mod:`multiprocessing` namespace so you need to import them from
435-
:mod:`Queue`.
435+
:mod:`queue`.
436436

437437

438438
.. warning::
@@ -477,11 +477,11 @@ For an example of the usage of queues for interprocess communication see
477477
locks/semaphores. When a process first puts an item on the queue a feeder
478478
thread is started which transfers objects from a buffer into the pipe.
479479

480-
The usual :exc:`Queue.Empty` and :exc:`Queue.Full` exceptions from the
480+
The usual :exc:`queue.Empty` and :exc:`queue.Full` exceptions from the
481481
standard library's :mod:`Queue` module are raised to signal timeouts.
482482

483-
:class:`Queue` implements all the methods of :class:`Queue.Queue` except for
484-
:meth:`~Queue.Queue.task_done` and :meth:`~Queue.Queue.join`.
483+
:class:`Queue` implements all the methods of :class:`queue.Queue` except for
484+
:meth:`~queue.Queue.task_done` and :meth:`~queue.Queue.join`.
485485

486486
.. method:: qsize()
487487

@@ -506,10 +506,10 @@ For an example of the usage of queues for interprocess communication see
506506
Put item into the queue. If the optional argument *block* is ``True``
507507
(the default) and *timeout* is ``None`` (the default), block if necessary until
508508
a free slot is available. If *timeout* is a positive number, it blocks at
509-
most *timeout* seconds and raises the :exc:`Queue.Full` exception if no
509+
most *timeout* seconds and raises the :exc:`queue.Full` exception if no
510510
free slot was available within that time. Otherwise (*block* is
511511
``False``), put an item on the queue if a free slot is immediately
512-
available, else raise the :exc:`Queue.Full` exception (*timeout* is
512+
available, else raise the :exc:`queue.Full` exception (*timeout* is
513513
ignored in that case).
514514

515515
.. method:: put_nowait(item)
@@ -521,18 +521,18 @@ For an example of the usage of queues for interprocess communication see
521521
Remove and return an item from the queue. If optional args *block* is
522522
``True`` (the default) and *timeout* is ``None`` (the default), block if
523523
necessary until an item is available. If *timeout* is a positive number,
524-
it blocks at most *timeout* seconds and raises the :exc:`Queue.Empty`
524+
it blocks at most *timeout* seconds and raises the :exc:`queue.Empty`
525525
exception if no item was available within that time. Otherwise (block is
526526
``False``), return an item if one is immediately available, else raise the
527-
:exc:`Queue.Empty` exception (*timeout* is ignored in that case).
527+
:exc:`queue.Empty` exception (*timeout* is ignored in that case).
528528

529529
.. method:: get_nowait()
530530
get_no_wait()
531531

532532
Equivalent to ``get(False)``.
533533

534534
:class:`multiprocessing.Queue` has a few additional methods not found in
535-
:class:`Queue.Queue` which are usually unnecessary:
535+
:class:`queue.Queue` which are usually unnecessary:
536536

537537
.. method:: close()
538538

@@ -1176,7 +1176,7 @@ their parent process exits. The manager classes are defined in the
11761176

11771177
.. method:: Queue([maxsize])
11781178

1179-
Create a shared :class:`Queue.Queue` object and return a proxy for it.
1179+
Create a shared :class:`queue.Queue` object and return a proxy for it.
11801180

11811181
.. method:: RLock()
11821182

@@ -1264,8 +1264,8 @@ Running the following commands creates a server for a single shared queue which
12641264
remote clients can access::
12651265

12661266
>>> from multiprocessing.managers import BaseManager
1267-
>>> import Queue
1268-
>>> queue = Queue.Queue()
1267+
>>> import queue
1268+
>>> queue = queue.Queue()
12691269
>>> class QueueManager(BaseManager): pass
12701270
...
12711271
>>> QueueManager.register('getQueue', callable=lambda:queue)

0 commit comments

Comments
 (0)