Weblate Python API

Telepítés

A Python API külön csomagként érhető el, a használatához telepíteni kell a Weblate klienst (Weblate kliens).

pip install wlc

wlc

WeblateException

exception wlc.WeblateException

Az összes kivétel alaposztálya.

Weblate

class wlc.Weblate(key='', url=None, config=None)
Paraméterek:

  • key (str) – Felhasználói kulcs

  • url (str) – Az API szerver URL-je, ha nincs megadva, az alapértelmezett érték kerül használatra.

  • config (wlc.config.WeblateConfig) – Beállítási objektum, felülírja a többi paramétert.

API-hozzáférést biztosító osztály, amelyben megadható az API-kulcs és opcionálisan az API URL-je.

get(path)
Paraméterek:

path (str) – A kérés útvonala

Visszatérés típusa:

object

Egyetlen API GET kérés végrehajtása.

post(path, **kwargs)
Paraméterek:

path (str) – A kérés útvonala

Visszatérés típusa:

object

Egyetlen API GET kérés végrehajtása.

wlc.config

WeblateConfig

class wlc.config.WeblateConfig(section='wlc')
Paraméterek:

section (str) – A használandó konfigurációs szekció

Konfigurációs fájl értelmező az XDG specifikáció szerint.

load(path=None)
Paraméterek:

path (str) – Az a fájl, ahonnan a konfiguráció betöltésre kerül.

Konfiguráció betöltése fájlból, ha nincs megadva fájl, akkor a wlc konfigurációs fájlából töltődik be (~/.config/wlc), amely az XDG konfigurációs útvonalon található (/etc/xdg/wlc).

wlc.main

wlc.main.main(settings=None, stdout=None, args=None)
Paraméterek:

  • settings (list) – Felülírandó beállítások listája tuple (rendezett párok) formában

  • stdout (object) – stdout fájlobjektum a kimenethez, alapértelmezés szerint: sys.stdout

  • args (list) – Feldolgozandó parancssori argumentumok, alapértelmezésként a sys.args kerül használatra

A parancssori felület fő belépési pontja.

@wlc.main.register_command(command)

Dekorátor, amely egy Command osztályt regisztrál a main() által használt fő parancsértelmezőben.

Command

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

Parancsok meghívására szolgáló fő osztály.