Documentarea noii clase

Studiu de caz: Construirea de software în Python

Mark Pedigo, PhD

Principal Data Scientist

Foaie de parcurs

Foaie de parcurs care arată ce părți ale proiectului am finalizat și pe care le vom începe.

Ierarhia claselor

BasicCalculator
- Efectuează operații aritmetice de bază
FinancialCalculator
- Clasă derivată din BasicCalculator
- Adaugă funcții financiare, cum ar fi rata dobânzii
MortgageCalculator
- Moștenește din FinancialCalculator
- Combină funcționalitatea ambelor clase

Docstring-uri

Beneficiile docstring-urilor
- Oferă explicații clare și concise ale codului
Cum se creează un docstring
- Adăugați un literal de șir ca primă instrucțiune
- Scrieți o explicație a scopului și funcționalității

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

Adăugați atribute clasei 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()

Urmăriți funcționalitatea claselor

Folosiți dir(ClassName) pentru a obține lista funcțiilor unei clase

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

Să exersăm!

Studiu de caz: Construirea de software în Python