Dokumentace nové třídy

Případová studie: Tvorba softwaru v Pythonu

Mark Pedigo, PhD

Principal Data Scientist

Plán projektu

Plán projektu znázorňující dokončené a aktuálně řešené části.

Hierarchie tříd

BasicCalculator
- Provádí základní aritmetiku
FinancialCalculator
- Potomek třídy BasicCalculator
- Přidává finanční funkce, jako je úroková sazba
MortgageCalculator
- Dědí z FinancialCalculator
- Kombinuje funkcionalitu obou tříd

Docstringy

Výhody docstringů
- Poskytují jasné a stručné vysvětlení kódu
Jak vytvořit docstring
- Přidejte řetězcový literál jako první příkaz
- Popište účel a funkcionalitu

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

Přidání atributů do třídy 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()

Přehled funkcí tříd

Použijte dir(ClassName) k zobrazení funkcí třídy

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

Pojďme si procvičit!

Případová studie: Tvorba softwaru v Pythonu