Weblate’s Python API

Installatie

De Python API wordt afzonderlijk verspreid, u moet de Weblate Client (wlc) installeren om het te hebben.

pip install wlc

wlc

WeblateException

exception wlc.WeblateException

Basisklasse voor alle uitzonderingen.

Weblate

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

  • key (str) – Gebruikerssleutel

  • url (str) – API server URL, indien niet gespecificeerd, wordt de standaard gebruikt.

  • config (wlc.config.WeblateConfig) – Configuratie-object, overschrijft alle andere parameters.

  • retries (int) – Totaal aantal pogingen om HTTP opnieuw te proberen.

  • status_forcelist (list) – HTTP-statuscodes die opnieuw zouden moeten activeren.

  • allowed_methods (list) – HTTP-methoden die opnieuw mogen worden geprobeerd.

  • backoff_factor (float) – Factor voor stoppen met opnieuw proberen doorgegeven aan urllib3.

  • timeout (int) – Time-out voor HTTP-request in seconden.

Toegangsklasse voor de API, definieer API-sleutel en optioneel API URL.

get(path)
Parameters:

path (str) – Pad voor verzoek

Terug te geven type:

object

Voert een enkele aanroep API GET uit.

post(path, **kwargs)
Parameters:

path (str) – Pad voor verzoek

Terug te geven type:

object

Voert een enkele aanroep API GET uit.

wlc.config

WeblateConfig

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

section (str) – Te gebruiken sectie van configuratie

Configuratie bestandsparser die XDG-specificatie volgt.

load(path=None)
Parameters:

path (str) – Pad waaruit configuratie moet worden geladen.

Laadt de configuratie vanuit path waar het is gespecificeerd. Anders wordt het gevonden globale configuratiebestand geladen en dan het dichtstbij gelegen projectconfiguratiebestand (.weblate, .weblate.ini of weblate.ini) vanuit de huidige map of zijn ouders.

wlc.main

wlc.main.main(settings=None, stdout=None, args=None)
Parameters:

  • settings (list) – Als lijst tuples te overschrijven instellingen

  • stdout (object) – stdout bestandsobject voor afdrukken van uitvoer, gebruikt standaard sys.stdout

  • args (list) – Te verwerken argumenten voor de opdrachtregel, gebruikt standaard sys.args

Hoofd toegangspoort voor interface van de opdrachtregel.

@wlc.main.register_command(command)

Decoratie voor registreren van de klasse Command in de hoofdparser die wordt gebruikt door main().

Command

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

Hoofdklasse voor aanroepen van opdrachten.