Skip to content

Commit abb8d01

Browse files
user202729user202729
committed
Fix alarm tests
1 parent e7477f8 commit abb8d01

18 files changed

+153
-101
lines changed

‎src/sage/coding/linear_code.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -789,10 +789,8 @@ def canonical_representative(self, equivalence='semilinear'):
789789
(see :issue:`21651`)::
790790
791791
sage: C = LinearCode(random_matrix(GF(47), 25, 35))
792-
sage: alarm(0.5); C.canonical_representative() # needs sage.libs.gap
793-
Traceback (most recent call last):
794-
...
795-
AlarmInterrupt
792+
sage: from sage.doctest.util import ensure_interruptible_after
793+
sage: with ensure_interruptible_after(0.5): C.canonical_representative() # needs sage.libs.gap
796794
"""
797795
aut_group_can_label = self._canonize(equivalence)
798796
return aut_group_can_label.get_canonical_form(), \

‎src/sage/data_structures/bounded_integer_sequences.pyx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1372,10 +1372,8 @@ def _biseq_stresstest():
13721372
TESTS::
13731373
13741374
sage: from sage.data_structures.bounded_integer_sequences import _biseq_stresstest
1375-
sage: alarm(1); _biseq_stresstest() # long time
1376-
Traceback (most recent call last):
1377-
...
1378-
AlarmInterrupt
1375+
sage: from sage.doctest.util import ensure_interruptible_after
1376+
sage: with ensure_interruptible_after(1): _biseq_stresstest() # long time
13791377
"""
13801378
cdef int branch
13811379
cdef Py_ssize_t x, y, z

‎src/sage/doctest/util.py

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525

2626
from time import time as walltime
2727
from os import sysconf, times
28+
from contextlib import contextmanager
29+
from cysignals.alarm import alarm, cancel_alarm, AlarmInterrupt
2830

2931

3032
def count_noun(number, noun, plural=None, pad_number=False, pad_noun=False):
@@ -749,3 +751,104 @@ def __ne__(self, other):
749751
True
750752
"""
751753
return not (self == other)
754+
755+
756+
@contextmanager
757+
def ensure_interruptible_after(seconds: float, max_wait_after_interrupt: float = 0.2, inaccuracy_tolerance: float = 0.1):
758+
"""
759+
Helper function for doctesting to ensure that the code is interruptible after a certain amount of time.
760+
This should only be used for internal doctesting purposes.
761+
762+
EXAMPLES::
763+
764+
sage: from sage.doctest.util import ensure_interruptible_after
765+
sage: with ensure_interruptible_after(1) as data: sleep(3)
766+
767+
``as data`` is optional, but if it is used, it will contain a few useful values::
768+
769+
sage: data # abs tol 0.2
770+
{'alarm_raised': True, 'elapsed': 1.0}
771+
772+
``max_wait_after_interrupt`` can be passed if the function may take longer than usual to be interrupted::
773+
774+
sage: cython('''
775+
....: from libc.time cimport clock_t, clock, CLOCKS_PER_SEC
776+
....: from cysignals.signals cimport sig_check
777+
....: cpdef void uninterruptible_sleep(double seconds):
778+
....: cdef clock_t target = clock() + <clock_t>(CLOCKS_PER_SEC * seconds)
779+
....: while clock() < target:
780+
....: pass
781+
....: cpdef void check_interrupt_only_occasionally():
782+
....: for i in range(10):
783+
....: uninterruptible_sleep(0.8)
784+
....: sig_check()
785+
....: ''')
786+
sage: with ensure_interruptible_after(1) as data: # not passing max_wait_after_interrupt will raise an error
787+
....: check_interrupt_only_occasionally()
788+
Traceback (most recent call last):
789+
...
790+
RuntimeError: Function is not interruptible within 1.0000 seconds, only after 1... seconds
791+
sage: with ensure_interruptible_after(1, max_wait_after_interrupt=0.9):
792+
....: check_interrupt_only_occasionally()
793+
794+
TESTS::
795+
796+
sage: data['elapsed'] # abs tol 0.3 # 1.6 = 0.8 * 2
797+
1.6
798+
799+
::
800+
801+
sage: with ensure_interruptible_after(2) as data: sleep(1)
802+
Traceback (most recent call last):
803+
...
804+
RuntimeError: Function terminates early after 1... < 2.0000 seconds
805+
sage: data # abs tol 0.2
806+
{'alarm_raised': False, 'elapsed': 1.0}
807+
sage: with ensure_interruptible_after(1) as data: raise ValueError
808+
Traceback (most recent call last):
809+
...
810+
ValueError
811+
sage: data # abs tol 0.2
812+
{'alarm_raised': False, 'elapsed': 0.0}
813+
814+
::
815+
816+
sage: # needs sage.misc.cython
817+
sage: with ensure_interruptible_after(1) as data: uninterruptible_sleep(2)
818+
Traceback (most recent call last):
819+
...
820+
RuntimeError: Function is not interruptible within 1.0000 seconds, only after 2... seconds
821+
sage: data # abs tol 0.2
822+
{'alarm_raised': True, 'elapsed': 2.0}
823+
sage: with ensure_interruptible_after(1): uninterruptible_sleep(2); raise RuntimeError
824+
Traceback (most recent call last):
825+
...
826+
RuntimeError: Function is not interruptible within 1.0000 seconds, only after 2... seconds
827+
sage: data # abs tol 0.2
828+
{'alarm_raised': True, 'elapsed': 2.0}
829+
"""
830+
data = {}
831+
start_time = walltime()
832+
alarm(seconds)
833+
alarm_raised = False
834+
835+
try:
836+
yield data
837+
except AlarmInterrupt:
838+
alarm_raised = True
839+
finally:
840+
cancel_alarm()
841+
elapsed = walltime() - start_time
842+
data["elapsed"] = elapsed
843+
data["alarm_raised"] = alarm_raised
844+
845+
if elapsed > seconds + max_wait_after_interrupt:
846+
raise RuntimeError(
847+
f"Function is not interruptible within {seconds:.4f} seconds, only after {elapsed:.4f} seconds"
848+
+ ("" if alarm_raised else " (__exit__ called before interrupt check)"))
849+
850+
if alarm_raised:
851+
if elapsed < seconds - inaccuracy_tolerance:
852+
raise RuntimeError(f"Interrupted too early: {elapsed:.4f} < {seconds:.4f}, this should not happen")
853+
else:
854+
raise RuntimeError(f"Function terminates early after {elapsed:.4f} < {seconds:.4f} seconds")

‎src/sage/geometry/integral_points.pxi

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -531,10 +531,8 @@ cpdef rectangular_box_points(list box_min, list box_max,
531531
....: (0, 0, 0, 0, 0, -1, 2, -1, 0),
532532
....: (0, 0, 0, 0, 0, 0, -1, 2, -1)]
533533
sage: P = Polyhedron(ieqs=ieqs)
534-
sage: alarm(0.5); P.integral_points()
535-
Traceback (most recent call last):
536-
...
537-
AlarmInterrupt
534+
sage: from sage.doctest.util import ensure_interruptible_after
535+
sage: with ensure_interruptible_after(0.5): P.integral_points()
538536
"""
539537
assert len(box_min) == len(box_max)
540538
assert not (count_only and return_saturated)

‎src/sage/libs/flint/nmod_poly_linkage.pxi

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -536,10 +536,8 @@ cdef inline int celement_pow(nmod_poly_t res, nmod_poly_t x, long e, nmod_poly_t
536536
Make sure that exponentiation can be interrupted, see :issue:`17470`::
537537
538538
sage: n = 2^23
539-
sage: alarm(0.2); x^n; cancel_alarm()
540-
Traceback (most recent call last):
541-
...
542-
AlarmInterrupt
539+
sage: from sage.doctest.util import ensure_interruptible_after
540+
sage: with ensure_interruptible_after(0.2): (x^n).degree()
543541
"""
544542
if modulus != NULL:
545543
sig_on()

‎src/sage/libs/gap/element.pyx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1135,10 +1135,8 @@ cdef class GapElement(RingElement):
11351135
Check that this can be interrupted gracefully::
11361136
11371137
sage: a, b = libgap.GL(1000, 3).GeneratorsOfGroup(); g = a * b
1138-
sage: alarm(0.5); g ^ (2 ^ 10000)
1139-
Traceback (most recent call last):
1140-
...
1141-
AlarmInterrupt
1138+
sage: from sage.doctest.util import ensure_interruptible_after
1139+
sage: with ensure_interruptible_after(0.5): g ^ (2 ^ 10000)
11421140
11431141
sage: libgap.CyclicGroup(2) ^ 2
11441142
Traceback (most recent call last):

‎src/sage/libs/libecm.pyx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,8 @@ def ecmfactor(number, double B1, verbose=False, sigma=0):
143143
Check that ``ecmfactor`` can be interrupted (factoring a large
144144
prime number)::
145145
146-
sage: alarm(0.5); ecmfactor(2^521-1, 1e7)
147-
Traceback (most recent call last):
148-
...
149-
AlarmInterrupt
146+
sage: from sage.doctest.util import ensure_interruptible_after
147+
sage: with ensure_interruptible_after(0.5): ecmfactor(2^521-1, 1e7)
150148
151149
Some special cases::
152150

‎src/sage/matrix/matrix_integer_dense.pyx

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4385,14 +4385,8 @@ cdef class Matrix_integer_dense(Matrix_dense):
43854385
43864386
sage: A = random_matrix(ZZ, 2000, 2000)
43874387
sage: B = random_matrix(ZZ, 2000, 2000)
4388-
sage: t0 = walltime()
4389-
sage: alarm(2); A._solve_iml(B) # long time
4390-
Traceback (most recent call last):
4391-
...
4392-
AlarmInterrupt
4393-
sage: t = walltime(t0)
4394-
sage: t < 10 or t
4395-
True
4388+
sage: from sage.doctest.util import ensure_interruptible_after
4389+
sage: with ensure_interruptible_after(2, max_wait_after_interrupt=8): A._solve_iml(B)
43964390
43974391
ALGORITHM: Uses IML.
43984392
@@ -4549,14 +4543,8 @@ cdef class Matrix_integer_dense(Matrix_dense):
45494543
45504544
sage: A = random_matrix(ZZ, 2000, 2000)
45514545
sage: B = random_matrix(ZZ, 2000, 2000)
4552-
sage: t0 = walltime()
4553-
sage: alarm(2); A._solve_flint(B) # long time
4554-
Traceback (most recent call last):
4555-
...
4556-
AlarmInterrupt
4557-
sage: t = walltime(t0)
4558-
sage: t < 10 or t
4559-
True
4546+
sage: from sage.doctest.util import ensure_interruptible_after
4547+
sage: with ensure_interruptible_after(2, max_wait_after_interrupt=8): A._solve_flint(B)
45604548
45614549
AUTHORS:
45624550

‎src/sage/matrix/matrix_mod2_dense.pyx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1975,10 +1975,8 @@ cdef class Matrix_mod2_dense(matrix_dense.Matrix_dense): # dense or sparse
19751975
sage: A = random_matrix(GF(2), n, m)
19761976
sage: x = random_vector(GF(2), m)
19771977
sage: B = A*x
1978-
sage: alarm(0.5); sol = A.solve_right(B)
1979-
Traceback (most recent call last):
1980-
...
1981-
AlarmInterrupt
1978+
sage: from sage.doctest.util import ensure_interruptible_after
1979+
sage: with ensure_interruptible_after(0.5): sol = A.solve_right(B)
19821980
"""
19831981
cdef mzd_t *B_entries = (<Matrix_mod2_dense>B)._entries
19841982

‎src/sage/rings/complex_arb.pyx

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1184,13 +1184,10 @@ class ComplexBallField(UniqueRepresentation, sage.rings.abc.ComplexBallField):
11841184
sage: ComplexBallField(100).integral(lambda x, _: sin(x), RBF(0), RBF(1))
11851185
[0.4596976941318602825990633926 +/- ...e-29]
11861186
1187-
sage: from cysignals.alarm import alarm
1188-
sage: alarm(0.1r)
1189-
sage: C = ComplexBallField(1000000)
1190-
sage: C.integral(lambda x, _: x.cos() * x.sin(), 0, 1)
1191-
Traceback (most recent call last):
1192-
...
1193-
AlarmInterrupt
1187+
sage: from sage.doctest.util import ensure_interruptible_after
1188+
sage: with ensure_interruptible_after(0.1):
1189+
....: C = ComplexBallField(1000000)
1190+
....: C.integral(lambda x, _: x.cos() * x.sin(), 0, 1)
11941191
"""
11951192
cdef IntegrationContext ctx = IntegrationContext()
11961193
cdef acb_calc_integrate_opt_t arb_opts

‎src/sage/rings/factorint_pari.pyx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,11 @@ def factor_using_pari(n, int_=False, debug_level=0, proof=None):
5050
5151
Check that PARI's debug level is properly reset (:issue:`18792`)::
5252
53-
sage: alarm(0.5); factor(2^1000 - 1, verbose=5)
54-
Traceback (most recent call last):
53+
sage: from sage.doctest.util import ensure_interruptible_after
54+
sage: with ensure_interruptible_after(0.5): factor(2^1000 - 1, verbose=5)
5555
...
56-
AlarmInterrupt
56+
doctest:warning...
57+
RuntimeWarning: cypari2 leaked ... bytes on the PARI stack
5758
sage: pari.get_debug_level()
5859
0
5960
"""

‎src/sage/rings/integer.pyx

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7108,21 +7108,16 @@ cdef class Integer(sage.structure.element.EuclideanDomainElement):
71087108
71097109
Check that it can be interrupted (:issue:`17852`)::
71107110
7111-
sage: alarm(0.5); (2^100).binomial(2^22, algorithm='mpir')
7112-
Traceback (most recent call last):
7113-
...
7114-
AlarmInterrupt
7111+
sage: from sage.doctest.util import ensure_interruptible_after
7112+
sage: with ensure_interruptible_after(0.5): (2^100).binomial(2^22, algorithm='mpir')
71157113
71167114
For PARI, we try 10 interrupts with increasing intervals to
71177115
check for reliable interrupting, see :issue:`18919`::
71187116
71197117
sage: from cysignals import AlarmInterrupt
71207118
sage: for i in [1..10]: # long time (5s) # needs sage.libs.pari
7121-
....: try:
7122-
....: alarm(i/11)
7119+
....: with ensure_interruptible_after(i/11):
71237120
....: (2^100).binomial(2^22, algorithm='pari')
7124-
....: except AlarmInterrupt:
7125-
....: pass
71267121
doctest:...: RuntimeWarning: cypari2 leaked ... bytes on the PARI stack...
71277122
"""
71287123
cdef Integer x

‎src/sage/rings/polynomial/polynomial_element.pyx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2533,10 +2533,8 @@ cdef class Polynomial(CommutativePolynomial):
25332533
sage: K.<a> = GF(2^8)
25342534
sage: x = polygen(K)
25352535
sage: pol = x^1000000 + x + a
2536-
sage: alarm(0.5); pol.any_root()
2537-
Traceback (most recent call last):
2538-
...
2539-
AlarmInterrupt
2536+
sage: from sage.doctest.util import ensure_interruptible_after
2537+
sage: with ensure_interruptible_after(0.5): pol.any_root()
25402538
25412539
Check root computation over large finite fields::
25422540

‎src/sage/rings/polynomial/polynomial_zmod_flint.pyx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -811,10 +811,8 @@ cdef class Polynomial_zmod_flint(Polynomial_template):
811811
812812
sage: R.<x> = PolynomialRing(GF(65537), implementation="FLINT")
813813
sage: f = R.random_element(9973) * R.random_element(10007)
814-
sage: alarm(0.5); f.factor()
815-
Traceback (most recent call last):
816-
...
817-
AlarmInterrupt
814+
sage: from sage.doctest.util import ensure_interruptible_after
815+
sage: with ensure_interruptible_after(0.5): f.factor()
818816
819817
Test zero polynomial::
820818

‎src/sage/rings/qqbar.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7106,14 +7106,13 @@ def exactify(self):
71067106
sage: x = polygen(AA)
71077107
sage: p = AA(2)^(1/100) * x + AA(3)^(1/100)
71087108
sage: cp = AA.common_polynomial(p)
7109-
sage: alarm(0.5); cp.generator()
7110-
Traceback (most recent call last):
7111-
...
7112-
AlarmInterrupt
7113-
sage: alarm(0.5); cp.generator()
7114-
Traceback (most recent call last):
7115-
...
7116-
AlarmInterrupt
7109+
sage: from sage.doctest.util import ensure_interruptible_after
7110+
sage: with ensure_interruptible_after(0.5): cp.generator()
7111+
doctest:warning...
7112+
RuntimeWarning: cypari2 leaked ... bytes on the PARI stack
7113+
sage: with ensure_interruptible_after(0.5): cp.generator()
7114+
doctest:warning...
7115+
RuntimeWarning: cypari2 leaked ... bytes on the PARI stack
71177116
"""
71187117
if self._exact:
71197118
return

‎src/sage/schemes/elliptic_curves/descent_two_isogeny.pyx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1208,10 +1208,8 @@ def two_descent_by_two_isogeny(E,
12081208
Elliptic Curve defined by y^2 = x^3 - x^2 - 900*x - 10098 over Rational Field
12091209
sage: E.sha().an()
12101210
4
1211-
sage: alarm(0.5); two_descent_by_two_isogeny(E, global_limit_large=10^8)
1212-
Traceback (most recent call last):
1213-
...
1214-
AlarmInterrupt
1211+
sage: from sage.doctest.util import ensure_interruptible_after
1212+
sage: with ensure_interruptible_after(0.5): two_descent_by_two_isogeny(E, global_limit_large=10^8)
12151213
"""
12161214
cdef Integer a1, a2, a3, a4, a6, s2, s4, s6
12171215
cdef Integer c, d, x0

‎src/sage/sets/recursively_enumerated_set.pyx

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1122,11 +1122,8 @@ cdef class RecursivelyEnumeratedSet_symmetric(RecursivelyEnumeratedSet_generic):
11221122
{0}
11231123
sage: next(it)
11241124
{-1, 1}
1125-
sage: from cysignals.alarm import alarm
1126-
sage: alarm(0.02); next(it)
1127-
Traceback (most recent call last):
1128-
...
1129-
AlarmInterrupt
1125+
sage: from sage.doctest.util import ensure_interruptible_after
1126+
sage: with ensure_interruptible_after(0.02): next(it)
11301127
sage: next(it)
11311128
Traceback (most recent call last):
11321129
...
@@ -1175,11 +1172,8 @@ cdef class RecursivelyEnumeratedSet_symmetric(RecursivelyEnumeratedSet_generic):
11751172
....: sleep(0.1r)
11761173
....: return [a - 1, a + 1]
11771174
sage: C = RecursivelyEnumeratedSet([0], f, structure='symmetric')
1178-
sage: from cysignals.alarm import alarm
1179-
sage: alarm(0.45); C.graded_component(10)
1180-
Traceback (most recent call last):
1181-
...
1182-
AlarmInterrupt
1175+
sage: from sage.doctest.util import ensure_interruptible_after
1176+
sage: with ensure_interruptible_after(0.45): C.graded_component(10)
11831177
sage: C.graded_component(1)
11841178
{-1, 1}
11851179
sage: C.graded_component(2)
@@ -1394,11 +1388,8 @@ cdef class RecursivelyEnumeratedSet_graded(RecursivelyEnumeratedSet_generic):
13941388
....: sleep(0.1r)
13951389
....: return [a + 1, a + I]
13961390
sage: C = RecursivelyEnumeratedSet([0], f, structure='graded')
1397-
sage: from cysignals.alarm import alarm
1398-
sage: alarm(0.45); C.graded_component(10)
1399-
Traceback (most recent call last):
1400-
...
1401-
AlarmInterrupt
1391+
sage: from sage.doctest.util import ensure_interruptible_after
1392+
sage: with ensure_interruptible_after(0.45): C.graded_component(10)
14021393
sage: C.graded_component(2)
14031394
{2*I, I + 1, 2}
14041395
sage: C.graded_component(3)

0 commit comments

Comments
 (0)