blocks|key|1448137|text|如果你真的帮助(Help)，你会看到：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1448138|Help+on+_Helper+in+module+site+object:

class+_Helper(__builtin__.object)
+%7C++Define+the+builtin+'help'.
+%7C++This+is+a+wrapper+around+pydoc.help+(with+a+twist).|code-block|syntax|javascript|1448139|rest被剪掉|1448140|所以-你应该看看pydoc模块-将有一个或多个方法将help(something)作为字符串返回……|offset|length|style|CODE|1448141|entityMap^0|0|0|0|Q|F|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|R|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|S|8|@]|9|@]|A|$]]|$1|I|3|J|5|6|7|T|8|@$K|U|L|V|M|N]]|9|@]|A|$]]|$1|O|3|-4|5|6|7|W|8|@]|9|@]|A|$]]]|P|$]]

If you do help(help) you'll see:

<pre><code>Help on _Helper in module site object:

class _Helper(__builtin__.object)
 | Define the builtin 'help'.
 | This is a wrapper around pydoc.help (with a twist).
</code></pre>

[rest snipped]

So - you should be looking at the pydoc module - there's going to be a method or methods that return what <code>help(something)</code> does as a string...

blocks|key|1448178|text|这有点老生常谈(而且可能有更好的解决方案)，但这是有效的：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1448179|import+sys
import+pydoc

def+output_help_to_file(filepath,+request):
++++f+=+open(filepath,+'w')
++++sys.stdout+=+f
++++pydoc.help(request)
++++f.close()
++++sys.stdout+=+sys.__stdout__
++++return|code-block|syntax|javascript|1448180|然后..。|1448181|>>>+output_help_to_file(r'test.txt',+'re')|1448182|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|N|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|O|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|P|8|@]|9|@]|A|$E|F]]|$1|K|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]]|L|$]]

This is a bit hackish (and there's probably a better solution somewhere), but this works:

<pre><code>import sys
import pydoc

def output_help_to_file(filepath, request):
 f = open(filepath, 'w')
 sys.stdout = f
 pydoc.help(request)
 f.close()
 sys.stdout = sys.__stdout__
 return
</code></pre>

And then...

<pre><code>&gt;&gt;&gt; output_help_to_file(r'test.txt', 're')
</code></pre>

blocks|key|3173247|text|pydoc.render_doc(thing)以字符串形式获取thing的帮助文本。pydoc的其他部分，如pydoc.text和pydoc.html，可以帮助您将其写入文件。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3173248|在linux中使用-w修饰符将把输出写到当前目录中的html，例如；|offset|length|style|CODE|3173249|pydoc+-w+Rpi.GPIO|code-block|syntax|javascript|3173250|将命令help(Rpi.GPIO)显示的所有help()文本放入一个格式良好的文件Rpi.GPIO.html中，该文件位于外壳程序的当前目录中|3173251|entityMap^0|0|9|2|0|0|3|E|M|6|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|R|8|@$D|S|E|T|F|G]]|9|@]|A|$]]|$1|H|3|I|5|J|7|U|8|@]|9|@]|A|$K|L]]|$1|M|3|N|5|6|7|V|8|@$D|W|E|X|F|G]|$D|Y|E|Z|F|G]]|9|@]|A|$]]|$1|O|3|-4|5|6|7|10|8|@]|9|@]|A|$]]]|P|$]]

pydoc.render_doc(thing) to get thing's help text as a string. Other parts of pydoc like pydoc.text and pydoc.html can help you write it to a file.

Using the <code>-w</code> modifier in linux will write the output to a html in the current directory, for example;

<pre><code>pydoc -w Rpi.GPIO
</code></pre>

Puts all the <code>help()</code> text that would be presented from the command <code>help(Rpi.GPIO)</code> into a nicely formatted file Rpi.GPIO.html, in the current directory of the shell

blocks|key|3173287|text|在Windows中，只需打开Windows命令行窗口，转到Python安装的Lib子文件夹，然后输入|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3173288|python+pydoc.py+moduleName.memberName+>+c:\myFolder\memberName.txt|3173289|将moduleName中的属性或方法memberName的文档放入文件memberName.txt。如果你想要一个对象在模块的层次结构中往下走，只需要放更多的点。例如|3173290|python+pydoc.py+wx.lib.agw.ultimatelistctrl+>+c:\myFolder\UltimateListCtrl.txt|3173291|将wxPython包中agw包中有关UltimateListCtrl控件的文档放入UltimateListCtrl.txt。|3173292|entityMap^0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|M|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|N|8|@]|9|@]|A|$]]|$1|F|3|G|5|6|7|O|8|@]|9|@]|A|$]]|$1|H|3|I|5|6|7|P|8|@]|9|@]|A|$]]|$1|J|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]]|K|$]]

