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)¶
- 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.
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 uit een bestand, als geen wordt gespecificeerd, wordt het geladen uit het configuratiebestand wlc (
~/.config/wlc
), geplaatst in uw pad voor configuratie van XDG (/etc/xdg/wlc
).
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 doormain()
.
Command
¶
- class wlc.main.Command(args, config, stdout=None)¶
Hoofdklasse voor aanroepen van opdrachten.