前言
Python/ target=_blank class=infotextkey>Python作为一个解释器,一个程序,如果不导入任何外部模块或包,就做不了什么。理解Python如何导入模块和包将在几乎所有的场景中都很有帮助。
本文中的所有代码都是在linux(Ubuntu)中应用和测试的,windows和macOS应该(希望)是类似的。
PART 01
当PIP安装一个包时会发生什么
当我们使用pip安装包时:
pip install <pkg_name>
包进入系统范围的文件夹
/home/<user_name>/.local/lib/python3.x/site-packages
这里的“系统范围”是指所有Python程序都可以访问已安装的软件包。
从哪里进口(import)
当使用import关键字导入包时,Python会循环sys. path中的路径列表。加载它的路径。
运行这个,查看路径列表:
import sys
print(sys.path)
这是我的。你的应该类似:
['', '/usr/lib/python36.zip', '/usr/lib/python3.6', '/usr/lib/python3.6/lib-dynload', '/home/andrewzhu/.local/lib/python3.6/site-packages', '/usr/local/lib/python3.6/dist-packages', '/usr/lib/python3/dist-packages', '/usr/lib/python3.6/dist-packages']
第一个空的"表示当前文件夹,因此Python运行时(或import关键字)可以访问位于运行Python脚本的同一文件夹中的任何包。
通过了解这一点,下次如果您想部署一个定制包,而不是从pip或condo。你从Github上窃取/抓取的东西,想让所有Python程序都能访问它,不管它位于哪里。你知道把包裹放在哪里。
顺便说一下,要获取当前目录路径,请运行:
import os
print(os.getcwd())
PART 02
导入模块的最佳方法是什么
正如Python的禅宗所说:“显式比隐式好”。如果你给一些东西命名,比如i, td,几周后,即使是你,这个程序的作者也不明白这些变量的含义。
所以,
规则1:明确。
Python作为一种脚本语言已经相对较慢了,为了使你的程序更快,需要加载模块。
规则2:只需要导入。
如果您正在编写一个可能被其他程序调用的程序,请注意命名冲突。其他可能在下游程序中给出相同的名称,并且可能会受到“类型错误异常”的欢迎。
规则3:取正确的名字。
您可能会看到下面列出的许多导入样式,但是哪一种是最好的,哪一种应该避免?
# style 1
import a_package
# or style 2
import a_package as p
# or style 3
from a_package import a_item
# or style 4
from a_package import *
# or style 5
from a_package import a_item as my_item
样式1是可以的,但是它将导入这个包中的所有模块,在导入datetime的情况下。当你想要获得当前时间时,代码会像这样形成:
import datetime
now_time = datetime.datetime.now()
注意,有双日期时间,如果您正在阅读一个很长的代码文件,每当您看到日期时间,将使您认为它是哪个日期时间,它是一个模块或包?
样式2将在某种程度上解决这个问题,你可以给datetime一个新的名称,也许是一个唯一的名称,像这样:
import datetime as az_datetime_pkg
now_time = az_datetime_pkg.datetime.now()
az_的意思是,它来自Andrew Zhu, _pkg表示它是从某处导入的包。但是,每次都输入包名是很繁琐的。
样式3解决了繁琐的问题,通过从…import…样式,你可以直接调用函数。
from datetime import datetime
now_time = datetime.now()
如果你想尽量避免命名冲突,请使用样式5。
from datetime import datetime as pkg_datetime_module
now_time = pkg_datetime_module.now()
风格4 ?永远不要使用import *样式。因为样式4打破了上面列出的3个规则。
如果您计划构建一个供其他人使用的包,那么有一种方法可以减轻import *事故。
使用__all__。这是一个例子。在你的模块中。
__all__ = ['pub_fun1','pub_fun2']
def pub_fun1:
return 'hey, this is pub_function1'
def pub_fun2:
return 'hey, this is pub_function2'
def pub_fun3:
return 'sorry, this function is private'
通过这种方式,即使模块用户通过import *调用您的包,也只有pub_fun1和pub_fun2会被通配符导入。Pub_fun3将对调用者保密。
如果你的同事固执地坚持使用import *,你可以把下面他们import *的True和False颠倒过来,来说服他们:
False, True = True, False # works only in python 2.x
Python会颠倒True和False的含义,这就是为什么我们在命名和导入模块时需要小心的原因。
PART 03
检查导入的模块
当你导入一个模块时,你如何知道这个模块的内部?当然,您可以查看文档,但如果您很懒,不想启动无聊的文档怎么办?Python提供了一种方便的方式来实现这一点。它是函数dir()。这个内置函数返回目标对象的第一层名称列表。
比方说,您导入了math模块。
import math
查看math模块中有哪些函数。
dir(math)
您将看到一个可供调用的变量和函数列表。
现在运行不带参数的dir()函数,看看当前模块中包含了什么。
dir()
您将在结果列表中看到导入的数学
[
...,
math,
...
]
还有一件事,如果您想删除现有的模块,可以使用del来删除它。这里,让我们从当前运行的程序中删除数学。
del math
使用dir()进行检查,数学就消失了。
PART 04
创建自己的Python包
在Python中,Function是变量和表达式的容器;类是函数、变量的容器;Module大致表示一个Python脚本文件,它是类、函数、表达式和变量的容器。Package是一个管理Python模块的解决方案。一个包是一个特殊的文件夹,包含多个模块和一个附加的__init__.py文件。
下面是一个示例包结构。如果使用Python 3.3+,可以省略__init__.py文件
py_package/
- __init__.py
- module1.py
- module2.py
在py_package文件夹内,创建两个名为module1.py和module2.py的文件。
在module1.py文件中,给出如下代码,在module2.py文件中,放入你喜欢的任何代码。
# module1.py file
__all__ = ["module1_pub_func"]
def module1_pub_func():
print('hey, this is a public function from module1')
def module1_pri_func():
print("hey, this is a private function from module1")
现在,在py_package文件夹所在的同一个文件夹中,放置test.py文件。
- py_package/
- ...
- test.py
在test.py文件中,调用新的烘培包。
from py_package.module1 import *
module1_pub_func()
module1_pri_func()
你会得到这样的结果,这里的错误消息是预期的,因为在你的__all__变量中,你只允许pub func被调用。
hey, this is a public function from module1
---------------------------------------------------------------------------
NameError Traceback (most recent call last)
~/az_git_folder/azcode/aznote/python/py_create_package/test.py in
2 from py_package.module1 import *
3 module1_pub_func()
----> 4 module1_pri_func()
NameError: name 'module1_pri_func' is not defined
请注意,使用下面所示的代码导入包是行不通的。谷歌不会告诉你很多,但如果你不知道这个错误,可能会困惑你一段时间。
# import the new created package won't works. don't do it.
import py_package import *
# or
import py_package
要调用这个包,您需要显式地包含module1关键字。
还有一件事要提。每个Python模块/程序都定义了一个__name__变量。如果该模块/程序是Python执行入口,则__name__将被分配给"__main__"。因此,我们可以使用__name__来检测程序是否直接执行或是否从其他程序中导入。在设计自定义包时特别有用。
if __name__ == '__main__':
print('running by myself')
else:
print('I am being imported from other module')