定义具有太多参数的函数以遵守 PEP8 标准

Question

我定义了一个带有一长串参数的函数。定义总字数80以上，不遵守PEP8。

def my_function(argument_one, argument_two, argument_three, argument_four, argument_five):

避免水平滚动的最佳方法是什么？

Answer 1

def my_function(argument_one, argument_two, argument_three, 
                argument_four, argument_five):

Answer 2

PEP 8 中给出了一个例子：

class Rectangle(Blob):

    def __init__(self, width, height,
                 color='black', emphasis=None, highlight=0):

这就是官方的回答。我个人讨厌这种方法，其中续行的前导空格与任何实际缩进级别都不对应。我的方法是：

class Rectangle(Blob):

    def __init__(
        self, width, height,
        color='black', emphasis=None, highlight=0
    ):

。 . .或者只是让该行超过 80 个字符。

Answer 3

我个人也曾经提出与@BrenBarn 的第二种风格相同的解决方案。我喜欢它正确表示函数参数的缩进及其实现的方式，尽管“不开心的脸”对其他人来说有些不寻常。

现在PEP8专门给出了这样的例子，所以也许主流会适应这种风格：

    # Add 4 spaces (an extra level of indentation)
    # to distinguish arguments from the rest.
    def long_function_name(
            var_one, var_two, var_three,
            var_four):
        print(var_one)

我们当然可以更进一步，将每个参数分开到自己的行中，这样以后任何添加/删除参数都会得到一个干净的git diff：

    # Add 4 spaces (an extra level of indentation)
    # to distinguish arguments from the rest.
    def long_function_name(  # NOTE: There should be NO parameter here
            var_one,
            var_two,
            var_three,
            var_four,  # NOTE: You can still have a comma at the last line
            ):  # NOTE: Here it aligns with other parameters, but you could align it with the "def"
        print(var_one)

Answer 4

对于使用 type annotations 的 Python 代码，我建议这样做：

def some_func(
    foo: str,
    bar: str = 'default_string',
    qux: Optional[str] = None,
    qui: Optional[int] = None,
) -> List[str]:
    """
    This is an example function.
    """
    print(foo)
    ...

如果您使用yapf，您可以在.style.yapf 中使用这些选项：

[style]
dedent_closing_brackets = true
split_arguments_when_comma_terminated = true

如果你使用black，你不需要做任何事情，如果你在最后一个参数后面添加一个逗号，它会使用上面的样式。

Answer 5

我个人喜欢将参数排成一行，从左括号开始并保持缩进。 flake8 似乎也很满意。

def guess_device_type(device_name: str,
                      username: str=app.config['KEY_TACACS_USER'],
                      password: str=app.config['KEY_TACACS_PASS'],
                      command: str='show version') -> str:
    """Get a device_type string for netmiko"""

Answer 6

我发现自己这样做很有趣：

def my_function(
        argument_one, argument_two, argument_three,
        argument_four, argument_five
):
    ...

它允许代码折叠很容易地揭示函数签名，例如，考虑下面的 sn-p：

def my_function(
        argument_one, argument_two, argument_three,
        argument_four, argument_five
):
    s1 = 1
    s2 = 2
    if s1 + s2:
        s3 = 3


def my_other_function(argument_one, argument_two, argument_three):
    s1 = 1
    s2 = 2
    if s1 + s2:
        s3 = 3

这种方式允许对整个文件进行代码折叠并一次查看所有函数/签名，即：

Answer 7

1。我会推荐什么

尽管它使函数更加冗长，对于多个参数，我认为这是最好的——下面的例子来自Python——：

def my_function(
    argument_one, 
    argument_two, 
    argument_three,
    argument_four, 
    argument_five,
):
    ...

2。为什么？

1. 将每个参数放在一行中使得使用git diffs 变得非常简单，因为更改一个 变量只会显示 的更改。如果每一行都有不止一个论点，那么以后在视觉上会更烦人。
   • 请注意，最后一个参数后面的逗号使以后添加或删除参数更容易，同时也符合PEP 8's Trailing Comma Convention，并在以后产生更好的git diff。
2. 我真的不喜欢“将参数与左括号对齐”范例的原因之一是它不会产生易于维护的代码。
   • Kevlin Henney 在his ITT 2016 - Seven Ineffective Coding Habits of Many Programmers lecture (around 17:08) 中解释说 是一种不好的做法。
   • 这是一种不好的做法的主要原因是，如果您更改函数的名称（或者如果它太长），您将不得不重新编辑 all上的间距> 论点的线条，完全不可扩展，虽然它可能 (sometimes) (subjectively) 更漂亮。
   • 另一个与上述原因密切相关的原因是关于元编程。如果代码库变得太大，您最终会发现自己需要对代码文件本身进行编程更改，如果每个函数的参数间距不同，这可能会变得地狱。
3. 大多数编辑器，一旦打开括号并按下 enter，将打开一个带有制表符的新行，并将右括号推到下一行，没有制表符。因此，以这种方式格式化代码非常快速且标准化。例如，这种格式在JavaScript 和Dart 中很常见。
4. 最后，如果您认为每个参数都过于笨拙，因为您的函数可能有 很多 个参数，我会说您因为极少数例外而影响了代码的简单格式化。
   • 不要通过例外来立法。
   • 如果您的函数有 很多 个参数，那么您可能做错了什么。将其分解为更多（子）函数和（子）类。

3。无论如何...

一个好的约定比一个坏的要好，但是执行一个比不必要地挑剔它们更重要。

一旦您决定使用标准，请与您的同事分享您的决定并使用自动格式化程序 - 例如，Prettier 是 JavaScript 在VS Code 中的流行选择; Dart 语言已经在全球范围内标准化了一个：dartfmt — 以一致地执行它，减少手动编辑的需要。