Skip to content

Commit 9dbd10d

Browse files
committed
Add missing docstrings
1 parent d03527f commit 9dbd10d

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

plugwise_usb/connection/queue.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ class RequestState:
2727

2828

2929
class DroppingPriorityQueue(Queue):
30+
"""Define a queue that has a maximum size.
31+
32+
Older entries are dropped when the queue reaches its maximum size.
33+
"""
3034
def _init(self, maxsize):
3135
# called by asyncio.Queue.__init__
3236
self._queue = SortedList()
@@ -48,14 +52,16 @@ def __drop(self):
4852
self.task_done()
4953

5054
def put_nowait(self, item):
55+
""" Override method for queue.put."""
5156
if self.full():
5257
self.__drop()
5358
super().put_nowait(item)
5459

5560
async def put(self, item):
56-
# Queue.put blocks when full, so we must override it.
57-
# Since our put_nowait never raises QueueFull, we can just
58-
# call it directly
61+
"""Queue.put blocks when full, so we must override it.
62+
63+
Since our put_nowait never raises QueueFull, we can just call it directly.
64+
"""
5965
self.put_nowait(item)
6066

6167

0 commit comments

Comments
 (0)