Escriu per cercar…

Refacció

Refactoritzar és modificar el codi perquè tingui una altre estructura, però que segueixi fent el mateix.

Introducció

Però per qué necessitem refactoritzar un codi si aquest funciona? Després de tot al compilador i a l’ordinador no li importa si el codi costa d’entendre o no està ben estructurat. Però quan una persona ha de modificar un codi, primer ha d’entendre el codi, i molts cops és difícil d’entendre el que està escrit encara que ho haguem escrit nosaltres fa unes setmanes.

Exemple

Per desenvolupar aquesta activitat farem servir un exemple, però aquest exemple és de poques línies de codi perquè sigui fàcil d’entendre. Per tant, en una situació real tindria poca utilitat refactoritzar el codi perquè segur que la majoria el podem entendre i podem tolerar que el codi no s’adapti al nostre estil, però en molts casos no és així.

Farem servir d’exemple una empresa que proporciona màquines virtuals al núvol, i factura mensualment als clients a partir del total d’hores que ha utilitzat el recurs virtual que s’ha creat sota demanda.

Per modelitzar les dades farem servir llistes, tuples i diccionaris tal com pots veure a continuació:

python
# recursos (màquines virtuals)
resources = {
    # ResourceId: (Processor, price per hour, cores, GB of memory)
    'CAX11': ('Ampere', 0.0072, 2, 4),
    'CAX21': ('Ampere', 0.0124, 4, 8),
    'CX11': ('Intel', 0.0081, 1, 2),
    'CPX11': ('AMD', 0.0084, 2, 2),
}

# recursos utilitzats per un client
invoice = {
    'client': 'ACME',
    # (ResourceId, hours)
    'rentals': [('CAX21', 6),  ('CPX11', 58), ('CAX21', 376)]
}

El codi que haurem de refactoritzar construeix la factura mensual en format text del client:

Rental Record for ACME
    	CAX21   0.0744
    	CPX11   0.4872
    	CAX21   2.3312
Amount owed is 2.89

A continuació tens el codi d’exemple main.py:

python
# funció que genera el document de text d'una factura
def statement(invoice, resources):
    
    totalAmount = 0

    result = f"Rental Record for {invoice['client']}\n"

    for rental in invoice['rentals']:

        amount = 0
        resourceId = rental[0]
        resource = resources[resourceId]
        cpu = resource[0]
        price = resource[1]
        hours = rental[1]

        # determine amount for each resource rental
        match cpu:
            case 'Ampere':
                amount =  hours * price
                if hours > 240:
                    amount = amount / 2
            case 'AMD':
                amount = hours * price
                if hours > 360:
                    amount = amount / 2
            case 'Intel':
                amount = hours * price
                if hours > 360:
                    amount = amount / 2

            case _:
                msg = f"Unknow cpu: {cpu}"
                raise Exception(msg)
       
        # print figures for this rental
        result += f'\t{resourceId}\t{amount:.4f}\n'
        totalAmount += amount

    # add footer lines
    result += f'Amount owed is {totalAmount:.2f}\n'

    return result

# recursos (màquines virtuals)
resources = {
    # ResourceId: (Processor, price per hour, cores, GB of memory)
    'CAX11': ('Ampere', 0.0072, 2, 4),
    'CAX21': ('Ampere', 0.0124, 4, 8),
    'CX11': ('Intel', 0.0081, 1, 2),
    'CPX11': ('AMD', 0.0084, 2, 2),
}

# recursos utilitzats per un client
invoice = {
    'client': 'ACME',
    # (ResourceId, hours)
    'rentals': [('CAX21', 6),  ('CPX11', 58), ('CAX21', 376)]
}

result = statement(invoice, resources)
print(result)

El resultat que obtenim quan executem python3 main.py és l’esperat:

Rental Record for ACME
    	CAX21   0.0744
    	CPX11   0.4872
    	CAX21   2.3312
Amount owed is 2.89

Estàs llegint una vista prèvia.

Inicia sessió per llegir l'article complet. Qualsevol compte obre 4 articles gratuïts al mes; l'alumnat i el professorat llegeixen les pàgines del seu curs sense límit.

Inicia sessió