Python模块系统

• Python模块系统
  • package->module->method
    • package
    • module
    • method
  • 模块的用意：分割与导入
• 参考资源
  • 6. 模块 — Python 3.10.5 文档
  • 5. 导入系统 — Python 3.10.5 文档
    • 调用导入机制的方式
    • 导入模块发生了什么
    • python的模块
    • python的包
    • 对比联系包和模块
    • 包的分类
      • 常规包
      • 命名空间包
    • 搜索
    • 加载
    • 相对导入

package->module->method

package

• 术语对照表:package — Python 3.10.5 文档

一种可包含子模块或递归地包含子包的 Python module。从技术上说，包是带有 path 属性的 Python 模块。

• 术语对照表:regular package — Python 3.10.5 文档

传统型的 package，例如包含有一个 init.py 文件的目录。

• 术语对照表: namespace package — Python 3.10.5 文档

PEP 420 所引入的一种仅被用作子包的容器的 package，命名空间包可以没有实体表示物，其描述方式与 regular package 不同，因为它们没有 init.py 文件。

• PEP 420 – Implicit Namespace Packages | peps.python.org

module

• 术语对照表: module — Python 3.10.5 文档

此对象是 Python 代码的一种组织单位。各模块具有独立的命名空间，可包含任意 Python 对象。模块可通过 importing 操作被加载到 Python 中。

• 术语对照表: module spec — Python 3.10.5 文档

一个命名空间，其中包含用于加载模块的相关导入信息。是 importlib.machinery.ModuleSpec 的实例。

