Python模块基础

一、模块

模块可以看成是一堆函数的集合体。

一个py文件内部就可以放一堆函数，因此一个py文件就可以看成一个模块。

如果这个py文件的文件名为module.py，模块名则是module。

1、模块的四种形式

在Python中，总共有以下四种形式的模块：

1. 自定义模块：如果你自己写一个py文件，在文件内写入一堆函数，则它被称为自定义模块，即使用python编写的.py文件
2. 第三方模块：已被编译为共享库或DLL的C或C++扩展 ，如requests
3. 内置模块：使用C编写并链接到python解释器的内置模块 ，如time
4. 包（文件夹）：把一系列模块组织到一起的文件夹（注：文件夹下有一个__init__.py文件，该文件夹称之为包）

2、为什么要用模块？

1. 用第三方或者内置的模块是一种拿来主义，可以极大地提升开发效率。
2. 自定义模块，将我们自己程序中用到的公共功能，写入一个python文件，然后程序的各部分组件可以通过导入的方式来引用自定义模块的功能。

二、如何用模块

一般我们使用import和from...import...导入模块。

以下述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

1、import 模块名

import首次导入模块发生了3件事：

1. 以模块为准创造一个模块的名称空间
2. 执行模块对应的文件，将执行过程中产生的名字都丢到模块的名称空间
3. 在当前执行文件中拿到一个模块名

注意：模块的重复导入会直接饮用之前创造好的结果，不会重复执行模块的文件，即重复导入会发生：spam=spam=模块名称空间的内存地址

# run.py
import spam  # from the spam.py
import spam

money = 111111
spam.read1()  # 'spam模块：1000'
spam.change()
print(spam.money)  # 0

print(money)  # 111111

导入重命名：smt变量指向span模块的名称空间

# run.py
import spam as sm


money = 111111

sm.money
sm.read1()  # 'spam模块：1000'
sm.read2
sm.change()

print(money)  # 1000

导入多个模块

import spam, time, os

# 推荐使用下述方式
import spam
import time
import os

2、from 模块名 import 具体的功能

from...import...首次导入模块发生了3件事：

1. 以模块为准创造一个模块的名称空间
2. 执行模块对应的文件，将执行过程中产生的名字都丢到模块的名称空间
3. 在当前执行文件的名称空间中拿到一个名字，该名字直接指向模块中的某一个名字，意味着可以不用加任何前缀而直接使用

• 优点：不用加前缀，代码更加精简
• 缺点：容易与当前执行文件中名称空间中的名字冲突

# run.py

from spam import money

from spam import money,read1

money = 10

print(money)  # 10

导入文件内所有的功能：

# spam.py
__all__ = ['money', 'read1']  # 只允许导入'money'和'read1'

# run.py
from spam import *  # 导入spam.py内的所有功能，但会受限制于__all__

money = 111111
read1()  # 'spam模块：1000'
change()
read1()  # 'spam模块：0'

print(money)  # 111111

3、import和from...import...的异同

相同点：

1. 两者都会执行模块对应的文件，两者都会产生模块的名称空间
2. 两者调用功能时，需要跑到定义时寻找作用域关系，与调用位置无关

不同点：

1. import需要加前缀；from...import...不需要加前缀

4、循环导入

以下情况会出现循环导入：

  
  
  
  

   
   
   
   
# m1.py
print('from m1.py')
from m2 import x

y = 'm1'


# m2.py
print('from m2.py')
from m1 import y

x = 'm2'
  
  
  
  

可以使用函数定义阶段只识别语法的特性解决循环导入的问题，或从本质上解决循环导入的问题，但是最好的解决方法是不要出现循环导入。

方案一：

  
  
  
  

   
   
   
   
# m1.py
print('from m1.py')


def func1():
    from m2 import x
    print(x)

y = 'm1'
   
   
   
   


   
   
   
   

# m2.py
print('from m2.py')

