upstream/ipython Files · IPython/core/tests/test_logger.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.

Fernando Perez - - Load All Authors

File last commit:

r7115:a8a64ebc


                r25165:5da2c265

Download file

             test_logger.py
        
                    32 lines
            
             | 917 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / tests / test_logger.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # -*- coding: utf-8 -*-

      """Test IPython.core.logger"""

      import os.path

      import nose.tools as nt

      from IPython.utils.tempdir import TemporaryDirectory

      _ip = get_ipython()

      def test_logstart_inaccessible_file():

          try:

              _ip.logger.logstart(logfname="/")   # Opening that filename will fail.

          except IOError:

              pass

          else:

              nt.assert_true(False)           # The try block should never pass.

          try:

              _ip.run_cell("a=1")                 # Check it doesn't try to log this

          finally:

              _ip.logger.log_active = False  # If this fails, don't let later tests fail

      def test_logstart_unicode():

          with TemporaryDirectory() as tdir:

              logfname = os.path.join(tdir, "test_unicode.log")

              _ip.run_cell("'abc€'")

              try:

                  _ip.magic("logstart -to %s" % logfname)

                  _ip.run_cell("'abc€'")

              finally:

                  _ip.logger.logstop()

	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

				# -- coding: utf-8 --
				"""Test IPython.core.logger"""

				import os.path

				import nose.tools as nt
				from IPython.utils.tempdir import TemporaryDirectory

				_ip = get_ipython()

				def test_logstart_inaccessible_file():
				try:
				_ip.logger.logstart(logfname="/") # Opening that filename will fail.
				except IOError:
				pass
				else:
				nt.assert_true(False) # The try block should never pass.

				try:
				_ip.run_cell("a=1") # Check it doesn't try to log this
				finally:
				_ip.logger.log_active = False # If this fails, don't let later tests fail

				def test_logstart_unicode():
				with TemporaryDirectory() as tdir:
				logfname = os.path.join(tdir, "test_unicode.log")
				_ip.run_cell("'abc€'")
				try:
				_ip.magic("logstart -to %s" % logfname)
				_ip.run_cell("'abc€'")
				finally:
				_ip.logger.logstop()