Skip to content

27. Ejercicio práctico: version 9

Volvemos a version 7 del ejercicio de aplicación y, en lugar de que el cliente y el servidor web intercambien cadenas jSON, aquí intercambiarán XML.

La arquitectura sigue siendo la misma:

Image

27.1. El servidor web

Image

La carpeta [http-servers/04] se obtiene copiando la carpeta [http-servers/02], con la excepción de la subcarpeta [utilities]. A continuación, se modifican los siguientes elementos:

Image

El archivo [config] se modifica de la siguiente manera:


    # dépendances absolues
    absolute_dependencies = [
        # dossiers du projet
        # BaseEntity, MyException
        f"{root_dir}/classes/02/entities",
        # InterfaceImpôtsDao, InterfaceImpôtsMétier, InterfaceImpôtsUi
        f"{root_dir}/impots/v04/interfaces",
        # AbstractImpôtsdao, ImpôtsConsole, ImpôtsMétier
        f"{root_dir}/impots/v04/services",
        # ImpotsDaoWithAdminDataInDatabase
        f"{root_dir}/impots/v05/services",
        # AdminData, ImpôtsError, TaxPayer
        f"{root_dir}/impots/v04/entities",
        # Constantes, tranches
        f"{root_dir}/impots/v05/entities",
        # index_controller
        f"{root_dir}/impots/http-servers/01/controllers",
        # scripts [config_database, config_layers]
        script_dir,
        # Logger, SendAdminMail
        f"{root_dir}/impots/http-servers/02/utilities",
    ]
  • línea 21: se indica la carpeta de las utilidades que se han quedado en [http-servers/02];

El script principal [main] cambia de la siguiente manera:


# Home URL
@app.route('/', methods=['GET'])
@auth.login_required
def index():
    logger = None
    try:
        # registrador
        logger = Logger(config["logsFilename"])
        # se almacena en un config asociado al hilo
        thread_config = {"logger": logger}
        thread_name = threading.current_thread().name
        config[thread_name] = {"config": thread_config}
        # se registra la solicitud
        logger.write(f"[index] requête : {request}\n")
        …
        # se ejecuta la solicitud mediante un controlador
        résultat, status_code = index_controller.execute(request, config)
        # ¿Se ha producido un error fatal?
        …
        # se registra la respuesta
        logger.write(f"[index] {résultat}\n")
        # se envía la respuesta
        return xml_response(résultat, status_code)
    except BaseException as erreur:
        # se registra el error si es posible
        if logger:
            logger.write(f"[index] {erreur}")
        # se prepara la respuesta para el cliente
        résultat = {"réponse": {"erreurs": [f"{erreur}"]}}
        # se envía la respuesta
        return xml_response(résultat, status.HTTP_500_INTERNAL_SERVER_ERROR)
    finally:
        # se cierra el archivo de registros si se ha abierto
        if logger:
            logger.close()
  • la única modificación se encuentra en la línea 23: ahora se envía una respuesta XML;

La función [xml_response] se define en el módulo [myutils]:


import xmltodict
…
def xml_response(résultat: dict, status_code: int) -> tuple:
    # resultado: el diccionario que se va a convertir en cadena XML
    xmlString = xmltodict.unparse(résultat)
    # se devuelve la respuesta HTTP
    response = make_response(xmlString)
    response.headers['Content-Type'] = 'application/xml; charset=utf-8'
    return response, status_code
  • línea 3: la función [xml_response] recibe como parámetros:
    • el diccionario [résultat] que se va a transformar en XML;
    • el código de estado [status_code] que se debe devolver al cliente web;
  • línea 5: se utiliza la biblioteca [xmltodict] para generar la cadena XML;
  • línea 8: se utiliza el encabezado [Content-Type] para indicar al cliente que se le envía XML;

La función [xml_response] debe importarse al script [__init__.py]:


from .myutils import set_syspath, json_response, decode_flask_session, xml_response

A continuación, el módulo [myutils] debe incorporarse a los módulos de ámbito de máquina. Esto se realiza en un terminal PyCharm con el comando [pip install .] (en la carpeta packages).

