Improvements to IPython printing: strings, floats, and ints. #2683

moorepants · 2013-12-15T15:57:51Z

Removed strings from LaTeX printing in IPython as this was causing dictionaries
that contained strings and other valid LaTeX printable types to render. This is
typically not desirable especially if you have a dictionary with only strings,
floats, and integers.

I also added an option print_builtin to init_printing that allows you to
disable the float and integer LaTeX printing. For example, if you don't want a
dictionary of integer keys and float values to render in LaTeX.

Fixes issue #2672.

Tasks

Add tests to check that the LaTeX printing is correct.

Removed strings from LaTeX printing in IPython as this was causing dictionaries that contained strings and other valid LaTeX printable types to render. This is typically not desirable especially if you have a dictionary with only strings, floats, and integers. I also added an option `print_builtin` to `init_printing` that allows you to disable the float and integer LaTeX printing. For example, if you don't want a dictionary of integer keys and float values to render in LaTeX. Fixes issue sympy#2672.

moorepants · 2013-12-15T16:00:25Z

Previous behavior: http://nbviewer.ipython.org/gist/moorepants/7931775

New behavior: http://nbviewer.ipython.org/gist/moorepants/7974682

moorepants · 2013-12-16T03:30:38Z

The Travis failure seems unrelated to the PR.

asmeurer · 2013-12-16T04:56:41Z

Add tests.

asmeurer · 2013-12-16T04:58:24Z

I think you somehow squashed on top of #2656.

moorepants · 2013-12-16T16:24:33Z

With regards to the failure? What do you mean I squashed on top of #2656?

moorepants · 2013-12-16T17:53:36Z

How do I check for LaTeX printing in the IPython notebook? It seems that my test is only checking for pretty printing.

asmeurer · 2013-12-16T19:44:26Z

Your first commit contains changes from that PR.

asmeurer · 2013-12-16T19:45:13Z

I guess you need to check whatever the mime type of mathjax is instead of text/plain.

moorepants · 2013-12-16T20:15:15Z

My first commit only has things I added as far as I can tell. I'm not seeing what you think is from #2656

moorepants · 2013-12-16T20:27:32Z

I don't really understand what's going on in the tests. It looks like we call format() on an object and then see what it returns. This returns a dictionary with various types of output? I'm only seeing a text/plain output. What should I call on the object to force a mimetype that matches mathjab output?

asmeurer · 2013-12-16T21:37:54Z

The docstring of init_printing.

moorepants · 2013-12-16T21:46:14Z

I edited the doc string of init_printing because I noticed that many of the options were not documented.

asmeurer · 2013-12-16T21:58:44Z

Oh, so it was made independently. In that case, maybe you could review the said PR, as it has many of the same changes you are making.

moorepants · 2013-12-16T22:27:59Z

I think the only same changes in #2656 are the addition of the docstrings for the extra parameters. One of our commits has to go in first and the other adjust. I think this one is ready to go. I couldn't tell the status of the other one. @moble can you comment? I can just remove these doc string additions, but we are likely to have a merge conflict regardless.

asmeurer · 2013-12-29T17:29:07Z

I don't remember how. I thought you just went to https://www.hipchat.com/ghSp7E1uY and entered your name.

moorepants · 2013-12-29T19:32:56Z

I've added the last test here to check for the LaTeX representations. Ready to be reviewed for merge.

moorepants · 2013-12-29T19:35:43Z

@asmeurer ping

asmeurer · 2013-12-29T20:18:13Z

Things to check:

