feature: add mypy type checking for better type consistency

Author: jameshilliard

.pre-commit-config.yaml

@@ -22,16 +22,24 @@ repos:
         name: check-yaml for other YAML files
         exclude: ^mkdocs\.yml$
     -   id: check-added-large-files
--   repo: https://github.com/psf/black
-    rev: 25.9.0
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.13.2
     hooks:
-    -   id: black
--   repo: https://github.com/pycqa/isort
-    rev: 6.0.1
+    -   id: ruff-check
+        args: [--fix]
+    -   id: ruff-format
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.18.2
     hooks:
-    -   id: isort
-        name: isort (python)
-
+      - id: mypy
+        additional_dependencies:
+          [
+            betterproto==2.0.0b7,
+            httpx==0.28.1,
+            types-aiofiles==24.1.0.20250822,
+            types-passlib==1.7.7.20250602,
+            pydantic==2.11.9,
+          ]
 -   repo: local
     hooks:
     -   id: unittest

docs/generate_miners.py

@@ -1,8 +1,8 @@
-import asyncio
 import importlib
 import os
 import warnings
 from pathlib import Path
+from typing import Any
 
 from pyasic.miners.factory import MINER_CLASSES, MinerTypes
 
@@ -128,7 +128,7 @@ def create_url_str(mtype: str):
     </ul>
 </details>"""
 
-m_data = {}
+m_data: dict[str, dict[str, list[type[Any]]]] = {}
 done = []
 
 for m in MINER_CLASSES:

poetry.lock

@@ -14,10 +14,41 @@
 #  limitations under the License.                                              -
 # ------------------------------------------------------------------------------
 
+from typing import Any
+
 from pydantic import BaseModel, Field
 
-from pyasic.config.fans import FanMode, FanModeConfig, FanModeNormal
-from pyasic.config.mining import MiningMode, MiningModeConfig
+from pyasic.config.fans import (
+    FanModeConfig,
+    FanModeImmersion,
+    FanModeManual,
+    FanModeNormal,
+)
+from pyasic.config.mining import (
+    MiningModeConfig,
+    MiningModeHashrateTune,
+    MiningModeHPM,
+    MiningModeLPM,
+    MiningModeManual,
+    MiningModeNormal,
+    MiningModePowerTune,
+    MiningModePreset,
+    MiningModeSleep,
+)
+
+# Type aliases for config field types
+FanModeType = FanModeNormal | FanModeManual | FanModeImmersion | FanModeConfig
+MiningModeType = (
+    MiningModeNormal
+    | MiningModeHPM
+    | MiningModeLPM
+    | MiningModeSleep
+    | MiningModeManual
+    | MiningModePowerTune
+    | MiningModeHashrateTune
+    | MiningModePreset
+    | MiningModeConfig
+)
 from pyasic.config.mining.scaling import ScalingConfig
 from pyasic.config.pools import PoolConfig
 from pyasic.config.temperature import TemperatureConfig
@@ -32,11 +63,11 @@ class Config:
         arbitrary_types_allowed = True
 
     pools: PoolConfig = Field(default_factory=PoolConfig.default)
-    fan_mode: FanMode = Field(default_factory=FanModeConfig.default)
+    fan_mode: FanModeType = Field(default_factory=FanModeConfig.default)
     temperature: TemperatureConfig = Field(default_factory=TemperatureConfig.default)
-    mining_mode: MiningMode = Field(default_factory=MiningModeConfig.default)
+    mining_mode: MiningModeType = Field(default_factory=MiningModeConfig.default)
 
-    def __getitem__(self, item):
+    def __getitem__(self, item: str) -> Any:
         try:
             return getattr(self, item)
         except AttributeError:
@@ -88,8 +119,8 @@ def as_wm(self, user_suffix: str | None = None) -> dict:
     def as_btminer_v3(self, user_suffix: str | None = None) -> dict:
         """Generates the configuration in the format suitable for Whatsminers running BTMiner V3."""
         return {
-            "set.miner.pools": self.pools.as_btminer_v3()
-            ** self.mining_mode.as_btminer_v3()
+            "set.miner.pools": self.pools.as_btminer_v3(),
+            **self.mining_mode.as_btminer_v3(),
         }
 
     def as_am_old(self, user_suffix: str | None = None) -> dict:
@@ -260,7 +291,7 @@ def from_goldshell_list(cls, web_conf: list) -> "MinerConfig":
         return cls(pools=PoolConfig.from_goldshell(web_conf))
 
     @classmethod
-    def from_goldshell_byte(cls, web_conf: dict) -> "MinerConfig":
+    def from_goldshell_byte(cls, web_conf: list) -> "MinerConfig":
         """Constructs a MinerConfig object from web configuration for Goldshell Byte miners."""
         return cls(pools=PoolConfig.from_goldshell_byte(web_conf))