chore: use ruff (#1474)

* chore: use ruff * add release note
PyPSA · Jan 3, 2025 · 151dc73 · 151dc73
1 parent 6a974d0
commit 151dc73
Show file tree

Hide file tree

Showing 114 changed files with 459 additions and 518 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,25 +8,19 @@ repos:
   rev: v5.0.0
   hooks:
   - id: check-merge-conflict
-  - id: end-of-file-fixer
-  - id: fix-encoding-pragma
-  - id: mixed-line-ending
-  - id: trailing-whitespace
   - id: check-added-large-files
     args: ["--maxkb=2000"]
 
-  # Sort package imports alphabetically
-- repo: https://github.com/PyCQA/isort
-  rev: 5.13.2
+# Run ruff to lint and format
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.8.1
   hooks:
-  - id: isort
-    args: ["--profile", "black", "--filter-files"]
-
-  # Convert relative imports to absolute imports
-- repo: https://github.com/MarcoGorelli/absolufy-imports
-  rev: v0.3.1
-  hooks:
-  - id: absolufy-imports
+    # Run the linter.
+  - id: ruff
+    args: [--fix]
+    # Run the formatter.
+  - id: ruff-format
 
   # Find common spelling mistakes in comments and docstrings
 - repo: https://github.com/codespell-project/codespell
@@ -37,37 +31,15 @@ repos:
     types_or: [python, rst, markdown]
     files: ^(scripts|doc)/
 
-# Make docstrings PEP 257 compliant
-# Broken for pre-commit<=4.0.0
-# See https://github.com/PyCQA/docformatter/issues/293
-# - repo: https://github.com/PyCQA/docformatter
-#   rev: v1.7.5
-#   hooks:
-#   - id: docformatter
-#     args: ["--in-place", "--make-summary-multi-line", "--pre-summary-newline"]
-
-- repo: https://github.com/keewis/blackdoc
-  rev: v0.3.9
-  hooks:
-  - id: blackdoc
-
-  # Formatting with "black" coding style
-- repo: https://github.com/psf/black-pre-commit-mirror
-  rev: 24.10.0
-  hooks:
-      # Format Python files
-  - id: black
-      # Format Jupyter Python notebooks
-  - id: black-jupyter
-
-  # Remove output from Jupyter notebooks
+# Remove output from Jupyter notebooks
 - repo: https://github.com/aflc/pre-commit-jupyter
   rev: v1.2.1
   hooks:
   - id: jupyter-notebook-cleanup
-    args: ["--remove-kernel-metadata"]
+    args: ['--remove-kernel-metadata']
+    exclude: examples/solve-on-remote.ipynb
 
-  # Do YAML formatting (before the linter checks it for misses)
+  # YAML formatting
 - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
   rev: v2.14.0
   hooks:
@@ -81,13 +53,6 @@ repos:
   hooks:
   - id: snakefmt
 
-  # For cleaning jupyter notebooks
-- repo: https://github.com/aflc/pre-commit-jupyter
-  rev: v1.2.1
-  hooks:
-  - id: jupyter-notebook-cleanup
-    exclude: examples/solve-on-remote.ipynb
-
   # Check for FSFE REUSE compliance (licensing)
 - repo: https://github.com/fsfe/reuse-tool
   rev: v5.0.2

diff --git a/config/create_scenarios.py b/config/create_scenarios.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # SPDX-FileCopyrightText: : 2023-2024 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
@@ -7,7 +6,7 @@
 # You can modify the template to your needs and define all possible combinations of config values that should be considered.
 
 if "snakemake" in globals():
-    filename = snakemake.output[0]
+    filename = snakemake.output[0]  # noqa: F821
 else:
     filename = "../config/scenarios.yaml"
 

diff --git a/data/custom_extra_functionality.py b/data/custom_extra_functionality.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # SPDX-FileCopyrightText: : 2023- The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT

diff --git a/doc/conf.py b/doc/conf.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # SPDX-FileCopyrightText: Contributors to PyPSA-Eur <https://github.com/pypsa/pypsa-eur>
 #
 # SPDX-License-Identifier: MIT

diff --git a/doc/release_notes.rst b/doc/release_notes.rst
@@ -109,7 +109,9 @@ Upcoming Release
 
 * Bugfix: Align the naming convention for the CO2 network configuration (from `co2network` to `co2_network`). This may be a small breaking change.
 
-* Feature: The installation via `make install` now prioritizes mamba over conda for faster installation. Conda is still used as a fallback. The command `make install` now also supports passing the name of the environment, e.g. `make install name=my-project`.
+* Development: The installation via `make install` now prioritizes mamba over conda for faster installation. Conda is still used as a fallback. The command `make install` now also supports passing the name of the environment, e.g. `make install name=my-project`.
+
+* Development: Ruff is now used for linting and formatting. It is used in the pre-commit, so no changes are needed. But you might wanna set it up in your IDE.
 
 * Update locations and capacities of ammonia plants.
 

diff --git a/envs/environment.yaml b/envs/environment.yaml
@@ -48,7 +48,6 @@ dependencies:
 - jpype1
 - pyxlsb
 - graphviz
-- pre-commit
 - geojson
 
 # Keep in conda environment when calling ipython
@@ -60,6 +59,10 @@ dependencies:
 - rasterio==1.4.1
 - libgdal-core<3.10.0 # rasterio>=1.4.2 needed for GDAL 3.10
 
+# Development dependencies
+- pre-commit
+- ruff
+
 - pip:
   - gurobipy
   - highspy<1.8

diff --git a/ruff.toml b/ruff.toml
@@ -0,0 +1,53 @@
+# SPDX-FileCopyrightText: : 2021-2024 The PyPSA-Eur Authors
+#
+# SPDX-License-Identifier: CC0-1.0
+
+extend-include = ['*.ipynb']
+
+[lint]
+select = [
+    'F',   # pyflakes
+    'E',   # pycodestyle: Error
+    'W',   # pycodestyle: Warning
+    'I',   # isort
+    'D',   # pydocstyle
+    'UP',  # pyupgrade
+    # 'ANN', # flake-8 annotations
+    'TID', # flake8-tidy-imports
+    # 'NPY', # numpy
+    # 'RUF', # ruff
+]
+
+ignore = [
+    'ANN401', # Dynamically typed expressions are forbidden
+    'E712', # comparison to False should be 'if cond is False:' or 'if not cond:'
+    'E741', # ambiguous variable names
+    'D203', # 1 blank line required before class docstring
+    'D212', # Multi-line docstring summary should start at the second line
+    'D401', # First line should be in imperative mood
+    ]
+
+
+[lint.per-file-ignores]
+# pydocstyle ignores, which could be enabled in future when existing
+# issues are fixed
+"!**/{xxx.py}" = [
+    'E501', # line too long
+    'D100', # Missing docstring in public module
+    'D101', # Missing docstring in public class
+    'D102', # Missing docstring in public method
+    'D103', # Missing docstring in public function
+    'D104', # Missing docstring in public package
+    'D105', # Missing docstring in magic method
+    'D107', # Missing docstring in __init__
+    'D200', # One-line docstring should fit on one line with quotes
+    'D202', # No blank lines allowed after function docstring
+    'D205', # 1 blank line required between summary line and description
+    'D400', # First line should end with a period
+    'D404', # First word of the docstring should not be "This
+    'D413', # Missing blank line after last section
+    'D415', # First line should end with a period, question mark, or exclamation point
+    'D417', # Missing argument descriptions in the docstring
+    # Include once available
+    # https://github.com/astral-sh/ruff/issues/2310
+    ]
diff --git a/scripts/__init__.py b/scripts/__init__.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # SPDX-FileCopyrightText: Contributors to PyPSA-Eur <https://github.com/pypsa/pypsa-eur>
 #
 # SPDX-License-Identifier: MIT

diff --git a/scripts/_benchmark.py b/scripts/_benchmark.py
@@ -1,10 +1,7 @@
-# -*- coding: utf-8 -*-
 # SPDX-FileCopyrightText: Contributors to PyPSA-Eur <https://github.com/pypsa/pypsa-eur>
 #
 # SPDX-License-Identifier: MIT
-""" """
 
-from __future__ import absolute_import, print_function
 
 import logging
 import os
@@ -42,7 +39,7 @@ def __init__(
         self.timestamps = kw.pop("timestamps", True)
         self.include_children = kw.pop("include_children", True)
 
-        super(MemTimer, self).__init__(*args, **kw)
+        super().__init__(*args, **kw)
 
     def run(self):
         # get baseline memory usage
@@ -58,7 +55,7 @@ def run(self):
 
         if self.filename is not None:
             stream = open(self.filename, "w")
-            stream.write("MEM {0:.6f} {1:.4f}\n".format(*cur_mem))
+            stream.write("MEM {:.6f} {:.4f}\n".format(*cur_mem))
             stream.flush()
         else:
             stream = None
@@ -74,7 +71,7 @@ def run(self):
             )
 
             if stream is not None:
-                stream.write("MEM {0:.6f} {1:.4f}\n".format(*cur_mem))
+                stream.write("MEM {:.6f} {:.4f}\n".format(*cur_mem))
                 stream.flush()
 
             n_measurements += 1
@@ -95,7 +92,7 @@ def run(self):
         self.pipe.send(n_measurements)
 
 
-class memory_logger(object):
+class memory_logger:
     """
     Context manager for taking and reporting memory measurements at fixed
     intervals from a separate process, for the duration of a context.
@@ -185,7 +182,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         return False
 
 
-class timer(object):
+class timer:
     level = 0
     opened = False
 
@@ -211,14 +208,14 @@ def __enter__(self):
 
     def print_usec(self, usec):
         if usec < 1000:
-            print("%.1f usec" % usec)
+            print(f"{usec:.1f} usec")
         else:
             msec = usec / 1000
             if msec < 1000:
-                print("%.1f msec" % msec)
+                print(f"{msec:.1f} msec")
             else:
                 sec = msec / 1000
-                print("%.1f sec" % sec)
+                print(f"{sec:.1f} sec")
 
     def __exit__(self, exc_type, exc_val, exc_tb):
         if not self.opened and self.verbose:
@@ -239,7 +236,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         return False
 
 
-class optional(object):
+class optional:
     def __init__(self, variable, contextman):
         self.variable = variable
         self.contextman = contextman

diff --git a/scripts/_helpers.py b/scripts/_helpers.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # SPDX-FileCopyrightText: Contributors to PyPSA-Eur <https://github.com/pypsa/pypsa-eur>
 #
 # SPDX-License-Identifier: MIT
@@ -10,7 +9,6 @@
 import os
 import re
 import time
-import urllib
 from functools import partial, wraps
 from os.path import exists
 from pathlib import Path
@@ -189,13 +187,13 @@ def set_scenario_config(snakemake):
     scenario = snakemake.config["run"].get("scenarios", {})
     if scenario.get("enable") and "run" in snakemake.wildcards.keys():
         try:
-            with open(scenario["file"], "r") as f:
+            with open(scenario["file"]) as f:
                 scenario_config = yaml.safe_load(f)
         except FileNotFoundError:
             # fallback for mock_snakemake
             script_dir = Path(__file__).parent.resolve()
             root_dir = script_dir.parent
-            with open(root_dir / scenario["file"], "r") as f:
+            with open(root_dir / scenario["file"]) as f:
                 scenario_config = yaml.safe_load(f)
         update_config(snakemake.config, scenario_config[snakemake.wildcards.run])
 
@@ -748,9 +746,9 @@ def update_config_from_wildcards(config, w, inplace=True):
         if dg_enable:
             config["sector"]["electricity_distribution_grid"] = True
             if dg_factor is not None:
-                config["sector"][
-                    "electricity_distribution_grid_cost_factor"
-                ] = dg_factor
+                config["sector"]["electricity_distribution_grid_cost_factor"] = (
+                    dg_factor
+                )
 
         if "biomasstransport" in opts:
             config["sector"]["biomass_transport"] = True
@@ -883,12 +881,12 @@ def rename_techs(label: str) -> str:
 
     Removes some prefixes and renames if certain conditions defined in function body are met.
 
-    Parameters:
+    Parameters
     ----------
     label: str
         Technology label to be renamed
 
-    Returns:
+    Returns
     -------
     str
         Renamed label

diff --git a/scripts/add_brownfield.py b/scripts/add_brownfield.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # SPDX-FileCopyrightText: Contributors to PyPSA-Eur <https://github.com/pypsa/pypsa-eur>
 #
 # SPDX-License-Identifier: MIT
@@ -19,7 +18,6 @@
     update_config_from_wildcards,
 )
 from add_existing_baseyear import add_build_year_to_new_assets
-from pypsa.clustering.spatial import normed_or_uniform
 
 logger = logging.getLogger(__name__)
 idx = pd.IndexSlice

diff --git a/scripts/add_electricity.py b/scripts/add_electricity.py
@@ -1,7 +1,7 @@
-# -*- coding: utf-8 -*-
 # SPDX-FileCopyrightText: Contributors to PyPSA-Eur <https://github.com/pypsa/pypsa-eur>
 #
 # SPDX-License-Identifier: MIT
+
 """
 Adds existing electrical generators, hydro-electric plants as well as
 greenfield and battery and hydrogen storage to the clustered network.
@@ -111,8 +111,6 @@
 """
 
 import logging
-from pathlib import Path
-from typing import Dict, List
 
 import numpy as np
 import pandas as pd
@@ -502,9 +500,7 @@ def attach_wind_and_solar(
                     + connection_cost
                 )
                 logger.info(
-                    "Added connection cost of {:0.0f}-{:0.0f} Eur/MW/a to {}".format(
-                        connection_cost.min(), connection_cost.max(), car
-                    )
+                    f"Added connection cost of {connection_cost.min():0.0f}-{connection_cost.max():0.0f} Eur/MW/a to {car}"
                 )
             else:
                 capital_cost = costs.at[car, "capital_cost"]
@@ -746,7 +742,7 @@ def attach_hydro(n, costs, ppl, profile_hydro, hydro_capacities, carriers, **par
         )
 
 
-def attach_OPSD_renewables(n: pypsa.Network, tech_map: Dict[str, List[str]]) -> None:
+def attach_OPSD_renewables(n: pypsa.Network, tech_map: dict[str, list[str]]) -> None:
     """
     Attach renewable capacities from the OPSD dataset to the network.