Dokumentera din nya klass

Fallstudie: Bygga programvara i Python

Mark Pedigo, PhD

Principal Data Scientist

Översikt

Översikt som visar vilka delar av projektet vi har slutfört och vad vi ska börja med härnäst.

Din klasshierarki

BasicCalculator
- Utför grundläggande aritmetik
FinancialCalculator
- Ärver från BasicCalculator
- Lägger till finansiella funktioner, t.ex. ränta
MortgageCalculator
- Ärver från FinancialCalculator
- Kombinerar funktionaliteten från båda klasserna

Docstrings

Fördelar med docstrings
- Ger tydliga och koncisa förklaringar av koden
Så skapar du en docstring
- Lägg till en strängkonstant som den första satsen
- Beskriv syfte och funktionalitet

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

Lägg till attribut i klassen 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

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

Håll koll på klassers funktionalitet

Använd dir(ClassName) för att lista en klass funktioner

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']

Nu kör vi en övning!

Fallstudie: Bygga programvara i Python