Unifying the style checkers (MetOffice#196)

* Yet another weird round of having to repeatedly accept the same changes which git / VS Code are marking as in conflict.
Annoyingly, this seems to have introduced a bug as well.

* Fixing issue with external runners not establishing properly.

* Fixing an error that seems to have crept in during merging main and resolving clashes. But looking at it, I really can't fathom out 'how'

* Where do these line length errors in the linter(s) come from - I haven't edited this file...

* quick "improvement" to the error reporting in one of the tests

* Why am I constantly having to re-impliment fixes/tidying I'm sure I've done before.

* And now ruff_format wants to change them back again...

* reviewer suggestion : start enumeration at 1

Co-authored-by: Sam Clarke-Green <74185251+t00sa@users.noreply.github.com>

* reviewer suggestion : start enumeration at 1, remove +1 from log

Co-authored-by: Sam Clarke-Green <74185251+t00sa@users.noreply.github.com>

* Reviewer suggested changes :  "Default mutable instance in a function signature"

---------

Co-authored-by: Sam Clarke-Green <74185251+t00sa@users.noreply.github.com>

Author: r-sharp

script_umdp3_checker/umdp3_checker_rules.py

@@ -329,7 +329,7 @@ def lowercase_variable_names(self, lines: List[str]) -> TestResult:
         failures = 0
         error_log = {}
         count = -1
-        for count, line in enumerate(lines):
+        for count, line in enumerate(lines, 1):
             clean_line = self.remove_quoted(line)
             clean_line = re.sub(r"!.*$", "", clean_line)
 
@@ -348,7 +348,7 @@ def lowercase_variable_names(self, lines: List[str]) -> TestResult:
                     self.add_extra_error(f"UPPERCASE variable name : {match[1]}")
                     failures += 1
                     error_log = self.add_error_log(
-                        error_log, f"UPPERCASE variable name {match[1]}", count + 1
+                        error_log, f"UPPERCASE variable name {match[1]}", count
                     )
 
         output = f"Checked {count + 1} lines, found {failures} failures."

script_umdp3_checker/umdp3_conformance.py

@@ -1,7 +1,7 @@
 import subprocess
 from abc import ABC, abstractmethod
 from pathlib import Path
-from typing import Callable, List, Dict, Set
+from typing import Callable, List, Dict, Set, Optional
 from dataclasses import dataclass, field
 import argparse
 from checker_dispatch_tables import CheckerDispatchTables
@@ -165,14 +165,11 @@ def check(self, file_path: Path) -> CheckResult:
     def from_full_list(
         cls,
         name: str,
-        file_extensions: Set[str] = set(),
-        check_functions: Dict[str, Callable] = {},
-        changed_files: List[Path] = [],
+        file_extensions: Set[str],
+        check_functions: Dict[str, Callable],
+        changed_files: List[Path],
         print_volume: int = 3,
     ):
-        """Create a StyleChecker instance whilst simultaneously filtering files
-        from a full list.
-        Returns a StyleChecker instance."""
         files_to_check = (
             cls.filter_files(changed_files, file_extensions) if changed_files else []
         )
@@ -188,7 +185,7 @@ def from_full_list(
 
     @staticmethod
     def filter_files(
-        files: List[Path], file_extensions: Set[str] = set()
+        files: List[Path], file_extensions: Optional[Set[str]] = None
     ) -> List[Path]:
         """Filter files based on the checker's file extensions."""
         if not file_extensions:
@@ -201,7 +198,7 @@ def create_external_runners(
         name: str,
         commands: List[List[str]],
         all_files: List[Path],
-        file_extensions: Set[str] = set(),
+        file_extensions: Set[str],
     ) -> "StyleChecker":
         """Create a StyleChecker instance filtering files from a full list."""
         filtered_files = cls.filter_files(all_files, file_extensions)