Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Tree: bb6f87bc7b
Fetching contributors…

Cannot retrieve contributors at this time

executable file 398 lines (344 sloc) 14.2 KB
#!/usr/bin/env python
# encoding: utf-8
The :class:`~IPython.core.application.Application` object for the command
line :command:`ipython` program.
* Brian Granger
* Fernando Perez
* Min Ragan-Kelley
# Copyright (C) 2008-2010 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
from __future__ import absolute_import
import logging
import os
import sys
from IPython.config.loader import (
Config, PyFileConfigLoader, ConfigFileNotFound
from IPython.config.application import boolean_flag, catch_config_error
from IPython.core import release
from IPython.core import usage
from IPython.core.completer import IPCompleter
from IPython.core.crashhandler import CrashHandler
from IPython.core.formatters import PlainTextFormatter
from IPython.core.application import (
ProfileDir, BaseIPythonApplication, base_flags, base_aliases
from IPython.core.shellapp import (
InteractiveShellApp, shell_flags, shell_aliases
from IPython.frontend.terminal.interactiveshell import TerminalInteractiveShell
from IPython.lib import inputhook
from IPython.utils import warn
from IPython.utils.path import get_ipython_dir, check_for_old_config
from IPython.utils.traitlets import (
Bool, List, Dict, CaselessStrEnum
# Globals, utilities and helpers
#: The default config file name for this application.
default_config_file_name = u''
_examples = """
ipython --pylab # start in pylab mode
ipython --pylab=qt # start in pylab mode with the qt4 backend
ipython --log-level=DEBUG # set logging to DEBUG
ipython --profile=foo # start with profile foo
ipython qtconsole # start the qtconsole GUI application
ipython qtconsole -h # show the help string for the qtconsole subcmd
ipython profile create foo # create profile foo w/ default config files
ipython profile -h # show the help string for the profile subcmd
# Crash handler for this application
class IPAppCrashHandler(CrashHandler):
"""sys.excepthook for IPython itself, leaves a detailed report on disk."""
def __init__(self, app):
contact_name = release.authors['Fernando'][0]
contact_email = release.author_email
bug_tracker = ''
app, contact_name, contact_email, bug_tracker
def make_report(self,traceback):
"""Return a string containing a crash report."""
sec_sep = self.section_sep
# Start with parent report
report = [super(IPAppCrashHandler, self).make_report(traceback)]
# Add interactive-specific info we may have
rpt_add = report.append
rpt_add(sec_sep+"History of session input:")
for line in['_ih']:
rpt_add('\n*** Last line of input (may not be in above history):\n')
return ''.join(report)
# Aliases and Flags
flags = dict(base_flags)
addflag = lambda *args: flags.update(boolean_flag(*args))
addflag('autoedit-syntax', 'TerminalInteractiveShell.autoedit_syntax',
'Turn on auto editing of files with syntax errors.',
'Turn off auto editing of files with syntax errors.'
addflag('banner', 'TerminalIPythonApp.display_banner',
"Display a banner upon starting IPython.",
"Don't display a banner upon starting IPython."
addflag('confirm-exit', 'TerminalInteractiveShell.confirm_exit',
"""Set to confirm when you try to exit IPython with an EOF (Control-D
in Unix, Control-Z/Enter in Windows). By typing 'exit' or 'quit',
you can force a direct exit without any confirmation.""",
"Don't prompt the user when exiting."
addflag('term-title', 'TerminalInteractiveShell.term_title',
"Enable auto setting the terminal title.",
"Disable auto setting the terminal title."
classic_config = Config()
classic_config.InteractiveShell.cache_size = 0
classic_config.PlainTextFormatter.pprint = False
classic_config.InteractiveShell.prompt_in1 = '>>> '
classic_config.InteractiveShell.prompt_in2 = '... '
classic_config.InteractiveShell.prompt_out = ''
classic_config.InteractiveShell.separate_in = ''
classic_config.InteractiveShell.separate_out = ''
classic_config.InteractiveShell.separate_out2 = ''
classic_config.InteractiveShell.colors = 'NoColor'
classic_config.InteractiveShell.xmode = 'Plain'
"Gives IPython a similar feel to the classic Python prompt."
# # log doesn't make so much sense this way anymore
# paa('--log','-l',
# action='store_true', dest='InteractiveShell.logstart',
# help="Start logging to the default log file (./")
# # quick is harder to implement
{'TerminalIPythonApp' : {'quick' : True}},
"Enable quick startup with no config files."
flags['i'] = (
{'TerminalIPythonApp' : {'force_interact' : True}},
"""If running code from the command line, become interactive afterwards.
Note: can also be given simply as '-i.'"""
flags['pylab'] = (
{'TerminalIPythonApp' : {'pylab' : 'auto'}},
"""Pre-load matplotlib and numpy for interactive use with
the default matplotlib backend."""
aliases = dict(base_aliases)
# it's possible we don't want short aliases for *all* of these:
# Main classes and functions
class TerminalIPythonApp(BaseIPythonApplication, InteractiveShellApp):
name = u'ipython'
description = usage.cl_usage
default_config_file_name = default_config_file_name
crash_handler_class = IPAppCrashHandler
examples = _examples
flags = Dict(flags)
aliases = Dict(aliases)
classes = List()
def _classes_default(self):
"""This has to be in a method, for TerminalIPythonApp to be available."""
return [
InteractiveShellApp, # ShellApp comes before TerminalApp, because
self.__class__, # it will also affect subclasses (e.g. QtConsole)
subcommands = Dict(dict(
"""Launch the IPython Qt Console."""
"""Launch the IPython HTML Notebook Server"""
profile = ("IPython.core.profileapp.ProfileApp",
"Create and manage IPython profiles."
kernel = ("IPython.zmq.ipkernel.IPKernelApp",
"Start a kernel without an attached frontend."
# *do* autocreate requested profile, but don't create the config file.
# configurables
ignore_old_config=Bool(False, config=True,
help="Suppress warning messages about legacy config files"
quick = Bool(False, config=True,
help="""Start IPython quickly by skipping the loading of config files."""
def _quick_changed(self, name, old, new):
if new:
self.load_config_file = lambda *a, **kw: None
gui = CaselessStrEnum(('qt', 'wx', 'gtk', 'glut', 'pyglet'), config=True,
help="Enable GUI event loop integration ('qt', 'wx', 'gtk', 'glut', 'pyglet')."
pylab = CaselessStrEnum(['tk', 'qt', 'wx', 'gtk', 'osx', 'auto'],
help="""Pre-load matplotlib and numpy for interactive use,
selecting a particular matplotlib backend and loop integration.
display_banner = Bool(True, config=True,
help="Whether to display a banner upon starting IPython."
# if there is code of files to run from the cmd line, don't interact
# unless the --i flag (App.force_interact) is true.
force_interact = Bool(False, config=True,
help="""If a command or file is given via the command-line,
e.g. 'ipython"""
def _force_interact_changed(self, name, old, new):
if new:
self.interact = True
def _file_to_run_changed(self, name, old, new):
if new and not self.force_interact:
self.interact = False
_code_to_run_changed = _file_to_run_changed
# internal, not-configurable
def parse_command_line(self, argv=None):
"""override to allow old '-pylab' flag with deprecation warning"""
argv = sys.argv[1:] if argv is None else argv
if '-pylab' in argv:
# deprecated `-pylab` given,
# warn and transform into current syntax
argv = argv[:] # copy, don't clobber
idx = argv.index('-pylab')
warn.warn("`-pylab` flag has been deprecated.\n"
" Use `--pylab` instead, or `--pylab=foo` to specify a backend.")
sub = '--pylab'
if len(argv) > idx+1:
# check for gui arg, as in '-pylab qt'
gui = argv[idx+1]
if gui in ('wx', 'qt', 'qt4', 'gtk', 'auto'):
sub = '--pylab='+gui
argv[idx] = sub
return super(TerminalIPythonApp, self).parse_command_line(argv)
def initialize(self, argv=None):
"""Do actions after construct, but before starting the app."""
super(TerminalIPythonApp, self).initialize(argv)
if self.subapp is not None:
# don't bother initializing further, starting subapp
if not self.ignore_old_config:
# print self.extra_args
if self.extra_args:
self.file_to_run = self.extra_args[0]
# create the shell
# and draw the banner
# Now a variety of things that happen after the banner is printed.
def init_shell(self):
"""initialize the InteractiveShell instance"""
# I am a little hesitant to put these into InteractiveShell itself.
# But that might be the place for them
sys.path.insert(0, '')
# Create an InteractiveShell instance.
# shell.display_banner should always be False for the terminal
# based app, because we call shell.show_banner() by hand below
# so the banner shows *before* all extension loading stuff. = TerminalInteractiveShell.instance(config=self.config,
display_banner=False, profile_dir=self.profile_dir,
def init_banner(self):
"""optionally display the banner"""
if self.display_banner and self.interact:
# Make sure there is a space below the banner.
if self.log_level <= logging.INFO: print
def init_gui_pylab(self):
"""Enable GUI event loop integration, taking pylab into account."""
gui = self.gui
# Using `pylab` will also require gui activation, though which toolkit
# to use may be chosen automatically based on mpl configuration.
if self.pylab:
activate =
if self.pylab == 'auto':
gui = None
gui = self.pylab
# Enable only GUI integration, no pylab
activate = inputhook.enable_gui
if gui or self.pylab:
try:"Enabling GUI event loop integration, "
"toolkit=%s, pylab=%s" % (gui, self.pylab) )
if self.pylab:
activate(gui, import_all=self.pylab_import_all)
self.log.warn("Error in enabling GUI event loop integration:")
def start(self):
if self.subapp is not None:
return self.subapp.start()
# perform any prexec steps:
if self.interact:
self.log.debug("Starting IPython's mainloop...")
self.log.debug("IPython not interactive...")
def load_default_config(ipython_dir=None):
"""Load the default config file from the default ipython_dir.
This is useful for embedded shells.
if ipython_dir is None:
ipython_dir = get_ipython_dir()
profile_dir = os.path.join(ipython_dir, 'profile_default')
cl = PyFileConfigLoader(default_config_file_name, profile_dir)
config = cl.load_config()
except ConfigFileNotFound:
# no config found
config = Config()
return config
def launch_new_instance():
"""Create and run a full blown IPython instance"""
app = TerminalIPythonApp.instance()
if __name__ == '__main__':
Jump to Line
Something went wrong with that request. Please try again.