Python中命名易遮蔽内置名称的format/type类参数的规范咨询

嗨，这个问题确实挺常见的——毕竟format和type都是Python里常用的内置名称，用它们当参数名确实容易踩坑。我整理了几个Python社区里常用的替代命名方案，你可以根据自己的场景选择：

• 加下划线后缀：这是Python社区里规避内置名称冲突的经典做法，官方库也有不少类似示例。直接在原名称末尾加下划线，比如format_，既保留了原名称的含义，又不会和内置名冲突。你的例子可以修改为：

  def foo(a, b, format_="str"):
      if format_ == "str":
          return str(a + b)
      elif format_ == "float":
          return float(a + b)
      else:
          raise Exception("Invalid parameter format")
  

• 使用更具描述性的名称：如果参数的作用是控制返回值的类型或格式，不如直接把名字起得更明确，比如return_type或者output_format。这种方式不仅避免了命名冲突，还让参数的含义一目了然，提升了代码的自文档性，别人不用看注释也能明白这个参数的作用。示例如下：

  def foo(a, b, return_type="str"):
      if return_type == "str":
          return str(a + b)
      elif return_type == "float":
          return float(a + b)
      else:
          raise Exception("Invalid return type")
  

• 使用简洁缩写（需谨慎）：比如把format缩写成fmt，type缩写成typ。不过这种方式要确保团队内部对缩写含义有共识，否则反而会降低代码的可读性，所以建议只在大家都能理解的场景下使用。

另外要注意：尽量不要用单个下划线前缀（比如_format），因为在Python中，单个下划线前缀通常用来表示“内部使用”的变量或参数，容易让调用者误解这个参数是私有、不应该被外部使用的。

备注：内容来源于stack exchange，提问作者RomainP