Add Ruff and Black CI, apply isort, apply ruff --fix

.github/workflows/build_lint.yml

@@ -0,0 +1,48 @@
+name: build
+
+on:
+  push:
+    branches:
+    - main
+    - release**
+    paths-ignore:
+      - '**.md'
+      - '**.rst'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - '**.rst'
+
+# This will cancel previous run if a newer job that obsoletes the said previous
+# run, is started.
+# Based on https://github.com/zulip/zulip/commit/4a11642cee3c8aec976d305d51a86e60e5d70522
+concurrency:
+  group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}"
+  cancel-in-progress: true
+
+jobs:
+  lint-ruff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+    - run: pip install ruff==0.0.275
+    - name: Lint with ruff
+      # Include `--format=github` to enable automatic inline annotations.
+      # Use settings from pyproject.toml.
+      run: ruff . --format=github
+
+  lint-black:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+    - run: pip install black[jupyter]
+    - name: Lint with black
+      run: black --check .

examples/bank_reserves/bank_reserves/agents.py

@@ -11,7 +11,6 @@
 """
 
 import mesa
-
 from bank_reserves.random_walk import RandomWalker
 
 

examples/bank_reserves/bank_reserves/model.py

@@ -12,7 +12,6 @@
 
 import mesa
 import numpy as np
-
 from bank_reserves.agents import Bank, Person
 
 """

examples/bank_reserves/bank_reserves/server.py

@@ -1,5 +1,4 @@
 import mesa
-
 from bank_reserves.agents import Person
 from bank_reserves.model import BankReserves
 

examples/bank_reserves/batch_run.py

@@ -29,7 +29,6 @@
 import mesa
 import numpy as np
 import pandas as pd
-
 from bank_reserves.agents import Bank, Person
 
 # Start of datacollector functions

examples/boid_flockers/boid_flockers/model.py

