Merge pull request #254 from roryyorke/lint-fixes-small

Minimum lint fixes and suppressions to pass CI

Author: roryyorke

BUILD.rst

@@ -62,9 +62,9 @@ The test command is the same as when building from the sdist::
 Non-isolated, editable build
 ----------------------------
 
-When doing development one builds over and over; in that case it's faster to do a non-isolated editable build.  Run or adapt developer script `inplace-editable-build.bash`_ for that.
+When doing development one builds over and over; in that case it's faster to do a non-isolated editable build.  Run or adapt developer script `inplace-editable-build.bash`_ for that.  CMake variables can be set to configure the build; for example, in the command below, ``BLA_VENDOR`` is set to tell CMake to use the Netlib BLAS/LAPACK libraries.  This example is not merely illustrative: on Debian 13 *not* specifying ``BLA_VENDOR`` can cause test failures.
 
-.. _`inplace-editable-build.bash`: ./dev-tools/inplace-editable-build.bash
+.. _`inplace-editable-build.bash`: BLA_VENDOR=Generic ./dev-tools/inplace-editable-build.bash
 
 
 Customizing the build

dev-tools/inplace-editable-build.bash

@@ -20,6 +20,9 @@
 #      - BLAS and LAPACK libraries
 #
 #  Tested on Debian 13.
+#
+#  Select a BLAS/LAPACK provider with environment variable BLA_VENDOR; see
+#    https://cmake.org/cmake/help/latest/module/FindBLAS.html#blas-lapack-vendors
 
 set -euo pipefail
 
@@ -28,6 +31,10 @@ if [ ! -f ./dev-tools/inplace-editable-build.bash ]; then
     exit 1;
 fi
 
+if [ ! -v BLA_VENDOR ]; then
+    echo "BLA_VENDOR is not set.  This is known to sometimes cause test failures";
+fi
+
 echo "--Build"
 python -m venv venv-build
 source venv-build/bin/activate

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["scikit-build-core", "numpy"]
+requires = ["scikit-build-core>=1.0", "numpy"]
 build-backend = "scikit_build_core.build"
 
 [project]
@@ -43,16 +43,21 @@ test = ["pytest", "scipy"]
 [project.urls]
 homepage = "https://github.com/python-control/Slycot"
 
+[[tool.dynamic-metadata]]
+field = "version"
+provider = "scikit_build_core.metadata.setuptools_scm"
+
 [tool.scikit-build]
-metadata.version.provider = "scikit_build_core.metadata.setuptools_scm"
 wheel.exclude = ["slycot/src/", "slycot/CMakeLists.txt", "slycot/slicot-source.cmake", "slycot/scipy-openblas-symbols"]
 
 [tool.pytest.ini_options]
 # run the tests with compiled and installed package
 addopts = "--pyargs slycot"
 
 [tool.ruff.lint]
-ignore = [ "E741" ]
+ignore = [
+ "I001", # import order & formatting
+]
 
 [tool.cibuildwheel]
 # scipy-openblas32 version specified here

slycot/__init__.py

