Question

在IPython中，为用户定义的对象提供制表符完成相当容易：只需定义一个__dir__方法，该方法返回对象的字符串列表。

IPython还为我们提供了一种使用方便的register_line_magic实用程序定义我们自己的自定义魔术函数的方法。在某些~/.ipython/profile_default/startup/magictest.py中：

from IPython.core.magic import register_line_magic

@register_line_magic
def show(dataType):
    # do something depending on the given `dataType` value

现在我的问题是：如何为这个神奇的功能提供自动完成功能？

根据this email，人们应该查看IPython.core.interactiveshell.InteractiveShell.init_completer()有关魔术函数完成者的示例，例如%reset，＆＃39;％cd＆＃39;等...... < / p>

但是，在与我的魔术功能定义相同的启动文件中，以下代码不起作用：

from IPython.core.interactiveshell import InteractiveShell

def show_complete():
     return ['dbs', 'databases', 'collections']

InteractiveShell._instance.set_hook(
    'complete_command', show_complete, str_key='%show')

在IPython shell中，键入%show TAB不会触发任何内容（函数中的print语句显示甚至没有调用该函数）。

有人可以指出一些关于如何在Ipython启动文件中定义这样的用户魔术命令参数完成的文档或示例吗？

谢谢！

Answer 1

您可以使用：

def load_ipython_extension(ipython):
    def apt_completers(self, event):
        """ This should return a list of strings with possible completions.

        Note that all the included strings that don't start with event.symbol
        are removed, in order to not confuse readline.
        """

        return ['update', 'upgrade', 'install', 'remove']

    ipython.set_hook('complete_command', apt_completers, re_key = '%%apt')

%% apt是神奇的关键字

用户魔术功能的IPython自定义选项卡完成

1 个答案: