Merge pull request #169 from bdrung/mypy

Add type hints to dicts

Author: potiuk

.github/workflows/cicd.yml

@@ -28,9 +28,9 @@ jobs:
       uses: actions/setup-python@v5
       with: {python-version: "${{ matrix.python-version }}", cache: pip, cache-dependency-path: 'requirements/*.txt'}
     - name: install tests dependencies
-      run: pip install -r requirements/test.txt -r requirements/lint.txt -r requirements/tox.txt -r requirements/format.txt
+      run: pip install -r requirements/test.txt -r requirements/lint.txt -r requirements/mypy.txt -r requirements/tox.txt -r requirements/format.txt
     - name: formatters check
-      run: tox --current-env -e lint,fmt
+      run: tox --current-env -e lint,mypy,fmt
 
   test-py3:
     runs-on: ubuntu-latest
@@ -67,4 +67,3 @@ jobs:
          docker compose build --build-arg BASE=corpusops/croniter:32bits
          docker compose run --rm app tox --current-env -e test
       env: {COMPOSE_FILE: "docker-compose.yml:docker-compose-32bits.yml"}
-

requirements/mypy.txt

@@ -0,0 +1,3 @@
+mypy
+types-python-dateutil
+types-pytz

src/croniter/croniter.py

@@ -11,6 +11,7 @@
 import sys
 import traceback as _traceback
 from time import time
+from typing import Optional, Union
 
 from dateutil.relativedelta import relativedelta
 from dateutil.tz import tzutc
@@ -59,12 +60,12 @@ def is_32bit():
 EPOCH = datetime.datetime.fromtimestamp(0, UTC_DT)
 
 # fmt: off
-M_ALPHAS = {
+M_ALPHAS: dict[str, Union[int, str]] = {
     "jan": 1, "feb": 2,  "mar": 3,  "apr": 4,  # noqa: E241
     "may": 5, "jun": 6,  "jul": 7,  "aug": 8,  # noqa: E241
     "sep": 9, "oct": 10, "nov": 11, "dec": 12,
 }
-DOW_ALPHAS = {
+DOW_ALPHAS: dict[str, Union[int, str]] = {
     "sun": 0, "mon": 1, "tue": 2, "wed": 3, "thu": 4, "fri": 5, "sat": 6
 }
 
@@ -109,8 +110,8 @@ def is_32bit():
 YEAR_CRON_LEN = len(YEAR_FIELDS)
 # retrocompat
 VALID_LEN_EXPRESSION = {a for a in CRON_FIELDS if isinstance(a, int)}
-TIMESTAMP_TO_DT_CACHE = {}
-EXPRESSIONS = {}
+TIMESTAMP_TO_DT_CACHE: dict[int, datetime.datetime] = {}
+EXPRESSIONS: dict[tuple[str, Optional[bytes], bool], list[str]] = {}
 MARKER = object()
 
 
@@ -176,7 +177,7 @@ class croniter:
         (1970, 2099),
     )
 
-    ALPHACONV = (
+    ALPHACONV: tuple[dict[str, Union[int, str]], ...] = (
         {},  # 0: min
         {},  # 1: hour
         {"l": "l"},  # 2: dom
@@ -190,7 +191,7 @@ class croniter:
         {},
     )
 
-    LOWMAP = (
+    LOWMAP: tuple[dict[int, int], ...] = (
         {},
         {},
         {0: 1},

src/croniter/tests/base.py

@@ -1,3 +1,4 @@
+import typing
 import unittest
 
 
@@ -7,4 +8,4 @@ class TestCase(unittest.TestCase):
     If necessary, we can put common utility or setup code in here.
     """
 
-    maxDiff = 10**10
+    maxDiff: typing.Optional[int] = 10**10

tox.ini

@@ -17,6 +17,10 @@ deps = -r{toxinidir}/requirements/lint.txt
 changedir = src
 commands = flake8 croniter/croniter.py
 
+[testenv:mypy]
+deps = -r{toxinidir}/requirements/mypy.txt
+commands = mypy .
+
 [testenv:fmt]
 deps = -r{toxinidir}/requirements/format.txt
 changedir = src