passagemath-repl 10.5.42__py3-none-any.whl → 10.6.1rc1__py3-none-any.whl

sage/doctest/fixtures.py

@@ -33,15 +33,15 @@ communicates with its surroundings::
     exit f -> None
 """
 
-#*****************************************************************************
+# ****************************************************************************
 #       Copyright (C) 2014-2015 Martin von Gagern <Martin.vGagern@gmx.net>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 2 of the License, or
 # (at your option) any later version.
-#                  http://www.gnu.org/licenses/
-#*****************************************************************************
+#                  https://www.gnu.org/licenses/
+# ****************************************************************************
 
 from functools import wraps
 
@@ -50,6 +50,15 @@ def reproducible_repr(val):
     r"""
     String representation of an object in a reproducible way.
 
+    .. NOTE::
+
+        This function is deprecated, in most cases it suffices to use
+        the automatic sorting of dictionary keys and set items by a displayhook.
+        See :func:`sage.doctest.forker.init_sage`.
+        If used in a format string, use :func:`IPython.lib.pretty.pretty`.
+        In the rare cases where the ordering of the elements is not reliable
+        or transitive, ``sorted`` with a sane key can be used instead.
+
     This tries to ensure that the returned string does not depend on
     factors outside the control of the doctest.
     One example is the order of elements in a hash-based structure.
@@ -74,6 +83,7 @@ def reproducible_repr(val):
 
     EXAMPLES::
 
+        sage: # not tested (test fails because of deprecation warning)
         sage: from sage.doctest.fixtures import reproducible_repr
         sage: print(reproducible_repr(set(["a", "c", "b", "d"])))
         set(['a', 'b', 'c', 'd'])
@@ -85,7 +95,20 @@ def reproducible_repr(val):
         {'2': 'two', 1: 'one', 3.00000000000000: 'three'}
         sage: print(reproducible_repr("foo\nbar"))  # demonstrate default case
         'foo\nbar'
+
+    TESTS:
+
+    Ensures deprecation warning is printed out::
+
+        sage: from sage.doctest.fixtures import reproducible_repr
+        sage: print(reproducible_repr(set(["a", "c", "b", "d"])))
+        doctest:warning...
+        DeprecationWarning: reproducible_repr is deprecated, see its documentation for details
+        See https://github.com/sagemath/sage/issues/39420 for details.
+        set(['a', 'b', 'c', 'd'])
     """
+    from sage.misc.superseded import deprecation
+    deprecation(39420, 'reproducible_repr is deprecated, see its documentation for details')
 
     def sorted_pairs(iterable, pairs=False):
         # We don't know whether container data structures will have
@@ -181,22 +204,23 @@ class AttributeAccessTracerHelper:
             4
         """
         val = getattr(self.delegate, name)
+        from IPython.lib.pretty import pretty
         if callable(val) and name not in self.delegate.__dict__:
             @wraps(val)
             def wrapper(*args, **kwds):
-                arglst = [reproducible_repr(arg) for arg in args]
-                arglst.extend("{}={}".format(k, reproducible_repr(v))
+                arglst = [pretty(arg) for arg in args]
+                arglst.extend("{}={}".format(k, pretty(v))
                               for k, v in sorted(kwds.items()))
                 res = val(*args, **kwds)
                 print("{}call {}({}) -> {}"
                       .format(self.prefix, name, ", ".join(arglst),
-                              reproducible_repr(res)))
+                              pretty(res)))
                 return res
             return wrapper
         else:
             if self.reads:
                 print("{}read {} = {}".format(self.prefix, name,
-                                              reproducible_repr(val)))
+                                              pretty(val)))
             return val
 
     def set(self, name, val):
