Документирование нового класса

Практический проект: разработка программного обеспечения на Python

Mark Pedigo, PhD

Principal Data Scientist

Дорожная карта

Дорожная карта с указанием завершённых и предстоящих этапов проекта.

Иерархия классов

BasicCalculator
- Выполняет базовые арифметические операции
FinancialCalculator
- Дочерний класс BasicCalculator
- Добавляет финансовые возможности, например расчёт процентной ставки
MortgageCalculator
- Наследует от FinancialCalculator
- Объединяет функциональность обоих классов

Строки документации

Преимущества строк документации
- Чёткое и понятное описание кода
Как создать строку документации
- Добавьте строковый литерал как первый оператор
- Опишите назначение и функциональность

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

Добавление атрибутов в класс 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()

Отслеживание функциональности классов

Используйте dir(ClassName), чтобы получить список методов класса

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

Давайте потренируемся!

Практический проект: разработка программного обеспечения на Python