Python中的模块和包

@[toc]

一、类属性和类方法

01. 类的结构

1.1 术语 —— 实例

1. 使用面相对象开发，第 1 步 是设计 类
2. 使用 类名() 创建对象，创建对象 的动作有两步：
   • 1. 在内存中为对象 分配空间
   • 2. 调用初始化方法 __init__ 为 对象初始化
3. 对象创建后，内存 中就有了一个对象的 实实在在 的存在 —— 实例

因此，通常也会把：

1. 创建出来的 对象 叫做 类 的 实例
2. 创建对象的 动作 叫做 实例化
3. 对象的属性 叫做 实例属性
4. 对象调用的方法 叫做 实例方法

在程序执行时：

1. 对象各自拥有自己的 实例属性
2. 调用对象方法，可以通过 self.
   • 访问自己的属性
   • 调用自己的方法

结论

• 每一个对象 都有自己 独立的内存空间，保存各自不同的属性
• 多个对象的方法，在内存中只有一份，在调用方法时，需要把对象的引用 传递到方法内部

1.2 类是一个特殊的对象

Python 中 一切皆对象：

• class AAA: 定义的类属于 类对象
• obj1 = AAA() 属于 实例对象

• 在程序运行时，类 同样 会被加载到内存
• 在 Python 中，类 是一个特殊的对象 —— 类对象
• 在程序运行时，类对象 在内存中 只有一份，使用 一个类 可以创建出 很多个对象实例
• 除了封装 实例 的 属性 和 方法外，类对象 还可以拥有自己的 属性 和 方法
  1. 类属性
  2. 类方法
• 通过 类名. 的方式可以 访问类的属性 或者 调用类的方法

02. 类属性和实例属性

2.1 概念和使用

• 类属性 就是给 类对象 中定义的 属性
• 通常用来记录 与这个类相关 的特征
• 类属性 不会用于记录 具体对象的特征

示例需求

• 定义一个 工具类
• 每件工具都有自己的 name
• 需求 —— 知道使用这个类，创建了多少个工具对象？

class Tool(object):

    # 使用赋值语句，定义类属性，记录创建工具对象的总数
    count = 0

    def __init__(self, name):
        self.name = name

        # 针对类属性做一个计数+1
        Tool.count += 1


# 创建工具对象
tool1 = Tool("斧头")
tool2 = Tool("榔头")
tool3 = Tool("铁锹")

# 知道使用 Tool 类到底创建了多少个对象?
print("现在创建了 %d 个工具" % Tool.count)

2.2 属性的获取机制

• 在 Python 中 属性的获取 存在一个 向上查找机制

• 因此，要访问类属性有两种方式：

  1. 类名.类属性
  2. 对象.类属性 （不推荐）

注意

• 如果使用 对象.类属性 = 值 赋值语句，只会 给对象添加一个属性，而不会影响到 类属性的值

03. 类方法和静态方法

3.1 类方法

• 类属性 就是针对 类对象 定义的属性
  • 使用 赋值语句 在 class 关键字下方可以定义 类属性
  • 类属性 用于记录 与这个类相关 的特征
• 类方法 就是针对 类对象 定义的方法
  • 在 类方法 内部可以直接访问 类属性 或者调用其他的 类方法

语法如下

@classmethod
def 类方法名(cls):
    pass

• 类方法需要用 修饰器 @classmethod 来标识，告诉解释器这是一个类方法
• 类方法的 第一个参数 应该是 cls
  • 由 哪一个类 调用的方法，方法内的 cls 就是 哪一个类的引用
  • 这个参数和 实例方法 的第一个参数是 self 类似
  • 提示 使用其他名称也可以，不过习惯使用 cls

3. 通过 类名. 调用 类方法，调用方法时，不需要传递 cls 参数
4. 在方法内部
   • 可以通过 cls. 访问类的属性
   • 也可以通过 cls. 调用其他的类方法

示例需求

• 定义一个 工具类
• 每件工具都有自己的 name
• 需求 —— 在 类 封装一个 show_tool_count 的类方法，输出使用当前这个类，创建的对象个数

@classmethod
def show_tool_count(cls):
    """显示工具对象的总数"""
    print("工具对象的总数 %d" % cls.count)

在类方法内部，可以直接使用 cls 访问 类属性 或者 调用类方法

3.2 静态方法

• 在开发时，如果需要在 类 中封装一个方法，这个方法：

  • 既 不需要 访问 实例属性 或者调用 实例方法
  • 也 不需要 访问 类属性 或者调用 类方法

• 这个时候，可以把这个方法封装成一个 静态方法

语法如下

@staticmethod
def 静态方法名():
    pass

• 静态方法 需要用 修饰器 @staticmethod 来标识，告诉解释器这是一个静态方法
• 通过 类名. 调用 静态方法

class Dog(object):
    
    # 狗对象计数
    dog_count = 0
    
    @staticmethod
    def run():
        
        # 不需要访问实例属性也不需要访问类属性的方法
        print("狗在跑...")

    def __init__(self, name):
        self.name = name
        

3.3 方法综合案例

需求

1. 设计一个 Game 类
2. 属性：
   • 定义一个 类属性 top_score 记录游戏的 历史最高分
   • 定义一个 实例属性 player_name 记录 当前游戏的玩家姓名
