IPython directive should strip ansi escape sequence from output.

[Carreau]

Stderr/out and especially traceback get garbled in the out with Ansi escape sequence.
We should figure out how to turn coloring off, or strip escape sequences.

[mrecachinas]

@Carreau Trying to reproduce this. Can you provide an example? I'm on macOS 10.14 using Python 3.6 and a fresh pull of ipython (running in a virtualenv).

(ipython) $ bin/ipython
Python 3.6.5 (default, Apr 25 2018, 14:23:58)
Type 'copyright', 'credits' or 'license' for more information
IPython 7.1.0.dev -- An enhanced Interactive Python. Type '?' for help.

In [1]: raise
---------------------------------------------------------------------------
RuntimeError                              Traceback (most recent call last)
<ipython-input-1-9c9a2cba73bf> in <module>
----> 1 raise

RuntimeError: No active exception to reraise

In [2]: raise ValueError('\v')
---------------------------------------------------------------------------
ValueError                                Traceback (most recent call last)
<ipython-input-2-47eaec54718e> in <module>
----> 1 raise ValueError('\v')

ValueError:

In [3]:

Note: the above is colored properly.

[Carreau]

You can see it just above this header, note that it only appears on the documentation page, not in IPython shell itself:

[mrecachinas]

Ahh, understood. I'll take a look.

[ankitkariryaa]

You can see it just above this header, note that it only appears on the documentation page, not in IPython shell itself:

Hey,
The link doesn't exist. Can you please update it?

[mrecachinas]

@ankitkariryaa https://ipython.readthedocs.io/en/stable/sphinxext.html

[mrecachinas]

@Carreau I looked at this briefly, but when I tried running the manual test in ipython/IPython/sphinxext/ipython_directive.py, it produced no output (i.e., no sphinx docs were generated to visually inspect). I tried making an automated unit test for it, so I could inspect further, but kept coming up against it wanting to be run within sphinx.

[mrecachinas]

@Carreau I couldn't replicate this issue in Python 3.6 using Sphinx==1.8.4 on either a clone of IPython from November (c3b288d) or today (548f0fe). My environment is:

(ipython) mrecachinas in ~/Desktop/ipython/docs  [548f0feba]  11:25
> python -c "import IPython; print(IPython.sys_info())"
{'commit_hash': '548f0feba',
 'commit_source': 'installation',
 'default_encoding': 'UTF-8',
 'ipython_path': '/Users/mrecachinas/Desktop/ipython/lib/python3.6/site-packages/IPython',
 'ipython_version': '7.4.0.dev',
 'os_name': 'posix',
 'platform': 'Darwin-18.2.0-x86_64-i386-64bit',
 'sys_executable': '/Users/mrecachinas/Desktop/ipython/bin/python',
 'sys_platform': 'darwin',
 'sys_version': '3.6.5 (default, Apr 25 2018, 14:23:58) \n'
                '[GCC 4.2.1 Compatible Apple LLVM 9.1.0 (clang-902.0.39.1)]'}

My steps to reproduce were:

git clone https://github.com/ipython/ipython
cd ipython
virtualenv -p `which python3` .
source bin/activate
pip install numpy matplotlib
python setup.py install
cd docs
make

This is the resulting HTML file showing the correct syntax highlighting (and no ansi escape characters).

I also tried the sphinx extension out on an example project using the following

$ pip install Sphinx
$ sphinx-quickstart
Welcome to the Sphinx 1.8.4 quickstart utility.
[...]
$ make html

I accepted most defaults in the conf.py, with the only difference in extensions, shown below

extensions = [
    'sphinx.ext.doctest',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx.ext.githubpages',
    'IPython.sphinxext.ipython_console_highlighting',
    'IPython.sphinxext.ipython_directive'
]

For the example, I added to index.rst

.. ipython::
   :okexcept:

   In [136]: 1 / 0

This resulted in

Unsure why the error still shows on https://ipython.readthedocs.io/en/stable/sphinxext.html, but it doesn't appear to be reproducible. Can we trigger a rebuild of the readthedocs.io build?

[Viktor-Demin]

@mrecachinas you can easily replicate this issue with datatable package:

.. ipython:: python

    import datatable as dt
    DT = dt.Frame(A=range(5))
    DT

generates

whilie in Jupyter notebooks it looks well:

There is a colorcoding for different data types

[Viktor-Demin]

@Carreau maybe you could suggest where to start to investigate this issue?

[Carreau]

Hum,

Thanks both for trying. I think so far we need to manage to narrow down where the big might be, or at least which extension/plugin/version of what is the culprit.

[Viktor-Demin]

@Carreau maybe there is a workaround? Can this color coding be turned off? or maybe using jupyter notebook of older version?

[Carreau]

I don't believe it can be turned off. It is most likely completely unrelated to the version of the notebook package.