模块和包

#1、从文件级别组织程序，更方便管理
随着程序的发展，功能越来越多，为了方便管理，我们通常将程序分成一个个的文件，这样做程序的结构更清晰，方便管理。这时我们不仅仅可以把这些文件当做脚本去执行，还可以把他们当做模块来导入到其他的模块中，实现了功能的重复利用

#2、拿来主义，提升开发效率
同样的原理，我们也可以下载别人写好的模块然后导入到自己的项目中使用，这种拿来主义，可以极大地提升我们的开发效率

#ps：
如果你退出python解释器然后重新进入，那么你之前定义的函数或者变量都将丢失，因此我们通常将程序写到文件中以便永久保存下来，需要时就通过python test.py方式去执行，此时test.py被称为脚本script。

#spam.py
print(‘from the spam.py‘)

money=1000

def read1():
    print(‘spam模块：‘,money)

def read2():
    print(‘spam模块‘)
    read1()

def change():
    global money
    money=0

#模块可以包含可执行的语句和函数的定义，这些语句的目的是初始化模块，它们只在模块名第一次遇到导入import语句时才执行（import语句是可以在程序中的任意位置使用的,且针对同一个模块很import多次,为了防止你重复导入，python的优化手段是：第一次导入后就将模块名加载到内存了，后续的import语句仅是对已经加载到内存中的模块对象增加了一次引用，不会重新执行模块内的语句），如下 

#test.py
import spam #只在第一次导入时才执行spam.py内代码,此处的显式效果是只打印一次‘from the spam.py‘,当然其他的顶级代码也都被执行了,只不过没有显示效果.
import spam
import spam
import spam

‘‘‘
执行结果：
from the spam.py
‘‘‘

#1. 为源文件(spam模块)创建新的名称空间,在spam中定义的函数和方法若是使用到了global时访问的就是这个名称空间

#2. 在新创建的命名空间中执行模块中的代码时,就导入一次
   函数定义也是一个"被执行"的语句,模块级别函数定义的执行就是将函数名放入模块创建的全 
   局空间中,使用global()可以查看

#3. 创建模块名字来引用该命名空间
    这个名字和变量名没什么区别，都是‘第一类的’，且使用spam.名字的方式
    可以访问spam.py文件中定义的名字，spam.名字与test.py中的名字来自
    两个完全不同的地方。

1. import spam as sm
2. print(sm.money)

#mysql.py
def sqlparse():
    print(‘from mysql sqlparse‘)
#oracle.py
def sqlparse():
    print(‘from oracle sqlparse‘)

#test.py
db_type=input(‘>>: ‘)
if db_type == ‘mysql‘:
    import mysql as db
elif db_type == ‘oracle‘:
    import oracle as db

db.sqlparse()

if file_format == ‘xml‘:
    import xmlreader as reader
elif file_format == ‘csv‘:
    import csvreader as reader
data=reader.read_date(filename)

import sys,os,re

from spam import read1,read2

# 区别:使用 from...import...是将spam(模块)中的名字直接导入当前名称空间中,在当前空间内直接使用名字就可以使用了,无需加前缀:  spam.

#优点: 使用方便
#缺点:容易与当前执行文件中的名字起冲突

#测试一：导入的函数read1，执行时仍然回到spam.py中寻找全局变量money
#test.py
from spam import read1
money=10000000
read1()
‘‘‘
执行结果:
from the spam.py
spam->read1->money 1000
‘‘‘

#测试二:导入的函数read2，执行时需要调用read1(),仍然回到spam.py中找read1()
#test.py
from spam import read2
def read1():
    print(‘==========‘)
read2()

‘‘‘
执行结果:

from the spam.py
spam模块
spam模块： 1000

spam->read2 calling read
spam->read1->money 1000
‘‘‘

#测试三:导入的函数read1，被当前位置定义的read1覆盖掉了
#test.py
from spam import read1
def read1():
    print(‘==========‘)
read1()
‘‘‘
执行结果:
from the spam.py
==========
‘‘‘

from spam import money,read1
money=100 #将当前位置的名字money绑定到了100
print(money) #打印当前的名字
read1() #读取spam.py中的名字money,仍然为1000

‘‘‘
from the spam.py
spam->read1->money 1000
‘‘‘

from spam import read1 as read

from spam import read1,read2,money

#from spam import * 把spam中所有的不是以下划线(_)开头的名字都导入到当前位置

#大部分情况下我们的python程序不应该使用这种导入方式，因为*你不知道你导入什么名字，
很有可能会覆盖掉你之前已经定义的名字。而且可读性极其的差，在交互式环境中导入时没有问题。

__all__=[‘money‘,‘read1‘] #这样在另外一个文件中用from spam import *就这能导入列表中规定的两个名字

#示范文件内容如下
#m1.py
print(‘正在导入m1‘)
from m2 import y

x=‘m1‘

#m2.py
print(‘正在导入m2‘)
from m1 import x

y=‘m2‘

#run.py
import m1

#测试一
执行run.py会抛出异常
正在导入m1
正在导入m2
Traceback (most recent call last):
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/aa.py", line 1, in <module>
    import m1
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m1.py", line 2, in <module>
    from m2 import y
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m2.py", line 2, in <module>
    from m1 import x
ImportError: cannot import name ‘x‘

#测试一结果分析
先执行run.py--->执行import m1，开始导入m1并运行其内部代码--->打印内容"正在导入m1"
--->执行from m2 import y 开始导入m2并运行其内部代码--->打印内容“正在导入m2”--->执行from m1 import x,由于m1已经被导入过了，所以不会重新导入，所以直接去m1中拿x，然而x此时并没有存在于m1中，所以报错


#测试二:执行文件不等于导入文件，比如执行m1.py不等于导入了m1
直接执行m1.py抛出异常
正在导入m1
正在导入m2
正在导入m1
Traceback (most recent call last):
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m1.py", line 2, in <module>
    from m2 import y
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m2.py", line 2, in <module>
    from m1 import x
  File "/Users/linhaifeng/PycharmProjects/pro01/1 aaaa练习目录/m1.py", line 2, in <module>
    from m2 import y
ImportError: cannot import name ‘y‘


#测试二分析
执行m1.py，打印“正在导入m1”，执行from m2 import y ，导入m2进而执行m2.py内部代码--->打印"正在导入m2"，执行from m1 import x，此时m1是第一次被导入，执行m1.py并不等于导入了m1，于是开始导入m1并执行其内部代码--->打印"正在导入m1"，执行from m1 import y，由于m1已经被导入过了，所以无需继续导入而直接问m2要y，然而y此时并没有存在于m2中所以报错



# 解决方法:
方法一:导入语句放到最后
#m1.py
print(‘正在导入m1‘)

x=‘m1‘

from m2 import y

#m2.py
print(‘正在导入m2‘)
y=‘m2‘

from m1 import x

方法二:导入语句放到函数中
#m1.py
print(‘正在导入m1‘)

def f1():
    from m2 import y
    print(x,y)

x = ‘m1‘

# f1()

#m2.py
print(‘正在导入m2‘)

def f2():
    from m1 import x
    print(x,y)

y = ‘m2‘

#run.py
import m1

m1.f1()

示例文件

1 import time,importlib
2 import test
3 
4 time.sleep(20)
5 # importlib.reload(aa)
6 test.func1()

在20秒的等待时间里，修改test.py中func1的内容，等待结果。

打开importlib注释，重新测试

# 编写好的一个python文件可以有两种用途:
1:脚本,文件就是整个程序,用来被执行
2:模块,文件中存放着众多功能,用来被导入使用



#python为我们内置了全局变量 __name__
被当做脚本执行时:__name__ =="__main__"
当做模块导入时: __name__ == 模块名

#作用:用来控制.py文件在不同的应用场景下执行不同的逻辑
是否是脚本,执行
if __name__ =="__main__"

