从python帮助中提取示例到ipython会话中

Question

在ipython我可以运行一些诸如

import pandas as pd
pd.DataFrame.join?

并查看有关的帮助DataFrame。

帮助文件的末尾通常有一些示例，例如

Another option to join using the key columns is to use the `on`
parameter. DataFrame.join always uses `other`'s index but we can use
any column in `df`. This method preserves the original DataFrame's
index in the result.

>>> df.join(other.set_index('key'), on='key')
  key   A    B
0  K0  A0   B0
1  K1  A1   B1
2  K2  A2   B2
3  K3  A3  NaN
4  K4  A4  NaN
5  K5  A5  NaN

我想知道是否有一种快速的方法可以将这些示例提取到当前会话中，以便我可以进一步研究它们，或者我是否必须从帮助文件中复制粘贴（然后调整）代码。

Answer 1

对于通用的Python示例，请复制示例，然后将其粘贴；IPython足够聪明，可以理解Python的前缀>>>和...前缀，以及它自己的前缀格式。请参阅IPython手册中的以Python或IPython提示开头的代码粘贴。

我在这里复制文档中的前两个示例：

In [1]: import pandas as pd

In [2]: pd.DataFrame.join?

In [3]: >>> df = pd.DataFrame({'key': ['K0', 'K1', 'K2', 'K3', 'K4', 'K5'],
   ...: ...                    'A': ['A0', 'A1', 'A2', 'A3', 'A4', 'A5']})

In [4]: df
Out[4]:
  key   A
0  K0  A0
1  K1  A1
2  K2  A2
3  K3  A3
4  K4  A4
5  K5  A5

In [5]: >>> other = pd.DataFrame({'key': ['K0', 'K1', 'K2'],
    ...: ...                       'B': ['B0', 'B1', 'B2']})

您还可以使用%pasteterminal magic命令使IPython进行相同的操作；此命令直接从剪贴板提取数据。

在这里，我将第三个示例放到剪贴板上：

In [6]: %paste
>>> df.set_index('key').join(other.set_index('key'))
## -- End pasted text --
Out[6]:
      A    B
key
K0   A0   B0
K1   A1   B1
K2   A2   B2
K3   A3  NaN
K4   A4  NaN
K5   A5  NaN

还有一个%cpastemagic命令，它提示您将Python代码粘贴到其中。您可以多次执行此操作（也许在不同的部分），直到您--自己在一行上输入双破折号为止。这确实要求您将示例排列在另一个位置以进行复制，或者需要使用剪贴板来调出以前的条目。

您还可以df使用pandas.read_clipboard()函数仅复制数据帧输出，并让Pandas从剪贴板读取它。从列开始行复制；这是文档中显示的最终数据框输出：

In [7]: pd.DataFrame.join?

In [8]: pd.read_clipboard('\s\s+')
Out[8]:
  key   A    B
0  K0  A0   B0
1  K1  A1   B1
2  K2  A2   B2
3  K3  A3  NaN
4  K4  A4  NaN
5  K5  A5  NaN

我用的\s\s+不是默认的\s+; 它更强大，因为它使您可以接受带有单个空格的列名称。