_instance = None

ast_transformers = List([], help=

"""

A list of ast.NodeTransformer subclass instances, which will be applied

to user input before code is run.

"""

).tag(config=True)

autocall = Enum((0,1,2), default_value=0, help=

"""

Make IPython automatically call any callable object even if you didn't

type explicit parentheses. For example, 'str 43' becomes 'str(43)'

automatically. The value can be '0' to disable the feature, '1' for

'smart' autocall, where it is not applied if there are no more

arguments on the line, and '2' for 'full' autocall, where all callable

objects are automatically called (even if no arguments are present).

"""

).tag(config=True)

# TODO: remove all autoindent logic and put into frontends.

# We can't do this yet because even runlines uses the autoindent.

autoindent = Bool(True, help=

"""

Autoindent IPython code entered interactively.

"""

).tag(config=True)

automagic = Bool(True, help=

"""

Enable magic commands to be called without the leading %.

"""

).tag(config=True)

banner1 = Unicode(default_banner,

help="""The part of the banner to be printed before the profile"""

).tag(config=True)

banner2 = Unicode('',

help="""The part of the banner to be printed after the profile"""

).tag(config=True)

cache_size = Integer(1000, help=

"""

Set the size of the output cache. The default is 1000, you can

change it permanently in your config file. Setting it to 0 completely

disables the caching system, and the minimum value accepted is 3 (if

you provide a value less than 3, it is reset to 0 and a warning is

issued). This limit is defined because otherwise you'll spend more

time re-flushing a too small cache than working

"""

).tag(config=True)

color_info = Bool(True, help=

"""

Use colors for displaying information about objects. Because this

information is passed through a pager (like 'less'), and some pagers

get confused with color codes, this capability can be turned off.

"""

).tag(config=True)

colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'),

default_value='Neutral',

help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)."

).tag(config=True)

debug = Bool(False).tag(config=True)

disable_failing_post_execute = Bool(False,

help="Don't call post-execute functions that have failed in the past."

).tag(config=True)

display_formatter = Instance(DisplayFormatter, allow_none=True)

displayhook_class = Type(DisplayHook)

display_pub_class = Type(DisplayPublisher)

sphinxify_docstring = Bool(False, help=

"""

Enables rich html representation of docstrings. (This requires the

docrepr module).

""").tag(config=True)

@observe("sphinxify_docstring")

def _sphinxify_docstring_changed(self, change):

if change['new']:

warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning)

enable_html_pager = Bool(False, help=

"""

(Provisional API) enables html representation in mime bundles sent

to pagers.

""").tag(config=True)

@observe("enable_html_pager")

def _enable_html_pager_changed(self, change):

if change['new']:

warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning)

data_pub_class = None

exit_now = Bool(False)

exiter = Instance(ExitAutocall)

@default('exiter')

def _exiter_default(self):

return ExitAutocall(self)

# Monotonically increasing execution counter

execution_count = Integer(1)

filename = Unicode("<ipython console>")

ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__

# Input splitter, to transform input line by line and detect when a block

# is ready to be executed.

input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',

(), {'line_input_checker': True})

# This InputSplitter instance is used to transform completed cells before

# running them. It allows cell magics to contain blank lines.

input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter',

(), {'line_input_checker': False})

logstart = Bool(False, help=

"""

Start logging to the default log file in overwrite mode.

Use `logappend` to specify a log file to **append** logs to.

"""

).tag(config=True)

logfile = Unicode('', help=

"""

The name of the logfile to use.

"""

).tag(config=True)

logappend = Unicode('', help=

"""

Start logging to the given file in append mode.

Use `logfile` to specify a log file to **overwrite** logs to.

"""

).tag(config=True)

object_info_string_level = Enum((0,1,2), default_value=0,

).tag(config=True)

pdb = Bool(False, help=

"""

Automatically call the pdb debugger after every exception.

"""

).tag(config=True)

display_page = Bool(False,

help="""If True, anything that would be passed to the pager

will be displayed as regular output instead."""

).tag(config=True)

# deprecated prompt traits:

prompt_in1 = Unicode('In [\\#]: ',

help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly."

).tag(config=True)

prompt_in2 = Unicode(' .\\D.: ',

help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly."

).tag(config=True)

prompt_out = Unicode('Out[\\#]: ',

help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly."

).tag(config=True)

prompts_pad_left = Bool(True,

help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly."

).tag(config=True)

@observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left')

def _prompt_trait_changed(self, change):

name = change['name']

warn("InteractiveShell.{name} is deprecated since IPython 4.0"

" and ignored since 5.0, set TerminalInteractiveShell.prompts"

" object directly.".format(name=name))

# protect against weird cases where self.config may not exist:

show_rewritten_input = Bool(True,

help="Show rewritten input, e.g. for autocall."

).tag(config=True)

quiet = Bool(False).tag(config=True)

history_length = Integer(10000,

help='Total length of command history'

).tag(config=True)

history_load_length = Integer(1000, help=

"""

The number of saved history entries to be loaded

into the history buffer at startup.

"""

).tag(config=True)

ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'],

default_value='last_expr',

help="""

'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying

which nodes should be run interactively (displaying output from expressions).

"""

).tag(config=True)

# TODO: this part of prompt management should be moved to the frontends.

# Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'

separate_in = SeparateUnicode('\n').tag(config=True)

separate_out = SeparateUnicode('').tag(config=True)

separate_out2 = SeparateUnicode('').tag(config=True)

wildcards_case_sensitive = Bool(True).tag(config=True)

xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),

default_value='Context',

help="Switch modes for the IPython exception handlers."

).tag(config=True)

# Subcomponents of InteractiveShell

alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True)

prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True)

builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True)

display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True)

extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True)

payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True)

history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True)

magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True)

profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True)

@property

def profile(self):

if self.profile_dir is not None:

name = os.path.basename(self.profile_dir.location)

return name.replace('profile_','')

# Private interface

_post_execute = Dict()

# Tracks any GUI loop loaded for pylab

pylab_gui_select = None

last_execution_succeeded = Bool(True, help='Did last executed command succeeded')

last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True)

def __init__(self, ipython_dir=None, profile_dir=None,

user_module=None, user_ns=None,

custom_exceptions=((), None), **kwargs):

# This is where traits with a config_key argument are updated

# from the values on config.

super(InteractiveShell, self).__init__(**kwargs)

if 'PromptManager' in self.config:

warn('As of IPython 5.0 `PromptManager` config will have no effect'

' and has been replaced by TerminalInteractiveShell.prompts_class')

self.configurables = [self]

# These are relatively independent and stateless

self.init_ipython_dir(ipython_dir)

self.init_profile_dir(profile_dir)

self.init_instance_attrs()

self.init_environment()

# Check if we're in a virtualenv, and set up sys.path.

self.init_virtualenv()

# Create namespaces (user_ns, user_global_ns, etc.)

self.init_create_namespaces(user_module, user_ns)

# This has to be done after init_create_namespaces because it uses

# something in self.user_ns, but before init_sys_modules, which

# is the first thing to modify sys.

# TODO: When we override sys.stdout and sys.stderr before this class

# is created, we are saving the overridden ones here. Not sure if this

# is what we want to do.

self.save_sys_module_state()

self.init_sys_modules()

# While we're trying to have each part of the code directly access what

# it needs without keeping redundant references to objects, we have too

# much legacy code that expects ip.db to exist.

self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))

self.init_history()

self.init_encoding()

self.init_prefilter()

self.init_syntax_highlighting()

self.init_hooks()

self.init_events()

self.init_pushd_popd_magic()

self.init_user_ns()

self.init_logger()

self.init_builtins()

# The following was in post_config_initialization

self.init_inspector()

self.raw_input_original = input

self.init_completer()

# TODO: init_io() needs to happen before init_traceback handlers

# because the traceback handlers hardcode the stdout/stderr streams.

# This logic in in debugger.Pdb and should eventually be changed.

self.init_io()

self.init_traceback_handlers(custom_exceptions)

self.init_prompts()

self.init_display_formatter()

self.init_display_pub()

self.init_data_pub()

self.init_displayhook()

self.init_magics()

self.init_alias()

self.init_logstart()

self.init_pdb()

self.init_extension_manager()

self.init_payload()

self.init_deprecation_warnings()

