Add pre-commit hooks

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+files: ^python/
+exclude: synthpop_pb2.py$
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.9.1
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.292
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]

python/draw_venues.py

@@ -1,10 +1,10 @@
 # You may need to 'pip install' some extra dependencies, or run in a
 # conda/poetry environment.
 
+import click
 import pandas as pd
 import plotly.express as px
 import synthpop_pb2
-import click
 
 
 @click.command()

python/protobuf_to_csv.py

@@ -1,9 +1,9 @@
 # You may need to 'pip install' some extra dependencies, or run in a
 # conda/poetry environment.
 
+import click
 import pandas as pd
 import synthpop_pb2
-import click
 
 
 @click.command()

python/protobuf_to_json.py

@@ -1,10 +1,11 @@
-from google.protobuf.json_format import MessageToJson
-import synthpop_pb2
 import sys
 
+import synthpop_pb2
+from google.protobuf.json_format import MessageToJson
+
 if len(sys.argv) != 2:
-  print(f"Usage: {sys.argv[0]} synthpop_protobuf_file")
-  sys.exit(-1)
+    print(f"Usage: {sys.argv[0]} synthpop_protobuf_file")
+    sys.exit(-1)
 
 pop = synthpop_pb2.Population()
 f = open(sys.argv[1], "rb")

python/tests/test_reader.py

@@ -1,6 +1,7 @@
-from uatk_spc.reader import SPCReaderParquet as SPCReader
-import pathlib
 import os
+import pathlib
+
+from uatk_spc.reader import SPCReaderParquet as SPCReader
 
 
 def get_path():
@@ -24,6 +25,7 @@ def test_merge_people_and_time_use_diaries():
     )
     assert merged.shape == (197_397, 30)
 
+
 def test_merge_people_and_households():
     spc = SPCReader(TEST_PATH, TEST_REGION)
     merged = spc.merge_people_and_households()

python/uatk_spc/reader.py

@@ -1,11 +1,11 @@
+import json
 import os
 from typing import Any, Dict, List
-from google.protobuf.json_format import MessageToDict
-import polars as pl
+
 import pandas as pd
+import polars as pl
 import uatk_spc.synthpop_pb2 as synthpop_pb2
-import json
-import pprint
+from google.protobuf.json_format import MessageToDict
 
 # TODO:
 # - Add graph data structure reading for flows (e.g. into networkx)
@@ -49,7 +49,8 @@ def __init__(self, path: str, region: str, backend="polars"):
             )
         else:
             raise ValueError(
-                f"Backend: {backend} is not implemented. Use 'polars' or 'pandas' instead."
+                f"Backend: {backend} is not implemented. Use 'polars' or 'pandas' "
+                f"instead."
             )
         self.venues_per_activity = pop_as_dict["venuesPerActivity"]
         self.info_per_msoa = pop_as_dict["infoPerMsoa"]
@@ -97,7 +98,8 @@ def __init__(self, path: str, region: str, backend="polars"):
             self.venues_per_activity = pd.read_parquet(path_ + "_venues.pq")
         else:
             raise ValueError(
-                f"Backend: {backend} is not implemented. Use 'polars' or 'pandas' instead."
+                f"Backend: {backend} is not implemented. Use 'polars' or 'pandas' "
+                f"instead."
             )
         with open(path_ + "_info_per_msoa.json", "rb") as f:
             self.info_per_msoa = json.loads(f.read())

python/uatk_spc/scripts.py

@@ -1,16 +1,16 @@
-import pandas as pd
-from google.protobuf.json_format import MessageToJson
-import uatk_spc.synthpop_pb2 as synthpop_pb2
 import click
+import uatk_spc.synthpop_pb2 as synthpop_pb2
+from google.protobuf.json_format import MessageToJson
+
 
 @click.command()
 @click.option("--input_path", required=True, help="path to an SPC .pb file")
 def convert_to_json(input_path: str) -> None:
     """Converts a protobuf population to JSON.
-    
+
     Args:
         input_path (str): Input path to a SPC protobuf file.
-    
+
     """
     pop = synthpop_pb2.Population()
     with open(input_path, "rb") as f: