Added Python type annotations

Author: dmotte

awesome/parse.py

@@ -132,7 +132,7 @@ def parse_header(s: str) -> tuple[int, str]:
     return level, name
 
 
-def check_items_sorted(data: dict):
+def ensure_items_sorted(data: dict) -> None:
     prev_name = ''
 
     for child in data:
@@ -142,10 +142,10 @@ def check_items_sorted(data: dict):
                                  f'after {prev_name}')
             prev_name = child['name']
         elif child['type'] == 'section':
-            check_items_sorted(child['children'])
+            ensure_items_sorted(child['children'])
 
 
-def main():
+def main() -> int:
     data = []
     errors = []
 
@@ -182,7 +182,7 @@ def main():
             except Exception as e:
                 errors.append(e)
 
-    check_items_sorted(data)
+    ensure_items_sorted(data)
 
     ############################################################################
 

examples/py-croniter/main.py

@@ -7,7 +7,7 @@
 from croniter import croniter
 
 
-def main():
+def main() -> int:
     iter = croniter('*/2 * * * *', ret_type=dt)  # every 2 minutes
 
     while True:

examples/pyscript-import/functions.py

@@ -1,4 +1,4 @@
 #!/usr/bin/env python3
 
-def sum_plus_three(a: int, b: int):
+def sum_plus_three(a: int, b: int) -> int:
     return a + b + 3

python-scripts/binance-stats/coins.py

@@ -6,7 +6,7 @@
 from lib.record import load_records
 
 
-def main(argv=None):
+def main(argv: list[str] = None) -> int:
     if argv is None:
         argv = sys.argv
 

python-scripts/binance-stats/combos.py

@@ -6,7 +6,7 @@
 from lib.record import load_records
 
 
-def main(argv=None):
+def main(argv: list[str] = None) -> int:
     if argv is None:
         argv = sys.argv
 

python-scripts/binance-stats/lib/ohlcv.py

@@ -83,7 +83,7 @@ class OHLCV:
     Volume) candlestick data for a trading pair
     '''
 
-    def __init__(self, base: str, quote: str, candles: list[dict]):
+    def __init__(self, base: str, quote: str, candles: list[dict]) -> None:
         if len(candles) < 2:
             raise ValueError('Not enough candles. Minimum required: 2')
 
@@ -205,7 +205,7 @@ class OHLCVDir:
     '''
 
     def __init__(self, dir: str, year_first: int, year_last: int,
-                 numtype: type[float | Decimal] = float):
+                 numtype: type[float | Decimal] = float) -> None:
         if numtype not in (float, Decimal):
             raise ValueError(f'Invalid number type: {numtype}')
         self._numtype = numtype

python-scripts/binance-stats/lib/portfolio.py

@@ -14,7 +14,7 @@ class Portfolio:
 
     def __init__(self, balances: dict[str, float | Decimal] = {},
                  numtype: type[float | Decimal] = Decimal,
-                 allow_negative: bool = False):
+                 allow_negative: bool = False) -> None:
         if numtype not in (float, Decimal):
             raise ValueError(f'Invalid number type: {numtype}')
         self._numtype = numtype

python-scripts/binance-stats/lib/record.py

@@ -2,10 +2,11 @@
 
 import csv
 
+from collections.abc import Iterator
 from datetime import datetime as dt
 from datetime import timezone as tz
 from decimal import Decimal
-from typing import TextIO
+from typing import Any, TextIO
 
 
 def load_records(file: TextIO) -> list[dict]:
@@ -54,7 +55,7 @@ def load_records(file: TextIO) -> list[dict]:
     return records
 
 
-def records_before(records: list[dict], dt_end: dt):
+def records_before(records: list[dict], dt_end: dt) -> Iterator[dict[str, Any]]:
     '''
     Returns only the records before a specific datetime.
     Warning: it assumes that the records are already sorted in ascending order!

python-scripts/binance-stats/stats.py

@@ -53,7 +53,7 @@ def compute_fiats(pin: Portfolio, d: dt, fiat: str,
     return pout
 
 
-def main(argv=None):
+def main(argv: list[str] = None) -> int:
     if argv is None:
         argv = sys.argv
 

python-scripts/binance-stats/test/test_ohlcv.py

@@ -13,7 +13,7 @@
 from lib.ohlcv import Interval, OHLCV
 
 
-def test_interval():
+def test_interval() -> None:
     cases = [
         (Interval.SEC01, '1s', timedelta(seconds=1)),
         (Interval.MIN01, '1m', timedelta(minutes=1)),
@@ -38,7 +38,7 @@ def test_interval():
         assert td == interval.timedelta()
 
 
-def test_ohlcv():
+def test_ohlcv() -> None:
     with pytest.raises(ValueError) as exc_info:
         OHLCV('BASE', 'QUOTE', [
             {