Add lint workflow (#23)

* Remove __main__ files
* Remove gravity migration webservice
* Remove Kurt's stuff from DT
* Lint everything
* Add linting workflow

Author: kfrey-idm

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: Lint
+
+on:
+  push:
+    paths:
+      - '**.py'
+
+  pull_request:
+    paths:
+      - '**.py'
+
+jobs:
+  run-linters:
+    name: Run linters
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+      - name: Install Python dependencies
+        run: |
+          python -m pip install .[lint]
+      - name: Lint
+        run: |
+          flake8 --ignore=E501,E261,W503 --exclude=.dtk_tools emod_api

emod_api/__main__.py

@@ -5,6 +5,8 @@
 
 import json
 
+from emod_api import schema_to_class as s2c
+
 schema_path = None
 _schema_json = None
 campaign_dict = {"Events": [], "Use_Defaults": 1}
@@ -21,20 +23,18 @@
 
 
 def reset():
-    del (campaign_dict["Events"][:])
-    global pubsub_signals_subbing
-    global pubsub_signals_pubbing
-    global adhocs
-    global event_map
-    del (pubsub_signals_subbing[:])
-    del (pubsub_signals_pubbing[:])
-    del (adhocs[:])
-    del (custom_coordinator_events[:])
-    del (custom_node_events[:])
-    event_map = {}
-    from emod_api import schema_to_class as s2c
+    campaign_dict["Events"].clear()
+
+    pubsub_signals_subbing.clear()
+    pubsub_signals_pubbing.clear()
+    adhocs.clear()
+    custom_coordinator_events.clear()
+    custom_node_events.clear()
+    implicits.clear()
+
+    event_map.clear()
+
     s2c.clear_schema_cache()
-    del (implicits[:])
 
 
 def set_schema(schema_path_in):
@@ -62,16 +62,15 @@ def get_schema():
 
 def add(event, name=None, first=False):
     """
-    Add a complete campaign event to the campaign builder. The new event is assumed to be a Python dict, and a 
-    valid event. The new event is not validated here. 
+    Add a complete campaign event to the campaign builder. The new event is assumed to be a Python dict, and a
+    valid event. The new event is not validated here.
     Set the first flag to True if this is the first event in a campaign because it functions as an
     accumulator and in some situations like sweeps it might have been used recently.
     """
     event.finalize()
     if first:
         print("Use of 'first' flag is deprecated. Use set_schema to start build a new, empty campaign.")
-        global campaign_dict
-        campaign_dict["Events"] = []
+        campaign_dict["Events"].clear()
     if "Event_Name" not in event and name is not None:
         event["Event_Name"] = name
     if "Listening" in event:
@@ -91,7 +90,7 @@ def get_trigger_list():
         try:
             trigger_list = get_schema()["idmTypes"]["idmAbstractType:EventCoordinator"]["BroadcastCoordinatorEvent"][
                 "Broadcast_Event"]["enum"]
-        except Exception as ex:
+        except Exception:
             trigger_list = get_schema()["idmTypes"]["idmType:IncidenceCounter"]["Trigger_Condition_List"]["Built-in"]
     return trigger_list
 

emod_api/campaign.py

@@ -2,13 +2,10 @@
 
 """Module for reading InsetChart.json channels."""
 
-from csv import writer as CsvWriter
 from datetime import datetime
 import json
 from pathlib import Path
 from typing import Dict, List, Union
-import warnings
-
 import pandas as pd
 
 _CHANNELS = "Channels"
@@ -410,7 +407,7 @@ def validate_channel(_channel, _title, _header) -> None:
 
         return
 
-    def to_csv(self, filename: Union[str, Path], channel_names: List[str]=None, transpose: bool=False) -> None:
+    def to_csv(self, filename: Union[str, Path], channel_names: List[str] = None, transpose: bool = False) -> None:
 
         """
         Write each channel from the report to a row, CSV style, in the given file.

emod_api/channelreports/__main__.py

@@ -2,23 +2,25 @@
 import json
 import pandas as pd
 
-def _get_sim_years( output_path ):
 
-    if not os.path.exists( "config.json" ):
+def _get_sim_years(output_path):
+
+    if not os.path.exists("config.json"):
         return None
-    with open( "config.json" ) as config_fp:
-        config = json.load( config_fp )
+    with open("config.json") as config_fp:
+        config = json.load(config_fp)
     if "Base_Year" not in config["parameters"]:
         return None
 
     base_year = config["parameters"]["Base_Year"]
-    step = config["parameters"]["Simulation_Timestep"]/365
-    steps = round(config["parameters"]["Simulation_Duration"]/step)
-    
-    sim_year = [ base_year + step * x for x in range(steps) ]
+    step = config["parameters"]["Simulation_Timestep"] / 365
+    steps = round(config["parameters"]["Simulation_Duration"] / step)
+
+    sim_year = [base_year + step * x for x in range(steps)]
     return sim_year
 
-def inset_chart_json_to_csv_dataframe_pd( output_path: str ):
+
+def inset_chart_json_to_csv_dataframe_pd(output_path: str):
     """
     Convert InsetChart.json file in 'output_path' to InsetChart.csv.
     Adding Simulation_Year column if Base_Year exists in config.json.
@@ -34,15 +36,15 @@ def inset_chart_json_to_csv_dataframe_pd( output_path: str ):
         ValueError: if InsetChart.csv can't be written.
     """
 
-    icj_path = os.path.join( output_path, "InsetChart.json" )
-    if not os.path.exists( icj_path ):
-        raise ValueError( f"InsetChart.json not found at {output_path}." )
+    icj_path = os.path.join(output_path, "InsetChart.json")
+    if not os.path.exists(icj_path):
+        raise ValueError(f"InsetChart.json not found at {output_path}.")
 
     # Load JSON data from file
-    with open( icj_path ) as fp:
-        icj = json.load( fp )
+    with open(icj_path) as fp:
+        icj = json.load(fp)
 
-    optional_years_channel = _get_sim_years( output_path )
+    optional_years_channel = _get_sim_years(output_path)
     if optional_years_channel:
         icj["Channels"]["Simulation_Year"]["Data"] = optional_years_channel
 
@@ -56,8 +58,8 @@ def inset_chart_json_to_csv_dataframe_pd( output_path: str ):
 
     try:
         # Convert DataFrame to CSV
-        csv_path = os.path.join( output_path, "InsetChart.csv" )
+        csv_path = os.path.join(output_path, "InsetChart.csv")
         df.to_csv(csv_path, index=False)
     except Exception as ex:
-        print( f"ERROR: Exception {ex} while writing csv dataframe of InsetChart.json to disk." )
-        raise ValueError( ex )
+        print(f"ERROR: Exception {ex} while writing csv dataframe of InsetChart.json to disk.")
+        raise ValueError(ex)