[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

docs/conf.py

@@ -25,9 +25,9 @@
 
 # Location of Sphinx files
 sys.path.insert(0, os.path.abspath("./../"))  ##Add the folder one level above
-os.environ[
-    "SPHINX_APIDOC_OPTIONS"
-] = "members,show-inheritance"  ## Hide undocumented members
+os.environ["SPHINX_APIDOC_OPTIONS"] = (
+    "members,show-inheritance"  ## Hide undocumented members
+)
 import sphinx.ext.apidoc
 
 # from sphinx_gallery.sorting import FileNameSortKey

magpylib/_src/defaults/defaults_utility.py

@@ -1,4 +1,5 @@
 """utilities for creating property classes"""
+
 # pylint: disable=too-many-branches
 import collections.abc
 import re

magpylib/_src/display/backend_matplotlib.py

@@ -1,4 +1,5 @@
 """matplotlib backend"""
+
 # pylint: disable=too-many-branches
 # pylint: disable=too-many-statements
 # pylint: disable=import-outside-toplevel

magpylib/_src/display/backend_plotly.py

@@ -1,4 +1,5 @@
 """plotly backend"""
+
 # pylint: disable=C0302
 # pylint: disable=too-many-branches
 import inspect

magpylib/_src/display/backend_pyvista.py

@@ -1,4 +1,5 @@
 """pyvista backend"""
+
 # pylint: disable=too-many-branches
 # pylint: disable=too-many-statements
 import os

magpylib/_src/display/display.py

@@ -1,4 +1,5 @@
 """ Display function codes"""
+
 import warnings
 from contextlib import contextmanager
 from importlib import import_module

magpylib/_src/display/traces_base.py

@@ -1,4 +1,5 @@
 """base traces building functions"""
+
 from functools import partial
 
 import numpy as np

magpylib/_src/display/traces_core.py

@@ -1,4 +1,5 @@
 """Generic trace drawing functionalities"""
+
 # pylint: disable=C0302
 # pylint: disable=too-many-branches
 # pylint: disable=too-many-statements

magpylib/_src/display/traces_generic.py

@@ -1,4 +1,5 @@
 """Generic trace drawing functionalities"""
+
 # pylint: disable=C0302
 # pylint: disable=too-many-branches
 # pylint: disable=too-many-statements
@@ -559,9 +560,7 @@ def get_generic_traces(
         tr["showlegend"] = (
             showlegend
             if showlegend is not None
-            else tr_showleg
-            if style.legend.show
-            else False
+            else tr_showleg if style.legend.show else False
         )
     out = {"generic": path_traces_generic}
 
@@ -580,11 +579,11 @@ def get_generic_traces(
                             "opacity": style.opacity,
                             "color": style.color,
                             "legendgroup": legendgroup,
-                            "showlegend": showlegend
-                            if showlegend is not None
-                            else None
-                            if style.legend.show
-                            else False,
+                            "showlegend": (
+                                showlegend
+                                if showlegend is not None
+                                else None if style.legend.show else False
+                            ),
                             "name": legendtext if legendtext else legend_label,
                             "row": row,
                             "col": col,

magpylib/_src/display/traces_utility.py

@@ -1,4 +1,5 @@
 """ Display function codes"""
+
 # pylint: disable=too-many-branches
 from collections import defaultdict
 from functools import lru_cache
@@ -136,9 +137,7 @@ def draw_arrowed_line(
     anchor = (
         (0, -0.5, 0)
         if pivot == "tip"
-        else (0, 0.5, 0)
-        if pivot == "tail"
-        else (0, 0, 0)
+        else (0, 0.5, 0) if pivot == "tail" else (0, 0, 0)
     )
     arrow = [
         [0, arrow_shift, 0],

magpylib/_src/fields/field_BH_circle.py

@@ -2,6 +2,7 @@
 Implementations of analytical expressions for the magnetic field of
 a circular current loop. Computation details in function docstrings.
 """
+
 import warnings
 
 import numpy as np

magpylib/_src/fields/field_BH_cuboid.py

@@ -2,6 +2,7 @@
 Implementations of analytical expressions for the magnetic field of homogeneously
 magnetized Cuboids. Computation details in function docstrings.
 """
+
 import numpy as np
 
 from magpylib._src.input_checks import check_field_input

magpylib/_src/fields/field_BH_cylinder.py

@@ -2,6 +2,7 @@
 Implementations of analytical expressions for the magnetic field of
 homogeneously magnetized Cylinders. Computation details in function docstrings.
 """
+
 # pylint: disable = no-name-in-module
 import numpy as np
 from scipy.special import ellipe
@@ -154,10 +155,7 @@ def fieldH_cylinder_diametral(
                 + 3
                 / 8
                 * r3X
-                * (
-                    (1 - 4 * zp2X) / zpp**3 / sqrt_p
-                    - (1 - 4 * zm2X) / zmm**3 / sqrt_m
-                )
+                * ((1 - 4 * zp2X) / zpp**3 / sqrt_p - (1 - 4 * zm2X) / zmm**3 / sqrt_m)
                 + 15
                 / 64
                 * r5X

magpylib/_src/fields/field_BH_cylinder_segment.py

@@ -147,10 +147,7 @@ def Hz_ri_case115(r, r_i, r_bar_i, phi_bar_j, phi_bar_M, theta_M):
     E_coef = np.sin(theta_M) * np.cos(phi_bar_M) * np.abs(r_bar_i) / r
     F = ellipkinc(phi_bar_j / 2.0, -4.0 * r * r_i / r_bar_i**2)
     F_coef = (
-        -np.sin(theta_M)
-        * np.cos(phi_bar_M)
-        * (r**2 + r_i**2)
-        / (r * np.abs(r_bar_i))
+        -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (r * np.abs(r_bar_i))
     )
     return t1_coef * t1 + E_coef * E + F_coef * F
 
@@ -222,10 +219,7 @@ def Hz_ri_case125(r, r_i, r_bar_i, phi_bar_j, phi_bar_M, theta_M):
     E_coef = np.sin(theta_M) * np.cos(phi_bar_M) * np.abs(r_bar_i) / r
     F = ellipkinc(phi_bar_j / 2.0, -4.0 * r * r_i / r_bar_i**2)
     F_coef = (
-        -np.sin(theta_M)
-        * np.cos(phi_bar_M)
-        * (r**2 + r_i**2)
-        / (r * np.abs(r_bar_i))
+        -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (r * np.abs(r_bar_i))
     )
     return np.sin(theta_M) * np.sin(phi_bar_M) * (r + r_i) / r + E_coef * E + F_coef * F
 
@@ -349,9 +343,7 @@ def Hz_ri_case135(r, r_i, r_bar_i, phi_bar_j, phi_bar_M, theta_M):
     E = ellipeinc(phi_bar_j / 2.0, -4.0 * r * r_i / t)
     E_coef = np.sin(theta_M) * np.cos(phi_bar_M) * np.sqrt(t) / r
     F = ellipkinc(phi_bar_j / 2.0, -4.0 * r * r_i / t)
-    F_coef = (
-        -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (r * np.sqrt(t))
-    )
+    F_coef = -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (r * np.sqrt(t))
     return t1_coef * t1 + E_coef * E + F_coef * F
 
 
@@ -508,9 +500,7 @@ def Hr_zk_case214(r, phi_bar_j, theta_M, z_bar_k):
     t = np.sqrt(r**2 + z_bar_k**2)
 
     def Pi1(sign):
-        return el3_angle(
-            phi_bar_j / 2, 2 * r / (r + sign * t), -4 * r**2 / z_bar_k**2
-        )
+        return el3_angle(phi_bar_j / 2, 2 * r / (r + sign * t), -4 * r**2 / z_bar_k**2)
 
     def Pi1_coef(sign):
         return (
@@ -603,9 +593,7 @@ def Hz_zk_case214(r, phi_bar_j, theta_M, z_bar_k):
     t = np.sqrt(r**2 + z_bar_k**2)
 
     def Pi(sign):
-        return el3_angle(
-            phi_bar_j / 2, 2 * r / (r + sign * t), -4 * r**2 / z_bar_k**2
-        )
+        return el3_angle(phi_bar_j / 2, 2 * r / (r + sign * t), -4 * r**2 / z_bar_k**2)
 
     Pi_coef = np.cos(theta_M) * np.sign(z_bar_k)
     return Pi_coef * Pi(1) + Pi_coef * Pi(-1)
@@ -728,9 +716,7 @@ def Hphi_ri_case215(r, r_i, r_bar_i, phi_bar_j, phi_bar_M, theta_M, z_bar_k):
     t1 = np.sqrt(r_bar_i**2 + z_bar_k**2) * z_bar_k / (2.0 * r**2)
     t1_coef = -np.sin(theta_M) * np.cos(phi_bar_M)
     t2 = np.arctanh(z_bar_k / np.sqrt(r_bar_i**2 + z_bar_k**2))
-    t2_coef = (
-        -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (2.0 * r**2)
-    )
+    t2_coef = -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (2.0 * r**2)
     E = ellipeinc(phi_bar_j / 2.0, -4.0 * r * r_i / (r_bar_i**2 + z_bar_k**2))
     E_coef = (
         np.sin(theta_M)
@@ -902,9 +888,7 @@ def Hz_phij_case223(r, phi_bar_M, theta_M, z_bar_k):
 
 
 def Hz_zk_case223(r, phi_bar_j, theta_M, z_bar_k):
-    t1 = arctan_k_tan_2(
-        np.sqrt(r**2 + z_bar_k**2) / np.abs(z_bar_k), 2.0 * phi_bar_j
-    )
+    t1 = arctan_k_tan_2(np.sqrt(r**2 + z_bar_k**2) / np.abs(z_bar_k), 2.0 * phi_bar_j)
     t1_coef = np.cos(theta_M) * np.sign(z_bar_k)
     return t1_coef * t1
 
@@ -1163,9 +1147,7 @@ def Hphi_ri_case225(r, r_i, r_bar_i, phi_bar_j, phi_bar_M, theta_M, z_bar_k):
     t1 = np.sqrt((r + r_i) ** 2 + z_bar_k**2) * z_bar_k / (2.0 * r**2)
     t1_coef = -np.sin(theta_M) * np.cos(phi_bar_M)
     t2 = np.arctanh(z_bar_k / np.sqrt((r + r_i) ** 2 + z_bar_k**2))
-    t2_coef = (
-        -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (2.0 * r**2)
-    )
+    t2_coef = -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (2.0 * r**2)
     E = ellipeinc(phi_bar_j / 2.0, -4.0 * r * r_i / (r_bar_i**2 + z_bar_k**2))
     E_coef = (
         np.sin(theta_M)
@@ -1400,9 +1382,7 @@ def Hz_phij_case233(r, phi_bar_j, phi_bar_Mj, theta_M, z_bar_k):
 
 
 def Hz_zk_case233(r, phi_bar_j, theta_M, z_bar_k):
-    t1 = arctan_k_tan_2(
-        np.sqrt(r**2 + z_bar_k**2) / np.abs(z_bar_k), 2.0 * phi_bar_j
-    )
+    t1 = arctan_k_tan_2(np.sqrt(r**2 + z_bar_k**2) / np.abs(z_bar_k), 2.0 * phi_bar_j)
     t1_coef = np.cos(theta_M) * np.sign(z_bar_k)
     return t1_coef * t1
 
@@ -1480,9 +1460,7 @@ def Pi1_coef(sign):
 
     def Pi2(sign):
         return el3_angle(
-            arctan_k_tan_2(
-                np.sqrt((4.0 * r**2 + z_bar_k**2) / z_bar_k**2), phi_bar_j
-            ),
+            arctan_k_tan_2(np.sqrt((4.0 * r**2 + z_bar_k**2) / z_bar_k**2), phi_bar_j),
             1.0 - z_bar_k**4 / ((4.0 * r**2 + z_bar_k**2) * (r + sign * t) ** 2),
             4.0 * r**2 / (4.0 * r**2 + z_bar_k**2),
         )
@@ -1647,9 +1625,7 @@ def Hr_phij_case235(r, r_i, phi_bar_j, phi_bar_Mj, theta_M, z_bar_k):
         / (
             r
             * np.sin(phi_bar_j)
-            * np.sqrt(
-                r**2 + r_i**2 - 2.0 * r * r_i * np.cos(phi_bar_j) + z_bar_k**2
-            )
+            * np.sqrt(r**2 + r_i**2 - 2.0 * r * r_i * np.cos(phi_bar_j) + z_bar_k**2)
         )
     )
     t2_coef = np.sin(theta_M) * np.sin(phi_bar_Mj) * np.sin(phi_bar_j)
@@ -1695,9 +1671,7 @@ def Pi1_coef(sign):
     def Pi2(sign):
         return el3_angle(
             arctan_k_tan_2(
-                np.sqrt(
-                    ((r_i + r) ** 2 + z_bar_k**2) / (r_bar_i**2 + z_bar_k**2)
-                ),
+                np.sqrt(((r_i + r) ** 2 + z_bar_k**2) / (r_bar_i**2 + z_bar_k**2)),
                 phi_bar_j,
             ),
             1.0
@@ -1740,9 +1714,7 @@ def Hphi_ri_case235(r, r_i, r_bar_i, phi_bar_j, phi_bar_M, theta_M, z_bar_k):
         z_bar_k
         / np.sqrt(r**2 + r_i**2 - 2.0 * r * r_i * np.cos(phi_bar_j) + z_bar_k**2)
     )
-    t2_coef = (
-        -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (2.0 * r**2)
-    )
+    t2_coef = -np.sin(theta_M) * np.cos(phi_bar_M) * (r**2 + r_i**2) / (2.0 * r**2)
     E = ellipeinc(phi_bar_j / 2.0, -4.0 * r * r_i / (r_bar_i**2 + z_bar_k**2))
     E_coef = (
         np.sin(theta_M)

magpylib/_src/fields/field_BH_dipole.py

@@ -1,6 +1,7 @@
 """
 Core implementation of dipole field
 """
+
 import numpy as np
 
 from magpylib._src.input_checks import check_field_input

magpylib/_src/fields/field_BH_polyline.py

@@ -1,6 +1,7 @@
 """
 Implementations of analytical expressions of line current segments
 """
+
 import warnings
 
 import numpy as np

magpylib/_src/fields/field_BH_sphere.py

@@ -2,6 +2,7 @@
 Implementations of analytical expressions for the magnetic field of homogeneously
 magnetized Spheres. Computation details in function docstrings.
 """
+
 import numpy as np
 
 from magpylib._src.input_checks import check_field_input

magpylib/_src/fields/field_BH_tetrahedron.py

@@ -2,6 +2,7 @@
 Implementation for the magnetic field of homogeneously
 magnetized tetrahedra. Computation details in function docstrings.
 """
+
 import numpy as np
 
 from magpylib._src.fields.field_BH_triangle import triangle_field

magpylib/_src/fields/field_BH_triangle.py

@@ -2,6 +2,7 @@
 Implementations of analytical expressions for the magnetic field of a triangular surface.
 Computation details in function docstrings.
 """
+
 # pylance: disable=Code is unreachable
 import numpy as np
 

magpylib/_src/fields/field_BH_triangularmesh.py

@@ -2,6 +2,7 @@
 Implementations of analytical expressions for the magnetic field of a triangular surface.
 Computation details in function docstrings.
 """
+
 # pylint: disable=too-many-nested-blocks
 # pylance: disable=Code is unreachable
 import numpy as np

magpylib/_src/fields/field_wrap_BH.py

@@ -40,6 +40,7 @@
 
 level5(sens.getB, sens.getH): <--- USER INTERFACE
 """
+
 # pylint: disable=cyclic-import
 import numbers
 import warnings

magpylib/_src/input_checks.py

@@ -1,4 +1,5 @@
 """ input checks code"""
+
 # pylint: disable=import-outside-toplevel
 # pylint: disable=cyclic-import
 import inspect

magpylib/_src/obj_classes/class_BaseDisplayRepr.py

@@ -1,4 +1,5 @@
 """BaseGeo class code"""
+
 # pylint: disable=cyclic-import
 # pylint: disable=too-many-branches
 import numpy as np

magpylib/_src/obj_classes/class_BaseExcitations.py

@@ -1,4 +1,5 @@
 """BaseHomMag class code"""
+
 # pylint: disable=cyclic-import
 import warnings
 

magpylib/_src/obj_classes/class_BaseGeo.py

@@ -1,4 +1,5 @@
 """BaseGeo class code"""
+
 # pylint: disable=cyclic-import
 # pylint: disable=too-many-instance-attributes
 # pylint: disable=protected-access

magpylib/_src/obj_classes/class_BaseTransform.py

@@ -1,4 +1,5 @@
 """BaseTransform class code"""
+
 # pylint: disable=protected-access
 import numbers
 

magpylib/_src/obj_classes/class_Collection.py

@@ -1,4 +1,5 @@
 """Collection class code"""
+
 # pylint: disable=redefined-builtin
 # pylint: disable=import-outside-toplevel
 from collections import Counter

magpylib/_src/obj_classes/class_Sensor.py

@@ -1,4 +1,5 @@
 """Sensor class code"""
+
 import numpy as np
 
 from magpylib._src.display.traces_core import make_Sensor

magpylib/_src/obj_classes/class_current_Circle.py

@@ -1,4 +1,5 @@
 """CircularCircle current class code"""
+
 import warnings
 
 from magpylib._src.display.traces_core import make_Circle

magpylib/_src/obj_classes/class_current_Polyline.py

@@ -1,4 +1,5 @@
 """Polyline current class code"""
+
 import warnings
 
 from magpylib._src.display.traces_core import make_Polyline