Python-API包装设计模式

Question

我正在尝试构建一个库来为API生成XML响应。为了帮助说明我的问题，这里有两个示例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>

。。。在

^{pr2}$

好的，我的模块大纲如下：

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接口类？在
3. 有没有一个编写优雅的Python库（Pythonic）可以做类似的事情？（我的想法就像Django模型系列化的精简版，或者Django-tastype）。在

Answer 1

最不幸的是，我不能评论Python方面的事情。

就我个人而言，我认为这个设计是非常可接受的。在

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

这些类对测试友好。您只需创建一条消息，填充一些值，并检查XML序列化版本。测试模式检查期望和实际输出。这些测试是整个协议的规范。在

这种设计有助于实现流畅的API:

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

为了便于参考，martinreddy在API design for C++中指出，对于协议或文件格式，有一个组件可以转换为序列化表示或从序列化表示转换。我认为这正是这些课程的目的。在

如果序列化表示形式发生变化（例如，从XML格式更改为二进制格式），则可以通过提供第二个接受格式的ctor来轻松地切换表示，或者您可以预料到该更改并引入一个SerializationFormat枚举。在

我可以很容易地想象一个python模块，它接受xmlschema ComplexType并从中生成匹配的python类。有一次，我尝试使用Altova XML-Spy在C中生成这些类；但是这涉及到引用一个运行时DLL，而使用另一个DLL只是，这似乎是太多的开销。这本质上就是protobuf的工作方式，xmlschema ComplexType在外部DSL中定义，序列化格式是二进制的。在