17 模块和包

最新推荐文章于 2025-03-13 01:50:19 发布

原创最新推荐文章于 2025-03-13 01:50:19 发布 · 652 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#python

模块和包

模块

模块的概念

模块是python 程序架构的一个核心概念
每一个以扩展名 py 结尾的 python 源代码文件都是一个模块
模块名同样也是一个标识符，需要符合标识符的命名规则
在模块中定义的全局变量、函数、类都是提供给外界直接使用的工具
命令就好比是工具包，要想使用这个工具包中的工具，就需要先导入这个模块
使用模块还可以避免函数名和变量名冲突

模块的两种导入方式

import 导入

import 模块名1，模块名2

提示：在导入模块时，每个导入应该独占一行

import 模块名1
import 模块名2

导入之后
- 通过 模块名. 使用模块提供的工具——全局变量、函数、类

使用 as 指定模块的别名

如果模块的名字太长，可以使用 as 指定模块的名称，以方便在代码中的使用

import 模块名 as 模块别名

注意：模块别名应该符合大驼峰命名法(单词之间首字母大写，单词与单词之间不使用下划线)

from...import 导入

如果希望从某一个模块中，导入部分工具，就可以使用 from...import 的方式
import 模块名 是一次性把模块中所有工具全部导入，并且通过模块名/别名访问

# 从模块导入某一个工具
  from 模块名 import 工具名

导入之后
- 不需要通过 模块名.
- 可以直接使用模块提供的工具——全部变量、函数、类

注意：

如果两个模块，存在同名的函数，那么后导入模块的函数，会覆盖掉先导入的函数

开发时 import 代码应该统一写在代码的顶部，更容易及时发现冲突
一旦发现冲突，可以使用 as 关键字给其中一个工具起一个别名

模块的搜索顺序

python 的解释器在导入模块时，会：

搜索当前目录指定模块名的文件，如果有就直接导入
如果没有，再搜索系统目录

在开发时，给文件起名，不要和系统的模块文件重名

python 中每一个模块都有一个内置属性 __file__ 可以查看模块的文章路劲

示例

import random
print(random.__file__)	# 查看模块的位置
rand = random.randint(0,10)
print(rand)

注意，如果当前目录下，存在一个 random.py 的文件，程序就无法正常执行了！

这个时候 python 的解释器会加载当前目录下的 random.py 而不会加载系统的 random 模块

每个文件都可以被导入

一个独立的 python 文件就是一个模块
再导入文件时，文件中所有没有任何缩进的代码都会被执行一遍

实际开发场景

在实际开发中，每一个模块都是独立开发的，大多都有专人负责
开发人员通常会在模块下方增加一些测试代码
- 仅在模块内部使用，而被导入到其他文件中不需要执行

__name__属性

__name__ 属性可以做到，测试模块的代码只在测试情况下被运行，而在被导入时不会被执行

__name__ 是 python 的一个内置属性，记录着一个字符串
如果是被其他文件导入的，__name__ 就是模块名
如果是当前执行的程序 __name__ 是 __main__

在很多 python 文件中都会看到下方格式的代码

# 导入模块
# 定义全局变量
# 定义类
# 定义函数

# 在代码的最下方
def main():
    ...
    pass
    
# 根据__name__ 判断是否执行下方代码
if __naem__ == "__main__"
    main()

包

包是一个包含多个模块的特殊目录
目录下又一个特殊文件__init__.py
包名的命名方式和变量名一致，小写字母+_

好处

使用 import 包名 可以一次性导入包中所有的模块

案例演练

新建一个hm_message 的包
在目录下，新建两个文件 send_message 和 receive_message
在 send_message 文件中定义一个 send 函数
在 receive_message 文件中定义一个 receive 函数
在外部直接导入 hm_message 的包

init.py

要在外界使用包中的模块，需要在__init__.py 中指定对外界提供的模块列表

# 从当前目录导入模块列表
from . import send_message
from . import receive_message

发布模块

如果希望自己开发的模块，分享给其他人，可以按照以下步骤操作

制作发布压缩包步骤

创建 setup.py 的文件

from distutils.core import setup

setup(name="hm_message",  # 包名
      version="1.0",    # 版本
      description="itheima's 发送和接收消息模块",    # 描述信息
      long_description="完整的发送和接收消息模块",   # 完整描述消息
      author="itheima", # 作者
      author_email="itheima@itheima.com",   # 作者邮箱
      url="www.itheima.com",    # 主页
      py_modules=["hm_message.send_message",
                  "hm_message.receive_message"])  # 压缩包中包含的模块名称

构建模块

python3 setup.py build

生成发布压缩包

python3 setup.py sdist

注意：要制作哪个版本的模块，就使用哪个版本的解释器执行

# 使用tree命令可以看到当前目录下生成了两个目录
# build和dist，dist目录里面已经存在一个压缩好的包了
├── build
│   └── lib
│       └── hm_message
│           ├── __init__.py
│           ├── receive_message.py
│           └── send_message.py
├── dist
│   └── hm_message-1.0.tar.gz
├── hm_message
│   ├── __init__.py
│   ├── __pycache__
│   │   ├── __init__.cpython-37.pyc
│   │   ├── receive_message.cpython-37.pyc
│   │   └── send_messge.cpython-37.pyc
│   ├── receive_message.py
│   └── send_message.py
├── MANIFEST
└── setup.py

安装模块

# 将上面生成的压缩包解压然后安装
tar xf hm_message-1.0.tar.gz
cd hm_message-1.0
python3 setup.py install
输出信息：
running install
running build
running build_py
running install_lib
running install_egg_info
Removing /usr/local/python37/lib/python3.7/site-packages/hm_message-1.0-py3.7.egg-info
Writing /usr/local/python37/lib/python3.7/site-packages/hm_message-1.0-py3.7.egg-info

# 安装完成之后可以直接在ipython中调用
In [1]: import hm_message

In [2]: hm_message.send_message.send("hello")
正在发送 hello...

In [3]: test = hm_message.receive_message.receive()

In [4]: print(test)
这是一条来自100xx的信息

In [5]:

卸载模块

# 直接从安装目录下，把安装模块的目录删除就可以
# 第三方安装的模块存放位置一般放在 `site-packages`
cd /usr/local/python37/lib/python3.7/site-packages/
rm -rf hm_message*

pip安装第三方模块

第三方模块是指由知名的第三方团队开发的并且被程序员广泛使用的 python 包/模块
- 例如pygame 就是一套非常成熟的游戏开发模块
pip 是一个现代的，通用的 python 包管理工具
提供了对 python 包的查找、下载、安装、卸载等功能

安装和卸载命令

pip3 install pygame
pip3 uninstall pygame

# 若使用国外网站比较慢可以尝试使用下方的方法下载
pip3 install -i http://pypi.douban.com/simple/ 模块名 --trusted-host pypi.douban.com