Linting

Author: monk-time

pyproject.toml

@@ -28,6 +28,8 @@ ignore = [
     "E731",    # lambda-assignment           (precludes a concise functional style)
     "PLC0415", # import-outside-top-level    (sometimes imports in a function are necessary)
     "PLR2004", # magic-value-comparison      (demands too many constants)
+    "DOC201",  # docstring-missing-returns   (excessive documentation)
+    "DOC402",  # docstring-missing-yields    (excessive documentation)
 ]
 allowed-confusables = [
     "а", "б", "в", "г", "е", "з", "и", "к", "м", "н", "о", "р", "с", "у", "ф", "х",

year2015/aoc20.py

@@ -13,7 +13,7 @@ def prime_powers_decomp(n):
     """
     if n <= 1:
         yield [1]
-        raise StopIteration
+        return
     # check powers of 2
     powers, cur_pow = [1], 1
     while n % 2 == 0:

year2018/aoc06_vis.py

@@ -31,6 +31,6 @@
 im = Image.new('RGB', IMG_SIZE, 'white')
 px = im.load()
 for x, y in grid:
-    px[x - min_x, y - min_y] = color_map[grid[(x, y)]]
+    px[x - min_x, y - min_y] = color_map[grid[x, y]]
 
 im.save('aoc06.png', 'PNG')

year2018/aoc15.py

@@ -45,17 +45,17 @@ def fromstring(cls, s: str, elf_power: int = 3):
                     power = elf_power if ch == 'E' else 3
                     unit = Unit((i, j), ch, power=power)
                     units.append(unit)
-                    map_[(i, j)] = unit
+                    map_[i, j] = unit
                 else:
-                    map_[(i, j)] = ch
+                    map_[i, j] = ch
         return cls(
             height=len(lines), width=len(lines[0]), map=map_, units=units
         )
 
     def __str__(self, *, hp: bool = False):
         """Get a text representation of the map."""
         map_ = [
-            ''.join(str(self.map[(i, j)]) for j in range(self.width))
+            ''.join(str(self.map[i, j]) for j in range(self.width))
             for i in range(self.height)
         ]
         if hp:

year2018/aoc22.py

@@ -31,10 +31,10 @@ def generate(self, extra: int = 0):
                 if y == 0
                 else y * 48271
                 if x == 0
-                else self.erosion[(y - 1, x)] * self.erosion[(y, x - 1)]
+                else self.erosion[y - 1, x] * self.erosion[y, x - 1]
             )
-            self.erosion[(y, x)] = (geoindex + self.depth) % 20183
-            self.cave[(y, x)] = '.=|'[self.erosion[(y, x)] % 3]
+            self.erosion[y, x] = (geoindex + self.depth) % 20183
+            self.cave[y, x] = '.=|'[self.erosion[y, x] % 3]
 
     def __str__(self):
         y_max, x_max = self.corner
@@ -44,7 +44,7 @@ def __str__(self):
                 if (y, x) == (0, 0)
                 else 'T'
                 if (y, x) == self.target
-                else self.cave[(y, x)]
+                else self.cave[y, x]
                 for x in range(x_max + 1)
             )
             for y in range(y_max + 1)
@@ -62,7 +62,7 @@ def adj(self, y: int, x: int) -> Iterable[Point]:
 def calc_risk(m: Map) -> int:
     y_t, x_t = m.target
     return sum(
-        '.=|'.index(m.cave[(y, x)])
+        '.=|'.index(m.cave[y, x])
         for y in range(y_t + 1)
         for x in range(x_t + 1)
     )

year2018/helpers.py

@@ -11,6 +11,9 @@ def read_puzzle(
 
     The number of the puzzle is determined by the filename of the caller,
     or can be specified explicitly.
+
+    Raises:
+        FileNotFoundError: if cannot find the puzzle file
     """
     if number:
         year_dir = Path(f'year{year}')

year2018/tests/test_aoc15.py

@@ -86,10 +86,10 @@ def st_move_big():
 def test_state_fromstring(st_sample):
     assert st_sample.height == 5
     assert st_sample.width == 7
-    assert st_sample.map[(0, 0)] == '#'
-    assert st_sample.map[(1, 1)] == '.'
-    assert st_sample.map[(1, 2)] == Unit((1, 2), 'G')
-    assert st_sample.map[(1, 4)] == Unit((1, 4), 'E')
+    assert st_sample.map[0, 0] == '#'
+    assert st_sample.map[1, 1] == '.'
+    assert st_sample.map[1, 2] == Unit((1, 2), 'G')
+    assert st_sample.map[1, 4] == Unit((1, 4), 'E')
     assert st_sample.units == [
         Unit((1, 2), 'G'),
         Unit((1, 4), 'E'),

year2018/tests/test_aoc20.py

@@ -12,10 +12,10 @@
 
 def test_parse_map():
     m = parse_map('^ENWWW$')
-    assert m[(0, -1)] == '#'
-    assert m[(0, 0)] == 'X'
-    assert m[(0, 1)] == '|'
-    assert m[(0, 2)] == '.'
+    assert m[0, -1] == '#'
+    assert m[0, 0] == 'X'
+    assert m[0, 1] == '|'
+    assert m[0, 2] == '.'
 
 
 samples = (

year2018/tests/test_aoc22.py

@@ -19,16 +19,16 @@ def test_map_init(sample):
     assert sample.depth == 510
     assert sample.target == (10, 10)
     assert len(sample.erosion.keys()) == 121
-    assert sample.erosion[(0, 0)] == 510
-    assert sample.erosion[(0, 1)] == 17317
-    assert sample.erosion[(1, 0)] == 8415
-    assert sample.erosion[(1, 1)] == 1805
-    assert sample.erosion[(10, 10)] == 510
-    assert sample.cave[(0, 0)] == '.'
-    assert sample.cave[(0, 1)] == '='
-    assert sample.cave[(1, 0)] == '.'
-    assert sample.cave[(1, 1)] == '|'
-    assert sample.cave[(10, 10)] == '.'
+    assert sample.erosion[0, 0] == 510
+    assert sample.erosion[0, 1] == 17317
+    assert sample.erosion[1, 0] == 8415
+    assert sample.erosion[1, 1] == 1805
+    assert sample.erosion[10, 10] == 510
+    assert sample.cave[0, 0] == '.'
+    assert sample.cave[0, 1] == '='
+    assert sample.cave[1, 0] == '.'
+    assert sample.cave[1, 1] == '|'
+    assert sample.cave[10, 10] == '.'
 
 
 def test_map_str(sample):

year2019/aoc13.py

@@ -28,8 +28,8 @@ def read_tiles(program: Intcode) -> TileMap:
     tiles = {}
     while True:
         try:
-            x, y, tile_id = [next(gen) for _ in range(3)]  # noqa: UP027
-            tiles[(x, y)] = Tile.from_index(tile_id)
+            x, y, tile_id = [next(gen) for _ in range(3)]
+            tiles[x, y] = Tile.from_index(tile_id)
         except StopIteration:
             return tiles
 
@@ -39,7 +39,7 @@ def print_tiles(tiles: TileMap):
     height = max(y for _, y in tiles) + 1  # coords are 0-based
     width = max(x for x, _ in tiles) + 1
     line = '\n'.join(
-        ''.join(tiles[(x, y)] for x in range(width)) for y in range(height)
+        ''.join(tiles[x, y] for x in range(width)) for y in range(height)
     )
     print(line)
 
@@ -73,7 +73,7 @@ def run_game(program: Intcode):
             if (x, y) == (-1, 0):
                 score = tile_id
                 continue
-            tiles[(x, y)] = Tile.from_index(tile_id)
+            tiles[x, y] = Tile.from_index(tile_id)
         except StopIteration:
             return score
 

year2019/aoc17.py

@@ -55,7 +55,7 @@ def render_tiles(tiles: TileMap) -> list[str]:
     height = max(y for _, y in tiles) + 1  # coords are 0-based
     width = max(x for x, _ in tiles) + 1
     return [
-        ''.join(tiles[(x, y)] for x in range(width)) for y in range(height)
+        ''.join(tiles[x, y] for x in range(width)) for y in range(height)
     ]
 
 

year2019/helpers.py

@@ -11,6 +11,9 @@ def read_puzzle(
 
     The number of the puzzle is determined by the filename of the caller,
     or can be specified explicitly.
+
+    Raises:
+        FileNotFoundError: if cannot find the puzzle file
     """
     if number:
         year_dir = Path(f'year{year}')

year2019/intcode.py

@@ -30,16 +30,17 @@ def __post_init__(self):
             self.program = defaultdict(lambda: 0, enumerate(self.program))
 
     def __iter__(self) -> Generator[int, int, None]:
-        """Execute the Intcode program."""
+        """Execute the Intcode program.
+
+        Raises:
+            UnknownOpCodeError: if encountered an unknown op code
+        """
         while True:
             op = self.program[self.pointer] % 100
             match op:
                 case 1 | 2:  # add, multiply
                     a, b, c = self.get_parameters(3)  # type: ignore
-                    if op == 1:
-                        self.program[c] = a + b
-                    else:
-                        self.program[c] = a * b
+                    self.program[c] = a + b if op == 1 else a * b
                     self.pointer += 4
                 case 3:  # input
                     a = self.program[self.pointer + 1]
@@ -51,19 +52,14 @@ def __iter__(self) -> Generator[int, int, None]:
                     a: int = self.get_parameters(1)  # type: ignore
                     self.pointer += 2
                     yield a
-                case 5:  # jump-if-true
-                    a, b = self.get_parameters(2)  # type: ignore
-                    self.pointer = b if a else self.pointer + 3
-                case 6:  # jump-if-false
+                case 5 | 6:  # jump-if-true, jump-if-false
                     a, b = self.get_parameters(2)  # type: ignore
-                    self.pointer = b if not a else self.pointer + 3
-                case 7:  # less than
-                    a, b, c = self.get_parameters(3)  # type: ignore
-                    self.program[c] = 1 if a < b else 0
-                    self.pointer += 4
-                case 8:  # equals
+                    cond = a if op == 5 else not a
+                    self.pointer = b if cond else self.pointer + 3
+                case 7 | 8:  # less than, equals
                     a, b, c = self.get_parameters(3)  # type: ignore
-                    self.program[c] = 1 if a == b else 0
+                    cond = a < b if op == 7 else a == b
+                    self.program[c] = 1 if cond else 0
                     self.pointer += 4
                 case 9:  # relative base offset
                     a: int = self.get_parameters(1)  # type: ignore