@@ -72,15 +72,15 @@
 
 
 __all__ = [
-    ab01nd, ab04md, ab05md, ab05nd, ab07nd, ab08nd, ab08nz,
-    ab09ad, ab09ax, ab09bd, ab09md, ab09nd, ab13bd, ab13dd,
-    ab13ed, ab13fd, ab13md, ag08bd, mb02ed, mb03rd, mb03vd,
-    mb03vy, mb03wd, mb05md, mb05nd, mc01td, sb01bd, sb02md,
-    sb02mt, sb02od, sb03md, sb03md57, sb03od, sb04md, sb04qd,
-    sb10ad, sb10dd, sb10fd, sb10hd, sb10jd, sb10yd, sg02ad,
-    sg03ad, sg03bd, tb01id, tb01pd, tb03ad, tb04ad, tb05ad,
-    tc01od, tc04ad, td04ad, tf01md, tf01rd, tg01ad, tg01fd,
-    __version__
+    '__version__',
+    'ab01nd', 'ab04md', 'ab05md', 'ab05nd', 'ab07nd', 'ab08nd', 'ab08nz',
+    'ab09ad', 'ab09ax', 'ab09bd', 'ab09md', 'ab09nd', 'ab13bd', 'ab13dd',
+    'ab13ed', 'ab13fd', 'ab13md', 'ag08bd', 'mb02ed', 'mb03rd', 'mb03vd',
+    'mb03vy', 'mb03wd', 'mb05md', 'mb05nd', 'mc01td', 'sb01bd', 'sb02md',
+    'sb02mt', 'sb02od', 'sb03md', 'sb03md57', 'sb03od', 'sb04md', 'sb04qd',
+    'sb10ad', 'sb10dd', 'sb10fd', 'sb10hd', 'sb10jd', 'sb10yd', 'sg02ad',
+    'sg03ad', 'sg03bd', 'tb01id', 'tb01pd', 'tb03ad', 'tb04ad', 'tb05ad',
+    'tc01od', 'tc04ad', 'td04ad', 'tf01md', 'tf01rd', 'tg01ad', 'tg01fd',
     ]
 
 def test():

slycot/examples.py

@@ -190,10 +190,13 @@ def tb03ad_example():
     print('is the following:' )
     print('index', out[4])
     k_max = max(out[4]) + 1
+    # ruff: disable[PIE808]
     for k in range(0,k_max):
+        # ruff: disable[UP031]
         print('P_%d =' %(k))
         print(out[5][0:m,0:m,k])
     for k in range(0,k_max):
+        # ruff: disable[UP031]
         print('Q_%d =' %(k))
         print(out[6][0:m,0:p,k])
 
@@ -254,13 +257,15 @@ def tb05ad_example():
     p = np.shape(C)[0]
 
     jw_s = [1j*11, 1j*15]
+    # ruff: disable[RUF059]
     at, bt, ct, g_1, hinvb,info = slycot.tb05ad(n, m, p, jw_s[0],
                                                A, B, C, job='NG')
     g_2, hinv2, info = slycot.tb05ad(n, m, p, jw_s[1], at, bt, ct, job='NH')
     print('--- Example for tb05ad...')
     print('Frequency response for (A, B, C)')
     print('-------------------------')
     print('Frequency  |     Response')
+    # ruff: disable[UP031]
     print('%s        | %s '%(jw_s[0], g_1[0, 0]))
     print('%s        | %s '%(jw_s[1], g_2[0, 0]))
 

slycot/exceptions.py

@@ -27,6 +27,7 @@ class SlycotError(RuntimeError):
     """Slycot exception base class"""
 
     def __init__(self, message, info):
+        # ruff: disable[UP008]
         super(SlycotError, self).__init__(message)
         self.info = info
 
@@ -37,20 +38,21 @@ class SlycotParameterError(SlycotError, ValueError):
     In case of a wrong input value, the SLICOT routines return a negative
     info parameter indicating which parameter was illegal.
     """
-
+    # ruff: disable[PIE790]
     pass
 
 
 class SlycotArithmeticError(SlycotError, ArithmeticError):
     """A Slycot computation failed"""
-
+    # ruff: disable[PIE790]
     pass
 
 
 class SlycotWarning(UserWarning):
     """Slycot Warning"""
 
     def __init__(self, message, iwarn, info):
+        # ruff: disable[UP008]
         super(SlycotWarning, self).__init__(message)
         self.info = info
         self.iwarn = iwarn
@@ -62,7 +64,7 @@ class SlycotResultWarning(SlycotWarning):
     A Slycot routine returned a nonzero info parameter that warns about the
     returned results, but the results might still be usable.
     """
-
+    # ruff: disable[PIE790]
     pass
 
 
@@ -101,7 +103,9 @@ def _parse_docsection(section_name, docstring, checkvars):
                     infospec_indent = len(imatch.group(1))
                     infospec = imatch.group(2)
                     # Don't handle the standard case unless we have i
+                    # ruff: disable[SIM102]
                     if infospec == "info = -i":
