Head toward deprecation of automatic imports of some dev tools

jhpalmieri · jhpalmieri · commit 8fa5c02b34a2 · 2023-06-26T13:37:10.000-07:00
diff --git a/src/sage/all.py b/src/sage/all.py
@@ -194,10 +194,6 @@
 copying = license
 copyright = license
 
-_cpu_time_ = cputime()
-_wall_time_ = walltime()
-
-
 def quit_sage(verbose=True):
     """
     Does nothing. Code that needs cleanup should register its own
diff --git a/src/sage/misc/abstract_method.py b/src/sage/misc/abstract_method.py
@@ -127,10 +127,10 @@ def abstract_method(f=None, optional=False):
 
         sage: abstract_method(optional = True)
         <function abstract_method.<locals>.<lambda> at ...>
-        sage: abstract_method(optional = True)(banner)
-        <optional abstract method banner at ...>
-        sage: abstract_method(banner, optional = True)
-        <optional abstract method banner at ...>
+        sage: abstract_method(optional = True)(version)
+        <optional abstract method version at ...>
+        sage: abstract_method(version, optional = True)
+        <optional abstract method version at ...>
     """
     if f is None:
         return lambda f: AbstractMethod(f, optional=optional)
@@ -173,11 +173,11 @@ def __repr__(self):
         """
         EXAMPLES::
 
-            sage: abstract_method(banner)
-            <abstract method banner at ...>
+            sage: abstract_method(version)
+            <abstract method version at ...>
 
-            sage: abstract_method(banner, optional = True)
-            <optional abstract method banner at ...>
+            sage: abstract_method(version, optional = True)
+            <optional abstract method version at ...>
         """
         return "<" + ("optional " if self._optional else "") + "abstract method %s at %s>" % (self.__name__, hex(id(self._f)))
 
@@ -188,12 +188,12 @@ def _sage_src_lines_(self):
         EXAMPLES::
 
             sage: from sage.misc.sageinspect import sage_getsourcelines
-            sage: g = abstract_method(banner)
+            sage: g = abstract_method(version)
             sage: (src, lines) = sage_getsourcelines(g)
             sage: src[0]
-            'def banner():\n'
+            'def version():\n'
             sage: lines
