simplify warning and error names

Author: jcapriot

pymatsolver/__init__.py

@@ -63,7 +63,7 @@
 from .direct import Solver, pardiso
 from .direct import SolverLU
 
-from .solvers import PymatsolverAccuracyError
+from .solvers import SolverAccuracyError
 from .direct import Pardiso, Mumps
 from .direct.pardiso import _available as _pardiso_available
 from .direct.mumps import _available as _mumps_available

pymatsolver/solvers.py

@@ -7,7 +7,11 @@
 import copy
 
 
-class PymatsolverAccuracyError(Exception):
+class SolverAccuracyError(Exception):
+    pass
+
+
+class UnusedArgumentWarning(UserWarning):
     pass
 
 
@@ -93,7 +97,7 @@ def __init__(
         if kwargs:
             warnings.warn(
                 f"Unused keyword arguments for {self.__class__.__name__}: {kwargs.keys()}",
-                UserWarning,
+                UnusedArgumentWarning,
                 stacklevel=3
             )
 
@@ -275,7 +279,7 @@ def _compute_accuracy(self, rhs, x):
         rhs_norm = np.linalg.norm(rhs)
         tolerance = max(self.check_rtol * rhs_norm, self.check_atol)
         if resid_norm > tolerance:
-            raise PymatsolverAccuracyError(
+            raise SolverAccuracyError(
                 f'Accuracy on solve is above tolerance: {resid_norm} > {tolerance}'
             )
 

pymatsolver/wrappers.py

@@ -2,7 +2,7 @@
 from inspect import signature
 import numpy as np
 
-from pymatsolver.solvers import Base
+from pymatsolver.solvers import Base, UnusedArgumentWarning
 
 def _valid_kwargs_for_func(func, **kwargs):
     """Validates keyword arguments for a function by inspecting its signature.
@@ -28,7 +28,7 @@ def _valid_kwargs_for_func(func, **kwargs):
             sig.bind_partial(**{key: value})
             valid_kwargs[key] = value
         except TypeError:
-            warnings.warn(f'Unused keyword argument "{key}" for {func.__name__}.', UserWarning, stacklevel=3)
+            warnings.warn(f'Unused keyword argument "{key}" for {func.__name__}.', UnusedArgumentWarning, stacklevel=3)
             # stack level of three because we want the warning issued at the call
             # to the wrapped solver's `__init__` method.
     return valid_kwargs

tests/test_Basic.py

@@ -4,6 +4,7 @@
 import scipy.sparse as sp
 import pymatsolver
 from pymatsolver import Diagonal
+from pymatsolver.solvers import UnusedArgumentWarning
 
 TOL = 1e-12
 
@@ -84,7 +85,7 @@ def test_errors_and_warnings():
     with pytest.warns(FutureWarning, match="accuracy_tol is deprecated.*"):
         IdentitySolver(np.full((4, 4), 1), accuracy_tol=0.41)
 
-    with pytest.warns(UserWarning, match="Unused keyword arguments.*"):
+    with pytest.warns(UnusedArgumentWarning, match="Unused keyword arguments.*"):
         IdentitySolver(np.full((4, 4), 1), not_an_argument=4)
 
     with pytest.raises(TypeError, match="is_symmetric must be a boolean."):

tests/test_Pardiso.py

@@ -128,7 +128,7 @@ def test_inacurrate_symmetry(test_mat_data):
     D = sp.diags(np.linspace(2, 3, A.shape[0]))
     A = A @ D
     Ainv = pymatsolver.Pardiso(A, is_symmetric=True, check_accuracy=True)
-    with pytest.raises(pymatsolver.PymatsolverAccuracyError):
+    with pytest.raises(pymatsolver.SolverAccuracyError):
         Ainv * rhs
 
 

tests/test_Wrappers.py

@@ -1,4 +1,5 @@
 from pymatsolver import SolverCG, SolverLU, wrap_direct, wrap_iterative
+from pymatsolver.solvers import UnusedArgumentWarning
 import pytest
 import scipy.sparse as sp
 import warnings
@@ -10,7 +11,7 @@
 def test_wrapper_unused_kwargs(solver_class):
     A = sp.eye(10)
 
-    with pytest.warns(UserWarning, match="Unused keyword argument.*"):
+    with pytest.warns(UnusedArgumentWarning, match="Unused keyword argument.*"):
         solver_class(A, not_a_keyword_arg=True)
 
 def test_good_arg_iterative():