Create a stopgap warning

[roed314]

Sometimes issues can produce mathematically incorrect results, and we should warn users of the problem. If the issue is fixed promptly then nothing more needs to be done, but sometimes tickets remain unresolved for months or years (c.f. #11358). This ticket adds a function that makes it easy to create a second ticket warning users of the problem while it's being resolved.

On trac, this functionality will be supported by the Stopgaps field. Create a new ticket that uses the stopgap function and include a link to it in the Stopgaps field in the original ticket.

---

Apply attachment: trac_12691-faster.patch

Depends on #12702

Component: misc

Keywords: rd2

Author: David Roe, William Stein

Reviewer: R. Andrew Ohana

Merged: sage-5.0.beta10

Issue created by migration from https://trac.sagemath.org/ticket/12691

[roed314]

Attachment: 12691.patch.gz

[jbalakrishnan]

comment:2

Looks good.

[jbalakrishnan]

Changed keywords from none to rd2

[jhpalmieri]

comment:3

See #12702 for a followup.

[williamstein]

comment:4

I think this code is too slow. We want it to be highly optimized so as to not have much of a performance penalty for introducing a stopgap. I'm going to attach a different patch that implements stopgaps, and is an order of magnitude faster than this code:

sage: timeit("sage.misc.misc.stopgap('abc', 123)", number=10^5)
100000 loops, best of 3: 2.49 µs per loop
sage: import sage.misc.stopgap
sage: timeit("sage.misc.stopgap.stopgap('abc', 123)", number=10^5)
100000 loops, best of 3: 388 ns per loop
sage: 2.49 / .388
6.41752577319588

[ohanar]

Changed author from David Roe to David Roe, William Stein

[ohanar]

comment:7

Attachment: trac_12691-faster.patch.gz

everything looks good to me and works how I expect it to, positive review!

[ohanar]

Reviewer: R. Andrew Ohana

[kcrisman]

comment:9

Just clarification; this doesn't

create a second ticket warning users of the problem

right, or even 'make it easy' to do so? It seems to function more like deprecations; it doesn't do anything, but warns users that something might be wrong. Let me know if I'm wrong about this, otherwise I hope to use it in the future.

Nice addition.

[jhpalmieri]

comment:10

kcrisman: you're right, it doesn't create a ticket or make it easy to create a ticket, but it makes it easy to print a nice warning, like a deprecation. Does the documentation at #12702 make it clearer?

[kcrisman]

comment:11

Yeah, that's great. Wish I could be helping with this, but looks like RD2 is going very well.

[jhpalmieri]

Dependencies: #12702

[jdemeyer]

Merged: sage-5.0.beta10

[jdemeyer]

comment:14

Why not display the stopgap warnings in doctests? I would prefer documentation to show the stopgap warnings. It also would allow to see which parts of Sage are affected by stopgapped tickets.

It would also prevent sillyness like

sage: 1+1
********************************************************************************
Addition of integers can sometimes return wrong results.
This issue is being tracked at https://github.com/sagemath/sage/issues/123456.
********************************************************************************
2