HOWTO · Python
Python 中类构造函数的可选参数
了解如何在 Python 中为类构造函数设置可选参数
本页内容
在 __init__ 中为参数指定默认值,就能让构造函数中的该参数变为可选参数。调用者省略该参数时,Python 使用默认值;调用者传入值时,Python 则使用该值。没有默认值的参数仍然是必填参数。这样,类既能提供实用的常用配置,也允许调用者自定义实例。
理解 Python 中的默认参数
默认值属于函数定义中的参数。在函数调用中,位置参数按从左到右的顺序匹配,关键字参数则按参数名匹配。因此,带默认值的参数仍可以显式传入,既可以按位置传入,也可以通过关键字传入。“可选”表示调用者可以省略该值,并不表示该参数只能按名称匹配。
在 Python 类构造函数中设置可选参数
在构造函数中,直接在 __init__ 的签名里为参数指定默认值。下面的 Point 类要求传入 x 和 y;调用者省略 z 时,z 使用默认值 0。第二次调用传入不同的 z 值,以覆盖默认值。
运行以下示例。代码和输出中的文本标签仍为英文:
class Point:
def __init__(self, x, y, z=0):
self.x = x
self.y = y
self.z = z
def __str__(self):
return f"Point(x={self.x}, y={self.y}, z={self.z})"
print(Point(1, 2))
print(Point(54, 92, 7))
Point(x=1, y=2, z=0)
Point(x=54, y=92, z=7)
第一个实例的 z=0;第二个实例保存的 z 值为 7。每个实例都有自己的属性,默认值只对省略 z 的那次调用生效。
在类构造函数中使用多个可选参数
构造函数可以有多个默认值。先列出必填参数,再为调用者可以省略的参数指定默认值。例如,矩形可以要求传入尺寸,同时为填充色和边框设置默认值:
本节中的代码以及显示的标签或输出仍为英文。
class Rectangle:
def __init__(self, width, height, color="white", outlined=False):
self.width = width
self.height = height
self.color = color
self.outlined = outlined
def describe(self):
return f"{self.width}x{self.height}, color={self.color}, outlined={self.outlined}"
print(Rectangle(10, 5).describe())
print(Rectangle(8, 8, color="blue", outlined=True).describe())
10x5, color=white, outlined=False
8x8, color=blue, outlined=True
第一次调用使用两个默认值。第二次调用通过关键字参数分别覆盖了这两个值。构造函数有多个可选参数时,使用关键字可以清楚地表明每个值的用途;调用者也可以省略其他带默认值的参数,而不必为它们前面的位置填入值。
遵循参数顺序规则
在普通 Python 函数签名中,带默认值的参数必须放在没有默认值的参数之后。有效写法是 def __init__(self, required, option="default"):。如果把必填参数放在带默认值的参数之后,例如 def __init__(self, option="default", required):,就会产生语法错误,因此 Python 无法定义该函数。应调整参数顺序,让必填值排在前面;如果后面的参数确实可以省略,也可以为它指定合适的默认值。
签名有效后,调用者仍可选择使用位置参数或关键字参数。例如,Rectangle(8, 8, color="blue") 显式指定颜色,同时让 outlined 使用默认值。调用时,关键字参数之后不要再放位置参数;后续可选设置应使用关键字传入。
避免可变默认值带来的问题
Python 在创建函数时只计算一次默认值,不会在每次调用时重新计算。因此,列表之类的可变默认值可能会在多个实例之间,或在省略该参数的多次调用之间共享。对于每个实例都需要各自集合的构造函数设置,可以用 None 作为哨兵值,再在 __init__ 中创建一个新列表。
下面的示例对比了使用共享列表默认值的函数和安全写法。最后一次调用还演示了如何有意传入由调用者创建的列表。代码和输出中的文本标签仍为英文:
def collect(item, items=[]):
items.append(item)
return items
def collect_safely(item, items=None):
if items is None:
items = []
items.append(item)
return items
print(collect("apple"))
print(collect("banana"))
print(collect_safely("apple"))
print(collect_safely("banana"))
print(collect_safely("pear", []))
['apple']
['apple', 'banana']
['apple']
['banana']
['pear']
第一个函数始终使用同一个列表,所以第二次调用的结果会包含两个项目。安全写法会在每次省略参数时创建新列表;如果传入了列表,就会直接使用该列表。列表和字典等可变构造函数默认值也应采用同样的“None 后再创建”模式。数字、字符串和元组等不可变默认值不会产生这种共享修改问题。