def func1():
    from m1 import y
    print(y)

x = 'm2'
  
  
  
  
方案二：

  
  
  
  

   
   
   
   
# m1.py
print('from m1.py')

y = 'm1'
from m2 import x
   
   
   
   


   
   
   
   

# m2.py
print('from m2.py')

x = 'm2'
from m1 import y
  
  
  
  

三、模块搜索路径

1、导入模块时查找模块的顺序

1、先从内存中已经导入的模块中寻找

如果我们在运行run.py文件的时候，快速删除mmm.py文件，我们会发现文件会继续运行，而不会报错，因为mmm已经被导入内存当中。如果我们再一次运行run.py时会报错，因为mmm.py已经被删除了。

# test.py
import m1  # 从m1.py文件中导入的,然后会生成m1模块的名称空间
import time

# 删除m1.py文件,m1模块的名称空间仍然存在

time.sleep(10)

import m1  # 不报错,一定不是从文件中获取了m1模块,而是从内存中获取的

2、内置的模块

验证先从内置中找，不会先找自定义的time.py文件。

# time.py
print('from time.py')

# run.py
import time

print(time)  # 

3、环境变量sys.path中找（强调：sys.path的第一个值是当前执行文件的所在的文件夹）

import sys

for n in sys.path:
    print(n)
# C:\PycharmProjects\untitled\venv\Scripts\python.exe C:/PycharmProjects/untitled/hello.py
# C:\PycharmProjects\untitled
# C:\PycharmProjects\untitled
# C:\Python\Python38\python38.zip
# C:\Python\Python38\DLLs
# C:\Python\Python38\lib
# C:\Python\Python38
# C:\PycharmProjects\untitled\venv
# C:\PycharmProjects\untitled\venv\lib\site-packages

如果mmm.py在C:\PycharmProjects\untitled\day16路径下，而执行文件路径为C:\PycharmProjects\untitled，如果普通导入一定会报错，我们可以把C:\PycharmProjects\untitled\day16添加到环境变量sys.path中，防止报错。

# run.py
import sys
sys.path.append(r'C:\PycharmProjects\untitled\day16')
print(sys.path)

import mmm
mmm.f1()

2、搜索路径以执行文件为准

假设我们有如下目录结构的文件，文件内代码分别是：

而hello和spam.py不是同目录下的，因此run.py的环境变量无法直接找到m2,需要从文件夹导入

from aa import spam

print(spam.money)

四、Python文件的两种用途

python文件总共有两种用途，一种是执行文件；另一种是被当做模块导入。

1、当run.py运行的时候，aaa.py被当做引用模块，它的__name__ == 'aaa'（模块名），会执行aaa.py中的f1()。

# aaa.py
x = 1

def f1():
    print('from f1')

f1()

# run.py
import aaa

2、aaa.py被当做可执行文件时，加上__name__ == '__main__'，单独运行aaa.py才会执行aaa.py中的f1()。  run.py运行时可以防止执行f1()。

# aaa.py
x = 1


def f1():
    print('from f1')

if __name__ == '__main__':
    f1()

五、包

包是模块的一种形式，包的本质就是一个含有.py的文件的文件夹。

导入包发生的三件事：

1. 创建一个包的名称空间
2. 由于包是一个文件夹，无法执行包，因此执行包下的.py文件，将执行过程中产生的名字存放于包名称空间中（即包名称空间中存放的名字都是来自于.py）
3. 在当前执行文件中拿到一个名字aaa，aaa是指向包的名称空间的

导入包就是在导入包下的.py，导入m1就是导入m1中的__init__。

可以使用以下两种方式导入：

1. import ...
2. from ... import...

凡是在导入时带点的，点的左边都必须是一个包，import aaa.bbb.m3.f3错误

1、导入包内的模块

修改__init__.py文件，

# aaa/.py
from aaa import m1
from aaa import m2


# run.py
import aaa

