在模块和/或包中组织 Python 类

Question

我喜欢每个文件有一个公共类的 Java 约定，即使有时有充分的理由将多个公共类放入一个文件中。就我而言，我有同一接口的替代实现。但是，如果我将它们放入单独的文件中，导入语句中就会有多余的名称（或误导性的模块名称）：

import someConverter.SomeConverter

而 someConverter 将是文件（和模块）名称，而 SomeConverter 类名。这对我来说看起来很不优雅。将所有替代类放入一个文件中将导致更有意义的导入语句：

import converters.SomeConverter

但我担心如果我将所有相关类放入单个模块文件中，文件会变得相当大。这里的 Python 最佳实践是什么？每个文件一个类是否异常？

Answer 1

很多都是个人喜好。使用 python 模块，您可以选择将每个类保留在单独的文件中，并且仍然允许导入转换器。SomeConverter（或从转换器导入SomeConverter）

您的文件结构可以看起来像这样：

* converters
     - __init__.py
     - baseconverter.py
     - someconverter.py
     - otherconverter.py

然后在您的 __init__.py 文件中：

from baseconverter import BaseConverter
from otherconverter import OtherConverter

Answer 2

Zach 的解决方案在 Python 3 上失败。这是一个固定的解决方案。

很多都是个人喜好。使用 python 模块，您可以选择将每个类保留在单独的文件中，并且仍然允许导入转换器。SomeConverter（或从转换器导入SomeConverter）

您的文件结构可以看起来像这样：

* converters
     - __init__.py
     - baseconverter.py
     - someconverter.py
     - otherconverter.py

然后在您的 __init__.py 文件中：

from converters.baseconverter import BaseConverter
from converters.otherconverter import OtherConverter

Answer 3

上面的解决方案很好，但是在__init__.py中导入模块的问题是，这会导致所有模块被加载两次（效率低下）。尝试在 otherconverter.py 末尾添加打印语句并运行 otherconverter.py。 （您会看到 print 语句被执行了两次）

我更喜欢以下内容。使用另一个名为“_converter”的包并定义其中的所有内容。然后你的“converters.py”成为访问所有公共成员的接口

* _converters
     - __init__.py
     - baseconverter.py
     - someconverter.py
     - otherconverter.py

*  converters.py

，其中 converters.py 是

from _converters.someconverter import SomeConverter
from _converters.otherconverter import OtherConverter
...
...
...
converters = [SomeConverter, OtherConverter, ...]

正如前面提到的解决方案，这是个人选择。一些实践涉及在包中定义模块“interace.py”并在此处导入所有公共成员。如果您有许多模块要加载，您应该选择效率而不是美观。