both the notebook and the qtconsole
Python 2 and Python 3
older versions of IPython (you don't have to go back too far, maybe one major version).

moorepants · 2013-12-29T20:52:51Z

Here is the qtconsole:

moorepants · 2013-12-29T20:55:39Z

I don't have environments on my local machine setup to test all kinds of versions of Python and IPython. I've been meaning to get familiar with conda, but haven't had the chance. Have people checked all these other versions before me? Is there no automated testing to deal with this?

asmeurer · 2013-12-29T20:58:57Z

conda/Anaconda would be the easiest way to do this. You could check everything in a jiffy. I personally can't check everything because there is not yet a pyqt (hence qtconsole) conda package for Python 3 on Mac OS X, but I believe there is on Linux.

moorepants · 2013-12-29T21:22:30Z

There doesn't seem to be Python 3 packages for conda for IPython 0.13.2. This is a lot of fussing around...not really a jiffy.

moorepants · 2013-12-29T21:34:15Z

Here is Python 2.7.6, IPython 0.13.2 in the notebook:

moorepants · 2013-12-29T21:39:11Z

Python 3.3, Ipython 1.1 in the notebook:

moorepants · 2013-12-29T21:39:44Z

I can't get qtconsole to run with anaconda. I keep getting failures in loading pygments.lexers.

moorepants · 2013-12-29T21:40:39Z

I've checked everything you listed except for all the permutations of version, of course.

asmeurer · 2013-12-29T22:16:04Z

Also check the tests. I can't remember if they are run in Travis.

But anyway, +1.

moorepants · 2013-12-30T00:00:50Z

The tests only run if IPython is installed. So, I don't think they happen on Travis.

I'm getting a test failure with Python 3.3 and IPython 0.13.2:

(sympy-3.3-testing)moorepants@moorepants-2170p:sympy(ipython-printing)$ bin/test sympy/interactive/tests/
================================================================ test process starts =================================================================
executable:         /home/moorepants/envs/sympy-3.3-testing/bin/python  (3.3.3-final-0) [CPython]
architecture:       64-bit
cache:              yes
ground types:       python 
random seed:        64048801
hash randomization: on (PYTHONHASHSEED=3531650678)

sympy/interactive/tests/test_interactive.py[1] .                                                                                                  [OK]
sympy/interactive/tests/test_ipython.py[2] ..                                                                                                     [OK]
sympy/interactive/tests/test_ipythonprinting.py[2] .F                                                                                           [FAIL]

______________________________________________________________________________________________________________________________________________________
_____________________________________ sympy/interactive/tests/test_ipythonprinting.py:test_print_builtin_option ______________________________________
  File "/home/moorepants/src/sympy/sympy/interactive/tests/test_ipythonprinting.py", line 66, in test_print_builtin_option
    assert text == "{pi: 3.14, n_i: 3}"
AssertionError

================================================ tests finished: 4 passed, 1 failed, in 1.46 seconds =================================================
DO *NOT* COMMIT!

This is returning the unicode version instead of a plain string. It passes on master but fails on this branch. I didn't touch that test. Not sure what the issue is.

moorepants · 2013-12-30T00:04:47Z

Would this failure have to do with removing the 'string_types'?

moorepants · 2013-12-30T00:07:13Z

No, this is something I wrote. Maybe it has to do with Python 3.3 strings being unicode.

moorepants · 2013-12-30T00:11:41Z

This is interesting:

(sympy-3.3-testing)moorepants@moorepants-2170p:sympy(ipython-printing)$ ipython --pdb
Python 2.7.5+ (default, Sep 19 2013, 13:48:49) 
Type "copyright", "credits" or "license" for more information.

IPython 1.1.0 -- An enhanced Interactive Python.
?         -> Introduction and overview of IPython's features.
%quickref -> Quick reference.
help      -> Python's own help system.
object?   -> Details about 'object', use 'object??' for extra details.

In [1]: from sympy.interactive.tests import test_ipythonprinting

In [2]: test_ipythonprinting.test_ipythonprinting()

In [3]: test_ipythonprinting.test_ipythonprinting()
---------------------------------------------------------------------------
AssertionError                            Traceback (most recent call last)
<ipython-input-3-ee1f64b37974> in <module>()
----> 1 test_ipythonprinting.test_ipythonprinting()

/home/moorepants/src/sympy/sympy/interactive/tests/test_ipythonprinting.pyc in test_ipythonprinting()
     29         assert app.user_ns['a2']['text/plain'] == "pi**2"
     30     else:
---> 31         assert app.user_ns['a'][0]['text/plain'] == "pi"
     32         assert app.user_ns['a2'][0]['text/plain'] == "pi**2"
     33 

AssertionError: 
> /home/moorepants/src/sympy/sympy/interactive/tests/test_ipythonprinting.py(31)test_ipythonprinting()
     30     else:
---> 31         assert app.user_ns['a'][0]['text/plain'] == "pi"
     32         assert app.user_ns['a2'][0]['text/plain'] == "pi**2"

ipdb> app.user_ns['a'][0]['text/plain']
u'\u03c0'

Seems the test passes on the first call but not on the second. Is that because init_printing has bee called on the first call to the test, but never reset?

Update: Notice that this isn't using the conda ipython.

moorepants · 2013-12-30T00:29:55Z

The tests pass on my machine for Python 3.3/IPython 0.13.2 but fail again on Python 2.7.5/IPython 1.1.0. It is some kind of unicode issue. I'm not familiar at all in the differences in strings/unicode from Python 2 to Python 3. I'll come back to this.

asmeurer · 2014-01-03T17:50:13Z

Can you paste the error here?

moorepants · 2014-01-03T19:19:43Z

Ok, tests now pass on:

Python 2.7.5 + IPython 1.1.0
Python 3.3.3 + IPython 1.1.0
Python 3.3.3 + IPython 0.13.2

Gonna merge based on the +1 from @asmeurer.

Should be ready to merge at this point.

Improvements to IPython printing: strings, floats, and ints.

asmeurer · 2014-01-09T22:52:40Z

Can you document any major changes (here and in other PRs) in the release notes?

moorepants · 2014-01-09T22:55:52Z

Yes, I'll do that.

Additional notes in doc string about line wrapping.

b5b0447

moorepants mentioned this pull request Dec 16, 2013

Mechanics Vectors and Dyadics print in LaTeX with init_printing() #2687

Merged

1 task

Added start of tests for print_builtin option.

b748fae

Added test that checks for LaTeX representations.

05361f7

Fixed tests for Python 3 unicode.

9c1bb7f

Tests pass on Python 2/3, IPython 0.13.2/0.1.1.

031c43f

moorepants added a commit that referenced this pull request Jan 3, 2014

Merge pull request #2683 from moorepants/ipython-printing

d906a9a

Improvements to IPython printing: strings, floats, and ints.

moorepants merged commit d906a9a into sympy:master Jan 3, 2014

moorepants mentioned this pull request Jan 3, 2014

init_printing does funny things to normal python dictionaries #2672

Closed

moorepants deleted the ipython-printing branch January 8, 2014 22:57

Improvements to IPython printing: strings, floats, and ints. #2683

Improvements to IPython printing: strings, floats, and ints. #2683

Conversation

moorepants commented Dec 15, 2013

moorepants commented Dec 15, 2013

moorepants commented Dec 16, 2013

asmeurer commented Dec 16, 2013

asmeurer commented Dec 16, 2013

moorepants commented Dec 16, 2013

moorepants commented Dec 16, 2013

asmeurer commented Dec 16, 2013

asmeurer commented Dec 16, 2013

moorepants commented Dec 16, 2013

moorepants commented Dec 16, 2013

asmeurer commented Dec 16, 2013

moorepants commented Dec 16, 2013

asmeurer commented Dec 16, 2013

moorepants commented Dec 16, 2013

asmeurer commented Dec 29, 2013

moorepants commented Dec 29, 2013

moorepants commented Dec 29, 2013

asmeurer commented Dec 29, 2013

moorepants commented Dec 29, 2013

moorepants commented Dec 29, 2013

asmeurer commented Dec 29, 2013

moorepants commented Dec 29, 2013

moorepants commented Dec 29, 2013

moorepants commented Dec 29, 2013

moorepants commented Dec 29, 2013

moorepants commented Dec 29, 2013

asmeurer commented Dec 29, 2013

moorepants commented Dec 30, 2013

moorepants commented Dec 30, 2013

moorepants commented Dec 30, 2013

moorepants commented Dec 30, 2013

moorepants commented Dec 30, 2013

asmeurer commented Jan 3, 2014

moorepants commented Jan 3, 2014

asmeurer commented Jan 9, 2014

moorepants commented Jan 9, 2014