Python中的参数命名约定

Question

对于具有密切相关的形式参数的函数，例如

def add_two_numbers(n1, n2):
    return n1 + n2

def multiply_two_numbers(n1, n2):
    return n1 * n2

如上所示，给两个函数中的参数赋予相同的名称是一个好主意吗？

另一种方法是重命名其中一个函数中的参数。 例如：

def add_two_numbers(num1, num2):
    return num1 + num2

在两个函数中保持相同看起来更加一致，因为每个函数所采用的参数都是类似的，但更令人困惑的是？

同样，对于下面的例子哪个更好？

def count(steps1, steps2):
    a = 0
    b = 0

    for i in range(steps1):
        a += 1

    for j in range(steps2):
        b += 1

    return a, b

def do_a_count(steps1, steps2):
    print "Counting first and second steps..."
    print count(steps1, steps2)

否则，更改第二个函数中的参数会给出：

def do_a_count(s1, s2):
    print "Counting first and second steps..."
    print count(s1, s2)

再说一遍，我不确定哪种方式最好。 保持相同的参数名称使两个函数之间的关系更清晰，而第二个意味着不可能在两个函数中混淆参数。

我做了一些搜索（包括浏览PEP-8），但找不到明确的答案。 （我发现的类似问题包括： python函数中的可选参数的命名练习和Python中，避免对__init__参数和实例变量使用相同名称的最佳方法是什么？ ）

Answer 1

我会保持名称相同，除非你有充分的理由使用不同的名称...请记住，甚至位置参数可以通过关键字调用，例如：

>>> def foo(a,b):
...     print a
...     print b
... 
>>> foo(b=2,a=1)

保持“关键字”相同有助于这个罕见但合法的角落案例......

Answer 2

一般来说，你应该给你的函数的参数名称有意义，甚至在选择这些名称时甚至不考虑与其他函数有关。 两个函数的参数名称之间没有任何关系，即使函数执行类似的操作也是如此。

虽然......如果功能确实做了类似的事情，也许这表明你错过了重构？ :)

Answer 3

这里重要的指导原则是你应该给他们一些合理的名字 - 理想情况下，当你一年后回到你的代码时，你会猜到参数的名字。

每个程序员都有一套约定。 有些人喜欢将整数参数调用到二进制函数n1和n2 ; 其他像n ， m ; 或者lhs ， rhs ; 或者是其他东西。 只要你选择一个并坚持下去（只要它是合理的），其他任何人都可以在几秒钟后学习你的风格，阅读你的代码并理解它。 如果你在各处使用不同的名字，他们将不得不做更多的猜测。

正如mgilson指出的那样，如果你愿意，你可以使用关键字参数。 它还意味着具有自动完成功能的IDE更有用 - 当您看到(…n1…, …n2…)弹出时，您知道要传递两个整数。 但主要是为了可读性。

当然，如果有不同的含义，给他们不同的名称。 在某些情况下，使用add_two_numbers(augend, addend)和multiply_two_numbers(factor, multiplicand)可能是合理的。