Question

以下是我要问的问题的前奏：我已经采用Python为我的公司构建了一个与网关无关的支付API。目前我只编写代码来支持Authorize.net，并希望从Python程序员那里得到一些关于我的API设计清晰度的反馈，而且比我更有经验。

我选择自己滚动，因为其他包存在感觉更像是一个想法或特定于Authorize.net（我想写一个更通用的包具有更清晰的界面）。我特别从包（pythorize）获得了一些灵感，但不喜欢他们的API。

在我开始描述我正在做的事情之前，这里是包的bitbucket上公共存储库的链接：paypy（注意那些可能想要使用它的人：代码是稳定的，但是文档很严重缺乏）。

我当前的策略是使用嵌套字典并将其传递给付款方式类的构造函数。在Authorize.net CIM API上创建新用户配置文件的示例：

>>> options = {'tran_key' : 'test_tran_key',
...            'login'    : 'developer_login',
...            'testing'  : True,
...            'validation': 'testMode',
...            'customer': {'description': 'Some description of the customer profile', 
...                         'id'         : 22,
...                         'email'      : 'johnny_doe@gmail.com'},
...            'billing': [{'type': 'individual',
...                         'profile': {'city'      : 'Carlsbad',
...                                     'state'     : 'California',
...                                     'zip'       : '92009',
...                                     'firstname' : 'John',
...                                     'address'   : '12 Alicante Rd. Suite 9',
...                                     'lastname'  : 'Doe',
...                                     'country'   : 'USA',
...                                     'phone'     : '(858) 557-2674'},
...                         'payment': {'card': {'ccv'        : '524',
...                                              'number'     : '4111111111111111',
...                                              'expiration' : '2014-04'}}},
...                        {'type'    : 'individual',
...                         'profile' : {'city'      : 'Las Vegas',
...                                      'state'     : 'Nevada',
...                                      'zip'       : '79112',
...                                      'firstname' : 'John',
...                                      'address'   : '78 Cloud Front',
...                                      'lastname'  : 'Doe',
...                                      'country'   : 'USA',
...                                      'phone'     : '(858) 557-2674'},
...                         'payment': {'card': {'ccv'        : '499',
...                                              'number'     : '4111111111111111',
...                                              'expiration' : '2012-11'}}},
...                        {'profile': {'city'       : 'Carlsbad',
...                                     'state'      : 'California',
...                                     'zip'        : '92009',
...                                     'firstname'  : 'John',
...                                     'address'    : '12 Alicante Rd. Suite 9',
...                                     'lastname'   : 'Doe',
...                                     'company'    : 'Xmarks',
...                                     'country'    : 'USA',
...                                     'phone'      : '(858) 557-2674'},
...                         'payment': {'bank': {'name_on_account' : 'John Doe',
...                                              'account'         : '829330184383',
...                                              'type'            : 'checking',
...                                              'name'            : 'Bank of America',
...                                              'routing'         : '122400724'}}}],
...            'shipping': [{'city'       : 'Carlsbad',
...                          'state'      : 'California',
...                          'zip'        : '92009',
...                          'firstname'  : 'John',
...                          'address'    : '12 Alicante Rd. Suite 9',
...                          'lastname'   : 'Doe',
...                          'country'    : 'USA',
...                          'phone'      : '(858) 557-2674'}]}
>>> profile = Profile(options)
>>> result  = profile.create()
>>> result.code
'I00001'
>>> print 'Customer Profile ID:' + str(result)
Customer Profile ID: 2758851
>>> print 'Customer Payment Profile IDs:' + repr(result.payment_ids)
Customer Payment Profile IDs: ['2380878', '2380879', '2380880']
>>> print 'Customer Shipping Profile IDs:' + repr(result.shipping_ids)
Customer Shipping Profile IDs: ['2427568']
>>>
>>>
>>> options = {'id'        : str(result),
...            'tran_key' : '86U5pvA9TcxZ5b8D',
...            'testing'  : True,
...            'login'    : '5b3PhGX68'}
>>> profile = Profile(options)
>>> result  = profile.remove()
>>> result.code
'I00001'
>>> ^D

您会注意到我为结果对象使用了几种魔术方法（如 str 等...）。我也使用AIM和ARB方法的字典策略，并认为这是向支付API传达“选项”的最简单方法 - 因为在某些时候会有适用于GoogleCheckout，Paypal等的适配器......

另一个想法是使用描述符和对象而不是字典来将选项数据传递给适配器。

与所有支付网关API（特别是PayPal和Authorize.net）一样，接口往往有点乱，并且没有任何标准化，因此很难避免某些与网关相关的选项。

Answer 1

深度嵌套的词典在Python中可能并不少见，也许它们可能是“Pythonic”，但它确实很好，因为我认为它不是Pythonic。

我会改为使用类的嵌套层次结构。这将更加清晰，IMO，并且还有使您能够进行类型检查的好处。

事实上，我可能会使用一些架构模块来做到这一点。

你应该如何输入这些数据？人们合理地不应该键入Python代码，对吗？

这是Pythonic API设计策略吗？

1 个答案: