Програмний інтерфейс Python Weblate

Установлення

Програмний інтерфейс Python постачається окремо. Вам слід встановити Клієнт 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) – 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.

Клас доступу до програмного інтерфейсу, визначає ключ до програмного інтерфейсу і, необов’язково, адресу програмного інтерфейсу.

get(path)
Параметри:

path (str) – Шлях запиту

Тип повернення:

object

Виконує один виклик GET програмного інтерфейсу.

post(path, **kwargs)
Параметри:

path (str) – Шлях запиту

Тип повернення:

object

Виконує один виклик GET програмного інтерфейсу.

wlc.config

WeblateConfig

class wlc.config.WeblateConfig(section='wlc')
Параметри:

section (str) – Розділ налаштувань, яким слід скористатися

Обробник файла налаштувань, у якому використано специфікацію XDG.

load(path=None)
Параметри:

path (str) – Шлях, з якого слід завантажувати налаштування.

Loads configuration from path when it is specified. Otherwise it loads the discovered global configuration file and then the nearest project configuration file (.weblate, .weblate.ini, or weblate.ini) from the current directory or its parents.

wlc.main

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

  • settings (list) – Параметри для перевизначення у форматі списку кортежів

  • stdout (object) – Файловий об’єкт stdout для виведення даних. Типовим є sys.stdout

  • args (list) – Аргументи командного рядка для обробки. Типовими є sys.args

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

@wlc.main.register_command(command)

Декоратор для реєстрації класу Command у основному обробнику, який використовується main().

Command

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

Основний клас для виклику команд.