Weblates Python-API

Installation

Python API levereras separat, du måste installera Weblate-klient (wlc) för att få tillgång till det.

pip install wlc

wlc

WeblateException

exception wlc.WeblateException

Basklass för alla undantag.

Weblate

class wlc.Weblate(key='', url=None, config=None)
Parametrar:

  • key (str) – Användarkod

  • url (str) – API-serverns URL, om ingen anges används standardvärdet.

  • config (wlc.config.WeblateConfig) – Konfigurationsobjekt, åsidosätter alla andra parametrar.

Få tillgång till API:et, definiera API-nyckel och eventuellt API-URL.

get(path)
Parametrar:

path (str) – Begär väg

Returtyp:

object

Utför ett enda API GET-anrop.

post(path, **kwargs)
Parametrar:

path (str) – Begär väg

Returtyp:

object

Utför ett enda API GET-anrop.

wlc.config

WeblateConfig

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

section (str) – Konfigurationsavsnitt att använda

Konfigurationsfilsparser enligt XDG-specifikationen.

load(path=None)
Parametrar:

path (str) – Sökväg från vilken konfigurationen ska laddas.

Laddar konfigurationen från en fil. Om ingen fil anges laddas den från wlc-konfigurationsfilen (~/.config/wlc) som finns i din XDG-konfigurationssökväg (/etc/xdg/wlc).

wlc.main

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

  • settings (list) – Inställningar som ska åsidosättas som en lista med tupler

  • stdout (object) – stdout-filobjekt för utskrift, använder sys.stdout som standard

  • args (list) – Kommandoradsargument att bearbeta, använder sys.args som standard

Huvudsaklig ingångspunkt för kommandoradsgränssnittet.

@wlc.main.register_command(command)

Dekorator för att registrera klassen Command i huvudparsern som används av main().

Command

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

Huvudklass för att anropa kommandon.