def make_IPython(argv=[''],user_ns=None,debug=0,rc_override=None):
"""This is a dump of IPython into a single function.
Later it will have to be broken up in a sensible manner."""
if sys.version[0:3] < '2.1':
print 'IPython requires Python Version 2.1 or above. Sorry.'
sys.exit()
#----------------------------------------------------------------------
# Defaults and initialization
# __IP is the main global that lives throughout and represents the whole
# application. If the user redefines it, all bets are off as to what
# happens.
# __IP is the name of he global which the caller will have accessible as
# __IP.name. We set its name via the first parameter passed to
# InteractiveShell:
IP = InteractiveShell('__IP',user_ns=user_ns)
# Put 'help' in the user namespace
from pydoc import help
IP.user_ns['help'] = help
# IPython itself shouldn't crash. This will produce a detailed post-mortem
# if it does
if debug:
import ultraTB
sys.excepthook = ultraTB.VerboseTB(call_pdb=1)
else:
import CrashHandler
sys.excepthook = CrashHandler.CrashHandler(IP)
IP.BANNER_PARTS = ['Python %s\n'
'Type "copyright", "credits" or "license" '
'for more information.\n'
% (sys.version.split('\n')[0],),
"IPython %s -- An enhanced Interactive Python."
% (__version__,),
"""? -> Introduction to IPython's features.
@magic -> Information about IPython's 'magic' @ functions.
help -> Python's own help system.
object? -> Details about 'object'. ?object also works, ?? prints more.
""" ]
IP.usage = interactive_usage
# default directory for configuration
ipythondir = os.path.abspath(os.environ.get('IPYTHONDIR',
os.path.join(IP.home_dir,'.ipython') ) )
# suffix to use in all rc-files:
if os.name == 'posix':
rc_suffix = ''
else:
rc_suffix = '.ini'
# we need the directory where IPython itself is installed
import IPython
IPython_dir = os.path.dirname(IPython.__file__)
del IPython
#-------------------------------------------------------------------------
# Command line handling
# Valid command line options (uses DPyGetOpt syntax, like Perl's
# GetOpt::Long)
# Any key not listed here gets deleted even if in the file (like session
# or profile). That's deliberate, to maintain the rc namespace clean.
# Each set of options appears twice: under _conv only the names are
# listed, indicating which type they must be converted to when reading the
# ipythonrc file. And under DPyGetOpt they are listed with the regular
# DPyGetOpt syntax (=s,=i,:f,etc).
# Make sure there's a space before each end of line (they get auto-joined!)
cmdline_opts = ('automagic! banner! cache_size|cs=i classic|cl '
'color_info! confirm_exit! '
'debug! deep_reload! editor=s log|l messages! nosep pdb! '
'pprint! prompt_in1|pi1=s prompt_in2|pi2=s prompt_out|po=s '
'quick screen_length|sl=i '
'colors|c=s logfile|lf=s logplay|lp=s profile|p=s '
'readline! readline_omit__names! '
'rcfile=s separate_in|si=s separate_out|so=s '
'separate_out2|so2=s xmode=s '
'magic_docstrings ')
# Options that can *only* appear at the cmd line (not in rcfiles).
# The "ignore" option is a kludge so that Emacs buffers don't crash, since
# the 'C-c !' command in emacs automatically appends a -i option at the end.
cmdline_only = 'help ignore|i ipythondir=s Version upgrade'
# Build the actual name list to be used by DPyGetOpt
opts_names = qw(cmdline_opts) + qw(cmdline_only)
# Set sensible command line defaults.
# This should have everything from cmdline_opts and cmdline_only
opts_def = Struct(automagic = 1,
banner = 1,
cache_size = 1000,
classic = 0,
colors = 'NoColor',
color_info = 0,
confirm_exit = 1,
debug = 0,
deep_reload = 0,
editor = '0',
help = 0,
ipythondir = ipythondir,
log = 0,
logfile = '',
logplay = '',
messages = 1,
nosep = 0,
pdb = 0,
pprint = 0,
profile = '',
prompt_in1 = 'In [%n]:',
prompt_in2 = ' .%n.:',
prompt_out = 'Out[%n]:',
quick = 0,
readline = 1,
readline_omit__names = 0,
rcfile = 'ipythonrc' + rc_suffix,
screen_length = 0,
separate_in = '\n',
separate_out = '\n',
separate_out2 = '',
upgrade = 0,
Version = 0,
xmode = 'Verbose',
magic_docstrings = 0, # undocumented, for doc generation
)
# Things that will *only* appear in rcfiles (not at the command line).
# Make sure there's a space before each end of line (they get auto-joined!)
rcfile_opts = { qwflat: 'include import_mod import_all execfile ',
qw_lol: 'import_some ',
# for things with embedded whitespace:
list_strings:'execute alias readline_parse_and_bind ',
# Regular strings need no conversion:
None:'readline_remove_delims ',
}
# Default values for these
rc_def = Struct(include = [],
import_mod = [],
import_all = [],
import_some = [[]],
execute = [],
execfile = [],
alias = [],
readline_parse_and_bind = [],
readline_remove_delims = '',
)
# Build the type conversion dictionary from the above tables:
typeconv = rcfile_opts.copy()
typeconv.update(optstr2types(cmdline_opts))
# FIXME: the None key appears in both, put that back together by hand. Ugly!
typeconv[None] += ' ' + rcfile_opts[None]
# Remove quotes at ends of all strings (used to protect spaces)
typeconv[unquote_ends] = typeconv[None]
del typeconv[None]
# Build the list we'll use to make all config decisions with defaults:
opts_all = opts_def.copy()
opts_all.update(rc_def)
# Build conflict resolver for recursive loading of config files:
# - preserve means the outermost file maintains the value, it is not
# overwritten if an included file has the same key.
# - add_flip applies + to the two values, so it better make sense to add
# those types of keys. But it flips them first so that things loaded
# deeper in the inclusion chain have lower precedence.
conflict = {'preserve': ' '.join([ typeconv[int],
typeconv[unquote_ends] ]),
'add_flip': ' '.join([ typeconv[qwflat],
typeconv[qw_lol],
typeconv[list_strings] ])
}
# Now actually process the command line
getopt = DPyGetOpt.DPyGetOpt()
getopt.setIgnoreCase(0)
getopt.parseConfiguration(opts_names)
try:
getopt.processArguments(argv)
except:
print cmd_line_usage
warn('\nError in Arguments: ' + `sys.exc_value`)
sys.exit()
# convert the options dict to a struct for much lighter syntax later
opts = Struct(getopt.optionValues)
args = getopt.freeValues
# this is the struct (which has default values at this point) with which
# we make all decisions:
opts_all.update(opts)
# Options that force an immediate exit
if opts_all.help:
page(cmd_line_usage)
sys.exit()
if opts_all.Version:
print __version__
sys.exit()
if opts_all.magic_docstrings:
IP.magic_magic('-latex')
sys.exit()
# Create user config directory if it doesn't exist. This must be done
# *after* getting the cmd line options.
if not os.path.isdir(opts_all.ipythondir):
IP.user_setup(opts_all.ipythondir,rc_suffix,'install')
# upgrade user config files while preserving a copy of the originals
if opts_all.upgrade:
IP.user_setup(opts_all.ipythondir,rc_suffix,'upgrade')
# check mutually exclusive options in the *original* command line
mutex_opts(opts,[qw('log logfile'),qw('rcfile profile'),
qw('classic profile'),qw('classic rcfile')])
# default logfilename used when -log is called.
IP.LOGDEF = 'ipython.log'
# history file for saving commands in between sessions
IP.histfile = os.path.join(opts_all.ipythondir,'history')
#---------------------------------------------------------------------------
# Log replay
# if -logplay, we need to 'become' the other session. That basically means
# replacing the current command line environment with that of the old session
# and moving on.
# this is needed so that later we know we're in session reload mode, as
# opts_all will get overwritten:
load_logplay = 0
if opts_all.logplay:
load_logplay = opts_all.logplay
opts_debug_save = opts_all.debug
try:
logplay = open(opts_all.logplay)
except IOError:
if opts_all.debug: IP.InteractiveTB()
warn('Could not open logplay file '+`opts_all.logplay`)
# restore state as if nothing had happened and move on, but make
# sure that later we don't try to actually load the session file
logplay = None
load_logplay = 0
del opts_all.logplay
else:
try:
logplay.readline()
logplay.readline();
# this reloads that session's command line
cmd = logplay.readline()[6:]
exec cmd
# restore the true debug flag given so that the process of session
# loading itself can be monitored.
opts.debug = opts_debug_save
# save the logplay flag so later we don't overwrite the log
opts.logplay = load_logplay
# now we must update our own structure with defaults
opts_all.update(opts)
# now load args
cmd = logplay.readline()[6:]
exec cmd
logplay.close()
except 'ha':
logplay.close()
if opts_all.debug: IP.InteractiveTB()
warn("Logplay file lacking full configuration information.\n"
"I'll try to read it, but some things may not work.")
#-------------------------------------------------------------------------
# set up output traps: catch all output from files, being run, modules
# loaded, etc. Then give it to the user in a clean form at the end.
msg_out = 'Output messages. '
msg_err = 'Error messages. '
msg_sep = '\n'
msg = Struct(config = OutputTrap('Configuration Loader',msg_out,
msg_err,msg_sep,debug,
quiet_out=1),
user_exec = OutputTrap('User File Execution',msg_out,
msg_err,msg_sep,debug),
logplay = OutputTrap('Log Loader',msg_out,
msg_err,msg_sep,debug),
summary = ''
)
#-------------------------------------------------------------------------
# Process user ipythonrc-type configuration files
# turn on output trapping and log to msg.config
# remember that with debug on, trapping is actually disabled
msg.config.trap_all()
# look for rcfile in current or default directory
try:
opts_all.rcfile = filefind(opts_all.rcfile,opts_all.ipythondir)
except IOError:
if opts_all.debug: IP.InteractiveTB()
warn('Configuration file %s not found. Ignoring request.'
% (opts_all.rcfile) )
# 'profiles' are a shorthand notation for config filenames
if opts_all.profile:
try:
opts_all.rcfile = filefind('ipythonrc-' + opts_all.profile
+ rc_suffix,
opts_all.ipythondir)
except IOError:
if opts_all.debug: IP.InteractiveTB()
opts.profile = '' # remove profile from options if invalid
warn('Profile configuration file %s not found. Ignoring request.'
% (opts_all.profile) )
# load the config file
rcfiledata = None
if opts_all.quick:
print 'Launching IPython in quick mode. No config file read.'
elif opts_all.classic:
print 'Launching IPython in classic mode. No config file read.'
elif opts_all.rcfile:
try:
cfg_loader = ConfigLoader(conflict)
rcfiledata = cfg_loader.load(opts_all.rcfile,typeconv,
'include',opts_all.ipythondir,
purge = 1,
unique = conflict['preserve'])
except:
IP.InteractiveTB()
warn('Problems loading configuration file '+
`opts_all.rcfile`+
'\nStarting with default -bare bones- configuration.')
else:
warn('No valid configuration file found in either currrent directory\n'+
'or in the IPython config. directory: '+`opts_all.ipythondir`+
'\nProceeding with internal defaults.')
#------------------------------------------------------------------------
# Set exception handlers in mode requested by user.
otrap = OutputTrap(trap_out=1) # trap messages from magic_xmode
IP.magic_xmode(opts_all.xmode)
otrap.release_out()
#------------------------------------------------------------------------
# Execute user config
# first, create a valid config structure with the right precedence order:
# defaults < rcfile < command line
IP.rc = rc_def.copy()
IP.rc.update(opts_def)
if rcfiledata:
# now we can update
IP.rc.update(rcfiledata)
IP.rc.update(opts)
IP.rc.update(rc_override)
# Store the original cmd line for reference:
IP.rc.opts = opts
IP.rc.args = args
# create a *runtime* Struct like rc for holding parameters which may be
# created and/or modified by runtime user extensions.
IP.runtime_rc = Struct()
# from this point on, all config should be handled through IP.rc,
# opts* shouldn't be used anymore.
# add personal .ipython dir to sys.path so that users can put things in
# there for customization
sys.path.append(IP.rc.ipythondir)
sys.path.insert(0, '') # add . to sys.path. Fix from Prabhu Ramachandran
# update IP.rc with some special things that need manual
# tweaks. Basically options which affect other options. I guess this
# should just be written so that options are fully orthogonal and we
# wouldn't worry about this stuff!
if IP.rc.classic:
IP.rc.quick = 1
IP.rc.cache_size = 0
IP.rc.pprint = 0
IP.rc.prompt_in1 = '>>> '
IP.rc.prompt_in2 = '... '
IP.rc.prompt_out = ''
IP.rc.separate_in = IP.rc.separate_out = IP.rc.separate_out2 = '0'
IP.rc.colors = 'NoColor'
IP.rc.xmode = 'Plain'
# configure readline
if IP.rc.readline:
IP.init_readline()
# update exception handlers with rc file status
otrap.trap_out() # I don't want these messages ever.
IP.magic_xmode(IP.rc.xmode)
otrap.release_out()
# activate logging if requested and not reloading a log
if IP.rc.logplay:
IP.magic_logstart(IP.rc.logplay + ' append')
elif IP.rc.logfile:
IP.magic_logstart(IP.rc.logfile)
elif IP.rc.log:
IP.magic_logstart()
# find user editor so that it we don't have to look it up constantly
if IP.rc.editor.strip()=='0':
try:
ed = os.environ['EDITOR']
except KeyError:
if os.name == 'posix':
ed = 'vi' # the only one guaranteed to be there!
else:
ed = 'notepad' # same in Windows!
IP.rc.editor = ed
# Recursive reload
try:
import deep_reload
if IP.rc.deep_reload:
__builtin__.reload = deep_reload.reload
else:
__builtin__.dreload = deep_reload.reload
del deep_reload
except ImportError:
pass
# Save the current state of our namespace so that the interactive shell
# can later know which variables have been created by us from config files
# and loading. This way, loading a file (in any way) is treated just like
# defining things on the command line, and @who works as expected.
# DON'T do anything that affects the namespace beyond this point!
IP.internal_ns = __main__.__dict__.copy()
#IP.internal_ns.update(locals()) # so our stuff doesn't show up in @who
# Now run through the different sections of the users's config
if IP.rc.debug:
print 'Trying to execute the following configuration structure:'
print '(Things listed first are deeper in the inclusion tree and get'
print 'loaded first).\n'
pprint(IP.rc.__dict__)
for mod in IP.rc.import_mod:
try:
exec 'import '+mod in IP.user_ns
except :
IP.InteractiveTB()
import_fail_info(mod)
for mod_fn in IP.rc.import_some:
if mod_fn == []: break
mod,fn = mod_fn[0],' '.join(mod_fn[1:])
try:
exec 'from '+mod+' import '+fn in IP.user_ns
except :
IP.InteractiveTB()
import_fail_info(mod,fn)
for mod in IP.rc.import_all:
try:
exec 'from '+mod+' import *' in IP.user_ns
except :
IP.InteractiveTB()
import_fail_info(mod)
for code in IP.rc.execute:
try:
exec code in IP.user_ns
except:
IP.InteractiveTB()
warn('Failure executing code: ' + `code`)
# Execute the files the user wants in ipythonrc
for file in IP.rc.execfile:
try:
file = filefind(file,sys.path+[IPython_dir])
except IOError:
warn(itpl('File $file not found. Skipping it.'))
else:
IP.safe_execfile(os.path.expanduser(file),IP.user_ns)
# Load user aliases
for alias in IP.rc.alias:
IP.magic_alias(alias)
# release stdout and stderr and save config log into a global summary
msg.config.release_all()
if IP.rc.messages:
msg.summary += msg.config.summary_all()
#------------------------------------------------------------------------
# Setup interactive session
# Now we should be fully configured. We can then execute files or load
# things only needed for interactive use. Then we'll open the shell.
# Take a snapshot of the user namespace before opening the shell. That way
# we'll be able to identify which things were interactively defined and
# which were defined through config files.
IP.user_config_ns = IP.user_ns.copy()
# Force reading a file as if it were a session log. Slower but safer.
if load_logplay:
print 'Replaying log...'
try:
if IP.rc.debug:
logplay_quiet = 0
else:
logplay_quiet = 1
msg.logplay.trap_all()
IP.safe_execfile(load_logplay,IP.user_ns,
islog = 1, quiet = logplay_quiet)
msg.logplay.release_all()
if IP.rc.messages:
msg.summary += msg.logplay.summary_all()
except:
warn('Problems replaying logfile %s.' % load_logplay)
IP.InteractiveTB()
# Load remaining files in command line
msg.user_exec.trap_all()
if IP.rc.args:
name_save = IP.user_ns['__name__']
IP.user_ns['__name__'] = '__main__'
for run in args:
IP.safe_execfile(run,IP.user_ns)
IP.user_ns['__name__'] = name_save
msg.user_exec.release_all()
if IP.rc.messages:
msg.summary += msg.user_exec.summary_all()
# since we can't specify a null string on the cmd line, 0 is the equivalent:
if IP.rc.nosep:
IP.rc.separate_in = IP.rc.separate_out = IP.rc.separate_out2 = '0'
if IP.rc.separate_in == '0': IP.rc.separate_in = ''
if IP.rc.separate_out == '0': IP.rc.separate_out = ''
if IP.rc.separate_out2 == '0': IP.rc.separate_out2 = ''
IP.rc.separate_in = IP.rc.separate_in.replace('\\n','\n')
IP.rc.separate_out = IP.rc.separate_out.replace('\\n','\n')
IP.rc.separate_out2 = IP.rc.separate_out2.replace('\\n','\n')
# Determine how many lines at the bottom of the screen are needed for
# showing prompts, so we can know wheter long strings are to be printed or
# paged:
num_lines_bot = IP.rc.separate_in.count('\n')+1
IP.rc.screen_length = IP.rc.screen_length - num_lines_bot
# Initialize cache, set in/out prompts and printing system
IP.outputcache = CachedOutput(IP.rc.cache_size,
IP.rc.pprint,
colors = IP.rc.colors,
input_sep = IP.rc.separate_in,
output_sep = IP.rc.separate_out,
output_sep2 = IP.rc.separate_out2,
ps1 = IP.rc.prompt_in1,
ps2 = IP.rc.prompt_in2,
ps_out = IP.rc.prompt_out,
user_ns = IP.user_ns,
input_hist = IP.input_hist)
IP.magic_colors(IP.rc.colors)
# user may have over-ridden the default print hook:
try:
IP.outputcache.__class__.display = IP.hooks.display
except AttributeError:
pass
# Set calling of pdb on exceptions
IP.InteractiveTB.call_pdb = IP.rc.pdb
# I don't like assigning globally to sys, because it means when embedding
# instances, each embedded instance overrides the previous choice. But
# sys.displayhook seems to be called internally by exec, so I don't see a
# way around it.
sys.displayhook = IP.outputcache
# we need to know globally if we're caching i/o or not
IP.do_full_cache = IP.outputcache.do_full_cache
# configure startup banner
if IP.rc.banner:
IP.BANNER = '\n'.join(IP.BANNER_PARTS)
else:
IP.BANNER = ''
if IP.rc.profile: IP.BANNER += '\nIPython profile: '+IP.rc.profile+'\n'
# add message log (possibly empty)
IP.BANNER += msg.summary
return IP