+                        # ruff: disable[SIM118]
                         if 'i' not in checkvars.keys():
                             continue
                     infospec_ = infospec.replace(" = ", " == ")
@@ -242,18 +246,21 @@ def raise_if_slycot_error(info, arg_list=None, docstring=None, checkvars=None):
             return
 
     if info < 0 and arg_list:
+        # ruff: disable[UP032]
         message = ("The following argument had an illegal value: {}"
                    "".format(arg_list[-info-1]))
         raise SlycotParameterError(message, info)
 
     # catch all
     if info > 0:
+        # ruff: disable[UP032]
         raise SlycotError("Caught unhandled nonzero INFO value {}"
                           "".format(info),
                           info)
     if iwarn is None and 'iwarn' in checkvars:
         iwarn = checkvars['iwarn']
     if iwarn:
+        # ruff: disable[UP032]
         warn(SlycotWarning("Caught unhandled nonzero IWARN value {}"
                            "".format(iwarn),
                            iwarn, info))

slycot/scipy-openblas-symbols/generate_def.py

@@ -95,6 +95,7 @@ def main():
     )
 
     with open("scipy-openblas-symbols.def", "wt") as outfile:
+        # ruff: disable[FURB122]
         for symbol in blas + lapack + own_symbols + lapack_exclusions:
             outfile.write(f"-D{symbol.upper()}=SCIPY_{symbol.upper()}\n")
 

slycot/synthesis.py

@@ -1087,6 +1087,7 @@ def sb04qd(n,m,A,B,C,ldwork=None):
             for the ({info}-{m})-th column of matrix X.
     """
     hidden = ' (hidden by the wrapper)'
+    # ruff: disable[PLW0127, PLW0128]
     arg_list =     arg_list = ['n', 'm', 'A', 'LDA' + hidden,  'B', 'LDB' + hidden,
                 'C', 'LDC' + hidden,  'Z', 'LDZ' + hidden,
                 'IWORK' + hidden, 'DWORK' + hidden, 'ldwork', 'INFO' + hidden]
@@ -2378,6 +2379,7 @@ def sg02ad(dico,jobb,fact,uplo,jobl,scal,sort,acc,N,M,P,A,E,B,Q,R,L,ldwork=None,
     elif (jobb == 'B'):
         if (fact == 'N'):
             out = _wrapper.sg02ad_bn(dico,uplo,jobl,scal,sort,acc,N,M,A,E,B,Q,R,L,tol,ldwork)
+        #ruff: disable[SIM114]
         elif (fact == 'C'):
             out = _wrapper.sg02ad_bc(dico,jobl,scal,sort,acc,N,M,P,A,E,B,Q,R,L,tol,ldwork)
         elif (fact == 'D'):

slycot/tests/test_ab08n.py

@@ -53,6 +53,7 @@ def ab08nX(self, ab08fun, A, B, C, D):
         assert_allclose(Af[:nu, :nu], np.array([[-4.]]))
         # Compute the structural invariants of the given system.
         out = ab08fun(n, m, p, A, B, C, D)
+        # ruff: disable[RUF059]
         nu, rank, dinfz, nkror, nkrol, infz, kronr, kronl, Af, Bf = out[:10]
         assert_equal(nu, 2)
         # Compute the invariant zeros of the given system.

slycot/tests/test_ab09nd.py

@@ -38,6 +38,7 @@ def test_slicot_ref():
 
     d = np.zeros((3,2))
 
+    # ruff: disable[RUF059]
     nr, ar, br, cr, dr, ns, hsv = \
             ab09nd(dico, job, equil, n, m, p, a, b, c, d, alpha, nr, tol1, tol2)
 
@@ -85,6 +86,7 @@ def test_gh242_regression():
     c = np.zeros((p, n))
     d = np.array([[42.24]])
 
+    # ruff: disable[RUF059]
     nr, ar, br, cr, dr, ns, hsv = \
         ab09nd(dico='C', job='B', equil='S', n=a.shape[0],
                m=b.shape[1], p=c.shape[0], A=a, B=b, C=c, D=d)