定制 Weblate¶

使用 Django 和 Python 进行扩展和定制。将你的更改贡献给上游，让每个人都能受益。这降低了您的维护成本；当改变内部接口或重构代码时，Weblate 的代码会被照顾到。

提示

你也可以在外观自定义中定制 Weblate 外观。

警告

内部接口与模板都不被认为是稳定的 API。请每次升级都检查你的定制，接口或其语义可能未经通知就进行更改。

参见

为 Weblate 作贡献

建立 Python 模块¶

如果不熟悉 Python，你可以查看适合初学者的 Python（英文），它解释了其基本内容并指向了高级教程。

要写入有定制 Python 代码（被称为模块）的文件，需要一个地方存储它，或者在系统路径（通常像 /usr/lib/python3.12/site-packages/ 的地方），或者在 Weblate 目录下，同样也添加到解释程序搜索路径下。

提示

使用 Docker 时，你可将 Python 模块置于 /app/data/python/ (见 Docker 容器卷) 以便它们可以由 Weblate 从设置覆盖文件等处进行加载。

更好地是，将你的定制化转变为适当的 Python 包：

为你的包建立文件夹（我们会使用 weblate_customization）。

Within it, create a pyproject.toml file to describe the package:

[build-system]
requires = ["uv_build>=0.8.18,<0.9.0"]
build-backend = "uv_build"

[project]
name = "weblate-customization"
version = "0.1.0"
description = "Add your description here"
requires-python = ">=3.13"
dependencies = []

Create a folder for the Python module: src/weblate_customization
在里面建立 __init__.py 文件来确认 Python 可以导入模块。
This package can now be installed using uv pip install -e. More info to be found in Editable packages documentation.
模块一旦安装，就可以用在 Weblate 配置中（例如 weblate_customization.checks.FooCheck）。

你的包结构应该看起来像这样：

weblate_customization
├── pyproject.toml
└── src
    └── weblate_customization
        ├── __init__.py
        ├── addons.py
        └── checks.py

可以在 <https://github.com/WeblateOrg/customize-example> 找到定制 Weblate 的示例，它涵盖了下面描述的所有题目。

更改标志¶

建立简单的 Django app 来包含想要覆盖的静态文件（请参见建立 Python 模块）。

品牌出现在后面的文件中：

icons/weblate.svg
导航栏中显示的标志。

logo-*.png
网页图标取决于屏幕分辨率和浏览器。

favicon.ico
传统浏览器使用的网页图标。

weblate-*.png
机器人或匿名用户使用的头像。一些浏览器将这些图标用作快捷方式图标。

email-logo.png
在通知电子邮件中使用。

把它添加到 INSTALLED_APPS:

INSTALLED_APPS = (
    # Add your customization as first
    "weblate_customization",
    # Weblate apps are here…
)

运行 weblate collectstatic --noinput，来收集提供给客户端的静态文件。

参见

Custom quality checks, add-ons, automatic suggestions and auto-fixes¶

To install your code for 定制的自动修正, 编写自己的检查, 定制化的机器翻译 or 编写附加组件 in Weblate:

Place the files into your Python module containing the Weblate customization (see 建立 Python 模块 or 自定义代码).
Add its fully-qualified path to the Python class in the dedicated settings:

# Checks
CHECK_LIST += ("weblate_customization.checks.FooCheck",)

# Autofixes
AUTOFIX_LIST += ("weblate_customization.autofix.FooFixer",)

# Add-ons
WEBLATE_ADDONS += ("weblate_customization.addons.ExamplePreAddon",)

# Automatic suggestions
WEBLATE_MACHINERY += ("weblate_customization.machinery.SampleTranslation",)

参见