enable ruff format checks and reformat unconforming files (Metta-AI#267)

### TL;DR Added `ruff format --check` to CI workflow and pre-commit hook, and fixed formatting issues across the codebase. ### What changed? - Added `ruff format --check` command to the GitHub Actions build workflow - Added `ruff format --check` to the pre-commit hook to ensure code is properly formatted before commits - Fixed formatting issues across multiple files ### How to test? 1. Run `ruff format --check .` to verify all files are properly formatted 2. Make a commit to ensure the pre-commit hook correctly checks formatting 3. Push changes to verify the GitHub Actions workflow passes with the new format check ### Why make this change? This change enforces consistent code formatting across the codebase, making it more readable and maintainable. By adding format checking to both the pre-commit hook and CI workflow, we ensure that all code contributions adhere to the same formatting standards, reducing style-related merge conflicts and code review comments.

Author: berekuk

.github/workflows/build.yml

@@ -75,6 +75,7 @@ jobs:
  source venv/bin/activate
  pip install ruff==0.11.5
  ruff check --respect-gitignore .
+ ruff format --check .
 
  - name: Run tests in /tests
  env:

deps/mettagrid/mettagrid/config/room/maze.py

@@ -13,7 +13,7 @@ class MazePrim(Room):
  def __init__(
  self, width, height, start_pos, end_pos, branching=0.0, seed=None, border_width=0, border_object="wall"
  ):
- super().__init__(border_width=border_width, border_object=border_object, labels = ["maze"])
+ super().__init__(border_width=border_width, border_object=border_object, labels=["maze"])
  self._rng = random.Random(seed)
  self._width = width if width % 2 == 1 else width - 1
  self._height = height if height % 2 == 1 else height - 1

deps/mettagrid/mettagrid/config/room/mean_distance.py

@@ -19,7 +19,7 @@ def __init__(
  border_width: int = 0,
  border_object: str = "wall",
  ):
- super().__init__(border_width=border_width, border_object=border_object, labels = ["mean_distance"])
+ super().__init__(border_width=border_width, border_object=border_object, labels=["mean_distance"])
  logger = logging.getLogger(__name__)
 
  self._rng = np.random.default_rng(seed)

deps/mettagrid/mettagrid/config/room/navigation/cylinder_world.py

@@ -23,7 +23,7 @@ def __init__(
  border_object: str = "wall",
  team: str | None = None,
  ):
- super().__init__(border_width=border_width, border_object=border_object, labels = ["cylinder_world"])
+ super().__init__(border_width=border_width, border_object=border_object, labels=["cylinder_world"])
  self._rng = np.random.default_rng(seed)
  width, height = np.random.randint(40, 100), np.random.randint(40, 100)
  self._width, self._height = width, height
@@ -33,6 +33,7 @@ def __init__(
  self._occ = np.zeros((height, width), dtype=bool)
 
  self.set_size_labels(width, height)
+
  # ------------------------------------------------------------------ #
  # Public build
  # ------------------------------------------------------------------ #
@@ -62,7 +63,6 @@ def _build_cylinder_world(self) -> np.ndarray:
  else:
  fails += 1 # try a different size/orientation
 
-
  # Finally, spawn any requested agents on leftover empty cells
  grid = self._place_agents(grid)
  return grid

deps/mettagrid/mettagrid/config/room/navigation/terrain_from_numpy.py

@@ -55,8 +55,14 @@ class TerrainFromNumpy(Room):
  """
 
  def __init__(
- self, dir, border_width: int = 0, border_object: str = "wall", num_agents: int = 10,
- generators: bool = False, file: str | None = None, team: str | None = None
+ self,
+ dir,
+ border_width: int = 0,
+ border_object: str = "wall",
+ num_agents: int = 10,
+ generators: bool = False,
+ file: str | None = None,
+ team: str | None = None,
  ):
  zipped_dir = dir + ".zip"
  lock_path = zipped_dir + ".lock"
@@ -75,7 +81,7 @@ def __init__(
  self.generators = generators
  self.uri = file
  self.team = team
- super().__init__(border_width=border_width, border_object=border_object, labels = ["terrain"])
+ super().__init__(border_width=border_width, border_object=border_object, labels=["terrain"])
 
  def get_valid_positions(self, level):
  valid_positions = []
@@ -113,7 +119,7 @@ def _build(self):
  else:
  level[pos] = "agent." + self.team
  area = level.shape[0] * level.shape[1]
- num_hearts = area // 180 #random.randint(66, 180)
+ num_hearts = area // 180  # random.randint(66, 180)
  # Find valid empty spaces surrounded by empty
  valid_positions = self.get_valid_positions(level)
 

deps/mettagrid/mettagrid/config/room/navigation/varied_terrain.py

@@ -29,44 +29,44 @@ class VariedTerrain(Room):
  STYLE_PARAMETERS = {
  "all-sparse": {
  "hearts_count": 15,
- "large_obstacles": {"size_range": [10, 25], "count": [0,2]},
- "small_obstacles": {"size_range": [3, 6], "count": [0,2]},
- "crosses": {"count": [0,2]},
- "labyrinths": {"count": [0,2]},
- "scattered_walls": {"count": [0,2]},
- "blocks": {"count": [0,2]},
- "clumpiness": [0,2],
+ "large_obstacles": {"size_range": [10, 25], "count": [0, 2]},
+ "small_obstacles": {"size_range": [3, 6], "count": [0, 2]},
+ "crosses": {"count": [0, 2]},
+ "labyrinths": {"count": [0, 2]},
+ "scattered_walls": {"count": [0, 2]},
+ "blocks": {"count": [0, 2]},
+ "clumpiness": [0, 2],
  },
  "balanced": {
  "hearts_count": 75,
- "large_obstacles": {"size_range": [10, 25], "count": [3,7]},
- "small_obstacles": {"size_range": [3, 6], "count": [3,7]},
- "crosses": {"count": [3,7]},
- "labyrinths": {"count": [3,7]},
- "scattered_walls": {"count": [3,7]},
- "blocks": {"count": [3,7 ]},
- "clumpiness": [1,3],
+ "large_obstacles": {"size_range": [10, 25], "count": [3, 7]},
+ "small_obstacles": {"size_range": [3, 6], "count": [3, 7]},
+ "crosses": {"count": [3, 7]},
+ "labyrinths": {"count": [3, 7]},
+ "scattered_walls": {"count": [3, 7]},
+ "blocks": {"count": [3, 7]},
+ "clumpiness": [1, 3],
  },
  "sparse-altars-dense-objects": {
  "hearts_count": 25,
- "large_obstacles": {"size_range": [10, 25], "count": [8,15]},
- "small_obstacles": {"size_range": [3, 6], "count": [8,15]},
- "crosses": {"count": [7,15]},
- "labyrinths": {"count": [6,15]},
- "scattered_walls": {"count": [40,60]},
- "blocks": {"count": [5,15]},
- "clumpiness": [2,6],
+ "large_obstacles": {"size_range": [10, 25], "count": [8, 15]},
+ "small_obstacles": {"size_range": [3, 6], "count": [8, 15]},
+ "crosses": {"count": [7, 15]},
+ "labyrinths": {"count": [6, 15]},
+ "scattered_walls": {"count": [40, 60]},
+ "blocks": {"count": [5, 15]},
+ "clumpiness": [2, 6],
  },
- # New style: maze-like with predominant labyrinth features.
+  # New style: maze-like with predominant labyrinth features.
  "maze": {
  "hearts_count": 25, # Altars placed after obstacles; keeps the grid sparse for maze corridors.
- "large_obstacles": {"size_range": [10, 25], "count": [0,2]}, # Disable large obstacles.
- "small_obstacles": {"size_range": [3, 6], "count": [0,2]}, # Disable small obstacles.
- "crosses": {"count": [0,2]}, # No cross obstacles.
- "labyrinths": {"count": [10,20]}, # Increase labyrinth count to generate more maze segments.
- "scattered_walls": {"count": [0,2]}, # Avoid adding extra walls that could break up maze consistency.
- "blocks": {"count": [0,2]}, # No rectangular blocks.
- "clumpiness": [0,2], # Clumpiness is not necessary when only labyrinths are used.
+ "large_obstacles": {"size_range": [10, 25], "count": [0, 2]}, # Disable large obstacles.
+ "small_obstacles": {"size_range": [3, 6], "count": [0, 2]}, # Disable small obstacles.
+ "crosses": {"count": [0, 2]}, # No cross obstacles.
+ "labyrinths": {"count": [10, 20]}, # Increase labyrinth count to generate more maze segments.
+ "scattered_walls": {"count": [0, 2]}, # Avoid adding extra walls that could break up maze consistency.
+ "blocks": {"count": [0, 2]}, # No rectangular blocks.
+ "clumpiness": [0, 2], # Clumpiness is not necessary when only labyrinths are used.
  },
  }
 
@@ -80,9 +80,9 @@ def __init__(
  border_object: str = "wall",
  occupancy_threshold: float = 0.66, # maximum fraction of grid cells to occupy
  style: str = "balanced",
- team: str| None = None,
+ team: str | None = None,
  ):
- super().__init__(border_width=border_width, border_object=border_object, labels = [style])
+ super().__init__(border_width=border_width, border_object=border_object, labels=[style])
 
  width = np.random.randint(40, 100)
  height = np.random.randint(40, 100)

deps/mettagrid/mettagrid/config/room/random.py

@@ -17,7 +17,7 @@ def __init__(
  border_width: int = 0,
  border_object: str = "wall",
  ):
- super().__init__(border_width=border_width, border_object=border_object, labels = ["random"])
+ super().__init__(border_width=border_width, border_object=border_object, labels=["random"])
  self._rng = np.random.default_rng(seed)
  assert isinstance(width, int), f"width must be an int, got '{width}'"
  assert isinstance(height, int), f"height must be an int, got {type(height)}"

deps/mettagrid/mettagrid/config/room/room_list.py

@@ -31,7 +31,6 @@ def _build(self):
  common_labels = set.intersection(*[set(labels) for labels in room_labels])
  self.labels = list(common_labels)
 
-
  # Determine grid dimensions based on number of rooms
  n_rooms = len(rooms)
 

deps/mettagrid/mettagrid/mettagrid_env.py

@@ -128,7 +128,6 @@ def process_episode_stats(self, infos: Dict[str, Any]):
  for n, v in infos["agent"].items():
  infos["agent"][n] = v / self._num_agents
 
-
  @property
  def _max_steps(self):
  return self._env_cfg.game.max_steps
@@ -203,5 +202,6 @@ def inventory_item_names(self):
  def close(self):
  pass
 
+
 # Ensure resolvers are registered when this module is imported
 register_resolvers()

devops/git-hooks/pre-commit

@@ -21,5 +21,11 @@ if ! echo "$STAGED_FILES" | xargs ruff check; then
  exit 1
 fi
 
+# Run ruff format on staged files
+if ! echo "$STAGED_FILES" | xargs ruff format --check; then
+ echo "❌ Ruff format failed. Please fix the issues before committing."
+ exit 1
+fi
+
 # No output on success - GitHub Desktop works better with silent success
-exit 0
+exit 0