Add CI workflow and fix linting/type errors

- Add GitHub Actions CI workflow with lint, typecheck, and test jobs
- Fix ruff lint errors (line length, bare except, type comparisons)
- Fix ruff formatting across all files
- Fix pyright type errors:
  - Correct decorator return type annotations
  - Add missing join_with_space_if_list function
  - Fix Optional[TracebackType] for exception hook
  - Use Sequence instead of List for covariant parameter
  - Fix fixture return types to Iterator[None]

Author: Nils Bars

.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master, dev]
+  pull_request:
+    branches: [main, master, dev]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run ruff check
+        run: uv run ruff check .
+
+      - name: Run ruff format check
+        run: uv run ruff format --check .
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run pyright
+        run: uv run pyright
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run tests with coverage
+        run: uv run pytest --cov=ref_utils --cov-report=term-missing --cov-report=xml
+
+      - name: Upload coverage reports
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.10'
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: false

ref_utils/__init__.py

@@ -1,22 +1,51 @@
-"""Import functions to avoid .dot import for user""" # pylint: disable = invalid-name
+"""Import functions to avoid .dot import for user"""  # pylint: disable = invalid-name
+
 __all__ = [
     # Modules
-    'process', 'assertion', 'utils', 'decorator', 'config', 'serialization',
+    "process",
+    "assertion",
+    "utils",
+    "decorator",
+    "config",
+    "serialization",
     # Config
-    'Config', 'get_config', 'set_config', 'override_config',
+    "Config",
+    "get_config",
+    "set_config",
+    "override_config",
     # Assertion
-    'assert_is_dir', 'assert_is_exec', 'assert_is_file',
+    "assert_is_dir",
+    "assert_is_exec",
+    "assert_is_file",
     # Decorator
-    'TestResult', 'TaskTestResult', 'environment_test', 'submission_test',
-    'add_environment_test', 'add_submission_test', 'run_tests',
+    "TestResult",
+    "TaskTestResult",
+    "environment_test",
+    "submission_test",
+    "add_environment_test",
+    "add_submission_test",
+    "run_tests",
     # Process
-    'drop_privileges', 'run', 'run_capture_output', 'run_with_payload',
-    'get_payload_from_executable', 'ref_util_install_global_exception_hook',
+    "drop_privileges",
+    "run",
+    "run_capture_output",
+    "run_with_payload",
+    "get_payload_from_executable",
+    "ref_util_install_global_exception_hook",
     # Serialization
-    'IPCSerializer', 'TypeCodec', 'safe_dumps', 'safe_loads', 'get_serializer',
+    "IPCSerializer",
+    "TypeCodec",
+    "safe_dumps",
+    "safe_loads",
+    "get_serializer",
     # Utils
-    'print_ok', 'print_warn', 'print_err', 'write_stdout',
-    'decode_or_str', 'test_result_will_be_submitted', 'get_user_environment',
+    "print_ok",
+    "print_warn",
+    "print_err",
+    "write_stdout",
+    "decode_or_str",
+    "test_result_will_be_submitted",
+    "get_user_environment",
 ]
 from .assertion import assert_is_dir, assert_is_exec, assert_is_file
 from .config import Config, get_config, override_config, set_config

ref_utils/assertion.py

@@ -1,4 +1,5 @@
 """Exception-free assert functions"""
+
 import os
 from pathlib import Path
 from typing import Any, Union  # pylint: disable = unused-import
@@ -14,20 +15,26 @@ def _assert(condition: bool, error_msg: str, silent: bool) -> bool:
         return False
     return True
 
-def assert_is_exec(executable: Union[str, 'os.PathLike[Any]', Path], silent: bool = False) -> bool:
+
+def assert_is_exec(executable: Union[str, "os.PathLike[Any]", Path], silent: bool = False) -> bool:
     """Assert file exists and is executable"""
     if not isinstance(executable, Path):
         return assert_is_exec(Path(executable))
-    return _assert(executable.exists() and executable.is_file() and os.access(executable, os.X_OK),
-                   f"Executable file {executable} not found or not executable", silent)
+    return _assert(
+        executable.exists() and executable.is_file() and os.access(executable, os.X_OK),
+        f"Executable file {executable} not found or not executable",
+        silent,
+    )
 
