Licence CC BY-NC-ND Thierry Parmentelat & Arnaud Legout
génération de facture¶
le problème¶
on veut automatiser la rédaction de factures à partir d’une liste d’items et de prix
exemple d’utilisation, imaginons qu’on a les données suivantes :
company_address = """Tribeca Inc.,
Somerset House – New Wing
Lancaster Place
London WC2R 1LA
"""
thanks_message = "Thanks for shopping with us today!"
currency = '€'
items = [
("Books", 25.0, 2),
("Monitor", 250.0, 1),
("Computer", 500.0, 1),
]à partir de ces données on pourrait imaginer plusieurs APIs pour produire des factures comme ceci
v0 : une fonction¶
l’API la plus simple évidemment ce serait tout simplement ceci
from invoice import generate_invoiceinvoice = generate_invoice(
items, company_address, thanks=thanks_message, currency='$')
print(invoice)**************************************************
Tribeca Inc.,
Somerset House – New Wing
Lancaster Place
London WC2R 1LA
++++++++++++++++++++++++++++++++++++++++++++++++++
Product Name # Item Price
Books 2 25.00
Monitor 1 250.00
Computer 1 500.00
--------------------------------------------------
Total 800.00 $
--------------------------------------------------
Thanks for shopping with us today!
--------------------------------------------------
suggestions / indices¶
dans un premier temps, affichez le contenu de
company_addresstel quelensuite définissez une fontion - par exemple
center_addressqui se charge seulement de centrer l’adresse dans une certaine largeur
les formats de f-string sont un trait très pratique ici
texte = "tutu"
largeur = 10# on peut utiliser une variable AUSSI pour la largeur du format
# ici je prends 10 caractères, et je justifie mon texte à droite (le >)
# ↓ ↓↓↓↓↓
f"X{texte:>{largeur}}X"'X tutuX'# et on peut aussi centrer (le ^) ou justifier à gauche (<)
# ↓
f"X{texte:^{largeur}}X"'X tutu X'v1 : une classe¶
maintenant on peut aussi imaginer une autre façon d’implémenter ceci, en passant par une classe, comme par exemple
from invoice import InvoiceGeneratorgenerator = InvoiceGenerator(
address=company_address,
thanks=thanks_message,
currency='$')
print(generator.invoice(items))**************************************************
Tribeca Inc.,
Somerset House – New Wing
Lancaster Place
London WC2R 1LA
++++++++++++++++++++++++++++++++++++++++++++++++++
Product Name # Item Price
Books 2 25.0
Monitor 1 250.0
Computer 1 500.0
--------------------------------------------------
Total 800.00$
++++++++++++++++++++++++++++++++++++++++++++++++++
Thanks for shopping with us today!
**************************************************
solution¶
Comme toujours, les annotations type hints sont totalement optionnelles
une solution v0¶
Dans une toute première version, on pourrait penser à faire des print() dans la fonction.
Toutefois cette approche n’est pas recommandée; il vaut beaucoup mieux construire et renvoyer une chaine; de cette façon l’appelant pourra toujours choisir d’utiliser print() de son coté
ouvrez-moi
invoice.py
NL = '\n'
LEFT, MIDDLE, RIGHT = 21, 8, 21
WIDTH = LEFT + RIGHT + MIDDLE
DEFAULT_THANKS = "Thanks for shopping with us today !"
def center_address(address: str) -> str:
"""
centers all lines in address to global WIDTH
empty lines are discarded
"""
result = ""
for line in address.split("\n"):
if not line:
continue
result += f"{line:^{WIDTH}}" + NL
return result
# convenience:
# we decide that the last 2 parameters are optional
def generate_invoice(items, company_address, thanks=DEFAULT_THANKS, currency='€'):
result = WIDTH * '*' + NL
result += center_address(company_address)
result += WIDTH * '+' + NL
left, middle, right = "Product Name", "#", "Item Price"
result += f"{left:>{LEFT}}{middle:^{MIDDLE}}{right:<{RIGHT}}" + NL
total = 0.
for what, unit_price, how_many in items:
result += f"{what:>{LEFT}}{how_many:^{MIDDLE}}{unit_price:<{RIGHT}.2f}" + NL
total += how_many * unit_price
result += WIDTH * '-' + NL
total_str = f"{total:.2f} {currency}"
result += f"{'Total':>{LEFT}}{'':^{MIDDLE}}{total_str:<{RIGHT}}" + NL
result += WIDTH * '-' + NL
result += f"{thanks:^{WIDTH}}" + NL
result += WIDTH * '-' + NL
return result
une solution v1¶
ouvrez-moi
invoice.py
# just to illustrate type hinting capabilities
UnitPrice = float
NumberItems = int
Item = tuple[str, UnitPrice, NumberItems]
class InvoiceGenerator:
# no longer a global in v1
width = 50
# also note that we could easily use a dataclass here
def __init__(self, address, thanks, currency='$'):
self.address = address
self.thanks = thanks
self.currency = currency
def invoice(self, items: list[Item]):
"""
items is expected to be a list of tuples of the form
(label, unit_price, number_items)
"""
result = self.width * '*' + "\n"
result += center_address(self.address)
result += "\n" + self.width * '+' + "\n"
width2 = self.width // 2 - 8
# using litterals inside another litteral
# thanks to the 2 kinds of quotes
result += f"{'Product Name':>{width2}}{'#':>6} {'Item Price':<{width2}}\n"
total = 0
for (label, unit_price, number_items) in items:
total += unit_price * number_items
result += f"{label:>{width2}}{number_items:>6} {unit_price:<{width2}}\n"
result += self.width * '-' + "\n"
result += f"{'Total':>{width2}}{' ':8}{total:.2f}{self.currency}\n"
result += self.width * '+' + "\n"
result += f"{self.thanks:^{self.width}}\n"
result += self.width * '*'
return result