Use ruff to lint

Author: AngheloAlf

.github/workflows/linting.yml

@@ -0,0 +1,53 @@
+name: Linting
+
+# Build on every branch push, tag push, and pull request change:
+on: [push, pull_request]
+
+jobs:
+  mypy:
+    name: mypy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout reposistory
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Install Dependencies
+        run: |
+          python3 -m pip install -r requirements.txt
+          python3 -m pip install -U maturin
+          python3 -m pip install -U mypy
+
+      - name: mypy
+        run: mypy --show-column-numbers --hide-error-context .
+
+  ruff:
+    runs-on: ubuntu-latest
+    name: ruff
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+
+      - name: Setup venv
+        run: |
+          python3 -m venv .venv
+
+      - name: Install Dependencies
+        run: |
+          . .venv/bin/activate
+          python3 -m pip install -U -r requirements.txt
+          python3 -m pip install -U ruff
+
+      - name: mypy
+        run: |
+          . .venv/bin/activate
+          ruff check

.github/workflows/mypy.yml

@@ -170,3 +170,5 @@ cython_debug/
 # Added by cargo
 
 /target
+
+.ruff_cache/

.gitignore

@@ -15,9 +15,9 @@ This library is available for Python3 and Rust
 
 - Fast parsing written in Rust.
 - Support map formats:
-  - GNU ld
-  - clang lld
-  - Metrowerks ld
+  - `GNU ld`.
+  - `clang lld`.
+  - `Metrowerks ld`.
 - Built-in cli utilities to process the parsed map file (see [Examples](#examples)).
 
 ## Installing

README.md

@@ -24,5 +24,6 @@
 
 from . import frontends as frontends
 
-# Renamed types
-from .mapfile import Section as File
+# Renamed types.
+# TODO: remove on version 3.0
+File = Section

src/mapfile_parser/__init__.py

@@ -15,7 +15,7 @@ def mapfileParserMain():
     decompConfig: decomp_settings.Config|None
     try:
         decompConfig = decomp_settings.scan_for_config()
-    except:
+    except Exception:
         decompConfig = None
 
     description = description="""\

src/mapfile_parser/__main__.py

@@ -53,8 +53,8 @@ def printSymbolComparisonAsCsv(comparisonInfo: mapfile.MapsComparisonInfo, print
         symbolState = "BAD"
         if symbolInfo.diff == 0:
             symbolState = "GOOD"
-            if not buildFile in comparisonInfo.badFiles and not expectedFile in comparisonInfo.badFiles:
-                if not buildFile in comparisonInfo.badFiles and not expectedFile in comparisonInfo.badFiles:
+            if buildFile not in comparisonInfo.badFiles and expectedFile not in comparisonInfo.badFiles:
+                if buildFile not in comparisonInfo.badFiles and expectedFile not in comparisonInfo.badFiles:
                     if not printAll:
                         continue
 
@@ -88,8 +88,8 @@ def printSymbolComparisonAsListing(comparisonInfo: mapfile.MapsComparisonInfo, p
         symbolState = "BAD"
         if symbolInfo.diff == 0:
             symbolState = "GOOD"
-            if not buildFile in comparisonInfo.badFiles and not expectedFile in comparisonInfo.badFiles:
-                if not buildFile in comparisonInfo.badFiles and not expectedFile in comparisonInfo.badFiles:
+            if buildFile not in comparisonInfo.badFiles and expectedFile not in comparisonInfo.badFiles:
+                if buildFile not in comparisonInfo.badFiles and expectedFile not in comparisonInfo.badFiles:
                     if not printAll:
                         continue
 

src/mapfile_parser/frontends/bss_check.py

@@ -877,7 +877,7 @@ def findLowestDifferingSymbol(self, otherMapFile: MapFile) -> tuple[Symbol, Sect
             # We want to check the previous section, not the current one,
             # since we already know the current one doesn't have a symbol
             # preceding the one we found.
-            j -= 1;
+            j -= 1
 
             while i >= 0:
                 builtSegment = self[i]
@@ -916,7 +916,7 @@ def getProgress(self, asmPath: Path, nonmatchings: Path, aliases: dict[str, str]
         progressPerFolder: dict[str, ProgressStats] = dict()
 
         if self.debugging:
-            utils.eprint(f"getProgress():")
+            utils.eprint("getProgress():")
 
         for segment in self._segmentsList:
             for section in segment:
@@ -965,22 +965,22 @@ def getProgress(self, asmPath: Path, nonmatchings: Path, aliases: dict[str, str]
                         totalStats.undecompedSize += symSize
                         progressPerFolder[folder].undecompedSize += symSize
                         if self.debugging:
-                            utils.eprint(f" the whole section is undecomped (no individual function files exist yet)")
+                            utils.eprint(" the whole section is undecomped (no individual function files exist yet)")
                     elif self.findSymbolByName(f"{func.name}.NON_MATCHING") is not None:
                         totalStats.undecompedSize += symSize
                         progressPerFolder[folder].undecompedSize += symSize
                         if self.debugging:
-                            utils.eprint(f" the function hasn't been matched yet (there's a `.NON_MATCHING` symbol with the same name)")
+                            utils.eprint(" the function hasn't been matched yet (there's a `.NON_MATCHING` symbol with the same name)")
                     elif checkFunctionFiles and funcAsmPath.exists():
                         totalStats.undecompedSize += symSize
                         progressPerFolder[folder].undecompedSize += symSize
                         if self.debugging:
-                            utils.eprint(f" the function hasn't been matched yet (the function section still exists)")
+                            utils.eprint(" the function hasn't been matched yet (the function section still exists)")
                     else:
                         totalStats.decompedSize += symSize
                         progressPerFolder[folder].decompedSize += symSize
                         if self.debugging:
-                            utils.eprint(f" the function is matched! (the function section was not found)")
+                            utils.eprint(" the function is matched! (the function section was not found)")
 
         return totalStats, progressPerFolder
 
@@ -1111,7 +1111,7 @@ def toCsv(self, printVram: bool=True, skipWithoutSymbols: bool=True) -> str:
         return ret
 
     def toCsvSymbols(self) -> str:
-        ret = f"Section," + Symbol.toCsvHeader() + "\n"
+        ret = "Section," + Symbol.toCsvHeader() + "\n"
 
         for segment in self._segmentsList:
             ret += segment.toCsvSymbols()