@@ -46,7 +46,7 @@ def __init__(
         self.separation = separation
         self.schedule = mesa.time.RandomActivation(self)
         self.space = mesa.space.ContinuousSpace(width, height, True)
-        self.factors = dict(cohere=cohere, separate=separate, match=match)
+        self.factors = {"cohere": cohere, "separate": separate, "match": match}
         self.make_agents()
         self.running = True
 

examples/boltzmann_wealth_model/app.py

@@ -1,13 +1,9 @@
-from boltzmann_wealth_model.model import BoltzmannWealthModel
-
-import streamlit as st
-
 import time
 
-import pandas as pd
-
 import altair as alt
-
+import pandas as pd
+import streamlit as st
+from boltzmann_wealth_model.model import BoltzmannWealthModel
 
 model = st.title("Boltzman Wealth Model")
 num_agents = st.slider(

examples/boltzmann_wealth_model_network/boltzmann_wealth_model_network/server.py

@@ -6,7 +6,7 @@
 def network_portrayal(G):
     # The model ensures there is 0 or 1 agent per node
 
-    portrayal = dict()
+    portrayal = {}
     portrayal["nodes"] = [
         {
             "id": node_id,

examples/caching_and_replay/cacheablemodel.py

@@ -1,5 +1,5 @@
-from model import Schelling
 from mesa_replay import CacheableModel, CacheState
+from model import Schelling
 
 
 class CacheableSchelling(CacheableModel):

examples/caching_and_replay/model.py

@@ -66,10 +66,7 @@ def __init__(self, width=20, height=20, density=0.8, minority_pc=0.2, homophily=
             x = cell[1]
             y = cell[2]
             if self.random.random() < self.density:
-                if self.random.random() < self.minority_pc:
-                    agent_type = 1
-                else:
-                    agent_type = 0
+                agent_type = 1 if self.random.random() < self.minority_pc else 0
 
                 agent = SchellingAgent((x, y), self, agent_type)
                 self.grid.place_agent(agent, (x, y))

examples/caching_and_replay/run.py

@@ -1,14 +1,8 @@
 from pathlib import Path
 
 import mesa
-
-from server import (
-    canvas_element,
-    get_happy_agents,
-    happy_chart,
-    model_params,
-)
 from cacheablemodel import CacheableSchelling
+from server import canvas_element, get_happy_agents, happy_chart, model_params
 
 # As 'replay' is a simulation model parameter in this example, we need to make it available as such
 model_params["replay"] = mesa.visualization.Checkbox("Replay cached run?", False)

examples/caching_and_replay/server.py

@@ -1,7 +1,6 @@
 """This file was copied over from the original Schelling mesa example."""
 
 import mesa
-
 from model import Schelling
 
 

examples/charts/charts/agents.py

@@ -11,7 +11,6 @@
 """
 
 import mesa
-
 from charts.random_walk import RandomWalker
 
 

examples/charts/charts/model.py

@@ -12,7 +12,6 @@
 
 import mesa
 import numpy as np
-
 from charts.agents import Bank, Person
 
 """

examples/charts/charts/server.py

@@ -1,5 +1,4 @@
 import mesa
-
 from charts.agents import Person
 from charts.model import Charts
 

examples/color_patches/color_patches/model.py

@@ -115,7 +115,7 @@ def grid(self):
              80                 cell_objects = model.grid.get_cell_list_contents([(x, y)])
 
         AttributeError: 'ColorPatches' object has no attribute 'grid'
-        """  # noqa: E501
+        """
         return self._grid
 
     @property

examples/conways_game_of_life/app.py

@@ -1,18 +1,10 @@
-import mesa
-import streamlit as st
-
 import time
 
-import pandas as pd
-
 import altair as alt
-
-
 import numpy as np
-from conways_game_of_life.model import ConwaysGameOfLife
-
 import pandas as pd
-
+import streamlit as st
+from conways_game_of_life.model import ConwaysGameOfLife
 
 model = st.title("Boltzman Wealth Model")
 num_ticks = st.slider("Select number of Steps", min_value=1, max_value=100, value=50)

examples/conways_game_of_life/conways_game_of_life/server.py

@@ -1,8 +1,7 @@
 import mesa
 
-from .portrayal import portrayCell
 from .model import ConwaysGameOfLife
-
+from .portrayal import portrayCell
 
 # Make a world that is 50x50, on a 250x250 display.
 canvas_element = mesa.visualization.CanvasGrid(portrayCell, 50, 50, 250, 250)

examples/epstein_civil_violence/epstein_civil_violence/model.py

@@ -1,6 +1,6 @@
 import mesa
 
-from .agent import Cop, Citizen
+from .agent import Citizen, Cop
 
 
 class EpsteinCivilViolence(mesa.Model):

examples/epstein_civil_violence/epstein_civil_violence/server.py

@@ -1,8 +1,7 @@
 import mesa
 
-from .model import EpsteinCivilViolence
 from .agent import Citizen, Cop
-
+from .model import EpsteinCivilViolence
 
 COP_COLOR = "#000000"
 AGENT_QUIET_COLOR = "#0066CC"
@@ -37,16 +36,16 @@ def citizen_cop_portrayal(agent):
     return portrayal
 
 
-model_params = dict(
-    height=40,
-    width=40,
-    citizen_density=0.7,
-    cop_density=0.074,
-    citizen_vision=7,
-    cop_vision=7,
-    legitimacy=0.8,
-    max_jail_term=1000,
-)
+model_params = {
+    "height": 40,
+    "width": 40,
+    "citizen_density": 0.7,
+    "cop_density": 0.074,
+    "citizen_vision": 7,
+    "cop_vision": 7,
+    "legitimacy": 0.8,
+    "max_jail_term": 1000,
+}
 
 canvas_element = mesa.visualization.CanvasGrid(citizen_cop_portrayal, 40, 40, 480, 480)
 server = mesa.visualization.ModularServer(

examples/hex_snowflake/hex_snowflake/model.py

@@ -1,5 +1,4 @@
 import mesa
-
 from hex_snowflake.cell import Cell
 
 

examples/hex_snowflake/hex_snowflake/server.py

@@ -1,7 +1,6 @@
 import mesa
-
-from hex_snowflake.portrayal import portrayCell
 from hex_snowflake.model import HexSnowflake
+from hex_snowflake.portrayal import portrayCell
 
 width, height = 50, 50
 

examples/pd_grid/pd_grid/server.py

@@ -1,8 +1,7 @@
 import mesa
 
-from .portrayal import portrayPDAgent
 from .model import PdGrid
-
+from .portrayal import portrayPDAgent
 
 # Make a world that is 50x50, on a 500x500 display.
 canvas_element = mesa.visualization.CanvasGrid(portrayPDAgent, 50, 50, 500, 500)

examples/schelling/model.py

@@ -64,10 +64,7 @@ def __init__(self, width=20, height=20, density=0.8, minority_pc=0.2, homophily=
             x = cell[1]
             y = cell[2]
             if self.random.random() < self.density:
-                if self.random.random() < self.minority_pc:
-                    agent_type = 1
-                else:
-                    agent_type = 0
+                agent_type = 1 if self.random.random() < self.minority_pc else 0
 
                 agent = SchellingAgent((x, y), self, agent_type)
                 self.grid.place_agent(agent, (x, y))

examples/schelling/run_ascii.py

@@ -1,5 +1,4 @@
 import mesa
-
 from model import Schelling
 
 

examples/schelling/server.py

@@ -1,5 +1,4 @@
 import mesa
-
 from model import Schelling
 
 

examples/shape_example/shape_example/server.py

@@ -1,6 +1,6 @@
 import mesa
 
-from .model import Walker, ShapeExample
+from .model import ShapeExample, Walker
 
 
 def agent_draw(agent):

examples/sugarscape_cg/sugarscape_cg/server.py

@@ -14,10 +14,7 @@ def SsAgent_portrayal(agent):
         return {"Shape": "sugarscape_cg/resources/ant.png", "scale": 0.9, "Layer": 1}
 
     elif type(agent) is Sugar:
-        if agent.amount != 0:
-            color = color_dic[agent.amount]
-        else:
-            color = "#D6F5D6"
+        color = color_dic[agent.amount] if agent.amount != 0 else "#D6F5D6"
         return {
             "Color": color,
             "Shape": "rect",

examples/sugarscape_g1mt/run.py

@@ -1,8 +1,9 @@
 import sys
-import pandas as pd
+
 import matplotlib.pyplot as plt
-import networkx as nx
 import mesa
+import networkx as nx
+import pandas as pd
 from sugarscape_g1mt.model import SugarscapeG1mt
 from sugarscape_g1mt.server import server
 

examples/sugarscape_g1mt/sugarscape_g1mt/model.py

@@ -1,9 +1,8 @@
+import mesa
 import numpy as np
 
-
-import mesa
+from .resource_agents import Spice, Sugar
 from .trader_agents import Trader
-from .resource_agents import Sugar, Spice
 
 
 # Helper Functions