self.hooks.late_startup_hook()

self.events.trigger('shell_initialized', self)

atexit.register(self.atexit_operations)

def get_ipython(self):

"""Return the currently running IPython instance."""

return self

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

# Trait changed handlers

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

@observe('ipython_dir')

def _ipython_dir_changed(self, change):

ensure_dir_exists(change['new'])

def set_autoindent(self,value=None):

"""Set the autoindent flag.

If called with no arguments, it acts as a toggle."""

if value is None:

self.autoindent = not self.autoindent

else:

self.autoindent = value

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

# init_* methods called by __init__

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

def init_ipython_dir(self, ipython_dir):

if ipython_dir is not None:

self.ipython_dir = ipython_dir

return

self.ipython_dir = get_ipython_dir()

def init_profile_dir(self, profile_dir):

if profile_dir is not None:

self.profile_dir = profile_dir

return

self.profile_dir =\

ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')

def init_instance_attrs(self):

self.more = False

# command compiler

self.compile = CachingCompiler()

# Make an empty namespace, which extension writers can rely on both

# existing and NEVER being used by ipython itself. This gives them a

# convenient location for storing additional information and state

# their extensions may require, without fear of collisions with other

# ipython names that may develop later.

self.meta = Struct()

# Temporary files used for various purposes. Deleted at exit.

self.tempfiles = []

self.tempdirs = []

# keep track of where we started running (mainly for crash post-mortem)

# This is not being used anywhere currently.

self.starting_dir = os.getcwd()

# Indentation management

self.indent_current_nsp = 0

# Dict to track post-execution functions that have been registered

self._post_execute = {}

def init_environment(self):

"""Any changes we need to make to the user's environment."""

pass

def init_encoding(self):

# Get system encoding at startup time. Certain terminals (like Emacs

# under Win32 have it set to None, and we need to have a known valid

# encoding to use in the raw_input() method

try:

self.stdin_encoding = sys.stdin.encoding or 'ascii'

except AttributeError:

self.stdin_encoding = 'ascii'

@observe('colors')

def init_syntax_highlighting(self, changes=None):

# Python source parser/formatter for syntax highlighting

pyformat = PyColorize.Parser(style=self.colors, parent=self).format

self.pycolorize = lambda src: pyformat(src,'str')

def refresh_style(self):

# No-op here, used in subclass

pass

def init_pushd_popd_magic(self):

# for pushd/popd management

self.home_dir = get_home_dir()

self.dir_stack = []

def init_logger(self):

self.logger = Logger(self.home_dir, logfname='ipython_log.py',

logmode='rotate')

def init_logstart(self):

"""Initialize logging in case it was requested at the command line.

"""

if self.logappend:

self.magic('logstart %s append' % self.logappend)

elif self.logfile:

self.magic('logstart %s' % self.logfile)

elif self.logstart:

self.magic('logstart')

def init_deprecation_warnings(self):

"""

register default filter for deprecation warning.

This will allow deprecation warning of function used interactively to show

warning to users, and still hide deprecation warning from libraries import.

"""

warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__"))

def init_builtins(self):

# A single, static flag that we set to True. Its presence indicates

# that an IPython shell has been created, and we make no attempts at

# removing on exit or representing the existence of more than one

# IPython at a time.

builtin_mod.__dict__['__IPYTHON__'] = True

builtin_mod.__dict__['display'] = display

self.builtin_trap = BuiltinTrap(shell=self)

@observe('colors')

def init_inspector(self, changes=None):

# Object inspector

self.inspector = oinspect.Inspector(oinspect.InspectColors,

PyColorize.ANSICodeColors,

self.colors,

self.object_info_string_level)

def init_io(self):

# This will just use sys.stdout and sys.stderr. If you want to

# override sys.stdout and sys.stderr themselves, you need to do that

# *before* instantiating this class, because io holds onto

# references to the underlying streams.

# io.std* are deprecated, but don't show our own deprecation warnings

# during initialization of the deprecated API.

with warnings.catch_warnings():

warnings.simplefilter('ignore', DeprecationWarning)

io.stdout = io.IOStream(sys.stdout)

io.stderr = io.IOStream(sys.stderr)

def init_prompts(self):

# Set system prompts, so that scripts can decide if they are running

