Weblate 的 Python API

安裝

Python API 是單獨提供的，您需要安裝 Weblate 用戶端 (wlc) 來使用。

pip install wlc

wlc

WeblateException

exception wlc.WeblateException

適用於所有例外的基底類別。

Weblate

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

  • key (str) -- 使用者金鑰

  • url (str) -- API 伺服器 URL，如果未指定則使用預設。

  • config (wlc.config.WeblateConfig) -- 配置物件，覆寫任何其他參數。

  • retries (int) -- HTTP 重試總次數。

  • status_forcelist (list) -- 應該觸發重試的 HTTP 狀態代碼。

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

Access class to the API, define API key and optionally API URL.

get(path)
參數:

path (str) -- 請求路徑

回傳型別:

object

執行單個 API GET 呼叫。

post(path, **kwargs)
參數:

path (str) -- 請求路徑

回傳型別:

object

執行單個 API GET 呼叫。

wlc.config

WeblateConfig

class wlc.config.WeblateConfig(section='wlc')
參數:

section (str) -- 要使用的配置部分

遵循 XDG 規範的配置檔案解析器。

load(path=None)
參數:

path (str) -- 載入配置的路徑。

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)
參數:

  • settings (list) -- Settings to override as list of tuples

  • stdout (object) -- 用於列印輸出的 stdout 檔案物件，預設使用 sys.stdout

  • args (list) -- 要處理的命令列引數，預設使用 sys.args

命令列介面的主要入口點。

@wlc.main.register_command(command)

Decorator to register Command class in main parser used by main().

Command

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

用於呼叫指令的主類別。