时间戳

首页 > 解决方案 > 如何在单体代码库中正确命名服务文件和文件夹？

python - 如何在单体代码库中正确命名服务文件和文件夹？

问题描述

我想听听您对在代码库中命名文件和文件夹的想法。假设我们在支付范围下定义了不同的供应商服务（paypalService、stripeService 等）和退款服务。考虑支付目录中的以下结构：

monolith
|
└--payment
     │   __init__.py
     │   views.py
     │   tasks.py
     └───services
     │   │   __init__.py
     │   └───refund
     │       │   __init__.py
     │       │   main.py
     │       │   utils.py
     │   └───vendors
     │       │   __init__.py
     │       └─── stripe
     │          │   __init__.py
     │          │   main.py
     │          │   utils.py
     │       └─── paypal
     │          │   __init__.py
     │          │   main.py
     │          │   utils.py
     │       └─── adyen
     │          │   __init__.py
     │          │   main.py
     │          │   utils.py

在这个结构中，文件名本身并不代表任何东西（例如main.py），但是当我们查看全名时，包括文件夹，例如（monolith/payment/services/refund/main.py），这个 main.py 名称确实给出了给定模块包含任何内容的主要部分的想法它所在的服务目录。同样的想法适用于所有文件：每个模块的完整路径清楚地描述了模块的内容。

有人声称这__init__.py是放置主模块类的合适位置，但我对此进行了研究，但没有遇到这样的用例。AFAIK 的可能用例__init__.py是定义如何将目录作为一个包提供给外部世界，例如__all__在这个文件中定义对我来说很有意义。

我想出了这个想法（init、main、utils trio）来构建服务目录，我想听听你的想法。所有具有相似名称的文件（例如 main、utils）都让我觉得有些痒痒。这是一个不好的做法吗？构建此类服务目录的替代方法有哪些？

假设：

任何阅读有关此问题的最佳实践的来源也将不胜感激！

标签： pythonservicedirectorynaming-conventionsmodularity

解决方案

问题中提供的结构对我来说看起来不错。这是绝对清楚的。

有很多具有相似名称的文件不是问题（你好，Django！每个包都有__init__.py, models.py, admin.py, tests.py, templatetags.py（或具有相同名称的包）。

对于像解决方案这样的框架来说，有很多类似的命名文件是绝对正常的，它允许您创建某种“可插拔系统”，以防您现在或将来需要它。

现代编辑器通过为案例添加带有父目录名称的前缀/后缀，可以很好地处理不同目录中的同名文件。我最喜欢的 IDE PyCharm 有一个很酷的插件，适用于这种情况Tabdir 插件。

我喜欢你的结构。任何现代框架都试图标准化“应用程序或插件文件夹”，这很正常。那是真正的编程，而不是编写大量丑陋的文件并导入它:)

推荐阅读