preview line length changes

.pre-commit-config.yaml

@@ -21,13 +21,13 @@ repos:
     rev: v0.10.1
     hooks:
       - id: validate-pyproject
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.202
+    hooks:
+      - id: ruff
   - repo: https://github.com/python/black
     rev: 22.12.0
     hooks:
       - id: black
         additional_dependencies: [".[jupyter]"]
         types_or: [python, jupyter]
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.202
-    hooks:
-      - id: ruff

gridstatus/base.py

@@ -81,11 +81,14 @@ def get_fuel_mix(self, date, end=None, verbose=False):
         """Get fuel mix in 5 minute intervals for a provided day
 
         Arguments:
-            date (datetime or str): "latest", "today", or an object that can be parsed as a datetime for the day to return data.
+            date (datetime or str): "latest", "today", or an object that can be parsed
+                as a datetime for the day to return data.
 
-            start (datetime or str): start of date range to return. alias for `date` parameter. Only specify one of `date` or `start`.
+            start (datetime or str): start of date range to return. alias for `date` parameter.
+                Only specify one of `date` or `start`.
 
-            end (datetime or str): "today" or an object that can be parsed as a datetime for the day to return data. Only used if requesting a range of dates.
+            end (datetime or str): "today" or an object that can be parsed as a datetime for the
+                day to return data. Only used if requesting a range of dates.
 
             verbose (bool): print verbose output. Defaults to False.
 

gridstatus/caiso.py

@@ -92,7 +92,6 @@ def get_fuel_mix(self, date, end=None, verbose=False):
         return self._get_historical_fuel_mix(date, verbose=verbose)
 
     def _get_historical_fuel_mix(self, date, verbose=False):
-
         url = _HISTORY_BASE + "/%s/fuelsource.csv"
         df = _get_historical(url, date, verbose=verbose)
 
@@ -431,14 +430,24 @@ def get_interconnection_queue(self, verbose=False):
 
         queue = queue.rename(
             columns={
-                "Interconnection Request\nReceive Date": "Interconnection Request Receive Date",
+                "Interconnection Request\nReceive Date": (
+                    "Interconnection Request Receive Date"
+                ),
                 "Actual\nOn-line Date": "Actual On-line Date",
                 "Current\nOn-line Date": "Current On-line Date",
-                "Interconnection Agreement \nStatus": "Interconnection Agreement Status",
+                "Interconnection Agreement \nStatus": (
+                    "Interconnection Agreement Status"
+                ),
                 "Study\nProcess": "Study Process",
-                "Proposed\nOn-line Date\n(as filed with IR)": "Proposed On-line Date (as filed with IR)",
-                "System Impact Study or \nPhase I Cluster Study": "System Impact Study or Phase I Cluster Study",
-                "Facilities Study (FAS) or \nPhase II Cluster Study": "Facilities Study (FAS) or Phase II Cluster Study",
+                "Proposed\nOn-line Date\n(as filed with IR)": (
+                    "Proposed On-line Date (as filed with IR)"
+                ),
+                "System Impact Study or \nPhase I Cluster Study": (
+                    "System Impact Study or Phase I Cluster Study"
+                ),
+                "Facilities Study (FAS) or \nPhase II Cluster Study": (
+                    "Facilities Study (FAS) or Phase II Cluster Study"
+                ),
                 "Optional Study\n(OS)": "Optional Study (OS)",
             },
         )
@@ -758,7 +767,6 @@ def _make_timestamp(time_str, today, timezone="US/Pacific"):
 
 
 def _get_historical(url, date, verbose=False):
-
     date_str = date.strftime("%Y%m%d")
     date_obj = date
     url = url % date_str

gridstatus/decorators.py

@@ -148,7 +148,6 @@ def wrapped_f(*args, **kwargs):
             total = len(dates) - dates.count(None) * 2 - 1
 
             with tqdm.tqdm(disable=total <= 1, total=total) as pbar:
-
                 for end_date in dates[1:]:
                     # if we come across None, it means we should reset
                     if end_date is None:

gridstatus/miso.py

@@ -87,7 +87,6 @@ def get_load(self, date, verbose=False):
             raise NotSupported
 
     def get_load_forecast(self, date, verbose=False):
-
         if date != "today":
             raise NotSupported()
 

gridstatus/nyiso.py

@@ -32,7 +32,6 @@ class NYISO(ISOBase):
 
     @support_date_range(frequency="MS")
     def get_status(self, date, end=None, verbose=False):
-
         if date == "latest":
             latest = self._latest_from_today(self.get_status)
             return GridStatus(
@@ -589,7 +588,6 @@ def _download_nyiso_archive(
         filename=None,
         verbose=False,
     ):
-
         if filename is None:
             filename = dataset_name
 
@@ -607,7 +605,6 @@ def _download_nyiso_archive(
         if end is None and date > pd.Timestamp.now(
             tz=self.default_timezone,
         ).normalize() - pd.DateOffset(days=7):
-
             if verbose:
                 print(f"Requesting {csv_url}")
 

gridstatus/pjm.py

@@ -267,7 +267,10 @@ def get_lmp(
             market_type = "da"
         else:
             raise ValueError(
-                "market must be one of REAL_TIME_5_MIN, REAL_TIME_HOURLY, DAY_AHEAD_HOURLY",
+                (
+                    "market must be one of REAL_TIME_5_MIN, REAL_TIME_HOURLY,"
+                    " DAY_AHEAD_HOURLY"
+                ),
             )
 
         if location_type:
@@ -279,7 +282,10 @@ def get_lmp(
 
             if market == Markets.REAL_TIME_5_MIN:
                 warnings.warn(
-                    "When using Real Time 5 Minute market, location_type filter will happen after all data is downloaded",
+                    (
+                        "When using Real Time 5 Minute market, location_type filter"
+                        " will happen after all data is downloaded"
+                    ),
                 )
             else:
                 params["type"] = f"*{location_type}*"
@@ -298,7 +304,10 @@ def get_lmp(
 
         elif locations is not None:
             warnings.warn(
-                "Querying before archive date, so filtering by location will happen after all data is downloaded",
+                (
+                    "Querying before archive date, so filtering by location will happen"
+                    " after all data is downloaded"
+                ),
             )
 
         data = self._get_pjm_json(
@@ -524,7 +533,6 @@ def _get_key(self):
 
 
 if __name__ == "__main__":
-
     import gridstatus
 
     for i in gridstatus.all_isos:

gridstatus/spp.py

@@ -99,7 +99,8 @@ def get_status(self, date=None, verbose=False):
 
         if (
             status_text
-            == "SPP is currently in Normal Operations with no effective advisories or alerts."
+            == "SPP is currently in Normal Operations with no effective advisories or"
+            " alerts."
         ):
             status = "Normal"
             notes = [status_text]
@@ -116,7 +117,6 @@ def get_status(self, date=None, verbose=False):
         )
 
     def get_fuel_mix(self, date, verbose=False):
-
         if date != "latest":
             raise NotSupported
 
@@ -159,7 +159,8 @@ def get_load(self, date, verbose=False):
     def get_load_forecast(self, date, forecast_type="MID_TERM", verbose=False):
         """
 
