Python 特殊方法：字符串表示与迭代器的奥秘

Python 特殊方法：字符串表示与迭代器的奥秘

介绍字符串表示相关的 __str__、__repr__、__format__、__bytes__ 方法，以及迭代器相关的 __aiter__、__anext__（异步迭代器）和 __iter__、__next__（同步迭代器）方法。讲解如何通过这些方法实现对象的友好字符串输出和高效迭代。

目录

• Python 特殊方法：字符串表示与迭代器的奥秘
  • 字符串表示方法：
    • __str__方法：
    • __repr__方法：
    • __format__方法：
  • 迭代器方法：
    • _iter_ 和__next__方法：
  • 参考资料：
  • 总结： 本文总结了字符串表示和迭代器相关特殊方法的关键要点，强调其在提升代码可读性和数据处理效率方面的作用。

字符串表示方法：

__str__方法：

返回对象的字符串表示，用于 str() 函数和 print() 函数的默认输出。它的返回值应该是一个对用户友好的字符串，通常用于展示对象的可读信息。
例如：

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __str__(self):
        return f"Point(x={self.x}, y={self.y})"


p = Point(1, 2)
print(p)

__repr__方法：

返回对象的官方字符串表示，通常用于调试和开发环境，可通过 repr() 函数调用。repr 的返回值应该是一个能够准确描述对象的字符串，最好可以通过这个字符串重新创建对象。例如：

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __repr__(self):
        return f"Point({self.x}, {self.y})"


p = Point(1, 2)
print(repr(p))

__format__方法：

自定义对象的格式化输出，配合 format() 函数或 f-string 使用。它可以根据不同的格式化规范返回不同格式的字符串。例如：

class Circle:
    def __init__(self, radius):
        self.radius = radius

    def __format__(self, format_spec):
        if format_spec == 'area':
            import math
            return f"The area of the circle is {math.pi * self.radius ** 2}"
        elif format_spec == 'circumference':
            import math
            return f"The circumference of the circle is {2 * math.pi * self.radius}"
        else:
            return f"Circle with radius {self.radius}"


c = Circle(5)
print(f"{c:area}")
print(f"{c:circumference}")

• _bytes_****方法：返回对象的字节表示，用于 bytes() 函数。适用于需要将对象转换为字节序列进行存储或传输的场景。例如：

class BinaryData:
    def __init__(self, data):
        self.data = data

    def __bytes__(self):
        return bytes(self.data, encoding='utf-8')


data = BinaryData("Hello, World!")
print(bytes(data))

迭代器方法：

_iter_ 和__next__方法：

用于实现同步迭代器，iter 返回迭代器对象（通常是自身），next 返回下一个元素，当没有更多元素时抛出 StopIteration 异常。这在前面容器与序列操作部分已有详细示例，这里再次强调其在通用迭代场景中的重要性。

• _aiter_和anext****方法：用于实现异步迭代器，可用于异步文件读取、异步分页数据处理等异步场景。例如，模拟一个异步迭代器读取数据：

import asyncio


class AsyncDataReader:
    def __init__(self, data):
        self.data = data
        self.index = 0

    def __aiter__(self):
        return self

    async def __anext__(self):
        if self.index >= len(self.data):
            raise StopAsyncIteration
        item = self.data[self.index]
        self.index += 1
        await asyncio.sleep(0.1)  # 模拟异步操作
        return item


async def main():
    data = [1, 2, 3, 4, 5]
    reader = AsyncDataReader(data)
    async for item in reader:
        print(item)


asyncio.run(main())

参考资料：

参考 Python 官方文档中关于字符串和迭代器的内容（https://docs.python.org/3/library/stdtypes.html#text-sequence-type-str ，https://docs.python.org/3/library/stdtypes.html#iterator-types ），结合 Tekin 的 Python 专栏中关于字符串处理和迭代器应用的文章（https://blog.csdn.net/tekin_cn/article/details/145798596），通过实例展示如何实现对象的友好字符串输出和高效迭代，帮助读者提升代码的可读性和数据处理能力。

总结： 本文总结了字符串表示和迭代器相关特殊方法的关键要点，强调其在提升代码可读性和数据处理效率方面的作用。

• TAG：Python、特殊方法、字符串表示、迭代器、异步迭代