fix(format): add formatting with pre-commit and CI (#431)

Author: Shillaker

.github/workflows/format.yml

@@ -0,0 +1,34 @@
+name: Formatting
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+    paths:
+      - "**/*.py"
+  pull_request:
+    branches:
+      - main
+      - dev
+    paths:
+      - "**/*.py"
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+
+    - name: Install poetry
+      run: python -m pip install --upgrade poetry wheel
+
+    - name: Install dependencies
+      run: make install
+
+    - name: Run format check
+      run: make format-check

.github/workflows/lint.yml

@@ -0,0 +1,34 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+    paths:
+      - "**/*.py"
+  pull_request:
+    branches:
+      - main
+      - dev
+    paths:
+      - "**/*.py"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+
+    - name: Install poetry
+      run: python -m pip install --upgrade poetry wheel
+
+    - name: Install dependencies
+      run: make install
+
+    - name: Run lint
+      run: make lint

.github/workflows/test.yml

@@ -23,27 +23,6 @@ on:
       - dev
 
 jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: 3.12
-
-    - name: Install pipenv
-      run: |
-        python -m pip install --upgrade poetry wheel
-
-    - name: Install dependencies
-      run: |
-        make install
-
-    - name: Run lint
-      run: |
-        make lint
-
   test:
     strategy:
       matrix:
@@ -56,14 +35,11 @@ jobs:
       with:
         python-version: ${{ matrix.version }}
 
-    - name: Install pipenv
-      run: |
-        python -m pip install --upgrade poetry wheel
+    - name: Install poetry
+      run: python -m pip install --upgrade poetry wheel
 
     - name: Install dependencies
-      run: |
-        make install
+      run: make install
 
     - name: Run test suite
-      run: |
-        make test
+      run: make test

.pre-commit-config.yaml

@@ -13,3 +13,12 @@ repos:
         entry: venv/bin/ruff
         args: [check, --force-exclude, --fix, --exit-non-zero-on-fix]
         types: ["python"]
+
+  - repo: local
+    hooks:
+      - id: ruff-format
+        name: ruff-format
+        language: system
+        entry: venv/bin/ruff
+        args: [format, --check]
+        types: ["python"]

Makefile

@@ -24,6 +24,12 @@ lint:
 lint-fix:
 		poetry run ruff check --fix
 
+format:
+		poetry run ruff format
+
+format-check:
+		poetry run ruff format --check
+
 pre-commit-install:
 		poetry run pre-commit install
 

boaviztapi/__init__.py

@@ -5,9 +5,9 @@
 import yaml
 
 if "pytest" in sys.modules:
-    data_dir = os.path.join(os.path.dirname(__file__), '../tests/data')
+    data_dir = os.path.join(os.path.dirname(__file__), "../tests/data")
 else:
-    data_dir = os.path.join(os.path.dirname(__file__), 'data')
+    data_dir = os.path.join(os.path.dirname(__file__), "data")
 
-config_file = os.path.join(data_dir, 'config.yml')
-config = yaml.safe_load(Path(config_file).read_text())
+config_file = os.path.join(data_dir, "config.yml")
+config = yaml.safe_load(Path(config_file).read_text())

boaviztapi/data/utils/complete_Azure_VMs/compare_vantage_with_benchmarks.py

@@ -6,6 +6,7 @@
 benchmark_file_linux = "instances_azure_linux.csv"
 benchmark_file_windows = "instances_azure_windows.csv"
 
+
 def main():
     v_csv_data = pd.read_csv(vantage_file)
     b_csv_data_win = pd.read_csv(benchmark_file_windows)
@@ -15,33 +16,42 @@ def main():
     items_found_in_v = []
     for d in v_csv_data["Name"]:
         d = d.replace(" ", "_")
-        #print("d: {}".format(d))
-        res_lin = [ i for i in b_csv_data_lin["Name"] if i == d ]
+        # print("d: {}".format(d))
+        res_lin = [i for i in b_csv_data_lin["Name"] if i == d]
         if len(res_lin) > 0:
             print("Found {} in Benchmark data for Linux: {}".format(d, res_lin))
             found_v_in_b += 1
         else:
-            res_win = [ i for i in b_csv_data_win["Name"] if i == d ]
+            res_win = [i for i in b_csv_data_win["Name"] if i == d]
             if len(res_win) > 0:
                 print("Found {} in Benchmark data for Windows: {}".format(d, res_win))
                 found_v_in_b += 1
             else:
                 print("{} NOT FOUND IN ANY BENCH".format(d))
     for d in b_csv_data_win["Name"]:
-        res_v = [ i for i in v_csv_data["Name"] if i.replace(" ", "_") == d ]
+        res_v = [i for i in v_csv_data["Name"] if i.replace(" ", "_") == d]
         if len(res_v) > 0 and d not in items_found_in_v:
             print("Found {} from bench windows in vantage data: {}".format(d, res_v))
             found_b_in_v += 1
             items_found_in_v += d
     for d in b_csv_data_lin["Name"]:
-        res_v = [ i for i in v_csv_data["Name"] if i.replace(" ", "_") == d ]
+        res_v = [i for i in v_csv_data["Name"] if i.replace(" ", "_") == d]
         if len(res_v) > 0 and d not in items_found_in_v:
             print("Found {} from bench linux in vantage data: {}".format(d, res_v))
             found_b_in_v += 1
             items_found_in_v += d
 
-    print("Found {} items from benchmarks in vantage data. Vantage data contains {}".format(found_b_in_v, len(v_csv_data)))
-    print("Found {} items from vantage data in benchmarks. Benchmarks contains {}".format(found_v_in_b, len(b_csv_data_lin)+len(b_csv_data_win)))
+    print(
+        "Found {} items from benchmarks in vantage data. Vantage data contains {}".format(
+            found_b_in_v, len(v_csv_data)
+        )
+    )
+    print(
+        "Found {} items from vantage data in benchmarks. Benchmarks contains {}".format(
+            found_v_in_b, len(b_csv_data_lin) + len(b_csv_data_win)
+        )
+    )
+
 
 if __name__ == "__main__":
     main()