在 python 中以正确的方式从子包内部调用函数

Question

我一直在努力了解如何从 python 中的子包中正确调用函数。我希望能够以我调用的方式调用该函数，例如，os 包中的函数 isfile，使用 os.path.isfile()。我制作了一个结构如下的测试包：

sandbox/
    -- __init__.py
    -- acid.py
    -- pack1/
        -- __init__.py
        -- fly/
            -- __init__.py
            -- plane.py
        -- by/
    -- pack2/

那里只有两个模块，acid.py 和 plane.py。它们都只包含一个函数，例如plane.py 是

"""plane module"""
def plane(x):
    x=x+4
    return x

要在我的 test.py 代码中使用该函数，我将

import pack1

在sandbox/__init__.py

import fly

在 sandbox/pack1/__init__.py 和

from plane import plane

在sandbox/pack1/fly/__init__.py

当时的测试代码是：

import sandbox
print sandbox.pack1.fly.plane(3)

这是从子包中导入函数的正确方法吗，还是我误解了什么？

Answer 1

你所做的确实有效，尽管有一些值得做出的改变。

首先，关于从包中导入的注意事项：导入模块在语义上不同于访问模块中的某些内容，尽管 from xml import sax 和 from datetime import date 在语法上是等价的。不可能只导入一个模块的部分，所以

import datetime
datetime.date.today()  # OK: date is a class

保证有效。但是，可以导入一个包而不是它包含的模块。这对效率来说是件好事，但确实意味着

import xml
xml.sax.parse(...)     # AttributeError: 'module' object has no attribute 'sax'

是一个错误。不幸的是，此类错误通常未被捕获，因为一些其他代码已经导入 sax，使其可用于导入 xml 的任何其他代码。（from xml import sax 中的 "from" 一词指的是磁盘上的完整包，而不是模块对象 xml — 它存储新模块作为属性！）

顺便说一句，请注意您的 os.path 示例是一个偏差：写作

    import os
    os.path.isfile(...)

有效，但这只是因为 os.path 实际上不是一个模块，而是 posixpath、ntpath、等之一的别名。（然后它被安装在 sys.modules 到 allow import os.path 就好像它是一个普通模块一样。）

因此，对于一个包，有一组 public 模块 用户必须知道（因为它们必须按名称导入才能使用);其余的是 内部模块 包在必要时自行加载。如果一个包不包含 public 模块，那么它是一个包与用户无关（例如，importlib 及其 one public function 实际上是作为一个包实现的，以便与 Python 3).

现在提出建议：

隐式相对导入是 deprecated：例如，在 sandbox/__init__.py 中写 from . import pack1 而不是 import pack1。
from plane import plane（或 from .plane import plane，遵循上述观点）是有问题的，因为它覆盖对模块 plane.py 的引用对函数的引用。反而：
1. 直接在他们的包 __init__.py 中定义用户可见的入口点（如 plane()），根据需要从私有模块导入内部函数，或
2. 重命名模块（至 plane_module.py 左右）以避免冲突。
然而，让一个包自动导入它的 public 模块通常不是一个好主意：它迫使客户为加载包中未使用的部分付费，并且它模糊了public 模块和简单嵌套名称之间的区别。相反，编写客户端代码
```
import sandbox.pack1.fly
print sandbox.pack1.fly.plane(3)    # the same line you had
```
或
```
from sandbox.pack1 import fly
print fly.plane(3)
```
如果你想避免重复sandbox.pack1.
通常建议 __init__.py 完全为空，在 Python 3.3 中可以定义完全没有任何 __init__.py 的包（通过必要性 "makes it empty"）。此策略比 "no automatic import" 建议更有效，因为它排除了从私有模块（如 plane）加载内容。

有时有充分的理由让非空 __init__.py；例如，它允许在不破坏其客户端的情况下将现有模块重组为一个包。我个人认为没有理由特别限制其内容；如需进一步讨论，请参阅 What is __init__.py for?.

Answer 2

init.py 文件将一个文件夹作为一个包，以便您可以将其导入到 python 提示符。如果您只想从文件 plane.py 调用函数 "plane"，请将 plane.py 文件的绝对路径添加到您的 PYTHONPATH 并调用函数，如下所示。

>>> import sys
>>> sys.path.append("D:\sandbox\pack1\fly")
>>> import plane
>>> print plane.__doc__
plane module
>>> print plane.plane(3)
7

如果你想在脚本中使用 "sandbox" 文件夹下的所有包，只需将 "sandbox" 文件夹的绝对路径添加到你的 PYTHONPATH 并调用函数，如下所示。

>>> import sys
>>> sys.path.append("D:\")
>>> from sandbox.pack1.fly import plane
>>> print plane.plane(3)
7

您也可以导入"plane.py"模块并调用函数"plane"，如下所示：

>>> import sys
>>> sys.path.append("D:\")
>>> import sandbox.pack1.fly.plane
>>> print sandbox.pack1.fly.plane.plane(3)
7

在 python 中以正确的方式从子包内部调用函数

Calling a function from inside a sub-package the correct way in python

packages

python-2.7