Add ruff, clean up pylint

Author: Skynet0

.gitignore

@@ -3,6 +3,7 @@
 .tool-versions
 .DS_STORE
 .ruff_cache/
+.idea/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

.pre-commit-config.yaml

@@ -1,9 +1,18 @@
 repos:
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.3.0
-  hooks:
-  - id: check-yaml
-    args: ['--unsafe']
-  - id: check-toml
-  - id: end-of-file-fixer
-  - id: trailing-whitespace
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    - id: check-yaml
+      args: ['--unsafe']
+    - id: check-toml
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+  - repo: https://github.com/ambv/black
+    rev: 23.1.0
+    hooks:
+      - id: black
+        language_version: python3.10
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.0.259"
+    hooks:
+      - id: ruff

bsag/_logging.py

@@ -1,7 +1,7 @@
 from __future__ import annotations  # necessary for loguru
 
+from collections.abc import Callable
 from enum import Flag, auto
-from typing import Callable
 
 import loguru
 from pydantic import BaseModel
@@ -28,10 +28,7 @@ def private_filter(record: loguru.Record) -> bool:
 
 def private_formatter(record: loguru.Record) -> str:
     swc: BaseStepWithConfig | None = record["extra"].get("swc")
-    if swc is None:
-        name = record["file"].name
-    else:
-        name = swc.name()
+    name = record["file"].name if swc is None else swc.name()
     return (
         "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | "
         "<level>{level: >8}</level> | "

bsag/_types.py

@@ -24,7 +24,7 @@ def name() -> str:
     # https://github.com/python/mypy/issues/7049
     # The reason these aren't instance methods is that I can't enforce a constructor call that would set `config`.
     @classmethod
-    def display_name(cls, config: C_co) -> str:  # type: ignore
+    def display_name(cls, _config: C_co) -> str:  # type: ignore
         """Returns display name of module that appears in student-facing logs."""
         return cls.name()
 

bsag/bsag.py

@@ -1,6 +1,7 @@
 import itertools
 import sys
 from argparse import ArgumentParser
+from pathlib import Path
 from typing import Any, get_args
 
 import pluggy  # type: ignore
@@ -57,6 +58,8 @@ def __init__(
         if not step_defs:
             step_defs = []
         pm = get_plugin_manager()
+        # type: ignore
+        # pylint: disable-next=no-member
         plugin_steps: list[type[ParamBaseStep]] = list(itertools.chain(*pm.hook.bsag_load_step_defs()))  # type: ignore
         self._step_defs = {m.name(): m for m in plugin_steps + step_defs}
         self._global_config = self._load_yaml_global_config(global_config_path)
@@ -66,13 +69,13 @@ def __init__(
 
     def _load_yaml_global_config(self, global_config_path: str | None) -> GlobalConfig:
         if global_config_path:
-            with open(global_config_path, encoding="utf-8") as f:
+            with Path(global_config_path).open(encoding="utf-8") as f:
                 return GlobalConfig.parse_obj(yaml.safe_load(f))
         else:
             return GlobalConfig()
 
     def _load_yaml_config(self, config_path: str) -> RunConfig:
-        with open(config_path, encoding="utf-8") as f:
+        with Path(config_path).open(encoding="utf-8") as f:
             predisc_config = ConfigPreDiscoveryYaml.parse_obj(yaml.safe_load(f))
 
         config = RunConfig()

bsag/bsagio.py

@@ -1,3 +1,4 @@
+import contextlib
 import sys
 from typing import Any
 
@@ -26,10 +27,8 @@ def __init__(self, colorize_private: bool = False, log_level_private: str = "DEB
 
         # TODO: `format` callable provided as argument?
         # TODO: log level setting, at least for private?
-        try:
+        with contextlib.suppress(ValueError):
             logger.remove(0)
-        except ValueError:
-            pass
 
         student_sink = create_student_sink(self.step_logs)
         # Student logs are never formatted

bsag/steps/common/run_command.py

@@ -33,7 +33,7 @@ def run(cls, bsagio: BSAGIO, config: RunCommandConfig) -> bool:
         results: Results = bsagio.data[RESULTS_KEY]
 
         bsagio.private.debug(f"Working directory: {config.working_dir}")
-        if type(config.command) is str:
+        if isinstance(config.command, str):
             bsagio.private.debug("\n" + config.command)
         else:
             bsagio.private.debug("\n" + list2cmdline(config.command))
@@ -45,10 +45,7 @@ def run(cls, bsagio: BSAGIO, config: RunCommandConfig) -> bool:
             shell=config.shell,
         )
 
-        test_result = TestResult(
-            name=config.display_name,
-            max_score=config.points
-        )
+        test_result = TestResult(name=config.display_name, max_score=config.points)
         passed = True
 
         if output.timed_out:

bsag/steps/gradescope/lateness.py

@@ -14,6 +14,7 @@ class LatenessConfig(BaseStepConfig):
     min_lateness_score: NonNegativeFloat = 0
 
     @validator("score_decay")
+    # pylint: disable-next=no-self-argument
     def halt_on_fail__score_decay_mutually_exclusive(
         cls,
         score_decay: dict[NonNegativeInt, float],
@@ -31,7 +32,7 @@ def name() -> str:
         return "gradescope.lateness"
 
     @classmethod
-    def display_name(cls, config: LatenessConfig) -> str:
+    def display_name(cls, _config: LatenessConfig) -> str:
         return "Lateness"
 
     @classmethod
@@ -48,7 +49,7 @@ def run(cls, bsagio: BSAGIO, config: LatenessConfig) -> bool:
         if lateness == 0:
             return True
 
-        bsagio.both.info("Your submission is %.2f hours late." % (lateness / 3600))
+        bsagio.both.info(f"Your submission is {lateness / 3600:.2f} hours late.")
         if graced_lateness == 0:
             bsagio.both.info("This is within the grace period for late submissions on this assignment.")
             return True
@@ -74,7 +75,7 @@ def run(cls, bsagio: BSAGIO, config: LatenessConfig) -> bool:
                     f"After applying a lateness penalty of {penalty * 100:.2f}%, your final score is {res.score:.3f}."
                 )
             else:
-                bsagio.both.info(f"Scores of 0 do not have lateness applied.")
+                bsagio.both.info("Scores of 0 do not have lateness applied.")
         else:
             bsagio.private.error("Cannot apply a lateness penalty without an overall score.")
 

bsag/steps/gradescope/limit_velocity.py

@@ -8,7 +8,7 @@
 from bsag.bsagio import BSAGIO
 from bsag.utils.datetimes import ZERO_TD, format_datetime
 
-from ._types import METADATA_KEY, SubmissionMetadata, Results, RESULTS_KEY
+from ._types import METADATA_KEY, RESULTS_KEY, Results, SubmissionMetadata
 
 EXTRA_TOKENS_KEY = "extra_tokens"
 """Used by `gradescope.limit_velocity` to add extra velocity tokens. If not present, then 0 tokens are added.
@@ -32,6 +32,7 @@ class LimitVelocityConfig(BaseStepConfig):
     windows: list[Window]
 
     @validator("windows")
+    # pylint: disable-next=no-self-argument
     def windows_must_be_strictly_asc(cls, windows: list[Window]) -> list[Window]:
         for i in range(len(windows) - 1):
             if windows[i + 1].start_time - windows[i].start_time <= ZERO_TD:
@@ -40,6 +41,7 @@ def windows_must_be_strictly_asc(cls, windows: list[Window]) -> list[Window]:
         return windows
 
     @validator("windows", each_item=True)
+    # pylint: disable-next=no-self-argument
     def windows_must_be_offset_aware(cls, window: Window, values: dict[str, Any]) -> Window:
         config_tz = timezone(values["time_zone"])
         if not window.start_time.tzinfo:
@@ -53,7 +55,7 @@ def name() -> str:
         return "gradescope.limit_velocity"
 
     @classmethod
-    def display_name(cls, config: LimitVelocityConfig) -> str:
+    def display_name(cls, _config: LimitVelocityConfig) -> str:
         return "Limit Velocity"
 
     @classmethod
@@ -68,8 +70,9 @@ def run(cls, bsagio: BSAGIO, config: LimitVelocityConfig) -> bool:
                 start_time=datetime.utcfromtimestamp(0).astimezone(timezone(config.time_zone)),
                 max_tokens=1,
                 recharge_time=ZERO_TD,
-            )
-        ] + config.windows
+            ),
+            *config.windows,
+        ]
 
         # Latest window with start time before current submission
         w_idx, active_window = [(i, w) for i, w in enumerate(windows) if w.start_time < curr_sub_create_time][-1]

bsag/steps/gradescope/results.py

@@ -17,7 +17,7 @@ def name() -> str:
         return "gradescope.results"
 
     @classmethod
-    def display_name(cls, config: ResultsConfig) -> str:
+    def display_name(cls, _config: ResultsConfig) -> str:
         return "Results"
 
     @classmethod