导入模块时隐藏外部模块（例如关于代码完成）

Question

我在一个包（一种工具包）中有几个模块，我在我的项目中使用它们。结构如下：

the_toolkit:
    __init__.py
    basic_io.py
    simple_math.py
    matrix_kit.py
    ...

现在当我从包中导入模块后使用IPython 或VIM 中的代码完成

from the_toolkit import matrix_kit

我得到了一堆 matrix_kit.py 导入的模块/函数（array、math、log、loggin、format_exc 等），以及 matrix_kit 的实际函数定义。 我如何过滤掉其他所有内容，因为我对 math 或 array 对 matrix_kit 模块的代码完成不感兴趣？

__init__.py 是空的，正如许多 pythonistas 所建议的那样，还是这样做的方式？

Answer 1

我遇到了同样的问题，并通过在我的所有导入中添加前导下划线来解决它。它看起来并不出色，但它实现了你所追求的。

from __future__ import division as _division
import numpy as _np
import pandas as _pd

当您使用 from .. import * 导入模块时，只会导入不带下划线开头的内容。或者当您在 IPython 或 spyder 中使用制表符完成时。

Answer 2

我开始喜欢并使用这种方法。从您的项目结构开始，我们将隐藏matrix_kit 中您不想显示的所有内容。

the_toolkit:
    __init__.py
    basic_io.py
    simple_math.py
    matrix_kit.py
    ...

将matrix_kit.py移动到同名包中，并在模块名称的开头加一个下划线：

the_toolkit:
    __init__.py
    basic_io.py
    simple_math.py
    matrix_kit:
        __init__.py
        _matrix_kit.py
    ...

现在在_matrix_kit.py 中添加一个全局变量__all__ = [...]，列出您希望显示的所有函数/类/变量的名称。然后，将以下行添加到matrix_kit/__init__.py：

from ._matrix_kit import *

它只会导入模块的__all__ 属性中列出的内容。然后，在像以前一样导入matrix_kit 时，您实际上将导入__init__.py 及其内容。

Answer 3

我想出的另一种解决方案是在__init__ 文件中实现一个简短的API 类，该类可以利用__all__ 变量（可能已经为import * 目的而定义）。 __init__.py 中的类似内容：

import matrix_kit

class _matrix_kit_API:
    def __init__(self):
        for func in matrix_kit.__all__:
            setattr(self, func, eval(f"matrix_kit.{func}"))

matrix_kit = _matrix_kit_API()

Answer 4

你可能会从__all__获得一些里程