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)#
- 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.
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
Analysierer für Konfigurationsdateien gemäß XDG-Spezifikation.
- load(path=None)#
- Parameter:
path (str) – Pfad, aus dem die Konfiguration geladen werden soll.
Lädt die Konfiguration aus einer Datei, wenn keine angegeben ist, wird sie aus der wlc-Konfigurationsdatei (
~/.config/wlc
) geladen, die sich in Ihrem XDG-Konfigurationspfad (/etc/xdg/wlc
) befindet.
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 Hauptanalysierer, der vonmain()
verwendet wird.
Command
#
- class wlc.main.Command(args, config, stdout=None)#
Hauptklasse zum Aufrufen von Befehlen.