创建一个符合Python风格的对象(1)

自己定义一个简单的二维欧几里得向量类型,使该类的行为跟真正的Python对象一样。
该类所支持的主要特性如下

  • 支持用于生成对象其他表示形式的内置函数,如repr(),bytes()
  • 使用一个类方法实现备选构造方法
  • 扩展内置的format()str.format()方法使用的格式微语言
  • 实现只读属性
  • 把对象变为可散列的,以便在集合中及作为dict的键使用
  • 利用__slots__节省内存

下面依次实现一些特殊方法。

1.__iter__

def __iter__(self):
    return (i for i in (self.x, self.y))

该方法使类变成可迭代的对象,可以支持拆包,例如x, y = my_vector

2.__repr__

def __repr__(self):
    class_name = type(self).__name__
    return '{}({!r}, {!r})'.format(class_name, *self)

使用 {!r} 获取各个分量的表示形式,然后插值,构成一个字符串;因为 Vector2d 实例是可迭代的对象,所以 *self 会把 xy 分量提供给 format 函数

3.__bytes__

def __bytes__(self):
    return (bytes([ord(self.typecode)]) + 
            bytes(array(self.typecode, self)))

首先将 typecode 转换成字节序列,然后迭代 Vector2d 实例,得到一个数组,再把数组转换成字节序列。

4.__eq__

def __eq__(self, other):
    return tuple(self) == tuple(other)

为了快速比较所有分量,在操作数中构建元组。

5.__format__

def __format__(self, fmt_spec=''):
    if fmt_spec.endswith('p'):
        fmt_spec = fmt_spec[:-1]
        coords = (abs(self), self.angle())
        outer_fmt = '<{}, {}>'
    else:
        coords = self
        outer_fmt = '({}, {})'
    components = (format(c, fmt_spec) for c in coords)
    return outer_fmt.format(*components)

在格式规范微语言中,整数使用的代码有 'bcdoxXn',浮点数使用的代码有 'eEfFgGn%',字符串使用的代码有 's'。因此,我为极坐标选的代码是 'p'

首先判断格式代码fmt_spec是否以'p'结尾。

如果是,使用极坐标,从格式代码中删除'p'后缀,然后构建一个元组表示极坐标,再把外层格式设为一对尖括号。

如果不是,使用selfxy分量构建直角坐标,把外层格式设为一对圆括号。

最后,使用各分量生成可迭代的对象,构成格式化字符串,把格式化字符串带入外层格式。

6.__hash__
为了把 Vector2d 实例变成可散列的,必须使现 __hash__ 方法(还需要 __eq__ 方法,前面已经实现了)。此外,还要设置只读属性,让向量不可变。

def __hash__(self):
    # 根据特殊方法 [__hash__的文档],最好使用位运算符异或(^)混合各分量的散列值
    return hash(self.x) ^ hash(self.y)

def __init__(self, x, y):
    self._x = float(x)
    self._y = float(y)

# @property 装饰器把读值方法标记为特性
@property
def x(self):
    return self._x

@property
def y(self):
    return self._y

6.备选构造方法
Vector2d 实例转换成字节序列了;同理,也应该能从字节序列转换成 Vector2d实例。

@classmethod
def frombytes(cls, octets):
    typecode = chr(octets[0])
    memv = memoryview(octets[1:]).cast(typecode)
    return cls(*memv) 

类方法使用classmethod装饰器修饰,不用传入self参数,相反,要通过cls传入类本身。
先从第一个字节读取typecode,然后使用剩余的字节序列创建一个memoryview,再使用typecode转换,最后拆包转换后的memoryview,得到构造方法所需的一对参数。

最后,使用 __slots__ 类属性节省空间。默认情况下,Python 在各个实例中名为 __dict__ 的字典里存储实例属性。为了使用底层的散列表提升访问速度,字典会消耗大量内存。如果要处理数百万个属性不多的实例,通过 __slots__ 类属性,能节省大量内存,方法是让解释器在元组中存储实例属性,而不用字典。
继承自超类的 __slots__ 属性没有效果。Python 只会使用各个类中定的 __slots__ 属性。
下面是完整的代码

from array import array
import math

class Vector2d:
    __slots__ = ('_x', '_y')
    
    typecode = 'd'

    def __init__(self, x, y):
        self.__x = float(x)
        self.__y = float(y)

    @property
    def x(self):
        return self.__x

    @property
    def y(self):
        return self.__y

    def __iter__(self):
        return (i for i in (self.x, self.y))

    def __repr__(self):
       class_name = type(self).__name__
        return '{}({!r}, {!r})'.format(class_name, *self)

    def __str__(self):
        return str(tuple(self))

    def __bytes__(self):
        return (bytes([ord(self.typecode)]) +
                bytes(array(self.typecode, self)))

    def __eq__(self, other):
        return tuple(self) == tuple(other)

    def __hash__(self):
        return hash(self.x) ^ hash(self.y)

    def __abs__(self):
        """返回 Vector2d 实例的模"""
        return math.hypot(self.x, self.y)

    def __bool__(self):
        """ bool 函数会调用 __bool__ 方法,如果 Vector2d 实例的模为零,返回 False,否则返回 True。"""
        return bool(abs(self))

    def angle(self):
        """计算角度"""
        return math.atan2(self.y, self.x)

    def __format__(self, fmt_spec=''):
        if fmt_spec.endswith('p'):
            fmt_spec = fmt_spec[:-1]
        coords = (abs(self), self.angle())
        outer_fmt = '<{}, {}>'
    else:
        coords = self
        outer_fmt = '({}, {})'
    components = (format(c, fmt_spec) for c in coords)
    return outer_fmt.format(*components)

@classmethod
def frombytes(cls, octets):
    typecode = chr(octets[0])
    memv = memoryview(octets[1:]).cast(typecode)
    return cls(*memv)

你可能感兴趣的:(创建一个符合Python风格的对象(1))