自定义类作为类型注解：提升代码可读性与可维护性的技巧_python 定义自定义类的实例增加代码可读性-CSDN博客

本文链接：https://blog.csdn.net/cebawuyue/article/details/142635441

在Python中，类型注解不仅可以帮助我们理解代码的意图，还能增强代码的可读性和可维护性。通过使用自定义类作为类型注解，我们可以更清晰地表达数据结构和函数的预期行为。本文将探讨如何有效使用自定义类作为类型注解，并提供一些实用的示例。

什么是类型注解？

类型注解是一种提供信息以指明函数参数和返回值的数据类型的方式。Python的动态特性使得类型注解在语法上是可选的，但在大型项目中，合理使用类型注解可以大大减少错误。

自定义类作为类型注解的优势

提高可读性：使用自定义类作为类型注解，能够清晰地表达数据的结构和用途。
简化代码：通过集中定义相关的数据，减少了对基本数据类型的依赖，使得代码更加直观。
增强类型检查：静态类型检查工具（如mypy）可以更好地理解你的代码，从而在开发时捕捉潜在错误。

示例：使用自定义类作为类型注解

考虑一个简单的例子，我们需要表示一个学生及其成绩：

from typing import List

class Student:
    def __init__(self, name: str, scores: List[int]):
        self.name = name
        self.scores = scores

    def average_score(self) -> float:
        return sum(self.scores) / len(self.scores)

def process_students(students: List[Student]) -> None:
    for student in students:
        print(f"{student.name}: {student.average_score():.2f}")

students = [
    Student("Alice", [85, 90, 92]),
    Student("Bob", [78, 82, 88]),
]

process_students(students)

在这个示例中，我们定义了一个Student类，并将其作为process_students函数的参数类型。这样，函数的意图变得更加明确。

组合使用自定义类

有时，我们的自定义类可能会包含其他类作为属性。这时，可以使用嵌套类型注解来清晰表达关系。例如，我们可以扩展上面的例子，增加课程信息：

class Course:
    def __init__(self, title: str, credits: int):
        self.title = title
        self.credits = credits

class Student:
    def __init__(self, name: str, courses: List[Course]):
        self.name = name
        self.courses = courses

    def total_credits(self) -> int:
        return sum(course.credits for course in self.courses)

def display_student_info(students: List[Student]) -> None:
    for student in students:
        print(f"Student: {student.name}, Total Credits: {student.total_credits()}")

# 示例数据
courses_alice = [Course("Math", 3), Course("Science", 4)]
courses_bob = [Course("History", 3), Course("Art", 2)]

students = [
    Student("Alice", courses_alice),
    Student("Bob", courses_bob),
]

display_student_info(students)

在这个扩展的例子中，Student类现在包含Course对象的列表，display_student_info函数也因此能够明确地展示出每个学生的课程信息。