Python 面向对象 9: 模块和包

一、内容总览

• 1.1、模块
• 1.2、包
• 1.3、发布模块

二、模块

• 2.1、模块的概念：模块是 Python 程序架构的一个核心概念

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

• 2.2、模块的两种导入方式

  • (1)、 import 导入(不推荐使用)

    import 模块名1, 模块名2 
    

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

    import 模块名1
    import 模块名2  
    

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

    • 使用 as 指定模块的别名(如果模块的名字太长，可以使用 as 指定模块的名称，以方便在代码中的使用),模块名字要符合大驼峰命名法

      import 模块名1 as 模块别名
      

  • (2)、from...import 导入

    • 如果希望 从某一个模块 中，导入 部分 工具，就可以使用 from ... import 的方式

    • import 模块名 是 一次性 把模块中 所有工具全部导入，并且通过 模块名/别名 访问

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

      解决办法：可以在再加一个as 别名,如：from 模块名1 import 工具名 as 别名

    • 导入之后

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

    • 提示：如果 两个模块，存在 同名的函数，那么 后导入模块的函数，会 覆盖掉先导入的函数
    • 开发时 import 代码应该统一写在 代码的顶部，更容易及时发现冲突
    • 一旦发现冲突，可以使用 as 关键字 给其中一个工具起一个别名
    • 关于覆盖看下面的代码，三个模块：JKPerson、JKAnimal、JKDog，JKAnimal和JKDog都有一个函数 test，当在JKPerson模块通过from 模块名1 import 函数名导入后，在调用 test() 时候走的是 后倒入模块的test函数

    • (3)、from...import *

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

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

• 2.3、模块的搜索顺序

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

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

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

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

  • 示例：

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

    提示：注意：如果当前目录下，存在一个 random.py 的文件，程序就无法正常执行了,这个时候，Python 的解释器会 加载当前目录 下的 random.py 而不会加载 系统的 random 模块
    

    模块命名和系统模块的名字重复

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

  • 一个 独立的 Python 文件 就是一个 模块

  • 在导入文件时，文件中 所有没有任何缩进的代码 都会被执行一遍！

  • 我们在开发一个模块的时候，可能在模块最下面会写一些测试的代码，在其他模块里面当如自己开发的模块的时候，测试的代码也会被执行，如何去避免测试的代码执行呢？那么下面我们就可以利用Python的内置属性 __name__

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

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

  • 示例: __name__的实际运用

    def test():
          print("我是来测试的")
    if __name__ == "__main__":
          test()
    

    再次提醒： 如果其他模块导入上面代码的模块：__name__就是模块名，也就是不会等于"__main__",故下面的代码不会被执行；如果是在上面代码的模块执行，__name__就是"__main__"，故会走

三、包

• 3.1、包的概念

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

• 3.2、使用包的好处

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

• 3.3、看一个案例

  • (1)、新建一个 hm_message 的 包

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

  提示： 做完上面的5步，在包外面的文件里面导入了包名，还是不能使用包里面模块或者模块的属性以及方法的，我们需要在包里面的__init__.py文件里面导入其他的模块，如下，. 代表当前目录

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

  注意：包内必须有 特殊的文件 __init__.py,在特殊文件里面用from . import 模块名 导入包下面的每个模块

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

• 4.1、制作发布压缩包步骤(别人想用你的包的话，把（3）中dist文件夹里面的压缩文件发给别人就好了)

  • (1) 在于包同目录下创建 setup.py文件（名字一定要是：setup.py），下面是setup.py 的文件的信息，改一下就好，注意：最后一个py_modules里面放的是包内模块名字的列表
    

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

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

  • (2) 构建模块

    cd 进入 包 和setup.py的父目录
    python3 setup.py build
    

  • (3) 生成发布压缩包

    python3 setup.py sdist
    

  制作好的压缩包

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

• 4.2、安装模块

  • (1)、把别人给你的压缩文件复制到一个文件夹内，cd 进入到文件夹，解压缩，安装

    # 进入压缩文件的目录
    cd 文件夹
    解压缩
    tar -zxvf JKTools-1.0.tar.gz 
    # cd 进入到上面解压的压缩包里面
    cd JKTools-1.0
    # 安装到相应系统内，我这里安装在 python3上
    sudo python3 setup.py install
    

  • (2)、卸载上面(1)安装的模块

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

    • 如果你忘记在哪了，用Python 中每一个模块都有一个内置属性 __file__ 可以 查看模块 的 完整路径

    • 路径的打印

      import JKTools
      print(JKTools.__file__)
      打印结果是：/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/JKTools/__init__.py
      

    • 开始卸载上面(1)安装的模块

      # cd 上面JKTools的路径
      cd /Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages
      # 删除（* 代表移除JKTools所有的内容，包括JKTools文件夹）
      sudo rm -r JKTools*
      

• 4.3、pip 安装第三方模块

  • 第三方模块 通常是指由 知名的第三方团队 开发的 并且被 程序员广泛使用 的 Python 包 / 模块

  • pip 是一个现代的，通用的 Python 包管理工具

  • 提供了对 Python 包的查找、下载、安装、卸载等功能

  • 安装和卸载命令如下：下面以模块 pygame 为例安装

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

  • 在 Mac 下安装 iPython(打印一些类的方法，以及使用dir()打印内置的方法)

    sudo pip install ipython
    

  • 在 Linux 下安装 iPython

    $ sudo apt install ipython
    $ sudo apt install ipython3