# interactively.

sys.ps1 = 'In : '

sys.ps2 = '...: '

sys.ps3 = 'Out: '

def init_display_formatter(self):

self.display_formatter = DisplayFormatter(parent=self)

self.configurables.append(self.display_formatter)

def init_display_pub(self):

self.display_pub = self.display_pub_class(parent=self)

self.configurables.append(self.display_pub)

def init_data_pub(self):

if not self.data_pub_class:

self.data_pub = None

return

self.data_pub = self.data_pub_class(parent=self)

self.configurables.append(self.data_pub)

def init_displayhook(self):

# Initialize displayhook, set in/out prompts and printing system

self.displayhook = self.displayhook_class(

parent=self,

shell=self,

cache_size=self.cache_size,

)

self.configurables.append(self.displayhook)

# This is a context manager that installs/revmoes the displayhook at

# the appropriate time.

self.display_trap = DisplayTrap(hook=self.displayhook)

def init_virtualenv(self):

"""Add a virtualenv to sys.path so the user can import modules from it.

This isn't perfect: it doesn't use the Python interpreter with which the

virtualenv was built, and it ignores the --no-site-packages option. A

warning will appear suggesting the user installs IPython in the

virtualenv, but for many cases, it probably works well enough.

Adapted from code snippets online.

http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv

"""

if 'VIRTUAL_ENV' not in os.environ:

# Not in a virtualenv

return

p = os.path.normcase(sys.executable)

p_venv = os.path.normcase(os.environ['VIRTUAL_ENV'])

# executable path should end like /bin/python or \\scripts\\python.exe

p_exe_up2 = os.path.dirname(os.path.dirname(p))

if p_exe_up2 and os.path.samefile(p_exe_up2, p_venv):

# Our exe is inside the virtualenv, don't need to do anything.

return

# fallback venv detection:

# stdlib venv may symlink sys.executable, so we can't use realpath.

# but others can symlink *to* the venv Python, so we can't just use sys.executable.

# So we just check every item in the symlink tree (generally <= 3)

paths = [p]

while os.path.islink(p):

p = os.path.normcase(os.path.join(os.path.dirname(p), os.readlink(p)))

paths.append(p)

# In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible

if p_venv.startswith('\\cygdrive'):

p_venv = p_venv[11:]

elif len(p_venv) >= 2 and p_venv[1] == ':':

p_venv = p_venv[2:]

if any(p_venv in p for p in paths):

# Running properly in the virtualenv, don't need to do anything

return

warn("Attempting to work in a virtualenv. If you encounter problems, please "

"install IPython inside the virtualenv.")

if sys.platform == "win32":

virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages')

else:

virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib',

'python%d.%d' % sys.version_info[:2], 'site-packages')

import site

sys.path.insert(0, virtual_env)

site.addsitedir(virtual_env)

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

# Things related to injections into the sys module

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

def save_sys_module_state(self):

"""Save the state of hooks in the sys module.

This has to be called after self.user_module is created.

"""

self._orig_sys_module_state = {'stdin': sys.stdin,

'stdout': sys.stdout,

'stderr': sys.stderr,

'excepthook': sys.excepthook}

self._orig_sys_modules_main_name = self.user_module.__name__

self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__)

def restore_sys_module_state(self):

"""Restore the state of the sys module."""

try:

for k, v in self._orig_sys_module_state.items():

setattr(sys, k, v)

except AttributeError:

pass

# Reset what what done in self.init_sys_modules

if self._orig_sys_modules_main_mod is not None:

sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod

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

# Things related to the banner

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

@property

def banner(self):

banner = self.banner1

if self.profile and self.profile != 'default':

banner += '\nIPython profile: %s\n' % self.profile

if self.banner2:

banner += '\n' + self.banner2

return banner

def show_banner(self, banner=None):

if banner is None:

banner = self.banner

sys.stdout.write(banner)

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

# Things related to hooks

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

def init_hooks(self):

# hooks holds pointers used for user-side customizations

self.hooks = Struct()

self.strdispatchers = {}

# Set all default hooks, defined in the IPython.hooks module.

hooks = IPython.core.hooks

for hook_name in hooks.__all__:

