生成文档源代码变体的实用程序
pear-cli的Python项目详细描述
梨
A utility for generating variations source code for docmentation.
在文档中,您可能希望显示文件随时间的增长情况。但是,如果您只想保留源代码的一个副本。考虑以下文件:
classFoo:def__init__(self,name):self.name=namedefreverse_name(self):returnself.name.reverse()
如果我们可以增量地构建文件,我们可以先写构造函数,然后再写reverse_name
。这意味着我们需要两个版本的文件:
classFoo:# constructordefreverse_name(self):returnself.name.reverse()
使用pear
你可以使用它。在
使用
在根目录中包含一个pear.json
文件以及必要的配置。对于上面的例子,我们可以:
{"out":"out","files":[{"path":"foo.py","tag":"without_reverse_name","layers":[{"type":"remove","start":4,"end":6}]},{"path":"foo.py","tag":"constructor_comment","layers":[{"type":"replace","start":2,"end":3,"replacement":[" # constructor"]}]}]}
然后从同一目录调用pear
。这将在out/
中生成foo.py_without_reverse_name
和{
- 项目
标签: