ci: Add type checking to CI

Add invokation of mypy to CI pipeline and change the code to adhere to its standard

Author: brain-dev-null

.github/workflows/python-app.yml

@@ -26,9 +26,11 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
-        pip install flake8
+        pip install -r requirements_ci.txt
     - name: Run linter
       run: flake8 electrolog
+    - name: Run type checker
+      run: mypy electrolog
     - name: Build application
       run: |
         pyinstaller -F electrolog/__main__.py -n electrolog --hiddenimport xlwt
@@ -52,9 +54,11 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
-        pip install flake8
+        pip install -r requirements_ci.txt
     - name: Run linter
       run: flake8 electrolog
+    - name: Run type checker
+      run: mypy electrolog
     - name: Build application
       run: |
         pyinstaller -F electrolog\__main__.py -n electrolog.exe --hiddenimport xlwt

electrolog/__main__.py

@@ -12,18 +12,24 @@
         default_ip = ""
 
     if in_dev:
-        handler = logging.StreamHandler()
-        log_level = logging.DEBUG
+        logging.basicConfig(
+            level=logging.DEBUG,
+            style="{",
+            format=(
+                "{asctime} - {levelname:<8} - {filename}:{funcName}:{lineno} -"
+                " {message}"
+            ),
+            handlers=[logging.StreamHandler()],
+        )
     else:
-        handler = logging.FileHandler("electrolog.log")
-        log_level = logging.INFO
-
-    logging.basicConfig(
-        level=logging.DEBUG,
-        style="{",
-        format="{asctime} - {levelname:<8} - {filename}:{funcName}:{lineno} - "
-        "{message}",
-        handlers=[handler],
-    )
+        logging.basicConfig(
+            level=logging.INFO,
+            style="{",
+            format=(
+                "{asctime} - {levelname:<8} - {filename}:{funcName}:{lineno} -"
+                " {message}"
+            ),
+            handlers=[logging.FileHandler("electrolog.log")],
+        )
 
     main(in_dev, default_ip=default_ip)

electrolog/data/download_functions.py

@@ -10,7 +10,8 @@ def download_past_hour(session: Session, base_url: str) -> DataFrame:
     url = f"{base_url}/V"
 
     responses = [
-        session.get(url, params={"h": page, "f": "j"}) for page in range(1, 3)
+        session.get(url, params={"h": str(page), "f": "j"})
+        for page in range(1, 3)
     ]
 
     page_dataframes = [
@@ -25,7 +26,8 @@ def download_past_day(session: Session, base_url: str) -> DataFrame:
     url = f"{base_url}/V"
 
     responses = [
-        session.get(url, params={"w": page, "f": "j"}) for page in range(1, 4)
+        session.get(url, params={"w": str(page), "f": "j"})
+        for page in range(1, 4)
     ]
 
     page_dataframes = [
@@ -40,7 +42,8 @@ def download_past_week(session: Session, base_url: str) -> DataFrame:
     url = f"{base_url}/V"
 
     responses = [
-        session.get(url, params={"d": page, "f": "j"}) for page in range(1, 7)
+        session.get(url, params={"d": str(page), "f": "j"})
+        for page in range(1, 7)
     ]
 
     page_dataframes = [
@@ -55,7 +58,8 @@ def download_past_year(session: Session, base_url: str) -> DataFrame:
     url = f"{base_url}/V"
 
     responses = [
-        session.get(url, params={"m": page, "f": "j"}) for page in range(1, 13)
+        session.get(url, params={"m": str(page), "f": "j"})
+        for page in range(1, 13)
     ]
 
     page_dataframes = [

electrolog/views/views.py

@@ -23,7 +23,6 @@
 
 class LoginView:
     def __init__(self, root: tk.Tk, default_ip: Optional[str] = "") -> None:
-
         if os.path.isfile("ip.txt"):
             with open("ip.txt", "r") as ip_file:
                 default_ip = ip_file.read()

requirements.txt

@@ -1,5 +1,4 @@
-pandas==1.5.2
-pyinstaller==5.7.0
-requests==2.28.1
-tk==0.1.0
-xlwt==1.3.0
+pandas
+requests
+tk
+xlwt

requirements_ci.txt

@@ -0,0 +1,6 @@
+pandas-stubs
+pyinstaller
+types-requests
+mypy
+flake8
+pytest