python 模块

什么是模块：

模块就是一系列功能的集合体,分为三大类
   I：内置的模块
   II：第三方的模块
   III：自定义的模块
         一个python文件本身就一个模块，文件名m.py，模块名叫m

   ps：模块有四种形式
       1 使用python编写的.py文件

       2 已被编译为共享库或DLL的C或C++扩展
            
       3 把一系列模块组织到一起的文件夹（注：文件夹下有一个__init__.py文件，该文件夹称之为包）
            
       4 使用C编写并链接到python解释器的内置模块

为什么要用模块

I:内置与第三的模块拿来就用，无需定义，这种拿来主义，可以极大地提升自己的开发效率
II:自定义的模块
    可以将程序的各部分功能提取出来放到一模块中为大家共享使用
    好处是减少了代码冗余，程序组织结构更加清晰

导入模块规范

导入模块的规范
#I. python内置模块
#II. 第三方模块
#III. 程序员自定义模块

# import time
# import sys
#
# import 第三方1
# import 第三方2
#
# import 自定义模块1     #自定义模块的命名应该采用纯小写+下划线的风格
# import 自定义模块2
# import 自定义模块3

以spam.py为例：文件名spam.py,模块名spam

spam.py文件内容

#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语句是可以在程序中的任意位置使用的,且针对同一个模块很import多次,为了防止你重复导入，
python的优化手段是：第一次导入后就将模块名加载到内存了，后续的import语句仅是对已经加载到内存中的模块对象增加了一次引用，不会重新执行模块内的语句），如下 

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

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

import的优缺点：

#import导入模块在使用时必须加前缀"模块"
#优点：肯定不会与当前名称空间中的名字冲突
#缺点：加前缀显得麻烦

1、import在第一次导入模块时会做三件事，重复导入会直接引用内存中已经加载好的结果

# 1、首次导入模块会发生3件事
# 1、执行spam.py
# 2、产生spam.py的名称空间，将spam.py运行过程中产生的名字都丢到spam的名称空间中
# 3、在当前文件中产生的有一个名字spam，该名字指向2中产生的名称空间

2、使用import，被导入模块有独立的名称空间

每个模块都是一个独立的名称空间，定义在这个模块中的函数，把这个模块的名称空间当做全局名称空间，这样我们在编写自己的模块时，就不用担心我们定义在自己模块中全局变量会在被导入时，与使用者的全局变量冲突

#test.py
import spam      #指向spam模块的名称空间
money=10
print(spam.money)   #指名道姓向spam名称空间要money

'''
执行结果：
from the spam.py
1000
'''

#money与spam.money不冲突

3、为模块名起别名

为已经导入的模块起别名的方式对编写可扩展的代码很有用(例如导入的模块名很长)

import spam as sm
print(sm.money)

'''
执行结果：
from the spam.py
1000
'''

可以在函数内导入模块

def func():
    import spam

有两中sql模块mysql和oracle，根据用户的输入，选择不同的sql功能

#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()

4、无论是查看还是修改操作都是模块本身，与调用位置无关

#spam.py
money = 1000

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

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

def change():
    global money
    money = 0

#test.py
import spam
spam.read1()  # 1000
spam.change()
spam.read1()  # 0

print(spam.money)  # 0

5、在一行导入多个模块

可以用逗号为分隔符在一行导入多个模块
# 建议如下所示导入多个模块
# import time
# import foo
# import m

# 不建议在一行同时导入多个模块
import time,foo,m

 使用模块之from...import...

1、from...import...的使用

from spam import read1,read2

2、from...import...与import的对比

#唯一的区别就是：使用from...import...则是将spam中的名字直接导入到当前的名称空间中，所以在当前名称空间中，直接使用名字就可以了、无需加前缀：spam.

#from...import...的方式有好处也有坏处
    好处：使用起来方便了
    坏处：容易与当前执行文件中的名字冲突

3、from...import...导入发生的三件事

#1、产生一个模块的名称空间
#2、运行spam.py将运行过程中产生的名字都丢到模块的名称空间去
#3、在当前名称空间拿到一个名字，改名字与模块名称空间中的某一个内存地址

验证一：当前位置直接使用read1和read2就好了，执行时，仍然以spam.py文件全局名称空间

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

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

'''
执行结果:
from the spam.py
spam模块
spam模块： 1000
'''

验证二：如果当前有重名read1或者read2，那么会有覆盖效果。

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

'''
执行结果
from the spam.py
==========
'''

验证三：导入的方法在执行时，始终是以源文件为准的

#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


#test.py
from spam import money # money=模块spam中值1000的内存地址
from spam import read1
from spam import change

