upstream/ipython Files · IPython/utils/syspathcontext.py

Backport PR : Unicode content crashes the pager (console)...

Backport PR : Unicode content crashes the pager (console) We've run into an interesting bug in the astropy project. https://github.com/astropy/astropy/issues/600 When displaying a docstring that contains Unicode and is also long enough that it gets sent to the pager it fails since the docstring can't be sent to the pager as ascii. This crashes in the middle of sending content to the pager, so the shell ends up in an inconsistent state and stops echoing the keyboard etc. The fix (attached) is merely to encode the content sent to the pager in the same encoding as the terminal (`sys.stdout.encoding`). Strictly speaking, this isn't always the right thing to do, since the pager may be configured to expect a different encoding than the terminal, but that is sort of an irrational way to configure a machine... ;) For example, `less`, in the absence of any special environment variables to tell it otherwise, uses the standard `LC*` environment variables to determine what to do, which should be the same mechanism the terminal also uses by default. If anyone can suggest a better fix, I'm all for it. Perhaps it should be configurable, defaulting to `sys.stdout.encoding`?

Matthias BUSSONNIER - - Load All Authors

File last commit:

r5390:c82649ea


                r9853:7f9a133e

Download file

             syspathcontext.py
        
                    69 lines
            
             | 2.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / syspathcontext.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # encoding: utf-8

      """

      Context managers for adding things to sys.path temporarily.

      Authors:

      * Brian Granger

      """

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

      #  Copyright (C) 2008-2011  The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

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

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

      # Imports

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

      import sys

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

      # Code

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

      class appended_to_syspath(object):

          """A context for appending a directory to sys.path for a second."""

          def __init__(self, dir):

              self.dir = dir

          def __enter__(self):

              if self.dir not in sys.path:

                  sys.path.append(self.dir)

                  self.added = True

              else:

                  self.added = False

          def __exit__(self, type, value, traceback):

              if self.added:

                  try:

                      sys.path.remove(self.dir)

                  except ValueError:

                      pass

              # Returning False causes any exceptions to be re-raised.

              return False

      class prepended_to_syspath(object):

          """A context for prepending a directory to sys.path for a second."""

          def __init__(self, dir):

              self.dir = dir

          def __enter__(self):

              if self.dir not in sys.path:

                  sys.path.insert(0,self.dir)

                  self.added = True

              else:

                  self.added = False

          def __exit__(self, type, value, traceback):

              if self.added:

                  try:

                      sys.path.remove(self.dir)

                  except ValueError:

                      pass

              # Returning False causes any exceptions to be re-raised.

              return False

	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

				# encoding: utf-8
				"""
				Context managers for adding things to sys.path temporarily.

				Authors:

				* Brian Granger
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2008-2011 The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

				import sys

				#-----------------------------------------------------------------------------
				# Code
				#-----------------------------------------------------------------------------

				class appended_to_syspath(object):
				"""A context for appending a directory to sys.path for a second."""

				def __init__(self, dir):
				self.dir = dir

				def __enter__(self):
				if self.dir not in sys.path:
				sys.path.append(self.dir)
				self.added = True
				else:
				self.added = False

				def __exit__(self, type, value, traceback):
				if self.added:
				try:
				sys.path.remove(self.dir)
				except ValueError:
				pass
				# Returning False causes any exceptions to be re-raised.
				return False

				class prepended_to_syspath(object):
				"""A context for prepending a directory to sys.path for a second."""

				def __init__(self, dir):
				self.dir = dir

				def __enter__(self):
				if self.dir not in sys.path:
				sys.path.insert(0,self.dir)
				self.added = True
				else:
				self.added = False

				def __exit__(self, type, value, traceback):
				if self.added:
				try:
				sys.path.remove(self.dir)
				except ValueError:
				pass
				# Returning False causes any exceptions to be re-raised.
				return False