summaryrefslogtreecommitdiffstats
path: root/Lib/pydoc.py
Commit message (Collapse)AuthorAgeFilesLines
* Patch #785689: Use basename in usage. Backported to 2.3.Martin v. Löwis2003-10-311-1/+1
|
* Let library modules use the new keyword arguments for list.sort().Raymond Hettinger2003-10-161-1/+1
|
* display link to module docs when it looks like the object module is a coreSkip Montanaro2003-09-101-1/+47
| | | | module
* (HTML|Text)Repr.repr1: Guard against objects whos types have no __name__Skip Montanaro2003-06-271-10/+10
| | | | attribute. Patch and bug report from Geoff Talvola. Closes patch #672855.
* Support keyword and topics help in cli(). Fixes #715782.Martin v. Löwis2003-06-141-4/+6
|
* Have pydoc try handling an object as "other" if the object does not act the wayBrett Cannon2003-06-111-3/+10
| | | | | | it expects based on what inspect classifies it as. Closes bug #729103 .
* Fix SF bug #735694, Pydoc.py fixes linksNeal Norwitz2003-05-261-5/+6
| | | | | Modified the patch some. Fixed invalid link in UNICODE (to STRING). Also updates some references.
* Patch #711902: Cause pydoc to show data descriptor __doc__ strings.Martin v. Löwis2003-05-031-2/+2
|
* SF patch #706338, Fix a few broken links in pydoc by Greg ChapmanNeal Norwitz2003-03-301-4/+4
|
* Hide private names beginning with _ (but don't hide __special__ names).Ka-Ping Yee2003-03-281-54/+77
| | | | | | Clean up section headings; make the bars on the left less fat. Adjust the display of properties slightly. Don't show stuff inherited from the base 'object' type.
* Fix SF patch #695581, "returnself" -> "return self"Neal Norwitz2003-03-011-1/+1
|
* Get rid of many apply() calls.Guido van Rossum2003-02-271-5/+5
|
* Fix for SF 686380, from SF patch 686771 by Ping. (errors trying toGuido van Rossum2003-02-161-1/+1
| | | | get help on os attributes)
* Fix SF bug #642168, help() fails for some builtin topicsNeal Norwitz2003-02-071-2/+2
| | | | | | Fix pydoc when doing help for: and, or, not, UNICODE. Will backport.
* SF bug 666444: 'help' makes linefeed only under Win32.Tim Peters2003-02-071-2/+2
| | | | | | Reverting one of those irritating "security fixes". fdopen() opens files in binary mode. That makes pydoc skip the \r\n on Windows that's need to make the output readable in the shell. Screw it.
* Gracefully delay runtime error up to 1s. Add .willdispatch().Martin v. Löwis2002-12-281-0/+1
|
* Correct erroneous parenthesis placement in the delta from 1.63 to 1.64.Raymond Hettinger2002-11-021-2/+2
|
* SF bug 630824: pydoc Helper keywords missing 'yield'Tim Peters2002-10-301-0/+1
| | | | | | | Wow, what a brittle subsystem! Fixed, maybe, provided Fred doesn't shuffle the docs around. Bugfix candidate.
* Explicitly use floor divisionRaymond Hettinger2002-10-211-1/+1
|
* try executing 'less' in a parenthesized subshell - prevents systems likeSkip Montanaro2002-09-261-1/+1
| | | | | Solaris from squawking if less isn't available. See http://python.org/sf/612111 for details.
* Added the standard MacOSX location for documentation inside a frameworkJack Jansen2002-08-231-1/+2
| | | | to the list of places where pydoc looks for HTML documents.
* Extend stripid() to handle strings ending in more than one '>'.Ka-Ping Yee2002-08-111-37/+36
| | | | | Add resolve() to handle looking up objects and names (fix SF bug 586931). Add a nicer error message when given a filename that doesn't exist.
* Massive changes from SF 589982 (tempfile.py rewrite, by ZackGuido van Rossum2002-08-091-4/+4
| | | | | Weinberg). This changes all uses of deprecated tempfile functions to the recommended ones.
* Add a coding cookie, because of the møøse quote.Guido van Rossum2002-08-061-0/+1
|
* Replaced obsolete stat module constants with equivalent attributesRaymond Hettinger2002-06-011-4/+4
|
* SF 563203. Replaced 'has_key()' with 'in'.Raymond Hettinger2002-06-011-13/+13
|
* In both spilldata() functions, pretend that the docstring forGuido van Rossum2002-05-211-2/+8
| | | | | non-callable objects is always None. This makes for less confusing output and fixes the problem reported in SF patch #550290.
* Partial introduction of bools where appropriate.Guido van Rossum2002-04-071-4/+5
|
* Convert a pile of obvious "yes/no" functions to return bool.Tim Peters2002-04-041-1/+2
|
* Quote href properly.Neil Schemenauer2002-03-241-1/+2
|
* Remove unnecessary \b. It was causing the RE to miss the tailingNeil Schemenauer2002-03-241-1/+1
| | | | slash on strings like "http://www.python.org/ is good".
* add repr_str as alias for repr_string in both HTMLRepr and TextRepr classesSkip Montanaro2002-03-071-0/+4
| | | | | - reflects the change in type("").__name__ between 2.1 and 2.2. The __name__ field is used to find a method to call for particular types.
* OS/2 more program behaves like Win32 moreAndrew MacIntyre2002-03-031-1/+1
| | | | (see patch #514490, by Stefan Schwarzer)
* SF patch #474485: pydoc generates some bad html, from Rich Salz.Tim Peters2001-10-311-5/+5
|
* SF bug [#472347] pydoc and properties.Tim Peters2001-10-181-3/+4
| | | | | | | | | | | | | | | The GUI-mode code to display properties blew up if the property functions (get, set, etc) weren't simply methods (or functions). "The problem" here is really that the generic document() method dispatches to one of .doc{routine, class, module, other}(), but all of those require a different(!) number of arguments. Thus document isn't general-purpose at all: you have to know exactly what kind of thing is it you're going to document first, in order to pass the correct number of arguments to .document for it to pass on. As an expedient hack, just tacked "*ignored" on to the end of the formal argument lists for the .docXXX routines so that .document's caller doesn't have to know in advance which path .document is going to take.
* docroutine() (both instances): Docstrings for class methods weren'tTim Peters2001-09-271-2/+0
| | | | | | | | | | | | | | | | getting displayed, due to a special case here whose purpose I didn't understand. So just disabled the doc suppression here. Another special case here skips the docs when picking apart a method and finding that the im_func is also in the class __dict__ under the same name. That one I understood. It has a curious consequence, though, wrt inherited properties: a static class copies inherited stuff into the inheriting class's dict, and that affects whether or not this special case triggers. The upshoot is that pydoc doesn't show the function docstrings of getter/setter/deleter functions of inherited properties in the property section when the class is static, but does when the class is dynamic (bring up Lib/test/pydocfodder.py under GUI pydoc to see this).
* List class attrs in MRO order of defining class instead of by alphabeticTim Peters2001-09-271-23/+12
| | | | order of defining class's name.
* Removed no-longer-true comment about pydoc working under all versions ofTim Peters2001-09-261-4/+0
| | | | | Python since 1.5 (virtually everything I changed over the last week relies on "modern" features, particularly nested scopes).
* Display a class's method resolution order, if it's non-trivial. "Trivial"Tim Peters2001-09-261-1/+22
| | | | | here means it has no more than one base class to rummage through (in which cases there's no potential confusion about resolution order).
* + Display property functions in the same order they're specified toTim Peters2001-09-251-7/+7
| | | | | | | | | | | | | | property() (get, set, del; not set, get, del). + Change "Data defined/inherited in ..." header lines to "Data and non-method functions defined/inherited in ...". Things like the value of __class__, and __new__, and class vrbls like the i in class C: i = int show up in this section too. I don't think it's worth a separate section to distinguish them from non-callable attrs, and there's no obvious reliable way to distinguish callable from non-callable attrs anyway.
* + Got rid of all instances of <small>. Under IE5, GUI-mode pydoc hasTim Peters2001-09-251-22/+19
| | | | | | | | | | | | | always been close to useless, because the <small>-ified docstrings were too small to read, even after cranking up my default font size just for pydoc. Now it reads fine under my defaults (as does most of the web <0.5 wink>). If it's thought important to play tricks with font size, tough, then someone should rework pydoc to use style sheets, and (more) predictable percentage-of-default size controls. + Tried to ensure that all <dt> and <dd> tags are closed. I've read (but don't know) that some browsers get confused if they're not, and esp. when style sheets are in use too.
* GUI mode now displays useful stuff for properties. This is usually betterTim Peters2001-09-251-4/+14
| | | | | than text mode, since here we can hyperlink from the getter etc methods back to their definitions.
* + Text-mode (but not yet GUI mode) pydoc now produces useful stuff forTim Peters2001-09-241-9/+35
| | | | | | | | | | properties: the docstring (if any) is displayed, and the getter, setter and deleter (if any) functions are named. All that is shown indented after the property name. + Text-mode pydoc class display now draws a horizontal line between class attribute groups (similar to GUI mode -- while visually more intrusive in text mode, it's still an improvement).
* More work on class display:Tim Peters2001-09-241-43/+61
| | | | | | | | | + Minor code cleanup, generalization and simplification. + "Do something" to make the attribute aggregation more apparent: - In text mode, stick a "* " at the front of subgroup header lines. - In GUI mode, display a horizontal rule between subgroups. For GUI mode, this is a huge improvement, at least under IE.
* Try to do for pydoc's GUI mode what the earlier checkin did for textTim Peters2001-09-241-9/+92
| | | | | | | | | | | | | | | | | | | | mode (identify the source class for class attrs; segregate attrs according to source class, and whether class method, static method, property, plain method, or data; display data attrs; display docstrings for data attrs when possible). Alas, this is mondo ugly, and I'm no HTML guy. Part of the problem is that pydoc's GUI mode has always been ugly under IE, largely because <small> under IE renders docstrings unreadably small (while sometimes non-docstring text is painfully large). Another part is that these segregated listings of attrs would *probably* look much better as bulleted lists. Alas, when I tried that, the bullets all ended up on lines by themselves, before the method names; this is apparently because pydoc (ab?)uses definition lists for format effects, and at least under IE if a definition list is the first chunk of a list item, it gets rendered on a line after the <li> bullet. An HTML wizard would certainly be welcomed here.
* Part of a partial solution to SF bugs 463378, 463381, 463383, 463384.Tim Peters2001-09-231-8/+87
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This almost entirely replaces how pydoc pumps out class docs, but only in text mode (like help(whatever) from a Python shell), not in GUI mode. A class C's attrs are now grouped by the class in which they're defined, attrs defined by C first, then inherited attrs grouped by alphabetic order of the defining classes' names. Within each of those groups, the attrs are subgrouped according to whether they're plain methods, class methods, static methods, properties, or data. Note that pydoc never dumped class data attrs before. If a class data attr is implemented via a data descriptor, the data docstring (if any) is also displayed (e.g., file.softspace). Within a subgroup, the attrs are listed alphabetically. This is a friggin' mess, and there are bound to be glitches. Please beat on it and complain! Here are three glitches: 1. __new__ gets classifed as 'data', for some reason. This will have to get fixed in inspect.py, but since the latter is already looking for any clue that something is a method, pydoc will almost certainly not know what to do with it when its classification changes. 2. properties are special-cased to death. Unlike any other kind of function or method, they don't have a __name__ attr, so none of pydoc's usual code can deal with them. Worse, the getter and setter and del'er methods associated with a property don't appear to be discoverable from Python, so there's really nothing I can think of to do here beyond just listing their names. Note that a property can't be given a docstring, either (or at least I've been unable to sneak one in) -- perhaps the property() constructor could take an optional doc argument? 3. In a nested-scopes world, pydoc still doesn't know anything about nesting, so e.g. classes nested in functions are effectively invisible.
* Since inspect.isfunction(obj) is a precondition for callingTim Peters2001-09-201-6/+6
| | | | | | | | inspect.getargspec(obj), test isfunction() directly in pydoc.py instead of trying to indirectly deduce isfunction() in pydoc by virtue of failing a combination of other tests. This shouldn't have any visible effect, except perhaps to squash a TypeError death if there was some path thru this code that was inferring isfunction() by mistake.
* After much thrashing, I believe this is a truly minimal patch to teachTim Peters2001-09-201-3/+6
| | | | | pydoc how to do something sensible with 2.2 descriptors. To see the difference, browse __builtin__ via pydoc before and after the patch.
* Oh, ok, so plainpager is probably marginally better.Fred Drake2001-07-231-1/+1
|
* If $TERM is "dumb" or "emacs", just dump the text instead of trying to runFred Drake2001-07-231-0/+2
| | | | | | "less". Patch contributed by Alex Convertry. This closes SF patch #443551.