# default hooks have priority 100, i.e. low; user hooks should have

# 0-100 priority

self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False)

if self.display_page:

self.set_hook('show_in_pager', page.as_hook(page.display_page), 90)

def set_hook(self,name,hook, priority=50, str_key=None, re_key=None,

_warn_deprecated=True):

"""set_hook(name,hook) -> sets an internal IPython hook.

IPython exposes some of its internal API as user-modifiable hooks. By

adding your function to one of these hooks, you can modify IPython's

behavior to call at runtime your own routines."""

# At some point in the future, this should validate the hook before it

# accepts it. Probably at least check that the hook takes the number

# of args it's supposed to.

f = types.MethodType(hook,self)

# check if the hook is for strdispatcher first

if str_key is not None:

sdp = self.strdispatchers.get(name, StrDispatch())

sdp.add_s(str_key, f, priority )

self.strdispatchers[name] = sdp

return

if re_key is not None:

sdp = self.strdispatchers.get(name, StrDispatch())

sdp.add_re(re.compile(re_key), f, priority )

self.strdispatchers[name] = sdp

return

dp = getattr(self.hooks, name, None)

if name not in IPython.core.hooks.__all__:

print("Warning! Hook '%s' is not one of %s" % \

(name, IPython.core.hooks.__all__ ))

if _warn_deprecated and (name in IPython.core.hooks.deprecated):

alternative = IPython.core.hooks.deprecated[name]

warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2)

if not dp:

dp = IPython.core.hooks.CommandChainDispatcher()

try:

dp.add(f,priority)

except AttributeError:

# it was not commandchain, plain old func - replace

dp = f

setattr(self.hooks,name, dp)

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

# Things related to events

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

def init_events(self):

self.events = EventManager(self, available_events)

self.events.register("pre_execute", self._clear_warning_registry)

def register_post_execute(self, func):

"""DEPRECATED: Use ip.events.register('post_run_cell', func)

Register a function for calling after code execution.

"""

warn("ip.register_post_execute is deprecated, use "

"ip.events.register('post_run_cell', func) instead.", stacklevel=2)

self.events.register('post_run_cell', func)

def _clear_warning_registry(self):

# clear the warning registry, so that different code blocks with

# overlapping line number ranges don't cause spurious suppression of

# warnings (see gh-6611 for details)

if "__warningregistry__" in self.user_global_ns:

del self.user_global_ns["__warningregistry__"]

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

# Things related to the "main" module

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

def new_main_mod(self, filename, modname):

"""Return a new 'main' module object for user code execution.

``filename`` should be the path of the script which will be run in the

module. Requests with the same filename will get the same module, with

its namespace cleared.

``modname`` should be the module name - normally either '__main__' or

the basename of the file without the extension.

When scripts are executed via %run, we must keep a reference to their

__main__ module around so that Python doesn't

clear it, rendering references to module globals useless.

This method keeps said reference in a private dict, keyed by the

absolute path of the script. This way, for multiple executions of the

same script we only keep one copy of the namespace (the last one),

thus preventing memory leaks from old references while allowing the

objects from the last execution to be accessible.

"""

filename = os.path.abspath(filename)

try:

main_mod = self._main_mod_cache[filename]

except KeyError:

main_mod = self._main_mod_cache[filename] = types.ModuleType(

modname,

doc="Module created for script run in IPython")

else:

main_mod.__dict__.clear()

main_mod.__name__ = modname

main_mod.__file__ = filename

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

# implement a __nonzero__ method

main_mod.__nonzero__ = lambda : True

return main_mod

def clear_main_mod_cache(self):

"""Clear the cache of main modules.

Mainly for use by utilities like %reset.

Examples

--------

In [15]: import IPython

In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython')

In [17]: len(_ip._main_mod_cache) > 0

Out[17]: True

In [18]: _ip.clear_main_mod_cache()

In [19]: len(_ip._main_mod_cache) == 0

Out[19]: True

"""

self._main_mod_cache.clear()

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

# Things related to debugging

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

def init_pdb(self):

# Set calling of pdb on exceptions

# self.call_pdb is a property

self.call_pdb = self.pdb

def _get_call_pdb(self):

return self._call_pdb

def _set_call_pdb(self,val):

