如何在Jupyter Notebook中实现类似code.interact的本地函数注入？

针对你想要在Jupyter Notebook中把核心函数注入到交互会话命名空间，同时避免修改全局builtins、减少用户操作的需求，这里有几个贴合IPython/Jupyter生态的最优方案：

方案1：自动检测IPython环境并注入（推荐，零额外用户操作） #

Jupyter基于IPython运行，我们可以在库的初始化逻辑里自动检测当前是否处于IPython会话中，如果是，直接把函数注入到IPython的user_ns——这就是Notebook代码单元格使用的命名空间，完全不会影响全局builtins，也不用用户手动写代码。

在你的库中添加这段逻辑：

import sys

def get_my_functions():
    # 这是你原来获取核心函数的逻辑
    return {"my_function": lambda x: x * 2}

def _auto_inject_for_ipython():
    # 检查是否运行在IPython/Jupyter环境中
    if 'ipykernel' in sys.modules:
        try:
            from IPython import get_ipython
            ip = get_ipython()
            if ip is not None:
                # 将函数注入到当前会话的命名空间
                ip.user_ns.update(get_my_functions())
        except ImportError:
            # 非IPython环境，什么都不做
            pass

# 库导入时自动执行检测
_auto_inject_for_ipython()

这样用户只需要在Notebook里执行import your_library，就能直接调用my_function()了，完全不用额外操作，同时高级用户把库作为普通模块导入时也不受任何影响。

方案2：制作IPython扩展（专业长期方案） #

如果你的库是长期维护的，做成IPython扩展会是更专业的选择，用户只需要一行魔术命令就能加载并注入函数。

步骤1：添加扩展入口文件 #

在你的库目录下创建_ipython_extension.py：

from IPython.core.magic import register_line_magic
from your_library import get_my_functions

def load_ipython_extension(ip):
    # 注入函数到会话命名空间
    ip.user_ns.update(get_my_functions())

步骤2：在setup.py中配置扩展 #

修改你的setup.py，添加IPython扩展的入口点：

from setuptools import setup

setup(
    name="your_library",
    # ...其他配置信息
    entry_points={
        'ipython.extensions': [
            'your_library = your_library._ipython_extension:load_ipython_extension',
        ]
    }
)

用户安装库后，在Notebook里只需要运行：

%load_ext your_library

就能直接使用你的核心函数，体验非常顺滑。

方案3：自定义魔术命令（灵活轻量） #

如果不想做完整的扩展，也可以在库中注册一个自定义魔术命令，用户运行后完成注入：

from IPython.core.magic import register_line_magic
from IPython import get_ipython
from your_library import get_my_functions

@register_line_magic
def load_my_funcs(line):
    ip = get_ipython()
    ip.user_ns.update(get_my_functions())

# 可选：让魔术命令可以不用加%前缀直接调用
if get_ipython() is not None:
    get_ipython().register_magic_function(load_my_funcs, magic_kind='line')

用户在Notebook里只需要执行：

%load_my_funcs
# 或者不带%前缀：load_my_funcs

就能完成函数注入，操作简单直观。

为什么这些方案更优？ #

• 完全遵循Python最佳实践，不会修改全局builtins，避免污染全局命名空间
• 用户操作成本极低，要么导入自动生效，要么只需要一行简单命令
• 完美兼容高级用户将库作为普通模块导入使用的场景，不会对他们的工作流造成任何干扰

内容的提问来源于stack exchange，提问作者c z