Lint Python code with ruff instead of flake8

Author: cclauss

.circleci/config.yml

@@ -17,12 +17,9 @@ jobs:
     steps:
       - checkout
       - run: python --version ; pip --version ; pwd ; ls -l
-      - run: pip install black codespell flake8 ruff
+      - run: pip install black codespell ruff
       - run: codespell -L queenland,uint
-      # stop the build if there are Python syntax errors or undefined names
-      - run: flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-      # exit-zero treats all errors as warnings.  The GitHub editor is 127 chars wide
-      - run: flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - run: ruff .
       - run: black . --check
 
 

STYLE_GUIDE.rst

@@ -1,12 +1,11 @@
 STYLE GUIDE
 ==============
 
-As a rough style guide, please lint your code with black, codespell, and flake8::
+As a rough style guide, please lint your code with black, codespell, and ruff::
 
-    pip install black codespell flake8
+    pip install black codespell ruff
     codespell -L queenland,uint
-    flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-    flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    ruff .
     black . --check
 
 More up-to-date checks may be detailed in `.circleci/config.yml`.

docs/source/conf.py

@@ -10,7 +10,9 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import os
+import sys
+
 import sc2reader
 
 autodoc_member_order = "bysource"

examples/sc2autosave.py

@@ -192,8 +192,9 @@ def run(args):
                 replay = sc2reader.load_replay(path, load_level=2)
             except KeyboardInterrupt:
                 raise
-            except:
+            except Exception as e:
                 # Failure to parse
+                args.log.write(f"{e!r}")
                 file_name = os.path.basename(path)
                 directory = make_directory(args, ("parse_error",))
                 new_path = os.path.join(directory, file_name)

ruff.toml

@@ -0,0 +1,8 @@
+ignore = [
+    "E402",  # Module level import not at top of file
+    "F401",  # module imported but unused; consider using `importlib.util.find_spec` to test for availability
+    "F403",  # Run `removestar` on this codebase
+    "F405",  # Run `removestar` on this codebase
+    "F841",  # Run `ruff --select=F841 --fix .`
+]
+line-length=129

sc2reader/engine/plugins/context.py

@@ -263,7 +263,7 @@ def handleUnitTypeChangeEvent(self, event, replay):
             replay.datapack.change_type(event.unit, event.unit_type_name, event.frame)
         else:
             self.logger.error(
-                "Unit {} type changed at {} [{}] before it was born!".format(
+                "Unit {} type changed at {} before it was born!".format(
                     event.unit_id, Length(seconds=event.second)
                 )
             )

sc2reader/engine/plugins/selection.py

@@ -76,7 +76,9 @@ def _deselect(self, selection, mode, data):
 
         if mode == "Mask":
             # Deselect objects according to deselect mask
-            sfilter = lambda bit_u: not bit_u[0]
+            def sfilter(bit_u):
+                return not bit_u[0]
+
             mask = data + [False] * (selection_size - data_size)
             new_selection = [u for (bit, u) in filter(sfilter, zip(mask, selection))]
             error = data_size > selection_size

sc2reader/factories/plugins/replay.py

@@ -85,7 +85,6 @@ def toDict(replay):
         "is_ladder": getattr(replay, "is_ladder", False),
         "is_private": getattr(replay, "is_private", False),
         "filename": getattr(replay, "filename", None),
-        "file_time": getattr(replay, "file_time", None),
         "frames": getattr(replay, "frames", None),
         "build": getattr(replay, "build", None),
         "release": getattr(replay, "release_string", None),

sc2reader/factories/sc2factory.py

@@ -266,13 +266,13 @@ def load_remote_resource_contents(self, remote_resource, **options):
         return resource
 
     def cache_has(self, cache_key):
-        raise NotImplemented()
+        raise NotImplementedError()
 
     def cache_get(self, cache_key):
-        raise NotImplemented()
+        raise NotImplementedError()
 
     def cache_set(self, cache_key, value):
-        raise NotImplemented()
+        raise NotImplementedError()
 
 
 class FileCachedSC2Factory(CachedSC2Factory):

sc2reader/resources.py

@@ -1491,8 +1491,8 @@ def __init__(self, header_file, filename=None, **options):
 
         # Parse localization hashes
         l18n_struct = self.data[0][4][8]
-        for l in l18n_struct:
-            parsed_hash = utils.parse_hash(l[1][0])
-            self.localization_urls[l[0]] = utils.get_resource_url(
+        for h in l18n_struct:
+            parsed_hash = utils.parse_hash(h[1][0])
+            self.localization_urls[h[0]] = utils.get_resource_url(
                 parsed_hash["server"], parsed_hash["hash"], parsed_hash["type"]
             )