Commit Graph

162 Commits

Author SHA1 Message Date
R David Murray 875565bbd6 #1065986: add missing error handler in pydoc unicode fix. 2014-01-05 17:14:08 -05:00
R David Murray 984f630f0a #1065986: Make pydoc handle unicode strings.
Patch by Akira Kitada.
2014-01-05 12:35:59 -05:00
R David Murray c313b1d9b0 #14638: pydoc now treats non-str __name__ as None instead of raising
Original patch by Peter Otten.
2012-04-23 13:27:11 -04:00
R David Murray 93a224dd75 #14434: make tutorial link in 'help' banner version-specific
Without this fix, both 2.7 and 3.x would always point to the "current"
docs...which means that before this fix python 3.2 'help' pointed to the 2.7
tutorial, and without this fix when we switch over to the 3.x docs being
current, 2.7 would have pointed to the python3 tutorial.
2012-03-31 12:10:48 -04:00
Antoine Pitrou b8572a1673 Issue #1785: Fix inspect and pydoc with misbehaving descriptors.
Also fixes issue #13581: `help(type)` wouldn't display anything.
2011-12-21 10:16:14 +01:00
Ned Deily 0096fb5780 Issue #7425: Prevent pydoc -k failures due to module import errors.
(Backport to 2.7 of existing 3.x fix)
2011-10-06 14:17:44 -07:00
Éric Araujo 9a528306b9 Make “pydoc somebuiltin.somemethod” work (#8887) 2011-07-29 17:34:35 +02:00
Senthil Kumaran 4af1c6a4fc Fix closes Issue11439 - Handle the SVN Keywords in 2.7 by replacing them with a high number so that code relying on them does not break. 2011-07-28 22:30:27 +08:00
Charles-François Natali 0cf7e25c28 - Issue #12603: Fix pydoc.synopsis() on files with non-negative st_mtime. 2011-07-27 19:36:40 +02:00
Victor Stinner dbfba1667c Close #12182: Fix pydoc.HTMLDoc.multicolumn() if Python uses the new (true)
division (python -Qnew). Patch written by Ralf W. Grosse-Kunstleve.
2011-05-26 13:37:25 +02:00
Raymond Hettinger 9aa5a34b6b Issue #11666: Teach pydoc to display full help for named tuples 2011-03-25 16:00:13 -07:00
Georg Brandl 52f839540c Merged revisions 86881,86887,86913-86915,86933,86943,86960,86964,86974,86980,86996,87008 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r86881 | georg.brandl | 2010-11-30 08:43:28 +0100 (Di, 30 Nov 2010) | 1 line

  #10584: fix bad links.
........
  r86887 | georg.brandl | 2010-11-30 15:57:54 +0100 (Di, 30 Nov 2010) | 1 line

  Fix typo.
........
  r86913 | georg.brandl | 2010-12-01 16:32:43 +0100 (Mi, 01 Dez 2010) | 1 line

  Add missing word, and add a better reference to the actual function.
........
  r86914 | georg.brandl | 2010-12-01 16:36:33 +0100 (Mi, 01 Dez 2010) | 1 line

  #10594: fix parameter names in PyList API docs.
........
  r86915 | georg.brandl | 2010-12-01 16:44:25 +0100 (Mi, 01 Dez 2010) | 1 line

  Fix some markup and style in the unittest docs.
........
  r86933 | georg.brandl | 2010-12-02 19:02:01 +0100 (Do, 02 Dez 2010) | 1 line

  #10597: fix Py_SetPythonHome docs by pointing to where the meaning of PYTHONHOME is already documented.
........
  r86943 | georg.brandl | 2010-12-02 23:35:25 +0100 (Do, 02 Dez 2010) | 1 line

  Re-add accidentally removed line.
........
  r86960 | georg.brandl | 2010-12-03 08:55:44 +0100 (Fr, 03 Dez 2010) | 1 line

  #10360: catch TypeError in WeakSet.__contains__, just like WeakKeyDictionary does.
........
  r86964 | georg.brandl | 2010-12-03 10:58:38 +0100 (Fr, 03 Dez 2010) | 1 line

  #10549: fix interface of docclass() for text documenter.
........
  r86974 | georg.brandl | 2010-12-03 16:30:09 +0100 (Fr, 03 Dez 2010) | 1 line

  Markup consistency fixes.
........
  r86980 | georg.brandl | 2010-12-03 18:19:27 +0100 (Fr, 03 Dez 2010) | 1 line

  Fix punctuation.
........
  r86996 | georg.brandl | 2010-12-03 20:56:42 +0100 (Fr, 03 Dez 2010) | 1 line

  Fix indentation.
........
  r87008 | georg.brandl | 2010-12-04 10:04:04 +0100 (Sa, 04 Dez 2010) | 1 line

  Fix typo.
........
2011-02-25 10:39:23 +00:00
Alexander Belopolsky d501dde89d Merged revisions 82547 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r82547 | alexander.belopolsky | 2010-07-04 13:00:20 -0400 (Sun, 04 Jul 2010) | 3 lines

  Issue #9118: help(None) will now return NoneType doc instead of
  starting interactive help.
........
2011-01-11 15:35:23 +00:00
Senthil Kumaran aa8954523c Merged revisions 84173 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r84173 | senthil.kumaran | 2010-08-19 01:02:21 +0530 (Thu, 19 Aug 2010) | 3 lines

  Fix Issue672656 - Securing pydoc server.
........
2010-08-18 19:35:53 +00:00
Georg Brandl 004c74d468 Merged revisions 83370,83372-83374,83384 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r83370 | georg.brandl | 2010-07-31 23:51:48 +0200 (Sa, 31 Jul 2010) | 5 lines

  #8198: the Helper class should not save the stdin and stdout objects
  at import time, rather by default use the current streams like the
  other APIs that output help.
........
  r83372 | georg.brandl | 2010-08-01 00:05:54 +0200 (So, 01 Aug 2010) | 1 line

  #4007: remove *.a and *.so.X.Y files in "make clean".
........
  r83373 | georg.brandl | 2010-08-01 00:11:11 +0200 (So, 01 Aug 2010) | 1 line

  #5147: revert accidental indentation of header constant for MozillaCookieJar.
........
  r83374 | georg.brandl | 2010-08-01 00:32:52 +0200 (So, 01 Aug 2010) | 1 line

  #5146: handle UID THREAD command correctly.
........
  r83384 | georg.brandl | 2010-08-01 08:32:55 +0200 (So, 01 Aug 2010) | 1 line

  Build properties using lambdas.  This makes test_pyclbr pass again, because it does not think that input and output are methods anymore.
........
2010-08-01 19:06:51 +00:00
Ronald Oussoren 9545a23c7f In a number of places code still revers
to "sys.platform == 'mac'" and that is
dead code because it refers to a platform
that is no longer supported (and hasn't been
supported for several releases).

Fixes issue #7908 for the trunk.
2010-05-05 19:09:31 +00:00
Brian Curtin a01da93d85 Fix a test_pydoc failure on Neal Norwitz's buildbot. 2010-04-01 04:02:00 +00:00
Brian Curtin fe4900c0bc Correct what was intended to be a single-tuple to just be a != check.
Thanks to Éric Araujo for noticing that.
2010-03-31 17:36:09 +00:00
Brian Curtin aeb2e8295d Fix #8225. xml.etree was displaying an incorrect link when viewed in help. 2010-03-31 03:10:21 +00:00
Ezio Melotti e511fc7979 #7930: fix stripid 2010-02-16 23:26:09 +00:00
Nick Coghlan 11db64e5fd Issue #7328: don't corrupt sys.path when running pydoc with the -m switch 2009-11-15 22:36:47 +00:00
R. David Murray ef087da9e7 Fix issue 5230 by having pydoc's safeimport check to see if the import
error was thrown from itself in order to decide if the module can't be
found.  Thanks to Lucas Prado Melo for collaborating on the fix and tests.
2009-06-23 18:02:46 +00:00
R. David Murray d67ea7d4c6 fix issue #6121 by stripping spaces from the argument in the 'help'
function.
2009-05-27 20:07:21 +00:00
Georg Brandl 438192540d Move pydoc_topics module to its own subdirectory, so that no generated code is in Lib/. 2009-04-26 09:56:44 +00:00
Georg Brandl e019706862 #5698: Fix casing of !DOCTYPE to conform to W3C specs. 2009-04-10 08:20:23 +00:00
Georg Brandl c3a9803410 Patch #4739 by David Laban: add symbols to pydoc help topics,
so that ``help('@')`` works as expected.
2008-12-27 18:20:04 +00:00
Georg Brandl 5c669db194 #3707: fix inf. recursion in pydoc topic search. Rev'd by Antoine. 2008-08-30 19:03:43 +00:00
Brett Cannon aca98b0a2c Silence SyntaxWarning and DeprecationWarning in pydoc triggered by tuple
unpacking in parameter lists and using callable(). Found through -3.
2008-08-03 00:58:51 +00:00
Georg Brandl b32dea5a3e #3045: fix pydoc behavior for TEMP path with spaces. 2008-07-16 21:19:28 +00:00
Nick Coghlan c060b0e7eb Issue 3190: pydoc now hides module __package__ attributes 2008-07-02 13:09:19 +00:00
Georg Brandl 681001e11b Generate pydoc's topic help from the reST docs via Sphinx'
new text writer.
2008-06-01 20:33:55 +00:00
Brett Cannon 2ee0e8eaec Revert the renaming of repr to reprlib. 2008-05-23 05:03:59 +00:00
Georg Brandl 6634bf2919 Tkinter rename reversal: remove tkinter package, adapt imports and docs. 2008-05-20 07:13:37 +00:00
Georg Brandl ad9afeb8f0 Tkinter rename, step 2: fix imports and add stub modules. 2008-05-16 15:48:15 +00:00
Alexandre Vassalotti 50a1acb2ab Changed references to the reprlib module to use its new name. 2008-05-16 06:58:49 +00:00
Georg Brandl b169eaa917 #2133: fix HTML color spec. 2008-02-17 21:18:55 +00:00
Andrew M. Kuchling 727a59070d Update PEP URL.
(This code is duplicated between pydoc and DocXMLRPCServer; maybe it
should be refactored as a GHOP project.)

2.5.2 backport candidate.
2008-02-05 16:06:57 +00:00
Georg Brandl ce8fd9d2bc Remove effectless expression statement. 2008-01-27 18:14:43 +00:00
Georg Brandl f2dae0e14a #1715: include sub-extension modules in pydoc text output. 2008-01-21 21:05:49 +00:00
Georg Brandl 0751d1ad2a Adapt pydoc to new doc URLs. 2008-01-21 17:13:03 +00:00
Ka-Ping Yee 9e0f116fac Check in the patch proposed by Ben Hayden (benjhayden) for issue
#1550: help('modules') broken by several 3rd party libraries.

Tested with Python build: trunk:54235:59936M -- the reported error
occurs with Django installed (or with any __init__.py present on
the path that raises an exception), and such errors indeed go away
when this change is applied.
2008-01-13 11:25:13 +00:00
Georg Brandl 7e2b6bb24f Patch #1194449: correctly detect unbound methods in pydoc. 2007-03-13 22:16:30 +00:00
Georg Brandl 8441f15626 Patch #1530482: add pydoc.render_doc() which returns the documentation
for a thing instead of paging it to stdout, which pydoc.doc() does.
2007-03-13 20:02:57 +00:00
Georg Brandl b6a87542b3 Patch #1542681: add entries for "with", "as" and "CONTEXTMANAGERS" to
pydoc's help keywords.
2007-03-13 10:06:48 +00:00
Georg Brandl 117a05ed50 Bug #1628895: some better tries to find HTML documentation in pydoc. 2007-03-02 14:37:12 +00:00
Ka-Ping Yee 8ef1cf30b7 Handle old-style instances more gracefully (display documentation on
the relevant class instead of documentation on <type 'instance'>).
2007-01-14 04:25:15 +00:00
Andrew M. Kuchling c911e916d4 [Patch #1600491 from Jim Jewett] Describe how to build help files on Windows 2006-12-19 15:18:12 +00:00
Barry Warsaw 00decd7835 Patch #1520294: Support for getset and member descriptors in types.py,
inspect.py, and pydoc.py.  Specifically, this allows for querying the type of
an object against these built-in C types and more importantly, for getting
their docstrings printed in the interactive interpreter's help() function.

This patch includes a new built-in module called _types which provides
definitions of getset and member descriptors for use by the types.py module.
These types are exposed as types.GetSetDescriptorType and
types.MemberDescriptorType.  Query functions are provided as
inspect.isgetsetdescriptor() and inspect.ismemberdescriptor().  The
implementations of these are robust enough to work with Python implementations
other than CPython, which may not have these fundamental types.

The patch also includes documentation and test suite updates.

I commit these changes now under these guiding principles:

1. Silence is assent.  The release manager has not said "no", and of the few
   people that cared enough to respond to the thread, the worst vote was "0".

2. It's easier to ask for forgiveness than permission.

3. It's so dang easy to revert stuff in svn, that you could view this as a
   forcing function. :)

Windows build patches will follow.
2006-07-27 23:43:15 +00:00
Phillip J. Eby ceb3087e1c Second phase of refactoring for runpy, pkgutil, pydoc, and setuptools
to share common PEP 302 support code, as described here:

http://mail.python.org/pipermail/python-dev/2006-April/063724.html

pydoc now supports PEP 302 importers, by way of utility functions in
pkgutil, such as 'walk_packages()'.  It will properly document
modules that are in zip files, and is backward compatible to Python
2.3 (setuptools installs for Python <2.5 will bundle it so pydoc
doesn't break when used with eggs.)

What has not changed is that pydoc command line options do not support
zip paths or other importer paths, and the webserver index does not
support sys.meta_path.  Those are probably okay as limitations.

Tasks remaining: write docs and Misc/NEWS for pkgutil/pydoc changes,
and update setuptools to use pkgutil wherever possible, then add it
to the stdlib.
2006-04-18 00:59:55 +00:00
Georg Brandl 26fd2e1dcc Fix pydoc.synopsis() so that it doesn't error out with an unreadable
module.
2006-03-08 09:34:53 +00:00