Trac #16746: Use the Sage displayhook in doctests

The doctests output should look like the Sage commandline output, which
it currently does not quite. Differences include:
* Dictionaries will be sorted by key, makes output more reproducable
* Sets are printed as `{1,2}` instead of `set([1,2])`
* Empty set is `set()` instead of `set([])`
* Types are `<Foo at 0x...>` instead of `<Foo object at 0x...>`

Other changes:
* Normal tracebacks can now be distinguished from tracebacks in
`__repr__` (IPython extension):
{{{
sage: f(*args)
<repr(<sage.interfaces.gap.GapElement at 0x...>) failed: ValueError: The
session in which this object was defined is no longer running.>
}}}
* Plots now print themselves in doctest mode:
{{{
sage: A.plot()
Graphics object consisting of 1 graphics primitive
}}}

URL: http://trac.sagemath.org/16746
Reported by: vbraun
Ticket author(s): Volker Braun
Reviewer(s): François Bissey

src/doc/de/thematische_anleitungen/sage_gymnasium.rst

@@ -607,6 +607,7 @@ darstellen::
 
     sage: f(x) = x^2
     sage: plot(f)
+    Graphics object consisting of 1 graphics primitive
 
 Sage versucht einen vernünftigen Bereich von x-Werten zu finden, um den Funktionsgraphen
 darzustellen. Falls dies nicht dem gewünschten Bereich entspricht, können wir diesen mit
@@ -615,6 +616,7 @@ die y-Achse den zu darstellenden Bereich festlegen::
 
     sage: f(x) = x^2
     sage: plot(f, xmin=-12, xmax=12, ymin=-10, ymax=150)
+    Graphics object consisting of 1 graphics primitive
 
 Wollen wir mehrere Funktionsgraphen im selben Koordinatensystem darstellen, können wir
 die beiden Plots einzeln erstellen und in Variabeln abspeichern. Dies verhindert, dass
@@ -625,6 +627,7 @@ zusammen anzuzeigen. Die Plots werden mit einem ``+``-Zeichen zusammengefügt. M
     sage: graph1 = plot(x^2 + 1, color="green", xmin = 0, xmax = 3)
     sage: graph2 = plot(e^x, color="red", xmin = 0, xmax = 3)
     sage: plot(graph1 + graph2, )
+    Graphics object consisting of 2 graphics primitives
 
 Optionen, welche für beide Plots gültig sind (z.B. ``xmin`` oder ``xmax``) müssen auch bei
 beiden Plots angegeben werden, da sonst Sage sonst beim Graph, wo es nicht angegeben wird wie
@@ -648,19 +651,22 @@ Wie wir oben gelernt haben, können wir den Wertebereich einfach einschränken::
 
     sage: f(x)=(x^2 +1)/(x^2-1)
     sage: plot(f, xmin=-2, xmax=2, ymin=-10, ymax = 10)
+    Graphics object consisting of 1 graphics primitive
 
 Nun haben wir nur noch das Problem, dass der Graph zwei unerwünschte senkrechte Linien an den
 Polstellen hat. Dies kann mit der Option ``detect_poles`` verhindert werden. Falls wir die
 Option auf ``True`` stellen, werden die Linien nicht mehr dargestellt::
 
     sage: f(x)=(x^2 +1)/(x^2-1)
     sage: plot(f, xmin=-2, xmax=2, ymin=-10, ymax = 10, detect_poles=True)
+    Graphics object consisting of 4 graphics primitives
 
 Möchten wir hingegen die vertikalen Asymptoten trotzdem darstellen, aber nicht in derselben
 Farbe wie den Funktionsgraphen, können wir die Option ``detect_poles`` auf ``"show"`` stellen::
 
     sage: f(x)=(x^2 +1)/(x^2-1)
     sage: plot(f, xmin=-2, xmax=2, ymin=-10, ymax = 10, detect_poles="show")
+    Graphics object consisting of 6 graphics primitives
 
 Logarithmen
 ===========
