Add mypy, raise minimum version, fixup code (#11)

.github/workflows/ci.yml

@@ -23,6 +23,20 @@ jobs:
       - name: Lint everything
         run: uvx tomlscript lint
 
+  run-static-analysis:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      - name: Install Python
+        run: uv python install
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+      - name: Run static analysis
+        run: uvx tomlscript typecheck
+
   run-tests:
     runs-on: ubuntu-latest
     steps:

LICENSE

@@ -417,4 +417,30 @@ are:
     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     SOFTWARE.
+    """
+
+- `mypy` licensed as follows:
+    """
+        The MIT License
+
+    Copyright (c) 2012-2023 Jukka Lehtosalo and contributors
+    Copyright (c) 2015-2023 Dropbox, Inc.
+
+    Permission is hereby granted, free of charge, to any person obtaining a
+    copy of this software and associated documentation files (the "Software"),
+    to deal in the Software without restriction, including without limitation
+    the rights to use, copy, modify, merge, publish, distribute, sublicense,
+    and/or sell copies of the Software, and to permit persons to whom the
+    Software is furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+    DEALINGS IN THE SOFTWARE.
     """

README.md

@@ -25,3 +25,5 @@ To run test use `uvx tomlscript test`.
 
 To run the linter use `uvx tomlscript lint` or `uvx tomlscript lint-fix` to fix the issues.
 
+To statically type check the project use `uvx tomlscript typecheck`.
+

mypy.ini

@@ -0,0 +1,8 @@
+[mypy]
+ignore_missing_imports = True
+warn_return_any = True
+disallow_untyped_defs = True
+
+[mypy-napytau.gui.*]
+# ignore any returns in gui, as it uses external libraries without type hints and will have to return Any sometimes
+warn_return_any = False

napytau/cli/cli_arguments.py

@@ -3,6 +3,9 @@
 
 
 class CLIArguments:
+    headless: bool
+    filename: str
+
     def __init__(self, raw_args: Namespace):
         self.headless = coalesce(raw_args.headless, False)
         self.filename = raw_args.filename

napytau/core/logic_mockup.py

@@ -1,4 +1,4 @@
-def logic(value):
+def logic(value: int) -> int:
     if value > 10:
         return value ** 2
     else:

napytau/gui/ui_mockup.py

@@ -1,5 +1,6 @@
 import tkinter as tk
 from tkinter import Canvas
+from tkinter import Widget
 
 import customtkinter
 from matplotlib.figure import Figure
@@ -16,7 +17,7 @@
 )  # Themes: "blue" (standard), "green", "dark-blue"
 
 
-def plot(value, window) -> Canvas:
+def plot(value: int, window: Widget) -> Canvas:
     # the figure that will contain the plot
     fig = Figure(figsize=(3, 2), dpi=100, facecolor="white", edgecolor="black")
 
@@ -38,7 +39,7 @@ def plot(value, window) -> Canvas:
 
 
 class App(customtkinter.CTk):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
         # values
@@ -153,20 +154,20 @@ def __init__(self):
         self.slider_2.configure(command=self.use_slider_value)
         self.label.configure(text="Result: ")
 
-    def change_appearance_mode_event(self, new_appearance_mode: str):
+    def change_appearance_mode_event(self, new_appearance_mode: str) -> None:
         customtkinter.set_appearance_mode(new_appearance_mode)
 
-    def change_scaling_event(self, new_scaling: str):
+    def change_scaling_event(self, new_scaling: str) -> None:
         new_scaling_float = int(new_scaling.replace("%", "")) / 100
         customtkinter.set_widget_scaling(new_scaling_float)
 
-    def sidebar_button_event(self):
+    def sidebar_button_event(self) -> None:
         print("sidebar_button click")
 
-    def use_slider_value(self, _value):
+    def use_slider_value(self, _value: int) -> None:
         self.calc()
 
-    def calc(self):
+    def calc(self) -> None:
         entry_value = self.tau.get()
 
         self.label.configure(text=f"Result: {logic(entry_value)}")
@@ -182,6 +183,6 @@ def calc(self):
         )
 
 
-def init(cli_arguments: CLIArguments):
+def init(cli_arguments: CLIArguments) -> None:
     app = App()
     app.mainloop()

napytau/headless/headless_mockup.py

@@ -2,7 +2,7 @@
 from napytau.ingest.ingest_mockup import ingest_file
 
 
-def init(cli_arguments: CLIArguments):
+def init(cli_arguments: CLIArguments) -> None:
     print("running headless mockup")
     if cli_arguments.has_filename():
         print(

napytau/ingest/ingest_mockup.py

@@ -1,4 +1,4 @@
-def ingest_file(filename):
+def ingest_file(filename: str) -> str:
     # Ingest data from a file
     with open(filename) as f:
         data = f.read()

napytau/main.py

@@ -3,7 +3,7 @@
 from cli.parser import parse_cli_arguments
 
 
-def main():
+def main() -> None:
     args = parse_cli_arguments()
 
     if args.headless:

napytau/util/coalesce.py

@@ -1,5 +1,7 @@
-def coalesce(*args):
+from typing import Optional
+
+def coalesce[T](*args: Optional[T]) -> T:
     for arg in args:
         if arg is not None:
             return arg
-    return None
+    raise ValueError("All arguments are None")

pyproject.toml

@@ -3,7 +3,7 @@ name = "napytau"
 version = "0.1.0"
 description = "A modern reimplementation of napatau"
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.12"
 dependencies = [
     "customtkinter>=5.2.2",
     "matplotlib>=3.9.2",
@@ -13,15 +13,20 @@ dependencies = [
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools]
+packages = ["napytau"]
+
 [tool.tomlscript]
 run= "uv run napytau/main.py"
 test = "uv run pytest -rA"
 lint = "uv run ruff check --config ruff.toml"
 lint-fix = "uv run ruff check --config ruff.toml --fix"
 format = "uv run ruff format"
+typecheck = "uv run mypy napytau --config-file=mypy.ini"
 
 [dependency-groups]
 dev = [
     "pytest>=7.4.4",
     "ruff>=0.8.0",
+    "mypy>=1.13.0",
 ]

tests/util/coalesce_test.py

@@ -7,13 +7,13 @@ def test_returnsFirstNonNoneArgument(self):
         """Returns the first non-None argument."""
         self.assertEqual(1, coalesce(None, None, None, 1, 2, 3))
 
-    def test_returnsNoneIfAllArgumentsAreNone(self):
-        """Returns None if all arguments are None."""
-        self.assertIsNone(coalesce(None, None, None))
+    def test_raisesAValueErrorIfAllArgumentsAreNone(self):
+        """Raises a ValueError if all arguments are None."""
+        self.assertRaises(ValueError, coalesce, None, None, None)
 
-    def test_returnsNoneIfNoArgumentsAreProvided(self):
+    def test_raisesAValueErrorIfNoArgumentsAreProvided(self):
         """Returns None if no arguments are provided."""
-        self.assertIsNone(coalesce())
+        self.assertRaises(ValueError, coalesce)
 
 
 if __name__ == "__main__":