sage -t, sage -fixdoctests: Rename option --only-lib to --if-installed

Author: Matthias Koeppe

src/bin/sage-fixdoctests

@@ -320,7 +320,7 @@ if not args.no_test:
     environment_args = f'--environment {args.environment} ' if args.environment != runtest_default_environment else ''
     long_args = f'--long ' if args.long else ''
     probe_args = f'--probe {shlex.quote(args.probe)} ' if args.probe else ''
-    lib_args = f'--only-lib ' if args.venv else ''
+    lib_args = f'--if-installed ' if args.venv else ''
     doc_file = tmp_filename()
     if args.venv or environment_args:
        input = os.path.join(os.path.relpath(SAGE_ROOT), 'src', 'sage', 'version.py')

src/bin/sage-runtests

@@ -69,7 +69,7 @@ if __name__ == "__main__":
     parser.add_argument("-i", "--initial", action="store_true", default=False, help="only show the first failure in each file")
     parser.add_argument("--exitfirst", action="store_true", default=False, help="end the test run immediately after the first failure or unexpected exception")
     parser.add_argument("--force_lib", "--force-lib", action="store_true", default=False, help="do not import anything from the tested file(s)")
-    parser.add_argument("--only-lib", action="store_true", default=False, help="skip Python/Cython files that are not installed as modules")
+    parser.add_argument("--if-installed", action="store_true", default=False, help="skip Python/Cython files that are not installed as modules")
     parser.add_argument("--abspath", action="store_true", default=False, help="print absolute paths rather than relative paths")
     parser.add_argument("--verbose", action="store_true", default=False, help="print debugging output during the test")
     parser.add_argument("-d", "--debug", action="store_true", default=False, help="drop into a python debugger when an unexpected error is raised")

src/doc/en/developer/doctesting.rst

@@ -1392,17 +1392,17 @@ tree (``src/sage/...``)::
 
 Note that testing all doctests as they appear in the source tree does not make sense
 because many of the source files may not be installed in the virtual environment.
-Use the option ``--only-lib`` to skip the source files of all Python/Cython modules
+Use the option ``--if-installed`` to skip the source files of all Python/Cython modules
 that are not installed in the virtual environment::
 
     [mkoeppe@sage sage]$ pkgs/sagemath-categories/.tox/sagepython-sagewheels-.../sage -t \
-                             -p4 --environment sage.all__sagemath_categories --only-lib  \
+                             -p4 --environment sage.all__sagemath_categories --if-installed  \
                              src/sage/schemes
 
 This option can also be combined with ``--all``::
 
     [mkoeppe@sage sage]$ pkgs/sagemath-categories/.tox/sagepython-sagewheels-.../sage -t \
-                             -p4 --environment sage.all__sagemath_categories --only-lib  \
+                             -p4 --environment sage.all__sagemath_categories --if-installed  \
                              --all
 
 
@@ -1645,7 +1645,7 @@ that uses the more specific options ``--venv`` and ``--environment``::
                                 src/sage/geometry/schemes/generic/*.py
 
 Either way, the options ``--keep-both``, ``--full-tracebacks``, and
-``--only-lib`` are implied.
+``--if-installed`` are implied.
 
 In this mode of operation, when the doctester encounters a global name
 that is unknown in its virtual environment (:class:`NameError`),

src/sage/doctest/control.py

@@ -123,7 +123,7 @@ def __init__(self, **kwds):
         self.initial = False
         self.exitfirst = False
         self.force_lib = False
-        self.only_lib = False
+        self.if_installed = False
         self.abspath = True         # sage-runtests default is False
         self.verbose = False
         self.debug = False
@@ -225,7 +225,7 @@ def skipdir(dirname):
     return False
 
 def skipfile(filename, tested_optional_tags=False, *,
-             only_lib=False, log=None):
+             if_installed=False, log=None):
     """
     Return ``True`` if and only if the file ``filename`` should not be doctested.
 
@@ -236,7 +236,7 @@ def skipfile(filename, tested_optional_tags=False, *,
     - ``tested_optional_tags`` -- a list or tuple or set of optional tags to test,
       or ``False`` (no optional test) or ``True`` (all optional tests)
 
-    - ``only_lib`` -- (boolean, default ``False``) whether to skip Python/Cython files
+    - ``if_installed`` -- (boolean, default ``False``) whether to skip Python/Cython files
       that are not installed as modules
 
     - ``log`` -- function to call with log messages, or ``None``
@@ -285,7 +285,7 @@ def skipfile(filename, tested_optional_tags=False, *,
         if log:
             log(f"Skipping '{filename}' because it is created by the jupyter-sphinx extension for internal use and should not be tested")
         return True
-    if only_lib and ext in ('.py', '.pyx', '.pxd'):
+    if if_installed and ext in ('.py', '.pyx', '.pxd'):
         module_name = get_basename(filename)
         try:
             if not importlib.util.find_spec(module_name):  # tries to import the containing package
@@ -949,7 +949,7 @@ def all_doc_sources():
                              filename.endswith(".rst"))
                         and not skipfile(opj(SAGE_ROOT, filename),
                                          True if self.options.optional else False,
-                                         only_lib=self.options.only_lib)):
+                                         if_installed=self.options.if_installed)):
                     self.files.append(os.path.relpath(opj(SAGE_ROOT, filename)))
 
     def expand_files_into_sources(self):
@@ -1011,11 +1011,11 @@ def expand():
                         for file in files:
                             if not skipfile(os.path.join(root, file),
                                             True if self.options.optional else False,
-                                            only_lib=self.options.only_lib):
+                                            if_installed=self.options.if_installed):
                                 yield os.path.join(root, file)
                 else:
                     if not skipfile(path, True if self.options.optional else False,
-                                    only_lib=self.options.only_lib, log=self.log):  # log when directly specified filenames are skipped
+                                    if_installed=self.options.if_installed, log=self.log):  # log when directly specified filenames are skipped
                         yield path
         self.sources = [FileDocTestSource(path, self.options) for path in expand()]