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

Hide dynamically defined metaclass base from Sphinx....

Hide dynamically defined metaclass base from Sphinx. The inheritance diagram extension in Sphinx 1.2 stores class references, which Sphinx then tries to pickle. This chokes on our dynamically defined base classes from the with_metaclass function. Starting the name with an underscore makes Sphinx ignore the class. (Bug obscurity/fix simplicity) ratio is high.

Matthias BUSSONNIER - - Load All Authors

File last commit:

r5390:c82649ea


                r13584:cbe18349

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