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

Question

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

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

使用我的import语句进行注释是否被认为是不好的风格？

Answer 1

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

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

Answer 2

评论有助于解释/提醒.如果它们对您有用,请使用它们.此外,诸如pylint之类的工具可以帮助发现不需要的进口以及许多其他东西.