Python API包装器设计模式

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接口类的设计模式？
3. 是否有一个编写精美的Python库（Pythonic），其功能类似？ （我在想像是Django模型序列化的简化版本，即Django-Tastypie）。

Answer 1

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

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

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

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

该设计使自己能够使用流畅的API ：

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

出于参考目的，Martin Reddy在C ++的API设计中声明，对于协议或文件格式，要具有一个与序列化表示形式相互转换的组件。 我认为这正是这些课程的目的。

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

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