Merge pull request #105 from alliander-opensource/feature/isort

Add isort to pre-commit

Author: bramstoeller

.pre-commit-config.yaml

@@ -7,6 +7,10 @@ repos:
     rev: v1.0.0
     hooks:
       - id: reuse
+  - repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+     - id: isort
   - repo: https://github.com/psf/black
     rev: 22.6.0
     hooks:

CONTRIBUTING.md

@@ -64,6 +64,7 @@ corrections) to your code (style) before each commit. It is up to the developer
 use this tool or not. The goal is to make sure that each commit will pass the quality checks in the github actions
 workflow. Currently, these hooks are defined in [`.pre-commit-config.yaml`](.pre-commit-config.yaml):
 * **reuse**: check if all licence headers and files are in place
+* **isort**: sort import statements
 * **black**: check and correct code style
 * **pylint**: check code style
 * **pytest**: run all unit tests

pyproject.toml

@@ -68,5 +68,9 @@ addopts = ["--cov=power_grid_model", "--cov-report", "term", "--cov-report", "ht
 line-length = 120
 target-version = ['py38']
 
+[tool.isort]
+src_paths = ["src", "tests/unit", "scripts"]
+profile = "black"
+
 [tool.pylint]
 max-line-length = 120

scripts/validate_batch_data.py

@@ -7,7 +7,12 @@
 
 from power_grid_model import CalculationType
 from power_grid_model.manual_testing import import_json_data
-from power_grid_model.validation import errors_to_string, validate_batch_data, InputData, UpdateData
+from power_grid_model.validation import (
+    InputData,
+    UpdateData,
+    errors_to_string,
+    validate_batch_data,
+)
 
 input_file = Path("../tests/data/power_flow/dummy-test-batch/input.json")
 update_file = Path("../tests/data/power_flow/dummy-test-batch/update_batch.json")

scripts/validate_input_data.py

@@ -7,7 +7,7 @@
 
 from power_grid_model import CalculationType
 from power_grid_model.manual_testing import import_json_data
-from power_grid_model.validation import errors_to_string, validate_input_data, InputData
+from power_grid_model.validation import InputData, errors_to_string, validate_input_data
 
 input_file = Path("../tests/data/state_estimation/dummy-test-sym/input.json")
 

setup.py

@@ -3,26 +3,24 @@
 # SPDX-License-Identifier: MPL-2.0
 
 import os
+import platform
 import re
 import shutil
 from itertools import chain
+from pathlib import Path
+from sysconfig import get_paths
 
 # noinspection PyPackageRequirements
-import numpy as np
+import Cython.Compiler.Main as CythonCompiler
 
 # noinspection PyPackageRequirements
-import Cython.Compiler.Main as CythonCompiler
+import numpy as np
 
 # noinspection PyPackageRequirements
 import requests
-import platform
-from sysconfig import get_paths
-from setuptools import Extension
-from setuptools.command.build_ext import build_ext
-from setuptools import setup
-from pathlib import Path
 from pybuild_header_dependency import HeaderResolver
-
+from setuptools import Extension, setup
+from setuptools.command.build_ext import build_ext
 
 # determine platform, only windows or linux
 if platform.system() == "Windows":

src/power_grid_model/__init__.py

@@ -7,4 +7,11 @@
 # pylint: disable=no-name-in-module
 
 from ._power_grid_core import PowerGridModel, initialize_array, power_grid_meta_data
-from .enum import BranchSide, CalculationMethod, CalculationType, LoadGenType, MeasuredTerminalType, WindingType
+from .enum import (
+    BranchSide,
+    CalculationMethod,
+    CalculationType,
+    LoadGenType,
+    MeasuredTerminalType,
+    WindingType,
+)

src/power_grid_model/enum.py

@@ -11,7 +11,6 @@
 
 from enum import Enum, IntEnum
 
-
 # pylint: disable=invalid-name
 
 

src/power_grid_model/validation/__init__.py

@@ -4,7 +4,11 @@
 
 """Power Grid Model input/update data validation"""
 
-from .assertions import assert_valid_input_data, assert_valid_batch_data, ValidationException
+from .assertions import (
+    ValidationException,
+    assert_valid_batch_data,
+    assert_valid_input_data,
+)
 from .errors import ValidationError
-from .utils import errors_to_string, InputData, UpdateData
-from .validation import validate_input_data, validate_batch_data
+from .utils import InputData, UpdateData, errors_to_string
+from .validation import validate_batch_data, validate_input_data

src/power_grid_model/validation/assertions.py

@@ -8,10 +8,10 @@
 """
 from typing import Dict, List, Optional, Union
 
+from ..enum import CalculationType
 from .errors import ValidationError
 from .utils import InputData, UpdateData, errors_to_string
-from .validation import validate_input_data, validate_batch_data
-from ..enum import CalculationType
+from .validation import validate_batch_data, validate_input_data
 
 
 class ValidationException(ValueError):