Make the docstring style consistent.

rhettinger · rhettinger · commit 0c5e52f0bda9 · 2012-01-09T06:17:39.000Z
diff --git a/Lib/queue.py b/Lib/queue.py
@@ -1,4 +1,4 @@
-"""A multi-producer, multi-consumer queue."""
+'''A multi-producer, multi-consumer queue.'''
 
 try:
     import threading
@@ -11,18 +11,19 @@
 __all__ = ['Empty', 'Full', 'Queue', 'PriorityQueue', 'LifoQueue']
 
 class Empty(Exception):
-    "Exception raised by Queue.get(block=0)/get_nowait()."
+    'Exception raised by Queue.get(block=0)/get_nowait().'
     pass
 
 class Full(Exception):
-    "Exception raised by Queue.put(block=0)/put_nowait()."
+    'Exception raised by Queue.put(block=0)/put_nowait().'
     pass
 
 class Queue:
-    """Create a queue object with a given maximum size.
+    '''Create a queue object with a given maximum size.
 
     If maxsize is <= 0, the queue size is infinite.
-    """
+    '''
+
     def __init__(self, maxsize=0):
         self.maxsize = maxsize
         self._init(maxsize)
@@ -47,7 +48,7 @@ def __init__(self, maxsize=0):
         self.unfinished_tasks = 0
 
     def task_done(self):
-        """Indicate that a formerly enqueued task is complete.
+        '''Indicate that a formerly enqueued task is complete.
 
         Used by Queue consumer threads.  For each get() used to fetch a task,
         a subsequent call to task_done() tells the queue that the processing
@@ -59,7 +60,7 @@ def task_done(self):
 
         Raises a ValueError if called more times than there were items
         placed in the queue.
-        """
+        '''
         with self.all_tasks_done:
             unfinished = self.unfinished_tasks - 1
             if unfinished <= 0:
@@ -69,25 +70,25 @@ def task_done(self):
             self.unfinished_tasks = unfinished
 
     def join(self):
-        """Blocks until all items in the Queue have been gotten and processed.
+        '''Blocks until all items in the Queue have been gotten and processed.
 
         The count of unfinished tasks goes up whenever an item is added to the
         queue. The count goes down whenever a consumer thread calls task_done()
         to indicate the item was retrieved and all work on it is complete.
 
         When the count of unfinished tasks drops to zero, join() unblocks.
-        """
+        '''
         with self.all_tasks_done:
             while self.unfinished_tasks:
                 self.all_tasks_done.wait()
 
     def qsize(self):
-        """Return the approximate size of the queue (not reliable!)."""
+        '''Return the approximate size of the queue (not reliable!).'''
         with self.mutex:
             return self._qsize()
 
     def empty(self):
-        """Return True if the queue is empty, False otherwise (not reliable!).
+        '''Return True if the queue is empty, False otherwise (not reliable!).
 
         This method is likely to be removed at some point.  Use qsize() == 0
         as a direct substitute, but be aware that either approach risks a race
@@ -96,25 +97,23 @@ def empty(self):
 
         To create code that needs to wait for all queued tasks to be
         completed, the preferred technique is to use the join() method.
-
-        """
+        '''
         with self.mutex:
             return not self._qsize()
 
     def full(self):
-        """Return True if the queue is full, False otherwise (not reliable!).
+        '''Return True if the queue is full, False otherwise (not reliable!).
 
         This method is likely to be removed at some point.  Use qsize() >= n
         as a direct substitute, but be aware that either approach risks a race
         condition where a queue can shrink before the result of full() or
         qsize() can be used.
-
-        """
+        '''
         with self.mutex:
             return 0 < self.maxsize <= self._qsize()
 
     def put(self, item, block=True, timeout=None):
-        """Put an item into the queue.
+        '''Put an item into the queue.
 
         If optional args 'block' is true and 'timeout' is None (the default),
         block if necessary until a free slot is available. If 'timeout' is
@@ -123,7 +122,7 @@ def put(self, item, block=True, timeout=None):
         Otherwise ('block' is false), put an item on the queue if a free slot
         is immediately available, else raise the Full exception ('timeout'
         is ignored in that case).
-        """
+        '''
         with self.not_full:
             if self.maxsize > 0:
                 if not block:
@@ -146,7 +145,7 @@ def put(self, item, block=True, timeout=None):
             self.not_empty.notify()
 
     def get(self, block=True, timeout=None):
-        """Remove and return an item from the queue.
+        '''Remove and return an item from the queue.
 
         If optional args 'block' is true and 'timeout' is None (the default),
         block if necessary until an item is available. If 'timeout' is
@@ -155,7 +154,7 @@ def get(self, block=True, timeout=None):
         Otherwise ('block' is false), return an item if one is immediately
         available, else raise the Empty exception ('timeout' is ignored
         in that case).
-        """
+        '''
         with self.not_empty:
             if not block:
                 if not self._qsize():
@@ -177,19 +176,19 @@ def get(self, block=True, timeout=None):
             return item
 
     def put_nowait(self, item):
-        """Put an item into the queue without blocking.
+        '''Put an item into the queue without blocking.
 
         Only enqueue the item if a free slot is immediately available.
         Otherwise raise the Full exception.
-        """
+        '''
         return self.put(item, block=False)
 
     def get_nowait(self):
-        """Remove and return an item from the queue without blocking.
+        '''Remove and return an item from the queue without blocking.
 
         Only get an item if one is immediately available. Otherwise
         raise the Empty exception.
-        """
+        '''
         return self.get(block=False)
 
     # Override these methods to implement other queue organizations
