python 双下划线方法如何调用

原创

mob649e81567471 2024-09-08 05:55:35 ©著作权

文章标签 下划线 Python 字符串 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e81567471的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python 双下划线方法如何调用

在Python中，双下划线方法（或称魔法方法）是以双下划线开头和结尾的特殊方法。这些方法在特定情境下被自动调用，允许开发者自定义类的行为，增强程序的可读性和可维护性。本文将介绍如何调用这些双下划线方法，并通过具体示例来展示它们的应用。

一、什么是双下划线方法

双下划线方法，又称为魔法方法（Magic Methods），是Python中特殊的方法，通常用于重载内置操作符、实现自定义行为。它们通常不直接调用，而在特定的上下文中被隐式调用。

常见的双下划线方法包括：

__init__: 构造方法
__str__: 字符串表示
__repr__: 官方字符串表示
__add__: 加法运算
__len__: 获取对象长度

二、具体示例：自定义一个简单的矩形类

我们以一个简单的矩形类为例，展示如何定义和调用双下划线方法。

1. 矩形类定义

class Rectangle:
    def __init__(self, length, width):
        self.length = length
        self.width = width

    def __str__(self):
        return f"Rectangle(length={self.length}, width={self.width})"

    def __repr__(self):
        return f"Rectangle({self.length}, {self.width})"

    def __add__(self, other):
        if isinstance(other, Rectangle):
            return Rectangle(self.length + other.length, self.width + other.width)
        return NotImplemented

    def __len__(self):
        return 2 * (self.length + self.width)

# 使用示例
rect1 = Rectangle(3, 4)
rect2 = Rectangle(5, 6)

print(rect1)          # 输出 Rectangle(length=3, width=4)
print(repr(rect1))   # 输出 Rectangle(3, 4)

rect3 = rect1 + rect2
print(rect3)         # 输出 Rectangle(length=8, width=10)

print(len(rect1))    # 输出 14

在上述示例中，我们定义了一个名为 Rectangle 的类，并实现了若干个双下划线方法。这里的__init__方法用于初始化长度和宽度，__str__和__repr__方法用于返回对象的字符串表示，__add__方法用于重载加法操作符，__len__方法则返回矩形的周长。

2. 调用过程解析

在创建 rect1 和 rect2 对象时，__init__ 方法被自动调用。在打印 rect1 时，实际调用的是 __str__ 方法。通过 rect1 + rect2 实际上调用了 __add__ 方法，而 len(rect1) 则调用了 __len__ 方法。

三、关系图

使用Mermaid语法来表示矩形类之间的关系图，如下所示：

erDiagram
    Rectangle {
        int length
        int width
    }

该关系图简单展示了 Rectangle 类的属性，便于理解类的结构。

四、旅程图

我们还可以使用Mermaid的“journey”图来描述从创建到使用矩形类的整个过程：

journey
    title 矩形类的使用旅程
    section 创建矩形
      创建 rect1: 5: rect1
      创建 rect2: 5: rect2
    section 调用方法
      打印 rect1: 5: print
      打印 rect1 的 repr: 5: repr
      尝试相加 rect1 和 rect2: 5: add
      打印新创建的矩形: 5: print
      获取 rect1 的长度: 5: len

该旅程图描述了从创建矩形对象到调用其方法的步骤，清晰而直观。