27.2. El cliente web

27.2.1. El código

El archivo [http-clients/04] se obtiene mediante una copia del cliente [http-clients/02]. A continuación, modificamos la clase [ImpôtsDaoWithHttpClient] de la siguiente manera:


# importaciones

import requests
import xmltodict
from flask_api import status

from AbstractImpôtsDao import AbstractImpôtsDao
from AdminData import AdminData
from ImpôtsError import ImpôtsError
from InterfaceImpôtsMétier import InterfaceImpôtsMétier
from TaxPayer import TaxPayer


class ImpôtsDaoWithHttpClient(AbstractImpôtsDao, InterfaceImpôtsMétier):

    # constructor
    def __init__(self, config: dict):
        …

    # método no utilizado
    def get_admindata(self) -> AdminData:
        pass

    # cálculo del impuesto
    def calculate_tax(self, taxpayer: TaxPayer, admindata: AdminData = None):
        ….
        # código de estado de la respuesta HTTP
        status_code = response.status_code
        # se coloca la respuesta XML en un diccionario
        résultat = xmltodict.parse(response.text[39:])
        # error si el código de estado es distinto de 200 OK
        ….
  • línea 30: la respuesta HTTP [response] del servidor web es ahora una cadena XML. Los registros muestran la naturaleza de esta: 

2020-07-27 15:53:47.886283, Thread-2 : <?xml version="1.0" encoding="utf-8"?>
<réponse><result><marié>non</marié><enfants>2</enfants><salaire>100000</salaire><impôt>19884</impôt><surcôte>4480</surcôte><taux>0.41</taux><décôte>0</décôte><réduction>0</réduction></result></réponse>

La cadena [<?xml version="1.0" encoding="utf-8"?>] tiene 38 caracteres. Además, si observamos el archivo de registros con un editor hexadecimal, vemos que detrás de esta cadena hay un carácter de salto de línea \n. A continuación viene la respuesta <respuesta>…</respuesta>. La cadena XML que debemos convertir comienza, por tanto, tras los primeros 39 caracteres de la cadena XML. Comienza a partir del carácter n.º 39, siendo el primer carácter el 0. Esta cadena se obtiene mediante la expresión [response.text[39:]].

Si ejecutamos el cliente (siga el procedimiento de los ejemplos anteriores), obtenemos los mismos resultados en el archivo [résultats.json] que en las versiones anteriores. Los registros son los siguientes:


