Python风格：我应该避免评论我的import语句吗？

Question

我会尝试尽可能地将其作为封闭式问题：

我经常发现我有一组进口，如一堆进口;但是稍后我可能删除或移动使用这些导入项目的代码部分到另一个文件。问题是我经常忘记为什么我使用特定的导入（例如，我经常使用Counter类，或者来自itertools的随机内容。）因此我可能希望有注释来指定我的导入的内容;这样，如果我不再需要它们，我可以删除整个块。

在我的导入语句中添加注释会被认为是不好的风格吗？

Answer 1

嗯，关于python的美妙之处在于它是（或应该）显式的。在这种情况下，只要你没有进行*导入（这被认为是不好的做法），你就会知道是否只是通过为命名空间执行grep来引用导入。然后你会知道你是否可以删除它。

请允许我为其他答案添加一个对位。 '太多'评论确实是不好的做法。您不应该在代码中添加冗余注释，这对于其功能来说是显而易见的。此外，必须保持评论，就像代码一样。如果您正在创建过多的评论，那么您将为自己创造更多的工作。

Answer 2

评论有助于解释/提醒。如果它们对您有用，请使用它们。此外，tools such as pylint可以帮助发现不需要的导入以及许多其他内容。

Answer 3

这一点都不错。最好有更多的评论而不是更少的评论。通过记录您使用某些导入的原因，它会向您的代码说明您拥有它们的原因，也许读者可能会看到您为什么要做某事并能够想出更好的方法。

你不应该回避正确评论你的代码。

Answer 4

我很确定你是否在代码中的任何地方添加了有意义的评论，它只能是一个加号。

我有时会对奇怪/令人困惑的进口商品添加评论，所以我会说去吧。

Answer 5

我不认为这是一种不好的做法。评论是为了提供清晰度，这就是你要做的事情。但是，如果您对使用的导入产品感到困惑，我建议您确定您的模块是否可能过大。