pydoc可以生成子目录吗?

时间:2009-07-30 19:58:51

标签: python pydoc

有没有办法让pydoc的writedocs()函数为包创建子目录?例如,假设我有以下模块要记录:

foo.py
dir/bar.py
dir/__init__.py

当我运行pydoc.writedocs()时,我得到以下文件:

foo.html
dir.bar.html

我想得到:

foo.html
dir/bar.html

有没有办法做到这一点?

1 个答案:

答案 0 :(得分:1)

pydoc.writedocs只是循环调用writedoc,它被记录(并实现)为“在当前目录中写入文件”。我能看到的唯一出路是通过制作一个修改后的版本并强制它(即叹气,monkeypatching它)到模块中,或者monkeypatching它的一些关键方面,即打开'open'打开HTML文件的问题。打开。具体来说,在您的代码中,您可以执行以下操作:

import pydoc

def monkey_open(name, option):
  if option == 'w' and name.endswith('.html'):
    name_pieces = name.split('.')
    name_pieces[-2:] = '.'.join(name_pieces[-2:])
    name = '/'.join(name_pieces)
  return open(name, option)

pydoc.open = monkey_open

不是一个优雅或极其强大的解决方案,但“需要必须”...... pydoc只是不是为了让你做你想做的事情而设计的,所以这个东西需要被“套牢”。