Most "pythonic" syntax to use for an API client library

Jonathan Leroy - Inikup jonathan at inikup.com
Sun Apr 28 14:58:40 EDT 2019


Hi all,

I'm writing a client library for a REST API. The API endpoints looks like this:
/customers
/customers/1
/customers/1/update
/customers/1/delete

Which of the following syntax do you expect an API client library to
use, and why?

1/
api.customers_list()
api.customers_info(1)
api.customers_update(1, name='Bob')
api.customers_delete(1)

2/
api.customers.list()
api.customers.info(1)
api.customers.update(1, name='Bob')
api.customers.delete(1)

3/
api.customers.list()
api.customers(1).info()
api.customers(1).update(name='Bob')
api.customers(1).delete()

...any other?

#3 seems to be more "pretty" to me, but I did not find any "official"
recommendation online.

Thanks.

--
Jonathan.


More information about the Python-list mailing list