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

Fix example usage of BaseFormatter.for_type_by_name....

Fix example usage of BaseFormatter.for_type_by_name. I propose a small documentation fix for this excellent feature of IPython. The current example doesn't work because the type module and type name are lumped into one string. They must be given as separate strings. See docstring: ``` Signature: BaseFormatter.for_type_by_name(self, type_module, type_name, func=None) ``` For extra clarity, I have added a submodule to this made-up example module so that the pattern is clear.

Matthias BUSSONNIER - - Load All Authors

File last commit:

r5390:c82649ea


                r25165:5da2c265

Download file

             test_page.py
        
                    20 lines
            
             | 772 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / tests / test_page.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #-----------------------------------------------------------------------------

      #  Copyright (C) 2010-2011 The IPython Development Team.

      #

      #  Distributed under the terms of the BSD License.

      #

      #  The full license is in the file COPYING.txt, distributed with this software.

      #-----------------------------------------------------------------------------

      import io

      # N.B. For the test suite, page.page is overridden (see IPython.testing.globalipapp)

      from IPython.core import page

      def test_detect_screen_size():

          """Simple smoketest for page._detect_screen_size."""

          try:

              page._detect_screen_size(True, 25)

          except (TypeError, io.UnsupportedOperation):

              # This can happen in the test suite, because stdout may not have a

              # fileno.

              pass

	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

				#-----------------------------------------------------------------------------
				# Copyright (C) 2010-2011 The IPython Development Team.
				#
				# Distributed under the terms of the BSD License.
				#
				# The full license is in the file COPYING.txt, distributed with this software.
				#-----------------------------------------------------------------------------
				import io

				# N.B. For the test suite, page.page is overridden (see IPython.testing.globalipapp)
				from IPython.core import page

				def test_detect_screen_size():
				"""Simple smoketest for page._detect_screen_size."""
				try:
				page._detect_screen_size(True, 25)
				except (TypeError, io.UnsupportedOperation):
				# This can happen in the test suite, because stdout may not have a
				# fileno.
				pass