Pydoc interactive browsing enhancement

[ronadam]

BPO	2001
Nosy	@birkenfeld, @ncoghlan, @abalkin, @vstinner, @merwok, @rliebscher
Files	issue2001_ncoghlan_cleanup.diff: Additional cleanup before compatibility issues were noted issue2001_b.diff: New enhanced browsing, deprecated gui(), serve(), and '-g' option. pydoc.png issue2001_c.diff issue2001_d.diff: Many small fix's and removal of urllib parse and tests. issue2001_e.diff: add with statements and reads _pydoc.css file. issue2001_f.diff: Has unittests now. issue_2001_f+1.diff issue_2001_g.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/ncoghlan'
closed_at = <Date 2010-12-03.16:13:11.881>
created_at = <Date 2008-02-02.23:05:52.107>
labels = ['type-feature', 'library']
title = 'Pydoc interactive browsing enhancement'
updated_at = <Date 2021-03-24.13:47:05.611>
user = 'https://bugs.python.org/ronadam'

bugs.python.org fields:

activity = <Date 2021-03-24.13:47:05.611>
actor = 'vstinner'
assignee = 'ncoghlan'
closed = True
closed_date = <Date 2010-12-03.16:13:11.881>
closer = 'ncoghlan'
components = ['Library (Lib)']
creation = <Date 2008-02-02.23:05:52.107>
creator = 'ron_adam'
dependencies = []
files = ['19534', '19613', '19630', '19638', '19642', '19644', '19727', '19846', '19847']
hgrepos = []
issue_num = 2001
keywords = ['buildbot']
message_count = 62.0
messages = ['62012', '62351', '62497', '72216', '100283', '100284', '100778', '111305', '111370', '111371', '111379', '111380', '111381', '111382', '111384', '111385', '111387', '111505', '111506', '111510', '112008', '112090', '112093', '114326', '119713', '120238', '120262', '120310', '120681', '120692', '120723', '120731', '120840', '121180', '121181', '121237', '121395', '121418', '121435', '121442', '121443', '121445', '121447', '121516', '121518', '121529', '121541', '121557', '121570', '121873', '122238', '122597', '122603', '122637', '123215', '123216', '123227', '123231', '123251', '123254', '123255', '389453']
nosy_count = 8.0
nosy_names = ['ping', 'georg.brandl', 'ncoghlan', 'belopolsky', 'vstinner', 'ron_adam', 'eric.araujo', 'r.liebscher']
pr_nums = []
priority = 'normal'
resolution = 'accepted'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue2001'
versions = ['Python 3.2']

[ronadam]

This patch removes the gui tk control panel and replaces it with a
navigation bar on the served web pages.

This offers a nicer user experience because one no longer needs to jump
back and forth between windows.

The navbar supports getting specific modules, searching modules, and
returning to the main module index. I believe the file source view is
safer also.

Possible issues...

+ Restarting the server without ending it causes an error do to the port
already being used. I think this is not new.

+ There may be some brakage if other applications depend on the tk
interface, but I don't think any do. Or at least none that I know of.

+ I haven't tested this on windows. (It works well on Ubuntu 7.10)

[ronadam]

Added a topics and keywords index choices to the navbar.

This gives the web interface the same functionality as the cli interface.

Fixed the -p option which I had missed.

[ronadam]

Remade the diff with correct directory name so it patches correctly.

Is there a way to add the patch keyword?

[ronadam]

New patch to replace outdated patch due to other changes to pydoc.

The easies way to try this out is to:

> import pydoc
> pydoc.gui()

Try it before and after the patch. I think most people will prefer the
patch.

[ronadam]

Updated the patch to work with 3.2 and removed earlier outdated patches.

[ronadam]

I think this is ready for a review and feedback.

[ronadam]

Missed a buffer write in the gettopic() method. Fixed.
Plus some minor doc string changes.

Can someone change the stage to "patch review". I can't do that myself.

Or is there something else I need to do first?

[BreamoreBoy]

The patch seems clean to me. Applied patch to unit test and ran it, tests failed, then applied patch to module, tests passed. Also tried import pydoc;pydoc.gui() from the command line, the output looked fine to me. Tested on Windows Vista with Firefox. Could someone commit this please.

[ronadam]

Thank You for the review Mark. It's very much appreciated.

I took another look at it and decided to offer another patch that moves the html/text server to the http package where the rest of the server stuff is.

I also corrected the example in it. Everything still works the same as when mark tested it.

This makes the diff file easier to read and tell what's going on.

[abalkin]

Ron,

Can you add a Misc/NEWS entry summarizing your change? Also, please check if any changes need to be made to ReST documentation, Doc/library/pydoc.rst .

Ka-Ping,

Do you want to hold on to this, you can I take it over?

[ronadam]

Here's the new patch with the Misc/NEWS and pydoc.rst additions added to it.

I'm not sure if local_text_server is the best name for the server module. In pydoc it's a local server, but it may not be limited to that use. I've also considered text_server, text_html_server, or simple_text_server.

[abalkin]

On Fri, Jul 23, 2010 at 4:08 PM, Ron Adam <report@bugs.python.org> wrote:
..

Here's the new patch with the Misc/NEWS and pydoc.rst additions added to it.

s/Romoved/Removed/