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

Merge pull request from rkern/fix-hyperobject-pprint...

Merge pull request from rkern/fix-hyperobject-pprint BUG: Fix pretty-printing for overzealous objects Some classes use __getattr__ to automatically create requested attributes. The recent trend of LINQ-like query objects is what I ran into. This confuses the pretty-printing machinery that tests for _repr_pretty_. This pull request fixes many of these problems by simply testing if the _repr_pretty_ attribute is callable. This may still be confused by certain mocking frameworks, but it's a good start.

Robert Kern - - Load All Authors

File last commit:

r6268:1f5362dc


                r6272:873e3647

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