Vega strike Python Modules doc: Helper Class Reference

All Data Structures Namespaces Files Functions Variables

Public Member Functions
def	__init__

def	__repr__

def	__call__

def	interact

def	help

def	intro

def	list

def	listkeywords

def	listtopics

def	showtopic

def	listmodules

Data Fields
	input

	output

	docdir

Static Public Attributes
dictionary	keywords

dictionary	topics

Detailed Description

Definition at line 1375 of file pydoc.py.

Constructor & Destructor Documentation

def __init__	(	self,
		input,
		output
	)

Definition at line 1486 of file pydoc.py.

 
     def __init__(self, input, output):
         self.input = input
         self.output = output
         self.docdir = None
         execdir = os.path.dirname(sys.executable)
         homedir = os.environ.get('PYTHONHOME')
         for dir in [os.environ.get('PYTHONDOCS'),
                     homedir and os.path.join(homedir, 'doc'),
                     os.path.join(execdir, 'doc'),
                     '/usr/doc/python-docs-' + split(sys.version)[0],
                     '/usr/doc/python-' + split(sys.version)[0],
                     '/usr/doc/python-docs-' + sys.version[:3],
                     '/usr/doc/python-' + sys.version[:3]]:
             if dir and os.path.isdir(os.path.join(dir, 'lib')):
                 self.docdir = dir

Member Function Documentation

def __call__	(	self,
		request = `None`
	)

Definition at line 1508 of file pydoc.py.

References NNTP.help(), Helper.help(), InteractiveConsole.interact(), Helper.interact(), Cmd.intro, and Helper.intro().

 
     def __call__(self, request=None):
         if request is not None:
             self.help(request)
         else:
             self.intro()
             self.interact()
             self.output.write('''
 You are now leaving help and returning to the Python interpreter.
 If you want to ask for help on a particular object directly from the
 interpreter, you can type "help(object)".  Executing "help('string')"
 has the same effect as typing a particular string at the help> prompt.
 ''')

def help	(	self,
		request
	)

Definition at line 1534 of file pydoc.py.

References pydoc.doc(), Cmd.intro, Helper.intro(), Helper.listkeywords(), Helper.listmodules(), Helper.listtopics(), Helper.showtopic(), and dospath.split().

 
     def help(self, request):
         if type(request) is type(''):
             if request == 'help': self.intro()
             elif request == 'keywords': self.listkeywords()
             elif request == 'topics': self.listtopics()
             elif request == 'modules': self.listmodules()
             elif request[:8] == 'modules ':
                 self.listmodules(split(request)[1])
             elif self.keywords.has_key(request): self.showtopic(request)
             elif self.topics.has_key(request): self.showtopic(request)
             elif request: doc(request, 'Help on %s:')
         elif isinstance(request, Helper): self()
         else: doc(request, 'Help on %s:')
         self.output.write('\n')

def interact ( self)

Definition at line 1521 of file pydoc.py.

References NNTP.help(), Helper.help(), string.lower(), pydoc.replace(), and string.strip().

 
     def interact(self):
         self.output.write('\n')
         while 1:
             self.output.write('help> ')
             self.output.flush()
             try:
                 request = self.input.readline()
                 if not request: break
             except KeyboardInterrupt: break
             request = strip(replace(request, '"', '', "'", ''))
             if lower(request) in ['q', 'quit']: break
             self.help(request)

def intro ( self)

Definition at line 1549 of file pydoc.py.

 
     def intro(self):
         self.output.write('''
 Welcome to Python %s!  This is the online help utility.
 
 If this is your first time using Python, you should definitely check out
 the tutorial on the Internet at http://www.python.org/doc/tut/.
 
 Enter the name of any module, keyword, or topic to get help on writing
 Python programs and using Python modules.  To quit this help utility and
 return to the interpreter, just type "quit".
 
 To get a list of available modules, keywords, or topics, type "modules",
 "keywords", or "topics".  Each module also comes with a one-line summary
 of what it does; to list the modules whose summaries contain a given word
 such as "spam", type "modules spam".
 ''' % sys.version[:3])

def list	(	self,
		items,
		columns = `4`,
		width = `80`
	)

Definition at line 1566 of file pydoc.py.

 
     def list(self, items, columns=4, width=80):
         items = items[:]
         items.sort()
         colw = width / columns
         rows = (len(items) + columns - 1) / columns
         for row in range(rows):
             for col in range(columns):
                 i = col * rows + row
                 if i < len(items):
                     self.output.write(items[i])
                     if col < columns - 1:
                         self.output.write(' ' + ' ' * (colw-1 - len(items[i])))
             self.output.write('\n')

def listkeywords ( self)

Definition at line 1580 of file pydoc.py.

References POP3.list(), fifo.list, NNTP.list(), MiniFieldStorage.list, FieldStorage.list, and Helper.list().

 
     def listkeywords(self):
         self.output.write('''
 Here is a list of the Python keywords.  Enter any keyword to get more help.
 
 ''')
         self.list(self.keywords.keys())