print(aaa.m1.func1())
print(aaa.m2.func2())

2、导入模块内具体的功能

# aaa/.py
from aaa.m1 import func1
from aaa.m2 import func2

from .bbb.m3 import func3

from .  import bbb

# run.py
import aaa

print(aaa.func1())
print(aaa.func2())

3、 导入包内包

aaa.bbb指向aaa内部的文件夹bbb包，如果我们需要导入bbb这个包。

# aaa/.py
from aaa import bbb

# run.py
import aaa

print(aaa.bbb)

4、导入包内包的模块

如果bbb包内部有m3.py，我们需要从run.py导入m3模块。

# aaa/.py
from aaa import bbb

# bbb/.py
from aaa.bbb import m3

# run.py
import aaa

aaa.bbb.m3

5、 绝对导入和相对导入

绝对导入：

# aaa/.py

from aaa.m1 import func1
from aaa.m2 import func2

相对导入：

• .代表当前被导入文件所在的文件夹
• ..代表当前被导入文件所在的文件夹的上一级
• ...代表当前被导入文件所在的文件夹的上一级的上一级

from .m1 import func1
from .m2 import func2

六、软件开发的目录规范

为了提高程序的可读性与可维护性，我们应该为软件设计良好的目录结构，这与规范的编码风格同等重要，简而言之就是把软件代码分文件目录。假设你要写一个ATM软件，你可以按照下面的目录结构管理你的软件代码：

ATM/
|-- core/
|   |-- src.py  # 业务核心逻辑代码
|
|-- api/
|   |-- api.py  # 接口文件
|
|-- db/
|   |-- db_handle.py  # 操作数据文件
|   |-- db.txt  # 存储数据文件
|
|-- lib/
|   |-- common.py  # 共享功能
|
|-- conf/
|   |-- settings.py  # 配置相关
|
|-- bin/
|   |-- run.py  # 程序的启动文件，一般放在项目的根目录下，因为在运行时会默认将运行文件所在的文件夹作为sys.path的第一个路径，这样就省去了处理环境变量的步骤
|
|-- log/
|   |-- log.log  # 日志文件
|
|-- requirements.txt # 存放软件依赖的外部Python包列表，详见https://pip.readthedocs.io/en/1.1/requirements.html
|-- README  # 项目说明文件

settings.py

# settings.py

import os

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

DB_PATH = os.path.join(BASE_DIR, 'db', 'db.txt')
LOG_PATH = os.path.join(BASE_DIR, 'log', 'user.log')

# print(DB_PATH)
# print(LOG_PATH)

common.py

# common.py

import time
from conf import settings


def logger(msg):
    current_time = time.strftime('%Y-%m-%d %X')
    with open(settings.LOG_PATH, mode='a', encoding='utf-8') as f:
        f.write('%s %s' % (current_time, msg))

src.py

# src.py

from conf import settings
from lib import common


def login():
    print('登陆')


def register():
    print('注册')
    name = input('username>>: ')
    pwd = input('password>>: ')
    with open(settings.DB_PATH, mode='a', encoding='utf-8') as f:
        f.write('%s:%s\n' % (name, pwd))
        # 记录日志。。。。。。
        common.logger('%s注册成功' % name)
        print('注册成功')


def shopping():
    print('购物')


def pay():
    print('支付')


def transfer():
    print('转账')


func_dic = {
    '1': login,
    '2': register,
    '3': shopping,
    '4': pay,
    '5': transfer,
}


def run():
    while True:
        print("""
        1 登陆
        2 注册
        3 购物
        4 支付
        5 转账
        6 退出
        """)
        choice = input('>>>: ').strip()
        if choice == '6': break
        if choice not in func_dic:
            print('输入错误命令，傻叉')
            continue
        func_dic[choice]()

run.py

# run.py

import sys
import os

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
sys.path.append(BASE_DIR)
from core import src

if __name__ == '__main__':
    src.run()