@@ -905,6 +911,7 @@ Die Addition von Vektoren könnte also zum Beispiel wie folgt veranschaulicht we
     sage: v2 = arrow((3,4), (6,1))
     sage: sum_v1_v2 = arrow((0,0), (6,1), color='red')
     sage: plot(v1 + v2 + sum_v1_v2)
+    Graphics object consisting of 3 graphics primitives
 
 Falls die Vektorpfeile zu dick oder zu dünn sind, kann mit der ``width`` Option die Strichbreite angepasst werden.
 Der Plot-Befehl besitzt eine ``gridlines`` option, welche wir auf ``true`` setzen können, falls Gitternetzlinien
@@ -914,6 +921,7 @@ in der Grafik erwünscht sind::
     sage: v2 = arrow((3,4), (6,1), width=5)
     sage: sum_v1_v2 = arrow((0,0), (6,1), color='red', width=6)
     sage: plot(v1 + v2 + sum_v1_v2, gridlines=true)
+    Graphics object consisting of 3 graphics primitives
 
 Analysis
 ========
@@ -978,6 +986,7 @@ wir sogenannte Python List Comprehensions [#listcomp]_ benutzen, um die Liste zu
     sage: a(n) = 1/n^2
     sage: punkte = [(n, a(n)) for n in range(1,10)]
     sage: scatter_plot(punkte)
+    Graphics object consisting of 1 graphics primitive
 
 
 Mit den Funktion ``range()`` geben wir an, welchen Bereich wir gerne darstellen möchten. Dabei wird
@@ -993,6 +1002,7 @@ darzustellen::
     sage: plot1 = scatter_plot(points)
     sage: plot2 = plot(a(x), xmin=1, xmax=5.4)
     sage: plot(plot1 + plot2)
+    Graphics object consisting of 2 graphics primitives
 
 
 Grenzwerte

src/doc/de/tutorial/programming.rst

@@ -500,16 +500,18 @@ ob ein Element zu der Menge gehört oder nicht, sehr schnell geht.
 ::
 
     sage: X = set([1,19,'a']);   Y = set([1,1,1, 2/3])
-    sage: X
-    set(['a', 1, 19])
+    sage: X   # random sort order
+    {1, 19, 'a'}
+    sage: X == set(['a', 1, 1, 19])
+    True
     sage: Y
-    set([1, 2/3])
+    {2/3, 1}
     sage: 'a' in X
     True
     sage: 'a' in Y
     False
     sage: X.intersection(Y)
-    set([1])
+    {1}
 
 Sage besitzt auch einen eigenen Mengen-Datentyp, welcher (manchmal)
 mit Hilfe des standardmäßigen Python-Mengen-Datentyps implementiert
@@ -520,8 +522,10 @@ verwenden. Zum Beispiel,
 ::
 
     sage: X = Set([1,19,'a']);   Y = Set([1,1,1, 2/3])
-    sage: X
+    sage: X   # random sort order
     {'a', 1, 19}
+    sage: X == Set(['a', 1, 1, 19])
+    True
     sage: Y
     {1, 2/3}
     sage: X.intersection(Y)

src/doc/de/tutorial/tour_functions.rst

@@ -22,6 +22,7 @@ oder integriert werden.
        sage: f(3)
        9
        sage: plot(f, 0, 2)
+       Graphics object consisting of 1 graphics primitive
 
 Beachten Sie die Syntax in der letzten Zeile. Falls Sie stattdessen
 ``plot(f(z), 0, 2)`` verwenden, erhalten Sie einen Fehler, da ``z``
@@ -40,6 +41,7 @@ sollte. (Beachten Sie unten den 4. Punkt)
        sage: f(z)
        z^2
        sage: plot(f(z), 0, 2)
+       Graphics object consisting of 1 graphics primitive
 
 Nun ist `f(z)`` ein symbolischer Ausdruck. Dies ist unser nächster Stichpunkt
 unserer Aufzählung.
@@ -61,6 +63,7 @@ können geplottet, differenziert und integriert werden.
        sage: type(g)
        <type 'sage.symbolic.expression.Expression'>
        sage: plot(g, 0, 2)
+       Graphics object consisting of 1 graphics primitive
 
 Beachten Sie, dass während ``g`` ein aufrufbarer symbolischer Ausdruck
 ist, ``g(x)`` ein verwandtes aber unterschiedliches Objekt ist,
@@ -79,6 +82,7 @@ Erläuterung zu erhalten.
        sage: g(x).derivative()
        2*x
        sage: plot(g(x), 0, 2)
+       Graphics object consisting of 1 graphics primitive
 
 3. Benutzung einer vordefinierten 'trigonometrischen Sage-Funktion'.
 Diese können mit ein wenig Hilfestellung differenziert und integriert
@@ -89,9 +93,11 @@ werden.
        sage: type(sin)
        <class 'sage.functions.trig.Function_sin'>
        sage: plot(sin, 0, 2)
+       Graphics object consisting of 1 graphics primitive
        sage: type(sin(x))
        <type 'sage.symbolic.expression.Expression'>
        sage: plot(sin(x), 0, 2)
+       Graphics object consisting of 1 graphics primitive
 
 Alleinestehend kann ``sin`` nicht differenziert werden, zumindest nicht
 um ``cos`` zu erhalten.
@@ -151,6 +157,7 @@ Die Lösung: verwenden Sie nicht ``plot(h(x), 0, 4)``; benutzen Sie stattdessen:
 ::
 
        sage: plot(h, 0, 4)
+       Graphics object consisting of 1 graphics primitive
 
 \5. Versehentliches Erzeugen einer Konstanten anstelle von einer Funktion.
 

src/doc/de/tutorial/tour_plotting.rst

@@ -22,12 +22,14 @@ Ursprung als Zentrum:
 ::
 
     sage: circle((0,0), 1, rgbcolor=(1,1,0))
+    Graphics object consisting of 1 graphics primitive
 
 Sie können auch einen ausgefüllten Kreis erzeugen:
 
 ::
 
     sage: circle((0,0), 1, rgbcolor=(1,1,0), fill=True)
+    Graphics object consisting of 1 graphics primitive
 
 Sie können einen Kreis auch erstellen, indem Sie ihn einer Variable
 zuweisen; so wird kein Plot gezeigt.
@@ -66,6 +68,7 @@ Es ist einfach elementare Funktionen zu plotten:
 ::
 
     sage: plot(cos, (-5,5))
+    Graphics object consisting of 1 graphics primitive
 
 Sobald Sie einen Variablennamen angegeben haben, können Sie
 parametrische Plots erzeugen:
@@ -74,6 +77,7 @@ parametrische Plots erzeugen:
 
     sage: x = var('x')
     sage: parametric_plot((cos(x),sin(x)^3),(x,0,2*pi),rgbcolor=hue(0.6))
+    Graphics object consisting of 1 graphics primitive
 
 Es ist wichtig zu beachten, dass sich die Achsen eines Plots nur
 schneiden, wenn sich der Ursprung im angezeigten Bildbereich des
@@ -82,6 +86,7 @@ wissenschaftliche Notation benutzt:
 ::
 
     sage: plot(x^2,(x,300,500))
+    Graphics object consisting of 1 graphics primitive
 
 Sie können mehrere Plots zusammenfügen indem Sie diese addieren:
 
@@ -104,6 +109,7 @@ bestimmten, Rand zu zeichnen. Zum Beispiel ist hier ein grünes Deltoid:
     ...   2*sin(pi*i/100)*(1-cos(pi*i/100))] for i in range(200)]
     sage: p = polygon(L, rgbcolor=(1/8,3/4,1/2))
     sage: p
+    Graphics object consisting of 1 graphics primitive
 
 Geben Sie ``show(p, axes=false)`` ein, um dies ohne Achsen zu sehen.
 
@@ -127,6 +133,7 @@ Befehl erzeugt dies:
 
     sage: v = [(sin(x),x) for x in srange(-2*float(pi),2*float(pi),0.1)]
     sage: line(v)
+    Graphics object consisting of 1 graphics primitive
 
 Da die Tangensfunktion einen größeren Wertebereich als die
 Sinusfunktion besitzt, sollten Sie, falls Sie den gleichen Trick
@@ -146,6 +153,7 @@ Beispiel eines Konturplots:
 
     sage: f = lambda x,y: cos(x*y)
     sage: contour_plot(f, (-4, 4), (-4, 4))
+    Graphics object consisting of 1 graphics primitive
 
 Dreidimensionale Plots
 ----------------------
@@ -162,6 +170,7 @@ Benutzen Sie ``plot3d`` um eine Funktion der Form `f(x, y) = z` zu zeichnen:
 
     sage: x, y = var('x,y')
     sage: plot3d(x^2 + y^2, (x,-2,2), (y,-2,2))
+    Graphics3d Object
 
 Alternativ können Sie auch ``parametric_plot3d`` verwenden um eine
 parametrisierte Fläche zu zeichnen, wobei jede der Variablen `x, y, z`
@@ -176,6 +185,7 @@ wie folgt parametrisiert angegeben werden:
     sage: f_y(u, v) = v
     sage: f_z(u, v) = u^2 + v^2
     sage: parametric_plot3d([f_x, f_y, f_z], (u, -2, 2), (v, -2, 2))
+    Graphics3d Object
 
 Die dritte Möglichkeit eine 3D Oberfläche zuplotten ist
 ``implicit_plot3d``, dies zeichnet eine Kontur einer Funktion mit
@@ -186,6 +196,7 @@ Sphäre mithilfe einer klassischen Formel zeichnen:
 
     sage: x, y, z = var('x, y, z')
     sage: implicit_plot3d(x^2 + y^2 + z^2 - 4, (x,-2, 2), (y,-2, 2), (z,-2, 2))
+    Graphics3d Object
 
 Hier sind noch ein paar Beispiele:
 
@@ -198,7 +209,8 @@ Hier sind noch ein paar Beispiele:
     sage: fy = u
     sage: fz = v^2
     sage: parametric_plot3d([fx, fy, fz], (u, -1, 1), (v, -1, 1),
-    ...   frame=False, color="yellow")
+    ....:   frame=False, color="yellow")
+    Graphics3d Object
 
 Die `Kreuz-Kappe <http://de.wikipedia.org/wiki/Kreuzhaube>`__:
 
@@ -209,7 +221,8 @@ Die `Kreuz-Kappe <http://de.wikipedia.org/wiki/Kreuzhaube>`__:
     sage: fy = (1+cos(v))*sin(u)
     sage: fz = -tanh((2/3)*(u-pi))*sin(v)
     sage: parametric_plot3d([fx, fy, fz], (u, 0, 2*pi), (v, 0, 2*pi),
-    ...   frame=False, color="red")
+    ....:   frame=False, color="red")
+    Graphics3d Object
 
 Ein gedrehter Torus:
 
@@ -220,7 +233,8 @@ Ein gedrehter Torus:
     sage: fy = (3+sin(v)+cos(u))*sin(2*v)
     sage: fz = sin(u)+2*cos(v)
     sage: parametric_plot3d([fx, fy, fz], (u, 0, 2*pi), (v, 0, 2*pi),
-    ...   frame=False, color="red")
+    ....:   frame=False, color="red")
+    Graphics3d Object
 
 Die `Lemniskate <http://de.wikipedia.org/wiki/Lemniskate>`__:
 
@@ -229,3 +243,4 @@ Die `Lemniskate <http://de.wikipedia.org/wiki/Lemniskate>`__:
     sage: x, y, z = var('x,y,z')
     sage: f(x, y, z) = 4*x^2 * (x^2 + y^2 + z^2 + z) + y^2 * (y^2 + z^2 - 1)
     sage: implicit_plot3d(f, (x, -0.5, 0.5), (y, -1, 1), (z, -1, 1))
+    Graphics3d Object

src/doc/en/bordeaux_2008/introduction.rst

@@ -66,12 +66,14 @@ positive integer up to :math:`500`.
 ::
 
     sage: line([(n, len(factor(n))) for n in [1..500]])
+    Graphics object consisting of 1 graphics primitive
 
 
 And, this example draws a similar 3d plot::
 
     sage: v = [[len(factor(n*m)) for n in [1..15]] for m in [1..15]]
     sage: list_plot3d(v, interpolation_type='nn')
