A Pythonic Object

[TOC]

第九章衔接第一章，介绍如何实现一个 Python 风格的对象。本章会重点介绍 Python 的魔法方法。

How to Implement a Pythonic Object

Python 并不是通过继承来实现某一个对象的特征，而是通过实现具体的魔法方法，来使一个对象具有某些特征。这就是 Python 的鸭子类型，实现了鸭子走和叫两个魔法方法，那么我们就拥有了鸭子的特征；实现了 __len__() 和 __getitem__() 这两个魔法方法，那么我们就拥有了 list 的特征，就可以调用 list 相关的标准库。

简单来说，我们想要我们自定义的类拥有什么样的特征，那么直接去实现去对应的魔法方法即可。

Object Representation 表示对象

print(object) 会打印出啥？

`repr()`

print() 方法会被 Python 解释器解释成 __repr__()，__repr__() 是面向开发者的

`str()`

str() 方法会被 Python 解释器解释成 __str__()，__str__() 是面向用户的，如果 __str__() 没有被实现，那么就会调用 __repr__() 方法

`bytes()`

bytes() 会调用该魔法方法，返回 byte sequence，将对象字节化

`format()`

built-in function: format()

str method: str.format()

创建一个 vector2d 类

实现 Iterable

def __iter__(self):
    """make a Vector2d iterable, make unpacking work
        vector = Vector2d(3, 4)
        x, y = vector
        iterable 是 tuple(this) 和 unpack 的基础
        返回一个 生成器表达式
        """
    return (i for i in (self.x, self.y))

实现 Representation

实现 __repr__() 方法的准则：

Note that in our __repr__ implementation we used !r to obtain the standard repre‐sentation of the attributes to be displayed. This is good practice, as it shows the crucialdifference between Vector(1, 2) and Vector('1', '2') — the latter would not work in the context of this example, because the constructors arguments must be numbers, not str.

The string returned by __repr__ should be unambiguous and, if possible, match the source code necessary to recreate the object being represented. That is why our chosen representation looks like calling the constructor of the class, e.g. Vector(3, 4).

def __repr__(self):
    """实现 print(vector) 的自定义"""
    class_name = type(self).__name__
    # __repr__ builds a string by interpolating the components with {!r} to get their
    # repr; because Vector2d is iterable, *self feeds the x and y components to
    # format
    return "{}({!r}, {!r})".format(class_name, *self)

判断 __repr__() 方法实现的效果：

v1 = Vector2d(3, 4)
v1_clone = eval(repr(v1))
v1 == v1_clone

实现 print

def __str__(self):
    """因为 Vector2d 是 iterable 的，所以其可以作为参数传入 tuple"""
    return str(tuple(self))

实现比较功能

def __eq__(self, other):
    """实现两个 vector 的可比性"""
    return tuple(self) == tuple(other)

特征 ——> 魔法方法

语法	魔法方法
==	`__eq__()`
repr()	`__repr__()`
str()	`__str__()`
bool()	`__bool__()`
format(), str.format()	`__format__()`
list	`__len__()` + `__getitem__()`
Iterable (单个对象可迭代)	`__iter__()`
hashable (可 hash)	1. 私有化成员变量 2. `__hash__()` 3. `__eq__()`
hash()	`__hash__()`

staticmethod and classmethod

classmethod is good for and staticmethod is not veryuseful.

staticmethod: Sometimes, you'll write code that belongs to a class, but that doesn't use the object itself at all.

classmethod: Class methods are methods that are not bound to an object, but to… a class!

Python 用两个内置的装饰器来实现静态方法。静态方法随着类的加载而加载，可以通过类名直接调用。

上面两个静态方法，不同点在于，classmethod 的第一个参数会传入类。Demos:

@staticmethod
def count(nums):
    return len(nums)

@classmethod
def frombytes(cls, octets): # 该方法属于该类，而不是属于对象
    typecode = chr(octets[0])
    memv = memoryview(octets[1:]).cast(typecode)
    return cls(*memv)

当我们在静态方法中，需要用到类时，就可以用 @classmethod 来修饰，例如上面的第二个例子中的 cls(*memv)

The classmethod decorator is clearly useful, but I’ve never seen a compelling use case for staticmethod. If you want do define a function that does not interact with the class, just define it in the module. Maybe the function is closely related even if it never touches the class, so you want to them nearby in the code. Even so, defining the function right before or after the class in the same module is close enough for all practical purposes.

其他人对于 staticmethod 和 classmethod 的观点：

[The definitive guide on how to use static, class or abstract methods in Python]

格式化 format

官方教程：Format String Syntax

三种特殊的格式化标记：

转换标记	解释成
`%s`, `!s`	`str()`
`%r`, `!r`	`repr()`
`%a`, `!a`	`ascii()`

format 的两种用法

fotmat 不仅可以对字符串进行格式化，还可以对很多对象进行格式化，时间对象，数值对象等

format(0.4115226337448559, '0.4f')
'1 BRL = {rate:0.2f} USD'.format(rate=brl)

%

name = "wansho"
age = 25

"age: %d" % age

"name: %s" % name # # %s 会被 Python 解释器解释成 str(name)
"name: %a" % name # %r 会被 Python 解释器解释成 ascii(name)
"name: %r" % name # %r 会被 Python 解释器解释成 repr(name)

format

name = "wansho"
age = 25

"age: {}".format(age)
"age: {age}".format(age = age)

'{2}, {1}, {0}'.format('a', 'b', 'c') # 'c, b, a'
'{2}, {1}, {0}'.format(*'abc') # 'c, b, a', * 用于将 字符串 解包
'{0}{1}{0}'.format('aa', 'bb') # aabbaa
"{:,}".format(6000000) # 6,000,000 https://www.cnblogs.com/lovejh/p/9201219.html

"name: {!r}".format(name)
"name: {!s}".format(name)
"name: {!a}".format(name)

数字格式化

下表展示了 str.format() 格式化数字的多种方法：

print("{:.2f}".format(3.1415926));
# 3.14

数字	格式	输出	描述
3.1415926	{:.2f}	3.14	保留小数点后两位
3.1415926	{:+.2f}	+3.14	带符号保留小数点后两位
-1	{:+.2f}	-1.00	带符号保留小数点后两位
2.71828	{:.0f}	3	不带小数
5	{:0>2d}	05	数字补零 (填充左边, 宽度为2)
5	{:x<4d}	5xxx	数字补x (填充右边, 宽度为4)
10	{:x<4d}	10xx	数字补x (填充右边, 宽度为4)
1000000	{:,}	1,000,000	以逗号分隔的数字格式
0.25	{:.2%}	25.00%	百分比格式
1000000000	{:.2e}	1.00e+09	指数记法
13	{:>10d}	13	右对齐 (默认, 宽度为10)
13	{:<10d}	13	左对齐 (宽度为10)
13	{:^10d}	13	中间对齐 (宽度为10)
11	`'{:b}'.format(11) '{:d}'.format(11) '{:o}'.format(11) '{:x}'.format(11) '{:#x}'.format(11) '{:#X}'.format(11)`	`1011 11 13 b 0xb 0XB`	进制

Hashable

一个自定义的类型，如何才能 hashable？

首先要实现 __hash__() 的魔法方法
如果实现了 __eq__() 方法，那么需要私有化成员变量

私有化成员变量 / hash

通过加双下划线，实现成员变量的私有化；通过 @property 装饰器，用来装饰只读方法。

Demo:

class Vector2d:
    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))  # 虽然私有化，但是内部仍然可以直接通过 self.x, self.y 调用

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

从上面这个例子可以看出，装饰器可以用来隐藏一些实现的细节，简化 function，使得语法更加简练，装饰器也可以用来表明一个 function 的作用。

private attributes in Python

截止到本章本知识点，本书没有提及私有方法的实现，只在本章提到了私有属性。

vector = Vector2d(3, 4)
print(vector.__dict__)
vector._Vector2d__x = 6
print(vector.__dict__)
vector.y = 8
"""
{'_Vector2d__x': 3.0, '_Vector2d__y': 4.0}
{'_Vector2d__x': 6, '_Vector2d__y': 4.0}
Traceback (most recent call last):
  File "D:/Github-Code/test/hashable.py", line 29, in <module>
    vector.y = 8
AttributeError: can't set attribute
"""

从上面的例子我们可以看出，虽然我们已经设置了 Python 对象成员变量的私有，但是我们还是可以在该类对象的 __dict__ 中看到该对象的私有变量，并且对其进行修改。

实际上，Python 不能实现真正的变量私有化，Python 的私有变量并不是 Java 的 private。我们从上面的例子可以看到，在进行 Python 所谓的私有化之后，Python 对私有变量加入了 _classname 的前缀，从而使得外部的写操作因为找不到真正的变量而失效，但是我们仍然可以通过加入前缀进行写的操作，这个无法避免，也是 Python 私有化和 Java 私有化的一个很大的区别。

protected attribute in Python

在 Python 的编码传统里，习惯将单下划线 _ 作为 protect 标记，表示我们不能在类外获取该属性，即该属性是类私有的，只能在类或者子类中使用。但是单下划线对于 Python 解释器来说，没有任何意义，只是一个约定俗成的规定。

另外，单下划线前缀在 module 的最上层变量确实有一个作用，如果我们通过 from my_module import *，那么以单下划线 _ 为前缀的变量并不会被导入。

saving space with `slots` class attribute

Python 默认将类的成员变量存储在 __dict__ 中，其实际上是将属性存储了字典中，那么如果属性太多，那么就会占用太多的空间，__slots__ 可以对其进行优化，不再详述。

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chapter9-a-pythonic-object.md

chapter9-a-pythonic-object.md

A Pythonic Object

How to Implement a Pythonic Object

Object Representation 表示对象

`repr()`

`str()`

`bytes()`

`format()`

创建一个 vector2d 类

实现 Iterable

实现 Representation

实现 print

实现比较功能

特征 ——> 魔法方法

staticmethod and classmethod

格式化 format

Hashable

私有化成员变量 / hash

private attributes in Python

protected attribute in Python

saving space with `slots` class attribute

Files

chapter9-a-pythonic-object.md

Latest commit

History

chapter9-a-pythonic-object.md

File metadata and controls

A Pythonic Object

How to Implement a Pythonic Object

Object Representation 表示对象

__repr__()

__str__()

__bytes__()

__format__()

创建一个 vector2d 类

实现 Iterable

实现 Representation

实现 print

实现比较功能

特征 ——> 魔法方法

staticmethod and classmethod

格式化 format

Hashable

私有化成员变量 / hash

private attributes in Python

protected attribute in Python

saving space with __slots__ class attribute

`repr()`

`str()`

`bytes()`

`format()`

saving space with `slots` class attribute