-        type (str): MID_TERM is hourly for next 7 days or SHORT_TERM is every five minutes for a few hours
+        type (str): MID_TERM is hourly for next 7 days or
+            SHORT_TERM is every five minutes for a few hours
         """
         df = self._get_load_and_forecast(verbose=verbose)
 
@@ -276,7 +277,8 @@ def get_interconnection_queue(self, verbose=False):
             "Substation or Line": "Interconnection Location",
         }
 
-        # todo: there are a few columns being parsed as "unamed" that aren't being included but should
+        # todo: there are a few columns being parsed
+        # as "unamed" that aren't being included but should
         extra_columns = [
             "In-Service Date",
             "Commercial Operation Date",
@@ -552,7 +554,10 @@ def _get_location_list(self, location_type, verbose=False):
         return df["SETTLEMENT_LOCATION"].unique().tolist()
 
     def _fs_get_rtbm_lmp_by_location_paths(self, date, verbose=False):
-        """Lists files for Real-Time Balancing Market (RTBM), Locational Marginal Price (LMP) by Settlement Location (SL)"""
+        """
+        Lists files for Real-Time Balancing Market (RTBM),
+        Locational Marginal Price (LMP) by Settlement Location (SL)
+        """
         if date == "latest":
             paths = ["/RTBM-LMP-SL-latestInterval.csv"]
         elif utils.is_today(date, self.default_timezone):
@@ -582,7 +587,10 @@ def _fetch_and_concat_csvs(self, paths: list, fs_name: str, verbose: bool = Fals
         return pd.concat(all_dfs)
 
     def _fs_get_dam_lmp_by_location_paths(self, date, verbose=False):
-        """Lists files for Day-ahead Market (DAM), Locational Marginal Price (LMP) by Settlement Location (SL)"""
+        """
+        Lists files for Day-ahead Market (DAM),
+        Locational Marginal Price (LMP) by Settlement Location (SL)
+        """
         paths = []
         if date == "latest":
             raise ValueError(

gridstatus/tests/test_ercot.py

@@ -101,7 +101,6 @@ def test_ercot_get_load_3_days_ago():
 
 
 def test_ercot_get_fuel_mix():
-
     # today
     iso = gridstatus.Ercot()
     cols = [

gridstatus/tests/test_viz.py

@@ -4,7 +4,6 @@
 
 
 def test_dam_heat_map():
-
     iso = gridstatus.CAISO()
 
     df = iso.get_lmp(
@@ -21,7 +20,8 @@ def test_dam_heat_map():
     assert isinstance(fig, plotly.graph_objs._figure.Figure)
 
     # check if works with hour too
-    # not the best test since we dont know if the viz is actually using it instead of time
+    # not the best test since we dont know if
+    # the viz is actually using it instead of time
     df["Hour"] = df["Time"].dt.hour
     fig = gridstatus.viz.dam_heat_map(df)
     assert isinstance(fig, plotly.graph_objs._figure.Figure)

gridstatus/utils.py

@@ -55,7 +55,6 @@ def make_availability_df():
         for method in methods:
             availability[i.__name__][method] = {}
             for date in ["latest", "today", "historical"]:
-
                 test = date
                 if date == "historical":
                     test = pd.Timestamp.now(
@@ -240,7 +239,8 @@ def load_folder(path, time_zone=None, verbose=True):
 
     Arguments:
         path {str} -- path to folder
-        time_zone {str} -- time zone to localize to timestamps. By default returns as UTC
+        time_zone {str} -- time zone to localize to timestamps.
+            By default returns as UTC
 
     Returns:
         pd.DataFrame -- dataframe of all files

gridstatus/viz.py

@@ -6,7 +6,8 @@ def dam_heat_map(df):
 
     Args:
         df (pd.DataFrame): A DataFrame with columns "Time", "Location", and "LMP".
-        If Hour is specified, it will be used as the x-axis. Otherwise, the hour ending will be used instead of Time
+            If Hour is specified, it will be used as the x-axis.
+            Otherwise, the hour ending will be used instead of Time
 
 
     Returns: