From 7502eb7ce85593dd66db524f4583f5b173501bf6 Mon Sep 17 00:00:00 2001 From: uvok Date: Fri, 18 Apr 2025 11:58:10 +0200 Subject: Documentation --- trade_queue.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/trade_queue.py b/trade_queue.py index a23d8e8..c76017a 100644 --- a/trade_queue.py +++ b/trade_queue.py @@ -18,15 +18,24 @@ class FIFOQueue: """ def __init__(self) -> None: + """ + Create new FIFO queue holding cryptocurrency trades. + """ self.__queue: Deque[Trade] = deque() self._cached_total: Decimal = Decimal(0) self._cache_valid: bool = True logger.info("FIFOQueue initialized with empty queue.") def __len__(self) -> int: + """ + Get amount of trades in the queue. + """ return len(self.__queue) def __repr__(self) -> str: + """ + Get string representation of queue (for debugging). + """ return f"FIFOQueue(len={len(self)})" def get_copy(self) -> List[Trade]: @@ -37,7 +46,7 @@ class FIFOQueue: def add(self, amount: Decimal, total_cost: Decimal, date: str) -> None: """ - Add a trade to the queue. + Add a trade to the queue by specifying properties. """ trade = Trade(amount, total_cost, date) self.__queue.append(trade) -- cgit v1.2.3