@@ -218,8 +242,9 @@ class AttributeAccessTracerHelper:
             sage: foo.x
             2
         """
+        from IPython.lib.pretty import pretty
         print("{}write {} = {}".format(self.prefix, name,
-                                       reproducible_repr(val)))
+                                       pretty(val)))
         setattr(self.delegate, name, val)
 
 
@@ -373,11 +398,12 @@ def trace_method(obj, meth, **kwds):
 
     @wraps(f)
     def g(*args, **kwds):
-        arglst = [reproducible_repr(arg) for arg in args]
-        arglst.extend("{}={}".format(k, reproducible_repr(v))
+        from IPython.lib.pretty import pretty
+        arglst = [pretty(arg) for arg in args]
+        arglst.extend("{}={}".format(k, pretty(v))
                       for k, v in sorted(kwds.items()))
         print("enter {}({})".format(meth, ", ".join(arglst)))
         res = f(t, *args, **kwds)
-        print("exit {} -> {}".format(meth, reproducible_repr(res)))
+        print("exit {} -> {}".format(meth, pretty(res)))
         return res
     setattr(obj, meth, g)

sage/doctest/forker.py

@@ -250,7 +250,7 @@ def init_sage(controller: DocTestController | None = None) -> None:
 
     try:
         import sympy
-    except ImportError:
+    except (ImportError, AttributeError):
         # Do not require sympy for running doctests (Issue #25106).
         pass
     else:
@@ -263,7 +263,8 @@ def showwarning_with_traceback(message, category, filename, lineno, file=None, l
     r"""
     Displays a warning message with a traceback.
 
-    INPUT: see :func:`warnings.showwarning`.
+    INPUT: see :func:`warnings.showwarning` with the difference that with ``file=None``
+           the message will be written to stdout.
 
     OUTPUT: none
 
