佇列物件¶

佇列物件（Queue、LifoQueue、PriorityQueue）提供下面描述的公用 method。

Queue.qsize()¶

回傳佇列的近似大小。注意，qsize() > 0 並不能保證後續的 get() 不會阻塞，qsize() < maxsize 也不會保證 put() 不會阻塞。

Queue.empty()¶

如果佇列為空，則回傳True，否則回傳False。如果 empty() 回傳True，則不保證後續呼叫 put() 不會阻塞。同樣，如果 empty() 回傳False，則不保證後續呼叫 get() 不會阻塞。

Queue.full()¶

如果佇列已滿，則回傳True ，否則回傳False。如果 full() 回傳True，則不保證後續呼叫 get() 不會阻塞。同樣，如果 full() 回傳False，則不保證後續呼叫 put() 不會阻塞。

Queue.put(item,block=True,timeout=None)¶

將item 放入佇列中。如果可選的 argsblock 為 true、timeout 為None（預設值），則在必要時阻塞，直到自由槽 (free slot) 可用。如果timeout 為正數，則最多阻塞timeout 秒，如果該時間內沒有可用的自由槽，則會引發Full 例外。否則（block 為 false），如果自由槽立即可用，則將項目放在佇列中，否則引發Full 例外（在這種情況下，timeout 將被忽略）。

RaisesShutDown if the queue has been shut down.

Queue.put_nowait(item)¶

等效於put(item,block=False)。

Queue.get(block=True,timeout=None)¶

從佇列中移除並回傳一個項目。如果可選的 argsblock 為 true，且timeout 為None（預設值），則在必要時阻塞，直到有可用的項目。如果timeout 是正數，則最多會阻塞timeout 秒，如果該時間內沒有可用的項目，則會引發Empty 例外。否則（block 為 false），如果立即可用，則回傳一個項目，否則引發Empty 例外（在這種情況下，timeout 將被忽略）。

在 POSIX 系統的 3.0 版之前，以及 Windows 的所有版本，如果block 為 true 且timeout 為None，則此操作將在底層鎖上進入不間斷等待。這意味著不會發生例外，特別是 SIGINT（中斷訊號）不會觸發KeyboardInterrupt。

RaisesShutDown if the queue has been shut down and is empty, or ifthe queue has been shut down immediately.

Queue.get_nowait()¶

等效於get(False)。

有兩個 method 可以支援追蹤放入佇列的任務是否已由常駐消費者執行緒 (daemon consumer threads) 完全處理。

Queue.task_done()¶

表示先前放入佇列的任務已完成。由佇列消費者執行緒使用。對於用來提取任務的每個get()，隨後呼叫task_done() 告訴佇列任務的處理已完成。

如果目前join() 阻塞，它將會在所有項目都已處理完畢後恢復（代表對於以put() 放進佇列的每個項目，都要收到task_done() 的呼叫）。

shutdown(immediate=True) callstask_done() for each remaining itemin the queue.

如果呼叫次數超過佇列中放置的項目數量，則引發ValueError。

Queue.join()¶

持續阻塞直到佇列中的所有項目都已被取得並處理完畢。

每當項目被加到佇列中時，未完成任務的計數都會增加。每當消費者執行緒呼叫task_done() 以指示該項目已被取出並且對其的所有工作都已完成時，計數就會下降。當未完成任務的計數降至零時，join() 將停止阻塞。

如何等待放入佇列的任務完成的範例：

importthreadingimportqueueq=queue.Queue()defworker():whileTrue:item=q.get()print(f'Working on{item}')print(f'Finished{item}')q.task_done()# Turn-on the worker thread.threading.Thread(target=worker,daemon=True).start()# Send thirty task requests to the worker.foriteminrange(30):q.put(item)# Block until all tasks are done.q.join()print('All work completed')

SimpleQueue 物件¶

SimpleQueue 物件提供下面描述的公用 method。

SimpleQueue.qsize()¶

傳回佇列的近似大小。注意，qsize() > 0 並不能保證後續的 get() 不會阻塞。

SimpleQueue.empty()¶

如果佇列為空，則回傳True，否則回傳False。如果 empty() 回傳False，則不保證後續呼叫 get() 不會阻塞。

SimpleQueue.put(item,block=True,timeout=None)¶

將item 放入佇列中。此 method 從不阻塞，並且都會成功（除了潛在的低階錯誤，像是分配記憶體失敗）。可選的 argsblock 和timeout 會被忽略，它們僅是為了與Queue.put() 相容才存在。

此 method 有一個可重入 (reentrant) 的 C 實作。意思就是，一個put() 或get() 呼叫，可以被同一執行緒中的另一個put() 呼叫中斷，而不會造成死鎖 (deadlock) 或損壞佇列中的內部狀態。這使得它適合在解構子 (destructor) 中使用，像是__del__ method 或weakref 回呼函式 (callback)。

SimpleQueue.put_nowait(item)¶

等效於put(item,block=False)，用於與Queue.put_nowait() 相容。

SimpleQueue.get(block=True,timeout=None)¶

從佇列中移除並回傳一個項目。如果可選的 argsblock 為 true，且timeout 為None（預設值），則在必要時阻塞，直到有可用的項目。如果timeout 是正數，則最多會阻塞timeout 秒，如果該時間內沒有可用的項目，則會引發Empty 例外。否則（block 為 false），如果立即可用，則回傳一個項目，否則引發Empty 例外（在這種情況下，timeout 將被忽略）。

SimpleQueue.get_nowait()¶

等效於get(False)。