#模块的查找顺序
1、在第一次导入某个模块时（比如spam），会先检查该模块是否已经被加载到内存中（当前执行文件的名称空间对应的内存），如果有则直接引用
    ps：python解释器在启动时会自动加载一些模块到内存中，可以使用sys.modules查看
2、如果没有，解释器则会查找同名的内建模块
3、如果还没有找到就从sys.path给出的目录列表中依次寻找spam.py文件。


#sys.path的初始化的值来自于：
The directory containing the input script (or the current directory when no file is specified).
PYTHONPATH (a list of directory names, with the same syntax as the shell variable PATH).
The installation-dependent default.

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

#在初始化后，python程序可以修改sys.path,路径放到前面的优先于标准库被加载。
>>> import sys
>>> sys.path.append(‘/a/b/c/d‘)
>>> 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文件，因此一定要事先创建他们，来避免加载模块是性能下降。

详细的

#官网链接：https://docs.python.org/3/tutorial/modules.html#the-module-search-path
搜索路径：
当一个命名为spam的模块被导入时
    解释器首先会从内建模块中寻找该名字
    找不到，则去sys.path中找该名字

sys.path从以下位置初始化
执行文件所在的当前目录
PTYHONPATH（包含一系列目录名，与shell变量PATH语法一样）
依赖安装时默认指定的

注意：在支持软连接的文件系统中，执行脚本所在的目录是在软连接之后被计算的，换句话说，包含软连接的目录不会被添加到模块的搜索路径中

在初始化后，我们也可以在python程序中修改sys.path,执行文件所在的路径默认是sys.path的第一个目录，在所有标准库路径的前面。这意味着，当前目录是优先于标准库目录的，需要强调的是：我们自定义的模块名不要跟python标准库的模块名重复，除非你是故意的，傻叉。

本质就是一个文件夹,功能就是将文件组织起来
随着功能越来越多,无法将所有的供都放到一个文件中,就用模块去组织功能,但随着模块也越来越多,就需要用文件夹来组织模块,用来提高程序的结构性,维护性和可读性

# 1 包的导入语句也分为import和from...import...两种,但都必须遵守一个原则:凡是在导入的时候带点(后缀)的,点的左边(上一层)必须是一个包,否则非法,如:item.subitem.subsubi的tem,但都必须遵守这个原则,导入后再使用就没有这种限制了,点的左边可以是包,也可以是模块,函数,类(都可以用点的方式调用自己的作用)

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

#3 包A和包B下有同名模块也不会冲突,如A.a与B.a来自两个命名空间(内存空间)

glance/                   #Top-level package

├── __init__.py      #Initialize the glance package

├── api                  #Subpackage for api

│   ├── __init__.py

│   ├── policy.py

│   └── versions.py

├── cmd                #Subpackage for cmd

│   ├── __init__.py

│   └── manage.py

└── db                  #Subpackage for db

    ├── __init__.py

    └── models.py

1 import glance.db.models
2 glance.db.models.register_models(‘mysql‘) 

#在与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

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中定义
x=10

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

__all__=[‘x‘,‘func‘,‘policy‘]

在glance/api/version.py

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

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

1 from glance.api import versions 

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

from glance.api import versions

‘‘‘
执行结果:
ImportError: No module named ‘policy‘
‘‘‘

‘‘‘
分析:
此时我们导入versions在versions.py中执行
import policy需要找从sys.path也就是从当前目录找policy.py,
这必然是找不到的
‘‘‘

绝对路径导入与相对路径导入


# 绝对导入:以执行文件的sys.path(当前文件的路径)为起始点开始导入,称之为相对导入
# 符号:. 代表当前所在文件,.. 代表上一级文件夹,...代表上一级的上一级文件夹
# 优点: 导入更加简单
# 缺点: 只能在导入包中的模块时候才能使用


#注意:
# 1. 相对导入只能用于包内部模块之间的相互导入,导入者与被导入者都必须在一个包内
# 2. attempted relative import beyond top-level package
#试图在顶级包之外使用相对导入时不可行的,是错误的,必须在顶级包内使用相对导入,.代表跳入到上一级文件夹,而上一级不应该超出顶级包