向Python字典键添加前缀的最有效方法

Question

所以我发现自己需要在Python字典中添加前缀。

基本上，我希望该字典的用户能够在字典实例化时添加前缀，在这种情况下，字典将保留该前缀，并且每次添加新键时，都会为其添加前缀。但是，如果出于某种原因未提供或更改前缀，我也想更改字典，这意味着旧字典键需要在保留其各自值的同时为其添加前缀。

用例：

基本上，我正在完成MWS API的最后一个api 。我围绕以下想法构建了api：每次调用都需要采用特定的参数，例如：

def get_report(self, marketplaceids):
    # Here I process marketplaceids which is a python list
    # and send the following to Amazon:

    MarketplaceIdList.Id.1: 123,
    MarketplaceIdList.Id.2: 345,
    MarketplaceIdList.Id.3: 4343

    # By doing this I eliminate the complexity of the arguments Amazon expects

不幸的是，后两个api很难通过这种方式实现，因为它们利用了Amazon引入的称为的新“功能” Datatypes。

这些“ Datatypes”是嵌套结构。例如：

我想从中调用CreateInboundShipment操作InboundShipmentAPI，

该操作采用以下参数：

ShipmentId - String
InboundShipmentHeader - InboundShipmentHeader datatype
InboundShipmentItems - A list of InboundShipmentItem datatypes

之所以会发生此问题，是因为InboundShipmentHeader是一个数据类型，该数据类型将另一个数据类型作为参数。最终，Amazon期望以下几点：

ShipmentId=102038383
InboundShipmentHeader.ShipmentName': 'somevalue',
InboundShipmentHeader.ShipFromAddress.Name': 'somevalue',
InboundShipmentHeader.ShipFromAddress.AddressLine1': 'somevalue',
InboundShipmentHeader.ShipFromAddress.City': 'somevalue',
InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode': 'somevalue',
InboundShipmentHeader.ShipFromAddress.PostalCode': 'somevalue',
InboundShipmentHeader.ShipFromAddress.CountryCode': 'somevalue',
InboundShipmentHeader.DestinationFulfillmentCenterId': 'somevalue',
InboundShipmentHeader.ShipmentStatus': 'somevalue',
InboundShipmentHeader.LabelPrepPreference': 'somevalue',
InboundShipmentItems.member.1.QuantityShipped': 'somevalue',
InboundShipmentItems.member.2.QuantityShipped': 'somevalue',
InboundShipmentItems.member.1.SellerSKU': 'somevalue',
InboundShipmentItems.member.2.SellerSKU': 'somevalue',
InboundShipmentHeader.ShipFromAddress.AddressLine2': 'somevalue',
InboundShipmentHeader.ShipFromAddress.DistrictOrCounty': 'somevalue',

因此，我想简化某人进行此调用的过程，而不必担心每个参数的名称。我的解决方案是创建一个基本数据类型类，然后将单独的数据类型创建为类。

这是我到目前为止的内容：

class AmazonDataType(dict):
    """
    Base for all Amazon datatypes.
    """

    def __init__(self, *args, **kwargs):
        self._prefix = kwargs.pop('prefix', '')
        self.update(*args, **kwargs)

    @property
    def prefix(self):
        return self._prefix

    @prefix.setter
    def prefix(self, value):
        self._prefix = value
        newdict = {'%s.%s' % (value, key): dictvalue for key, dictvalue in self.iteritems()}
        self.clear()
        dict.update(self, newdict)

    def __setitem__(self, key, value):
        try:
            original_key = self.fields[key]
        except KeyError, e:
            raise e
        if isinstance(value, AmazonDataType):
            value.prefix = original_key
            dict.update(self, value)
        else:
            newkey = self.prefix + original_key if self.prefix else original_key
            dict.__setitem__(self, newkey, value)

    def update(self, *args, **kwargs):
        """
        Props to Matt Anderson (http://stackoverflow.com/a/2390997/389453)
        """
        for k, v in dict(*args, **kwargs).iteritems():
            self[k] = v


