Fix license header whitespaces, drop pycodestyle E linting

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
pyxem · Jan 1, 2025 · 7ab68b6 · 7ab68b6
1 parent 0f7020e
commit 7ab68b6
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 32 deletions.
diff --git a/.github/workflows/perhaps_make_tagged_release_draft.py b/.github/workflows/perhaps_make_tagged_release_draft.py
@@ -1,4 +1,5 @@
-# Copyright 2019-2024 The kikuchipy developers
+#
+# Copyright 2019-2025 the kikuchipy developers
 #
 # This file is part of kikuchipy.
 #
@@ -13,7 +14,7 @@
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.
+# along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.#
 
 import re
 
@@ -45,10 +46,12 @@
             elif line.startswith(pypi_version):
                 changelog_end = i - 1
     with open("release_part_in_changelog.rst", mode="w") as f:
+        # fmt: off
         f.write(
             "kikuchipy is an open-source Python library for processing, simulating and indexing of electron backscatter diffraction (EBSD) patterns.\n\n"
             f"See below, the `changelog <https://kikuchipy.org/en/stable/changelog.html>`_ or the `GitHub changelog <https://github.com/pyxem/kikuchipy/compare/v{pypi_version}...v{branch_version}>`_ for all updates from the previous release.\n\n"
         )
+        # fmt: on
         for line in content[changelog_start:changelog_end]:
             f.write(line)
 

diff --git a/.license.tmpl b/.license.tmpl
@@ -9,8 +9,8 @@ the Free Software Foundation, either version 3 of the License, or
 
 ${projectname} is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
-along with ${projectname}.  If not, see <http://www.gnu.org/licenses/>.
+along with ${projectname}. If not, see <http://www.gnu.org/licenses/>.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -10,11 +10,11 @@
 ##
 ## kikuchipy is distributed in the hope that it will be useful,
 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 ## GNU General Public License for more details.
 ##
 ## You should have received a copy of the GNU General Public License
-## along with kikuchipy.  If not, see <http://www.gnu.org/licenses/>.##
+## along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.##
 repos:
   # https://docs.astral.sh/ruff/configuration
   - repo: https://github.com/astral-sh/ruff-pre-commit
@@ -30,7 +30,7 @@ repos:
       files: \.ipynb
       args: [--line-length=77]
   - repo: https://github.com/johann-petrak/licenseheaders.git
-    rev: 'v0.8.8'
+    rev: v0.8.8
     hooks:
         - id: licenseheaders
           args: ["-t", ".license.tmpl", "-cy", "-n", "kikuchipy", "-f"]

diff --git a/pyproject.toml b/pyproject.toml
@@ -165,21 +165,17 @@ filterwarnings = [
     "ignore:Unable to import recommended hash 'siphash24.siphash13'",
 ]
 
-[tool.isort]
-profile = "black"
-filter_files = true
-force_sort_within_sections = true
-
+# https://docs.astral.sh/ruff/configuration
 [tool.ruff.lint]
+exclude = ["*.ipynb"]
 select = [
-    # Pyflakes
-    "F",
-    # Pycodestyle
-    "E",
-    "W",
-    # isort
-    "I"
+    "F",  # Pyflakes
+    "W",  # Pycodestyle
+    "I",  # isort
 ]
+# https://docs.astral.sh/ruff/settings/#lintisort
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
 
 [tool.ruff.format]
 exclude = ["*.ipynb"]
diff --git a/tests/test_detectors/test_ebsd_detector.py b/tests/test_detectors/test_ebsd_detector.py
@@ -10,11 +10,11 @@
 #
 # kikuchipy is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with kikuchipy.  If not, see <http://www.gnu.org/licenses/>.#
+# along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.#
 
 from copy import deepcopy
 
@@ -231,7 +231,8 @@ def test_gnomonic_scale(self, pc1, shape, desired_x_scale, desired_y_scale):
         assert np.allclose(detector.y_scale, desired_y_scale, atol=1e-6)
 
     @pytest.mark.parametrize(
-        "tilt, azimuthal, twist, sample_tilt, expected_angle, expected_axis, expected_rotation",
+        "tilt, azimuthal, twist, sample_tilt, expected_angle, expected_axis, "
+        "expected_rotation",
         [
             (
                 0,
@@ -1220,7 +1221,8 @@ def test_get_indexer(self):
 
 class TestSaveLoadDetector:
     @pytest.mark.parametrize(
-        "nav_shape, shape, convention, sample_tilt, tilt, px_size, binning, azimuthal, twist",
+        "nav_shape, shape, convention, sample_tilt, tilt, px_size, binning, azimuthal, "
+        "twist",
         [
             ((3, 4), (10, 20), "bruker", 70, 0, 70, 1, 0, 0),
             ((1, 5), (5, 5), "tsl", 69.5, 3.14, 57.2, 2, 3.7, 0.003),

diff --git a/tests/test_io/test_nordif_calibration_patterns.py b/tests/test_io/test_nordif_calibration_patterns.py
@@ -1,4 +1,5 @@
-# Copyright 2019-2024 The kikuchipy developers
+#
+# Copyright 2019-2025 the kikuchipy developers
 #
 # This file is part of kikuchipy.
 #
@@ -13,7 +14,7 @@
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.
+# along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.#
 
 from matplotlib.pyplot import imread
 import numpy as np
@@ -86,7 +87,8 @@ def test_logs_incorrect_shapes(self, caplog, nordif_path):
             [
                 "Could not read area (electron image) shape",
                 "Could not read area ROI 'Top'",
-                "Number of samples (3, 3) differs from the one calculated from area/ROI shapes (4, 4)",
+                "Number of samples (3, 3) differs from the one calculated from area/ROI"
+                " shapes (4, 4)",
                 "No area image found",
             ],
         ):

diff --git a/tests/test_signals/test_ebsd_hough_indexing.py b/tests/test_signals/test_ebsd_hough_indexing.py
@@ -1,4 +1,5 @@
-# Copyright 2019-2024 The kikuchipy developers
+#
+# Copyright 2019-2025 the kikuchipy developers
 #
 # This file is part of kikuchipy.
 #
@@ -13,7 +14,7 @@
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.
+# along with kikuchipy. If not, see <http://www.gnu.org/licenses/>.#
 
 from diffpy.structure import Lattice, Structure
 from diffsims.crystallography import ReciprocalLatticeVector
@@ -52,10 +53,12 @@ def test_hough_indexing_print_information(self):
         )
         info_list = info.split("\n")
         # fmt: off
-        assert info_list[0] ==     "Hough indexing with PyEBSDIndex information:"
+        assert info_list[0] == "Hough indexing with PyEBSDIndex information:"
         assert info_list[1][:12] == "  PyOpenCL: "
-        assert info_list[2] ==     "  Projection center (Bruker, mean): (0.4251, 0.2134, 0.5007)"
-        assert info_list[3] ==     "  Indexing 9 pattern(s) in 3 chunk(s)"
+        assert info_list[2] == (
+            "  Projection center (Bruker, mean): (0.4251, 0.2134, 0.5007)"
+        )
+        assert info_list[3] == "  Indexing 9 pattern(s) in 3 chunk(s)"
         # fmt: on
 
         det_pc_mean = det.deepcopy()
@@ -170,7 +173,9 @@ def test_indexer_is_compatible_with_signal(self):
         assert not _indexer_is_compatible_with_kikuchipy(indexer, (60, 60), 8)
         with pytest.raises(
             ValueError,
-            match=r"`indexer.PC` must be an array of shape \(3,\) or \(8, 3\), but was ",
+            match=(
+                r"`indexer.PC` must be an array of shape \(3,\) or \(8, 3\), but was "
+            ),
         ):
             _indexer_is_compatible_with_kikuchipy(
                 indexer, (60, 60), 8, raise_if_not=True