2020-07-27 16:21:14.015941, Thread-1 : début du thread [Thread-1] avec 2 contribuable(s)
2020-07-27 16:21:14.016940, Thread-1 : début du calcul de l'impôt de {"id": 1, "marié": "oui", "enfants": 2, "salaire": 55555}
2020-07-27 16:21:14.016940, Thread-2 : début du thread [Thread-2] avec 3 contribuable(s)
2020-07-27 16:21:14.018939, Thread-2 : début du calcul de l'impôt de {"id": 3, "marié": "oui", "enfants": 3, "salaire": 50000}
2020-07-27 16:21:14.019979, Thread-3 : début du thread [Thread-3] avec 3 contribuable(s)
2020-07-27 16:21:14.019979, Thread-3 : début du calcul de l'impôt de {"id": 6, "marié": "oui", "enfants": 3, "salaire": 100000}
2020-07-27 16:21:14.021938, Thread-4 : début du thread [Thread-4] avec 2 contribuable(s)
2020-07-27 16:21:14.021938, Thread-4 : début du calcul de l'impôt de {"id": 9, "marié": "oui", "enfants": 2, "salaire": 30000}
2020-07-27 16:21:14.021938, Thread-5 : début du thread [Thread-5] avec 1 contribuable(s)
2020-07-27 16:21:14.022939, Thread-5 : début du calcul de l'impôt de {"id": 11, "marié": "oui", "enfants": 3, "salaire": 200000}
2020-07-27 16:21:14.031942, Thread-1 : <?xml version="1.0" encoding="utf-8"?>
<réponse><result><marié>oui</marié><enfants>2</enfants><salaire>55555</salaire><impôt>2814</impôt><surcôte>0</surcôte><taux>0.14</taux><décôte>0</décôte><réduction>0</réduction></result></réponse>
2020-07-27 16:21:14.031942, Thread-1 : fin du calcul de l'impôt de {"id": 1, "marié": "oui", "enfants": 2, "salaire": 55555, "impôt": 2814, "surcôte": 0, "taux": 0.14, "décôte": 0, "réduction": 0}
2020-07-27 16:21:14.031942, Thread-1 : début du calcul de l'impôt de {"id": 2, "marié": "oui", "enfants": 2, "salaire": 50000}
2020-07-27 16:21:14.034941, Thread-4 : <?xml version="1.0" encoding="utf-8"?>
<réponse><result><marié>oui</marié><enfants>2</enfants><salaire>30000</salaire><impôt>0</impôt><surcôte>0</surcôte><taux>0.0</taux><décôte>0</décôte><réduction>0</réduction></result></réponse>
…
2020-07-27 16:21:17.055931, Thread-3 : fin du thread [Thread-3]
2020-07-27 16:21:17.059930, Thread-2 : <?xml version="1.0" encoding="utf-8"?>
<réponse><result><marié>non</marié><enfants>3</enfants><salaire>100000</salaire><impôt>16782</impôt><surcôte>7176</surcôte><taux>0.41</taux><décôte>0</décôte><réduction>0</réduction></result></réponse>
2020-07-27 16:21:17.060971, Thread-2 : fin du calcul de l'impôt de {"id": 5, "marié": "non", "enfants": 3, "salaire": 100000, "impôt": 16782, "surcôte": 7176, "taux": 0.41, "décôte": 0, "réduction": 0}
2020-07-27 16:21:17.060971, Thread-2 : fin du thread [Thread-2]

En el lado del servidor, los registros son los siguientes:


2020-07-27 16:32:04.983020, Thread-46 : [index] requête : <Request 'http://127.0.0.1:5000/?marié=oui&enfants=2&salaire=50000' [GET]>
2020-07-27 16:32:04.983020, Thread-46 : [index] mis en pause du thread pendant 1 seconde(s)
2020-07-27 16:32:04.984021, Thread-47 : [index] requête : <Request 'http://127.0.0.1:5000/?marié=oui&enfants=2&salaire=55555' [GET]>
2020-07-27 16:32:04.984021, Thread-47 : [index] mis en pause du thread pendant 1 seconde(s)
…
2020-07-27 16:32:07.001271, Thread-56 : [index] mis en pause du thread pendant 1 seconde(s)
2020-07-27 16:32:07.003078, Thread-54 : [index] {'réponse': {'result': {'marié': 'oui', 'enfants': 5, 'salaire': 100000, 'impôt': 4230, 'surcôte': 0, 'taux': 0.14, 'décôte': 0, 'réduction': 0}}}
2020-07-27 16:32:07.006078, Thread-55 : [index] {'réponse': {'result': {'marié': 'oui', 'enfants': 3, 'salaire': 200000, 'impôt': 42842, 'surcôte': 17283, 'taux': 0.41, 'décôte': 0, 'réduction': 0}}}
2020-07-27 16:32:08.002824, Thread-56 : [index] {'réponse': {'result': {'marié': 'non', 'enfants': 2, 'salaire': 100000, 'impôt': 19884, 'surcôte': 4480, 'taux': 0.41, 'décôte': 0, 'réduction': 0}}}
  • el registrador sigue escribiendo el diccionario de la respuesta y no la cadena XML que se envía al cliente. No se trata de un error, sino que es intencionado;

27.2.2. Prueba de la capa [dao] del cliente

Image

La clase de prueba [TestHttpClientDao] es la misma que en |version 7| y da los mismos resultados.

https://stahe.github.io
Este tutorial, escrito por Serge Tahé, se pone a disposición del público bajo los términos de la Creative Commons Reconocimiento – No comercial – Compartir igual 3.0 Unported.