##// END OF EJS Templates
Fix issue #880 - initialize TryNext with args and kwargs....
Fix issue #880 - initialize TryNext with args and kwargs. Presents a message to the user along with the traceback prompting them to install tkinter.

File last commit:

r4040:158cc426
r5303:14d011c2
Show More
ipython.txt
147 lines | 5.7 KiB | text/plain | TextLexer
Brian Granger
Major work on the documentation....
r2277 .. _configuring_ipython:
===========================================================
Configuring the :command:`ipython` command line application
===========================================================
This section contains information about how to configure the
:command:`ipython` command line application. See the :ref:`configuration
overview <config_overview>` for a more general description of the
configuration system and configuration file format.
The default configuration file for the :command:`ipython` command line application
is :file:`ipython_config.py`. By setting the attributes in this file, you
can configure the application. A sample is provided in
:mod:`IPython.config.default.ipython_config`. Simply copy this file to your
Darren Dale
Add a cross reference to discussion of ipython directory location.
r3830 :ref:`IPython directory <ipython_dir>` to start using it.
Brian Granger
Major work on the documentation....
r2277
MinRK
update config docs with recent changes...
r4040 Most configuration attributes that this file accepts are associated with classes
that are subclasses of :class:`~IPython.config.configurable.Configurable`.
Brian Granger
Major work on the documentation....
r2277
MinRK
update config docs with recent changes...
r4040 Applications themselves are Configurable as well, so we will start with some
application-level config.
Brian Granger
Major work on the documentation....
r2277
MinRK
update config docs with recent changes...
r4040 Application-level configuration
===============================
Brian Granger
Major work on the documentation....
r2277
Assuming that your configuration file has the following at the top::
c = get_config()
MinRK
update config docs with recent changes...
r4040 the following attributes are set application-wide:
Brian Granger
Major work on the documentation....
r2277
MinRK
update config docs with recent changes...
r4040 terminal IPython-only flags:
:attr:`c.TerminalIPythonApp.display_banner`
Brian Granger
Major work on the documentation....
r2277 A boolean that determined if the banner is printer when :command:`ipython`
is started.
MinRK
update config docs with recent changes...
r4040 :attr:`c.TerminalIPythonApp.classic`
Brian Granger
Major work on the documentation....
r2277 A boolean that determines if IPython starts in "classic" mode. In this
mode, the prompts and everything mimic that of the normal :command:`python`
shell
MinRK
update config docs with recent changes...
r4040 :attr:`c.TerminalIPythonApp.nosep`
Brian Granger
Major work on the documentation....
r2277 A boolean that determines if there should be no blank lines between
prompts.
MinRK
update config docs with recent changes...
r4040 :attr:`c.Application.log_level`
Brian Granger
Major work on the documentation....
r2277 An integer that sets the detail of the logging level during the startup
of :command:`ipython`. The default is 30 and the possible values are
(0, 10, 20, 30, 40, 50). Higher is quieter and lower is more verbose.
MinRK
update config docs with recent changes...
r4040 This can also be set by the name of the logging level, e.g. INFO=20,
WARN=30.
Some options, such as extensions and startup code, can be set for any
application that starts an
:class:`~IPython.core.interactiveshell.InteractiveShell`. These apps are
subclasses of :class:`~IPython.core.shellapp.InteractiveShellApp`. Since
subclasses inherit configuration, setting a trait of
:attr:`c.InteractiveShellApp` will affect all IPython applications, but if you
want terminal IPython and the QtConsole to have different values, you can set
them via :attr:`c.TerminalIPythonApp` and :attr:`c.IPKernelApp` respectively.
Brian Granger
Major work on the documentation....
r2277
MinRK
update config docs with recent changes...
r4040 :attr:`c.InteractiveShellApp.extensions`
Brian Granger
Major work on the documentation....
r2277 A list of strings, each of which is an importable IPython extension. An
IPython extension is a regular Python module or package that has a
Brian Granger
The pretty.py extension has been ported to the new extension API....
r2281 :func:`load_ipython_extension(ip)` method. This method gets called when
the extension is loaded with the currently running
MinRK
update config docs with recent changes...
r4040 :class:`~IPython.core.interactiveshell.InteractiveShell` as its only
argument. You can put your extensions anywhere they can be imported but we
add the :file:`extensions` subdirectory of the ipython directory to
``sys.path`` during extension loading, so you can put them there as well.
Extensions are not executed in the user's interactive namespace and they
must be pure Python code. Extensions are the recommended way of customizing
Brian Granger
The pretty.py extension has been ported to the new extension API....
r2281 :command:`ipython`. Extensions can provide an
:func:`unload_ipython_extension` that will be called when the extension is
unloaded.
Brian Granger
Major work on the documentation....
r2277
MinRK
update config docs with recent changes...
r4040 :attr:`c.InteractiveShellApp.exec_lines`
Brian Granger
Major work on the documentation....
r2277 A list of strings, each of which is Python code that is run in the user's
namespace after IPython start. These lines can contain full IPython syntax
with magics, etc.
MinRK
update config docs with recent changes...
r4040 :attr:`c.InteractiveShellApp.exec_files`
Brian Granger
Major work on the documentation....
r2277 A list of strings, each of which is the full pathname of a ``.py`` or
``.ipy`` file that will be executed as IPython starts. These files are run
in IPython in the user's namespace. Files with a ``.py`` extension need to
be pure Python. Files with a ``.ipy`` extension can have custom IPython
syntax (magics, etc.). These files need to be in the cwd, the ipythondir
or be absolute paths.
Classes that can be configured
==============================
The following classes can also be configured in the configuration file for
:command:`ipython`:
MinRK
update config docs with recent changes...
r4040 * :class:`~IPython.core.interactiveshell.InteractiveShell`
Brian Granger
Major work on the documentation....
r2277
* :class:`~IPython.core.prefilter.PrefilterManager`
* :class:`~IPython.core.alias.AliasManager`
To see which attributes of these classes are configurable, please see the
source code for these classes, the class docstrings or the sample
configuration file :mod:`IPython.config.default.ipython_config`.
Example
=======
For those who want to get a quick start, here is a sample
:file:`ipython_config.py` that sets some of the common configuration
attributes::
# sample ipython_config.py
c = get_config()
MinRK
update config docs with recent changes...
r4040 c.IPythonTerminalApp.display_banner = True
c.InteractiveShellApp.log_level = 20
c.InteractiveShellApp.extensions = [
Brian Granger
Major work on the documentation....
r2277 'myextension'
]
MinRK
update config docs with recent changes...
r4040 c.InteractiveShellApp.exec_lines = [
Brian Granger
Major work on the documentation....
r2277 'import numpy',
'import scipy'
]
MinRK
update config docs with recent changes...
r4040 c.InteractiveShellApp.exec_files = [
Brian Granger
Major work on the documentation....
r2277 'mycode.py',
'fancy.ipy'
]
c.InteractiveShell.autoindent = True
c.InteractiveShell.colors = 'LightBG'
c.InteractiveShell.confirm_exit = False
c.InteractiveShell.deep_reload = True
c.InteractiveShell.editor = 'nano'
c.InteractiveShell.prompt_in1 = 'In [\#]: '
c.InteractiveShell.prompt_in2 = ' .\D.: '
c.InteractiveShell.prompt_out = 'Out[\#]: '
c.InteractiveShell.prompts_pad_left = True
c.InteractiveShell.xmode = 'Context'
c.PrefilterManager.multi_line_specials = True
c.AliasManager.user_aliases = [
('la', 'ls -al')
Brian Granger
Adding new docs for configuration/extensions/plugins.
r2749 ]