Mark constants in config as Final (#422)

Author: mzuenni

bin/config.py

@@ -5,20 +5,20 @@
 import os
 import re
 from pathlib import Path
-from typing import Literal, Optional
+from typing import Final, Literal, Optional
 
 # return values
-RTV_AC = 42
-RTV_WA = 43
+RTV_AC: Final = 42
+RTV_WA: Final = 43
 
-SUBMISSION_DIRS = [
+SUBMISSION_DIRS: Final = [
     "accepted",
     "wrong_answer",
     "time_limit_exceeded",
     "run_time_error",
 ]
 
-KNOWN_LICENSES = [
+KNOWN_LICENSES: Final = [
     "cc by-sa",
     "cc by",
     "cc0",
@@ -29,25 +29,25 @@
 ]
 
 # When --table is set, this threshold determines the number of identical profiles needed to get flagged.
-TABLE_THRESHOLD = 4
+TABLE_THRESHOLD: Final = 4
 
-FILE_NAME_REGEX = "[a-zA-Z0-9][a-zA-Z0-9_.-]*[a-zA-Z0-9]"
-COMPILED_FILE_NAME_REGEX = re.compile(FILE_NAME_REGEX)
+FILE_NAME_REGEX: Final = "[a-zA-Z0-9][a-zA-Z0-9_.-]*[a-zA-Z0-9]"
+COMPILED_FILE_NAME_REGEX: Final = re.compile(FILE_NAME_REGEX)
 
-KNOWN_TESTCASE_EXTENSIONS = [
+KNOWN_TESTCASE_EXTENSIONS: Final = [
     ".in",
     ".ans",
     ".out",
 ]
 
-KNOWN_VISUALIZER_EXTENSIONS = [
+KNOWN_VISUALIZER_EXTENSIONS: Final = [
     ".png",
     ".jpg",
     ".svg",
     ".pdf",
 ]
 
-KNOWN_TEXT_DATA_EXTENSIONS = KNOWN_TESTCASE_EXTENSIONS + [
+KNOWN_TEXT_DATA_EXTENSIONS: Final = KNOWN_TESTCASE_EXTENSIONS + [
     ".interaction",
     ".hint",
     ".desc",
@@ -56,32 +56,32 @@
     #'.args',
 ]
 
-KNOWN_DATA_EXTENSIONS = KNOWN_TEXT_DATA_EXTENSIONS + KNOWN_VISUALIZER_EXTENSIONS
+KNOWN_DATA_EXTENSIONS: Final = KNOWN_TEXT_DATA_EXTENSIONS + KNOWN_VISUALIZER_EXTENSIONS
 
-INVALID_CASE_DIRECTORIES = [
+INVALID_CASE_DIRECTORIES: Final = [
     "invalid_inputs",
     "invalid_answers",
     "invalid_outputs",
     "bad",
 ]
 
 
-SEED_DEPENDENCY_RETRIES = 10
+SEED_DEPENDENCY_RETRIES: Final = 10
 
 # The root directory of the BAPCtools repository.
-tools_root = Path(__file__).resolve().parent.parent
+TOOLS_ROOT: Final = Path(__file__).resolve().parent.parent
 
 # The directory from which BAPCtools is invoked.
-current_working_directory = Path.cwd().resolve()
+current_working_directory: Final = Path.cwd().resolve()
 
 # Add third_party/ to the $PATH for checktestdata.
-os.environ["PATH"] += os.pathsep + str(tools_root / "third_party")
+os.environ["PATH"] += os.pathsep + str(TOOLS_ROOT / "third_party")
 
 # Below here is some global state that will be filled in main().
 
 args = argparse.Namespace()
 
-default_args = {
+DEFAULT_ARGS: Final = {
     "jobs": (os.cpu_count() or 1) // 2,
     "time": 600,  # Used for `bt fuzz`
     "verbose": 0,
@@ -93,19 +93,19 @@
 """
 for cmd in $(bapctools --help | grep '^  {' | sed 's/  {//;s/}//;s/,/ /g') ; do bapctools $cmd --help ; done |& \
 grep '^  [^ ]' | sed 's/^  //' | cut -d ' ' -f 1 | sed -E 's/,//;s/^-?-?//;s/-/_/g' | sort -u | \
-grep -Ev '^(h|jobs|time|verbose)$' | sed "s/^/'/;s/$/',/" | tr '\n' ' ' | sed 's/^/args_list = [/;s/, $/]\n/'
+grep -Ev '^(h|jobs|time|verbose)$' | sed "s/^/'/;s/$/',/" | tr '\n' ' ' | sed 's/^/ARGS_LIST: Final = [/;s/, $/]\n/'
 """
 # fmt: off
-args_list = ['1', 'add', 'all', 'answer', 'api', 'author', 'check_deterministic', 'clean', 'colors', 'contest', 'contest_id', 'contestname', 'cp', 'default_solution', 'depth', 'directory', 'error', 'force', 'force_build', 'input', 'interaction', 'interactive', 'invalid', 'kattis', 'language', 'memory', 'more', 'move_to', 'no_bar', 'no_generate', 'no_solution', 'no_solutions', 'no_testcase_sanity_checks', 'no_time_limit', 'no_validators', 'no_visualizer', 'open', 'order', 'order_from_ccs', 'overview', 'password', 'post_freeze', 'problem', 'problemname', 'remove', 'reorder', 'samples', 'sanitizer', 'skel', 'skip', 'sort', 'submissions', 'table', 'testcases', 'time_limit', 'timeout', 'token', 'tree', 'username', 'validation', 'watch', 'web', 'write']
+ARGS_LIST: Final = ['1', 'add', 'all', 'answer', 'api', 'author', 'check_deterministic', 'clean', 'colors', 'contest', 'contest_id', 'contestname', 'cp', 'default_solution', 'depth', 'directory', 'error', 'force', 'force_build', 'input', 'interaction', 'interactive', 'invalid', 'kattis', 'language', 'memory', 'more', 'move_to', 'no_bar', 'no_generate', 'no_solution', 'no_solutions', 'no_testcase_sanity_checks', 'no_time_limit', 'no_validators', 'no_visualizer', 'open', 'order', 'order_from_ccs', 'overview', 'password', 'post_freeze', 'problem', 'problemname', 'remove', 'reorder', 'samples', 'sanitizer', 'skel', 'skip', 'sort', 'submissions', 'table', 'testcases', 'time_limit', 'timeout', 'token', 'tree', 'username', 'validation', 'watch', 'web', 'write']
 # fmt: on
 
 
 def set_default_args():
     # Set default argument values.
-    for arg in args_list:
+    for arg in ARGS_LIST:
         if not hasattr(args, arg):
             setattr(args, arg, None)
-    for arg, value in default_args.items():
+    for arg, value in DEFAULT_ARGS.items():
         if not hasattr(args, arg):
             setattr(args, arg, value)
 
@@ -124,5 +124,5 @@ def set_default_args():
 
 
 # Randomly generated uuid4 for BAPCtools
-BAPC_UUID = "8ee7605a-d1ce-47b3-be37-15de5acd757e"
-BAPC_UUID_PREFIX = 8
+BAPC_UUID: Final = "8ee7605a-d1ce-47b3-be37-15de5acd757e"
+BAPC_UUID_PREFIX: Final = 8

bin/generate.py

@@ -7,7 +7,7 @@
 from collections.abc import Callable
 from colorama import Fore, Style
 from pathlib import Path, PurePosixPath
-from typing import overload
+from typing import Final, overload
 
 import config
 import parallel
@@ -40,7 +40,7 @@ def assert_type(name, obj, types, path=None):
     )
 
 
-UNIQUE_TESTCASE_KEYS = [
+UNIQUE_TESTCASE_KEYS: Final = [
     "copy",
     "generate",
     "retries",
@@ -88,8 +88,8 @@ def resolve_path(path, *, allow_absolute, allow_relative):
 # - SolutionInvocation
 # - VisualizerInvocation
 class Invocation:
-    SEED_REGEX = re.compile(r"\{seed(:[0-9]+)?\}")
-    NAME_REGEX = re.compile(r"\{name\}")
+    SEED_REGEX: Final = re.compile(r"\{seed(:[0-9]+)?\}")
+    NAME_REGEX: Final = re.compile(r"\{name\}")
 
     # `string` is the name of the submission (relative to generators/ or absolute from the problem root) with command line arguments.
     # A direct path may also be given.
@@ -318,7 +318,7 @@ def __init__(self, generator_config):
         super().__init__(generator_config.problem, default_solution_path(generator_config))
 
 
-KNOWN_TESTCASE_KEYS = [
+KNOWN_TESTCASE_KEYS: Final = [
     "type",
     "generate",
     "copy",
@@ -328,8 +328,8 @@ def __init__(self, generator_config):
     "retries",
     "count",
 ] + [e[1:] for e in config.KNOWN_TEXT_DATA_EXTENSIONS]
-RESERVED_TESTCASE_KEYS = ["data", "testdata.yaml", "include"]
-KNOWN_DIRECTORY_KEYS = [
+RESERVED_TESTCASE_KEYS: Final = ["data", "testdata.yaml", "include"]
+KNOWN_DIRECTORY_KEYS: Final = [
     "type",
     "data",
     "testdata.yaml",
@@ -339,9 +339,9 @@ def __init__(self, generator_config):
     "random_salt",
     "retries",
 ]
-RESERVED_DIRECTORY_KEYS = ["command"]
-KNOWN_ROOT_KEYS = ["generators", "parallel"]
-DEPRECATED_ROOT_KEYS = ["gitignore_generated"]
+RESERVED_DIRECTORY_KEYS: Final = ["command"]
+KNOWN_ROOT_KEYS: Final = ["generators", "parallel"]
+DEPRECATED_ROOT_KEYS: Final = ["gitignore_generated"]
 
 
 # Holds all inheritable configuration options. Currently:
@@ -372,7 +372,7 @@ def parse_random_salt(p, x, path):
             return ""
         return x
 
-    INHERITABLE_KEYS = [
+    INHERITABLE_KEYS: Final = [
         # True: use an AC submission by default when the solution: key is not present.
         ("solution", True, parse_solution),
         ("visualizer", None, parse_visualizer),
@@ -1413,7 +1413,7 @@ def parse_generators(generators_yaml):
         return generators
 
     # Only used at the root directory level.
-    ROOT_KEYS = [
+    ROOT_KEYS: Final = [
         ("generators", dict[Path, list[Path]](), parse_generators),
     ]
 

bin/interactive.py

@@ -3,7 +3,7 @@
 import subprocess
 import sys
 import threading
-from typing import Literal, Optional, TYPE_CHECKING
+from typing import Final, Literal, Optional, TYPE_CHECKING
 
 import config
 from util import *
@@ -13,7 +13,7 @@
 if TYPE_CHECKING:
     from run import Run
 
-BUFFER_SIZE = 2**20
+BUFFER_SIZE: Final = 2**20
 
 
 # Return a ExecResult object amended with verdict.

bin/latex.py

@@ -221,7 +221,7 @@ def make_environment() -> dict[str, str]:
         Path.cwd(),
         Path.cwd() / "solve_stats",
         Path.cwd() / "solve_stats" / "activity",
-        config.tools_root / "latex",
+        config.TOOLS_ROOT / "latex",
     ]
     texinputs = ""
     for p in latex_paths:
@@ -371,7 +371,7 @@ def build_problem_pdf(
 
     local_data = Path(main_file)
     copy_and_substitute(
-        local_data if local_data.is_file() else config.tools_root / "latex" / main_file,
+        local_data if local_data.is_file() else config.TOOLS_ROOT / "latex" / main_file,
         builddir / main_file,
         problem_data(problem, language),
     )
@@ -419,7 +419,7 @@ def find_logo() -> Path:
             logo = Path(directory + "logo." + extension)
             if logo.exists():
                 return logo
-    return config.tools_root / "latex" / "images" / "logo-not-found.pdf"
+    return config.TOOLS_ROOT / "latex" / "images" / "logo-not-found.pdf"
 
 
 def build_contest_pdf(
@@ -461,7 +461,7 @@ def build_contest_pdf(
         (
             local_contest_data
             if local_contest_data.is_file()
-            else config.tools_root / "latex" / "contest_data.tex"
+            else config.TOOLS_ROOT / "latex" / "contest_data.tex"
         ),
         builddir / "contest_data.tex",
         config_data,
@@ -482,7 +482,7 @@ def build_contest_pdf(
     per_problem_data_tex = (
         local_per_problem_data
         if local_per_problem_data.is_file()
-        else config.tools_root / "latex" / f"contest-{build_type.value}.tex"
+        else config.TOOLS_ROOT / "latex" / f"contest-{build_type.value}.tex"
     ).read_text()
 
     for prob in problems:

bin/problem.py

@@ -5,7 +5,7 @@
 
 from collections.abc import Callable
 from pathlib import Path
-from typing import Any, Literal, Optional, TYPE_CHECKING
+from typing import Any, Final, Literal, Optional, TYPE_CHECKING
 
 if TYPE_CHECKING:  # Prevent circular import: https://stackoverflow.com/a/39757388
     from program import Program
@@ -155,8 +155,8 @@ def is_legacy(self):
 
 # A problem.
 class Problem:
-    _SHORTNAME_REGEX_STRING = "^[a-z0-9]+$"
-    _SHORTNAME_REGEX = re.compile(_SHORTNAME_REGEX_STRING)
+    _SHORTNAME_REGEX_STRING: Final = "^[a-z0-9]+$"
+    _SHORTNAME_REGEX: Final = re.compile(_SHORTNAME_REGEX_STRING)
 
     def __init__(self, path: Path, tmpdir: Path, label: Optional[str] = None):
         # The problem name/shortname, which is the name of the directory and used as a display name.
@@ -678,7 +678,7 @@ def _validators(
         if cls == validate.OutputValidator and problem.settings.validation == "default":
             if paths:
                 error("Validation is default but custom output validator exists (ignoring it)")
-            paths = [config.tools_root / "support" / "default_output_validator.cpp"]
+            paths = [config.TOOLS_ROOT / "support" / "default_output_validator.cpp"]
 
         # TODO: Instead of checking file contents, maybe specify this in generators.yaml?
         def has_constraints_checking(f):

bin/program.py

@@ -3,7 +3,7 @@
 import stat
 import subprocess
 import threading
-from typing import TYPE_CHECKING
+from typing import Final, TYPE_CHECKING
 
 from colorama import Fore
 
@@ -12,7 +12,7 @@
 if TYPE_CHECKING:  # Prevent circular import: https://stackoverflow.com/a/39757388
     from problem import Problem
 
-EXTRA_LANGUAGES = """
+EXTRA_LANGUAGES: Final = """
 checktestdata:
     name: 'Checktestdata'
     priority: 1
@@ -33,7 +33,7 @@
     run: '{run}'
 """
 
-SANITIZER_FLAGS = """
+SANITIZER_FLAGS: Final = """
 cpp:
     compile: -fsanitize=undefined,address
 """
@@ -53,7 +53,7 @@ def languages():
         if Path("languages.yaml").is_file():
             _languages = read_yaml(Path("languages.yaml"))
         else:
-            _languages = read_yaml(config.tools_root / "config/languages.yaml")
+            _languages = read_yaml(config.TOOLS_ROOT / "config/languages.yaml")
 
         # Add custom languages.
         extra_langs = parse_yaml(EXTRA_LANGUAGES)
@@ -289,7 +289,7 @@ def _get_language(self, bar: ProgressBar):
                     self.tmpdir / "build" if (self.tmpdir / "build") in self.input_files else ""
                 ),
                 "run": self.tmpdir / "run",
-                "viva_jar": config.tools_root / "third_party/viva/viva.jar",
+                "viva_jar": config.TOOLS_ROOT / "third_party/viva/viva.jar",
             }
 
             return True

bin/skel.py

@@ -106,15 +106,15 @@ def new_contest():
     rights_owner = _ask_variable_string("rights owner", "author")
     title = title.replace("_", "-")
 
-    skeldir = config.tools_root / "skel/contest"
+    skeldir = config.TOOLS_ROOT / "skel/contest"
     log(f"Copying {skeldir} to {dirname}.")
     copytree_and_substitute(
         skeldir, Path(dirname), locals(), exist_ok=False, preserve_symlinks=False
     )
 
 
 def get_skel_dir(target_dir):
-    skeldir = config.tools_root / "skel/problem"
+    skeldir = config.TOOLS_ROOT / "skel/problem"
     preserve_symlinks = False
     if (target_dir / "skel/problem").is_dir():
         skeldir = target_dir / "skel/problem"
@@ -316,16 +316,16 @@ def create_gitlab_jobs(contest, problems):
     def problem_source_dir(problem):
         return problem.path.resolve().relative_to(Path("..").resolve())
 
-    header_yml = (config.tools_root / "skel/gitlab_ci/header.yaml").read_text()
+    header_yml = (config.TOOLS_ROOT / "skel/gitlab_ci/header.yaml").read_text()
     print(substitute(header_yml, locals()))
 
-    contest_yml = (config.tools_root / "skel/gitlab_ci/contest.yaml").read_text()
+    contest_yml = (config.TOOLS_ROOT / "skel/gitlab_ci/contest.yaml").read_text()
     changes = ""
     for problem in problems:
         changes += "      - " + str(problem_source_dir(problem)) + "/problem_statement/**/*\n"
     print(substitute(contest_yml, locals()))
 
-    problem_yml = (config.tools_root / "skel/gitlab_ci/problem.yaml").read_text()
+    problem_yml = (config.TOOLS_ROOT / "skel/gitlab_ci/problem.yaml").read_text()
     for problem_obj in problems:
         changesdir = problem_source_dir(problem_obj)
         problem = problem_obj.name