Add ruff for linting, remove flake8, remove isort

.github/workflows/lint.yaml

@@ -1,11 +1,5 @@
 name: Lint Check
-on:
-  pull_request:
-    types: [opened, synchronize]
-  push:
-    branches:
-      - main
-
+on: [pull_request]
 jobs:
   lint_test:
     name: 3.11 lint check
@@ -19,11 +13,5 @@ jobs:
       - name: Install package with dev deps
         run: |
           python -m pip install -e ".[dev]"
-      - name: Run lint test
+      - name: Run lint check
         run: make lint
-      - name: Lint with flake8
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

.pre-commit-config.yaml

@@ -4,6 +4,7 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.3.0
     hooks:
+      - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/MarcoGorelli/absolufy-imports
@@ -16,14 +17,18 @@ repos:
     hooks:
       - id: add-trailing-comma
         name: Add trailing comma
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.10.1
     hooks:
-      - id: isort
+      - id: validate-pyproject
   - repo: https://github.com/python/black
     rev: 22.12.0
     hooks:
       - id: black
         args: [--target-version=py311]
         additional_dependencies: [".[jupyter]"]
         types_or: [python, jupyter]
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.202
+    hooks:
+      - id: ruff

Makefile

@@ -29,13 +29,13 @@ installdeps-docs:
 
 .PHONY: lint
 lint:
-	isort --check-only gridstatus/
 	black gridstatus/ -t py311 --check
+	ruff gridstatus/
 
 .PHONY: lint-fix
 lint-fix:
 	black gridstatus/ -t py311
-	isort gridstatus/
+	ruff gridstatus/ --fix
 
 .PHONY: upgradepip
 upgradepip:

docs/Examples/spp/LMP Data.ipynb

@@ -196,10 +196,7 @@
     }
    ],
    "source": [
-    "df = iso.get_lmp(\n",
-    "    date=\"latest\",\n",
-    "    market=\"REAL_TIME_5_MIN\"\n",
-    ")\n",
+    "df = iso.get_lmp(date=\"latest\", market=\"REAL_TIME_5_MIN\")\n",
     "df"
    ]
   },
@@ -333,9 +330,7 @@
    ],
    "source": [
     "df = iso.get_lmp(\n",
-    "    date=\"latest\",\n",
-    "    market=\"REAL_TIME_5_MIN\",\n",
-    "    location_type=\"SETTLEMENT_LOCATION\"\n",
+    "    date=\"latest\", market=\"REAL_TIME_5_MIN\", location_type=\"SETTLEMENT_LOCATION\"\n",
     ")\n",
     "df.head(5)"
    ]
@@ -500,11 +495,7 @@
     }
    ],
    "source": [
-    "df = iso.get_lmp(\n",
-    "    date=\"latest\",\n",
-    "    market=\"REAL_TIME_5_MIN\",\n",
-    "    location_type=\"Interface\"\n",
-    ")\n",
+    "df = iso.get_lmp(date=\"latest\", market=\"REAL_TIME_5_MIN\", location_type=\"Interface\")\n",
     "df.head(5)"
    ]
   },
@@ -637,11 +628,7 @@
     }
    ],
    "source": [
-    "df = iso.get_lmp(\n",
-    "    date=\"today\",\n",
-    "    market=\"REAL_TIME_5_MIN\",\n",
-    "    location_type=\"Interface\"\n",
-    ")\n",
+    "df = iso.get_lmp(date=\"today\", market=\"REAL_TIME_5_MIN\", location_type=\"Interface\")\n",
     "df.head(5)"
    ]
   },
@@ -776,11 +763,7 @@
     }
    ],
    "source": [
-    "df = iso.get_lmp(\n",
-    "    date=\"today\",\n",
-    "    market=\"DAY_AHEAD_HOURLY\",\n",
-    "    location_type=\"Hub\"\n",
-    ")\n",
+    "df = iso.get_lmp(date=\"today\", market=\"DAY_AHEAD_HOURLY\", location_type=\"Hub\")\n",
     "df.head(5)"
    ]
   },
@@ -915,11 +898,7 @@
     }
    ],
    "source": [
-    "df = iso.get_lmp(\n",
-    "    date=\"today\",\n",
-    "    market=\"DAY_AHEAD_HOURLY\",\n",
-    "    location_type=\"Interface\"\n",
-    ")\n",
+    "df = iso.get_lmp(date=\"today\", market=\"DAY_AHEAD_HOURLY\", location_type=\"Interface\")\n",
     "df.head(5)"
    ]
   }

docs/update_docs.py

@@ -1,4 +1,3 @@
-import gridstatus
 from gridstatus.utils import make_availability_table, make_lmp_availability_table
 
 

gridstatus/caiso.py

@@ -7,7 +7,6 @@
 import requests
 import tabula
 
-import gridstatus
 from gridstatus import utils
 from gridstatus.base import FuelMix, GridStatus, ISOBase, Markets, NotSupported
 from gridstatus.decorators import support_date_range
@@ -560,7 +559,7 @@ def get_curtailment(self, date, verbose=False):
         with io.StringIO() as buf, redirect_stderr(buf):
             try:
                 tables = tabula.read_pdf(pdf, pages="all")
-            except:
+            except Exception:
                 print(buf.getvalue())
                 raise RuntimeError("Problem Reading PDF")
 
@@ -854,7 +853,6 @@ def _caiso_handle_start_end(date, end):
 
     # check if any files are missing
     import glob
-    import os
 
     files = glob.glob("caiso_curtailment/*.csv")
     dates = (

gridstatus/isone.py

@@ -1,13 +1,9 @@
 import io
 import math
-import re
-from heapq import merge
-from tabnanny import verbose
 
 import pandas as pd
 import requests
 
-import gridstatus
 from gridstatus import utils
 from gridstatus.base import (
     FuelMix,
@@ -558,7 +554,7 @@ def _make_request(url, skiprows, verbose):
         attempt = 0
         while attempt < 3:
             # make first get request to get cookies set
-            r1 = s.get(
+            _ = s.get(
                 "https://www.iso-ne.com/isoexpress/web/reports/operations/-/tree/gen-fuel-mix",
             )
 

gridstatus/miso.py

@@ -2,7 +2,6 @@
 
 import pandas as pd
 import requests
-from pandas import Timestamp
 
 from gridstatus import utils
 from gridstatus.base import FuelMix, ISOBase, Markets, NotSupported

gridstatus/nyiso.py

@@ -12,7 +12,6 @@
     InterconnectionQueueStatus,
     ISOBase,
     Markets,
-    _interconnection_columns,
 )
 from gridstatus.decorators import support_date_range
 
@@ -86,7 +85,7 @@ def get_fuel_mix(self, date, end=None, verbose=False):
 
             if data["status"] != "success":
                 raise RuntimeError(
-                    f"Failed to get latest fuel mix. Check if NYISO's API is down.",
+                    "Failed to get latest fuel mix. Check if NYISO's API is down.",
                 )
 
             mix_df = pd.DataFrame(data["data"])

gridstatus/pjm.py

@@ -6,7 +6,6 @@
 import requests
 import tqdm
 
-import gridstatus
 from gridstatus import utils
 from gridstatus.base import FuelMix, ISOBase, Markets, NotSupported
 from gridstatus.decorators import (
@@ -343,7 +342,7 @@ def get_lmp(
             data = data[data["Location Type"] == location_type]
 
         if locations is not None and locations != "ALL":
-            data = gridstatus.utils.filter_lmp_locations(
+            data = utils.filter_lmp_locations(
                 data,
                 map(int, locations),
             )
@@ -370,10 +369,10 @@ def _get_pjm_json(
         final_params.update(default_params)
 
         if start is not None:
-            start = gridstatus.utils._handle_date(start)
+            start = utils._handle_date(start)
 
             if end:
-                end = gridstatus.utils._handle_date(end)
+                end = utils._handle_date(end)
             else:
                 end = start + pd.DateOffset(days=1)
 

gridstatus/tests/test_caiso.py

@@ -1,5 +1,3 @@
-import pytest
-
 import gridstatus
 
 

gridstatus/tests/test_ercot.py

@@ -166,7 +166,7 @@ def test_ercot_get_two_days_ago_day_ahead_hourly_zone():
 def test_ercot_get_dam_latest_day_ahead_hourly_zone_should_raise_exception():
     iso = gridstatus.Ercot()
     with pytest.raises(ValueError):
-        df = iso.get_spp(
+        iso.get_spp(
             date="latest",
             market=Markets.DAY_AHEAD_HOURLY,
             location_type="zone",

gridstatus/tests/test_isone.py

@@ -12,13 +12,12 @@ def test_isone_fuel_mix():
 
 def run_all(date):
     iso = gridstatus.ISONE()
-
-    data = iso.get_fuel_mix(date=date)
-    data = iso.get_load(date=date)
-    data = iso.get_load_forecast(date=date)
-    data = iso.get_lmp(date=date, market=Markets.DAY_AHEAD_HOURLY)
-    data = iso.get_lmp(date=date, market=Markets.REAL_TIME_5_MIN)
-    data = iso.get_lmp(date=date, market=Markets.REAL_TIME_HOURLY)
+    iso.get_fuel_mix(date=date)
+    iso.get_load(date=date)
+    iso.get_load_forecast(date=date)
+    iso.get_lmp(date=date, market=Markets.DAY_AHEAD_HOURLY)
+    iso.get_lmp(date=date, market=Markets.REAL_TIME_5_MIN)
+    iso.get_lmp(date=date, market=Markets.REAL_TIME_HOURLY)
 
 
 def test_isone_dst_end():

gridstatus/tests/test_isos.py

@@ -3,7 +3,7 @@
 from pandas.api.types import is_numeric_dtype
 
 import gridstatus
-from gridstatus import *
+from gridstatus import CAISO, ISONE, MISO, NYISO, PJM, SPP, Ercot, Markets
 from gridstatus.base import FuelMix, GridStatus, ISOBase
 
 all_isos = [MISO(), CAISO(), PJM(), Ercot(), SPP(), NYISO(), ISONE()]
@@ -85,7 +85,7 @@ def test_get_iso():
 
 
 def test_get_iso_invalid():
-    with pytest.raises(Exception) as e_info:
+    with pytest.raises(Exception):
         gridstatus.get_iso("ISO DOESNT EXIST")
 
 
@@ -281,9 +281,7 @@ def test_get_historical_lmp(test):
 def test_get_latest_lmp(test):
     iso = list(test)[0]
     markets = test[iso]["markets"]
-    locations = test[iso]
 
-    date_str = "20220722"
     for m in markets:
         print(iso.iso_id, m)
         latest = iso.get_lmp(date="latest", market=m)
@@ -421,13 +419,13 @@ def test_date_or_start(iso):
     end = pd.Timestamp.now(tz=iso.default_timezone)
     start = end - pd.Timedelta(days=num_days)
 
-    data_date = iso.get_fuel_mix(date=start.date(), end=end.date())
-    data_start = iso.get_fuel_mix(
+    iso.get_fuel_mix(date=start.date(), end=end.date())
+    iso.get_fuel_mix(
         start=start.date(),
         end=end.date(),
     )
-    data_date = iso.get_fuel_mix(date=start.date())
-    data_start = iso.get_fuel_mix(start=start.date())
+    iso.get_fuel_mix(date=start.date())
+    iso.get_fuel_mix(start=start.date())
 
     with pytest.raises(ValueError):
         iso.get_fuel_mix(start=start.date(), date=start.date())

gridstatus/tests/test_nyiso.py

@@ -1,4 +1,3 @@
-import pandas as pd
 import pytest
 
 import gridstatus
@@ -129,7 +128,7 @@ def test_location_type_parameter():
     assert (df_gen["Location Type"] == "Generator").all()
 
     with pytest.raises(ValueError):
-        df = iso.get_lmp(
+        iso.get_lmp(
             date="latest",
             market=Markets.DAY_AHEAD_HOURLY,
             location_type="dummy",
@@ -166,7 +165,7 @@ def test_nyiso_get_loads():
 
 def test_nyiso_interconnection_queue():
     iso = gridstatus.NYISO()
-    df = iso.get_interconnection_queue()
+    iso.get_interconnection_queue()
 
 
 def test_nyiso_get_capacity_prices():

gridstatus/tests/test_pjm.py

@@ -1,5 +1,3 @@
-from ftplib import ftpcp
-
 import pandas as pd
 import pytest
 
@@ -30,7 +28,7 @@ def test_no_data():
     date = "2000-01-14"
     iso = gridstatus.PJM()
     with pytest.raises(RuntimeError):
-        df = iso.get_fuel_mix(start=date)
+        iso.get_fuel_mix(start=date)
 
 
 def test_dst_shift_back():

gridstatus/utils.py

@@ -20,7 +20,6 @@
 GREEN_CHECKMARK_HTML_ENTITY = "✅"
 
 RED_X_HTML_ENTITY = "❌"
-
 all_isos = [MISO, CAISO, PJM, Ercot, SPP, NYISO, ISONE]