read1()       #1000
change()      
read1()       #0
# from spam import money # money = 新地址
print(money)    #1000 test名称空间中导入的money，定义阶段money=模块spam中值1000的内存地址

#打印结果
'''
from the spam.py
spam模块： 1000
spam模块： 0
1000
'''

也支持as

from spam import read1 as read

一行导入多个名字

from spam import read1,read2,money

from...import *

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

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

#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

#test.py
from spam import * #将模块spam中所有的名字都导入到当前名称空间
print(money)       #money打印就报错了，提示未定义
print(read1)
print(read2)
print(change)

'''
执行结果:
from the spam.py
<function read1 at 0x1012e8158>
<function read2 at 0x1012e81e0>
<function change at 0x1012e8268>
'''

可以使用__all__来控制*（用来发布新版本），在spam.py中新增一行

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

在模块的一开始定义 __all__ 变量，import该模块后，只能找到 __all__中存在的变量或者函数，其他的不能调用

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

__all__=["_money",'read1']   #只能使用_money和read1

_money=1000

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

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

def change():
    global money
    money=0

#test.py
from spam import *
print(_money)
print(read1)
#print(read2)    #执行就会报错，提示未定义read2

'''
执行结果
from the spam.py
1000
<function read1 at 0x000001D706FB3840>
'''

py文件的两个用途：模块和脚本

#编写好的一个python文件可以有两种用途：
    一：脚本，一个文件就是整个程序，用来被执行
    二：模块，文件中存放着一堆功能，用来被导入使用


#python为我们内置了全局变量__name__，
    当文件被当做脚本执行时：__name__ 等于'__main__'
    当文件被当做模块导入时：__name__等于模块名

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

# fib.py
def fib(n):  # write Fibonacci series up to n
    a, b = 0, 1
    while b < n:
        print(a, end=' ')
        a, b = b, a + b

# def fib2(n):
#     # return Fibonacci series up to n
#     result = []
#     a, b = 0, 1
#     while b < n:
#         result.append(a)
#         a, b = b, a + b
#     return result


if __name__ == "__main__":  # 被当作脚本执行时，才会运行下面的代码
    import sys

    fib(int(sys.argv[1]))


# 执行：python fib.py <arguments>
python fib.py 50 #在命令行

模块的搜索路径

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

#在初始化后，python程序可以修改sys.path,路径放到前面的优先于标准库被加载。
>>> import sys
>>> sys.path.append('/a/b/c/d')
>>> sys.path.insert(0,'/x/y/z') #排在前的目录，优先被搜索

#模块的查找顺序
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文件，因此一定要事先创建他们，来避免加载模块是性能下降。

详细的

sys.path的应用

找foo.py就把foo.py的文件夹添加到环境变量中

目录：

 foo.py

"""
开发人员: alias
开发时间: 2021/11/13 11:05
文件名称: foo.py
开发工具: PyCharm
"""
print("模块foo====>")

money = 1000


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


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


def change():
    global money
    money = 0


if __name__ == '__main__':
    read1()

test.py

import os
import sys
# print(os.path.dirname( os.path.abspath(__file__)))
foo_dir = "{}//aaa".format(os.path.dirname( os.path.abspath(__file__)))
sys.path.append(foo_dir)
# print(sys.path)

import foo

foo.read1()

#执行结果
模块foo====>
spam模块： 1000

模块循环导入的问题：

模块循环/嵌套导入抛出异常的根本原因是由于在python中模块被导入一次之后，就不会重新导入，只会在第一次导入时执行模块内代码

在我们的项目中应该尽量避免出现循环/嵌套导入，如果出现多个模块都需要共享的数据，可以将共享的数据集中存放到某一个地方

在程序出现了循环/嵌套导入后的异常分析、解决方法如下

#示范文件内容如下
#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()

 编写一个规范的模块

在编写py文件时，需要时刻提醒自己，该文件既是给自己用的，也有可能会被其他人使用，因而代码的可读性与易维护性显得十分重要，为此我们在编写一个模块时最好按照统一的规范去编写，如下

#!/usr/bin/env python #通常只在类unix环境有效,作用是可以使用脚本名来执行，而无需直接调用解释器。

"The module is used to..." #模块的文档描述

import sys #导入模块

x=1 #定义全局变量,如果非必须,则最好使用局部变量,这样可以提高代码的易维护性,并且可以节省内存提高性能

class Foo: #定义类,并写好类的注释
    'Class Foo is used to...'
    pass

def test(): #定义函数,并写好函数的注释
    'Function test is used to…'
    pass

if __name__ == '__main__': #主程序
    test() #在被当做脚本执行时,执行此处的代码