IDLE: Include nested functions and classes in module browser

@terryjreedy

BPO	1612262
Nosy	@terryjreedy, @ncoghlan, @devdanzin, @serwy, @csabella
PRs	bpo-1612262: IDLE: Class Browser shows nested functions and classes #2573 [3.6] bpo-1612262: IDLE: Class Browser shows nested functions, classes (GH-2573) #3702
Dependencies	bpo-6691: Support for nested classes and function for pyclbr bpo-30881: IDLE: add docstrings to browser.py
Files	classbrowser_nesting_support.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/terryjreedy'
closed_at = <Date 2017-09-22.21:34:32.114>
created_at = <Date 2006-12-09.17:38:55.000>
labels = ['expert-IDLE', 'type-feature', '3.7']
title = 'IDLE: Include nested functions and classes in module browser'
updated_at = <Date 2017-09-23.20:45:10.472>
user = 'https://github.com/taleinat'

bugs.python.org fields:

activity = <Date 2017-09-23.20:45:10.472>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = True
closed_date = <Date 2017-09-22.21:34:32.114>
closer = 'terry.reedy'
components = ['IDLE']
creation = <Date 2006-12-09.17:38:55.000>
creator = 'taleinat'
dependencies = ['6691', '30881']
files = ['14706']
hgrepos = []
issue_num = 1612262
keywords = ['patch']
message_count = 16.0
messages = ['30777', '84594', '89549', '91499', '91509', '250596', '297297', '297974', '299794', '301929', '301930', '301947', '302716', '302767', '302776', '302777']
nosy_count = 6.0
nosy_names = ['terry.reedy', 'ncoghlan', 'ajaksu2', 'gpolo', 'roger.serwy', 'cheryl.sabella']
pr_nums = ['2573', '3702']
priority = 'high'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue1612262'
versions = ['Python 3.6', 'Python 3.7']

If I define a class within a class, like this:

class A:
    class B:
        pass
    
    def foo(self):
        pass

The class browser shows that A contains foo, but it doesn't show B at all.

Confirmed on trunk and py3k.

The class browser relies on the pyclbr module to scan the code. This
module doesn't support classes within classes. Both pyclbr and IDLE's
class browser need to be modified.

The attached patch adds support for nested objects in pyclbr and also in
ClassBrowser.

I have yet to find an optimal way to test this on test_pyclbr (I did
some things here, none very nice), so you will notice tests are missing
on this patch.

I've removed the previous patch from here and attached an updated one on
bpo-6691.

Now the patch attached here only contains changes related to
idlelib.ClassBrowser.

Class Browser is now a module browser as it includes functions not in classes. I guess pyclbr does this. Enhancing this for current versions would require adding a private copy of enhanced pyclbr to idlelib.

I believe the patch for bpo-6691 will also add detection of nested functions. If so, the IDLE patch must also make use of that new information.

If the patch for bpo-6691 is only applied to 3.7, I want to put a temporary copy of the revised pyclbr in 3.6 idlelib, perhaps as _pyclbr, and change the 3.6 import accordingly.

I created bpo-30881 to add docstrings to browser.py to make creating user tests easier.

I added a more complete set of unit tests to the PR.

Nick, this over-due improvement to IDLE depends on the over-due improvement to pyclbr in 3.7. I would like to backport the IDLE improvement by putting a copy of 3.7 pyclbr in 3.6 idlelib. Do you agree that PEP-434 allows this?

Would it make any difference if the module were renamed? and made to only work with IDLE?

I think a bundled copy as idlelib._pyclbr in the 3.6 branch would be within the intent of PEP-434.

I am revising the codecontext patch to use comprehensions and the sort key option. I will rename the new function 'collect_objects' (GPolo) / '_traverse_node' (CSabella) as 'list_children' and have it return the name-object list, ordered by line number, needed by the tree widget.

[The input is a dictionary of children of a node, rather than a node, because pyclbr returns the dictionary of the children of the root module node of the tree, rather than a root node itself. Sorting is not actually needed for 3.6/7 because the dicts are already ordered, but pyclbr does not guarantee this by using OrderedDict. Proposing these two changes is a separate potential issue.]

New changeset 058de11 by Terry Jan Reedy (Cheryl Sabella) in branch 'master':
bpo-1612262: IDLE: Class Browser shows nested functions, classes (bpo-2573)
058de11

New changeset fa1cae5 by Terry Jan Reedy in branch '3.6':
[3.6] bpo-1612262: IDLE: Class Browser shows nested functions, classes (GH-2573) (bpo-3702)
fa1cae5

I settled on 'transform_children' for the new function. bpo-31461 is the master issue for improving the browsers.

Navigation Menu

Repository navigation

IDLE: Include nested functions and classes in module browser #44322

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

IDLE: Include nested functions and classes in module browser #44322

Description

Activity

taleinat commented on Dec 9, 2006

devdanzin commented on Mar 30, 2009

serwy commented on Jun 20, 2009

gpolo commented on Aug 12, 2009

gpolo commented on Aug 12, 2009

terryjreedy commented on Sep 14, 2015

terryjreedy commented on Jun 29, 2017

csabella commented on Jul 9, 2017

csabella commented on Aug 5, 2017

terryjreedy commented on Sep 12, 2017

terryjreedy commented on Sep 12, 2017

ncoghlan commented on Sep 12, 2017

terryjreedy commented on Sep 21, 2017

terryjreedy commented on Sep 22, 2017

terryjreedy commented on Sep 22, 2017

terryjreedy commented on Sep 22, 2017

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions