模块和包

 

 

阅读目录

一: 模块

二: 包

 

 

模块

 

1.什么是模块

 

同一个模块不会被重复导入
导入模块的顺序:内置>>>需要安装的扩展模块>>>自己写的模块
导入模块的规则:不要在同一行导入多个模块

 

模块就是一个py文件

   常见的场景:一个模块就是一个包含了python定义和声明的文件,文件名就是模块名字加上.py的后缀。

   但其实import加载的模块分为四个通用类别: 

  1 使用python编写的代码(.py文件)

  2 已被编译为共享库或DLL的C或C++扩展

  3 包好一组模块的包

  4 使用C编写并链接到python解释器的内置模块

 

2.模块的命名空间

 

每个模块都是一个独立的名称空间,定义在这个模块中的函数,把这个模块的名称空间当做全局名称空间,这样我们在编写自己的模块时,

就不用担心我们定义在自己模块中全局变量会在被导入时,与使用者的全局变量冲突

#测试一:money与my_module.money不冲突
#demo.py
import my_module
money=10
print(my_module.money)

'''
执行结果:
from the my_module.py
'''

测试一:money与my_module.money不冲突
测试一

 

#测试二:read1与my_module.read1不冲突
#demo.py
import my_module
def read1():
    print('========')
my_module.read1()

'''
执行结果:
from the my_module.py
my_module->read1->money 1000
'''

测试二:read1与my_module.read1不冲突
测试二

 

#测试三:执行my_module.change()操作的全局变量money仍然是my_module中的
#demo.py
import my_module
money=1
my_module.change()
print(money)

'''
执行结果:
from the my_module.py
'''

测试三:执行my_module.change()操作的全局变量money仍然是my_module中的
测试三

 

3.导入方法

 

1. import 模块名  #导入整个模块,使用时  模块名.方法名

2. from 模块名 import 名字  #导入模块中的方法  使用时直接用名字

3.from 模块名 import *  #导入模块中所有内容 , 模块中的名字不要和自己文件中的冲突

4.from 模块名 import 名字 as 重命名 : 如果你导入的模块过大,而你要用的功能很少

 

5.from 模块名 import *  与 __all__ = ['名字', '名字'] 的关联:

在被导入的模块中写上  __all__ = ['名字','名字']  那么用 from 模块名 import * 时,只导入列表中的方法和属性

 

6.一次导入,后面的模块中也可以用这个已经导入的名字

 

 

4.把模块当做脚本执行

 

我们可以通过模块的全局变量__name__来查看模块名:


当做脚本运行:
__name__ 等于'__main__'

当做模块导入:
__name__= 模块名

 

作用:用来控制.py文件在不同的应用场景下执行不同的逻辑
if __name__ == '__main__':

  测试时当做脚本运行时执行

  当做模块导入时就不执行这些

def login():
    print('逻辑')

if __name__ == '__main__':
    login()

#在当做脚本执行时会打印
#在当做模块导入时不会打印,在调用login()时才打印

 

 

 

5.模块搜索路径

sys.modules:查看当前引入的所有模块
sys.path:导入模块的时候依据的路径列表

  在第一次导入某个模块时(比如spam),会先检查该模块是否已经被加载到内存中(当前执行文件的名称空间对应的内存),如果有则直接引用

  如果没有,解释器则会查找同名的內建模块,如果还没有找到就从sys.path给出的目录列表依次寻找spam.py文件。

  所以总结模块的查找顺序是:内存中已经加载的模块->内置模块->sys.path路径中包含的模块

       需要特别注意的是:我们自定义的模块名不应该与系统内置模块重名。虽然每次都说,但是仍然会有人不停的犯错

 

sys.path.append()   添加搜索路径

sys.path.remove()   删除搜索路径

 

在初始化后,python程序可以修改sys.path,路径放到前面的优先于标准库被加载。

1 >>> import sys
2 >>> sys.path.append('/a/b/c/d')
3 >>> sys.path.insert(0,'/x/y/z') #排在前的目录,优先被搜索

注意:搜索时按照sys.path中从左到右的顺序查找,位于前的优先被查找,sys.path中还可能包含.zip归档文件和.egg文件,python会把.zip归档文件当成一个目录去处理。

复制代码
#首先制作归档文件:zip module.zip foo.py bar.py

import sys
sys.path.append('module.zip')
import foo,bar

#也可以使用zip中目录结构的具体位置
sys.path.append('module.zip/lib/python')

#windows下的路径不加r开头,会语法错误
sys.path.insert(0,r'C:\Users\Administrator\PycharmProjects\a')
复制代码

 

至于.egg文件是由setuptools创建的包,这是按照第三方python库和扩展时使用的一种常见格式,.egg文件实际上只是添加了额外元数据(如版本号,依赖项等)的.zip文件。

需要强调的一点是:只能从.zip文件中导入.py,.pyc等文件。使用C编写的共享库和扩展块无法直接从.zip文件中加载(此时setuptools等打包系统有时能提供一种规避方法),且从.zip中加载文件不会创建.pyc或者.pyo文件,因此一定要事先创建他们,来避免加载模块是性能下降。

 

 

6.pyc文件 :python文件的编译文件,在import模块的时候自动生成,可以忽略

 

 

7.补充dir()函数

 

 

内建函数dir是用来查找模块中定义的名字,返回一个有序字符串列表

 

import my_module
dir(my_module)

 

 

 

如果没有参数,dir()列举出当前定义的名字

 


dir()不会列举出内建函数或者变量的名字,它们都被定义到了标准模块builtin中,可以列举出它们,

 

import builtins
dir(builtins)

 

 

 

 

 

 

对于别人写好的包 直接用
如果你自己写包:
--如果模块与模块之间没什么联系:就不用操心绝对路径和相对路径的事儿
--如果包的模块之间存在引用关系:
绝对路径的导入 :导入的路径会随着包与文件之间关系的变化而变化
在包内部、外部都可以执行
相对路径的导入 :一次写好的模块的导入关系,不需要关心模块和文件之间的关系
只能在包的外面执行

 

 什么是包

#官网解释
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. 创建包的目的不是为了运行,而是被导入使用,记住,包只是模块的一种形式而已,包的本质就是一种模块

 

为何要是用包

包的本质就是一个文件夹,那么文件夹唯一的功能就是将文件组织起来
随着功能越写越多,我们无法将所以功能都放到一个文件中,于是我们使用模块去组织功能,而随着模块越来越多,我们就需要用文件夹将模块文件组织起来,以此来提高程序的结构性和可维护性

 

 

包是一种通过使用‘.模块名’来组织python模块名称空间的方式。

1. 无论是import形式还是from...import形式,凡是在导入语句中(而不是在使用时)遇到带点的,都要第一时间提高警觉:这是关于包才有的导入语法

2. 包是目录级的(文件夹级),文件夹是用来组成py文件(包的本质就是一个包含__init__.py文件的目录)

3. import导入文件时,产生名称空间中的名字来源于文件,import 包,产生的名称空间的名字同样来源于文件,即包下的__init__.py,导入包本质就是在导入该文件

强调:

  1. 在python3中,即使包下没有__init__.py文件,import 包仍然不会报错,而在python2中,包下一定要有该文件,否则import 包报错

  2. 创建包的目的不是为了运行,而是被导入使用,记住,包只是模块的一种形式而已,包即模块


包A和包B下有同名模块也不会冲突,如A.a与B.a来自俩个命名空间

 

注意事项

 

1.关于包相关的导入语句也分为import和from ... import ...两种,但是无论哪种,无论在什么位置,在导入时都必须遵循一个原则:凡是在导入时带点的,点的左边都必须是一个包,否则非法。可以带有一连串的点,如item.subitem.subsubitem,但都必须遵循这个原则。

2.对于导入后,在使用时就没有这种限制了,点的左边可以是包,模块,函数,类(它们都可以用点的方式调用自己的属性)。

 

3.对比import item 和from item import name的应用场景:
如果我们想直接使用name那必须使用后者。

 

 

from...import...

 

需要注意的是from后import导入的模块,必须是明确的一个不能带点,否则会有语法错误,如:from a import b.c是错误语法

我们在与包glance同级别的文件中测试 

1 from glance.db import models
2 models.register_models('mysql')
3 
4 from glance.db.models import register_models
5 register_models('mysql')

 

__init__.py文件

 

不管是哪种方式,只要是第一次导入包或者是包的任何其他部分,都会依次执行包下的__init__.py文件(我们可以在每个包的文件内都打印一行内容来验证一下),

这个文件可以为空,但是也可以存放一些初始化包的代码。

 

 

from glance.api import *

 

在讲模块时,我们已经讨论过了从一个模块内导入所有*,此处我们研究从一个包导入所有*。

 

此处是想从包api中导入所有,实际上该语句只会导入包api下__init__.py文件中定义的名字,我们可以在这个文件中定义__all___:

 

复制代码
#在__init__.py中定义
x=10

def func():
    print('from api.__init.py')

__all__=['x','func','policy']
复制代码

 

 此时我们在于glance同级的文件中执行from glance.api import *就导入__all__中的内容(versions仍然不能导入)。

 

 

绝对导入和相对导入

 

 

 

我们的最顶级包glance是写给别人用的,然后在glance包内部也会有彼此之间互相导入的需求,这时候就有绝对导入和相对导入两种方式:

 

绝对导入:以glance作为起始

 

相对导入:用.或者..的方式最为起始(只能在一个包中使用,不能用于不同目录内)

 

例如:我们在glance/api/version.py中想要导入glance/cmd/manage.py

 

复制代码
在glance/api/version.py

#绝对导入
from glance.cmd import manage
manage.main()

#相对导入
from ..cmd import manage
manage.main()
复制代码

 

测试结果:注意一定要在于glance同级的文件中测试

 

1 from glance.api import versions 

 

注意:在使用pycharm时,有的情况会为你多做一些事情,这是软件相关的东西,会影响你对模块导入的理解,因而在测试时,一定要回到命令行去执行,模拟我们生产环境,你总不能拿着pycharm去上线代码吧!!!

 

 

 

特别需要注意的是:可以用import导入内置或者第三方模块(已经在sys.path中),但是要绝对避免使用import来导入自定义包的子模块(没有在sys.path中),应该使用from... import ...的绝对或者相对导入,且包的相对导入只能用from的形式。

 

比如我们想在glance/api/versions.py中导入glance/api/policy.py,有的同学一抽这俩模块是在同一个目录下,十分开心的就去做了,它直接这么做

 

1 #在version.py中
2 
3 import policy
4 policy.get()

 

 

 

没错,我们单独运行version.py是一点问题没有的,运行version.py的路径搜索就是从当前路径开始的,于是在导入policy时能在当前目录下找到

 

但是你想啊,你子包中的模块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,
这必然是找不到的
'''
复制代码

 

 

 

 

glance/                   

├── __init__.py      from glance import api
                             from glance import cmd
                             from glance import db

├── api                  

│   ├── __init__.py  from glance.api import policy
                              from glance.api import versions

│   ├── policy.py

│   └── versions.py

├── cmd                 from glance.cmd import manage

│   ├── __init__.py

│   └── manage.py

└── db                   from glance.db import models

    ├── __init__.py

    └── models.py

绝对导入
绝对导入

 

 

 

 

glance/                   

├── __init__.py      from . import api  #.表示当前目录
                     from . import cmd
                     from . import db

├── api                  

│   ├── __init__.py  from . import policy
                     from . import versions

│   ├── policy.py

│   └── versions.py

├── cmd              from . import manage

│   ├── __init__.py

│   └── manage.py    from ..api import policy   
                     #..表示上一级目录,想再manage中使用policy中的方法就需要回到上一级glance目录往下找api包,从api导入policy

└── db               from . import models

    ├── __init__.py

    └── models.py

相对导入
相对导入

 

 

 

 

单独导入包

 

 

单独导入包名称时不会导入包中所有包含的所有子模块,如

 

复制代码
#在与glance同级的test.py中
import glance
glance.cmd.manage.main()

'''
执行结果:
AttributeError: module 'glance' has no attribute 'cmd'

'''
复制代码

 

 

 

解决方法:

 

1 #glance/__init__.py
2 from . import cmd
3 
4 #glance/cmd/__init__.py
5 from . import manage

 

执行:

 

1 #在于glance同级的test.py中
2 import glance
3 glance.cmd.manage.main()

 

千万别问:__all__不能解决吗,__all__是用于控制from...import *

 

 

 

import glance之后直接调用模块中的方法

glance/                   

├── __init__.py     from .api import *
                    from .cmd import *
                    from .db import *    
├── api                  

│   ├── __init__.py   __all__ = ['policy','versions'] 

│   ├── policy.py

│   └── versions.py

├── cmd               __all__ = ['manage']    

│   ├── __init__.py

│   └── manage.py    

└── db                __all__ = ['models']              

    ├── __init__.py

    └── models.py


import glance
policy.get()

import glance
View Code

 

posted @ 2017-09-21 20:05  选择远方,风雨兼程。  阅读(163)  评论(0)    收藏  举报