Documenter votre nouvelle classe

Étude de cas : créer des logiciels en Python

Mark Pedigo, PhD

Principal Data Scientist

Feuille de route

Feuille de route montrant les parties du projet terminées et celles à commencer.

Votre hiérarchie de classes

BasicCalculator
- Effectue des opérations arithmétiques de base
FinancialCalculator
- Enfant de BasicCalculator
- Ajoute des fonctions financières, p. ex. taux d'intérêt
MortgageCalculator
- Hérite de FinancialCalculator
- Combine les fonctions des deux classes

Docstrings

Atouts des docstrings
- Offrent des explications claires et concises du code
Créer une docstring
- Ajouter une chaîne littérale comme première instruction
- Décrire l'objectif et les fonctionnalités

def MortgageClass(FinancialCalculator):
    """
    MortgageClass extends the FinancialCalculator to mortgage specific calculations.
    """
    ...

Ajouter des attributs à la classe Mortgage Calculator

    class MortgageCalculator(FinancialCalculator):
    def __init__(self, loan_amount, annual_interest_rate, years):
        super().__init__()
        self.loan_amount = loan_amount
        self.monthly_interest_rate = self.monthly_interest(annual_interest_rate)

    self.months = years * 12

    # Create an attribute to hold the monthly payment amount.
    self.monthly_payment = self.calculate_monthly_payment()

Suivre les fonctionnalités des classes

Utilisez dir(ClassName) pour obtenir la liste des fonctions d'une classe

dir(MortgageCalculator)

['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', 
'__format__', '__ge__', '__getattribute__', '__getstate__', '__gt__', 
'__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', 
'__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__',
'__sizeof__', '__str__', '__subclasshook__', '__weakref__', 
'difference', 'monthly_interest', 'months_from_years',
'power', 'product', 'quotient', 'sum']

Passons à la pratique !

Étude de cas : créer des logiciels en Python