-def assert_is_file(file_: Union[str, 'os.PathLike[Any]', Path], silent: bool = False) -> bool:
+
+def assert_is_file(file_: Union[str, "os.PathLike[Any]", Path], silent: bool = False) -> bool:
     """Assert file exists"""
     if not isinstance(file_, Path):
         return assert_is_file(Path(file_))
     return _assert(file_.exists() and file_.is_file(), f"File {file_} not found", silent)
 
-def assert_is_dir(directory: Union[str, 'os.PathLike[Any]', Path], silent: bool = False) -> bool:
+
+def assert_is_dir(directory: Union[str, "os.PathLike[Any]", Path], silent: bool = False) -> bool:
     """Assert directory exists"""
     if not isinstance(directory, Path):
         return assert_is_dir(Path(directory))

ref_utils/checks.py

@@ -1,4 +1,5 @@
 """Various checks you may want to run during submission tests"""
+
 import os
 import subprocess
 from pathlib import Path
@@ -12,6 +13,7 @@
 _ENV_VAL_TRUE = "1"
 _ENV_VAL_FALSE = "0"
 
+
 def contains_flag(flag: str, python_script: Path, silent: bool = False) -> bool:
     """
     Run submitted file and match whether it contains the flag value.
@@ -32,15 +34,18 @@ def run_pylint(python_files: List[Path]) -> bool:
     """
     Run pylint with custom config on user code (only interesting if submission contains .py files)
     """
-    if not python_files or os.environ.get(_NO_LINT_ENV_VAR, '') == _ENV_VAL_TRUE:
+    if not python_files or os.environ.get(_NO_LINT_ENV_VAR, "") == _ENV_VAL_TRUE:
         return SUCCESS
-    result = run(["pylint", "--exit-zero", "--rcfile", str(get_config().pylint_config_path)] +
-                 [str(f.resolve()) for f in python_files],
-                 stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+    result = run(
+        ["pylint", "--exit-zero", "--rcfile", str(get_config().pylint_config_path)]
+        + [str(f.resolve()) for f in python_files],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.STDOUT,
+    )
     lint_output = result.stdout.decode() if result.stdout else ""
     if lint_output != "":
         print_warn("[!] pylint's syntax and coding style checks failed:")
-        print_warn('    ' + '\n    '.join(lint_output.split('\n')))
+        print_warn("    " + "\n    ".join(lint_output.split("\n")))
         return FAILURE
     print_ok("[+] pylint's syntax and coding style checks passed")
     return SUCCESS
@@ -50,15 +55,15 @@ def run_mypy(python_files: List[Path]) -> bool:
     """
     Run mypy with custom config on user code (only interesting if submission contains typed .py files)
     """
-    if not python_files or os.environ.get(_NO_LINT_ENV_VAR, '') == _ENV_VAL_TRUE:
+    if not python_files or os.environ.get(_NO_LINT_ENV_VAR, "") == _ENV_VAL_TRUE:
         return SUCCESS
     cmd = ["mypy", "--config-file", str(get_config().mypy_config_path)]
     cmd += [str(f.resolve()) for f in python_files]
     result = run(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
     lint_output = result.stdout.decode() if result.stdout else ""
     if lint_output != "":
         print_warn("[!] mypy's type checks failed:")
-        print_warn('    ' + '\n    '.join(lint_output.split('\n')))
+        print_warn("    " + "\n    ".join(lint_output.split("\n")))
         return FAILURE
     print_ok("[+] mypy's type checks passed")
     return SUCCESS
@@ -70,9 +75,9 @@ def check_all_python_files() -> bool:
     """
     tests_passed = True
     python_files = [f for f in get_config().user_home_path.glob("**/*.py") if not f.name.startswith(".")]
-    if not python_files or os.environ.get(_NO_LINT_ENV_VAR, '') == _ENV_VAL_TRUE:
+    if not python_files or os.environ.get(_NO_LINT_ENV_VAR, "") == _ENV_VAL_TRUE:
         return tests_passed
-    print_ok(f'[+] Testing {len(python_files)} Python source code files')
+    print_ok(f"[+] Testing {len(python_files)} Python source code files")
     tests_passed &= run_pylint(python_files)
     tests_passed &= run_mypy(python_files)
     return tests_passed

ref_utils/config.py

@@ -1,4 +1,5 @@
 """Configuration module for ref-utils with testable path abstraction."""
+
 from contextlib import contextmanager
 from contextvars import ContextVar
 from dataclasses import dataclass, field