class InboundShipmentHeader(AmazonDataType):
    fields = {
        'name': 'ShipmentName',
        'address': 'ShipFromAddress',
        'fulfillment_center_id': 'DestinationFulfillmentCenterId',
        'label_preference': 'LabelPrepPreference',
        'cases_required': 'AreCasesRequired',
        'shipment_status': 'ShipmentStatus',
    }

然后，而不是做

somedict = {
    'InboundShipmentHeader.ShipmentName': 'somevalue',
    'InboundShipmentHeader.ShipFromAddress.Name': 'somevalue',
    'InboundShipmentHeader.ShipFromAddress.AddressLine1': 'somevalue',
    'InboundShipmentHeader.ShipFromAddress.City': 'somevalue',
    'InboundShipmentHeader.ShipFromAddress.StateOrProvinceCode': 'somevalue',
    'InboundShipmentHeader.ShipFromAddress.PostalCode': 'somevalue',
    'InboundShipmentHeader.ShipFromAddress.CountryCode': 'somevalue',
    'InboundShipmentHeader.DestinationFulfillmentCenterId': 'somevalue',
    'InboundShipmentHeader.ShipmentStatus': 'somevalue',
    'InboundShipmentHeader.LabelPrepPreference': 'somevalue',
}

call_amazon(somedict)

我想通过类似

ShipmentHeader = InboundShipmentHeader()
ShipmentHeader['name'] = 'somevalue'
ShipmentHeader['address'] = address_datatype_instance
ShipmentHeader['fulfillment_center_id'] = 'somevalue'
ShipmentHeader['label_preference'] = 'somevalue'
ShipmentHeader['cases_required'] = 'somevalue'
ShipmentHeader['shipment_status'] = 'somevalue'

call_amazon(ShipmentHeader, otherparams)

该call_amazon方法在后台执行以下操作：

ShipmentHeader.prefix = InboundShipmentHeader

Answer 1

你可以子类化dict并添加一个方法（我不知道该怎么称呼它，所以让我们说dict）：

class AmazonDataType(dict):
    """
    Base for all Amazon datatypes.
    """

    def __init__(self, *args, **kwargs):
        self._prefix = kwargs.pop('prefix', self.__class__.__name__)

        super(AmazonDataType, self).__init__(*args, **kwargs)

    def __getattr__(self, key):
        return self.__getitem__(key)

    def __setattr__(self, key, value):
        return self.__setitem__(key, value)

    def dict(self):
        result = {}

        for key, value in self.items():
            if key.startswith('_'):
                continue

            key = self.fields.get(key, key)

            if isinstance(value, AmazonDataType):
                for skey, svalue in value.dict().items():
                    result['%s.%s' % (self._prefix, skey)] = svalue
            else:
                result['%s.%s' % (self._prefix, key)] = value

        return result

现在，界面更加 Pythonic 了：

class InboundShipmentHeader(AmazonDataType):
    fields = {
        'name': 'ShipmentName',
        'address': 'ShipFromAddress',
        'fulfillment_center_id': 'DestinationFulfillmentCenterId',
        'label_preference': 'LabelPrepPreference',
        'cases_required': 'AreCasesRequired',
        'shipment_status': 'ShipmentStatus',
    }

class Address(AmazonDataType):
    fields = {
        'name': 'Name',
        'address': 'AddressLine1',
        'city': 'City'
    }

address = Address(prefix='ShipFromAddress')
address.name = 'Foo'

header = InboundShipmentHeader()
header.name = 'somevalue'
header.address = address
header.fulfillment_center_id = 'somevalue'
header.label_preference = 'somevalue'
header.cases_required = 'somevalue'
header.shipment_status = 'somevalue'

的输出header.dict()是：

{'InboundShipmentHeader.AreCasesRequired': 'somevalue',
 'InboundShipmentHeader.DestinationFulfillmentCenterId': 'somevalue',
 'InboundShipmentHeader.LabelPrepPreference': 'somevalue',
 'InboundShipmentHeader.ShipFromAddress.Name': 'Foo',
 'InboundShipmentHeader.ShipmentName': 'somevalue',
 'InboundShipmentHeader.ShipmentStatus': 'somevalue'}