Програмний інтерфейс Python Weblate¶
Установлення¶
Програмний інтерфейс Python постачається окремо. Вам слід встановити Клієнт Weblate (wlc), щоб отримати доступ до нього.
pip install wlc
wlc
¶
WeblateException
¶
- exception wlc.WeblateException¶
Основний клас для всіх винятків.
Weblate
¶
- class wlc.Weblate(key='', url=None, config=None)¶
- Параметри:
key (str) – Ключ користувача
url (str) – Адреса програмного інтерфейсу сервера. Якщо не вказано, буде використано типову.
config (wlc.config.WeblateConfig) – Об’єкт налаштувань, перевизначає усі інші параметри.
Клас доступу до програмного інтерфейсу, визначає ключ до програмного інтерфейсу і, необов’язково, адресу програмного інтерфейсу.
- 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) – Шлях, з якого слід завантажувати налаштування.
Завантажує налаштування з файла. Якщо файл не вказано, завантаження відбуватиметься з файла налаштувань wlc (
~/.config/wlc
), який розташовано у вашому каталозі налаштувань XDG (/etc/xdg/wlc
).
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)¶
Основний клас для виклику команд.