In Windows, just open up a Windows Command Line window, go to the Lib subfolder of your Python installation, and type

python pydoc.py moduleName.memberName > c:\myFolder\memberName.txt

to put the documentation for the property or method memberName in moduleName into the file memberName.txt. If you want an object further down the hierarchy of the module, just put more dots. For example

python pydoc.py wx.lib.agw.ultimatelistctrl > c:\myFolder\UltimateListCtrl.txt

to put the documentation on the UltimateListCtrl control in the agw package in the wxPython package into UltimateListCtrl.txt.

blocks|key|1448295|text|pydoc已经提供了所需的功能，这是所有问答系统都应该具有的一个设计得非常好的功能。pydoc.Helper.init有一个output对象，所有输出都被发送到那里。如果你使用你自己的输出对象，你可以做任何你想做的事情。例如：|type|unstyled|depth|inlineStyleRanges|offset|length|style|BOLD|entityRanges|data|1448296|class+OUTPUT()：|1448297|def+__init__(self):
++++self.results+=+[]
def+write(self,text):
++++self.results+%2B=+[text]
def+flush(self):
++++pass
def+print_(self):
++++for+x+in+self.results:+print(x)
def+return_(self):
++++return+self.results
def+clear_(self):
++++self.results+=+[]|code-block|syntax|javascript|1448298|当作为|1448299|O=+OUTPUT()+#必须记住结果，但请参见下面的内容。|1448300|帮助=+pydoc.Helper(O)|1448301|将所有结果存储在输出实例中。当然，以O=+OUTPUT()开头并不是最好的想法(见下文)。render_doc不是中心输出点；输出是。我想要输出，这样我就可以使用Mark+Lutz的"More“这样的东西来防止大输出从屏幕上消失。不同的输出将允许您写入文件。|1448302|您还可以在类pydoc.Helper的末尾添加一个"+return“，以返回所需的信息。类似于：|1448303|如果为self.output_：返回self.output_|1448304|应该起作用，或者|1448305|if+self.output_：返回self.output.return_()|1448306|所有这一切都是可能的，因为pydoc设计得很好。它之所以被隐藏，是因为help的定义省略了输入和输出参数。|1448307|entityMap^0|1J|4|0|0|0|0|0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|16|8|@$9|17|A|18|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|19|8|@]|D|@]|E|$]]|$1|H|3|I|5|J|7|1A|8|@]|D|@]|E|$K|L]]|$1|M|3|N|5|6|7|1B|8|@]|D|@]|E|$]]|$1|O|3|P|5|6|7|1C|8|@]|D|@]|E|$]]|$1|Q|3|R|5|6|7|1D|8|@]|D|@]|E|$]]|$1|S|3|T|5|6|7|1E|8|@]|D|@]|E|$]]|$1|U|3|V|5|6|7|1F|8|@]|D|@]|E|$]]|$1|W|3|X|5|6|7|1G|8|@]|D|@]|E|$]]|$1|Y|3|Z|5|6|7|1H|8|@]|D|@]|E|$]]|$1|10|3|11|5|6|7|1I|8|@]|D|@]|E|$]]|$1|12|3|13|5|6|7|1J|8|@]|D|@]|E|$]]|$1|14|3|-4|5|6|7|1K|8|@]|D|@]|E|$]]]|15|$]]

pydoc already provides the needed feature, a very well-designed feature that all question-answering systems should have. The pydoc.Helper.init has an output object, all output being sent there. If you use your own output object, you can do whatever you want. For example:

class OUTPUT():

<pre><code>def __init__(self):
 self.results = []
def write(self,text):
 self.results += [text]
def flush(self):
 pass
def print_(self):
 for x in self.results: print(x)
def return_(self):
 return self.results
def clear_(self):
 self.results = []
</code></pre>

when passed as 

O = OUTPUT() # Necessarily to remember results, but see below.

help = pydoc.Helper(O)

will store all results in the OUTPUT instance. Of course, beginning with O = OUTPUT() is not the best idea (see below). render_doc is not the central output point; output is. I wanted OUTPUT so I could keep large outputs from disappearing from the screen using something like Mark Lutz' "More". A different OUTPUT would allow you to write to files.

You could also add a "return" to the end of the class pydoc.Helper to return the information you want. Something like:

if self.output_: return self.output_

should work, or

if self.output_: return self.output.return_()

All of this is possible because pydoc is well-designed. It is hidden because the definition of help leaves out the input and output arguments.

