Skip to content

27. Esercizio pratico: versione 9

Torniamo alla versione 7 dell’esercizio pratico: invece di scambiarsi stringhe jSON, il client e il server web si scambieranno qui stringhe XML.

L’architettura rimane la stessa:

Image

27.1. Il server web

Image

La cartella [http-servers/04] si ottiene copiando la cartella [http-servers/02], ad eccezione della sottocartella [utilities]. Quindi si modificano i seguenti elementi:

Image

Il file [config] viene modificato come segue:


    # dipendenze assolute
    absolute_dependencies = [
        # cartelle del progetto
        # 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",
        # Costanti, fasce
        f"{root_dir}/impots/v05/entities",
        # index_controller
        f"{root_dir}/impots/http-servers/01/controllers",
        # script [config_database, config_layers]
        script_dir,
        # Logger, SendAdminMail
        f"{root_dir}/impots/http-servers/02/utilities",
    ]
  • riga 21: si indica la cartella delle utilità rimaste in [http-servers/02];

Lo script principale [main] viene modificato come segue:


# Home URL
@app.route('/', methods=['GET'])
@auth.login_required
def index():
    logger = None
    try:
        # logger
        logger = Logger(config["logsFilename"])
        # viene memorizzato in una configurazione associata al thread
        thread_config = {"logger": logger}
        thread_name = threading.current_thread().name
        config[thread_name] = {"config": thread_config}
        # si registra la richiesta
        logger.write(f"[index] requête : {request}\n")
        …
        # si fa eseguire la richiesta da un controller
        résultat, status_code = index_controller.execute(request, config)
        # si è verificato un errore fatale?
        …
        # si registra la risposta
        logger.write(f"[index] {résultat}\n")
        # si invia la risposta
        return xml_response(résultat, status_code)
    except BaseException as erreur:
        # si registra l'errore, se possibile
        if logger:
            logger.write(f"[index] {erreur}")
        # si prepara la risposta per il cliente
        résultat = {"réponse": {"erreurs": [f"{erreur}"]}}
        # si invia la risposta
        return xml_response(résultat, status.HTTP_500_INTERNAL_SERVER_ERROR)
    finally:
        # si chiude il file di log se è stato aperto
        if logger:
            logger.close()
  • l’unica modifica è alla riga 23: ora viene inviata una risposta XML;

La funzione [xml_response] è definita nel modulo [myutils]:


import xmltodict
…
def xml_response(résultat: dict, status_code: int) -> tuple:
    # risultato: il dizionario da convertire in stringa XML
    xmlString = xmltodict.unparse(résultat)
    # si restituisce la risposta HTTP
    response = make_response(xmlString)
    response.headers['Content-Type'] = 'application/xml; charset=utf-8'
    return response, status_code
  • riga 3: la funzione [xml_response] riceve come parametri:
    • il dizionario [résultat] da convertire in XML;
    • il codice di stato [status_code] da restituire al client web;
  • riga 5: si utilizza la libreria [xmltodict] per generare la stringa XML;
  • riga 8: si utilizza l'intestazione [Content-Type] per comunicare al client che gli viene inviato XML;

La funzione [xml_response] deve essere importata nello script [__init__.py]:


from .myutils import set_syspath, json_response, decode_flask_session, xml_response

Successivamente, il modulo [myutils] deve essere incorporato nei moduli a livello di macchina. Ciò avviene in un terminale PyCharm con il comando [pip install .] (nella cartella packages).

27.2. Il client web

27.2.1. Il codice

Image

Il file [http-clients/04] viene creato copiando il file [http-clients/02]. Successivamente modifichiamo la classe [ImpôtsDaoWithHttpClient] come segue:


# importazioni

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

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

    # metodo non utilizzato
    def get_admindata(self) -> AdminData:
        pass

    # calcolo dell'imposta
    def calculate_tax(self, taxpayer: TaxPayer, admindata: AdminData = None):
        ….
        # codice di stato della risposta HTTP
        status_code = response.status_code
        # si inserisce la risposta XML in un dizionario
        résultat = xmltodict.parse(response.text[39:])
        # errore se il codice di stato è diverso da 200 OK
        ….
  • riga 30: la risposta HTTP [response] del server web è ora una stringa XML. I log ne mostrano la natura: 

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 stringa [<?xml version="1.0" encoding="utf-8"?>] è composta da 38 caratteri. Inoltre, se si esamina il file di log con un editor esadecimale, si nota che dopo questa stringa è presente un carattere di nuova riga \n. Segue poi la risposta <risposta>…</risposta>. La stringa XML che dobbiamo convertire inizia quindi dopo i primi 39 caratteri della stringa XML. Inizia dal carattere n. 39, essendo il primo carattere numerato 0. Questa stringa si ottiene dall’espressione [response.text[39:]].

Se eseguiamo il client (seguendo la procedura degli esempi precedenti), otteniamo gli stessi risultati nel file [résultats.json] delle versioni precedenti. I log sono i seguenti:


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]

Sul lato server, i log sono i seguenti:


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/?sposato=sì&figli=2&stipendio=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}}}
  • il logger continua a scrivere il dizionario della risposta e non la stringa XML che viene inviata al client. Non si tratta di un errore ed è intenzionale;

27.2.2. Test del livello [dao] del client

Image

La classe di test [TestHttpClientDao] è la stessa della |versione 7| e fornisce gli stessi risultati.

https://stahe.github.io
Questo tutorial scritto da Serge Tahé è reso disponibile al pubblico secondo i termini della Creative Commons Attribuzione – Non commerciale – Condividi allo stesso modo 3.0 Unported.