Python API包装器设计模式

我正在尝试构建一个库，该库将为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>

注意：为了可读性，我删除了这些类处理的验证和消毒

因此，我的问题是：

我实际上是在输出这些对象的序列化表示，这样做是错误的还是糟糕的做法

是否有一种设计模式来描述这种API接口类

是否有一个编写优雅（Pythonic）的Python库可以做类似的事情？（我的想法就像是Django模型序列化或Django Tastypie的精简版本）

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

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

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

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

该设计有助于实现流畅的API：

出于参考目的，Martin Reddy声明，对于协议或文件格式，有一个组件可以转换为序列化表示或从序列化表示转换为组件。我认为这正是这些课程的目的

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

序列化格式

枚举

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

最不幸的是，我无法评论Python方面的内容

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

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

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

该设计有助于实现流畅的API：

出于参考目的，Martin Reddy声明，对于协议或文件格式，有一个组件可以转换为序列化表示或从序列化表示转换为组件。我认为这正是这些课程的目的

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

序列化格式

枚举

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

<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))

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