Move DOCTEST_MODE to doctesting framework

[jdemeyer]

Move the DOCTEST_MODE setting to the doctesting framework, for example in the file sage/doctest/all.py.

Depends on #12415

CC: @jhpalmieri

Component: doctest framework

Author: John Palmieri

Reviewer: Volker Braun

Merged: sage-5.10.beta1

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

[jdemeyer]

Dependencies: #12415

[jhpalmieri]

comment:3

This patch puts DOCTEST_MODE in sage/doctest/__init__.py. It also removes it entirely from sage/plot/plot.py, since it wasn't used there at all. Should we leave it there for backwards compatibility with optional/experimental packages and third party code?

At some point, we might do the same with EMBEDDED_MODE, but this will also require patches to sagenb, and therefore is more annoying.

[roed314]

comment:4

Replying to @jhpalmieri:

This patch puts DOCTEST_MODE in sage/doctest/__init__.py. It also removes it entirely from sage/plot/plot.py, since it wasn't used there at all. Should we leave it there for backwards compatibility with optional/experimental packages and third party code?

We need a combined lazy_import/deprecate for this situation. :-)

At some point, we might do the same with EMBEDDED_MODE, but this will also require patches to sagenb, and therefore is more annoying.

Where would EMBEDDED_MODE move to?

[jhpalmieri]

comment:5

Replying to @roed314:

Where would EMBEDDED_MODE move to?

Maybe somewhere in sagenb?

[roed314]

comment:6

Replying to @roed314:

We need a combined lazy_import/deprecate for this situation. :-)

I decided to write something: see #14275.

[jdemeyer]

comment:7

Replying to @jhpalmieri:

At some point, we might do the same with EMBEDDED_MODE, but this will also require patches to sagenb, and therefore is more annoying.

And rename EMBEDDED_MODE to HTML_MODE or something else which describes the usage better.

And EMBEDDED_MODE is actually independently defined in 6 different modules:

devel/sagenb/sagenb/misc/support.py
devel/sage/sage/misc/pager.py
devel/sage/sage/misc/sageinspect.py
devel/sage/sage/misc/latex.py
devel/sage/sage/plot/plot.py
devel/sage/sage/server/support.py

[jhpalmieri]

comment:8

Is NOTEBOOK_MODE a good name?

Maybe we should import it from sagenb.misc.support for now, and then rename it later. Or we could do this once somewhere in the Sage library:

try:
    from sagenb.misc.support import NOTEBOOK_MODE
except ImportError:
    from sagenb.misc.support import EMBEDDED_MODE as NOTEBOOK_MODE

Then there can be an independent sagenb patch eventually.

[jdemeyer]

comment:10

Is this ticket ready for review?

[jhpalmieri]

comment:11

Sure, why not?

[jhpalmieri]

initial patch

[jhpalmieri]

comment:12

Attachment: trac_14203_doctest.patch.gz

Rebased to 5.9.beta2.

[vbraun]

Author: John Palmieri

[vbraun]

Reviewer: Volker Braun

[vbraun]

comment:13

Looks good to me!

[kcrisman]

comment:14

Umm... what about the #14275 situation? I don't think this would mess things up as much as moving EMBEDDED_MODE but perhaps it's still unwise to do without this...

[vbraun]

comment:15

I don't agree with #14275, for starters. It would be a mistake to make any guarantees about the implementation of the doctesting framework. If your code depends on the location of DOCTEST_MODE then your code is broken.

[jdemeyer]

Merged: sage-5.10.beta1