小编典典

“导入模块”的编码样式是否比“来自模块导入功能”的编码样式更好?

python

from module import function被称为FMIF的编码风格。

import module被称为IM的编码风格。

from package import module被称为FPIM的编码风格。

为什么IM +FPIM被认为比FMIF更好的编码风格?(有关问题的启发。)

以下是一些使我更喜欢FMIF而不是IM的条件:

  1. 代码的简短性:它使我可以使用较短的函数名称,从而有助于遵循每行80列的约定。
  2. 可读性:chisquare(...)比更具可读性 scipy.stats.stats.chisquare(...)。尽管这是一个主观标准,但我认为大多数人都会同意。
  3. 易于重定向:如果我使用FMIF,并且由于某些原因在以后的某个时间想要重定向python来定义functionalt_module而不是module我只需要更改一行:from alt_module import function。如果要使用IM,则需要更改许多代码行。

我意识到FPIM可以使前两个问题无效,但是第三个问题又如何呢?

我对IM +
FPIM可能比FMIF更好的所有原因都感兴趣,但是特别是,我对这里提到的以下几点感兴趣:

IM的优点:

  1. 易于在测试中进行模拟/注入。(尽管我最近对模拟并不十分熟悉,但是我最近才了解该术语的含义。在这里,您可以显示代码证明IM优于FMIF的代码吗?)
  2. 通过重新定义一些条目,模块可以灵活更改的功能。(我一定会误会,因为这似乎是FMIF相对于IM的优势。请参见上面支持FMIF的第三个理由。)
  3. 有关数据序列化和恢复的可预测和可控制的行为。(我真的不明白IM或FMIF的选择如何影响此问题。请详细说明。)
  4. 我了解FMIF会“污染我的名称空间”,但是除了听起来像是一个否定性的短语外,我不明白这会如何以任何具体方式伤害代码。

PS。在撰写此问题时,我收到警告,该问题看起来很主观,很可能已被关闭。请不要关闭它。我并不是在寻找主观意见,而是要寻找IM +
FPIM比FMIF更好的具体编码情况。

非常感谢。


阅读 170

收藏
2020-12-20

共1个答案

小编典典

您为IM / FPIM列出的否定词通常可以通过适当使用as子句来改善。 from some.package import mymodulewithalongname as mymod可以有效地缩短代码并提高其可读性,如果重命名mymodulewithalongnamesomethingcompletelydifferent明天,则该as子句可以用作单个语句进行编辑。

考虑您的FMIF前点3(重定向时称为R)与FPIM的前点2(灵活性时称为F):R等于促进模块边界完整性的丧失,而F则增强了模块边界的完整性。模块中的多个函数,类和变量通常旨在协同工作:不应将它们独立切换为不同的含义。例如,考虑模块random及其功能seed以及uniform:如果要将其中一个的导入切换到其他模块,则将中断对的调用seed与对的调用结果之间的常规连接uniform。当一个模块设计得很好,具有内聚力和完整性时,R打破模块边界的便利实际上是不利的-
它使您做得更好的事情变得更容易 这样做。

反之亦然,F使耦合的函数,类和变量(因此,通常,通过模块化 属于 同一实体的实体)之间的 协调
切换成为可能。例如,要使测试可重复(FPIM要点1),请在模块中和两者同时进行模拟,如果代码遵循FPIM,则一切就绪,可以保证协调。但是,如果您有直接导入函数的代码,则必须查找每个此类模块,并一遍又一遍地重复模拟。要使测试完全可重复,通常还需要对日期和时间函数进行“协调模拟”-如果在某些模块中使用,则需要查找并模拟所有这些(以及所有进行模拟的模拟)
__seed``random``random``from datetime import datetime``from time import time,依此类推),以确保当系统的各个部分询问“现在几点了?”时收到的所有时间。完全一致(如果使用FPIM,则只需模拟两个相关模块)。

我喜欢FPIM,因为通过使用有真的没有太多的附加价值 乘以 合格的名称,而不是一个单独合格的一个(而barenames和合格的名称之间的差异是
巨大的 -你会得到 这样 一个合格的名字更多的控制,无论是单或成倍增加,比起用一个裸名!

嗯,不能把所有的工作时间都花在回答您的每一个问题上-您的问题可能应该是六个问题;-)。我希望这至少能解决“为什么F比R更好”以及一些模拟/测试问题-归结为
维护和增强设计良好的模块化 (通过F)而不是破坏(通过R)。

2020-12-20