tox-ini-fmt

对tox.ini文件应用一致的格式

安装

pip安装tox-ini-fmt

作为pre-commit钩子

有关说明，请参阅pre-commit

示例.pre-commit-config.yaml

- repo: https://github.com/tox-dev/tox-ini-fmt
  rev: "1.3.1"
  hooks:
    - id: tox-ini-fmt
      args: ["-p", "fix_lint,type"]

命令行界面

查阅帮助了解最新用法

$ tox-ini-fmt --help
usage: tox-ini-fmt [-h] [-s] [-p toxenv] tox_ini

positional arguments:
  tox_ini       tox ini file to format

optional arguments:
  -h, --help    show this help message and exit
  -s, --stdout  print the formatted text to the stdout (instead of update in-place)
  -p toxenv     tox environments that pin to the start of the envlist (comma separated)

它是做什么的？

它不做

• 不会格式化除tox/testenv:*以外的任何部分（除了将这些部分放在文件末尾）

一般

• boolean字段被标准化为true或false
• 所有字段都去除了两端空白
• 包含列表的值将按每行一个值进行分割（对PR/合并友好）
• 多行值缩进四个空格，并在新行开始
• 多行中的替换（不包括commands）将被移动到列表的开始处（顺序保持不变）

部分顺序

应用以下部分顺序

1. tox
2. testenv
3. testenv:* - 按Python版本递减顺序对py/pypy环境进行排序，然后应用tox部分中envlist部分定义的顺序，您可以使用-p标志将tox元素固定到开头
4. 文件中定义的任何其他部分

tox部分

排序依据

1. envlist - 多行，以递减的Python顺序开始py环境，然后是pypy，然后是其他所有内容
2. isolated_build - boolean字段
3. skipsdist - boolean字段
4. skip_missing_interpreters - boolean字段
5. minversion

testenv部分

排序依据

1. 描述
2. passenv - 多行，每行一个环境名称，按名称排序
3. setenv - 多行，每行一个环境名称值，格式为key=value，按key+value排序
4. basepython
5. skip_install - boolean字段
6. usedevelop - boolean字段
7. deps - 多行，按包名排序（但保持与包名相关的依赖项在末尾分开），规范化格式以删除额外空格
8. extras - 多行，每行一个额外环境
9. parallel_show_output - boolean字段
10. commands - 每行一个命令，跨多行的命令从第二行或以后缩进额外四个空格