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, retries=0, status_forcelist=None, allowed_methods=None, backoff_factor=0, timeout=300)
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.

  • retries (int) – Total number of HTTP retries.

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

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.

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