Python类__init__()内显式属性声明与隐式创建的差异及最佳实践

问题描述 #

我是一名正在学习Eric Matthes所著《Python Crash Course》的Python初学者，目前学到第9章“类与面向对象编程”。我编写了如下代码：

class User: # Define the class
    """A simple attempt to model website users."""

    def __init__(self, first_name, last_name, age, username, city, country):
        self.first_name = first_name.title()
        self.last_name = last_name.title()
        self.age = age
        self.username = username
        self.city = city.title()
        self.country = country.title()
        self.login_attempts = 0

我理解Python会调用__init__()方法创建实例，存储first_name、last_name、age、username、city和country属性，作者提到Python会创建login_attempts属性。但我看到有人会在__init__()的参数列表中显式写入login_attempts属性，请问这两种实现方式有何区别？哪种属于编程最佳实践？我希望养成良好的编码习惯，避免给后续使用我代码的人带来困扰，感谢解答！

两种实现方式的区别 #

首先明确两种写法的差异：

写法1（你的实现） #

在__init__内部直接初始化属性，参数列表不包含login_attempts：

def __init__(self, first_name, last_name, age, username, city, country):
    # ... 其他属性赋值
    self.login_attempts = 0

写法2（显式添加参数） #

将login_attempts加入参数列表，并设置默认值：

def __init__(self, first_name, last_name, age, username, city, country, login_attempts=0):
    # ... 其他属性赋值
    self.login_attempts = login_attempts

两者核心区别：

• 灵活性：写法2允许创建实例时自定义login_attempts的初始值（比如User("John", "Doe", 30, "johndoe", "New York", "USA", 5)），而写法1所有实例的初始值固定为0，无法在初始化阶段修改。
• 可读性与透明度：写法2把login_attempts的可配置性直接暴露在函数签名中，其他开发者通过参数列表就能知道这个属性可以初始化配置；写法1的login_attempts是类内部隐式初始化的，不查看__init__代码的话，可能无法快速知晓这个属性的存在或初始值规则。
• 设计意图传递：写法1传递的意图是“这个属性是类内部维护的状态，外部无需在创建时干预”；写法2传递的意图是“这个属性支持外部初始化配置，默认值为0”。

最佳实践建议 #

选择哪种写法取决于你的业务需求：

• 如果login_attempts是纯内部维护的状态（比如只有类的increment_login_attempts()这类方法会修改它，外部永远不需要在创建用户时设置初始值），那么写法1是合理的，符合封装内部状态的原则。
• 如果存在自定义初始值的场景（比如从数据库加载用户数据时，需要恢复之前的登录尝试次数），那么写法2更合适——既保留了默认初始值为0的行为，又提供了灵活配置的能力，符合Python“显式优于隐式”的设计哲学。
• 无论选择哪种写法，都应该在类的文档字符串中明确说明login_attempts的作用，比如更新类的文档：

  class User:
      """A simple attempt to model website users.
      
      Attributes:
          login_attempts: 跟踪用户的登录尝试次数，初始值为0。
      """
  

  这样能让其他开发者快速理解属性用途，减少使用困惑。

内容的提问来源于stack exchange，提问作者Kenny Smith