1) “import X” VS "from X import Y”
我们有 2 个文件:运行的 main.py 和导入的 helper.py。
这里有两种主要的导入方式:
以及
两种方法都有效,各有利弊:
在 from helper import testfunc
中,我们只需键入 testfunc()
就可以使用它,而在 import helper
中,我们需要键入 helper.testfunc()
。
不过,在更大、更复杂的应用程序中, from helper import testfunc
更有可能导致命名空间冲突,即意外覆盖另一个同名函数/变量。
相反, import helper
不会意外覆盖另一个名称为 testfunc
的函数/变量,因为它是有命名空间的( helper.testfunc
)。
2) “from X import Y“ VS ”from X import *"
from helper import testfunc
只导入 testfunc 函数。
from helper import *
导入 helper.py 中的所有内容
虽然 from helper import *
一开始可能看起来更方便,但它实际上是一种不好的做法。
当我们使用 from helper import *
时,我们会从 helper.py 导入所有内容,这也意味着一些导入的函数/变量可能会意外地覆盖现有的同名函数/变量。
因此,更好的做法通常是明确说明我们要导入的内容,而不是在文件中导入所有内容。
3) import 用于动态导入
这样我们就可以使用字符串动态导入模块。
4) sys.path 和导入内容的位置
当我们导入东西时,Python 有一个要搜索的文件夹列表。
我们可以通过打印 sys.path 来查看这个文件夹列表。
当我们导入 pandas 时,Python 会尝试在第一个文件夹 /Users/me/Documents/test
中找到 pandas。
如果第一个文件夹中存在 pandas,Python 就会直接从这里导入 pandas。否则,Python 将转到下一个文件夹 /some/other/path
,并尝试从那里导入 pandas。
如此反复,直到没有文件夹可供 Python 搜索。当这种情况发生时,我们会得到一个 ImportError
5) 可以手动向 sys.path 添加内容
sys.path 是一个普通的字符串列表。Python 只是碰巧从 sys.path 中的路径搜索模块。
假设我们需要从 /some/weird/path/test.py
导入某个函数
而我们正在使用 /our/main/path/main.py
一个完全不同的路径。
因此,我们只需在 sys.path 中添加 /some/weird/path
,这样 Python 就会知道我们希望从 /some/weird/path
这个位置进行搜索。
将 some/weird/path
添加到 sys.path 之后,我们就可以从该目录导入了。
6) PEP8 的导入顺序
PEP8 (Python Enhancement Proposal 8) 是一份说明 Python 代码风格最佳实践的文档。
链接:https://peps.python.org/pep-0008/
关于导入,最好这样排序:
标准库导入,例如 os, sys, json, re 2. 相关的第三方导入,如 pandas、numpy、fastapi 3. 本地库特定导入,如 our_custom_modules
记得在每组导入之间添加一个换行符,以提高可读性
注意: Python 并不强制这样做
7) __all__
和从文件导出
特殊的 __all__
变量控制着从文件导入的内容。
我们有两个文件:main.py 和 helper.py,main.py 从 helper.py 导入。
helper.py包含许多函数,但它有一个__all__
变量。
在这里,__all__
变量的作用是,当我们执行 from helper import
时,只有 hello 和 hi 被导出。
在这里,由于 hello.py 只导出了 hello 和 hi,因此 main.py 只导入了 hello 和 hi.
这意味着 hola 和 nihao 不会被导入。
因此,__all__
变量可以用来限制 Python 模块中导出的内容,如果我们的模块很杂乱,包含很多变量,这个变量就特别有用。
8) 在 “from X import” 过程中,不导入以 _ 开头的变量。
我们有 2 个文件:main.py 和 helper.py,main.py 从 helper.py 导入。
在 helper.py 中,我们有 2 个普通函数和 2 个名称以下划线 _ 开头的函数。
而当我们执行 “from helper import *
” 时, 以下划线 _ 开头的变量/函数不会被导入。时,以下划线 _ 开头的变量/函数不会被导入。
9) PYTHONPATH 环境变量
PYTHONPATH是一个环境变量,我们可以选择是否定义它。如果我们定义了它,PYTHONPATH 会自动添加到 sys.path 中。
在下面的示例中,我们没有定义PYTHONPATH:
在下一个示例中,我们将PYTHONPATH 设置为 /some/funny/path
因此, /some/funny/path
会自动添加到 sys.path 中,我们可以观察到这一点。现在,当我们在 Python 中导入东西时,Python 也会自动搜索我们的 PYTHONPATH。
如果我们想从其他路径导入模块,但又不想将我们的当前目录与该位置关联起来,这就很有用了。
10) 在导入时使用 '__name__'
是 Python 中的另一个特殊变量。'__name__'
当我们直接运行一个文件时,__name__
默认为字符串值*'__main__'
*。
相反,导入文件中的 __name__
并不是 '__main__'
,而是 Python 文件的名称。
在这里,我们直接运行 a.py。因此,a.py 中的 '__name__'
默认为 __main__
。
b.py 和 c.py 不会直接运行。相反,我们从它们中导入。因此,b.py 中的 '__name__'
只是 b, 而 c.py 中的 '__name__'
只是 c
这就是为什么我们经常在 Python 代码中看到 if __name__ == '__main__'
这是为了确保只有在我们直接运行这个特定的 Python 文件时,这个代码块中的内容才会运行。