Python 函数库 APIs 编写指南

来源:Python程序员ID:pythonbuluo本篇文章基于 2017 PyCon 大会上的演讲：How to make a good library API。列出对于构建 Python 库 API 有用的建议清单。简洁性 在 README 文件中写入简单的客户端代码。例如：Pendulum 的 README 文件就是以简单的用户代码开始的。减少冗余的代码：数一数从第一行开始到你真正调用 API 函数的行数。例如：与 Request 库相比，进行 HTTP 请求时 urllib2 库就很多的冗余代码。使用案例例如：这个网页展示的内容：https://python-social-auth-docs.readthedocs.io/en/latest/use_cases.html在实践中逐步完善：实用且明智的缺省值设置       - 具有缺省设置，并根据最常用的使用情况来设置缺省值。       - 设置参数位置，将最常用的参数放在前面，将相似的放在一起。例如：JavaScript ………………………………