+    Graphics3d Object
 
 
 The Sage-Pari-Magma Ecosystem

src/doc/en/constructions/calculus.rst

@@ -317,6 +317,7 @@ for :math:`0 <= t <= 2`. The same result can be obtained by using ``desolve_syst
     sage: p1 = list_plot([[i,j] for i,j,k in P], plotjoined=True)
     sage: p2 = list_plot([[i,k] for i,j,k in P], plotjoined=True, color='red')
     sage: p1+p2
+    Graphics object consisting of 2 graphics primitives
 
 Another way this system can be solved is to use the command ``desolve_system``.
 

src/doc/en/constructions/plotting.rst

@@ -40,6 +40,7 @@ You can plot piecewise-defined functions:
     sage: f4 = lambda x:sin(2*x)
     sage: f = Piecewise([[(0,1),f1],[(1,2),f2],[(2,3),f3],[(3,10),f4]])
     sage: f.plot()
+    Graphics object consisting of 4 graphics primitives
 
 Other function plots can be produced as well:
 
@@ -93,6 +94,7 @@ A blue conchoid of Nicomedes:
     sage: L = [[1+5*cos(pi/2+pi*i/100), tan(pi/2+pi*i/100)*\
     ...   (1+5*cos(pi/2+pi*i/100))] for i in range(1,100)]
     sage: line(L, rgbcolor=(1/4,1/8,3/4))
+    Graphics object consisting of 1 graphics primitive
 
 A blue hypotrochoid (3 leaves):
 
@@ -102,6 +104,7 @@ A blue hypotrochoid (3 leaves):
     sage: L = [[n*cos(pi*i/100)+h*cos((n/b)*pi*i/100),\
     ...   n*sin(pi*i/100)-h*sin((n/b)*pi*i/100)] for i in range(200)]
     sage: line(L, rgbcolor=(1/4,1/4,3/4))
+    Graphics object consisting of 1 graphics primitive
 
 A blue hypotrochoid (4 leaves):
 
@@ -111,6 +114,7 @@ A blue hypotrochoid (4 leaves):
     sage: L = [[n*cos(pi*i/100)+h*cos((n/b)*pi*i/100),\
     ...   n*sin(pi*i/100)-h*sin((n/b)*pi*i/100)] for i in range(200)]
     sage: line(L, rgbcolor=(1/4,1/4,3/4))
+    Graphics object consisting of 1 graphics primitive
 
 A red limaçon of Pascal:
 
@@ -119,6 +123,7 @@ A red limaçon of Pascal:
     sage: L = [[sin(pi*i/100)+sin(pi*i/50),-(1+cos(pi*i/100)+cos(pi*i/50))]\
     ...   for i in range(-100,101)]
     sage: line(L, rgbcolor=(1,1/4,1/2))
+    Graphics object consisting of 1 graphics primitive
 
 A light green trisectrix of Maclaurin:
 
@@ -127,6 +132,7 @@ A light green trisectrix of Maclaurin:
     sage: L = [[2*(1-4*cos(-pi/2+pi*i/100)^2),10*tan(-pi/2+pi*i/100)*\
     ...   (1-4*cos(-pi/2+pi*i/100)^2)] for i in range(1,100)]
     sage: line(L, rgbcolor=(1/4,1,1/8))
+    Graphics object consisting of 1 graphics primitive
 
 
 A green lemniscate of Bernoulli (we omit i==100 since that would give a 0 division error):
@@ -136,6 +142,7 @@ A green lemniscate of Bernoulli (we omit i==100 since that would give a 0 divisi
     sage: v = [(1/cos(-pi/2+pi*i/100), tan(-pi/2+pi*i/100)) for i in range(1,200) if i!=100 ]
     sage: L = [(a/(a^2+b^2), b/(a^2+b^2)) for a,b in v]
     sage: line(L, rgbcolor=(1/4,3/4,1/8))
+    Graphics object consisting of 1 graphics primitive
 
 
 .. index:: plot;curve using surf