if val not in (0,1,False,True):

raise ValueError('new call_pdb value must be boolean')

# store value in instance

self._call_pdb = val

# notify the actual exception handlers

self.InteractiveTB.call_pdb = val

call_pdb = property(_get_call_pdb,_set_call_pdb,None,

'Control auto-activation of pdb at exceptions')

def debugger(self,force=False):

"""Call the pdb debugger.

Keywords:

- force(False): by default, this routine checks the instance call_pdb

flag and does not actually invoke the debugger if the flag is false.

The 'force' option forces the debugger to activate even if the flag

is false.

"""

if not (force or self.call_pdb):

return

if not hasattr(sys,'last_traceback'):

error('No traceback has been produced, nothing to debug.')

return

self.InteractiveTB.debugger(force=True)

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

# Things related to IPython's various namespaces

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

default_user_namespaces = True

def init_create_namespaces(self, user_module=None, user_ns=None):

# Create the namespace where the user will operate. user_ns is

# normally the only one used, and it is passed to the exec calls as

# the locals argument. But we do carry a user_global_ns namespace

# given as the exec 'globals' argument, This is useful in embedding

# situations where the ipython shell opens in a context where the

# distinction between locals and globals is meaningful. For

# non-embedded contexts, it is just the same object as the user_ns dict.

# FIXME. For some strange reason, __builtins__ is showing up at user

# level as a dict instead of a module. This is a manual fix, but I

# should really track down where the problem is coming from. Alex

# Schmolck reported this problem first.

# A useful post by Alex Martelli on this topic:

# Re: inconsistent value from __builtins__

# Von: Alex Martelli <aleaxit@yahoo.com>

# Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends

# Gruppen: comp.lang.python

# Michael Hohn <hohn@hooknose.lbl.gov> wrote:

# > >>> print type(builtin_check.get_global_binding('__builtins__'))

# > <type 'dict'>

# > >>> print type(__builtins__)

# > <type 'module'>

# > Is this difference in return value intentional?

# Well, it's documented that '__builtins__' can be either a dictionary

# or a module, and it's been that way for a long time. Whether it's

# intentional (or sensible), I don't know. In any case, the idea is

# that if you need to access the built-in namespace directly, you

# should start with "import __builtin__" (note, no 's') which will

# definitely give you a module. Yeah, it's somewhat confusing:-(.

# These routines return a properly built module and dict as needed by

# the rest of the code, and can also be used by extension writers to

# generate properly initialized namespaces.

if (user_ns is not None) or (user_module is not None):

self.default_user_namespaces = False

self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)

# A record of hidden variables we have added to the user namespace, so

# we can list later only variables defined in actual interactive use.

self.user_ns_hidden = {}

# Now that FakeModule produces a real module, we've run into a nasty

# problem: after script execution (via %run), the module where the user

# code ran is deleted. Now that this object is a true module (needed

# so doctest and other tools work correctly), the Python module

# teardown mechanism runs over it, and sets to None every variable

# present in that module. Top-level references to objects from the

# script survive, because the user_ns is updated with them. However,

# calling functions defined in the script that use other things from

# the script will fail, because the function's closure had references

# to the original objects, which are now all None. So we must protect

# these modules from deletion by keeping a cache.

#

# To avoid keeping stale modules around (we only need the one from the

# last run), we use a dict keyed with the full path to the script, so

# only the last version of the module is held in the cache. Note,

# however, that we must cache the module *namespace contents* (their

# __dict__). Because if we try to cache the actual modules, old ones

# (uncached) could be destroyed while still holding references (such as

# those held by GUI objects that tend to be long-lived)>

#

# The %reset command will flush this cache. See the cache_main_mod()

# and clear_main_mod_cache() methods for details on use.

# This is the cache used for 'main' namespaces

self._main_mod_cache = {}

# A table holding all the namespaces IPython deals with, so that

# introspection facilities can search easily.

self.ns_table = {'user_global':self.user_module.__dict__,

'user_local':self.user_ns,

'builtin':builtin_mod.__dict__

}

@property

def user_global_ns(self):

return self.user_module.__dict__

def prepare_user_module(self, user_module=None, user_ns=None):