@@ -295,7 +296,7 @@ def showwarning_with_traceback(message, category, filename, lineno, file=None, l
     lines.extend(traceback.format_exception_only(category, category(message)))
 
     if file is None:
-        file = sys.stderr
+        file = sys.stdout
     try:
         file.writelines(lines)
         file.flush()
@@ -666,7 +667,8 @@ class SageDocTestRunner(doctest.DocTestRunner):
             # We print the example we're running for easier debugging
             # if this file times out or crashes.
             with OriginalSource(example):
-                print("sage: " + example.source[:-1] + " ## line %s ##" % (test.lineno + example.lineno + 1))
+                assert example.source.endswith("\n"), example
+                print("sage: " + example.source[:-1].replace("\n", "\n....: ") + " ## line %s ##" % (test.lineno + example.lineno + 1))
             # Update the position so that result comparison works
             self._fakeout.getvalue()
             if not quiet:
@@ -1099,7 +1101,7 @@ class SageDocTestRunner(doctest.DocTestRunner):
             False
             sage: doctests, extras = FDS.create_doctests(globs)
             sage: ex0 = doctests[0].examples[0]
-            sage: flags = 32768 if sys.version_info.minor < 8 else 524288
+            sage: flags = 524288
             sage: def compiler(ex):
             ....:     return compile(ex.source, '<doctest sage.doctest.forker[0]>',
             ....:                    'single', flags, 1)
@@ -1492,6 +1494,7 @@ class SageDocTestRunner(doctest.DocTestRunner):
                     from sage.repl.configuration import sage_ipython_config
                     from IPython.terminal.embed import InteractiveShellEmbed
                     cfg = sage_ipython_config.default()
+                    cfg.InteractiveShell.enable_tip = False
                     # Currently this doesn't work: prompts only work in pty
                     # We keep simple_prompt=True, prompts will be "In [0]:"
                     # cfg.InteractiveShell.prompts_class = DebugPrompts

sage/doctest/parsing.py

@@ -39,36 +39,44 @@ import platform
 import re
 from collections import defaultdict
 from functools import reduce
+from re import Pattern
 from typing import Literal, Union, overload
 
+from sage.doctest.check_tolerance import (
+    ToleranceExceededError,
+    check_tolerance_complex_domain,
+    check_tolerance_real_domain,
+    float_regex,
+)
+from sage.doctest.external import available_software, external_software
+from sage.doctest.marked_output import MarkedOutput
+from sage.doctest.rif_tol import RIFtol, add_tolerance
 from sage.misc.cachefunc import cached_function
 from sage.repl.preparse import preparse, strip_string_literals
-from sage.doctest.rif_tol import RIFtol, add_tolerance
-from sage.doctest.marked_output import MarkedOutput
-from sage.doctest.check_tolerance import (
-    ToleranceExceededError, check_tolerance_real_domain,
-    check_tolerance_complex_domain, float_regex)
-
-from .external import available_software, external_software
-
 
 # This is the correct pattern to match ISO/IEC 6429 ANSI escape sequences:
-ansi_escape_sequence = re.compile(r"(\x1b[@-Z\\-~]|\x1b\[.*?[@-~]|\x9b.*?[@-~])")
+ansi_escape_sequence: Pattern[str] = re.compile(
+    r"(\x1b[@-Z\\-~]|\x1b\[.*?[@-~]|\x9b.*?[@-~])"
+)
 
-special_optional_regex = (
+special_optional_regex_raw = (
     "py2|long time|not implemented|not tested|optional|needs|known bug"
 )
-tag_with_explanation_regex = r"((?:!?\w|[.])*)\s*(?:\((?P<cmd_explanation>.*?)\))?"
-optional_regex = re.compile(
-    rf"[^ a-z]\s*(?P<cmd>{special_optional_regex})(?:\s|[:-])*(?P<tags>(?:(?:{tag_with_explanation_regex})\s*)*)",
+tag_with_explanation_regex_raw = r"((?:!?\w|[.])*)\s*(?:\((?P<cmd_explanation>.*?)\))?"
+optional_regex: Pattern[str] = re.compile(
+    rf"[^ a-z]\s*(?P<cmd>{special_optional_regex_raw})(?:\s|[:-])*(?P<tags>(?:(?:{tag_with_explanation_regex_raw})\s*)*)",
     re.IGNORECASE,
 )
-special_optional_regex = re.compile(special_optional_regex, re.IGNORECASE)
-tag_with_explanation_regex = re.compile(tag_with_explanation_regex, re.IGNORECASE)
+special_optional_regex: Pattern[str] = re.compile(
+    special_optional_regex_raw, re.IGNORECASE
+)
+tag_with_explanation_regex: Pattern[str] = re.compile(
+    tag_with_explanation_regex_raw, re.IGNORECASE
+)
 
-nodoctest_regex = re.compile(r'\s*(#+|%+|r"+|"+|\.\.)\s*nodoctest')
-optionaltag_regex = re.compile(r"^(\w|[.])+$")
-optionalfiledirective_regex = re.compile(
+no_doctest_regex: Pattern[str] = re.compile(r'\s*(#+|%+|r"+|"+|\.\.)\s*nodoctest')
+optional_tag_regex: Pattern[str] = re.compile(r"^(\w|[.])+$")
+optional_file_directive_regex: Pattern[str] = re.compile(
     r'\s*(#+|%+|r"+|"+|\.\.)\s*sage\.doctest: (.*)'
 )
 
@@ -167,7 +175,7 @@ def parse_optional_tags(
         ....:                     return_string_sans_tags=True)
         ({'scipy': None}, 'sage: #this is not \n....: import scipy', False)
     """
-    safe, literals, state = strip_string_literals(string)
+    safe, literals, _ = strip_string_literals(string)
     split = safe.split('\n', 1)
     if len(split) > 1:
         first_line, rest = split
@@ -231,7 +239,7 @@ def parse_optional_tags(
         return tags
 
 
-def parse_file_optional_tags(lines):
+def parse_file_optional_tags(lines) -> dict[str, str | None]:
     r"""
     Scan the first few lines for file-level doctest directives.
 
@@ -261,11 +269,11 @@ def parse_file_optional_tags(lines):
         ....:     parse_file_optional_tags(enumerate(f))
         {'xyz': None}
     """
-    tags = {}
+    tags: dict[str, str | None] = {}
     for line_count, line in lines:
-        if nodoctest_regex.match(line):
+        if no_doctest_regex.match(line):
             tags['not tested'] = None
-        if m := optionalfiledirective_regex.match(line):
+        if m := optional_file_directive_regex.match(line):
             file_tag_string = m.group(2)
             tags.update(parse_optional_tags('#' + file_tag_string))
         if line_count >= 10:
@@ -274,7 +282,7 @@ def parse_file_optional_tags(lines):
 
 
 @cached_function
-def _standard_tags():
+def _standard_tags() -> frozenset[str]:
     r"""
     Return the set of the names of all standard features.
 
@@ -321,7 +329,7 @@ def _tag_group(tag):
         return 'special'
 
 
-def unparse_optional_tags(tags, prefix='# '):
+def unparse_optional_tags(tags, prefix='# ') -> str:
     r"""
     Return a comment string that sets ``tags``.
 
@@ -596,7 +604,7 @@ def parse_tolerance(source, want):
     return want
 
 
-def pre_hash(s):
+def pre_hash(s) -> str:
     """
     Prepends a string with its length.
 
@@ -1482,7 +1490,7 @@ class SageOutputChecker(doctest.OutputChecker):
             did_fixup = True
 
         if "R[write to console]" in got:
-            # Supress R warnings
+            # suppress R warnings
             r_warning_regex = re.compile(r'R\[write to console\]:.*')
             got = r_warning_regex.sub('', got)
             did_fixup = True
@@ -1513,6 +1521,13 @@ class SageOutputChecker(doctest.OutputChecker):
             got = dup_lib_regex.sub('', got)
             did_fixup = True
 
+        if "duplicate" in got:
+            # Warnings about duplicate rpaths in the linker command line
+            # occurs sometimes when compiling cython code via sage.misc.cython
+            dup_rpath_regex = re.compile("ld: warning: duplicate -rpath .* ignored")
+            got = dup_rpath_regex.sub('', got)
+            did_fixup = True
+
         return did_fixup, want, got
 
     def output_difference(self, example, got, optionflags):

sage/doctest/sources.py

@@ -87,8 +87,18 @@ def get_basename(path):
         sage: import os
         sage: get_basename(sage.doctest.sources.__file__)
         'sage.doctest.sources'
+
+    ::
+
+        sage: # optional - !meson_editable
         sage: get_basename(os.path.join(sage.structure.__path__[0], 'element.pxd'))
         'sage.structure.element.pxd'
+
+    TESTS::
+
+        sage: # optional - meson_editable
+        sage: get_basename(os.path.join(os.path.dirname(sage.structure.__file__), 'element.pxd'))
+        'sage.structure.element.pxd'
     """
     if path is None:
         return None

sage/doctest/test.py

@@ -295,15 +295,21 @@ Test a doctest failing with ``abort()``::
     ...
     16
 
-A different kind of crash::
+A different kind of crash (also test printing of line continuation ``...:``,
+represented by ``<DOTSCOLON>`` below)::
 
-    sage: subprocess.call(["sage", "-t", "--warn-long", "0",    # long time
-    ....:      "--random-seed=0", "--optional=sage", "fail_and_die.rst"], **kwds)
+    sage: # long time
+    sage: proc = subprocess.run(["sage", "-t", "--warn-long", "0",
+    ....:      "--random-seed=0", "--optional=sage", "fail_and_die.rst"], **kwds,
+    ....:      stdout=subprocess.PIPE, text=True)
+    sage: # the replacements are needed to avoid the strings being interpreted
+    ....: # specially by the doctesting framework
+    sage: print(proc.stdout.replace('sage:', 'sage<COLON>').replace('....:', '<DOTSCOLON>'))
     Running doctests...
     Doctesting 1 file.
     sage -t --warn-long 0.0 --random-seed=0 fail_and_die.rst
     **********************************************************************
-    File "fail_and_die.rst", line 5, in sage.doctest.tests.fail_and_die
+    File "fail_and_die.rst", line 8, in sage.doctest.tests.fail_and_die
     Failed example:
         this_gives_a_NameError
     Exception raised:
@@ -313,11 +319,18 @@ A different kind of crash::
         Killed due to kill signal
     **********************************************************************
     Tests run before process (pid=...) failed:
-    ...
+    sage<COLON> import time, signal ## line 4 ##
+    sage<COLON> print(1,
+    <DOTSCOLON>       2) ## line 5 ##
+    1 2
+    sage<COLON> this_gives_a_NameError ## line 8 ##
+    sage<COLON> os.kill(os.getpid(), signal.SIGKILL) ## line 9 ##
+    **********************************************************************
     ----------------------------------------------------------------------
     sage -t --warn-long 0.0 --random-seed=0 fail_and_die.rst  # Killed due to kill signal
     ----------------------------------------------------------------------
     ...
+    sage: proc.returncode
     16
 
 Test that ``sig_on_count`` is checked correctly::

sage/doctest/tests/fail_and_die.rst

@@ -1,6 +1,9 @@
 The :exc:`NameError` raised on the second line should be displayed, even
-if we crash immediately afterwards::
+if we crash immediately afterwards (also test printing of line continuation)::
 
     sage: import time, signal
+    sage: print(1,
+    ....:       2)
+    1 2
     sage: this_gives_a_NameError
     sage: os.kill(os.getpid(), signal.SIGKILL)

sage/doctest/util.py

@@ -23,10 +23,9 @@ AUTHORS:
 #                  https://www.gnu.org/licenses/
 # ****************************************************************************
 
+from os import times
 from time import time as walltime
-from os import sysconf, times
 from contextlib import contextmanager
-from cysignals.alarm import alarm, cancel_alarm, AlarmInterrupt
 
 
 def count_noun(number, noun, plural=None, pad_number=False, pad_noun=False):
@@ -206,6 +205,8 @@ class Timer:
             raise OSError(f"unable to parse {path}") from e
 
         try:
+            from os import sysconf
+
             hertz = sysconf("SC_CLK_TCK")
         except (ValueError) as e:
             # ValueError: SC_CLK_TCK doesn't exist
@@ -332,7 +333,10 @@ class Timer:
             sage: Timer().start()
             {'cputime': ..., 'walltime': ...}
         """
-        from sage.interfaces.quit import expect_objects
+        try:
+            from sage.interfaces.quit import expect_objects
+        except ImportError:
+            expect_objects = []
         self.cputime = self._quick_cputime(expect_objects)
         self.walltime = walltime()
         return self
@@ -351,7 +355,10 @@ class Timer:
             sage: timer.stop()
             {'cputime': ..., 'walltime': ...}
         """
-        from sage.interfaces.quit import expect_objects
+        try:
+            from sage.interfaces.quit import expect_objects
+        except ImportError:
+            expect_objects = []
         self.cputime = self._quick_cputime(expect_objects) - self.cputime
         self.walltime = walltime() - self.walltime
         return self
@@ -607,7 +614,7 @@ def make_recording_dict(D, st, gt):
     EXAMPLES::
 
         sage: from sage.doctest.util import make_recording_dict
-        sage: D = make_recording_dict({'a':4,'d':42},set([]),set(['not_here']))
+        sage: D = make_recording_dict({'a':4,'d':42},set(),set(['not_here']))
         sage: sorted(D.items())
         [('a', 4), ('d', 42)]
         sage: D.got
@@ -802,7 +809,7 @@ def ensure_interruptible_after(seconds: float, max_wait_after_interrupt: float =
         ....:     check_interrupt_only_occasionally()
         Traceback (most recent call last):
         ...
-        RuntimeError: Function is not interruptible within 1.0000 seconds, only after 1.60... seconds
+        RuntimeError: Function is not interruptible within 1.0000 seconds, only after 1.6... seconds
         sage: with ensure_interruptible_after(1, max_wait_after_interrupt=0.9):
         ....:     check_interrupt_only_occasionally()
 
@@ -870,6 +877,8 @@ def ensure_interruptible_after(seconds: float, max_wait_after_interrupt: float =
         sage: data
         {'alarm_raised': False, 'elapsed': ...}
     """
+    from cysignals.alarm import alarm, cancel_alarm, AlarmInterrupt
+
     seconds = float(seconds)
     max_wait_after_interrupt = float(max_wait_after_interrupt)
     inaccuracy_tolerance = float(inaccuracy_tolerance)

sage/misc/banner.py

@@ -13,7 +13,8 @@ SageMath version and banner info
 # ****************************************************************************
 import sys
 
-from sage.env import (SAGE_VERSION, SAGE_VERSION_BANNER, SAGE_BANNER)
+from sage.env import SAGE_BANNER, SAGE_VERSION
+from sage.version import banner as sage_banner
 
 
 def version():
@@ -25,9 +26,16 @@ def version():
     EXAMPLES::
 
        sage: version()
+       doctest:warning
+       ...
+       DeprecationWarning: Use sage.version instead.
+       ...
        '... version ..., Release Date: ...'
     """
-    return SAGE_VERSION_BANNER
+    from sage.misc.superseded import deprecation
+
+    deprecation(39015, "Use sage.version instead.")
+    return sage_banner
 
 
 def banner_text(full=True):
@@ -54,13 +62,13 @@ def banner_text(full=True):
         ... version ..., Release Date: ...
     """
     if not full:
-        return version()
+        return sage_banner
 
     bars = "─" * 68
     s = []
     a = s.append
     a('┌' + bars + '┐')
-    a("\n│ %-66s │\n" % version())
+    a("\n│ %-66s │\n" % sage_banner)
     python_version = sys.version_info[:3]
     a("│ %-66s │\n" % 'Using Python {}.{}.{}. Type "help()" for help.'.format(*python_version))
     a('└' + bars + '┘')

sage/misc/cython.py

@@ -30,11 +30,10 @@ from pathlib import Path
 
 from sage.env import (SAGE_LOCAL, cython_aliases,
                       sage_include_directories)
+from sage.misc.cachefunc import cached_function
+from sage.misc.sage_ostools import restore_cwd, redirection
 from sage.misc.temporary_file import spyx_tmp, tmp_filename
 from sage.repl.user_globals import get_globals
-from sage.misc.sage_ostools import restore_cwd, redirection
-from sage.cpython.string import str_to_bytes
-from sage.misc.cachefunc import cached_function
 
 
 @cached_function
@@ -90,7 +89,7 @@ def _webbrowser_open_file(path):
 
 def cython(filename, verbose=0, compile_message=False,
            use_cache=False, create_local_c_file=False, annotate=True, view_annotate=False,
-           view_annotate_callback=_webbrowser_open_file, sage_namespace=True, create_local_so_file=False):
+           view_annotate_callback=None, sage_namespace=True, create_local_so_file=False):
     r"""
     Compile a Cython file. This converts a Cython file to a C (or C++ file),
     and then compiles that. The .c file and the .so file are
@@ -126,7 +125,8 @@ def cython(filename, verbose=0, compile_message=False,
     - ``view_annotate_callback`` -- function; a function that takes a string
       being the path to the html file. This can be overridden to change
       what to do with the annotated html file. Have no effect unless
-      ``view_annotate`` is ``True``.
+      ``view_annotate`` is ``True``. By default, the html file is opened in a
+      web browser.
 
     - ``sage_namespace`` -- boolean (default: ``True``); if ``True``, import
       ``sage.all``
@@ -273,6 +273,9 @@ def cython(filename, verbose=0, compile_message=False,
         sage: len(collected_paths)
         1
     """
+    if view_annotate_callback is None:
+        # needed because of https://github.com/sagemath/sage/pull/38946#issuecomment-2656329774
+        view_annotate_callback = _webbrowser_open_file
     if not filename.endswith('pyx'):
         print("Warning: file (={}) should have extension .pyx".format(filename), file=sys.stderr)