Это стратегия разработки Pythonic API? - PullRequest
3 голосов
/ 07 декабря 2010

Вот прелюдия к вопросу, который я задаю: я приступил к созданию независимого платежного API в Python для моей компании.На данный момент я написал только код для поддержки Authorize.net и хотел получить отзывы о ясности моего дизайна API от программистов на Python с немного большим опытом, чем я.

Я решил свернуть свой собственный, потому чтодругие существующие пакеты больше похожи на запоздалые или специфичные для Authorize.net (я хочу написать более общий пакет с более понятным интерфейсом).В частности, я получил некоторое вдохновение от пакета ( pythorize ), но мне не понравился его API.

Прежде чем я начну описывать, что я делаю, вот ссылка на публичный репозиторий на bitbucketпакет: paypy (обратите внимание на тех, кто, возможно, захочет его использовать: код стабилен, но документов крайне не хватает).

Моя текущая стратегия использует вложенный словарь и передает егоконструктору класса метода оплаты.Пример создания нового профиля пользователя в CIM API Authorize.net:

>>> 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), интерфейсы имеют тенденцию кбыть немного грязным и не стандартизированным в любом случае, поэтому трудно избежать некоторых параметров, зависящих от шлюза.

1 Ответ

2 голосов
/ 08 декабря 2010

Глубоко вложенные словари не могут быть необычными в Python, и, возможно, они тогда являются "Pythonic", но, черт побери, это не очень хорошая идея, поэтому я бы сказал, что это не Pythonic.

Вместо этого я бы создал вложенную иерархию классов. Это будет намного понятнее, IMO, а также даст вам возможность сделать проверку типов.

На самом деле, я бы, вероятно, использовал для этого какой-нибудь модуль схемы.

И как вы должны вводить эти данные? Люди не должны вводить код на Python, верно?

...