API Python de Weblate¶
Installation¶
L’API Python est livrée séparément, vous devez installer le Client Weblate (wlc) pour l’obtenir.
pip install wlc
wlc¶
WeblateException¶
- exception wlc.WeblateException¶
Classe de base pour toutes les exceptions.
Weblate¶
- class wlc.Weblate(key='', url=None, config=None, retries=0, status_forcelist=None, allowed_methods=None, backoff_factor=0, timeout=300)¶
- Paramètres:
key (str) – Clé utilisateur
url (str) – API server URL, if not specified default is used.
config (wlc.config.WeblateConfig) – Objet de configuration, redéfinit tout autre paramètre.
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.
Classe d’accès à l’API, définit la clé de l’API et sur option l’URL de l’API.
- get(path)¶
- Paramètres:
path (str) – Chemin de la requête
- Type renvoyé:
object
Réalise un appel API GET unique .
- post(path, **kwargs)¶
- Paramètres:
path (str) – Chemin de la requête
- Type renvoyé:
object
Réalise un appel API GET unique .
wlc.config¶
WeblateConfig¶
- class wlc.config.WeblateConfig(section='wlc')¶
- Paramètres:
section (str) – Section de configuration à utiliser
Analyseur de fichiers de configuration suivant la spécification XDG.
- load(path=None)¶
- Paramètres:
path (str) – Chemin utilisé pour charger la configuration.
Loads configuration from
pathwhen it is specified. Otherwise it loads the discovered global configuration file and then the nearest project configuration file (.weblate,.weblate.ini, orweblate.ini) from the current directory or its parents.
wlc.main¶
- wlc.main.main(settings=None, stdout=None, args=None)¶
- Paramètres:
settings (list) – Paramètres à redéfinir en tant que liste de tuples
stdout (object) – objet fichier stdout pour imprimer la sortie, utilise
sys.stdoutpar défautargs (list) – Arguments de la ligne de commande à traiter, utilise
sys.argspar défaut
Point d’entrée principal de l’interface en ligne de commande.
- @wlc.main.register_command(command)¶
Decorator to register
Commandclass in main parser used bymain().
Command¶
- class wlc.main.Command(args, config, stdout=None)¶
Classe principale pour appeler des commandes.