为新类编写文档

案例研究：用 Python 构建软件

Mark Pedigo, PhD

Principal Data Scientist

路线图

路线图，展示我们已完成的项目部分和即将开始的部分。

案例研究：用 Python 构建软件

类层级结构

  • BasicCalculator
    • 执行基础算术
  • FinancialCalculator
    • BasicCalculator 的子类
    • 增加金融功能，如利率
  • MortgageCalculator
    • 继承自 FinancialCalculator
    • 组合两者的功能
案例研究：用 Python 构建软件

文档字符串（Docstrings）

  • 文档字符串的益处
    • 提供清晰、简洁的代码说明
  • 如何创建文档字符串
    • 将字符串字面量放在首行
    • 说明目的和功能
def MortgageClass(FinancialCalculator):
    """
    MortgageClass 扩展 FinancialCalculator，用于按揭相关计算。
    """
    ...
案例研究：用 Python 构建软件

为按揭计算器类添加属性

    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

    # 创建一个属性以保存每月还款额。
    self.monthly_payment = self.calculate_monthly_payment()
案例研究：用 Python 构建软件

跟踪类的功能

  • 使用 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 构建软件

Passons à la pratique !

案例研究：用 Python 构建软件

Preparing Video For Download...