blocks|key|3173364|text|这是一个老问题，但较新的recommended通用解决方案(针对Python+3.4%2B)用于编写print()到终端使用contextlib.redirect_stdout的函数的输出|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|3173365|import+contextlib

def+write_help(func,+out_file):
++++with+open(out_file,+'w')+as+f:
++++++++with+contextlib.redirect_stdout(f):
++++++++++++help(func)|code-block|syntax|javascript|3173366|使用示例：|3173367|write_help(int,+'test.txt')|3173368|entityMap|0|LINK|mutability|MUTABLE|url|https://twitter.com/raymondh/status/1030160198600548352^0|1C|7|1O|Q|C|B|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|W|8|@$9|X|A|Y|B|C]|$9|Z|A|10|B|C]]|D|@$9|11|A|12|1|13]]|E|$]]|$1|F|3|G|5|H|7|14|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|15|8|@]|D|@]|E|$]]|$1|M|3|N|5|H|7|16|8|@]|D|@]|E|$I|J]]|$1|O|3|-4|5|6|7|17|8|@]|D|@]|E|$]]]|P|$Q|$5|R|S|T|E|$U|V]]]]

An old question but the newer <a href="https://twitter.com/raymondh/status/1030160198600548352" rel="noreferrer">recommended</a> generic solution (for Python 3.4+) for writing the output of functions that <code>print()</code> to terminal is using <code>contextlib.redirect_stdout</code>:

<pre><code>import contextlib

def write_help(func, out_file):
 with open(out_file, 'w') as f:
 with contextlib.redirect_stdout(f):
 help(func)
</code></pre>

Usage example:

<pre><code>write_help(int, 'test.txt')
</code></pre>

blocks|key|3173402|text|选择的答案对我不起作用，所以我做了更多的搜索，找到了一些在Daniweb上有效的东西。功劳归功于素食。https://www.daniweb.com/programming/software-development/threads/20774/starting-python/8#post1306519|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|3173403|#+simplified+version+of+sending+help()+output+to+a+file
import+sys
#+save+present+stdout
out+=+sys.stdout
fname+=+"help_print7.txt"
#+set+stdout+to+file+handle
sys.stdout+=+open(fname,+"w")
#+run+your+help+code
#+its+console+output+goes+to+the+file+now
help("print")
sys.stdout.close()
#+reset+stdout
sys.stdout+=+out|code-block|syntax|javascript|3173404|entityMap|0|LINK|mutability|MUTABLE|url|https://www.daniweb.com/programming/software-development/threads/20774/starting-python/8#post1306519^0|1F|2S|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@$A|R|B|S|1|T]]|C|$]]|$1|D|3|E|5|F|7|U|8|@]|9|@]|C|$G|H]]|$1|I|3|-4|5|6|7|V|8|@]|9|@]|C|$]]]|J|$K|$5|L|M|N|C|$O|P]]]]

Selected answer didn't work for me, so I did a little more searching and found something that worked on Daniweb. Credit goes to vegaseat. <a href="https://www.daniweb.com/programming/software-development/threads/20774/starting-python/8#post1306519" rel="nofollow noreferrer">https://www.daniweb.com/programming/software-development/threads/20774/starting-python/8#post1306519</a>

<pre><code># simplified version of sending help() output to a file
import sys
# save present stdout
out = sys.stdout
fname = "help_print7.txt"
# set stdout to file handle
sys.stdout = open(fname, "w")
# run your help code
# its console output goes to the file now
help("print")
sys.stdout.close()
# reset stdout
sys.stdout = out
</code></pre>

blocks|key|1776785|text|实现这一点的最简单方法是使用|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1776786|1776787|系统模块|blockquote|1776788|1776789|1776790|它在操作系统和自身之间打开一个数据流，从帮助模块中抓取数据并保存到外部文件中|1776791|file="str.txt";file1="list.txt"
out=sys.stdout
sys.stdout=open('str_document','w')
help(str)
sys.stdout.close|code-block|syntax|javascript|1776792|entityMap^0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|R|8|@]|9|@]|A|$]]|$1|C|3|D|5|E|7|S|8|@]|9|@]|A|$]]|$1|F|3|-4|5|6|7|T|8|@]|9|@]|A|$]]|$1|G|3|-4|5|6|7|U|8|@]|9|@]|A|$]]|$1|H|3|I|5|6|7|V|8|@]|9|@]|A|$]]|$1|J|3|K|5|L|7|W|8|@]|9|@]|A|$M|N]]|$1|O|3|-4|5|6|7|X|8|@]|9|@]|A|$]]]|P|$]]

The simplest way to do that is via using 

<blockquote>
 sys module
</blockquote>

