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, retries=0, status_forcelist=None, allowed_methods=None, backoff_factor=0, timeout=300)
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.

  • 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-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.

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)
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.