一、什么是包
官网解释
Packages are a way of structuring Python’s module namespace by using “dotted module names”
包是一种通过使用‘.模块名’来组织python模块名称空间的方式
具体的:包就是一个含有__init__.py文件的文件夹,所以我们创建包的目的就是为了用文件夹将模块组织起来,方便开发者进行维护管理
需要强调的是：
1. 在python3中，即使包下没有__init__.py文件，import 包仍然不会报错，而在python2中，包下一定要有该文件，否则import 包报错
2. 创建包的目的不是为了运行，而是被导入使用，包里面的py文件除了开发者在测试的时候需要右键运行外,其他任何时候都不会有右键运行的需求.另外，包只是模块的一种形式而已，包的本质就是一种模块(通俗来讲包就是一个文件夹,这个文件夹里边放了很多个模块,使用包将这些文件组织起来便于管理,创建包的时候回有一个__init__.py这样一个文件,这个文件中不应该输入逻辑代码,而要在里边将包中的模块一一进行导入,方便后边进行调用.因为调用包的时候就相当于直接运行包下面的__init__.py文件从里边获得需要的名称放入为包创建的名称空间.文章后边会有对__init__有一个详细的介绍)
二、为什么要使用包
包的本质就是一个文件夹，那么文件夹唯一的功能就是将文件组织起来
随着功能越写越多，我们无法将所有功能都放到一个文件中，于是我们使用模块去组织功能，而随着模块越来越多，我们就需要用文件夹将模块文件组织起来，以此来提高程序的结构性和可维护性,方便程序员对自己开发的包进行维护和管理.
三、怎么使用包
3.1包的导入
进行包的导入的时候,和模块相似也发生三个事情:
1 产生一个包的名称空间
2 执行包下的__init__.py文件，将产生的名字存放于包的名称空间中
3 在当前执行文件中拿到一个名字(这个名字时在执行文件的名称空间中但是改名字具体的值或者内存地址是指向名字来源的包的名称空间的)，该名字指向包的名称空间
使用包和使用模块的方式差不多,都需要在执行文件中进行导入,包的导入也分两种import 和 from...import...
1.关于包相关的导入语句也分为import和from ... import ...两种，但是无论哪种，无论在什么位置，在导入时都必须遵循一个原则：凡是在导入时带点的，点的左边都必须是一个包，否则非法。可以带有一连串的点，如item.subitem.subsubitem,但都必须遵循这个原则(也就是说item和subitem都必须也是包才可以正常导入)。但导入后，再用时就没有这种限制了，点的左边可以是包,模块，函数，类(它们都可以用点的方式调用自己的属性)。在本文后边相对导入和绝对导入中有详细的介绍.
2、import导入文件时，产生名称空间中的名字来源于文件，import 包时，产生的名称空间的名字同样来源于文件，即包下的__init__.py，导入包本质就是在导入该文件
3、包A和包B下有同名模块也不会冲突，如A.a与B.a来自俩个命名空间
这里说明一下在包的文件下的__init__.py文件的作用:
首先要明白在包导入的时候发生了什么事情:
1.创建一个名称空间
2.执行包文件中的代码(其实就是执行__init__.py文件中的代码,将文件中的名称放到创建好的名称空间中)
3.在执行文件中产生一个名称指向包的名称空间
在导入包时,实际上执行的就是这个__init__.py文件
这样规定的好处:
我们可以使用__init__.py来把一个文件夹''变成''一个模块,这个模块的种类是包,通常情况下,一个包中有多个模块,并且这些模块经常会被同时被导入使用,这个时候就可以在__init__.py文件中将需要的模块一次性导入,当外界在使用这个包的时候,就无需再挨个导入了
总之:__init__.py文件的作用是初始化包,初始化其实就是将包中需要提供给外界的模块统一导入,打包在一起,用户导入了包,就可以使用所有的功能
需要注意的是:__init__.py文件导入包中的模块文件时,有误是作为模块导入的,所以在sys.path中并不包含模块所在的目录,所以在执行文件中导入使用的时候,要指定包名:(sys.path中只有当前执行文件的路径,和系统默认的几个路径,其他的都没有,需要的时候可以自行添加)
pack包下的init
from pack import module
import pack.module另外:__init__.py文件在python2 中是必须要有的,没有的话在import的时候程序会进行报错,但是在python3中是可选的,有没有都可以,但是建议一般都要有,这样程序会比较规范
3.2包的导入之import
单独导入包的名称时不会导入包中所含的所有子模块(在报的__init__.py中没有进行设置的前提下),如:
#在与glance同级的test.py中
import glance
glance.cmd.manage.main()
'''
执行结果：
AttributeError: module 'glance' has no attribute 'cmd'
'''解决办法:
#glance/__init__.py
from . import cmd
#glance/cmd/__init__.py
from . import manage3.3包的导入之from...import...
需要注意的是from后import导入的模块,必须是明确的一个不能带点的名称,否则会有语法错误,例如:from a import b.c(在这里违背了包导入时的原则)
正确的导入方式:
from glance.db import models
models.register_models('mysql')
from glance.db.models import register_models
register_models('mysql')3.4 from glance.api import *
在讲模块的时候,可以使用这种办法来导入模块中的所有名称,在这里讨论一下使用这种办法尝试导入包中的所有
在这里是想从包api中导入所有,实际上该语句只会导入包api下__init__.py文件中定义的名字,同样也可以使用__all__来定义导入所有时导入的名称
#在__init__.py中定义
x=10
def func():
print('from api.__init.py')
__all__=['x','func','policy']例子:
执行文件中想要使用的效果如下:
from glance import *
get()
create_resource('a.conf')
main()
register_models('mysql')这时在glance包中的__init__文件中应该定义:
#在glance.__init__.py中
from .api.policy import get
from .api.versions import create_resource
from .cmd.manage import main
from .db.models import register_models
__all__=['get','create_resource','main','register_models']这样定义之后,再调用包是就会直接将对应模块中的功能名称拿过来直接使用了,并且也不要加前缀
四、包的嵌套:
包的嵌套的定义:包中有包
一般情况下,在一个包中除了__init__.py文件外,都是一个个模块,在python中包也是可以像函数一样进行嵌套
要使用子包中模块的内容和使用包的方法是一致 的,在子包中的__init__.py文件中导入需要的内容,但是注意,不管是不是子包,包都是作为模块导入可执行文件的,所以在sys.path中肯定不包含子包路径,在导入使用的时候需要从可执行文件目录往下进行寻找,意思就是在子包的__init__.py文件中导入子包中的模块时不能从子包的路径往下找,而是需要从可执行文件所在的路径往下找.例如:
导入subpack包下的__init__.py文件
subpack(子包) 包下 init文件中在导入的时候
import pack.subpack.module4
也可以使用from来导入:
语法: from pack.suback import modules4包的终极奥义就是把一堆的模块中的功能集合到文件中,方便开发者管理,同时也提升了用户的调用体验
五、相对导入和绝对导入
相对导入:使用相对导入来简化书写并提高代码的可修改性)
相对导入使用时，一个.表示在当前包的目录下导入,两个..表示往上两个层级
即一个点表示当前操作的文件所在的文件目录,两个点表示往上一级的文件目录,以此类推
注意:相对导入仅能用于模块之间互相导入,不能用于执行文件中
在创建包的时候,在包的内部不管是在子包中还是包中各模块的互相调用,都尽量使用相对导入,防止后面如果包的名字需要变动的话,所有的调用地方都需要修改,那样将会非常的麻烦,在这里说道了包和模块的名字,在python3后边同意使用纯小写的字母或单词命名
绝对导入:按照名字从可执行文件一层一层的往下需要的模块
绝对导入时可能会出现的错误提示:
1.绝对导入时没有从执行文件目录开始
2.在执行文件中使用了相对导入
3跳出顶层包
顶层包指的是在你存放所有模块和子包的那个文件夹,成为顶层包
例如:
在glance/api/version.py
#绝对导入
from glance.cmd import manage
manage.main()
#相对导入
from ..cmd import manage
manage.main()绝对导入与相对导入总结:
绝对导入: 以执行文件的sys.path为起始点开始导入,称之为绝对导入
优点: 执行文件与被导入的模块中都可以使用
缺点: 所有导入都是以sys.path为起始点,导入麻烦
相对导入: 参照当前所在文件的文件夹为起始开始查找,称之为相对导入
符号: 一个.代表当前操作文件所在的文件夹,两个..代表上一级文件夹,三个点...代表上一级的上一级文件夹
优点: 导入更加简单
缺点: 只能在导入包中的模块时才能使用,不能再包外边的文件中使用
注意:
1. 相对导入只能用于包内部模块之间的相互导入,导入者与被导入者都必须存在于一个包内
2. attempted relative import beyond top-level package # 试图在顶级包之外使用相对导入是错误的,言外之意,必须在顶 级包内使用相对导入,每增加一个.代表跳到上一级文件夹,而上一级不应该超出顶级包
5.2包以及包所包含的模块都是用来被导入的，而不是被直接执行的。而环境变量都是以执行文件为准的
比如:我们想在glance/api/versions.py中导入glance/api/policy.py,不能一看这两个模块在同一个目录下,就直接去调用:
1 #在version.py中
2
3 import policy
4 policy.get()这样写的话,单独运行versions.py是没有问题的,运行version.py的路径搜索就是从当前路径开始的,于是在导入police时能在当前目录下找到,但是如果子包中的模块version.py极有可能是被一个glance包同一级别的其他文件导入使用的,比如我们在这里测试一下,在于glance同级的test.py文件中导入version.py
from glance.api import versions
'''
执行结果:
ImportError: No module named 'policy'
'''
'''
分析:
此时我们导入versions在versions.py中执行
import policy需要找从sys.path也就是从当前目录找policy.py,
这必然是找不到的
'''总之在模块中进行其他模块的导入和常见包的时候需要注意的问题:
首先要明白执行文件是哪个,方便确定到底是哪个文件路径在sys.path中
1.在包的内部进行模块互导时,使用相对导入,同时遵循相对导入的原则,在当前操作文件中进行其他导入模块或者子包中的模块时,都从当前文件所在的目录开始一级一级的往上找,但是要记住上一级不能超出顶级包的范围
2.在包外面的文件中中进行模块的导入的时候不能使用相对导入的方法,只能使用绝对导入的方法进行导入
3.确定调用的包所在的文件目录,如果不在sys.path中,需要自行使用sys.path.append(包所在的文件目录路径)将包所在的文件夹路径添加到sys.path中这样使用第三方软件的时候和使用自定义模块和包的时候才不会出现调用错误