cleaned up pytest errors

Author: engineerjoe440

conftest.py

@@ -0,0 +1,9 @@
+# Pytest configuration
+
+import pytest
+import numpy as np
+
+@pytest.fixture(scope="session", autouse=True)
+def setup_environment():
+    """Use Legacy Numpy Printing Options for consistent test outputs."""
+    np.set_printoptions(legacy='1.25')

electricpy/geometry/__init__.py

@@ -16,14 +16,16 @@
 
 import math
 from dataclasses import dataclass
-from typing import Iterable, Iterator, Optional, Tuple, Union
+from typing import Iterator, Tuple, Union
 
 
 Number = Union[int, float]
 
 
 def _as_float(x) -> float:
     """
+    Cast as a float.
+
     Coerce numeric-like values (including complex with ~0 imag) to float.
     This defends against accidental cmath usage elsewhere in the library.
     """
@@ -40,7 +42,8 @@ def _is_close(a: float, b: float, *, rel_tol: float = 1e-9, abs_tol: float = 1e-
 
 @dataclass(frozen=False)
 class Point:
-    """A point in 2D space.
+    """
+    A point in 2D space.
 
     Parameters
     ----------
@@ -49,6 +52,7 @@ class Point:
     y : float
         The y coordinate of the point
     """
+
     x: float
     y: float
 
@@ -78,18 +82,18 @@ def is_close(self, other: "Point", *, tol: float = 1e-9) -> bool:
         return _is_close(self.x, other.x, rel_tol=tol, abs_tol=tol) and _is_close(self.y, other.y, rel_tol=tol, abs_tol=tol)
 
     def __repr__(self) -> str:
+        """Developer representation of the Point."""
         return f"Point({self.x}, {self.y})"
 
     def __str__(self) -> str:
+        """Representation of the Point."""
         return f"({self.x}, {self.y})"
 
 
 @dataclass(frozen=False)
 class Line:
-    """A line in 2D space in the form:
+    """A line in 2D space in the form (`ax + by + c = 0`)."""
 
-        ax + by + c = 0
-    """
     a: float
     b: float
     c: float
@@ -149,6 +153,8 @@ def intersection(self, other: object) -> Point:
 
     def normalized(self) -> Tuple[float, float, float]:
         """
+        Normalize the geometry coefficients.
+
         Return a normalized (a,b,c) such that sqrt(a^2+b^2)=1 and sign is stable.
         This helps with comparisons and distances.
         """
@@ -178,6 +184,8 @@ def is_close(self, other: "Line", *, tol: float = 1e-9) -> bool:
 
     def __eq__(self, other: object) -> bool:
         """
+        Evaluate the equality of geometric object.
+
         Exact-ish equality (proportional coefficients), but using normalization for
         better behavior than raw ratio checks. This is safer than the original.
         """
@@ -186,10 +194,11 @@ def __eq__(self, other: object) -> bool:
         return self.is_close(other, tol=1e-9)
 
     def __repr__(self) -> str:
+        """Developer representation of the Line."""
         return f"Line({self.a}, {self.b}, {self.c})"
 
     def __str__(self) -> str:
-        # Keep a readable form; avoid division by zero when possible.
+        """Keep a readable form; avoid division by zero when possible."""
         if _is_close(self.a, 0.0):
             # by + c = 0 => y = -c/b
             return f"y = {-self.c / self.b}"
@@ -220,8 +229,8 @@ def angle_btw_lines(l1: Line, l2: Line) -> float:
         raise ValueError("Cannot compute angle for degenerate line.")
 
     # Clamp to [-1,1] to protect against tiny numeric drift
-    cosang = max(-1.0, min(1.0, dot / (n1 * n2)))
-    ang = math.acos(cosang)
+    cosine_angle = max(-1.0, min(1.0, dot / (n1 * n2)))
+    ang = math.acos(cosine_angle)
 
     # Return acute angle
     if ang > math.pi / 2:

electricpy/geometry/circle.py

@@ -1,7 +1,6 @@
 ################################################################################
 """
-electricpy.geometry.circle - Collection of methods which operate on Cartesian
-circles.
+electricpy.geometry.circle - Collection of methods for Cartesian circles.
 
 >>> import electricpy.geometry.circle as circle
 
@@ -13,7 +12,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Generator, Iterable, Optional, Tuple, Union, overload
+from typing import Generator, Tuple, Union
 import math
 
 from electricpy import geometry
@@ -52,6 +51,7 @@ class Circle:
     radius : float
         The radius of the circle (must be >= 0)
     """
+
     center: Point
     radius: float
 
@@ -139,9 +139,9 @@ def is_tangent(self, l: Line, *, tol: float = 1e-9) -> bool:
 
     def is_normal(self, l: Line, *, tol: float = 1e-9) -> bool:
         """
-        Return True if the line passes through the circle's center (within tolerance).
+        Line passes through the circle's center (within tolerance).
 
-        IMPORTANT
+        Important
         ---------
         A line being a "normal to the circle" is only well-defined at a specific
         point of contact. This method keeps backward compatibility with the
@@ -175,11 +175,11 @@ def equation(self) -> str:
         B = -2.0 * k
         C = const
 
-        def _term(coeff: float, var: str) -> str:
-            if _is_close(coeff, 0.0):
+        def _term(coef: float, var: str) -> str:
+            if _is_close(coef, 0.0):
                 return ""
-            sign = " + " if coeff > 0 else " - "
-            mag = abs(coeff)
+            sign = " + " if coef > 0 else " - "
+            mag = abs(coef)
             # Prefer integer-like display when possible
             if _is_close(mag, round(mag)):
                 mag_str = str(int(round(mag)))
@@ -343,20 +343,25 @@ def intersetion(self, other) -> Union[None, Point, Tuple[Point, Point], str]:
     # Dunder methods
     # -------------------------------------------------------------------------
     def __repr__(self) -> str:
+        """Representation of the Circle."""
         return f"Circle(center={self.center}, radius={self.radius})"
 
     def __str__(self) -> str:
+        """Form of the Circle."""
         return f"Circle(center={self.center}, radius={self.radius})"
 
     def __eq__(self, other: object) -> bool:
+        """Equality comparison for Circle."""
         if isinstance(other, Circle):
             return self.center == other.center and self.radius == other.radius
         return False
 
     def __ne__(self, other: object) -> bool:
+        """Inequality comparison for Circle."""
         return not self == other
 
     def __hash__(self) -> int:
+        """Hash for Circle."""
         return hash((self.center, self.radius))
 
 

electricpy/geometry/triangle.py

@@ -1,7 +1,6 @@
 ################################################################################
 """
-electricpy.geometry.triangle - Collection of methods which operate on Cartesian
-triangles.
+electricpy.geometry.triangle - Collection of methods for Cartesian triangles.
 
 >>> import electricpy.geometry.triangle as triangle
 
@@ -12,7 +11,7 @@
 
 from __future__ import annotations
 
-from typing import Iterable, Optional, Sequence, Tuple, Union
+from typing import Tuple, Union
 import math
 
 from electricpy.geometry import Point, Line
@@ -42,9 +41,7 @@ def _is_close(a: float, b: float, *, rel_tol: float = 1e-9, abs_tol: float = 1e-
 
 
 def _triangle_twice_area(p0: Point, p1: Point, p2: Point) -> float:
-    """
-    Return twice the signed area (cross product magnitude).
-    """
+    """Return twice the signed area (cross product magnitude)."""
     return (p1.x - p0.x) * (p2.y - p0.y) - (p1.y - p0.y) * (p2.x - p0.x)
 
 
@@ -115,9 +112,7 @@ def perimeter(self) -> float:
         return self.a + self.b + self.c
 
     def perimeters(self) -> float:
-        """
-        Backward-compatible alias for perimeter().
-        """
+        """Backward-compatible alias for perimeter()."""
         return self.perimeter()
 
     def area(self) -> float:
@@ -151,9 +146,9 @@ def centroid(self) -> Point:
 
     def in_center(self) -> Point:
         """
-        Return the incenter of the triangle.
+        Return the in_center of the triangle.
 
-        The incenter is the weighted average of vertices by the lengths of
+        The in_center is the weighted average of vertices by the lengths of
         the opposite sides. With our naming:
           a = |p0-p1| opposite vertex p2
           b = |p1-p2| opposite vertex p0
@@ -172,7 +167,7 @@ def in_center(self) -> Point:
 
     def in_radius(self) -> float:
         """
-        Return the inradius of the triangle.
+        Return the in_radius of the triangle.
 
         r = A / s where s is semiperimeter.
         """
@@ -184,12 +179,12 @@ def in_radius(self) -> float:
 
     def ortho_center(self) -> Point:
         """
-        Return the orthocenter of the triangle.
+        Return the ortho_center of the triangle.
 
         Construct two altitudes:
         - altitude from p0 to line through p1-p2
         - altitude from p1 to line through p0-p2
-        Their intersection is the orthocenter.
+        Their intersection is the ortho_center.
 
         Requires Line objects returned by geometry.line_equation to support:
         - foot_perpendicular(Point) -> Point
@@ -207,7 +202,7 @@ def ortho_center(self) -> Point:
 
     def circum_center(self) -> Point:
         """
-        Return the circumcenter of the triangle.
+        Return the circum_center of the triangle.
 
         Intersection of perpendicular bisectors of two sides.
         """
@@ -217,21 +212,23 @@ def circum_center(self) -> Point:
 
     def circum_radius(self) -> float:
         """
-        Return the circumradius of the triangle.
+        Return the circum_radius of the triangle.
 
         R = abc / (4A)
         """
         A = self.area()
         if _is_close(A, 0.0, abs_tol=self._tol):
-            raise ValueError("Degenerate triangle: area is zero, circumradius undefined")
+            raise ValueError("Degenerate triangle: area is zero, circum_radius undefined")
         return (self.a * self.b * self.c) / (4.0 * A)
 
     # -------------------------------------------------------------------------
     # Validation
     # -------------------------------------------------------------------------
     def __is_valid(self) -> bool:
         """
-        Validate triangle:
+        Validate triangle.
+
+        Checks:
         - triangle inequality with tolerance
         - non-collinear (non-degenerate) using cross-product area test
         """

electricpy/passive.py

@@ -126,7 +126,7 @@ def capbacktoback(C1, C2, Lm, VLN=None, VLL=None):
     Function to calculate the maximum current and the
     frequency of the inrush current of two capacitors
     connected in parallel when one (energized) capacitor
-    is switched into another (non-engergized) capacitor.
+    is switched into another (non-energized) capacitor.
 
     .. note:: This formula is only valid for three-phase systems.
 
@@ -443,7 +443,7 @@ def air_core_inductance(d: float, coil_l: float, n: int):
 
 def air_core_required_length(d: float, L: float, n: int):
     r"""
-    Compute Required Length of Air Core Inductor
+    Compute Required Length of Air Core Inductor.
 
     .. math:: l = \frac{1000 d^2 n^2 - 457418 d L}{1016127 L}
 
@@ -467,7 +467,7 @@ def air_core_required_length(d: float, L: float, n: int):
 
 def air_core_required_diameter(coil_l: float, L: float, n: int):
     r"""
-    Compute Diameter of Air Core Inductor
+    Compute Diameter of Air Core Inductor.
 
     .. math:: 1000 n^2 d^2 - 457418 L d - 1016127 L l = 0
 
@@ -496,7 +496,7 @@ def air_core_required_diameter(coil_l: float, L: float, n: int):
 
 def air_core_required_num_turns(d: float, coil_l: float, L: float):
     r"""
-    Compute Required Number of Turns of Air Core Inductor
+    Compute Required Number of Turns of Air Core Inductor.
 
     .. math:: n = \sqrt{\frac{L(1016127 l + 457418 d)}{1000 d^2}}
 

test/__init__.py

@@ -1,6 +1,5 @@
 from electricpy.geometry import Point
 from electricpy.geometry import Line
-import numpy as np
 from numpy.testing import assert_almost_equal
 
 def compare_points(p1: Point, p2: Point) -> bool: