mirror of
https://gh.wpcy.net/https://github.com/WeblateOrg/weblate.git
synced 2026-04-25 07:06:32 +08:00
137 lines
3.3 KiB
ReStructuredText
137 lines
3.3 KiB
ReStructuredText
.. _internals:
|
|
|
|
Weblate internals
|
|
=================
|
|
|
|
.. note::
|
|
|
|
This chapter will give you basic overview of Weblate internals.
|
|
|
|
Weblate derives most of its code structure from, and is based on `Django`_.
|
|
|
|
Directory structure
|
|
-------------------
|
|
|
|
Quick overview of directory structure of Weblate main repository:
|
|
|
|
``docs``
|
|
Source code for this documentation, which can be built using `Sphinx <https://www.sphinx-doc.org/>`_.
|
|
``dev-docker``
|
|
Docker code to run development server, see :ref:`dev-docker`.
|
|
``weblate``
|
|
Source code of Weblate as a `Django <https://www.djangoproject.com/>`_ application, see :ref:`internals`.
|
|
``weblate/static``
|
|
Client files (CSS, Javascript and images), see :doc:`frontend`.
|
|
|
|
Modules
|
|
-------
|
|
|
|
Weblate consists of several Django applications (some optional, see
|
|
:doc:`/admin/optionals`):
|
|
|
|
``accounts``
|
|
|
|
User account, profiles and notifications.
|
|
|
|
``addons``
|
|
|
|
Add-ons to tweak Weblate behavior, see :ref:`addons`.
|
|
|
|
``api``
|
|
|
|
API based on `Django REST framework`_.
|
|
|
|
``auth``
|
|
|
|
Authentication and permissions.
|
|
|
|
``billing``
|
|
|
|
The optional :ref:`billing` module.
|
|
|
|
``checks``
|
|
|
|
Translation string :ref:`checks` module.
|
|
|
|
``fonts``
|
|
|
|
Font rendering checks module.
|
|
|
|
``formats``
|
|
|
|
File format abstraction layer based on translate-toolkit.
|
|
|
|
``gitexport``
|
|
|
|
The optional :ref:`git-exporter` module.
|
|
|
|
``lang``
|
|
|
|
Module defining language and plural models.
|
|
|
|
``legal``
|
|
|
|
The optional :ref:`legal` module.
|
|
|
|
``machinery``
|
|
|
|
Integration of machine translation services.
|
|
|
|
``memory``
|
|
|
|
Built-in translation memory, see :ref:`translation-memory`.
|
|
|
|
``screenshots``
|
|
|
|
Screenshots management and OCR module.
|
|
|
|
``trans``
|
|
|
|
Main module handling translations.
|
|
|
|
``utils``
|
|
|
|
Various helper utilities.
|
|
|
|
``vcs``
|
|
|
|
Version control system abstraction.
|
|
|
|
``wladmin``
|
|
|
|
Django admin interface customization.
|
|
|
|
|
|
.. _Django: https://www.djangoproject.com/
|
|
.. _Django REST framework: https://www.django-rest-framework.org/
|
|
|
|
.. _background-tasks-internals:
|
|
|
|
Background tasks internals
|
|
--------------------------
|
|
|
|
.. hint::
|
|
|
|
This section describes Celery task internals. :ref:`celery` describes how to configure Celery to run the tasks.
|
|
|
|
Weblate uses Celery to execute tasks in the background. Some tasks are
|
|
event-triggered, and some tasks are schedule-triggered.
|
|
|
|
The Celery Beat is used for scheduling tasks, and `django-celery-beat` is used
|
|
to store the periodic task schedule in the database. The tasks schedule is
|
|
configured in :file:`tasks.py` in each of the Django apps.
|
|
|
|
The tasks are consumed using several queues; the routing is configured in
|
|
:file:`settings.py`. The queues were designed to separate different types of
|
|
workload:
|
|
|
|
``celery``
|
|
The default queue where background tasks are processed.
|
|
``notify``
|
|
Delivers notification e-mails, both for events within Weblate and for authentication or registration. This is a separate queue to make e-mail delivery smooth even if there is a backlog of other tasks.
|
|
``memory``
|
|
Updates translation memory entries. The updating queue can be long when importing new strings, and long processing does not matter much here, so having a separate queue avoids blocking other tasks.
|
|
``backup``
|
|
The backup tasks cannot be executed in parallel, and a single dedicated worker makes this easier.
|
|
``translate``
|
|
Automatic translation tasks are known to take long because they hit external services.
|