"""Prepare the module and namespace in which user code will be run.

When IPython is started normally, both parameters are None: a new module

is created automatically, and its __dict__ used as the namespace.

If only user_module is provided, its __dict__ is used as the namespace.

If only user_ns is provided, a dummy module is created, and user_ns

becomes the global namespace. If both are provided (as they may be

when embedding), user_ns is the local namespace, and user_module

provides the global namespace.

Parameters

----------

user_module : module, optional

The current user module in which IPython is being run. If None,

a clean module will be created.

user_ns : dict, optional

A namespace in which to run interactive commands.

Returns

-------

A tuple of user_module and user_ns, each properly initialised.

"""

if user_module is None and user_ns is not None:

user_ns.setdefault("__name__", "__main__")

user_module = DummyMod()

user_module.__dict__ = user_ns

if user_module is None:

user_module = types.ModuleType("__main__",

doc="Automatically created module for IPython interactive environment")

# We must ensure that __builtin__ (without the final 's') is always

# available and pointing to the __builtin__ *module*. For more details:

# http://mail.python.org/pipermail/python-dev/2001-April/014068.html

user_module.__dict__.setdefault('__builtin__', builtin_mod)

user_module.__dict__.setdefault('__builtins__', builtin_mod)

if user_ns is None:

user_ns = user_module.__dict__

return user_module, user_ns

def init_sys_modules(self):

# We need to insert into sys.modules something that looks like a

# module but which accesses the IPython namespace, for shelve and

# pickle to work interactively. Normally they rely on getting

# everything out of __main__, but for embedding purposes each IPython

# instance has its own private namespace, so we can't go shoving

# everything into __main__.

# note, however, that we should only do this for non-embedded

# ipythons, which really mimic the __main__.__dict__ with their own

# namespace. Embedded instances, on the other hand, should not do

# this because they need to manage the user local/global namespaces

# only, but they live within a 'normal' __main__ (meaning, they

# shouldn't overtake the execution environment of the script they're

# embedded in).

# This is overridden in the InteractiveShellEmbed subclass to a no-op.

main_name = self.user_module.__name__

sys.modules[main_name] = self.user_module

def init_user_ns(self):

"""Initialize all user-visible namespaces to their minimum defaults.

Certain history lists are also initialized here, as they effectively

act as user namespaces.

Notes

-----

All data structures here are only filled in, they are NOT reset by this

method. If they were not empty before, data will simply be added to

them.

"""

# This function works in two parts: first we put a few things in

# user_ns, and we sync that contents into user_ns_hidden so that these

# initial variables aren't shown by %who. After the sync, we add the

# rest of what we *do* want the user to see with %who even on a new

# session (probably nothing, so they really only see their own stuff)

# The user dict must *always* have a __builtin__ reference to the

# Python standard __builtin__ namespace, which must be imported.

# This is so that certain operations in prompt evaluation can be

# reliably executed with builtins. Note that we can NOT use

# __builtins__ (note the 's'), because that can either be a dict or a

# module, and can even mutate at runtime, depending on the context

# (Python makes no guarantees on it). In contrast, __builtin__ is

# always a module object, though it must be explicitly imported.

# For more details:

# http://mail.python.org/pipermail/python-dev/2001-April/014068.html

ns = {}

# make global variables for user access to the histories

ns['_ih'] = self.history_manager.input_hist_parsed

ns['_oh'] = self.history_manager.output_hist

ns['_dh'] = self.history_manager.dir_hist

# user aliases to input and output histories. These shouldn't show up

# in %who, as they can have very large reprs.

ns['In'] = self.history_manager.input_hist_parsed

ns['Out'] = self.history_manager.output_hist

# Store myself as the public api!!!

ns['get_ipython'] = self.get_ipython

ns['exit'] = self.exiter

ns['quit'] = self.exiter

# Sync what we've added so far to user_ns_hidden so these aren't seen

# by %who

self.user_ns_hidden.update(ns)

# Anything put into ns now would show up in %who. Think twice before

# putting anything here, as we really want %who to show the user their

# stuff, not our variables.

# Finally, update the real user's namespace

self.user_ns.update(ns)

@property

def all_ns_refs(self):

"""Get a list of references to all the namespace dictionaries in which

IPython might store a user-created object.