Enable various ruff rules

This commit enables a bunch of unrelated ruff rules, which only require
minimal changes to the code base to enable them.

The rules enabled by this commit are:

- check the use of datetime objects without timezone (DTZ005)
- check the performance of try-except in loops (PERF203)
- check the number of function arguments (PLR0913)
- check for mutable class defaults (RUF012)
- check for the use of secure hashing algorithms (S324)
- check for raising base exceptions (TRY002)
- check for raising other exceptions where TypeErrors should be raised
  (TRY004)

.gitea/CODEOWNERS

@@ -3,6 +3,7 @@
 \\.gitea/.* @Stan @Itms
 ## Linting
 \\.pre-commit-config\\.yaml @Dunedan
+ruff\\.toml @Dunedan
 
 ## == Build & Libraries
 (build|libraries)/.* @Itms @Stan

ruff.toml

@@ -10,36 +10,29 @@ ignore = [
     "C90",
     "COM812",
     "D10",
-    "DTZ005",
     "EM",
     "FA",
     "FIX",
     "FBT",
     "ISC001",
-    "N",
-    "PERF203",
+    "N817",
     "PERF401",
     "PLR0912",
-    "PLR0913",
     "PLR0915",
     "PLR2004",
     "PLW2901",
     "PT",
     "PTH",
-    "RUF012",
     "S101",
     "S310",
     "S314",
-    "S324",
     "S320",
     "S603",
     "S607",
     "T20",
     "TD002",
     "TD003",
-    "TRY002",
     "TRY003",
-    "TRY004",
     "UP038",
     "W505"
 ]
@@ -52,3 +45,6 @@ max-doc-length = 72
 
 [lint.pydocstyle]
 convention = "pep257"
+
+[lint.pylint]
+max-args = 8

source/tools/entity/checkrefs.py

@@ -387,8 +387,8 @@ class CheckRefs:
 
                 cmp_auras = entity.find("Auras")
                 if cmp_auras is not None:
-                    auraString = cmp_auras.text
-                    for aura in auraString.split():
+                    aura_string = cmp_auras.text
+                    for aura in aura_string.split():
                         if not aura:
                             continue
                         if aura.startswith("-"):
@@ -397,33 +397,33 @@ class CheckRefs:
 
                 cmp_identity = entity.find("Identity")
                 if cmp_identity is not None:
-                    reqTag = cmp_identity.find("Requirements")
-                    if reqTag is not None:
+                    req_tag = cmp_identity.find("Requirements")
+                    if req_tag is not None:
 
-                        def parse_requirements(fp, req, recursionDepth=1):
-                            techsTag = req.find("Techs")
-                            if techsTag is not None:
-                                for techTag in techsTag.text.split():
+                        def parse_requirements(fp, req, recursion_depth=1):
+                            techs_tag = req.find("Techs")
+                            if techs_tag is not None:
+                                for tech_tag in techs_tag.text.split():
                                     self.deps.append(
-                                        (fp, Path(f"simulation/data/technologies/{techTag}.json"))
+                                        (fp, Path(f"simulation/data/technologies/{tech_tag}.json"))
                                     )
 
-                            if recursionDepth > 0:
-                                recursionDepth -= 1
-                                allReqTag = req.find("All")
-                                if allReqTag is not None:
-                                    parse_requirements(fp, allReqTag, recursionDepth)
-                                anyReqTag = req.find("Any")
-                                if anyReqTag is not None:
-                                    parse_requirements(fp, anyReqTag, recursionDepth)
+                            if recursion_depth > 0:
+                                recursion_depth -= 1
+                                all_req_tag = req.find("All")
+                                if all_req_tag is not None:
+                                    parse_requirements(fp, all_req_tag, recursion_depth)
+                                any_req_tag = req.find("Any")
+                                if any_req_tag is not None:
+                                    parse_requirements(fp, any_req_tag, recursion_depth)
 
-                        parse_requirements(fp, reqTag)
+                        parse_requirements(fp, req_tag)
 
                 cmp_researcher = entity.find("Researcher")
                 if cmp_researcher is not None:
-                    techString = cmp_researcher.find("Technologies")
-                    if techString is not None:
-                        for tech in techString.text.split():
+                    tech_string = cmp_researcher.find("Technologies")
+                    if tech_string is not None:
+                        for tech in tech_string.text.split():
                             if not tech:
                                 continue
                             if tech.startswith("-"):

source/tools/fontbuilder2/font_loader.py

@@ -1,7 +1,10 @@
 # Adapted from http://cairographics.org/freetypepython/
 
+# ruff: noqa: TRY002
+
 import ctypes
 import sys
+from typing import ClassVar
 
 import cairo
 
@@ -40,7 +43,7 @@ _surface = cairo.ImageSurface(cairo.FORMAT_A8, 0, 0)
 
 
 class PycairoContext(ctypes.Structure):
