如何在jupyter中定义自定义魔术?


问题内容

我正在使用Ubuntu 14.04 LTSAnaconda python安装:

Python 3.5.1 :: Anaconda 2.4.1(64位)

我正在尝试使用此食谱在我的ipython笔记本中启用C ++交互式编译:

import IPython.core.magic as ipym

@ipym.magics_class
class CppMagics(ipym.Magics):
    @ipym.cell_magic
    def cpp(self, line, cell=None):
        """Compile, execute C++ code, and return the standard output."""
        # Define the source and executable filenames.
        source_filename = 'temp.cpp'
        program_filename = 'temp.exe'
        # Write the code contained in the cell to the C++ file.
        with open(source_filename, 'w') as f:
            f.write(cell)
        # Compile the C++ code into an executable.
        compile = self.shell.getoutput("g++ {0:s} -o {1:s}".format(
            source_filename, program_filename))
        # Execute the executable and return the output.
        output = self.shell.getoutput(program_filename)
        return output

def load_ipython_extension(ipython):
    ipython.register_magics(CppMagics)

当我使用以下命令执行单元格时,是否用ipython notebokjupyter notebook(我相信第一个别名还是第二个别名)启动笔记本?

%load_ext cppmagic

我收到以下错误:

---------------------------------------------------------------------------
ImportError                               Traceback (most recent call last)
<ipython-input-1-7b90c7a2b808> in <module>()
----> 1 get_ipython().magic('load_ext cppmagic')

/home/norah/anaconda3/lib/python3.5/site-packages/IPython/core/interactiveshell.py in magic(self, arg_s)
   2334         magic_name, _, magic_arg_s = arg_s.partition(' ')
   2335         magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
-> 2336         return self.run_line_magic(magic_name, magic_arg_s)
   2337 
   2338     #-------------------------------------------------------------------------

/home/norah/anaconda3/lib/python3.5/site-packages/IPython/core/interactiveshell.py in run_line_magic(self, magic_name, line)
   2255                 kwargs['local_ns'] = sys._getframe(stack_depth).f_locals
   2256             with self.builtin_trap:
-> 2257                 result = fn(*args,**kwargs)
   2258             return result
   2259

/home/norah/anaconda3/lib/python3.5/site-packages/IPython/core/magics/extension.py in load_ext(self, module_str)

/home/norah/anaconda3/lib/python3.5/site-packages/IPython/core/magic.py in <lambda>(f, *a, **k)
    191     # but it's overkill for just that one bit of state.
    192     def magic_deco(arg):
--> 193         call = lambda f, *a, **k: f(*a, **k)
    194 
    195         if callable(arg):

/home/norah/anaconda3/lib/python3.5/site-packages/IPython/core/magics/extension.py in load_ext(self, module_str)
     64         if not module_str:
     65             raise UsageError('Missing module name.')
---> 66         res = self.shell.extension_manager.load_extension(module_str)
     67 
     68         if res == 'already loaded':

/home/norah/anaconda3/lib/python3.5/site-packages/IPython/core/extensions.py in load_extension(self, module_str)
     87             if module_str not in sys.modules:
     88                 with prepended_to_syspath(self.ipython_extension_dir):
---> 89                     __import__(module_str)
     90             mod = sys.modules[module_str]
     91             if self._call_load_ipython_extension(mod):

ImportError: No module named 'cppmagic'

食谱中的代码似乎与我将其放在以下目录中的官方文档(两者都使用IPython.core.magic.magics_class)一致cppmagic.py

〜/ .ipython / profile_default /启动

使其在笔记本启动时自动加载,但我无法感受到魔力。有人可以帮忙吗?


问题答案:

这里有两件事:

  1. 启动文件脚本~/.ipython/profile_[name]/startup,作为启动IPython中的一部分被执行。就像您%run在第一个In[1]提示之前一样将它们视为。无法导入启动文件,因为它们不在上sys.path
  2. 扩展 是可以导入并定义load_ipython_extension函数的Python模块。您可以放入扩展名,~/.ipython/extensions这些扩展名将是可导入的,也可以使用来将其安装为常规软件包pip

第一个解决方法是你移动cppmagics~/.ipython/extensions或一些site-packages目录,使其可导入。

如果您确实希望%load_ext cppmagic魔术总是注册(而不是调用),则可以将其保留为启动文件,并在脚本末尾注册魔术,而不是def load_ipython_extension

if __name__ == '__main__':
    from IPython import get_ipython
    get_ipython().register_magics(CppMagics)