ipython 是一个 python 的交互式 shell，支持变量自动补全，自动缩进，支持 bash shell 命令，内置了许多很有用的功能和函数，比默认的 python shell 好用得多。IPython 已经成为用 Python 做教学、计算、科研的一个重要工具

2001 年, Fernando Pérez 为了得到一个更为高效的交互式 Python 解释器而启动了一个业余项目, 于是 IPython 项目诞生了。之后，它逐渐被公认为现代科学计算中最重要的 Python 工具之一。IPython 本身并没有提供任何的计算或数据分析功能, 其设计目的是在交互式计算和软件开发这两个方面最大化地提高生产力。它鼓励一种 “执行-探索”(execute explore) 的工作模式, 而不是许多其他编程语言那种“编辑-编译-运行”(edit-complie-run)的传统工作模式。此外, 它跟操作系统shell和文件系统之间也有着非常紧密的集成。由于大部分的数据分析代码都含有探索式操作(试误法和迭代法), 因此 IPython (在绝大多数情况下)将有助于提高你的工作效率。

基础

IPython 安装可以用如下命令：

# Debian 平台安装
apt-get install ipython

# Redhat 平台安装
yum install ipython

# 直接 pip 安装
pip install ipython

安装完成后，终端输入 ipython 即可进入其环境，如下所示：

$ ipython
Python 3.5.3 |Continuum Analytics, Inc.| (default, Mar  6 2017, 11:58:13)
Type 'copyright', 'credits' or 'license' for more information
IPython 6.1.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]:

IPython 基本的使用方法与 python 的默认解释器基本相同，但 ipython 支持部分 shell 命令，且有自动补全，语法高亮等功能，如下所示：

In [1]: print "hello world"
hello world

In [2]: range(10)
Out[2]: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

In [3]: ls
aboutme  logs  temp  work

In [4]: pwd
Out[4]: u'/home/huoty'

IPython 将许多 Python 对象格式化为可读性更好(或者说排版更好)的形式，使得可读性更强。IPython 支持 Tab 自动补全，使用起来十分方便。

内省

在变量名或命令的前面或后面加一个 ? 并执行，可以用于显示该对象的一些通用信息，如对象类型、文档字符串等，这就叫做对象内省（object introspection）。例如：

In [1]: l = [2, 3, 4 ,5]

In [2]: l?
Type:        list
String form: [2, 3, 4, 5]
Length:      4
Docstring:
list() -> new empty list
list(iterable) -> new list initialized from iterable's items

In [3]: list?
Docstring:
list() -> new empty list
list(iterable) -> new list initialized from iterable's items
Type:      type

使用 ?? 还将显示出该函数的源代码（如果可能的话）。? 的另一个用法是可以搜索 IPython 的命名空间，。一些字符再配以通配符 * 即可显示出所有与该通配符表达式相匹配的名称。如：

In [10]: import time

In [11]: time.*time*?
time.asctime
time.ctime
time.gmtime
time.localtime
time.mktime
time.strftime
time.strptime
time.struct_time
time.time
time.timezone

魔法

IPython 有一些特殊命令，被称为魔法命令（Magic Command），它们有的为常见任务提供便利，有的则使你能够轻松控制 IPython 系统的行为。魔法命令是以百分号 % 为前缀的命令。例如，你可以通过 %timeit 这个魔法命令检测任意 Python 语句的执行时间。

魔法命令可以看做运行于 IPython 系统中的命令行程序，它们大都还有一些 “命令行选项”，使用 ? 即可查看其选项，例如 %run? 命令用于查看帮助。在 IPython 会话环境中，所有文件都可以通过 %run 命令当做 Python 程序来运行，同时支持命令行参数。假设你在 ipython_script_test.py 中存放了一段简单的脚本，那么可以用如下方式执行：

In [5]: %run ipython_script_test.py