3. 方法：
   • 静态方法 show_help 显示游戏帮助信息
   • 类方法 show_top_score 显示历史最高分
   • 实例方法 start_game 开始当前玩家的游戏
4. 主程序步骤
   • 1. 查看帮助信息
   • 2. 查看历史最高分
   • 3. 创建游戏对象，开始游戏

案例小结

1. 实例方法 —— 方法内部需要访问 实例属性
   • 实例方法 内部可以使用 类名. 访问类属性
2. 类方法 —— 方法内部 只 需要访问 类属性
3. 静态方法 —— 方法内部，不需要访问 实例属性 和 类属性

提问

如果方法内部 即需要访问 实例属性，又需要访问 类属性，应该定义成什么方法？

答案

• 应该定义 实例方法
• 因为，类只有一个，在 实例方法 内部可以使用 类名. 访问类属性

class Game(object):

    # 游戏最高分，类属性
    top_score = 0

    @staticmethod
    def show_help():
        print("帮助信息：让僵尸走进房间")
        
    @classmethod
    def show_top_score(cls):
        print("游戏最高分是 %d" % cls.top_score)

    def __init__(self, player_name):
        self.player_name = player_name

    def start_game(self):
        print("[%s] 开始游戏..." % self.player_name)
        
        # 使用类名.修改历史最高分
        Game.top_score = 999

# 1. 查看游戏帮助
Game.show_help()

# 2. 查看游戏最高分
Game.show_top_score()

# 3. 创建游戏对象，开始游戏
game = Game("小明")

game.start_game()

# 4. 游戏结束，查看游戏最高分
Game.show_top_score()

二、eval 函数

eval() 函数十分强大 —— 将字符串 当成 有效的表达式 来求值 并 返回计算结果

# 基本的数学计算
In [1]: eval("1 + 1")
Out[1]: 2

# 字符串重复
In [2]: eval("'*' * 10")
Out[2]: '**********'

# 将字符串转换成列表
In [3]: type(eval("[1, 2, 3, 4, 5]"))
Out[3]: list

# 将字符串转换成字典
In [4]: type(eval("{'name': 'xiaoming', 'age': 18}"))
Out[4]: dict

案例 - 计算器

需求

1. 提示用户输入一个 加减乘除混合运算
2. 返回计算结果

input_str = input("请输入一个算术题：")

print(eval(input_str))

不要滥用 eval

在开发时千万不要使用 eval 直接转换 input 的结果

__import__('os').system('ls')

• 等价代码

import os

os.system("终端命令")

• 执行成功，返回 0
• 执行失败，返回错误信息

三、模块和包

01. 模块

1.1 模块的概念

模块是 Python 程序架构的一个核心概念

• 每一个以扩展名 py 结尾的 Python 源代码文件都是一个 模块
• 模块名 同样也是一个 标识符，需要符合标识符的命名规则
• 在模块中定义的 全局变量 、函数、类 都是提供给外界直接使用的 工具
• 模块 就好比是 工具包，要想使用这个工具包中的工具，就需要先 导入 这个模块

1.2 模块的两种导入方式

1）import 导入

import 模块名1, 模块名2 

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

import 模块名1
import 模块名2 

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

使用 as 指定模块的别名

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

import 模块名1 as 模块别名

注意：模块别名 应该符合 大驼峰命名法

2）from...import 导入

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

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

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

注意

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

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

from...import *（知道）

# 从 模块 导入 所有工具
from 模块名1 import *

注意

这种方式不推荐使用，因为函数重名并没有任何的提示，出现问题不好排查

1.3 模块的搜索顺序[扩展]

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

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

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

Python 中每一个模块都有一个内置属性 __file__ 可以 查看模块 的 完整路径

示例

import random

# 生成一个 0～10 的数字
rand = random.randint(0, 10)

print(rand)

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

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

1.4 原则 —— 每一个文件都应该是可以被导入的

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

实际开发场景

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

__name__ 属性

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

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

在很多 Python 文件中都会看到以下格式的代码：

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

# 在代码的最下方
def main():
    # ...
    pass

# 根据 __name__ 判断是否执行下方代码
if __name__ == "__main__":
    main()

02. 包（Package）

概念

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

好处

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

案例演练

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

__init__.py

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

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

03. 发布模块

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

3.1 制作发布压缩包步骤

1) 创建 setup.py

• 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"])

有关字典参数的详细信息，可以参阅官方网站：

https://docs.python.org/2/distutils/apiref.html

2) 构建模块

$ python3 setup.py build

3) 生成发布压缩包

$ python3 setup.py sdist

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

3.2 安装模块

$ tar -zxvf hm_message-1.0.tar.gz 

$ sudo python3 setup.py install

卸载模块

直接从安装目录下，把安装模块的 目录 删除就可以

$ cd /usr/local/lib/python3.5/dist-packages/
$ sudo rm -r hm_message*

3.3 pip 安装第三方模块

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

安装和卸载命令如下：

# 将模块安装到 Python 2.x 环境
$ sudo pip install pygame
$ sudo pip uninstall pygame

# 将模块安装到 Python 3.x 环境
$ sudo pip3 install pygame
$ sudo pip3 uninstall pygame

在 Mac 下安装 iPython

$ sudo pip install ipython

在 Linux 下安装 iPython

$ sudo apt install ipython
$ sudo apt install ipython3