Python API Weblate¶
Установка¶
Python API поставляется отдельно, чтобы он был у вас появился, вам нужно установить Клиент Weblate (wlc).
pip install wlc
wlc¶
WeblateException¶
- exception wlc.WeblateException¶
Базовый класс для всех исключений.
Weblate¶
- class wlc.Weblate(key='', url=None, config=None, retries=0, status_forcelist=None, allowed_methods=None, backoff_factor=0, timeout=300)¶
- Параметры:
key (str) – Ключ пользователя
url (str) – API server URL, if not specified default is used.
config (wlc.config.WeblateConfig) – Объект-конфигурация, может переопределять все остальные параметры.
retries (int) – Total number of HTTP retries.
status_forcelist (list) – HTTP status codes that should trigger retries.
allowed_methods (list) – HTTP methods that may be retried.
backoff_factor (float) – Retry backoff factor passed to urllib3.
timeout (int) – HTTP request timeout in seconds.
Класс доступа к API, определения ключа API и, необязательно, URL-адреса API.
- get(path)¶
- Параметры:
path (str) – Путь запроса
- Тип результата:
object
Выполняет единичный GET-вызов API.
- post(path, **kwargs)¶
- Параметры:
path (str) – Путь запроса
- Тип результата:
object
Выполняет единичный GET-вызов API.
wlc.config¶
WeblateConfig¶
- class wlc.config.WeblateConfig(section='wlc')¶
- Параметры:
section (str) – Используемый раздел конфигурации
Парсер файлов настроек, реализующий спецификацию XDG.
- load(path=None)¶
- Параметры:
path (str) – Путь к файлу, из которого загружаются настройки.
Loads configuration from
pathwhen it is specified. Otherwise it loads the discovered global configuration file and then the nearest project configuration file (.weblate,.weblate.ini, orweblate.ini) from the current directory or its parents.
wlc.main¶
- wlc.main.main(settings=None, stdout=None, args=None)¶
- Параметры:
settings (list) – Параметры для переопределения в виде списка кортежей
stdout (object) – Файловый объект стандартного потока вывода печати вывода, по умолчанию используется
sys.stdoutargs (list) – Аргументы командной строки для обработки, по умолчанию используется
sys.args
Главная точка входа для интерфейса командной строки.
- @wlc.main.register_command(command)¶
Декоратор для регистрации класса
Commandв основном анализаторе, используемом функциейmain().
Command¶
- class wlc.main.Command(args, config, stdout=None)¶
Главный класс для вызова команд.