如何合并包含具有相同签名的方法的两个Python类?

时间:2012-03-06 00:55:36

标签: python api rest api-design

我正在使用REST客户端库,并且最近开始致力于添加对发送批处理消息的支持。

但是,我不喜欢当前的设计。它要求您使用相同的方法签名维护大型Client和RequestMessage类。

我正在寻找一种巩固这两个类的方法。

原始客户端类的方法包含准备和发送请求所需的所有代码:

class Client(object):

   def __init__(self, config):
       self.request = Request(config, "application/json")

   def create_vertex(self, data):
       path = "vertices"
       params = remove_null_values(data)
       self.request.post(path, params)

要添加对批处理消息的支持,我在每个Client方法中删除了代码的内容,并将其放入单独的RequestMessage类中,以便您可以将消息添加到批处理中而不发送它,直到您#39 ;准备好了:

class Client(object):

   def __init__(self, config):
       self.request = Request(config, "application/json")
       self.message = RequestMessage(config)

   def create_vertex(self, data):
       message = self.message.create_vertex(data)
       return self.request.send(message)

   # ...more REST client methods...

   def batch(self, messages):
       path = "batch" 
       params = messages
       return self.request.post(path, params)       

class RequestMessage(object):

   def __init__(self, config):
       self.config = config

   def create_vertex(self, data):
       path = "vertices"
       params = remove_null_values(data)
       return POST, path, params

  # ...more REST client methods...

但我不喜欢这个设计,因为现在你必须维护Client和RequestMessage类 - 两个具有相同签名的大类。

这是Batch类的样子:

class Batch(object):

   def __init__(self, client):
       self.client = client
       self.messages = []

   def add(self, message):
       self.messages.append(message)

   def send(self):
       return self.client.batch(self.messages)

以下是在服务器上创建顶点的示例用法:

>>> client = Client(config)
>>> vertex = client.create_vertex({'name':'James'})

以下是在服务器上创建一批顶点的示例用法:

>>> message1 = client.message.create_vertex({'name':'James'})
>>> message2 = client.message.create_vertex({'name':'Julie'})
>>> batch = Batch(client)
>>> batch.add(message1)
>>> batch.add(message2)
>>> batch.send()

Batch的使用频率低于Client,所以我想让普通的Client界面最容易使用。

这是一个想法,但我不太确定如何实现它或者其他什么会更好:

   >>> vertex = client.create_vertex(data)
   >>> message = client.create_vertex(data).message()

2 个答案:

答案 0 :(得分:1)

我的个人偏好是一个API,如:

client.create_vertex({'name':'James'}) # single
client.create_vertex([{'name':'James'}, {'name':'Julie'}]) # batch

这样你使用完全相同的功能,你只是给它更多的数据。典型用法可能看起来更像:

batch = []
batch.append({'name':'James'})
batch.append({'name':'Julie'})
client.create_vertex(batch)

答案 1 :(得分:1)

我同意@Karl的一些修改

client.create_vertex({'name':'James'}) # single
client.create_vertex({'name':'James'}, {'name':'Julie'}) # batch

batch = []
batch.append({'name':'James'})
batch.append({'name':'Julie'})
client.create_vertex(*batch)

这样您就不必检查输入的类型。更容易编写,更易于使用。