xml
app.common.http.xml
Módulo de Python para consumir url's externas, utilizando usando XML. Tenga en cuenta que este módulo no pretende convertirse en un cliente de XML/SOAP.
Para más información, te recomendamos leer la documentación del Proyecto.
- el módulo
app.common.http.base_api - https://docs.python.org/3.12/library/xml.etree.elementtree.html
- https://github.com/tiran/defusedxml
- https://documenter.getpostman.com/view/8854915/Szf26WHn
XMLApi
Bases: BaseApiClient
Genera una instancia de urllib3.request para hacer peticiones a url's externas usando XML, se extiende de BaseApiClient.
Attributes:
| Name | Type | Description |
|---|---|---|
_default_headers | dict[str, Any] | un diccionario con la información de la cabecera para xml |
Warning
este metódo:
- se encuentra en revisión, puede cambiar en el futuro.
- se necesitan más pruebas y ejemplos.
_build_response(resp, user_enconding=False)
Permite estandarizar los mensajes de respuesta/error generados por urllib3 (BaseHTTPResponse), este metódo sobreescribe el método _build_response de BaseApiClient, con el fin de hacerlo acorde a las respuestas en XML.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
resp | Any | un objeto de tipo | required |
user_enconding | bool | establece si se utilizará un encoding para parsear la respuesta XML, por defecto | False |
Warning
este metódo:
- se necesitan más pruebas y ejemplos.
Returns:
| Type | Description |
|---|---|
Optional[Any] | Genera la representación en formato string de un elemento |
Examples:
post(url, data, custom_headers=None, use_enconding=False)
Realiza una petición de tipo POST para peticiones en formato XML.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url | str | la url/endpoint para enviar los datos | required |
data | str | la consulta en formato XML | required |
custom_headers | dict[str, Any] | un diccionario para establecer cabeceras adicionales | None |
use_enconding | bool | establece si se utilizará un encoding para parsear la respuesta XML, por defecto | False |
Warning
este metódo:
- se necesitan más pruebas y ejemplos.
Returns:
| Type | Description |
|---|---|
Optional[Any] | Genera la representación en formato string de un elemento |
Examples: