[issue2001] Pydoc interactive browsing enhancement

STINNER Victor added the comment: The "getfile" feature has a directory traversal vulnerability and so I propose to remove the feature: see bpo-42988. -- nosy: +vstinner ___ Python tracker __

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: Oh, that would be Éric's point 4 that I fixed. OK, no need to create a new issue for that one then :) -- ___ Python tracker ___ _

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: r86975 should fix the problem with Windows paths. I also found an issue where many of the emitted HTML pages contained two HTML header sections. The tests were just written in a way that they only looked at the second of these header sections, while my browser

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: Added the missing CSS file in r86971. Hopefully that will make the buildbots a little happier. -- ___ Python tracker ___

[issue2001] Pydoc interactive browsing enhancement

Éric Araujo added the comment: Nick, you seem to have forgotten to svn add the CSS file. -- ___ Python tracker ___ ___ Python-bugs-lis

[issue2001] Pydoc interactive browsing enhancement

Changes by Giampaolo Rodola' : -- nosy: -giampaolo.rodola ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http:

[issue2001] Pydoc interactive browsing enhancement

Georg Brandl added the comment: The html_getfile() function is Unix-specific: it constructs paths like path = os.sep + path.replace('%20', ' ') Consequently, its test fails on Windows: http://www.python.org/dev/buildbot/all/builders/x86%20XP-4%203.x/builds/3703/steps/test/logs/stdio

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: Oh, I also fixed in issue in both the old and new server code that switched warnings off globally rather than merely for the operation it was trying to disable warnings for. -- ___ Python tracker

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: Committed in r86962. Thanks to all involved in getting this from initial submission to final checkin :) Any further changes (including addressing Éric's last few comments) can be undertaken as separate issues. -- resolution: -> accepted stage: patch

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Thanks for the review and style edits Éric. I think it's a much better patch with the changes and suggestions from you, Nick, and Alexander. I'll check my white space settings. Thanks for noticing it. As Nick points out, parts of the patch was written with the i

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: Regarding question 1 (_start_server docstring): I have no problem with docstrings on private functions in general. It just means they're for the benefit of developers of the module itself rather than users of the module. However, in this case, I would move the

[issue2001] Pydoc interactive browsing enhancement

Changes by Éric Araujo : Added file: http://bugs.python.org/file19847/issue_2001_g.diff ___ Python tracker ___ ___ Python-bugs-list mailing lis

[issue2001] Pydoc interactive browsing enhancement

Éric Araujo added the comment: First, thanks for your work on this. I have some feature requests for pydoc too and I’m hoping to work with you in the future :) I found it more efficient (and fair) to make a new diff instead of listing all nitpicks and have you do the changes. issue_2001_g.d

[issue2001] Pydoc interactive browsing enhancement

Éric Araujo added the comment: I am reviewing this and making some edits to the patch. Will post this week. -- nosy: +giampaolo.rodola ___ Python tracker ___ ___

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Here is the latest patch with tests. In order to test the html pages I separated out the URL handler. So now we have three new functions. pydoc._start_server(urlhandler, port) pydoc._url_handler(url, content_type="text/html") pydoc.browse(port=0, *, op

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: I added an empty _pydoc.css file. The server does read it and you'll be able to play around with it, but don't expect it to be pretty if you do until the rest of the html is updated. Should I put that in the pydoc_data? It just needs tests now, which I'll be work

Re: [issue2001] Pydoc interactive browsing enhancement

On 11/19/2010 08:21 AM, Alexander Belopolsky wrote: Alexander Belopolsky added the comment: On Thu, Nov 18, 2010 at 2:37 AM, Ron Adam wrote: .. I'll try reading and writing directly to the socket and working up some tests from that. I don't suppose there's something like that already in t

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Here is the patch in the current state which includes the changes in issue2001_c.diff as well as most of the changes Éric suggested. Still to do: * Use the with statement in several places to ensure closing. * Add tests for the server. I did try to make the hea

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: Gah, I accidentally generated a diff that included some unrelated changes to urrlib (and its tests) for a different issue I had been working on, and Ron's subsequent patch picked them up. I then misinterpreted "left them alone" to mean "didn't include them in t

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: issue2001_c.diff is the same as issue2001_b.diff, but without urlparse changes and with minor modifications to pydoc.rst resolving a conflict with a recent commit. I have also uploaded the same patch to rietveld: http://codereview.appspot.com/3187042

[issue2001] Pydoc interactive browsing enhancement

Changes by Giampaolo Rodola' : -- nosy: -giampaolo.rodola ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http:

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: issue2001_b.diff patch includes changes to urllib. Is this intentional? Is it a bug fix, a feature? There is no mention in the NEWS file. If these changes are needed for pydoc enhancements, I would like to separate them in its own issue and commit s

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: On Thu, Nov 18, 2010 at 2:37 AM, Ron Adam wrote: .. > I'll try reading and writing directly to the socket and working up some tests > from that. > I don't suppose there's something like that already in the test suite I can > copy? I believe you can fin

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Sense these features reuse other parts of pydoc, they are are covered to some degree by the existing tests. An easy test would be to just start the server and then shut it down after a short timeout. Better than nothing. I'll try reading and writing directly to

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Thanks for the review Éric! The more eyes on this the better it will be. I'm not familiar with rietveld yet. But no time like the present to get started. Here's the link. http://codereview.appspot.com/3151042/ I didn't play around with the html too much. Mo

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: Shouldn't tests for new features added to Lib/test/test_pydoc.py? -- ___ Python tracker ___ __

[issue2001] Pydoc interactive browsing enhancement

Changes by Sridhar Ratnakumar : -- nosy: -srid ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.pyth

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: I am attaching pydoc.png screenshot that shows how the new navigation bar is rendered in my browser. It looks a little bit busy and I don't like (get)/(search) buttons jumping below the text boxes when the browser window is is not wide enough. ---

[issue2001] Pydoc interactive browsing enhancement

Éric Araujo added the comment: Review time! Please use rietveld for big patches in the future. I had started with a list of remarks in same order than the code and minor remarks grouped at the end, but I see now that all my remarks are minor, since I have found no real code problem (I don’t

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: Ron, I added a header to the text documentation clarifying that pydoc-generated documentation is not authoritative. See issue 10446. I did add it to the HTML page because it was not obvious where to put it and I knew that you are changing layout anywa

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: I just noticed I used "depreciated" in place of "deprecated" in one of the doc strings. I can upload a new patch with that fixed. Before I do that, is there any thing else I can do? Do you agree that the browse function should be public? If not, what do we tell

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam : Removed file: http://bugs.python.org/file19476/pydoc_r86133.diff ___ Python tracker ___ ___ Python-bugs-list mailing list

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam : Removed file: http://bugs.python.org/file19604/issue2001_a.diff ___ Python tracker ___ ___ Python-bugs-list mailing list

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: This should be done or very close to done. The -g option, gui(), and serve() functions are deprecated. The new features are browse(port, *, open_browser=True), and a '-b' option. The '-p port' option does browse(port=port, open_browser=False), so _startserver() d

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: Just call warnings.warn with an appropriate message, a category of DeprecationWarning and a stacklevel of 2 (so the warning will refer to the function's caller rather than to the pydoc code). It's basically the example from the warnings.warn docs. --

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Ok, here is the latest patch for review. "issue2001_a.diff' I restored the pydoc.py file and then put most of the new code in these two functions, _startserver(urlhandler, port) _browse(port=0, *, open_browser=True) This creates a bettor organized file, and r

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: As per python-dev discussion, we'll keep the old server and GUI implementations intact (but deprecated). The -g command line option will start the old implementation, -p and -b will start the new one. The APIs to activate the new implementation will start with

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: Yeah, I'll ask for feedback on python-dev regarding the API breakage. If we decide not to break the existing API, I'd suggest the following: - keep both the old serve() and the old gui() (with DeprecationWarning added to both) (I'd forgotten your point in the p

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: > What about http://bugs.python.org/issue2001#msg114326 ? Thanks for the reminder. To Nick: >However, the public (albeit undocumented) nature of the APIs >implementing the >old Tk GUI means I'm not comfortable committing the >patch in a form that >simply drops t

[issue2001] Pydoc interactive browsing enhancement

René Liebscher added the comment: What about http://bugs.python.org/issue2001#msg114326 ? -- ___ Python tracker ___ ___ Python-bugs-li

[issue2001] Pydoc interactive browsing enhancement

Changes by Nick Coghlan : Added file: http://bugs.python.org/file19534/issue2001_ncoghlan_cleanup.diff ___ Python tracker ___ ___ Python-bugs-l

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: I'd actually started typing out the command to commit this before it finally clicked that the patch changes public APIs of the pydoc module in incompatible ways. Sure, they aren't documented, but the fact they aren't protected by an underscore means I'm not com

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Here you go Nick. One file with Underscores for the new class's and functions. Where there was some overlap in names, like where some of the older server class's were reused, but don't have exactly the same behavior, I started those with underscores also. This s

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam : Removed file: http://bugs.python.org/file18271/pydoc_server4.diff ___ Python tracker ___ ___ Python-bugs-list mailing lis

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam : Removed file: http://bugs.python.org/file18165/pydoc_server3.diff ___ Python tracker ___ ___ Python-bugs-list mailing lis

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam : Removed file: http://bugs.python.org/file16517/pydoc_gui.diff ___ Python tracker ___ ___ Python-bugs-list mailing list Un

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: On Wed, Nov 3, 2010 at 2:17 AM, Ron Adam wrote: > > Ron Adam added the comment: > > Nick, I can update the patch and move the server back into pydoc.py if that > will help you get this into 3.2 beta. Yep, probably the best option 3.2 - then make a new issue ab

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Nick, I can update the patch and move the server back into pydoc.py if that will help you get this into 3.2 beta. I can also changed the docstrings of the new parts to # comments. -- ___ Python tracker

[issue2001] Pydoc interactive browsing enhancement

Nick Coghlan added the comment: Unassigning from ping given the lack of comments - I should be able to have a look at this in time for beta 1 -- assignee: ping -> ncoghlan ___ Python tracker __

[issue2001] Pydoc interactive browsing enhancement

Changes by René Liebscher : -- nosy: +r.liebscher ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.py

[issue2001] Pydoc interactive browsing enhancement

Mark Lawrence added the comment: I've closed #902061 as a duplicate of this, but please keep in mind msg75324 from that issue. -- ___ Python tracker ___

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: New diff file. Removed the '-g' option and added a '-b' option. Using the '-g' option will now bring up pydoc options help. Added a simple server command prompt with 'b' and 'q' choices to open a browser and quit the server. Allow the '-p' option to be use along w

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: I also put in a temporary fix to skip the test file that was causing it to crash when doing a search. It's marked as such and can be removed once the bug is fixed. -- ___ Python tracker

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Link to the discussion on the python-dev new group. Subject: [isssue 2001] Pydoc enhancement patch questions http://permalink.gmane.org/gmane.comp.python.devel/115474 -- ___ Python tracker

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam : Removed file: http://bugs.python.org/file18163/pydoc_server2.diff ___ Python tracker ___ ___ Python-bugs-list mailing lis

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam : Removed file: http://bugs.python.org/file18160/pydoc_server.diff ___ Python tracker ___ ___ Python-bugs-list mailing list

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Ok, on the "!" marks. The Segmentation fault exits python and isn't catchable as far as I know. It's happens in the compiled tokenize.c file. The python side error detection doesn't get a chance to catch it. The problem is present without the patch applied and whe

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: OK, the crash is due to issue9319, but as far as I understand, the faulty code is in the error handling branch, so there must be a bug in your code as well. -- ___ Python tracker

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: Hmm. Still no luck $ ./python.exe -m pydoc -g Server ready at: http://localhost:7464/ Segmentation fault The Segmentation fault happens after I enter pydoc in the search window and press the "Search!" button. BTW, please remove !'s from the labels.

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Ok, spell, check and attribute error corrected. I agree on the -p / -g issue. I'll bring this up on python dev. Thanks for the reviews and feedback. It really helps. -- Added file: http://bugs.python.org/file18165/pydoc_server3.diff

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: Ron, Your latest patch does not work for me: $ ./python.exe -m pydoc -g Traceback (most recent call last): File "/Users/sasha/Work/python-svn/py3k-commit/Lib/runpy.py", line 160, in _run_module_as_main "__main__", fname, loader, pkg_name) File

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: +:program:`pydoc` :option:`-g` will start the server and additionally open a web +browser to a module index page. Each served page has a navagation bar at the +top where you can 'get' help on a individual item, 'find' all modules with a +keyword in thier

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Sorry, will do... -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.py

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: s/navagation/navigation/ Please spell-check your changes. -- ___ Python tracker ___ ___ Pytho

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: On Fri, Jul 23, 2010 at 4:08 PM, Ron Adam wrote: .. > Here's the new patch with the Misc/NEWS and pydoc.rst additions added to it. s/Romoved/Removed/ -- ___ Python tracker

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: 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_s

[issue2001] Pydoc interactive browsing enhancement

Alexander Belopolsky added the comment: 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? -- nosy: +belopolsk

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: 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 w

[issue2001] Pydoc interactive browsing enhancement

Mark Lawrence added the comment: 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. Cou

[issue2001] Pydoc interactive browsing enhancement

Changes by Benjamin Peterson : -- stage: -> patch review ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http:/

[issue2001] Pydoc interactive browsing enhancement

Changes by Sridhar Ratnakumar : -- nosy: +srid ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.pytho

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: 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? -- Added file: http://bugs.python.org/file1651

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam : Removed file: http://bugs.python.org/file16411/pydoc_gui.diff ___ Python tracker ___ ___ Python-bugs-list mailing list Un

[issue2001] Pydoc interactive browsing enhancement

Changes by Nick Coghlan : -- nosy: +ncoghlan ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam <[EMAIL PROTECTED]>: Removed file: http://bugs.python.org/file9448/pydocnotk.diff ___ Python tracker <[EMAIL PROTECTED]> ___ ___

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam <[EMAIL PROTECTED]>: Removed file: http://bugs.python.org/file9423/pydocnotk.diff ___ Python tracker <[EMAIL PROTECTED]> ___ ___

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam <[EMAIL PROTECTED]>: Removed file: http://bugs.python.org/file9350/pydocnotk.diff ___ Python tracker <[EMAIL PROTECTED]> ___ ___

[issue2001] Pydoc interactive browsing enhancement

Ron Adam <[EMAIL PROTECTED]> added the comment: 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. Added file: http://bugs.python

[issue2001] Pydoc interactive browsing enhancement

Changes by Sean Reifschneider <[EMAIL PROTECTED]>: -- assignee: -> ping nosy: +ping priority: -> normal __ Tracker <[EMAIL PROTECTED]> __ ___

[issue2001] Pydoc interactive browsing enhancement

Changes by A.M. Kuchling: -- keywords: +patch __ Tracker <[EMAIL PROTECTED]> __ ___ Python-bugs-list mailing list Unsubscribe: http://mail.pyt

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: Remade the diff with correct directory name so it patches correctly. Is there a way to add the patch keyword? Added file: http://bugs.python.org/file9448/pydocnotk.diff __ Tracker <[EMAIL PROTECTED]>

[issue2001] Pydoc interactive browsing enhancement

Ron Adam added the comment: 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. Added file: http://bugs.python.org/file9423/pydocnotk.diff __

[issue2001] Pydoc interactive browsing enhancement

Changes by Ron Adam: -- versions: +Python 2.6 __ Tracker <[EMAIL PROTECTED]> __ ___ Python-bugs-list mailing list Unsubscribe: http://mail.pyt

[issue2001] Pydoc interactive browsing enhancement

Changes by Giampaolo Rodola': -- nosy: +giampaolo.rodola __ Tracker <[EMAIL PROTECTED]> __ ___ Python-bugs-list mailing list Unsubscribe: http

[issue2001] Pydoc interactive browsing enhancement

New submission from Ron Adam: 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, searchin