Weblates Python-API

Installation

Die Python-API wird separat ausgeliefert, Sie müssen den Weblate-Client (wlc) installieren, um sie zu nutzen.

pip install wlc

wlc

WeblateException

exception wlc.WeblateException

Basisklasse für alle Ausnahmen.

Weblate

class wlc.Weblate(key='', url=None, config=None, retries=0, status_forcelist=None, allowed_methods=None, backoff_factor=0, timeout=300)
Parameter:

  • key (str) – Benutzerschlüssel

  • url (str) – API-Server-URL, wenn nicht angegeben, wird der Standardwert verwendet.

  • config (wlc.config.WeblateConfig) – Konfigurationsobjekt, überschreibt alle anderen Parametern.

  • retries (int) – Gesamtzahl der HTTP-Wiederholungsversuche.

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

Zugriffsklasse auf die API, Definition des API-Schlüssels und optional der API-URL.

get(path)
Parameter:

path (str) – Anfragepfad

Rückgabetyp:

object

Führt einen einzelnen API-GET-Aufruf durch.

post(path, **kwargs)
Parameter:

path (str) – Anfragepfad

Rückgabetyp:

object

Führt einen einzelnen API-GET-Aufruf durch.

wlc.config

WeblateConfig

class wlc.config.WeblateConfig(section='wlc')
Parameter:

section (str) – Zu verwendender Konfigurationsabschnitt

Parser für Konfigurationsdateien gemäß XDG-Spezifikation.

load(path=None)
Parameter:

path (str) – Pfad, aus dem die Konfiguration geladen werden soll.

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)
Parameter:

  • settings (list) – Zu überschreibende Einstellungen als Liste von Tupeln

  • stdout (object) – stdout-Dateiobjekt für die Ausgabe, verwendet standardmäßig sys.stdout

  • args (list) – Befehlszeilenargumente, die verarbeitet werden sollen, verwendet standardmäßig sys.args

Haupteinstiegspunkt für die Befehlszeilenschnittstelle.

@wlc.main.register_command(command)

Decorator zur Registrierung der Klasse Command im Hauptparser, der von main() verwendet wird.

Command

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

Hauptklasse zum Aufrufen von Befehlen.