-            89
+            19
         """
         from sage.misc.sageinspect import sage_getsourcelines
         return sage_getsourcelines(self._f)
diff --git a/src/sage/misc/all.py b/src/sage/misc/all.py
@@ -16,36 +16,28 @@
 lazy_import('sage.misc.misc', 'union',
             deprecation=32096)
 
-from .banner import version, banner
+from .banner import version
 
-from .dev_tools import runsnake, import_statements
+from .dev_tools import import_statements
 
 from .html import html, pretty_print_default
 
 from .table import table
 
 from .sage_timeit_class import timeit
 
-from .edit_module import edit, set_edit_template
+from .edit_module import edit
 
 from .map_threaded import map_threaded
 
 from .session import load_session, save_session, show_identifiers
 
 from .remote_file import get_remote_file
 
-from .profiler import Profiler
-
 from .mrange import xmrange, mrange, xmrange_iter, mrange_iter, cartesian_product_iterator
 
 from .fpickle import pickle_function, unpickle_function
 
-from .dist import install_scripts
-
-lazy_import('sage.misc.package', ('installed_packages', 'is_package_installed',
-                                  'standard_packages', 'optional_packages',
-                                  'experimental_packages', 'package_versions'))
-
 lazy_import('sage.misc.pager', 'pager')
 
 lazy_import('sage.misc.sagedoc', ['browse_sage_doc',
@@ -129,8 +121,6 @@
 
 from .latex import LatexExpr, latex, view
 
-from .trace import trace
-
 from .randstate import seed, set_random_seed, initial_seed, current_randstate
 
 from .prandom import *
@@ -139,36 +129,15 @@
 
 lazy_import('sage.misc.inline_fortran', 'fortran')
 
-
-##########################################################################
-def benchmark(n=-1):
-    """
-    Run a well-chosen range of Sage commands and record the time it
-    takes for each to run.
-
-    INPUT:
-
-    - ``n`` -- int (default: -1); the benchmark number. The default
-      of -1 runs all the benchmarks.
-
-    OUTPUT:
-
-    - ``list`` -- summary of timings for each benchmark
-    """
-    import sage.misc.benchmark
-    return sage.misc.benchmark.benchmark(n)
-
-
-class logstr(str):
-    def __repr__(self):
-        return self
-
-    def _latex_(self):
-        # return "\\begin{verbatim}%s\\end{verbatim}"%self
-        if '#' not in self:
-            delim = '#'
-        elif '@' not in self:
-            delim = '@'
-        elif '~' not in self:
-            delim = '~'
-        return r"""\verb%s%s%s""" % (delim, self.replace('\n\n', '\n').replace('\n', '; '), delim)
+lazy_import('sage.misc.banner', 'banner', deprecation=34259)
+lazy_import('sage.misc.dev_tools', 'runsnake', deprecation=34259)
+lazy_import('sage.misc.edit_module', 'set_edit_template', deprecation=34259)
+lazy_import('sage.misc.profiler', 'Profiler', deprecation=34259)
+lazy_import('sage.misc.dist', 'install_scripts', deprecation=34259)
+lazy_import('sage.misc.trace', 'trace', deprecation=34259)
+lazy_import('sage.misc.package', ('installed_packages', 'is_package_installed',
+                                  'standard_packages', 'optional_packages',
+                                  'experimental_packages', 'package_versions'),
+            deprecation=34259)
+lazy_import('sage.misc.benchmark', 'benchmark', deprecation=34259)
+lazy_import('sage.repl.interpreter', 'logstr', deprecation=34259)
diff --git a/src/sage/misc/banner.py b/src/sage/misc/banner.py
@@ -100,7 +100,7 @@ def banner():
     EXAMPLES::
 
         sage: import sage.misc.banner; sage.misc.banner.SAGE_BANNER = ''
-        sage: banner()
+        sage: sage.misc.banner.banner()
         ┌────────────────────────────────────────────────────────────────────┐
         │ SageMath version ..., Release Date: ...                            │
         │ Using Python .... Type "help()" for help.                          │
diff --git a/src/sage/misc/dev_tools.py b/src/sage/misc/dev_tools.py
@@ -31,6 +31,7 @@ def runsnake(command):
 
     EXAMPLES::
 
+        sage: from sage.misc.dev_tools import runsnake
         sage: runsnake("list(SymmetricGroup(3))")        # optional - runsnake
 
     ``command`` is first preparsed (see :func:`preparse`)::
diff --git a/src/sage/misc/dist.py b/src/sage/misc/dist.py
@@ -70,6 +70,7 @@ def install_scripts(directory=None, ignore_existing=False):
     EXAMPLES::
 
         sage: import tempfile
+        sage: from sage.misc.dist import install_scripts
         sage: with tempfile.TemporaryDirectory() as d:
         ....:     install_scripts(d, ignore_existing=True)
         doctest:warning...
diff --git a/src/sage/misc/lazy_attribute.pyx b/src/sage/misc/lazy_attribute.pyx
@@ -82,7 +82,7 @@ cdef class _lazy_attribute():
         EXAMPLES::
 
             sage: from sage.misc.sageinspect import sage_getsourcelines
-            sage: g = lazy_attribute(banner)
+            sage: g = lazy_attribute(sage.misc.banner.banner)
             sage: (src, lines) = sage_getsourcelines(g)
             sage: src[0]
             'def banner():\n'
diff --git a/src/sage/misc/package.py b/src/sage/misc/package.py
@@ -393,6 +393,7 @@ def installed_packages(exclude_pip=True):
     records of Python packages. Our ``SAGE_VENV`` is not necessarily the
     main Sage venv; it could be a user-created venv or a venv created by tox.)::
 
+        sage: from sage.misc.package import installed_packages
         sage: sorted(installed_packages().keys())         # optional - sage_spkg
         [...'conway_polynomials', ...]
         sage: installed_packages()['conway_polynomials']  # optional - sage_spkg, random
@@ -431,6 +432,7 @@ def is_package_installed(package, exclude_pip=True):
 
     EXAMPLES::
 
+        sage: from sage.misc.package import is_package_installed
         sage: is_package_installed('conway_polynomials')  # optional - sage_spkg
         True
 
@@ -501,6 +503,7 @@ def package_versions(package_type, local=False):
 
     EXAMPLES::
 
+        sage: from sage.misc.package import package_versions
         sage: std = package_versions('standard', local=True)  # optional - sage_spkg
         sage: 'gap' in std  # optional - sage_spkg
         True
diff --git a/src/sage/misc/profiler.py b/src/sage/misc/profiler.py
@@ -28,6 +28,7 @@ class Profiler:
 
     EXAMPLES::
 
+        from sage.misc.profiler import Profiler
         sage: def f():                        # not tested
         ....:     p = Profiler()
 
diff --git a/src/sage/misc/trace.py b/src/sage/misc/trace.py
@@ -26,6 +26,7 @@ def trace(code, preparse=True):
 
     ::
 
+        sage: from sage.misc.trace import trace
         sage: trace("factor(100)")             # not tested
 
     then at the (Pdb) prompt type ``s`` (or ``step``), then press :kbd:`Return`
@@ -55,7 +56,7 @@ def trace(code, preparse=True):
 
         sage: import pexpect
         sage: s = pexpect.spawn('sage')
-        sage: _ = s.sendline("trace('print(factor(10))'); print(3+97)")
+        sage: _ = s.sendline("from sage.misc.trace import trace; trace('print(factor(10))'); print(3+97)")
         sage: _ = s.expect('ipdb>', timeout=90)
         sage: _ = s.sendline("s"); _ = s.sendline("c")
         sage: _ = s.expect('100', timeout=90)
diff --git a/src/sage/modular/hecke/module.py b/src/sage/modular/hecke/module.py
@@ -1696,7 +1696,6 @@ def system_of_eigenvalues(self, n, name='alpha'):
         Next we define a function that does the above::
 
             sage: def b(N,k=2):
-            ....:    t=cputime()
             ....:    S = ModularSymbols(N,k,sign=-1).cuspidal_submodule().new_submodule()
             ....:    for A in S.decomposition():
             ....:        print("{} {}".format(N, A.system_of_eigenvalues(5)))
diff --git a/src/sage/repl/interpreter.py b/src/sage/repl/interpreter.py
@@ -455,6 +455,42 @@ def SagePreparseTransformer(lines):
 # Interface shell #
 ###################
 
+class logstr(str):
+    """
+    For use by :meth`~InterfaceShellTransformer.transform`.
+    This provides a ``_latex_`` method which is just the string
+    wrapped in a ``\\verb`` environment.
+    """
+    def __repr__(self):
+        """
+        EXAMPLES::
+            sage: from sage.repl.interpreter import logstr
+            sage: logstr("ABC")
+            ABC
+        """
+        return self
+
+    def _latex_(self):
+        """
+        EXAMPLES::
+            sage: from sage.repl.interpreter import logstr
+            sage: logstr("A")
+            A
+            sage: latex(logstr("A"))
+            \verb#A#
+            sage: latex(logstr("A#B"))
+            \verb@A#B@
+        """
+        # return "\\begin{verbatim}%s\\end{verbatim}"%self
+        if '#' not in self:
+            delim = '#'
+        elif '@' not in self:
+            delim = '@'
+        elif '~' not in self:
+            delim = '~'
+        return r"""\verb%s%s%s""" % (delim, self.replace('\n\n', '\n').replace('\n', '; '), delim)
+
+
 class InterfaceShellTransformer(PrefilterTransformer):
     priority = 50
 
@@ -555,16 +591,16 @@ def transform(self, line, continue_prompt):
             sage: shell = interface_shell_embed(maxima)
             sage: ift = InterfaceShellTransformer(shell=shell, config=shell.config, prefilter_manager=shell.prefilter_manager)
             sage: ift.transform('2+2', False)   # note: output contains triple quotation marks
-            'sage.misc.all.logstr(r"""4""")'
+            'sage.repl.interpreter.logstr(r"""4""")'
             sage: ift.shell.ex('a = 4')
             sage: ift.transform(r'sage(a)+4', False)
-            'sage.misc.all.logstr(r"""8""")'
+            'sage.repl.interpreter.logstr(r"""8""")'
             sage: ift.temporary_objects
             set()
             sage: shell = interface_shell_embed(gap)
             sage: ift = InterfaceShellTransformer(shell=shell, config=shell.config, prefilter_manager=shell.prefilter_manager)
             sage: ift.transform('2+2', False)
-            'sage.misc.all.logstr(r"""4""")'
+            'sage.repl.interpreter.logstr(r"""4""")'
 
         TESTS:
 
@@ -574,12 +610,12 @@ def transform(self, line, continue_prompt):
             sage: shell = interface_shell_embed(gap)
             sage: ift = InterfaceShellTransformer(shell=shell, config=shell.config, prefilter_manager=shell.prefilter_manager)
             sage: ift.transform(r'Print("  -\n\\\\-  ");', False)
-            'sage.misc.all.logstr(r"""  -\n\\\\-""")'
+            'sage.repl.interpreter.logstr(r"""  -\n\\\\-""")'
 
             sage: shell = interface_shell_embed(macaulay2)  # optional - macaulay2
             sage: ift = InterfaceShellTransformer(shell=shell, config=shell.config, prefilter_manager=shell.prefilter_manager) # optional - macaulay2
             sage: ift.transform('net(ZZ^2)', False)  # optional - macaulay2
-            'sage.misc.all.logstr(r"""  2\nZZ""")'
+            'sage.repl.interpreter.logstr(r"""  2\nZZ""")'
         '''
         line = self.preparse_imports_from_sage(line)
 
@@ -591,7 +627,7 @@ def transform(self, line, continue_prompt):
             self.temporary_objects = set()
         # We do not strip whitespace from t here as the individual interface is
         # responsible for that
-        return 'sage.misc.all.logstr(r"""%s""")' % t
+        return 'sage.repl.interpreter.logstr(r"""%s""")' % t
 
 
 def interface_shell_embed(interface):
diff --git a/src/sage/tests/benchmark.py b/src/sage/tests/benchmark.py
@@ -15,7 +15,30 @@
     sage: import sage.tests.benchmark
 """
 
