DEV: add check for misnamed tests (scipy#17655)

Closes scipygh-17652

Regarding the command line output of `dev.py lint`, 
note that the commands are emitted all at once, which is a minor
limitation of using `run_doit_task` rather than having it in a Task
class with methods, like the setup/build/install commands.
Still better than not emitting the commands that are being run at all.

[skip azure] [skip cirrus] [skip circle]

Co-authored-by: Marco Gorelli <marcogorelli@protonmail.com>
Co-authored-by: Ralf Gommers <ralf.gommers@gmail.com>

Author: 3 people

azure-pipelines.yml

@@ -158,6 +158,7 @@ stages:
         # in Checkout stage)
         python tools/lint_diff.py --branch origin/$(System.PullRequest.TargetBranch)
         tools/unicode-check.py
+        tools/check_test_name.py
       displayName: 'Run Lint Checks'
       failOnStderr: true
   - job: Linux_Python_38_32bit_full

dev.py

@@ -861,22 +861,34 @@ def run(cls, **kwargs):
 ###################
 # linters
 
+def emit_cmdstr(cmd):
+    """Print the command that's being run to stdout"""
+    console = Console(theme=console_theme)
+    # The [cmd] square brackets controls the font styling, typically in italics
+    # to differentiate it from other stdout content
+    console.print(f"{EMOJI.cmd} [cmd] {cmd}")
+
+
 @task_params([{'name': 'output_file', 'long': 'output-file', 'default': None,
                'help': 'Redirect report to a file'}])
 def task_flake8(output_file):
     """Run flake8 over the code base and benchmarks."""
     opts = ''
     if output_file:
         opts += f'--output-file={output_file}'
+
+    cmd = f"flake8 {opts} scipy benchmarks/benchmarks"
+    emit_cmdstr(f"{cmd}")
     return {
-        'actions': [f"flake8 {opts} scipy benchmarks/benchmarks"],
+        'actions': [cmd],
         'doc': 'Lint scipy and benchmarks directory',
     }
 
 
 def task_pep8diff():
     # Lint just the diff since branching off of main using a
     # stricter configuration.
+    emit_cmdstr(os.path.join('tools', 'lint_diff.py'))
     return {
         'basename': 'pep8-diff',
         'actions': [str(Dirs().root / 'tools' / 'lint_diff.py')],
@@ -885,6 +897,7 @@ def task_pep8diff():
 
 
 def task_unicode_check():
+    emit_cmdstr(os.path.join('tools', 'unicode-check.py'))
     return {
         'basename': 'unicode-check',
         'actions': [str(Dirs().root / 'tools' / 'unicode-check.py')],
@@ -893,16 +906,30 @@ def task_unicode_check():
     }
 
 
+def task_check_test_name():
+    emit_cmdstr(os.path.join('tools', 'check_test_name.py'))
+    return {
+        "basename": "check-testname",
+        "actions": [str(Dirs().root / "tools" / "check_test_name.py")],
+        "doc": "Check tests are correctly named so that pytest runs them."
+    }
+
+
 @cli.cls_cmd('lint')
 class Lint():
     """:dash: Run flake8, check PEP 8 compliance on branch diff and check for
-    disallowed Unicode characters."""
+    disallowed Unicode characters and possibly-invalid test names."""
     output_file = Option(
         ['--output-file'], default=None, help='Redirect report to a file')
 
     def run(output_file):
         opts = {'output_file': output_file}
-        run_doit_task({'flake8': opts, 'pep8-diff': {}, 'unicode-check': {}})
+        run_doit_task({
+            'flake8': opts,
+            'pep8-diff': {},
+            'unicode-check': {},
+            'check-testname': {},
+        })
 
 
 @cli.cls_cmd('mypy')
@@ -938,6 +965,7 @@ def run(cls, **kwargs):
             os.environ['MYPY_FORCE_COLOR'] = '1'
             # Change to the site directory to make sure mypy doesn't pick
             # up any type stubs in the source tree.
+            emit_cmdstr(f"mypy.api.run --config-file {config} {check_path}")
             report, errors, status = mypy.api.run([
                 "--config-file",
                 str(config),

scipy/optimize/tests/test__numdiff.py

@@ -215,9 +215,6 @@ def jac_zero_jacobian(self, x):
             [-x[1] * np.sin(x[0] * x[1]), -x[0] * np.sin(x[0] * x[1])]
         ])
 
-    def fun_non_numpy(self, x):
-        return math.exp(x)
-
     def jac_non_numpy(self, x):
         # x can be a scalar or an array [val].
         # Cast to true scalar before handing over to math.exp

scipy/optimize/tests/test__spectral.py

@@ -149,7 +149,8 @@ def x0_2(n):
     x0.fill(1/n**2)
     return x0
 
-def F_4(x, n):
+
+def F_4(x, n):  # skip name check
     assert_equal(n % 3, 0)
     g = np.zeros([n])
     # Note: the first line is typoed in some of the references;
@@ -159,7 +160,8 @@ def F_4(x, n):
     g[2::3] = 1.25 * x[2::3] - 0.25*x[2::3]**3
     return g
 
-def x0_4(n):
+
+def x0_4(n):  # skip name check
     assert_equal(n % 3, 0)
     x0 = np.array([-1, 1/2, -1] * (n//3))
     return x0

scipy/optimize/tests/test_linesearch.py

@@ -53,33 +53,33 @@ def assert_fp_equal(x, y, err_msg="", nulp=50):
 
 class TestLineSearch:
     # -- scalar functions; must have dphi(0.) < 0
-    def _scalar_func_1(self, s):
+    def _scalar_func_1(self, s):  # skip name check
         self.fcount += 1
         p = -s - s**3 + s**4
         dp = -1 - 3*s**2 + 4*s**3
         return p, dp
 
-    def _scalar_func_2(self, s):
+    def _scalar_func_2(self, s):  # skip name check
         self.fcount += 1
         p = np.exp(-4*s) + s**2
         dp = -4*np.exp(-4*s) + 2*s
         return p, dp
 
-    def _scalar_func_3(self, s):
+    def _scalar_func_3(self, s):  # skip name check
         self.fcount += 1
         p = -np.sin(10*s)
         dp = -10*np.cos(10*s)
         return p, dp
 
     # -- n-d functions
 
-    def _line_func_1(self, x):
+    def _line_func_1(self, x):  # skip name check
         self.fcount += 1
         f = np.dot(x, x)
         df = 2*x
         return f, df
 
-    def _line_func_2(self, x):
+    def _line_func_2(self, x):  # skip name check
         self.fcount += 1
         f = np.dot(x, np.dot(self.A, x)) + 1
         df = np.dot(self.A + self.A.T, x)

scipy/sparse/tests/test_sparsetools.py

@@ -220,41 +220,41 @@ def get_matrix():
         finally:
             gc.collect()
 
-    def _check_bsr_matvecs(self, m):
+    def _check_bsr_matvecs(self, m):  # skip name check
         m = m()
         n = self.n
 
         # _matvecs
         r = m.dot(np.ones((n, 2), dtype=np.int8))
         assert_equal(r[0, 0], int_to_int8(n))
 
-    def _check_bsr_matvec(self, m):
+    def _check_bsr_matvec(self, m):  # skip name check
         m = m()
         n = self.n
 
         # _matvec
         r = m.dot(np.ones((n,), dtype=np.int8))
         assert_equal(r[0], int_to_int8(n))
 
-    def _check_bsr_diagonal(self, m):
+    def _check_bsr_diagonal(self, m):  # skip name check
         m = m()
         n = self.n
 
         # _diagonal
         r = m.diagonal()
         assert_equal(r, np.ones(n))
 
-    def _check_bsr_sort_indices(self, m):
+    def _check_bsr_sort_indices(self, m):  # skip name check
         # _sort_indices
         m = m()
         m.sort_indices()
 
-    def _check_bsr_transpose(self, m):
+    def _check_bsr_transpose(self, m):  # skip name check
         # _transpose
         m = m()
         m.transpose()
 
-    def _check_bsr_matmat(self, m):
+    def _check_bsr_matmat(self, m):  # skip name check
         m = m()
         n = self.n
 

scipy/special/tests/test_basic.py

@@ -835,7 +835,7 @@ def test_pro_ang1_cv(self):
         assert_array_almost_equal(cephes.pro_ang1_cv(1,1,1,1,0),
                                   array((1.0,0.0)))
 
-    def _check_pro_cv(self):
+    def test_pro_cv(self):
         assert_equal(cephes.pro_cv(1,1,0),2.0)
 
     def test_pro_rad1(self):

scipy/special/tests/test_data.py

@@ -10,7 +10,7 @@
     jn, jv, jvp, yn, yv, yvp, iv, ivp, kn, kv, kvp,
     gamma, gammaln, gammainc, gammaincc, gammaincinv, gammainccinv, digamma,
     beta, betainc, betaincinv, poch,
-    ellipe, ellipeinc, ellipk, ellipkm1, ellipkinc, ellipj,
+    ellipe, ellipeinc, ellipk, ellipkm1, ellipkinc,
     elliprc, elliprd, elliprf, elliprg, elliprj,
     erf, erfc, erfinv, erfcinv, exp1, expi, expn,
     bdtrik, btdtr, btdtri, btdtria, btdtrib, chndtr, gdtr, gdtrc, gdtrix, gdtrib,
@@ -64,10 +64,6 @@ def ellipeinc_(f, k):
     return ellipeinc(f, k*k)
 
 
-def ellipj_(k):
-    return ellipj(k*k)
-
-
 def zeta_(x):
     return zeta(x, 1.)