flake8-import-order 使用教程
flake8-import-orderFlake8 plugin that checks import order against various Python Style Guides项目地址:https://gitcode.com/gh_mirrors/fl/flake8-import-order
1. 项目的目录结构及介绍
flake8-import-order 是一个用于检查 Python 导入语句顺序的插件。以下是其基本目录结构:
flake8-import-order/
├── flake8_import_order/
│ ├── __init__.py
│ ├── formats.py
│ ├── import_order.py
│ ├── styles.py
│ └── tests/
│ ├── __init__.py
│ ├── test_import_order.py
│ └── test_styles.py
├── .flake8
├── .gitignore
├── .travis.yml
├── LICENSE
├── MANIFEST.in
├── README.rst
├── setup.cfg
├── setup.py
└── tox.ini
目录结构介绍
flake8_import_order/
: 包含插件的主要代码。
__init__.py
: 模块初始化文件。formats.py
: 定义导入语句的格式。import_order.py
: 主要逻辑文件,用于检查导入语句的顺序。styles.py
: 定义不同的导入风格。tests/
: 包含测试文件。
test_import_order.py
: 测试导入顺序的文件。test_styles.py
: 测试不同导入风格的文件。 .flake8
: flake8 配置文件。.gitignore
: Git 忽略文件配置。.travis.yml
: Travis CI 配置文件。LICENSE
: 项目许可证。MANIFEST.in
: 打包清单文件。README.rst
: 项目说明文档。setup.cfg
: setuptools 配置文件。setup.py
: 安装脚本。tox.ini
: tox 配置文件。
2. 项目的启动文件介绍
flake8-import-order 的启动文件是 flake8_import_order/__init__.py
。这个文件包含了插件的入口点,负责注册插件并将其集成到 flake8 中。
3. 项目的配置文件介绍
flake8-import-order 的配置文件是 .flake8
。这个文件用于配置 flake8 和 flake8-import-order 的行为。以下是一个示例配置:
[flake8]
import-order-style = google
application-import-names = mypackage,anotherpackage
配置项介绍
import-order-style
: 指定导入语句的风格,支持的风格有 cryptography
, google
, smarkets
, appnexus
等。application-import-names
: 指定应用特定的导入名称,用于区分标准库、第三方库和应用内部导入。
通过这些配置,可以自定义导入语句的检查规则,确保代码风格的一致性。
flake8-import-orderFlake8 plugin that checks import order against various Python Style Guides项目地址:https://gitcode.com/gh_mirrors/fl/flake8-import-order