Python 中的“空行”缩进

Question

哪个是首选（“.”表示空格）？

A)

def foo():
    x = 1
    y = 2
....
    if True:
        bar()

B)

def foo():
    x = 1
    y = 2

    if True:
        bar()

我的直觉是 B （这也是 Vim 所做的我），但我看到人们一直在使用 A）。难道只是因为大多数编辑器都坏了？

Answer 1

如果您使用 A，您可以在 Python shell 中复制粘贴您的块，但 B 将收到意外缩进错误（“IndentationError：意外缩进”）。

Answer 2

PEP 8 在这个问题上似乎并没有明确，尽管声明关于“空行”可以解释为有利于 B。PEP 8 样式检查器 (pep8.py) 更喜欢 B，并在您使用 A 时发出警告；然而，这两种变体都是合法的。我自己的观点是，由于 Python 在任何一种情况下都会成功解释代码，因此这并不重要，并且尝试强制执行它会付出大量工作而收效甚微。我想如果你非常坚定地支持其中之一，你可以自动将其中一种转换为另一种。不过，尝试手动修复所有这些线路将是一项艰巨的任务，而且真的不值得付出努力，恕我直言。

Answer 3

向空行添加适当的缩进（问题中的样式 A）在启用显示空白的情况下极大地提高了代码的可读性，因为它可以更轻松地查看空行之后的代码是否属于同一缩进块的一部分。

对于像 Python 这样没有结束语句或右括号的语言，我很惊讶这不是 PEP 的一部分。强烈建议在打开显示空白的情况下编辑 Python，以避免尾随空白和混合缩进。

比较阅读以下内容：

A)

def foo():
....x = 1
....y = 2
....
....if True:
........bar()

B)

def foo():
....x = 1
....y = 2

....if True:
........bar()

在 A 中，最后两行是 foo 的一部分，这一点要清楚得多。这在更高的压痕级别上更加有用。

Answer 4

该空行属于 foo()，因此我认为 A 是最自然的。但我想这只是一个意见问题。

Answer 5

如果您使用 B，TextMate 会破坏块折叠，无论如何我更喜欢 A，因为它更“合乎逻辑” 。

Answer 6

我在开源开发方面的经验是，永远不应该在空行内留下空格。另外，永远不应该留下尾随空白。

这是编码礼仪的问题。

Answer 7

B 是优选的——即没有缩进。 PEP 8 说：

避免任何地方出现尾随空格。因为它通常是不可见的，所以可能会令人困惑 [...] 一些编辑器不保留它，并且许多项目（如 CPython 本身）都有拒绝它的预提交钩子。

---

这些格式化程序强制执行此操作：

• 黑色 (在线尝试)
• autopep8 (在线尝试）

Answer 8

我不一定将第一个示例称为“损坏”，因为我知道有些人讨厌在代码中向上或向下移动光标时光标“跳回”。例如，Visual Studio（至少 2008）会自动防止这种情况发生，而无需在这些行上使用任何空白字符。

Answer 9

Emacs 对我来说是 B)，但我真的认为这并不重要。 A) 意味着您可以在正确的缩进处添加一行，而无需任何制表符。

Answer 10

vi 隐含地阻止了 A 中的行为，因为 {/< code>} 导航不再按预期工作。 Git 在运行 git diff。我还认为，如果一行包含空格，那么它就不是空行。

出于这个原因，我强烈喜欢 B。没有什么比期望用 { 动作跳过六行左右并最终到达类定义的顶部更糟糕的了。

Answer 11

除了@Zags 答案。添加此作为答案以便能够附加图片。

如果您希望 PyCharm 使用“A”样式（在空行上保留缩进），请在设置中启用它：
文件 |设置 |编辑|代码风格| Python。
在您选择的方案中，启用复选框“在空行上保留缩进”。

但是，对于现有的不正确（样式“B”）文件，您仍然需要触发重新格式化。从主菜单：代码 |重新格式化文件（CtrlAltShiftL）。