Python API 包装设计模式

Question

已结束。此问题正在寻求书籍、工具、软件库等的推荐。它不满足 Stack Overflow guidelines 。目前不接受答案。

---

我们不允许提出寻求书籍、工具、软件库等推荐的问题。您可以编辑问题，以便用事实和引文来回答。

已关闭 5 年前。

Improve this question

我正在尝试构建一个库来为 API 构建 XML 响应。为了帮助说明我的问题，这里有 2 个 API 响应示例。第一个用于显示菜单，第二个用于显示文本。

<CiscoIPPhoneMenu>
  <Title>Title text goes here</Title>
  <Prompt>Prompt text goes here</Prompt>
  <MenuItem>
   <Name>The name of each menu item</Name>
   <URL>The URL associated with the menu item</URL>
  </MenuItem>
  <SoftKeyItem>
   <Name>Name of soft key</Name>
   <URL>URL or URI of soft key</URL>
   <Position>Position information of the soft key</Position>
  </SoftKeyItem>
</CiscoIPPhoneMenu>

...

<CiscoIPPhoneText>
  <Title>Title text goes here</Title>
  <Prompt>The prompt text goes here</Prompt>
  <Text>The text to be displayed as the message body goes here</Text>
  <SoftKeyItem>
   <Name>Name of soft key</Name>
   <URL>URL or URI of soft key</URL>
   <Position>Position information of the soft key</Position>
  <SoftKeyItem>
</CiscoIPPhoneText>

好的，我的模块大纲如下所示:

class CiscoIPPhone(object): 
    def __init__(self, title=None, prompt=None):
        self.title = title
        self.prompt = prompt

class MenuItem(object):
    def __init__(self, name, url):
        self.name = name
        self.url = url

class CiscoIPPhoneMenu(CiscoIPPhone):
    def __init__(self, *args, **kwargs):
        super(CiscoIPPhoneMenu, self).__init__(*args, **kwargs)
        self.items = []

    def add_menu(self, name, url):
        self.items.append(MenuItem(name, url))

注意:为了便于阅读，我删除了这些类处理的验证和清理。

所以我的问题是:

1. 我实际上输出这些对象的序列化表示，这样做是否被认为是错误或不好的做法？
2. 是否有描述此类 API 接口(interface)类的设计模式？
3. 是否有一个编写优雅(Pythonic)的 Python 库可以做类似的事情？ (我的想法就像 Django 模型序列化的精简版本，或 Django-Tastypie)。

Answer 1

最不幸的是，我无法对 Python 方面的事情发表评论。

我个人认为这个设计是非常可以接受的。

这些消息在一个地方被序列化和反序列化。使用这些类的域代码创建一个类，用必要的数据填充它，然后将它(或其序列化表示)传递给另一个组件。当实际序列化发生时，类本身会检查是否已设置所有必需数据。

这些类适合测试。您只需创建一条消息，填写一些值，然后检查 XML 序列化版本。测试模式检查期望和实际输出。这些测试是整个协议(protocol)的规范。

该设计适合于一个很好的流畅的 API:

new CiscoIPPhoneMenu()
    .withTitle("Title text goes here")
    .withPrompt("Prompt text goes here")
    ...

出于引用目的，Martin Reddy 在 API design for C++ 中指出对于协议(protocol)或文件格式，有一个组件可以转换为序列化表示或从序列化表示转换。我认为这正是这些类(class)的目的。

如果序列化表示发生变化(例如从 XML 格式更改为二进制格式)，您可以轻松地通过以下方式切换表示:提供接受格式的第二个构造函数，或者您预计会进行更改并引入 SerializationFormat 枚举。

我可以很容易地想象一个 python 模块，它采用 XML 模式 ComplexType 并从中生成匹配的 python 类。一旦我尝试使用 Altova XML Spy 在 C# 中生成这些类；然而，这涉及引用运行时 DLL，并且为此使用另一个 DLL 似乎开销太大。这本质上就是这样protobuf可以使用在外部 DSL 中定义的 XML 模式 ComplexType，并且序列化格式为二进制格式。