- [importlib --- import 的实现 — Python 3.10.5 文档](https://docs.python.org/zh-cn/3/library/importlib.html#importlib.machinery.ModuleSpec)
关于模块导入系统相关状态的规范。通常这是作为模块的 __spec__ 属性暴露出来。 
在以下描述中，括号里的名字给出了模块对象中直接可用的属性。
比如 module.__spec__.origin == module.__file__。 
但是请注意，虽然 值 通常是相等的，但它们可以不同，因为两个对象之间没有进行同步。
因此 __path__ 有可能在运行时做过更新，而这不会自动反映在 __spec__.submodule_search_locations 中。

method

模块的用意：分割与导入

参考资源

6. 模块 — Python 3.10.5 文档

1. 文件即模块：为实现切分需求，Python 把各种定义存入一个文件，在脚本或解释器的交互式实例中使用。这个文件就是 模块 ；模块中的定义可以 导入 到其他模块或 主 模块（在顶层和计算器模式下，执行脚本中可访问的变量集）。

在模块这一点，python、rust和go各有不同

• python的代码管理最小单位是模块
• rust代码管理最小单位也是模块，但是它还提供了一个关键字mod让一个文件里面包含多个模块。rust的crate其实是'标准'包，由一系列已发布、版本化、被分发的包构成。可以直接从版本控制仓库或crate.io下载模块。
• go的module和package的关系则与前两者反过来：模块由一系列已发布、版本化、被分发的包构成。可以直接从版本控制仓库或模块代理服务器下载模块。

2. 文件名即模块名：模块是包含 Python 定义和语句的文件。其文件名是模块名加后缀名 .py 。
3. 在模块内部，通过全局变量 name 可以获取模块名（即字符串）。
4. 关于模块命名空间：每个模块有各自文件范围内的全局命名空间(global namespace)
5. 模块顶部引入的其他模块在文件内全局可用，在函数、类等内部引入的，只能在内部使用
6. 关于from module_name import *: 导入所有不以下划线（_）开头的名称

大多数情况下，不要用这个功能，这种方式向解释器导入了一批未知的名称，可能会覆盖已经定义的名称。

7. 关于导入时发生的事情：

• 当一个名为 spam 的模块被导入时，解释器首先搜索具有该名称的内置模块。
• 这些模块的名字被列在 sys.buildin_module_names 中。
• 如果没有找到，它就在变量 sys.path 给出的目录列表中搜索一个名为 spam.py 的文件。

8. sys.path 从这些位置初始化:

• 输入脚本的目录（或未指定文件时的当前目录）。
• PYTHONPATH （目录列表，与 shell 变量 PATH 的语法一样）。
• 依赖于安装的默认值（按照惯例包括一个 site-packages 目录，由 site 模块处理）。

9. 关于'编译'文件处理： 6. 模块 — Python 3.10.5 文档
10. 找不到模块时的处理步骤：

• 使用dir()函数确认搜索路径
• 如果没找到，使用sys.path将对应路径加入

dir()函数列出会所有类型的名称：变量、模块、函数等。但不会列出内置函数和变量的名称。这些内容的定义在标准模块 builtins 里

11. 包是模块的集合，存在形式是目录。导入包时，Python 搜索 sys.path 里的目录，查找包的子目录。
12. 包的标志: 必须有__path__属性，包含__init__.py
13. 包的分类：

• 传统包(regular package): 包含一个__init__.py

导入包的时候，或默认执行__init__.py里面的代码

• 命名空间包(namespace package): 一种仅被用作子包的容器的 package，命名空间包可以没有实体表示物, 没有__init__.py

14. 从包导入*

• 在文件系统查找并导入包的所有子模块。这项操作花费的时间较长，并且导入子模块可能会产生不必要的副作用，这种副作用只有在显式导入子模块时才会发生。
• 可以在__init__.py里面使用__all__定义默认可以被导入的模块

15. 包的__path__属性：在导入包的时候，执行__init__.py之前，会默认将这个属性进行初始化。主要是将当前导入包的目录放入搜索路径里面

• __path__属性 — Python 3.10.5 文档
• module.path — Python 3.10.5 文档

5. 导入系统 — Python 3.10.5 文档

调用导入机制的方式

1. import语句/import()
2. importlib.import_module

导入模块发生了什么

1. 当一个模块首次被导入时，Python 会搜索该模块
2. 如果找到就创建一个 module 对象 1 并初始化它。
3. 如果指定名称的模块未找到，则会引发 ModuleNotFoundError。
4. 当发起调用导入机制时，Python 会实现多种策略来搜索指定名称的模块。

这些策略可以通过使用使用下文所描述的多种钩子来加以修改和扩展。

python的模块

Python 只有一种模块对象类型，所有模块都属于该类型，无论模块是用 Python、C 还是别的语言实现。

python的包

为了帮助组织模块并提供名称层次结构，Python 还引入了 包 的概念。

你可以把包看成是文件系统中的目录，并把模块看成是目录中的文件

对比联系包和模块

包的分类

常规包

1. 包含__init__.py文件，会在导入时隐式执行
2. 如果没有__init__.py, 一个包含文件的目录也是会被认为是一个包, 命名空间包

parent/
    __init__.py
    one/
        __init__.py
    two/
        __init__.py
    three/
        __init__.py

import parent.one

命名空间包

• 10.5 利用命名空间导入目录分散的代码 — python3-cookbook 3.0.0 文档

1. 命名空间包不包含__init__.py, 这样就不会限定是单个包内的模块名称
2. 不包含__init__.py的时候，不同目录下的同名包会被认为是同一个包。

这一点可以和golang的包机制对比联系起来

foo-package/
    spam/
        blah.py

bar-package/
    spam/
        grok.py

>>> import sys
>>> sys.path.extend(['foo-package', 'bar-package'])
>>> import spam.blah
>>> import spam.grok
>>>

搜索

加载

相对导入

package/
    __init__.py
    subpackage1/
        __init__.py
        moduleX.py
        moduleY.py
    subpackage2/
        __init__.py
        moduleZ.py
    moduleA.py

from .moduleY import spam
from .moduleY import spam as ham
from . import moduleY
from ..subpackage1 import moduleY
from ..subpackage2.moduleZ import eggs
from ..moduleA import foo

# moduleX.py
import sys
sys.append('..')
from moduleA import *