读取代码并返回可用于生成文档的JSON描述。像狮身人面像汽车医生,但没有狮身人面像。

inspect-it的Python项目详细描述


inspect.

在记录用python编写的库或软件产品时,通常
一个自述文件是不够的,但是完整的sphinx是太多的工作或太过严格。


inspect是一个命令行工具,它将自动记录python的代码,但它将输出作为机器可读的json或人类可读的标记返回,因此,您可以完全控制如何呈现
文档。

--include…
--exclude…

raw::html

<;object>;

一些
示例:

::

fixtures/example.py—包含名称:fun,名称:b
仅包含bean上的文档化方法
(这两个相同)
检查fixtures/example.py bean—包含文档化的
检查fixtures/example.py—包含名称:bean,members.documented

``.``遍历层次结构,`:``是要对其进行
测试的值。(如果您不指定值,我们将测试是否存在。)

`,``将多个条件分隔在一起。

todo:

-改进文档
-单元测试过滤机制
-在描述json(如果有的话)中填写缺少的信息
-一个“intercalate”实用程序,在文件的“`%`
标记中运行shell命令,并用这些命令的标准输出

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java@AfterEach注释在Spring测试中被忽略   散列如何使用bouncy castle在Java中创建SHA512摘要字符串?   java无法使用Okhttp获取响应cookie   100个数的java阶乘   多线程如何在Java中实现对象计数器   java我的精灵不显示背景   java如何在com上应用PanelSlideListener。索特里。滑动面板。SlidengUpPanelLayout SlideUp库   java如何在JDBC中使用WHERE EXISTS函数   java Swing:标签前景中的白色被绘制为黑色   获取java的时间戳。util。另一个java的日期对象为(10/7/14)。util。日期对象(2014年10月7日星期二11:21:00)   java如何在Spring/OpenJPA 1中重新创建用于更新行锁定的选择   java在保存另一个maven项目中的类时,有没有办法让eclipse识别对该类的更改?   java如何解决Spring中的Servlet上下文错误?   java在mongodb中删除记录   显示的java片段与当前片段重叠,而不是替换它