Python 风格，命名常量参数

Question

我正在考虑将那些在函数体中未修改的 Python 函数参数拼写为 ALL_UPPERCASE，向此类 API 的用户发出信号，表明传递的值不会被修改(如果一切都如广告所言，无论如何) )。我不知道这会与 Python 约定或语言机制发生冲突；有吗？这样的命名约定是否可取，或者只是不必要的奇怪？

例如:

def foo(bar, BAZ):
    return bar.some_method(BAZ.some_property)

Answer 1

大写用于全局常量，而不是函数参数。请参阅Python Style Guide在这里。

在 Python 函数签名中，您希望所有参数都未被修改。如果一个参数需要一个可变对象并且它将就地更改，那么这是异常(exception)，应该这样记录:

def foo(bar, baz):
    """Frobs the bar in baz

    Alters the baz list in-place, and returns None.

    """

对未修改的函数参数使用大写字母会 a) 令人困惑(因为它与样式指南冲突)和 b) 多余，因为大多数代码不会就地更改可变对象，除非明确记录为这样做.