upstream/ipython Files · IPython/core/tests/test_formatters.py

Merge pull request from fperez/cellmagics...

Merge pull request from fperez/cellmagics Refactoring of the magics system and implementation of cell magics. This PR completely refactors the magic system, finally moving the magic objects to standalone, independent objects instead of being the mixin class we'd had since the beginning of IPython. Now, a separate base class is provided in IPython.core.magic.Magics that users can subclass to create their own magics. Decorators are also provided to create magics from simple functions without the need for object orientation. All builtin magics now exist in a few subclasses that group together related functionality, and the new IPython.core.magics package has been created to organize this into smaller files. This cleanup was the last major piece of deep refactoring needed from the original 2001 codebase. Secondly, this PR introduces a new type of magic function, prefixed with `%%` instead of `%`, which operates at the cell level. A cell magic receives two arguments: the line it is called on (like a line magic) and the body of the cell below it. Cell magics are most natural in the notebook, but they also work in the terminal and qt console, with the usual approach of using a blank line to signal cell termination. This PR closes , or IPEP 1, where the design had been discussed.

Robert Kern - - Load All Authors

File last commit:

r6268:1f5362dc


                r7011:61eb2ffe

Download file

             test_formatters.py
        
                    91 lines
            
             | 2.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / tests / test_formatters.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Robert Kern
    
ENH: Implement and test the default pretty formatter.

              r3209
            
      """Tests for the Formatters.

      """

        MinRK
    
add `float_precision` trait to PlainTextFormatter...

              r3350
            
      from math import pi

      try:

          import numpy

      except:

          numpy = None

        Robert Kern
    
ENH: Implement and test the default pretty formatter.

              r3209
            
      import nose.tools as nt

        MinRK
    
add `float_precision` trait to PlainTextFormatter...

              r3350
            
      from IPython.core.formatters import FormatterABC, PlainTextFormatter

        Robert Kern
    
BUG: Fix pretty-printing for overzealous objects that will return something non-callable for any requested attribute (thus confusing hasattr).

              r6268
            
      from IPython.lib import pretty

        Robert Kern
    
ENH: Implement and test the default pretty formatter.

              r3209
            
      class A(object):

          def __repr__(self):

              return 'A()'

      class B(A):

          def __repr__(self):

              return 'B()'

        Robert Kern
    
BUG: Fix pretty-printing for overzealous objects that will return something non-callable for any requested attribute (thus confusing hasattr).

              r6268
            
      class BadPretty(object):

          _repr_pretty_ = None

      class GoodPretty(object):

          def _repr_pretty_(self, pp, cycle):

              pp.text('foo')

          def __repr__(self):

              return 'GoodPretty()'

        Robert Kern
    
ENH: Implement and test the default pretty formatter.

              r3209
            
      def foo_printer(obj, pp, cycle):

          pp.text('foo')

      def test_pretty():

        MinRK
    
add `float_precision` trait to PlainTextFormatter...

              r3350
            
          f = PlainTextFormatter()

        Robert Kern
    
ENH: Implement and test the default pretty formatter.

              r3209
            
          f.for_type(A, foo_printer)

          nt.assert_equals(f(A()), 'foo')

          nt.assert_equals(f(B()), 'foo')

        Robert Kern
    
BUG: Fix pretty-printing for overzealous objects that will return something non-callable for any requested attribute (thus confusing hasattr).

              r6268
            
          nt.assert_equals(f(GoodPretty()), 'foo')

          # Just don't raise an exception for the following:

          f(BadPretty())

        Robert Kern
    
ENH: Implement and test the default pretty formatter.

              r3209
            
          f.pprint = False

          nt.assert_equals(f(A()), 'A()')

          nt.assert_equals(f(B()), 'B()')

        Robert Kern
    
BUG: Fix pretty-printing for overzealous objects that will return something non-callable for any requested attribute (thus confusing hasattr).

              r6268
            
          nt.assert_equals(f(GoodPretty()), 'GoodPretty()')

        Robert Kern
    
ENH: Implement and test the default pretty formatter.

              r3209
            
      def test_deferred():

        MinRK
    
add `float_precision` trait to PlainTextFormatter...

              r3350
            
          f = PlainTextFormatter()

      def test_precision():

          """test various values for float_precision."""

          f = PlainTextFormatter()

          nt.assert_equals(f(pi), repr(pi))

          f.float_precision = 0

          if numpy:

              po = numpy.get_printoptions()

              nt.assert_equals(po['precision'], 0)

          nt.assert_equals(f(pi), '3')

          f.float_precision = 2

          if numpy:

              po = numpy.get_printoptions()

              nt.assert_equals(po['precision'], 2)

          nt.assert_equals(f(pi), '3.14')

          f.float_precision = '%g'

          if numpy:

              po = numpy.get_printoptions()

              nt.assert_equals(po['precision'], 2)

          nt.assert_equals(f(pi), '3.14159')

          f.float_precision = '%e'

          nt.assert_equals(f(pi), '3.141593e+00')

          f.float_precision = ''

          if numpy:

              po = numpy.get_printoptions()

              nt.assert_equals(po['precision'], 8)

          nt.assert_equals(f(pi), repr(pi))

      def test_bad_precision():

          """test various invalid values for float_precision."""

          f = PlainTextFormatter()

          def set_fp(p):

              f.float_precision=p

          nt.assert_raises(ValueError, set_fp, '%')

          nt.assert_raises(ValueError, set_fp, '%.3f%i')

          nt.assert_raises(ValueError, set_fp, 'foo')

          nt.assert_raises(ValueError, set_fp, -1)

        Robert Kern
    