-    _fields_ = [
+    _fields_: ClassVar = [
         ("PyObject_HEAD", ctypes.c_byte * object.__basicsize__),
         ("ctx", ctypes.c_void_p),
         ("base", ctypes.c_void_p),

source/tools/i18n/i18n_helper/catalog.py

@@ -1,6 +1,6 @@
 """Wrapper around babel Catalog / .po handling."""
 
-from datetime import datetime
+from datetime import datetime, timezone
 
 from babel.messages.catalog import Catalog as BabelCatalog
 from babel.messages.pofile import read_po, write_po
@@ -10,7 +10,7 @@ class Catalog(BabelCatalog):
     """Wraps a BabelCatalog for convenience."""
 
     def __init__(self, *args, project=None, copyright_holder=None, **other_kwargs):
-        date = datetime.now()
+        date = datetime.now(tz=timezone.utc)
         super().__init__(
             *args,
             header_comment=(

source/tools/mapcompatibility/a18_to_a19.py

@@ -56,13 +56,13 @@ args = parser.parse_args()
 
 HEIGHTMAP_BIT_SHIFT = 3
 
-for xmlFile in args.files:
-    pmpFile = xmlFile[:-3] + "pmp"
+for xml_file in args.files:
+    pmp_file = xml_file[:-3] + "pmp"
 
-    print("Processing " + xmlFile + " ...")
+    print("Processing " + xml_file + " ...")
 
-    if os.path.isfile(pmpFile):
-        with open(pmpFile, "rb") as f1, open(pmpFile + "~", "wb") as f2:
+    if os.path.isfile(pmp_file):
+        with open(pmp_file, "rb") as f1, open(pmp_file + "~", "wb") as f2:
             # 4 bytes PSMP to start the file
             f2.write(f1.read(4))
 
@@ -73,7 +73,7 @@ for xmlFile in args.files:
             elif args.reverse:
                 if version != 6:
                     print(
-                        f"Warning: File {pmpFile} was not at version 6, while a negative version "
+                        f"Warning: File {pmp_file} was not at version 6, while a negative version "
                         f"bump was requested.\nABORTING ..."
                     )
                     continue
@@ -81,7 +81,7 @@ for xmlFile in args.files:
             else:
                 if version != 5:
                     print(
-                        f"Warning: File {pmpFile} was not at version 5, while a version bump was "
+                        f"Warning: File {pmp_file} was not at version 5, while a version bump was "
                         f"requested.\nABORTING ..."
                     )
                     continue
@@ -122,13 +122,13 @@ for xmlFile in args.files:
             f1.close()
 
         # replace the old file, comment to see both files
-        os.remove(pmpFile)
-        os.rename(pmpFile + "~", pmpFile)
+        os.remove(pmp_file)
+        os.rename(pmp_file + "~", pmp_file)
 
-    if os.path.isfile(xmlFile):
+    if os.path.isfile(xml_file):
         with (
-            open(xmlFile, encoding="utf-8") as f1,
-            open(xmlFile + "~", "w", encoding="utf-8") as f2,
+            open(xml_file, encoding="utf-8") as f1,
+            open(xml_file + "~", "w", encoding="utf-8") as f2,
         ):
             data = f1.read()
 
@@ -137,7 +137,7 @@ for xmlFile in args.files:
                 if args.reverse:
                     if data.find('<Scenario version="6">') == -1:
                         print(
-                            f"Warning: File {xmlFile} was not at version 6, while a negative "
+                            f"Warning: File {xml_file} was not at version 6, while a negative "
                             f"version bump was requested.\nABORTING ..."
                         )
                         sys.exit()
@@ -145,7 +145,7 @@ for xmlFile in args.files:
                         data = data.replace('<Scenario version="6">', '<Scenario version="5">')
                 elif data.find('<Scenario version="5">') == -1:
                     print(
-                        f"Warning: File {xmlFile} was not at version 5, while a version bump "
+                        f"Warning: File {xml_file} was not at version 5, while a version bump "
                         f"was requested.\nABORTING ..."
                     )
                     sys.exit()
@@ -164,5 +164,5 @@ for xmlFile in args.files:
             f2.close()
 
         # replace the old file, comment to see both files
-        os.remove(xmlFile)
-        os.rename(xmlFile + "~", xmlFile)
+        os.remove(xml_file)
+        os.rename(xml_file + "~", xml_file)

source/tools/rlclient/python/README.md

@@ -58,4 +58,4 @@ actions = [zero_ad.actions.attack(my_units, enemy_units[0])]
 state = game.step(actions)
 ```
 
-For a more thorough example, check out samples/simple-example.py!
+For a more thorough example, check out samples/simple_example.py!

source/tools/spirv/compile.py

@@ -29,6 +29,7 @@ import os
 import subprocess
 import sys
 import xml.etree.ElementTree as ET
+from enum import Enum
 
 import yaml
 
@@ -46,7 +47,7 @@ def execute(command):
 def calculate_hash(path):
     assert os.path.isfile(path)
     with open(path, "rb") as handle:
-        return hashlib.sha1(handle.read()).hexdigest()
+        return hashlib.sha256(handle.read()).hexdigest()
 
 
 def compare_spirv(path1, path2):
@@ -169,18 +170,21 @@ def compile_and_reflect(input_mod_path, dependencies, stage, path, out_path, def
         add_push_constants(module["push_constants"][0], push_constants)
     descriptor_sets = []
     if module.get("descriptor_sets"):
-        VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER = 1
-        VK_DESCRIPTOR_TYPE_STORAGE_IMAGE = 3
-        VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER = 6
-        VK_DESCRIPTOR_TYPE_STORAGE_BUFFER = 7
+
+        class VkDescriptorType(Enum):
+            COMBINED_IMAGE_SAMPLER = 1
+            STORAGE_IMAGE = 3
+            UNIFORM_BUFFER = 6
+            STORAGE_BUFFER = 7
+
         for descriptor_set in module["descriptor_sets"]:
-            UNIFORM_SET = 1 if use_descriptor_indexing else 0
-            STORAGE_SET = 2
+            uniform_set = 1 if use_descriptor_indexing else 0
+            storage_set = 2
             bindings = []
-            if descriptor_set["set"] == UNIFORM_SET:
+            if descriptor_set["set"] == uniform_set:
                 assert descriptor_set["binding_count"] > 0
                 for binding in descriptor_set["bindings"]:
-                    assert binding["set"] == UNIFORM_SET
+                    assert binding["set"] == uniform_set
                     block = binding["block"]
                     members = []
                     for member in block["members"]:
@@ -200,15 +204,15 @@ def compile_and_reflect(input_mod_path, dependencies, stage, path, out_path, def
                         }
                     )
                 binding = descriptor_set["bindings"][0]
-                assert binding["descriptor_type"] == VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER
-            elif descriptor_set["set"] == STORAGE_SET:
+                assert binding["descriptor_type"] == VkDescriptorType.UNIFORM_BUFFER.value
+            elif descriptor_set["set"] == storage_set:
                 assert descriptor_set["binding_count"] > 0
                 for binding in descriptor_set["bindings"]:
                     is_storage_image = (
-                        binding["descriptor_type"] == VK_DESCRIPTOR_TYPE_STORAGE_IMAGE
+                        binding["descriptor_type"] == VkDescriptorType.STORAGE_IMAGE.value
                     )
                     is_storage_buffer = (
-                        binding["descriptor_type"] == VK_DESCRIPTOR_TYPE_STORAGE_BUFFER
+                        binding["descriptor_type"] == VkDescriptorType.STORAGE_BUFFER.value
                     )
                     assert is_storage_image or is_storage_buffer
                     assert (
@@ -217,13 +221,13 @@ def compile_and_reflect(input_mod_path, dependencies, stage, path, out_path, def
                     )
                     assert binding["image"]["arrayed"] == 0
                     assert binding["image"]["ms"] == 0
-                    bindingType = "storageImage"
+                    binding_type = "storageImage"
                     if is_storage_buffer:
-                        bindingType = "storageBuffer"
+                        binding_type = "storageBuffer"
                     bindings.append(
                         {
                             "binding": binding["binding"],
-                            "type": bindingType,
+                            "type": binding_type,
                             "name": binding["name"],
                         }
                     )
@@ -232,7 +236,8 @@ def compile_and_reflect(input_mod_path, dependencies, stage, path, out_path, def
                     assert descriptor_set["binding_count"] >= 1
                     for binding in descriptor_set["bindings"]:
                         assert (
-                            binding["descriptor_type"] == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
+                            binding["descriptor_type"]
+                            == VkDescriptorType.COMBINED_IMAGE_SAMPLER.value
                         )
                         assert binding["array"]["dims"][0] == 16384
                         if binding["binding"] == 0:
@@ -246,7 +251,9 @@ def compile_and_reflect(input_mod_path, dependencies, stage, path, out_path, def
             else:
                 assert descriptor_set["binding_count"] > 0
                 for binding in descriptor_set["bindings"]:
-                    assert binding["descriptor_type"] == VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
+                    assert (
+                        binding["descriptor_type"] == VkDescriptorType.COMBINED_IMAGE_SAMPLER.value
+                    )
                     assert binding["image"]["sampled"] == 1
                     assert binding["image"]["arrayed"] == 0
                     assert binding["image"]["ms"] == 0

source/tools/xmlvalidator/validate_grammar.py

@@ -21,7 +21,7 @@ class SingleLevelFilter(Filter):
         return record.levelno == self.passlevel
 
 
-class VFS_File:
+class VFSFile:
     def __init__(self, mod_name, vfs_path):
         self.mod_name = mod_name
         self.vfs_path = vfs_path
@@ -198,10 +198,8 @@ class RelaxNGValidator:
         relaxng = lxml.etree.RelaxNG(data)
         error_count = 0
         for file in sorted(files):
-            try:
-                doc = lxml.etree.parse(str(file[1]))
-                relaxng.assertValid(doc)
-            except Exception:
+            doc = lxml.etree.parse(str(file[1]))
+            if not relaxng.validate(doc):
                 error_count = error_count + 1
                 self.logger.exception(file[1])