Python實現自定義Jupyter魔法命令

from IPython.core.magic import (
    magics_class,
    Magics,
    line_magic,
    cell_magic
)


@magics_class
class MagicOrder(Magics):
    """
    自定義一個類，類名叫什麼無所謂
    但要繼承 Magics，並且要被 magics_class 裝飾
    """

    @line_magic
    def hello(self, line):
        """
        在 jupyter 中就可以使用如下命令，比如：
        %hello <Your Code>，然後就會呼叫這個 hello 方法
        引數 line 就是 %hello 後面的程式碼
        """
        print(f"line: {line}")

    @cell_magic
    def world(self, line, cell):
        """
        在 jupyter 中就可以使用如下命令，比如：
        %%world
        <Your Code>
        <Your Code>
        ...

        然後就會呼叫這個 world 方法
        引數 cell 就是 %%world 下面整個單元格的程式碼

        然後還有一個引數 line，它表示 %%world 所在行後面的程式碼
        但對於 %% 開頭的命令來說，我們一般都會新起一行，然後寫程式碼
        所以 line 這個引數暫時用不到
        """
        print(f"line: n{line}")
        print("-----------------")
        print(f"cell: n{cell}")


# 必須定義 load_ipython_extension 函數
# %load_ext 本質上也是載入一個模組
# 但它會自動呼叫該函數
def load_ipython_extension(ip):
    # 在函數內部，我們將類 MagicOrder 註冊進去
    # 然後就可以使用它內部的魔法命令了
    ip.register_magics(MagicOrder)

# 如果不定義此函數，那麼使用 %load_ext 載入時會報錯
# The xxx module is not an IPython extension.

@magics_class
class MagicOrder(Magics):

    @line_magic
    def hello(self, line):
        exec(line)

    @cell_magic
    def world(self, line, cell):
        exec(cell)

from IPython.core.magic import (
    magics_class,
    Magics,
    line_magic,
    cell_magic,
    needs_local_scope
)


@magics_class
class MagicOrder(Magics):

    @line_magic
    def hello(self, line):
        # 通過 self.shell.user_ns
        # 可以拿到當前 shell 的名稱空間
        # 注意：包含所有的單元格
        local_ns = self.shell.user_ns
        # 在 local_ns 當中執行程式碼
        exec(line, local_ns, local_ns)

    @needs_local_scope
    @cell_magic
    def world(self, line, cell, local_ns):
        # 或者通過 needs_local_scope 裝飾器
        # 這樣在呼叫函數的時候，會額外傳遞一個 local_ns 引數
        # 該引數和 self.shell.user_ns 等價
        exec(cell, local_ns, local_ns)

def load_ipython_extension(ip):
    ip.register_magics(MagicOrder)

@magics_class
class MagicOrder(Magics):

    @needs_local_scope
    @line_magic
    def my_time(self, line, local_ns):
        start = time.perf_counter()
        exec(line, local_ns, local_ns)
        end = time.perf_counter()
        print(f"總耗時: {round(end - start, 3)}")

from IPython.core.magic import (
    magics_class,
    Magics,
    cell_magic,
    needs_local_scope
)
from IPython.core import magic_arguments


@magics_class
class MagicOrder(Magics):
    @magic_arguments.magic_arguments()
    # 在 jupyter 中可以通過 -n=xxx 或者 --name=xxx
    # 然後是 dest="name"，用於指定引數的名字
    # 後續便可以通過 name 欄位來獲取該引數的值
    @magic_arguments.argument(
        "-n", "--name", dest="name", default="satori"
    )
    # "-" 和 "--" 可以只出現一個，並且預設解析得到的是字串
    # 而 age 我們希望是整數，所以指定 type 為 int
    # 解析完引數之後，會自動呼叫 int 進行轉化
    # 如果不指定該引數，則使用 default
    # 而這裡沒有 default，那麼結果就是 None
    @magic_arguments.argument(
        "--age", dest="age", type=int
    )
    @magic_arguments.argument(
        "-h", "--hobby", dest="hobby", default=[],
        action="append"
    )
    @needs_local_scope
    @cell_magic
    def order(self, line, cell, local_ns):
        # 顯然 line 就是可選引數，cell 就是程式碼塊
        exec(cell, local_ns, local_ns)
        # 解析引數
        args = magic_arguments.parse_argstring(
            self.order, line)
        # 列印
        print(args)


def load_ipython_extension(ip):
    ip.register_magics(MagicOrder)