Absolufy-imports 使用与配置指南

1. 项目的目录结构及介绍

absolufy-imports 项目是一个用于将相对导入自动转换为绝对导入的工具。项目的目录结构如下：

• .github/
  • 存放与 GitHub 相关的配置文件，例如工作流（workflows）。
• tests/
  • 包含测试代码，用于保证项目的功能正常运行。
• .gitignore
  • 指定 Git 忽略的文件和目录。
• .pre-commit-config.yaml
  • 配置 pre-commit 的钩子，用于在提交代码前自动运行 absolufy-imports。
• LICENSE
  • 项目的许可证文件，本项目采用 MIT 许可证。
• README.md
  • 项目的说明文档，包含了项目的介绍、安装、使用方法和配置信息。
• absolufy_imports.py
  • 项目的主要 Python 脚本，实现了相对导入转换为绝对导入的功能。
• requirements-dev.txt
  • 开发环境所需依赖的列表。
• setup.cfg
  • 包含了项目打包和分发时的配置信息。
• setup.py
  • Python 包的设置文件，用于构建和打包项目。
• tox.ini
  • 配置 tox，一个用于自动化测试的命令行工具。

2. 项目的启动文件介绍

absolufy_imports.py 是项目的核心文件，它包含了主要的逻辑。当作为命令行工具使用时，可以直接运行此文件来转换指定 Python 文件中的相对导入为绝对导入。

例如，运行以下命令可以转换 mypackage/myfile.py 文件中的导入：

absolufy-imports mypackage/myfile.py

3. 项目的配置文件介绍

pre-commit-config.yaml 是项目的配置文件，用于设置 pre-commit 钩子。pre-commit 是一个在代码提交前自动执行一系列钩子（例如，代码格式化、静态分析等）的工具。

配置文件示例：

repo: https://github.com/MarcoGorelli/absolufy-imports
rev: v0.3.1
hooks:
  - id: absolufy-imports

这段配置指定了在每次提交前，使用 absolufy-imports 的指定版本（v0.3.1）来检查和转换相对导入。

若项目目录遵循常见的 ./src 结构，可以通过 --application-directories 参数指定应用目录，例如：

absolufy-imports src/mypackage/myfile.py --application-directories src

这样设置后，absolufy-imports 会知道如何正确处理 src 目录下的文件。