def listmodules	(	self,
		key = `''`
	)

Definition at line 1639 of file pydoc.py.

References pydoc.apropos(), pydoc.callback, gettext.find(), POP3.list(), fifo.list, NNTP.list(), MiniFieldStorage.list, FieldStorage.list, Helper.list(), and imaplib.run().

 
     def listmodules(self, key=''):
         if key:
             self.output.write('''
 Here is a list of matching modules.  Enter any module name to get more help.
 
 ''')
             apropos(key)
         else:
             self.output.write('''
 Please wait a moment while I gather a list of all available modules...
 
 ''')
             modules = {}
             def callback(path, modname, desc, modules=modules):
                 if modname and modname[-9:] == '.__init__':
                     modname = modname[:-9] + ' (package)'
                 if find(modname, '.') < 0:
                     modules[modname] = 1
             ModuleScanner().run(callback)
             self.list(modules.keys())
             self.output.write('''
 Enter any module name to get more help.  Or, type "modules spam" to search
 for modules whose descriptions contain the word "spam".
 ''')

def listtopics ( self)

Definition at line 1587 of file pydoc.py.

References POP3.list(), fifo.list, NNTP.list(), MiniFieldStorage.list, FieldStorage.list, and Helper.list().

 
     def listtopics(self):
         self.output.write('''
 Here is a list of available topics.  Enter any topic name to get more help.
 
 ''')
         self.list(self.topics.keys())

def showtopic	(	self,
		topic
	)

Definition at line 1594 of file pydoc.py.

References Helper.docdir, dospath.join(), aifc.open(), pydoc.pager(), pydoc.replace(), Helper.showtopic(), dospath.split(), and string.strip().

 
     def showtopic(self, topic):
         if not self.docdir:
             self.output.write('''
 Sorry, topic and keyword documentation is not available because the Python
 HTML documentation files could not be found.  If you have installed them,
 please set the environment variable PYTHONDOCS to indicate their location.
 ''')
             return
         target = self.topics.get(topic, self.keywords.get(topic))
         if not target:
             self.output.write('no documentation found for %s\n' % repr(topic))
             return
         if type(target) is type(''):
             return self.showtopic(target)
 
         filename, xrefs = target
         filename = self.docdir + '/' + filename + '.html'
         try:
             file = open(filename)
         except:
             self.output.write('could not read docs from %s\n' % filename)
             return
 
         divpat = re.compile('<div[^>]*navigat.*?</div.*?>', re.I | re.S)
         addrpat = re.compile('<address.*?>.*?</address.*?>', re.I | re.S)
         document = re.sub(addrpat, '', re.sub(divpat, '', file.read()))
         file.close()
 
         import htmllib, formatter, StringIO
         buffer = StringIO.StringIO()
         parser = htmllib.HTMLParser(
             formatter.AbstractFormatter(formatter.DumbWriter(buffer)))
         parser.start_table = parser.do_p
         parser.end_table = lambda parser=parser: parser.do_p({})
         parser.start_tr = parser.do_br
         parser.start_td = parser.start_th = lambda a, b=buffer: b.write('\t')
         parser.feed(document)
         buffer = replace(buffer.getvalue(), '\xa0', ' ', '\n', '\n  ')
         pager('  ' + strip(buffer) + '\n')
         if xrefs:
             buffer = StringIO.StringIO()
             formatter.DumbWriter(buffer).send_flowing_data(
                 'Related help topics: ' + join(split(xrefs), ', ') + '\n')
             self.output.write('\n%s\n' % buffer.getvalue())

Field Documentation

dictionary keywords

static

Initial value:

 = {
         'and': 'BOOLEAN',
         'assert': ('ref/assert', ''),
         'break': ('ref/break', 'while for'),
         'class': ('ref/class', 'CLASSES SPECIALMETHODS'),
         'continue': ('ref/continue', 'while for'),
         'def': ('ref/function', ''),
         'del': ('ref/del', 'BASICMETHODS'),
         'elif': 'if',
         'else': ('ref/if', 'while for'),
         'except': 'try',
         'exec': ('ref/exec', ''),
         'finally': 'try',
         'for': ('ref/for', 'break continue while'),
         'from': 'import',
         'global': ('ref/global', 'NAMESPACES'),
         'if': ('ref/if', 'TRUTHVALUE'),
         'import': ('ref/import', 'MODULES'),
         'in': ('ref/comparisons', 'SEQUENCEMETHODS2'),
         'is': 'COMPARISON',
         'lambda': ('ref/lambda', 'FUNCTIONS'),
         'not': 'BOOLEAN',
         'or': 'BOOLEAN',
         'pass': 'PASS',
         'print': ('ref/print', ''),
         'raise': ('ref/raise', 'EXCEPTIONS'),
         'return': ('ref/return', 'FUNCTIONS'),
         'try': ('ref/try', 'EXCEPTIONS'),
         'while': ('ref/while', 'break continue if TRUTHVALUE'),
     }

Definition at line 1376 of file pydoc.py.

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation