upstream/ipython Files · IPython/core/fakemodule.py

Multiple improvements to tab completion....

Multiple improvements to tab completion. I refactored the API quite a bit, to retain readline compatibility but make it more independent of readline. There's still more to do in cleaning up our init_readline() method, but now the completer objects have separate rlcomplete() and complete() methods. The former uses the quirky readline API with a state flag, while the latter is stateless, takes only text information, and is more suitable for GUIs and other frontends to call programatically. Made other minor fixes to ensure the test suite passes in full. While all this code is a bit messy, we're getting in the direction of the APIs we need in the long run.

Brian Granger - - Load All Authors

File last commit:

r2020:f3a106b5


                r2839:8cff4913

Download file

             fakemodule.py
        
                    66 lines
            
             | 2.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / fakemodule.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

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

      """

      Class which mimics a module.

      Needed to allow pickle to correctly resolve namespaces during IPython

      sessions.

      """

      #*****************************************************************************

      #       Copyright (C) 2002-2004 Fernando Perez. <fperez@colorado.edu>

      #

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

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

      #*****************************************************************************

      import types

      def init_fakemod_dict(fm,adict=None):

          """Initialize a FakeModule instance __dict__.

          Kept as a standalone function and not a method so the FakeModule API can

          remain basically empty.

          This should be considered for private IPython use, used in managing

          namespaces for %run.

          Parameters

          ----------

          fm : FakeModule instance

          adict : dict, optional

          """

          dct = {}

          # It seems pydoc (and perhaps others) needs any module instance to

          # implement a __nonzero__ method, so we add it if missing:

          dct.setdefault('__nonzero__',lambda : True)

          dct.setdefault('__file__',__file__)

          if adict is not None:

              dct.update(adict)

          # Hard assignment of the object's __dict__.  This is nasty but deliberate.

          fm.__dict__.clear()

          fm.__dict__.update(dct)

      class FakeModule(types.ModuleType):

          """Simple class with attribute access to fake a module.

          This is not meant to replace a module, but to allow inserting a fake

          module in sys.modules so that systems which rely on run-time module

          importing (like shelve and pickle) work correctly in interactive IPython

          sessions.

          Do NOT use this code for anything other than this IPython private hack."""

          def __init__(self,adict=None):

              # tmp to force __dict__ instance creation, else self.__dict__ fails

              self.__iptmp = None

              # cleanup our temp trick

              del self.__iptmp

              # Now, initialize the actual data in the instance dict.

              init_fakemod_dict(self,adict)

	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 --
				"""
				Class which mimics a module.

				Needed to allow pickle to correctly resolve namespaces during IPython
				sessions.
				"""

				#*****************************************************************************
				# Copyright (C) 2002-2004 Fernando Perez. <fperez@colorado.edu>
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#*****************************************************************************

				import types

				def init_fakemod_dict(fm,adict=None):
				"""Initialize a FakeModule instance __dict__.

				Kept as a standalone function and not a method so the FakeModule API can
				remain basically empty.

				This should be considered for private IPython use, used in managing
				namespaces for %run.

				Parameters
				----------

				fm : FakeModule instance

				adict : dict, optional
				"""

				dct = {}
				# It seems pydoc (and perhaps others) needs any module instance to
				# implement a __nonzero__ method, so we add it if missing:
				dct.setdefault('__nonzero__',lambda : True)
				dct.setdefault('__file__',__file__)

				if adict is not None:
				dct.update(adict)

				# Hard assignment of the object's __dict__. This is nasty but deliberate.
				fm.__dict__.clear()
				fm.__dict__.update(dct)


				class FakeModule(types.ModuleType):
				"""Simple class with attribute access to fake a module.

				This is not meant to replace a module, but to allow inserting a fake
				module in sys.modules so that systems which rely on run-time module
				importing (like shelve and pickle) work correctly in interactive IPython
				sessions.

				Do NOT use this code for anything other than this IPython private hack."""

				def __init__(self,adict=None):

				# tmp to force __dict__ instance creation, else self.__dict__ fails
				self.__iptmp = None
				# cleanup our temp trick
				del self.__iptmp
				# Now, initialize the actual data in the instance dict.
				init_fakemod_dict(self,adict)