-from sage.all import * # QQ, alarm, ModularSymbols, gp, pari, cputime, EllipticCurve
+from cysignals.alarm import alarm, cancel_alarm, AlarmInterrupt
+from sage.combinat.combinat import fibonacci
+from sage.functions.other import factorial
+from sage.interfaces.gap import gap
+from sage.interfaces.gp import gp
+from sage.interfaces.macaulay2 import macaulay2
+from sage.interfaces.magma import magma, Magma
+from sage.interfaces.maple import maple
+from sage.interfaces.mathematica import mathematica
+from sage.interfaces.maxima import maxima
+from sage.interfaces.singular import singular
+from sage.libs.pari import pari
+from sage.matrix.matrix_space import MatrixSpace
+from sage.misc.functional import log
+from sage.misc.misc import cputime, walltime
+from sage.modular.modsym.modsym import ModularSymbols
+from sage.rings.complex_mpfr import ComplexField
+from sage.rings.finite_rings.finite_field_constructor import GF
+from sage.rings.finite_rings.integer_mod_ring import Integers
+from sage.rings.rational_field import QQ
+from sage.rings.integer import Integer
+from sage.rings.integer_ring import ZZ
+from sage.rings.polynomial.polynomial_ring_constructor import PolynomialRing
+from sage.schemes.elliptic_curves.constructor import EllipticCurve
 
 def avg(X):
     """
