Dokumentowanie nowej klasy

Studium przypadku: tworzenie oprogramowania w Pythonie

Mark Pedigo, PhD

Principal Data Scientist

Plan projektu

Plan projektu pokazujący ukończone i nadchodzące etapy.

Hierarchia klas

BasicCalculator
- Wykonuje podstawowe działania arytmetyczne
FinancialCalculator
- Klasa podrzędna BasicCalculator
- Dodaje funkcje finansowe, takie jak stopa procentowa
MortgageCalculator
- Dziedziczy po FinancialCalculator
- Łączy funkcjonalność obu klas

Docstringi

Zalety docstringów
- Zapewniają jasne i zwięzłe objaśnienia kodu
Jak tworzyć docstringi
- Dodaj literał tekstowy jako pierwsze wyrażenie
- Opisz cel i funkcjonalność

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

Dodawanie atrybutów do klasy 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()

Śledzenie funkcjonalności klas

Użyj dir(ClassName), aby uzyskać listę funkcji klasy

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

Czas na ćwiczenia!

Studium przypadku: tworzenie oprogramowania w Pythonie