Issue #18676: Change 'positive' to 'non-negative' in queue.py put and get

terryjreedy · terryjreedy · commit 7608b607b1b4 · 2013-08-10T18:17:13.000-04:00
docstrings and ValueError messages. Patch by Zhongyue Luo
diff --git a/Lib/queue.py b/Lib/queue.py
@@ -120,7 +120,7 @@ def put(self, item, block=True, timeout=None):
 
         If optional args 'block' is true and 'timeout' is None (the default),
         block if necessary until a free slot is available. If 'timeout' is
-        a positive number, it blocks at most 'timeout' seconds and raises
+        a non-negative number, it blocks at most 'timeout' seconds and raises
         the Full exception if no free slot was available within that time.
         Otherwise ('block' is false), put an item on the queue if a free slot
         is immediately available, else raise the Full exception ('timeout'
@@ -135,7 +135,7 @@ def put(self, item, block=True, timeout=None):
                     while self._qsize() >= self.maxsize:
                         self.not_full.wait()
                 elif timeout < 0:
-                    raise ValueError("'timeout' must be a positive number")
+                    raise ValueError("'timeout' must be a non-negative number")
                 else:
                     endtime = time() + timeout
                     while self._qsize() >= self.maxsize:
@@ -152,7 +152,7 @@ def get(self, block=True, timeout=None):
 
         If optional args 'block' is true and 'timeout' is None (the default),
         block if necessary until an item is available. If 'timeout' is
-        a positive number, it blocks at most 'timeout' seconds and raises
+        a non-negative number, it blocks at most 'timeout' seconds and raises
         the Empty exception if no item was available within that time.
         Otherwise ('block' is false), return an item if one is immediately
         available, else raise the Empty exception ('timeout' is ignored
@@ -166,7 +166,7 @@ def get(self, block=True, timeout=None):
                 while not self._qsize():
                     self.not_empty.wait()
             elif timeout < 0:
-                raise ValueError("'timeout' must be a positive number")
+                raise ValueError("'timeout' must be a non-negative number")
             else:
                 endtime = time() + timeout
                 while not self._qsize():
diff --git a/Misc/ACKS b/Misc/ACKS
@@ -753,6 +753,7 @@ Ray Loyzaga
 Lukas Lueg
 Loren Luke
 Fredrik Lundh
+Zhongyue Luo
 Mark Lutz
 Jim Lynch
 Mikael Lyngvig
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -64,6 +64,9 @@ Core and Builtins
 Library
 -------
 
+- Issue #18676: Change 'positive' to 'non-negative' in queue.py put and get
+  docstrings and ValueError messages. Patch by Zhongyue Luo
+
 - Issue #18681: Fix a NameError in imp.reload() (noticed by Weizhao Li).
 
 - Issue #8112: xlmrpc.server's DocXMLRPCServer server no longer raises an error
