Most "pythonic" syntax to use for an API client library
tjol at tjol.eu
Mon Apr 29 04:54:10 EDT 2019
On 29/04/2019 09.18, Peter Otten wrote:
> Jonathan Leroy - Inikup via Python-list wrote:
>> Hi all,
>> I'm writing a client library for a REST API. The API endpoints looks like
>> this: /customers
>> Which of the following syntax do you expect an API client library to
>> use, and why?
>> api.customers_update(1, name='Bob')
>> api.customers.update(1, name='Bob')
>> ...any other?
> How about mimicking (to some extent) an existing interface, like a list,
> dict, or set:
> customers = api.customers
> list(customers) # __iter__
> alice = customers # __getitem__
> print(alice) # __str__
This was my first thought seeing the third option as well, but...
> alice.name = "Bob" # __setattr__
> del customers # __delitem__
do you want this sort of thing to update the upstream database directly?
Maybe there should be a commit() method on every object. Maybe not.
I imagine it would be best if the data is cached locally (i.e. alice =
customers does a query, print(alice.name) does not). In this case you
probably want the local/database separation to be consistent for both
getting and setting things.
> del customers[alice]
Are you sure about this?
>> #3 seems to be more "pretty" to me, but I did not find any "official"
>> recommendation online.
I'd like #3 if it had square brackets after .customers. Of the
suggestions as they are I prefer #2.
More information about the Python-list