[Python-checkins] r68266 - in python/branches/release30-maint: Lib/pydoc.py Misc/NEWS

Sun Jan 4 00:53:44 CET 2009

Author: georg.brandl
Date: Sun Jan 4 00:53:44 2009
New Revision: 68266
Log:
Merged revisions 68137 via svnmerge from 
svn+ssh://svn.python.org/python/branches/py3k
................
 r68137 | georg.brandl | 2009年01月01日 16:53:14 +0100 (2009年1月01日) | 10 lines
 
 Merged revisions 67953 via svnmerge from 
 svn+ssh://pythondev@svn.python.org/python/trunk
 
 ........
 r67953 | georg.brandl | 2008年12月27日 19:20:04 +0100 (2008年12月27日) | 3 lines
 
 Patch #4739 by David Laban: add symbols to pydoc help topics,
 so that ``help('@')`` works as expected.
 ........
................
Modified:
 python/branches/release30-maint/ (props changed)
 python/branches/release30-maint/Lib/pydoc.py
 python/branches/release30-maint/Misc/NEWS
Modified: python/branches/release30-maint/Lib/pydoc.py
==============================================================================

--- python/branches/release30-maint/Lib/pydoc.py	(original)
+++ python/branches/release30-maint/Lib/pydoc.py	Sun Jan 4 00:53:44 2009
@@ -1568,6 +1568,42 @@
 'with': ('with', 'CONTEXTMANAGERS EXCEPTIONS yield'),
 'yield': ('yield', ''),
 }
+ # Either add symbols to this dictionary or to the symbols dictionary
+ # directly: Whichever is easier. They are merged later.
+ _symbols_inverse = {
+ 'STRINGS' : ("'", "'''", "r'", "b'", '"""', '"', 'r"', 'b"'),
+ 'OPERATORS' : ('+', '-', '*', '**', '/', '//', '%', '<<', '>>', '&',
+ '|', '^', '~', '<', '>', '<=', '>=', '==', '!=', '<>'),
+ 'COMPARISON' : ('<', '>', '<=', '>=', '==', '!=', '<>'),
+ 'UNARY' : ('-', '~'),
+ 'AUGMENTEDASSIGNMENT' : ('+=', '-=', '*=', '/=', '%=', '&=', '|=',
+ '^=', '<<=', '>>=', '**=', '//='),
+ 'BITWISE' : ('<<', '>>', '&', '|', '^', '~'),
+ 'COMPLEX' : ('j', 'J')
+ }
+ symbols = {
+ '%': 'OPERATORS FORMATTING',
+ '**': 'POWER',
+ ',': 'TUPLES LISTS FUNCTIONS',
+ '.': 'ATTRIBUTES FLOAT MODULES OBJECTS',
+ '...': 'ELLIPSIS',
+ ':': 'SLICINGS DICTIONARYLITERALS',
+ '@': 'def class',
+ '\\': 'STRINGS',
+ '_': 'PRIVATENAMES',
+ '__': 'PRIVATENAMES SPECIALMETHODS',
+ '`': 'BACKQUOTES',
+ '(': 'TUPLES FUNCTIONS CALLS',
+ ')': 'TUPLES FUNCTIONS CALLS',
+ '[': 'LISTS SUBSCRIPTS SLICINGS',
+ ']': 'LISTS SUBSCRIPTS SLICINGS'
+ }
+ for topic, symbols_ in _symbols_inverse.items():
+ for symbol in symbols_:
+ topics = symbols.get(symbol, topic)
+ if topic not in topics:
+ topics = topics + ' ' + topic
+ symbols[symbol] = topics
 
 topics = {
 'TYPES': ('types', 'STRINGS UNICODE NUMBERS SEQUENCES MAPPINGS '
@@ -1705,10 +1741,12 @@
 if type(request) is type(''):
 if request == 'help': self.intro()
 elif request == 'keywords': self.listkeywords()
+ elif request == 'symbols': self.listsymbols()
 elif request == 'topics': self.listtopics()
 elif request == 'modules': self.listmodules()
 elif request[:8] == 'modules ':
 self.listmodules(request.split()[1])
+ elif request in self.symbols: self.showsymbol(request)
 elif request in self.keywords: self.showtopic(request)
 elif request in self.topics: self.showtopic(request)
 elif request: doc(request, 'Help on %s:')
@@ -1753,6 +1791,14 @@
 ''')
 self.list(self.keywords.keys())
 
+ def listsymbols(self):
+ self.output.write('''
+Here is a list of the punctuation symbols which Python assigns special meaning
+to. Enter any symbol to get more help.
+
+''')
+ self.list(self.symbols.keys())
+
 def listtopics(self):
 self.output.write('''
 Here is a list of available topics. Enter any topic name to get more help.
@@ -1760,7 +1806,7 @@
 ''')
 self.list(self.topics.keys())
 
- def showtopic(self, topic):
+ def showtopic(self, topic, more_xrefs=''):
 try:
 import pydoc_topics
 except ImportError:
@@ -1774,7 +1820,7 @@
 self.output.write('no documentation found for %s\n' % repr(topic))
 return
 if type(target) is type(''):
- return self.showtopic(target)
+ return self.showtopic(target, more_xrefs)
 
 label, xrefs = target
 try:
@@ -1783,6 +1829,8 @@
 self.output.write('no documentation found for %s\n' % repr(topic))
 return
 pager(doc.strip() + '\n')
+ if more_xrefs:
+ xrefs = (xrefs or '') + ' ' + more_xrefs
 if xrefs:
 import io, formatter
 buffer = io.StringIO()
@@ -1790,6 +1838,11 @@
 'Related help topics: ' + ', '.join(xrefs.split()) + '\n')
 self.output.write('\n%s\n' % buffer.getvalue())
 
+ def showsymbol(self, symbol):
+ target = self.symbols[symbol]
+ topic, _, xrefs = target.partition(' ')
+ self.showtopic(topic, xrefs)
+
 def listmodules(self, key=''):
 if key:
 self.output.write('''
Modified: python/branches/release30-maint/Misc/NEWS
==============================================================================
--- python/branches/release30-maint/Misc/NEWS	(original)
+++ python/branches/release30-maint/Misc/NEWS	Sun Jan 4 00:53:44 2009
@@ -87,6 +87,9 @@
 
 - Issue #3248: Allow placing ScrolledText in a PanedWindow.
 
+- Issue #4739: Add pydoc help topics for symbols, so that e.g. help('@')
+ works as expected in the interactive environment.
+
 - Issue #4574: reading an UTF16-encoded text file crashes if \r on 64-char
 boundary.
 