ENH: Implement and test the default pretty formatter.

              r3209

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Robert Kern ENH: Implement and test the default pretty formatter.	r3209	"""Tests for the Formatters.
		"""

MinRK add `float_precision` trait to PlainTextFormatter...	r3350	from math import pi

		try:
		import numpy
		except:
		numpy = None
Robert Kern ENH: Implement and test the default pretty formatter.	r3209	import nose.tools as nt

MinRK add `float_precision` trait to PlainTextFormatter...	r3350	from IPython.core.formatters import FormatterABC, PlainTextFormatter
Robert Kern BUG: Fix pretty-printing for overzealous objects that will return something non-callable for any requested attribute (thus confusing hasattr).	r6268	from IPython.lib import pretty
Robert Kern ENH: Implement and test the default pretty formatter.	r3209
		class A(object):
		def __repr__(self):
		return 'A()'

		class B(A):
		def __repr__(self):
		return 'B()'

Robert Kern BUG: Fix pretty-printing for overzealous objects that will return something non-callable for any requested attribute (thus confusing hasattr).	r6268	class BadPretty(object):
		_repr_pretty_ = None

		class GoodPretty(object):
		def _repr_pretty_(self, pp, cycle):
		pp.text('foo')

		def __repr__(self):
		return 'GoodPretty()'

Robert Kern ENH: Implement and test the default pretty formatter.	r3209	def foo_printer(obj, pp, cycle):
		pp.text('foo')

		def test_pretty():
MinRK add `float_precision` trait to PlainTextFormatter...	r3350	f = PlainTextFormatter()
Robert Kern ENH: Implement and test the default pretty formatter.	r3209	f.for_type(A, foo_printer)
		nt.assert_equals(f(A()), 'foo')
		nt.assert_equals(f(B()), 'foo')
Robert Kern BUG: Fix pretty-printing for overzealous objects that will return something non-callable for any requested attribute (thus confusing hasattr).	r6268	nt.assert_equals(f(GoodPretty()), 'foo')
		# Just don't raise an exception for the following:
		f(BadPretty())

Robert Kern ENH: Implement and test the default pretty formatter.	r3209	f.pprint = False
		nt.assert_equals(f(A()), 'A()')
		nt.assert_equals(f(B()), 'B()')
Robert Kern BUG: Fix pretty-printing for overzealous objects that will return something non-callable for any requested attribute (thus confusing hasattr).	r6268	nt.assert_equals(f(GoodPretty()), 'GoodPretty()')

Robert Kern ENH: Implement and test the default pretty formatter.	r3209
		def test_deferred():
MinRK add `float_precision` trait to PlainTextFormatter...	r3350	f = PlainTextFormatter()

		def test_precision():
		"""test various values for float_precision."""
		f = PlainTextFormatter()
		nt.assert_equals(f(pi), repr(pi))
		f.float_precision = 0
		if numpy:
		po = numpy.get_printoptions()
		nt.assert_equals(po['precision'], 0)
		nt.assert_equals(f(pi), '3')
		f.float_precision = 2
		if numpy:
		po = numpy.get_printoptions()
		nt.assert_equals(po['precision'], 2)
		nt.assert_equals(f(pi), '3.14')
		f.float_precision = '%g'
		if numpy:
		po = numpy.get_printoptions()
		nt.assert_equals(po['precision'], 2)
		nt.assert_equals(f(pi), '3.14159')
		f.float_precision = '%e'
		nt.assert_equals(f(pi), '3.141593e+00')
		f.float_precision = ''
		if numpy:
		po = numpy.get_printoptions()
		nt.assert_equals(po['precision'], 8)
		nt.assert_equals(f(pi), repr(pi))

		def test_bad_precision():
		"""test various invalid values for float_precision."""
		f = PlainTextFormatter()
		def set_fp(p):
		f.float_precision=p
		nt.assert_raises(ValueError, set_fp, '%')
		nt.assert_raises(ValueError, set_fp, '%.3f%i')
		nt.assert_raises(ValueError, set_fp, 'foo')
		nt.assert_raises(ValueError, set_fp, -1)

Robert Kern ENH: Implement and test the default pretty formatter.	r3209