看看头条

神级Python程序猿告诉你面向文档编程最正确的方法

概述

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

Python

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

用注释写单元测试:doctest

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

单元测试是代码开发环节必不可少的一环,对于Bug定位和代码质量而言是非常重要的。

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

举个例子:

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

这是一个求N的阶乘函数示例,在docstring 中通过 >>>符号来开始一个单元测试,然后换行输入预期结果即可。就是复制粘贴一下调试过程结果,超级简单,想实现TDD也因此变得很容易。

用注释写API文档:apidoc

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

完成机器学习模型后,提供对外服务的接口来贡献我们的算力时就要用到完整的API文档,通过API的调用才能为我们的模型源源不断的提供校验数据,对提升模型效果具有相当的意义。

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

而利用 apidoc 可以很好地解决这些API文档中常见的诸多问题.相当于通过模板提升了我们的接口设计的能力。

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

l例如:

这是一个API接口的定义方法,最核心的部分就是

  • 路由

  • GET/POST方法

  • 名称/分组

  • 参数与调用例子

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

咱可以直接撸个示例来学习怎么使用apidoc,先下载示例源码。

git clone https://github.com/apidoc/apidoc

cd apidoc

再来安装 apidoc 组件

sudo npm install apidoc -g

直接用官方代码制作一个例子,去访问就可以了。

apidoc -i example/ -o output/ -t template/

open output/index.html

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

apidoc的官方文档贼简单贼清晰,我就不过多强调语法了。

apidoc 提供了接口调试功能,在实际使用时要注意:

  • 我们需要一个web server 才可以使用这个接口调试的功能。

  • 要注意跨域的问题。

使用注释写命令行接口:docopt

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

例如:

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

在命令行中我们可以成功调用

fiannceR.py tcp 0.0.0.0 3838

arguments 会传出一个字典对象,以Key-Value的形式将命令行中的输入值捕获。

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

最后

真要从数据撸到模型、接口,那么一排注释的画面美的无法想象。

神级Python程序猿告诉你面向文档编程最正确的方法

人生苦短,我用Python

欢迎大家留言讨论,也可以加下我的群643692991给出更多应用案例,交流分享。

|\n|\r

赞 (0)
分享到:更多 ()