如何正确组织包/模块依赖树？

Question

早上好，

我目前正在编写python库。 目前，模块和类是以无组织的方式部署的，没有合理的设计。 当我接近正式发布时，我想重新组织类和模块，以便它们具有更好的总体设计。 我绘制了导入依赖关系图，并计划按层级别聚合类。 另外，我正在考虑对类进行一些修改，以减少这些依赖性。

对于潜在复杂且正在制作中的python库进行总体设计的最佳策略是什么？ 您有有趣的建议吗？

谢谢

更新：

我确实在寻找经验法则。 例如，假设发生这种情况（为清楚起见删除了init .py）

foo/bar/a.py
foo/bar/b.py
foo/hello/c.py
foo/hello/d.py

现在，如果您碰巧有d.py导入bar.b和a.py导入hello.c，我认为这是一个糟糕的设置。 另一种情况是

foo/bar/a.py
foo/bar/baz/b.py
foo/bar/baz/c.py

假设a.py和b.py都导入c。 您有以下三种解决方案：1）b导入c，导入baz.c 2）您在foo / bar中移动c。 a.py导入c，b.py导入.c 3）将c移动到其他位置（例如foo / cpackage / c.py），然后a和b都导入cpackage.c

我倾向于3），但是如果c.py作为独立模块没有任何意义，例如，因为您要将其“私有”保留在bar包中，则我会优先使用1）。

还有许多其他类似的情况。 我的经验法则是尽量减少依赖性和交叉的数量，以防止出现高度分支，高度交错的设置，但我可能是错的。

Answer 1

“我绘制了导入依赖关系图，并计划按层级别聚合类。”

Python必须像英语（或其他自然语言）一样阅读。

导入是一流的语句，应具有真实含义。 按“层次”（无论是什么层次）组织事物应该是清晰，有意义和显而易见的。

不要将类的任意技术分组归入模块，而将模块归入包。

使模块和包显而易见且合乎逻辑，以便导入列表显而易见，简单且合乎逻辑。

“此外，我正在考虑对类进行一些修改，以减少这些依赖性。”

减少依赖关系听起来是技术性和任意性的。 可能不是，但是听起来是这样。 没有实际的例子，这是不可能的。

您的目标是清晰。

而且，模块和包是独立的重用单元。 （不是类；是类，但是它本身通常是不可重用的。）您的依赖关系树应该反映出这一点。 您的目标是可以整洁干净地导入应用程序的模块。

如果您有许多密切相关的模块（或替代实现），则可以使用软件包，但要谨慎使用。 Python库相对扁平； 这有一些智慧。

---

编辑

层之间的单向依赖是一项基本功能。 这更多的是关于适当的软件设计，而不是Python。 您应该（1）在各层中进行设计，（2）在设计时要使各层之间的依赖性非常严格，然后（3）在Python中实现。

这些包可能不一定完全适合您的分层。 这些软件包实际上可以是目录的平面列表，其依赖性仅通过import语句表示。

Answer 2

这个问题很模糊。

您可以通过使基本/核心内容从库的其余部分中不导入任何内容，并从此处导入具体的实现方式来实现此目的。 除了“在导入时没有彼此导入的两个模块”之外，您应该没问题。

module1.py：

import module2

module2.py：

import module1

这行不通！

Answer 3

这取决于项目，对吗？ 例如，如果您使用的是模型视图控制器设计，那么您的程序包将以使三组代码独立的方式进行结构化。

如果您需要一些想法，请打开site-packages目录，并查看这些模块中的一些代码以了解如何设置它们。

如果不了解该模块，就没有正确的方法。 正如阿里所说，这是一个模糊的问题。 您确实只需要分析自己面前的东西，然后找出可能会更好的方法。