Jupyter Notebookでマジックコマンド一覧を確認する%lsmagic
Jupyter Notebook(IPython Notebook)で使用できるマジックコマンド一覧は%lsmagic
で確認できる。
マジックコマンドについてはWeb上に公式ドキュメントもあるが、バージョンや環境によって使えないものもあるので、実際に起動しているJupyter Notebook / IPythonの中で確認したほうが確実。
なお、%lsmagic
はIPythonで実装されているマジックコマンド。実装されていない限り他のカーネルでは使えない。
ここでは以下の内容について説明する。
- IPythonのマジックコマンドのドキュメント
%lsmagic
でマジックコマンド一覧を表示- 各マジックコマンドの詳細をJupyter Notebook内で確認
?
と??
- キーボードショートカット:
shift + TAB
IPythonには!ls
のように先頭に!
をつけることでシステムコマンド(OSコマンド / シェルコマンド)を実行できるという仕組みもある。以下の記事を参照。
IPythonのマジックコマンドのドキュメント
IPythonのマジックコマンドについてのドキュメントは以下。
%lsmagicでマジックコマンド一覧を表示
%lsmagic
で現在利用可能なマジックコマンド一覧を表示できる。
ipynb
は以下のリンクを参照。
%lsmagic
はIPythonの対話型コンソールでも使える。
In [1]: %lsmagic
Out[1]:
Available line magics:
%alias %alias_magic %autocall %autoindent %automagic %bookmark %cat %cd %clear %colors %config %cp %cpaste %debug %dhist %dirs %doctest_mode %ed %edit %env %gui %hist %history %killbgscripts %ldir %less %lf %lk %ll %load %load_ext %loadpy %logoff %logon %logstart %logstate %logstop %ls %lsmagic %lx %macro %magic %man %matplotlib %mkdir %more %mv %notebook %page %paste %pastebin %pdb %pdef %pdoc %pfile %pinfo %pinfo2 %popd %pprint %precision %profile %prun %psearch %psource %pushd %pwd %pycat %pylab %quickref %recall %rehashx %reload_ext %rep %rerun %reset %reset_selective %rm %rmdir %run %save %sc %set_env %store %sx %system %tb %time %timeit %unalias %unload_ext %who %who_ls %whos %xdel %xmode
Available cell magics:
%%! %%HTML %%SVG %%bash %%capture %%debug %%file %%html %%javascript %%js %%latex %%markdown %%perl %%prun %%pypy %%python %%python2 %%python3 %%ruby %%script %%sh %%svg %%sx %%system %%time %%timeit %%writefile
Automagic is ON, % prefix IS NOT needed for line magics.
各マジックコマンドの詳細をJupyter Notebook内で確認
各マジックコマンドの詳細も、上記Web上のドキュメントだけでなく、Jupyter NotebookやIPythonの対話型コンソールの中で確認できる。
?と??
マジックコマンドの末尾に?
をつけて実行するとそのコマンドのdocstringが表示される。??
をつけるとそのコマンドのソースコードが表示される。
この方法はIPythonの対話型コンソールでも使える。
In [1]: %lsmagic?
Docstring: List currently available magic functions.
File: /usr/local/lib/python3.7/site-packages/IPython/core/magics/basic.py
In [2]: %lsmagic??
Source:
@line_magic
def lsmagic(self, parameter_s=''):
"""List currently available magic functions."""
return MagicsDisplay(self.shell.magics_manager, ignore=[self.pip])
File: /usr/local/lib/python3.7/site-packages/IPython/core/magics/basic.py
キーボードショートカット: shift + TAB
Jupyter Notebookでは、入力セルで該当のマジックコマンドにカーソル(キャレット)を合わせた状態で shift + TAB
を押すと、docstringがツールチップで表示される。
shift
を押したままさらにTAB
を押す(shift
を押しながらTAB
を2回押す)と詳細内容表示になる。
マウスポインタではなくキャレット(縦棒)を合わせる必要があるので注意。