it opens a data stream between the operation system and it's self , it grab the data from the help module then save it in external file 

<pre><code>file="str.txt";file1="list.txt"
out=sys.stdout
sys.stdout=open('str_document','w')
help(str)
sys.stdout.close
</code></pre>

blocks|key|3084936|text|要获得“干净”的文本输出，就像内置的help()所提供的那样，并且适合导出到文件或其他任何文件，您可以使用以下命令：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3084937|>>>+import+pydoc
>>>+pydoc.render_doc(len,+renderer=pydoc.plaintext)
'Python+Library+Documentation:+built-in+function+len+in+module+builtins\n\nlen(obj,+/)\n++++Return+the+number+of+items+in+a+container.\n'|code-block|syntax|javascript|3084938|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

To get a "clean" text output, just as the built-in help() would deliver, and suitable for exporting to a file or anything else, you can use the following:

<pre class="lang-py prettyprint-override"><code>&gt;&gt;&gt; import pydoc
&gt;&gt;&gt; pydoc.render_doc(len, renderer=pydoc.plaintext)
'Python Library Documentation: built-in function len in module builtins\n\nlen(obj, /)\n Return the number of items in a container.\n'
</code></pre>

blocks|key|1777408|text|最干净的方式|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1777409|假设help(os)|offset|length|style|CODE|1777410|第1步-在Python控制台中|1777411|+import+pydoc+
+pydoc.render_doc(os,+renderer=pydoc.plaintext)`+
+
+#this+will+display+a+string+containing+help(os)+output+|code-block|syntax|javascript|1777412|第2步-复制字符串|1777413|第3步-在终端上|1777414|echo+"copied+string"+%7C+tee+somefile.txt+|1777415|如果要在文本文件中写入类信息。请按照以下步骤操作|1777416|1777417|在类和运行文件中的某个位置插入pdb钩子|ordered-list-item|1777418|1777419|导入pdb；pdb.set_trace()|1777420|1777421|执行上述步骤1至3|1777422|1777423|entityMap^0|0|2|8|0|0|0|0|0|0|0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|19|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|1A|8|@$D|1B|E|1C|F|G]]|9|@]|A|$]]|$1|H|3|I|5|6|7|1D|8|@]|9|@]|A|$]]|$1|J|3|K|5|L|7|1E|8|@]|9|@]|A|$M|N]]|$1|O|3|P|5|6|7|1F|8|@]|9|@]|A|$]]|$1|Q|3|R|5|6|7|1G|8|@]|9|@]|A|$]]|$1|S|3|T|5|L|7|1H|8|@]|9|@]|A|$M|N]]|$1|U|3|V|5|6|7|1I|8|@]|9|@]|A|$]]|$1|W|3|-4|5|6|7|1J|8|@]|9|@]|A|$]]|$1|X|3|Y|5|Z|7|1K|8|@]|9|@]|A|$]]|$1|10|3|-4|5|6|7|1L|8|@]|9|@]|A|$]]|$1|11|3|12|5|6|7|1M|8|@]|9|@]|A|$]]|$1|13|3|-4|5|6|7|1N|8|@]|9|@]|A|$]]|$1|14|3|15|5|Z|7|1O|8|@]|9|@]|A|$]]|$1|16|3|-4|5|6|7|1P|8|@]|9|@]|A|$]]|$1|17|3|-4|5|6|7|1Q|8|@]|9|@]|A|$]]]|18|$]]

The cleanest way
Assuming <code>help(os)</code>
Step 1 - In Python Console
<pre><code> import pydoc 
 pydoc.render_doc(os, renderer=pydoc.plaintext)` 
 
 #this will display a string containing help(os) output 
</code></pre>
Step 2 - Copy string
Step 3 - On a Terminal
<pre><code>echo &quot;copied string&quot; | tee somefile.txt 
</code></pre>
If you want to write Class information in a text file. Follow below steps
<ol>
<li>Insert pdb hook somewhere in the Class and run file
import pdb; pdb.set_trace()
</li>
<li>Perform step 1 to 3 stated above
</li>
</ol>

I've got a python package which outputs considerable help text from: <code>help(package)</code> 

I would like to export this help text to a file, in the format in which it's displayed by <code>help(package)</code>

How might I go about this?

How do I export the output of Python's built-in help() function

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋 

腾讯云代码助手

CODING DevOps

Cloud Studio

SDK中心

API中心

命令行工具

我有一个python包，它输出了相当多的帮助文本：help(package)我想以help(package)显示的格式将此帮助文本导出到文件中我该怎么做呢？

问如何导出Python内置help()函数的输出
EN

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何导出Python内置help()函数的输出EN