专属
文档
插件
助手
邀请
顶部
快速返回页面顶部
收起
收起工具栏
轩辕镜像 官方专业版
轩辕镜像
专业版
轩辕镜像 官方专业版
轩辕镜像
专业版
首页个人中心搜索镜像

交易
充值流量我的订单

文档

工具

功能
提交工单页面收录

帮助
轩辕镜像免费版

其他
关于我们网站地图
热门搜索:
code-quality

plone/code-quality

plone

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

下载次数: 0状态：社区镜像维护者：plone仓库类型：镜像最近更新：1 个月前
让 AI 帮你使用轩辕镜像？ · 展开查看说明

如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。

只需在 AI 对话中先发送下面这句话即可：

请先完整阅读并严格遵守以下文档中的全部规则与要求：

https://xuanyuan.cloud/agents.md

在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。

查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。 若 AI 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。

中文简介
标签列表
镜像标签列表与下载命令
轩辕镜像，快一点，稳很多。
点击查看

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]([***]

许可证

项目采用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文件格式化）
  • 统一配置：通过项目根目录的__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]([***]

许可证

项目采用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文件格式化）
  • 统一配置：通过项目根目录的__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

登录仓库拉取

登录认证 · 私有仓库

专属域名拉取

免登录 · 高速拉取

Linux

Docker 镜像配置

Windows / Mac

Docker Desktop 配置

MacOS OrbStack

OrbStack 容器

Docker Compose

Compose 项目配置

NAS

群晖

Synology 配置

飞牛

fnOS 镜像配置

绿联

绿联 NAS

威联通

QNAP 配置

极空间

极空间 NAS

企业仓库

其他仓库

ghcr · Quay · nvcr

Harbor 镜像源

Proxy Repository 对接

Portainer 镜像源

Registries 配置

Nexus 镜像源

Docker Proxy 缓存

开发工具

Dev Containers

VS Code 开发容器

Podman

Podman 配置指南

Singularity / Apptainer

HPC 科学计算容器

Kubernetes

K8s Containerd

Kubernetes · Containerd

K3s

轻量级集群

面板 / 网络

爱快路由

iKuai 镜像加速

宝塔面板

一键配置镜像源

AI

用 AI 使用轩辕镜像

agents.md · AI 对话 · 提示词

一键安装

一键安装 Docker

Linux Docker 一键安装

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

镜像拉取常见问题

功能

免费版与专业版区别

功能对比 · 版本选择

支持的镜像仓库

Docker Hub · GCR · GHCR

新手拉取配置

登录 · 专属域名 · 配置

docker search 限制

专属域名 · Hub 搜索

不支持 push

仅支持 pull · 不支持

拉取速度原因

带宽 · 缓存 · 冷热镜像

错误码

402 与流量用尽

402 · 流量包 · 充值

401 认证失败

401 · docker login

manifest unknown

标签错误 · 镜像不存在

410 Gone 排查

410 · Docker 升级

429 限流

免费版 · 请求频率

其他报错

DNS 超时

DNS 解析 · 网络超时

TLS 证书失败

no matching manifest（架构）

账号

失败是否计费

manifest · blob · 计费

申请开发票（企业 / 个人）

企业 · 个人 · 工单

修改登录密码

网站 · 仓库 · 重置

注销账户

工单 · 数据 · 注销

原理

mirrors 不生效

daemon.json · 重启

去掉域名前缀

docker tag · 重命名

指定架构拉取

ARM64 · AMD64 · 多架构

latest 与「最新」

digest · 版本号 · 标签

查看全部问题→

用户好评

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

用户头像

oldzhang

运维工程师

Linux服务器

5

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

轩辕镜像
镜像详情
...
plone/code-quality
教程轩辕镜像功能与使用教程
定价查看流量套餐与价格
热门查看热门 Docker 镜像推荐
博客Docker 镜像公告与技术博客
官方公众号：源码跳动|官方技术交流群：831623681
官方公众号：源码跳动|官方技术交流群：|问题咨询请：提交工单
商务合作：点击复制邮箱
©2024-2026 源码跳动
商务合作：点击复制邮箱Copyright © 2024-2026 杭州源码跳动科技有限公司. All rights reserved.

更多 code-quality 镜像推荐

plone logo

library/plone

Docker 官方镜像
已弃用。Plone 是一个基于 Zope 应用服务器构建的免费开源内容管理系统。
102 次收藏500万+ 次下载
1 年前更新
plone/plone logo

plone/plone

plone
Plone Docker镜像基于Plone统一安装程序构建，支持通过环境变量配置插件，适用于Plone的测试、开发及主题定制等场景。
6 次收藏1万+ 次下载
5 年前更新
plone/plone-backend logo

plone/plone-backend

plone
Plone 6官方后端Docker镜像，使用Python 3和pip构建，非Buildout基础，与plone-frontend配合使用。
6 次收藏10万+ 次下载
1 个月前更新
plone/plone-frontend logo

plone/plone-frontend

plone
使用Node.js环境的Plone前端（Volto）Docker镜像，用于构建和部署Plone官方前端环境。
6 次收藏10万+ 次下载
9 天前更新
plone/plone-react logo

plone/plone-react

plone
Plone内容管理系统的React前端镜像，用于构建现代化、响应式的Plone CMS前端界面。
1万+ 次下载
7 年前更新
plone/server-acceptance logo

plone/server-acceptance

plone
暂无描述
10万+ 次下载
1 个月前更新

查看更多 code-quality 相关镜像