Documentare la tua nuova classe

Caso di studio: sviluppare software in Python

Mark Pedigo, PhD

Principal Data Scientist

Roadmap

Roadmap che mostra le parti del progetto completate e quelle in arrivo.

La tua gerarchia di classi

BasicCalculator
- Esegue operazioni aritmetiche di base
FinancialCalculator
- Figlio di BasicCalculator
- Aggiunge funzionalità finanziarie, come il tasso d'interesse
MortgageCalculator
- Eredita da FinancialCalculator
- Combina le funzionalità di entrambe le classi

Docstring

Vantaggi delle docstring
- Forniscono spiegazioni chiare e concise del codice
Come creare una docstring
- Aggiungi una stringa letterale come prima istruzione
- Scrivi scopo e funzionalità

def MortgageClass(FinancialCalculator):
    """
    MortgageClass estende FinancialCalculator con calcoli specifici per il mutuo.
    """
    ...

Aggiungi attributi alla classe MortgageCalculator

    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

    # Crea un attributo per memorizzare la rata mensile.
    self.monthly_payment = self.calculate_monthly_payment()

Tieni traccia delle funzionalità delle classi

Usa dir(ClassName) per ottenere l'elenco delle funzioni di una 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']

Ayo berlatih!

Caso di studio: sviluppare software in Python