python模块和包

January 10, 2023

Ref

https://docs.python.org/zh-cn/3/tutorial/modules.html
https://docs.python.org/zh-cn/3/tutorial/venv.html
https://docs.python.org/zh-cn/3/installing/

模块

模块包含可执行语句及函数定义。这些语句用于初始化模块，且仅在 import 语句 第一次 遇到模块名时执行
(文件作为脚本运行时，也会执行这些语句)

每个模块都有自己的独立命名空间，import 语句并不限制必须置于脚本开头

模块内部的全局变量 __name__ 包含了模块名(字符串)
当通过 import 导入时，__name__ = 模块名
当直接运行脚本时，__name__ = '__main__'

if __name__ == "__main__":
    from sys import argv, __name__
    print(__name__) # sys
    print(argv)     # ['xxx.py']

当一个名为 xxx 的模块被导入时，解释器首先搜索具有该名称的内置模块（这些模块的名字被列在 sys.builtin_module_names 中）
如果没有找到，它就在变量 sys.path 给出的目录列表中搜索一个名为 xxx.py 的文件，sys.path 从这些位置初始化:

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

例如，直接通过 pip 安装的模块位于 Python\Python311\Lib\site-packages\ (windows) 目录
默认情况下 PYTHONPATH 是未配置的

dir() 函数返回模块(暴露的)变量列表，不带参数时返回当前定义的变量列表

def dir(模块对象 = 当前模块) -> list[str]: ...

包

包就是包含模块的目录，搜索方式和模块一致（包是特殊的模块，即包含模块的模块）
python 仅将目录下包含 __init__.py 文件的目录当成包该脚本在包初始化时执行，还可以包含一个 __all__ 列表变量，指定包导出的模块/自包名

仅子包中可以使用相对导入，导入父包中或相同层级包中的内容

from . import echo
from .. import formats
from ..filters import equalizer

使用 venv

venv 是 python 的内置模块

$ python3 -m venv <dirname>
$ cd <dirname>

首先需要执行脚本以进入虚拟环境

# Windows
.\Scripts\activate.bat

# Windows MinGW/msys
source ./Scripts/activate

# Unix
source ./bin/activate

这样通过 pip 安装的包就会安装在当前项目路径下
执行对应的 deactivate 脚本 退出虚拟环境

使用 pip

# 安装最新版本
pip install requests

# 安装指定版本
pip install requests==2.28.1
pip install "SomeProject>=1,<2"
pip install "SomeProject~=1.4.2"

# 从git仓库安装 (-e: editable mode)
pip install -e git+https://git.repo/some_pkg.git#egg=SomeProject
pip install -e git+https://git.repo/some_pkg.git@BranchName#egg=SomeProject

# 安装可选(额外)依赖
pip install SomePackage[PDF]

# 升级到最新版本
pip install --upgrade requests

#  显示安装的模块
pip list

# 显示模块信息
pip show requests

# 锁定版本
pip freeze > requirements.txt
pip install -r requirements.txt

pip 替代品

https://python-poetry.org/
https://github.com/pypa/pipenv
https://github.com/pypa/pipx

←Back to home