Documentando sua nova classe

Estudo de Caso: Construindo Software em Python

Mark Pedigo, PhD

Principal Data Scientist

Roteiro

Roteiro mostrando o que já foi concluído no projeto e o que vamos começar.

Sua hierarquia de classes

BasicCalculator
- Executa aritmética básica
FinancialCalculator
- Filho de BasicCalculator
- Adiciona recursos financeiros, como taxa de juros
MortgageCalculator
- Herda de FinancialCalculator
- Combina funcionalidades de ambas as classes

Docstrings

Benefícios de docstrings
- Fornecem explicações claras e concisas do código
Como criar uma docstring
- Adicione um literal de string como a primeira instrução
- Explique o propósito e a funcionalidade

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

Adicione atributos à classe Mortgage Calculator

    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()

Acompanhe a funcionalidade das classes

Use dir(ClassName) para obter a lista de funções de uma classe

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

Vamos praticar!

Estudo de Caso: Construindo Software em Python