Weblate's Python API

導入

The Python API is shipped separately, you need to install the Weblate クライアント: (wlc) to have it.

pip install wlc

wlc

WeblateException

exception wlc.WeblateException

Base class for all exceptions.

Weblate

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

パラメータ

• key (str) -- User key

• url (str) -- API server URL, if not specified default is used

• config (wlc.config.WeblateConfig) -- Configuration object, overrides any other parameters.

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

get(path)

パラメータ

path (str) -- Request path

戻り値の型

object

Performs a single API GET call.

post(path, **kwargs)

パラメータ

path (str) -- Request path

戻り値の型

object

Performs a single API GET call.

wlc.config

WeblateConfig

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

パラメータ

section (str) -- Configuration section to use

Configuration file parser following XDG specification.

load(path=None)

パラメータ

path (str) -- Path from which to load configuration.

Loads configuration from a file, if none is specified, it loads from the wlc configuration file (~/.config/wlc) placed in your XDG configuration path (/etc/xdg/wlc).

wlc.main

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

パラメータ

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

• stdout (object) -- stdout file object for printing output, uses sys.stdout as default

• args (list) -- Command-line arguments to process, uses sys.args as default

Main entry point for command-line interface.

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

Main class for invoking commands.