热门搜索:

plone/code-quality

plone

Plone代码质量工具，集成black、flake8、isort、pyroma、zpretty等检查器和格式化器，通过pyproject.toml配置，支持代码质量检查与自动格式化，适用于Plone项目及Python代码库的代码规范保障。

下载次数: 0状态：社区镜像维护者：plone仓库类型：镜像最近更新：1 年前

镜像标签列表与下载命令

Plone 代码质量工具

!GitHub 仓库星数

镜像概述

Plone 代码质量工具是一个集成多种代码检查器和格式化器的Docker镜像，旨在简化Plone项目及Python代码库的代码质量保障流程。该工具通过统一的配置和命令行接口，提供代码风格检查、语法分析和自动格式化功能，确保代码符合行业标准和项目规范。

核心功能与特性

多工具集成：整合black（代码格式化）、flake8（语法检查）、isort（导入排序）、pyroma（包质量检查）、zpretty（Zope/Plone特定文件格式化）等多种工具
灵活配置：通过项目根目录的pyproject.toml文件自定义检查器、格式化器、路径及各工具参数
检查与格式化分离：支持单独运行代码检查（不修改文件）或自动格式化（修改文件）
用户权限处理：格式化时可通过--user参数保持文件所有者信息，避免权限问题
即插即用：无需本地安装依赖，通过Docker容器直接运行，简化环境配置

配置说明

该工具通过项目根目录的pyproject.toml文件读取配置。

默认配置

默认配置值如下：

toml
[tool.plone-code-analysis]
checkers = ["black", "flake8", "isort", "pyroma", "zpretty"]
formatters = ["black", "isort", "zpretty"]
paths = "."
paths_pyroma = "."
paths_black = "."
paths_flake8 = "."
paths_isort = "."
paths_pyroma = "."
paths_zpretty = "."

自定义配置

修改路径

如需仅修改检查/格式化路径，在pyproject.toml中添加：

toml
[tool.plone-code-analysis]
paths = "src/ setup.py"

工具单独路径

可针对不同工具设置单独路径：

toml
[tool.plone-code-analysis]
paths_black = "src/ tests/ setup.py"
paths_flake8 = "src/ setup.py"

自定义检查器/格式化器

显式指定要使用的检查器或格式化器：

toml
[tool.plone-code-analysis]
checkers = ["black", "flake8", "isort", "pyroma"]
formatters = ["black", "isort"]

工具详细配置

black、flake8（通过flakeheaven）和isort的详细配置也在pyproject.toml中设置。示例配置：

toml
[tool.black]
line-length = 88
target-version = ['py38']
include = '\.pyi?

## 使用方法

首先进入需要检查或格式化的代码仓库目录。

### 代码检查（Linter）

#### 运行所有检查

使用`pyproject.toml`中的配置运行所有检查器：

```bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check

检查特定工具

black检查

使用配置文件检查：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check black

显式检查指定目录和文件：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check black src setup.py

flake8检查

使用flakeheaven配置的flake8检查，包含插件：flake8-blind-except、flake8-debugger、flake8-print。

使用配置文件检查：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check flake8

显式检查指定目录和文件：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check flake8 src setup.py

isort检查

使用配置文件检查：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check isort

显式检查指定目录和文件：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check isort src setup.py

pyroma检查

使用配置文件检查：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check pyroma

显式检查指定包目录：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check pyroma src/mypackage

zpretty检查

使用配置文件检查：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check zpretty

显式检查指定目录：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check zpretty src

代码格式化

为避免修改文件的所有者和组信息，格式化时需通过--user参数指定当前用户ID和组ID。以下示例使用"$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)"获取当前用户信息。

运行所有格式化器

使用pyproject.toml配置运行所有格式化器：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format

特定工具格式化

black格式化

使用配置文件格式化：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format black

显式格式化指定目录和文件：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format src setup.py

isort格式化

使用配置文件格式化：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format isort

显式格式化指定目录和文件：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format src setup.py

zpretty格式化

使用配置文件格式化：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format zpretty

显式格式化指定目录：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format src

贡献

问题跟踪：https://github.com/plone/code-quality/issues
源代码：https://github.com/plone/code-quality/
文档：https://github.com/plone/code-quality/

请注意：不要直接提交到版本分支，即使是最小的修复。始终创建拉取请求并请求他人合并，不要自行合并。

本地代码检查

使用本工具检查自身代码库：

shell
make lint-all

增加详细程度：

shell
LOG_LEVEL=DEBUG make lint-all

本地代码格式化

使用本工具格式化自身代码库：

shell
make format

增加详细程度：

shell
LOG_LEVEL=DEBUG make format

本地测试

测试使用pytest实现，可通过以下命令运行：

shell
make build
make test

credits

基于kitconcept GmbH最初开发的解决方案。

https://raw.githubusercontent.com/plone/.github/main/plone-foundation.png]([***]

许可证

项目采用GPLv2许可证。<|FCResponseEnd|>===SHORT_DESC=== Plone代码质量工具，集成black、flake8、isort等多种检查器和格式化器，通过pyproject.toml配置，支持代码质量检查与自动格式化，适用于Plone项目及Python代码库的代码规范保障。 ===FULL_DESC===# Plone 代码质量工具

!GitHub 仓库星数

镜像概述

Plone代码质量工具是一个集成多种代码检查和格式化工具的Docker镜像，旨在为Plone项目及Python代码库提供统一的代码质量保障解决方案。通过简单的命令行接口和灵活的配置，可实现代码风格检查、语法分析和自动格式化，确保代码符合行业标准和项目规范。

核心功能与特性

多工具集成：整合black（代码格式化）、flake8（语法检查）、isort（导入排序）、pyroma（包质量检查）和zpretty（Zope/Plone文件格式化）
统一配置：通过项目根目录的pyproject.toml文件集中配置所有工具参数、检查路径和启用状态
检查与格式化分离：支持仅检查代码问题（不修改文件）或自动格式化代码（修改文件）两种模式
灵活路径控制：可全局设置检查路径，也可针对不同工具单独配置路径
权限兼容：格式化时支持保留文件原有所有者信息，避免权限问题

配置说明

工具通过项目根目录的pyproject.toml文件读取配置。

默认配置

默认配置值如下：

toml
[tool.plone-code-analysis]
checkers = ["black", "flake8", "isort", "pyroma", "zpretty"]
formatters = ["black", "isort", "zpretty"]
paths = "."
paths_pyroma = "."
paths_black = "."
paths_flake8 = "."
paths_isort = "."
paths_pyroma = "."
paths_zpretty = "."

自定义配置

修改全局路径

如需修改所有工具的默认检查路径，添加：

toml
[tool.plone-code-analysis]
paths = "src/ setup.py"

工具单独路径配置

可针对特定工具设置独立路径：

toml
[tool.plone-code-analysis]
paths_black = "src/ tests/ setup.py"  # black检查路径
paths_flake8 = "src/ setup.py"        # flake8检查路径

自定义检查器和格式化器

显式指定要启用的检查器或格式化器：

toml
[tool.plone-code-analysis]
checkers = ["black", "flake8", "isort"]  # 仅启用这些检查器
formatters = ["black", "isort"]          # 仅启用这些格式化器

工具详细配置

black、flake8（通过flakeheaven）和isort的详细配置也在pyproject.toml中设置。示例配置：

toml
[tool.black]
line-length = 88
target-version = ['py38']
include = '\.pyi?

## 使用方法

### 前提条件

进入需要检查或格式化的代码仓库目录。

### 代码检查（Linter）

#### 运行所有检查

使用`pyproject.toml`配置运行所有检查器：

```bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check

单独工具检查

black检查

使用配置文件检查：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check black

显式指定检查目录和文件：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check black src setup.py

flake8检查

Flake8检查（含flake8-blind-except、flake8-debugger、flake8-print插件）：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check flake8

显式指定检查目录和文件：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check flake8 src setup.py

isort检查

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check isort

显式指定检查目录和文件：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check isort src setup.py

pyroma检查

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check pyroma

显式指定检查包目录：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check pyroma src/mypackage

zpretty检查

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check zpretty

显式指定检查目录：

bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check zpretty src

代码格式化

格式化会修改文件内容，为保留文件所有者信息，需通过--user参数指定当前用户ID和组ID。以下示例使用"$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)"自动获取当前用户信息。

运行所有格式化器

使用配置文件运行所有格式化器：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format

单独工具格式化

black格式化

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format black

显式指定格式化目录和文件：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format src setup.py

isort格式化

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3)" --rm -v "${PWD}":/github/workspace plone/code-quality:latest format isort

显式指定格式化目录和文件：

bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3

[tool.isort]
profile = "black"
force_alphabetical_sort = true
force_single_line = true
lines_after_imports = 2
line_length = 120

[tool.flakeheaven]
format="grouped"
max_line_length=88
show_source=true
max-complexity=25

[tool.flakeheaven.plugins]
pycodestyle = ["+*"]
pyflakes = ["+*"]
"flake8-*" = ["+*"]

[tool.plone-code-analysis]
paths = "docker-entrypoint.py src/setup.py src/plone_code_analysis tests/fixtures/packages/ok tests/package tests/conftest.py"
paths_pyroma = "src/ tests/fixtures/packages/ok"

使用方法

首先进入需要检查或格式化的代码仓库目录。

代码检查（Linter）

运行所有检查

使用__CODE_TOKEN_53__中的配置运行所有检查器：

CODE_TOKEN_5

检查特定工具

black检查

使用配置文件检查：

CODE_TOKEN_6

显式检查指定目录和文件：

CODE_TOKEN_7

flake8检查

使用flakeheaven配置的flake8检查，包含插件：flake8-blind-except、flake8-debugger、flake8-print。

使用配置文件检查：

CODE_TOKEN_8

显式检查指定目录和文件：

CODE_TOKEN_9

isort检查

使用配置文件检查：

CODE_TOKEN_10

显式检查指定目录和文件：

CODE_TOKEN_11

pyroma检查

使用配置文件检查：

CODE_TOKEN_12

显式检查指定包目录：

CODE_TOKEN_13

zpretty检查

使用配置文件检查：

CODE_TOKEN_14

显式检查指定目录：

CODE_TOKEN_15

代码格式化

为避免修改文件的所有者和组信息，格式化时需通过__CODE_TOKEN_54__参数指定当前用户ID和组ID。以下示例使用__CODE_TOKEN_55__获取当前用户信息。

运行所有格式化器

使用__CODE_TOKEN_56__配置运行所有格式化器：

CODE_TOKEN_16

特定工具格式化

black格式化

使用配置文件格式化：

CODE_TOKEN_17

显式格式化指定目录和文件：

CODE_TOKEN_18

isort格式化

使用配置文件格式化：

CODE_TOKEN_19

显式格式化指定目录和文件：

CODE_TOKEN_20

zpretty格式化

使用配置文件格式化：

CODE_TOKEN_21

显式格式化指定目录：

CODE_TOKEN_22

贡献

问题跟踪：https://github.com/plone/code-quality/issues
源代码：https://github.com/plone/code-quality/
文档：https://github.com/plone/code-quality/

请注意：不要直接提交到版本分支，即使是最小的修复。始终创建拉取请求并请求他人合并，不要自行合并。

本地代码检查

使用本工具检查自身代码库：

CODE_TOKEN_23

增加详细程度：

CODE_TOKEN_24

本地代码格式化

使用本工具格式化自身代码库：

CODE_TOKEN_25

增加详细程度：

CODE_TOKEN_26

本地测试

测试使用__CODE_TOKEN_57__实现，可通过以下命令运行：

CODE_TOKEN_27

credits

基于kitconcept GmbH最初开发的解决方案。

https://raw.githubusercontent.com/plone/.github/main/plone-foundation.png]([***]

许可证

!GitHub 仓库星数

镜像概述

核心功能与特性

多工具集成：整合black（代码格式化）、flake8（语法检查）、isort（导入排序）、pyroma（包质量检查）和zpretty（Zope/Plone文件格式化）
统一配置：通过项目根目录的__CODE_TOKEN_58__文件集中配置所有工具参数、检查路径和启用状态
检查与格式化分离：支持仅检查代码问题（不修改文件）或自动格式化代码（修改文件）两种模式
灵活路径控制：可全局设置检查路径，也可针对不同工具单独配置路径
权限兼容：格式化时支持保留文件原有所有者信息，避免权限问题

配置说明

工具通过项目根目录的__CODE_TOKEN_59__文件读取配置。

默认配置

默认配置值如下：

CODE_TOKEN_28

自定义配置

修改全局路径

如需修改所有工具的默认检查路径，添加：

CODE_TOKEN_29

工具单独路径配置

可针对特定工具设置独立路径：

CODE_TOKEN_30

自定义检查器和格式化器

显式指定要启用的检查器或格式化器：

CODE_TOKEN_31

工具详细配置

black、flake8（通过flakeheaven）和isort的详细配置也在__CODE_TOKEN_60__中设置。示例配置：

CODE_TOKEN_32

使用方法

前提条件

进入需要检查或格式化的代码仓库目录。

代码检查（Linter）

运行所有检查

使用__CODE_TOKEN_61__配置运行所有检查器：

CODE_TOKEN_33

单独工具检查

black检查

使用配置文件检查：

CODE_TOKEN_34

显式指定检查目录和文件：

CODE_TOKEN_35

flake8检查

Flake8检查（含flake8-blind-except、flake8-debugger、flake8-print插件）：

CODE_TOKEN_36

显式指定检查目录和文件：

CODE_TOKEN_37

isort检查

CODE_TOKEN_38

显式指定检查目录和文件：

CODE_TOKEN_39

pyroma检查

CODE_TOKEN_40

显式指定检查包目录：

CODE_TOKEN_41

zpretty检查

CODE_TOKEN_42

显式指定检查目录：

CODE_TOKEN_43

代码格式化

格式化会修改文件内容，为保留文件所有者信息，需通过__CODE_TOKEN_62__参数指定当前用户ID和组ID。以下示例使用__CODE_TOKEN_63__自动获取当前用户信息。

运行所有格式化器

使用配置文件运行所有格式化器：

CODE_TOKEN_44

单独工具格式化

black格式化

CODE_TOKEN_45

显式指定格式化目录和文件：

CODE_TOKEN_46

isort格式化

CODE_TOKEN_47

显式指定格式化目录和文件：

CODE_TOKEN_64`bash docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3

[tool.isort] profile = "black" force_alphabetical_sort = true force_single_line = true lines_after_imports = 2 line_length = 120

[tool.flakeheaven] format="grouped" max_line_length=88 show_source=true max-complexity=25

[tool.flakeheaven.plugins] pycodestyle = ["+"] pyflakes = ["+"] "flake8-" = ["+"]

[tool.plone-code-analysis] paths = "src/ setup.py tests/" paths_pyroma = "src/"


## 使用方法

### 前提条件

进入需要检查或格式化的代码仓库目录。

### 代码检查（Linter）

#### 运行所有检查

使用__CODE_TOKEN_61__配置运行所有检查器：

__CODE_TOKEN_33__

#### 单独工具检查

##### black检查

使用配置文件检查：

__CODE_TOKEN_34__

显式指定检查目录和文件：

__CODE_TOKEN_35__

##### flake8检查

Flake8检查（含flake8-blind-except、flake8-debugger、flake8-print插件）：

__CODE_TOKEN_36__

显式指定检查目录和文件：

__CODE_TOKEN_37__

##### isort检查

__CODE_TOKEN_38__

显式指定检查目录和文件：

__CODE_TOKEN_39__

##### pyroma检查

__CODE_TOKEN_40__

显式指定检查包目录：

__CODE_TOKEN_41__

##### zpretty检查

__CODE_TOKEN_42__

显式指定检查目录：

__CODE_TOKEN_43__

### 代码格式化

格式化会修改文件内容，为保留文件所有者信息，需通过__CODE_TOKEN_62__参数指定当前用户ID和组ID。以下示例使用__CODE_TOKEN_63__自动获取当前用户信息。

#### 运行所有格式化器

使用配置文件运行所有格式化器：

__CODE_TOKEN_44__

#### 单独工具格式化

##### black格式化

__CODE_TOKEN_45__

显式指定格式化目录和文件：

__CODE_TOKEN_46__

##### isort格式化

__CODE_TOKEN_47__

显式指定格式化目录和文件：

__CODE_TOKEN_64__`bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3

[tool.isort]
profile = "black"
force_alphabetical_sort = true
force_single_line = true
lines_after_imports = 2
line_length = 120

[tool.flakeheaven]
format="grouped"
max_line_length=88
show_source=true
max-complexity=25

[tool.flakeheaven.plugins]
pycodestyle = ["+*"]
pyflakes = ["+*"]
"flake8-*" = ["+*"]

[tool.plone-code-analysis]
paths = "docker-entrypoint.py src/setup.py src/plone_code_analysis tests/fixtures/packages/ok tests/package tests/conftest.py"
paths_pyroma = "src/ tests/fixtures/packages/ok"

使用方法

首先进入需要检查或格式化的代码仓库目录。

代码检查（Linter）

运行所有检查

使用__CODE_TOKEN_53__中的配置运行所有检查器：

CODE_TOKEN_5

检查特定工具

black检查

使用配置文件检查：

CODE_TOKEN_6

显式检查指定目录和文件：

CODE_TOKEN_7

flake8检查

使用flakeheaven配置的flake8检查，包含插件：flake8-blind-except、flake8-debugger、flake8-print。

使用配置文件检查：

CODE_TOKEN_8

显式检查指定目录和文件：

CODE_TOKEN_9

isort检查

使用配置文件检查：

CODE_TOKEN_10

显式检查指定目录和文件：

CODE_TOKEN_11

pyroma检查

使用配置文件检查：

CODE_TOKEN_12

显式检查指定包目录：

CODE_TOKEN_13

zpretty检查

使用配置文件检查：

CODE_TOKEN_14

显式检查指定目录：

CODE_TOKEN_15

代码格式化

为避免修改文件的所有者和组信息，格式化时需通过__CODE_TOKEN_54__参数指定当前用户ID和组ID。以下示例使用__CODE_TOKEN_55__获取当前用户信息。

运行所有格式化器

使用__CODE_TOKEN_56__配置运行所有格式化器：

CODE_TOKEN_16

特定工具格式化

black格式化

使用配置文件格式化：

CODE_TOKEN_17

显式格式化指定目录和文件：

CODE_TOKEN_18

isort格式化

使用配置文件格式化：

CODE_TOKEN_19

显式格式化指定目录和文件：

CODE_TOKEN_20

zpretty格式化

使用配置文件格式化：

CODE_TOKEN_21

显式格式化指定目录：

CODE_TOKEN_22

贡献

问题跟踪：https://github.com/plone/code-quality/issues
源代码：https://github.com/plone/code-quality/
文档：https://github.com/plone/code-quality/

请注意：不要直接提交到版本分支，即使是最小的修复。始终创建拉取请求并请求他人合并，不要自行合并。

本地代码检查

使用本工具检查自身代码库：

CODE_TOKEN_23

增加详细程度：

CODE_TOKEN_24

本地代码格式化

使用本工具格式化自身代码库：

CODE_TOKEN_25

增加详细程度：

CODE_TOKEN_26

本地测试

测试使用__CODE_TOKEN_57__实现，可通过以下命令运行：

CODE_TOKEN_27

credits

基于kitconcept GmbH最初开发的解决方案。

https://raw.githubusercontent.com/plone/.github/main/plone-foundation.png]([***]

许可证

!GitHub 仓库星数

镜像概述

核心功能与特性

多工具集成：整合black（代码格式化）、flake8（语法检查）、isort（导入排序）、pyroma（包质量检查）和zpretty（Zope/Plone文件格式化）
统一配置：通过项目根目录的__CODE_TOKEN_58__文件集中配置所有工具参数、检查路径和启用状态
检查与格式化分离：支持仅检查代码问题（不修改文件）或自动格式化代码（修改文件）两种模式
灵活路径控制：可全局设置检查路径，也可针对不同工具单独配置路径
权限兼容：格式化时支持保留文件原有所有者信息，避免权限问题

配置说明

工具通过项目根目录的__CODE_TOKEN_59__文件读取配置。

默认配置

默认配置值如下：

CODE_TOKEN_28

自定义配置

修改全局路径

如需修改所有工具的默认检查路径，添加：

CODE_TOKEN_29

工具单独路径配置

可针对特定工具设置独立路径：

CODE_TOKEN_30

自定义检查器和格式化器

显式指定要启用的检查器或格式化器：

CODE_TOKEN_31

工具详细配置

black、flake8（通过flakeheaven）和isort的详细配置也在__CODE_TOKEN_60__中设置。示例配置：

CODE_TOKEN_32

使用方法

前提条件

进入需要检查或格式化的代码仓库目录。

代码检查（Linter）

运行所有检查

使用__CODE_TOKEN_61__配置运行所有检查器：

CODE_TOKEN_33

单独工具检查

black检查

使用配置文件检查：

CODE_TOKEN_34

显式指定检查目录和文件：

CODE_TOKEN_35

flake8检查

Flake8检查（含flake8-blind-except、flake8-debugger、flake8-print插件）：

CODE_TOKEN_36

显式指定检查目录和文件：

CODE_TOKEN_37

isort检查

CODE_TOKEN_38

显式指定检查目录和文件：

CODE_TOKEN_39

pyroma检查

CODE_TOKEN_40

显式指定检查包目录：

CODE_TOKEN_41

zpretty检查

CODE_TOKEN_42

显式指定检查目录：

CODE_TOKEN_43

代码格式化

格式化会修改文件内容，为保留文件所有者信息，需通过__CODE_TOKEN_62__参数指定当前用户ID和组ID。以下示例使用__CODE_TOKEN_63__自动获取当前用户信息。

运行所有格式化器

使用配置文件运行所有格式化器：

CODE_TOKEN_44

单独工具格式化

black格式化

CODE_TOKEN_45

显式指定格式化目录和文件：

CODE_TOKEN_46

isort格式化

CODE_TOKEN_47

显式指定格式化目录和文件：

CODE_TOKEN_64`bash docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3

镜像拉取方式

您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问标签列表页面。

轩辕镜像加速拉取命令点我查看更多 code-quality 镜像标签

docker pull docker.xuanyuan.run/plone/code-quality:<标签>

使用方法：

DockerHub 原生拉取命令

docker pull plone/code-quality:<标签>

轩辕镜像配置手册

探索更多轩辕镜像的使用方法，找到最适合您系统的配置方式

Docker 配置

登录仓库拉取

通过 Docker 登录认证访问私有仓库

专属域名拉取

无需登录使用专属域名

K8s Containerd

Kubernetes 集群配置 Containerd

K3s

K3s 轻量级 Kubernetes 镜像加速

Dev Containers

VS Code Dev Containers 配置

Podman

Podman 容器引擎配置

Singularity/Apptainer

HPC 科学计算容器配置

其他仓库配置

ghcr、Quay、nvcr 等镜像仓库

Harbor 镜像源配置

Harbor Proxy Repository 对接专属域名

Portainer 镜像源配置

Portainer Registries 加速拉取

Nexus 镜像源配置

Nexus3 Docker Proxy 内网缓存

系统配置

Linux

在 Linux 系统配置镜像服务

Windows/Mac

在 Docker Desktop 配置镜像

MacOS OrbStack

MacOS OrbStack 容器配置

Docker Compose

Docker Compose 项目配置

NAS 设备

群晖

Synology 群晖 NAS 配置

飞牛

飞牛 fnOS 系统配置镜像

绿联

绿联 NAS 系统配置镜像

威联通

QNAP 威联通 NAS 配置

极空间

极空间 NAS 系统配置服务

网络设备

爱快路由

爱快 iKuai 路由系统配置

宝塔面板

在宝塔面板一键配置镜像

需要其他帮助？请查看我们的常见问题Docker 镜像访问常见问题解答或提交工单

镜像拉取常见问题

使用与功能问题

配置了专属域名后，docker search 为什么会报错？

docker search 限制

Docker Hub 上有的镜像，为什么在轩辕镜像网站搜不到？

站内搜不到镜像

机器不能直连外网时，怎么用 docker save / load 迁镜像？

离线 save/load

docker pull 拉插件报错（plugin v1+json）怎么办？

插件要用 plugin install

WSL 里 Docker 拉镜像特别慢，怎么排查和优化？

WSL 拉取慢

轩辕镜像安全吗？如何用 digest 校验镜像没被篡改？

安全与 digest

第一次用轩辕镜像拉 Docker 镜像，要怎么登录和配置？

新手拉取配置

轩辕镜像合规吗？轩辕镜像的合规是怎么做的？

镜像合规机制

错误码与失败问题

docker pull 提示 manifest unknown 怎么办？

manifest unknown

docker pull 提示 no matching manifest 怎么办？

no matching manifest（架构）

镜像已拉取完成，却提示 invalid tar header 或 failed to register layer 怎么办？

invalid tar header（解压）

Docker pull 时 HTTPS / TLS 证书验证失败怎么办？

TLS 证书失败

Docker pull 时 DNS 解析超时或连不上仓库怎么办？

DNS 超时

docker 无法连接轩辕镜像域名怎么办？

域名连通性排查

Docker 拉取出现 410 Gone 怎么办？

410 Gone 排查

出现 402 或「流量用尽」提示怎么办？

402 与流量用尽

Docker 拉取提示 UNAUTHORIZED（401）怎么办？

401 认证失败

遇到 429 Too Many Requests（请求太频繁）怎么办？

429 限流

docker login 提示 Cannot autolaunch D-Bus，还算登录成功吗？

D-Bus 凭证提示

为什么会出现「单层超过 20GB」或 413，无法加速拉取？

413 与超大单层

账号 / 计费 / 权限

轩辕镜像免费版和专业版有什么区别？

免费版与专业版区别

轩辕镜像支持哪些 Docker 镜像仓库？

支持的镜像仓库

镜像拉取失败还会不会扣流量？

失败是否计费

麒麟 V10 / 统信 UOS 提示 KYSEC 权限不够怎么办？

KYSEC 拦截脚本

如何在轩辕镜像申请开具发票？

申请开票

怎么修改轩辕镜像的网站登录和仓库登录密码？

修改登录密码

如何注销轩辕镜像账户？要注意什么？

注销账户

配置与原理类

写了 registry-mirrors，为什么还是走官方或仍然报错？

mirrors 不生效

怎么用 docker tag 去掉镜像名里的轩辕域名前缀？

去掉域名前缀

如何拉取指定 CPU 架构的镜像（如 ARM64、AMD64）？

指定架构拉取

用轩辕镜像拉镜像时快时慢，常见原因有哪些？

拉取速度原因

查看全部问题→

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

"Docker访问体验非常流畅，大镜像也能快速完成下载。"

toml

[tool.plone-code-analysis]
checkers = ["black", "flake8", "isort", "pyroma", "zpretty"]
formatters = ["black", "isort", "zpretty"]
paths = "."
paths_pyroma = "."
paths_black = "."
paths_flake8 = "."
paths_isort = "."
paths_pyroma = "."
paths_zpretty = "."

toml

[tool.black]
line-length = 88
target-version = ['py38']
include = '\.pyi?

## 使用方法

首先进入需要检查或格式化的代码仓库目录。

### 代码检查（Linter）

#### 运行所有检查

使用`pyproject.toml`中的配置运行所有检查器：

```bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check

toml

[tool.plone-code-analysis]
checkers = ["black", "flake8", "isort", "pyroma", "zpretty"]
formatters = ["black", "isort", "zpretty"]
paths = "."
paths_pyroma = "."
paths_black = "."
paths_flake8 = "."
paths_isort = "."
paths_pyroma = "."
paths_zpretty = "."

toml

[tool.black]
line-length = 88
target-version = ['py38']
include = '\.pyi?

## 使用方法

### 前提条件

进入需要检查或格式化的代码仓库目录。

### 代码检查（Linter）

#### 运行所有检查

使用`pyproject.toml`配置运行所有检查器：

```bash
docker run --rm -v "${PWD}":/github/workspace plone/code-quality:latest check

bash

docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3

[tool.isort]
profile = "black"
force_alphabetical_sort = true
force_single_line = true
lines_after_imports = 2
line_length = 120

[tool.flakeheaven]
format="grouped"
max_line_length=88
show_source=true
max-complexity=25

[tool.flakeheaven.plugins]
pycodestyle = ["+*"]
pyflakes = ["+*"]
"flake8-*" = ["+*"]

[tool.plone-code-analysis]
paths = "docker-entrypoint.py src/setup.py src/plone_code_analysis tests/fixtures/packages/ok tests/package tests/conftest.py"
paths_pyroma = "src/ tests/fixtures/packages/ok"


## 使用方法

### 前提条件

进入需要检查或格式化的代码仓库目录。

### 代码检查（Linter）

#### 运行所有检查

使用__CODE_TOKEN_61__配置运行所有检查器：

__CODE_TOKEN_33__

#### 单独工具检查

##### black检查

使用配置文件检查：

__CODE_TOKEN_34__

显式指定检查目录和文件：

__CODE_TOKEN_35__

##### flake8检查

Flake8检查（含flake8-blind-except、flake8-debugger、flake8-print插件）：

__CODE_TOKEN_36__

显式指定检查目录和文件：

__CODE_TOKEN_37__

##### isort检查

__CODE_TOKEN_38__

显式指定检查目录和文件：

__CODE_TOKEN_39__

##### pyroma检查

__CODE_TOKEN_40__

显式指定检查包目录：

__CODE_TOKEN_41__

##### zpretty检查

__CODE_TOKEN_42__

显式指定检查目录：

__CODE_TOKEN_43__

### 代码格式化

格式化会修改文件内容，为保留文件所有者信息，需通过__CODE_TOKEN_62__参数指定当前用户ID和组ID。以下示例使用__CODE_TOKEN_63__自动获取当前用户信息。

#### 运行所有格式化器

使用配置文件运行所有格式化器：

__CODE_TOKEN_44__

#### 单独工具格式化

##### black格式化

__CODE_TOKEN_45__

显式指定格式化目录和文件：

__CODE_TOKEN_46__

##### isort格式化

__CODE_TOKEN_47__

显式指定格式化目录和文件：

__CODE_TOKEN_64__`bash
docker run --user="$(id -u $(whoami)):$(getent group $(whoami)|cut -d: -f3

[tool.isort]
profile = "black"
force_alphabetical_sort = true
force_single_line = true
lines_after_imports = 2
line_length = 120

[tool.flakeheaven]
format="grouped"
max_line_length=88
show_source=true
max-complexity=25

[tool.flakeheaven.plugins]
pycodestyle = ["+*"]
pyflakes = ["+*"]
"flake8-*" = ["+*"]

[tool.plone-code-analysis]
paths = "docker-entrypoint.py src/setup.py src/plone_code_analysis tests/fixtures/packages/ok tests/package tests/conftest.py"
paths_pyroma = "src/ tests/fixtures/packages/ok"

镜像拉取方式

您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问标签列表页面。

plone/code-quality

Plone代码质量工具，集成black、flake8、isort、pyroma、zpretty等检查器和格式化器，通过pyproject.toml配置，支持代码质量检查与自动格式化，适用于Plone项目及Python代码库的代码规范保障。

Plone 代码质量工具

镜像概述

核心功能与特性

配置说明

默认配置

自定义配置

工具详细配置

代码格式化

贡献

本地代码检查

本地代码格式化

本地测试

credits

许可证

镜像概述

核心功能与特性

配置说明

默认配置

自定义配置

工具详细配置

代码格式化

使用方法

代码检查（Linter）

代码格式化

贡献

本地代码检查

本地代码格式化

本地测试

credits

许可证

镜像概述

核心功能与特性

配置说明

默认配置

自定义配置

工具详细配置

使用方法

前提条件

代码检查（Linter）

代码格式化

使用方法

代码检查（Linter）

代码格式化

贡献

本地代码检查

本地代码格式化

本地测试

credits

许可证

镜像概述

核心功能与特性

配置说明

默认配置

自定义配置

工具详细配置

使用方法

前提条件

代码检查（Linter）

代码格式化

镜像拉取方式

轩辕镜像加速拉取命令点我查看更多 code-quality 镜像标签

DockerHub 原生拉取命令

更多 code-quality 镜像推荐

kasmweb/vs-code

codeception/codeception

jetbrains/code-with-me-relay

linuxserver/code-server

ai/qwen3-coder

demisto/qrcode

查看更多 code-quality 相关镜像

轩辕镜像配置手册

Docker 配置

登录仓库拉取

专属域名拉取

K8s Containerd

K3s

Dev Containers

Podman