使用 %run 时，脚本是在一个空的命名空间中运行的（没有任何 import，也没有定义任何其他的变量），所以其行为应该跟在标准命令行环境（通过 python script.py 启动的）中执行时一样。此后，该文件中所定义的全部变量（还有各种import、函数和全局变量）就可以在当前 IPython Shell 中访问了（除非发生了异常）。 如果希望脚本能够访问在交互式 IPython 命名空间中定义的变量，那就应该使用 %run -i 而不是 %run。

使用 %lsmagic 可以列出所有的魔法命令，另外一些常用的魔术命令如下所示：

%quickref    显示 IPython 快速参考
%magic    显示所有魔术命令的详细文档
%debug    从最新的异常跟踪的底部进入交互式调试器
%pdb    在异常发生后自动进入调试器
%reset    删除 interactive 命名空间中的全部变量
%load    从文中加载代码
%run script.py    执行 script.py
%prun statement     通过 cProfile 执行对 statement 的逐行性能分析
%time statement     测试 statement 的执行时间
%timeit statement    多次测试 statement 的执行时间并计算平均值
%%history    显示历史命令，很多可选参数，可用于制作命令说明
%hist    %history 的别名
%dhist    显示历史目录，用 cd -n 可以直接跳转；
%who、%who_ls、%whos    显示 interactive 命名空间中定义的变量，信息级别/冗余度可变
%xdel variable    删除 variable，并尝试清除其在 IPython 中的对象上的一切引用
%bookmark    使用 IPython 的目录书签系统
%cd direcrory    切换工作目录
%pwd    返回当前工作目录（字符串形式）
%env    返回当前系统变量（以字典形式），同时也可用于设置环境变量
%pycat    查看 python 源码文件

!cmd    在系统 shell 执行 cmd
output=!cmd args    执行 cmd 并赋值

在 IPython 中还可以用 ed 或 edit 命令编辑一个文件并执行，ed -x filename 则表示编辑文件不执行。用 pycat filename 命令可以语法高亮显示一个文件。

IPython 还有很多的魔术命令，不熟悉的话可以通过 %magic 查看详细文档；对某一个命令不熟悉的话，可以通过 %cmd? 内省机制查看特定文档。值得一提的是，IPython 中使用 del 命令无法删除所有的变量引用，因此垃圾回收机制也无法启用，所以有些时候你会需要使用 %xdel 或者 %reset。

配置

使用如下命令可以创建默认的配置文件：

ipython profile create

以上命令会在 ~/.ipython/profile_default/ 目录下生成 ipython_config.py 和 ipython_kernel_config.py 这两个配置文件。IPython 可以使用多个配置文件，具有单独的配置和历史。默认情况下，如果不指定配置文件，IPython 将始终运行在 default 配置文件下。也可以在单独创建另一个配置文件并使用：

$ ipython profile create huoty  # 创建配置文件
[ProfileCreate] Generating default config file: '/home/huoty/.ipython/profile_huoty/ipython_config.py'
[ProfileCreate] Generating default config file: '/home/huoty/.ipython/profile_huoty/ipython_kernel_config.py'

$ ipython --profile=huoty  # 指定配置文件并启动
Python 3.8.5 (default, Sep  4 2020, 07:30:14)
Type 'copyright', 'credits' or 'license' for more information
IPython 7.20.0 -- An enhanced Interactive Python. Type '?' for help.

IPython profile: huoty

In [1]:

配置项可以直接在配置文件里修改，如：

c.InteractiveShell.ast_node_interactivity = "all"

也可以在运行中进行修改，如：

from IPython.core.interactiveshell import InteractiveShell
InteractiveShell.ast_node_interactivity = "all"

一些常用的配置项：

# 配置命令别名
c.AliasManager.user_aliases = [
    ('ll', 'ls -al')
]

# 列出启动时需要自动执行的代码行
c.InteractiveShellApp.exec_lines = [
    'import os',
    'import sys',
    'from pprint import pprint',
]

# 列出启动时需要自动执行的文件
c.InteractiveShellApp.exec_files = []

还可以在 $HOME/.ipython/profile_default/startup 目录下放置脚本，ipython 在启动时会自动加载。

参考资料