El API de Python de Weblate¶
Instalación¶
El API de Python se envía por separado, necesita instalar Cliente de Weblate (wlc) para tenerla.
pip install wlc
wlc¶
WeblateException¶
- exception wlc.WeblateException¶
Clase base para todas las excepciones.
Weblate¶
- class wlc.Weblate(key='', url=None, config=None, retries=0, status_forcelist=None, allowed_methods=None, backoff_factor=0, timeout=300)¶
- Parámetros:
key (str) – Clave de usuario
url (str) – URL del servidor API, si no se especifica se utiliza el valor predeterminado.
config (wlc.config.WeblateConfig) – Objeto de configuración, anula cualquier otro parámetro.
retries (int) – Número total de reintentos HTTP.
status_forcelist (list) – Códigos de estado HTTP que provocarían reintentos.
allowed_methods (list) – Métodos HTTP que pueden reintentarse.
backoff_factor (float) – El factor de retroceso de reintento se pasa a urllib3.
timeout (int) – Vencimiento de espera de la solicitud HTTP en segundos.
Clase de acceso para el API, define clave API y opcionalmente URL de API.
- get(path)¶
- Parámetros:
path (str) – Ruta requerida
- Tipo del valor devuelto:
object
Realiza una única invocación de GET de API.
- post(path, **kwargs)¶
- Parámetros:
path (str) – Ruta requerida
- Tipo del valor devuelto:
object
Realiza una única invocación de GET de API.
wlc.config¶
WeblateConfig¶
- class wlc.config.WeblateConfig(section='wlc')¶
- Parámetros:
section (str) – Sección de configuración a utilizar
Intérprete de archivos de configuración según la especificación XDG.
- load(path=None)¶
- Parámetros:
path (str) – Ruta desde la cual cargar la configuración.
Carga la configuración desde
pathcuando se especifica. De lo contrario, carga el archivo de configuración global detectado y luego el archivo de configuración del proyecto más cercano (.weblate,.weblate.inioweblate.ini) del directorio actual o de sus directorios superiores.
wlc.main¶
- wlc.main.main(settings=None, stdout=None, args=None)¶
- Parámetros:
settings (list) – Ajustes para anular como lista de tuplas
stdout (object) – objeto de archivo stdout para salida de impresión, utiliza
sys.stdoutcomo predeterminadoargs (list) – Argumentos de la línea de comandos para procesar, utiliza
sys.argscomo predeterminado
Punto de entrada principal para la interfaz de línea de comandos.
- @wlc.main.register_command(command)¶
Decorador para registrar la clase
Commanden el analizador principal utilizado pormain().
Command¶
- class wlc.main.Command(args, config, stdout=None)¶
Clase principal para invocar órdenes.