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) – URL-адрес сервера API; если не указан, используется значение по умолчанию.

  • config (wlc.config.WeblateConfig) – Объект-конфигурация, может переопределять все остальные параметры.

  • retries (int) – Общее количество повторных попыток HTTP.

  • status_forcelist (list) – Коды состояния HTTP, которые должны инициировать повторные попытки.

  • allowed_methods (list) – Методы HTTP, которые могут быть повторены.

  • backoff_factor (float) – Коэффициент задержки повторных попыток, передаваемый в urllib3.

  • timeout (int) – Время ожидания HTTP-запроса в секундах.

Класс доступа к 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) – Путь к файлу, из которого загружаются настройки.

Загружает конфигурацию из path, если он указан. В противном случае он загружает обнаруженный глобальный файл конфигурации, а затем ближайший файл конфигурации проекта (.weblate, .weblate.ini или weblate.ini) из текущего каталога или его родительских каталогов.

wlc.main

wlc.main.main(settings=None, stdout=None, args=None)
Параметры:

  • settings (list) – Параметры для переопределения в виде списка кортежей

  • stdout (object) – Файловый объект стандартного потока вывода печати вывода, по умолчанию используется sys.stdout

  • args (list) – Аргументы командной строки для обработки, по умолчанию используется sys.args

Главная точка входа для интерфейса командной строки.

@wlc.main.register_command(command)

Декоратор для регистрации класса Command в основном анализаторе, используемом функцией main().

Command

class wlc.main.Command(args, config, stdout=None)

Главный класс для вызова команд.