compiler module deprecated

[metakermit]

Currently raises ImportError on Python 3.

As mentioned here, the module's functionality should be replaced with one of these:

• compile
• ast

[pv]

Those are used only in the traits and phantom_import sphinx plugins. If you don't use them, you are fine.

IIRC, porting those modules from compiler is not completely straightforward, so I left it to someone who actually uses them.

[metakermit]

I'm trying to dig into them. Does anyone maybe know more about these traits (comment_eater.get_class_traits in specific)? I don't see it documented or tested. From what I saw, it parses the top-level assignments in a class, but I can't figure out what doc is it trying to get. For example for this class:

class Bla(object):
    ''' class description '''
    # before
    a = 7 # same line
    # after

it still only returns doc='':

In [2]: list(get_class_traits(Bla))
Out[2]: [('a', '7', '')]

[rkern]

It's for documenting HasTraits subclasses that typically look like this:

from traits.api import Float, HasTraits

class Position(HasTraits):
    # The X coordinate.
    x = Float(10.0)

    # The Y coordinate.
    y = Float(20.0)

I'm not entirely sure why it got pushed up into numpydoc.

[metakermit]

Thanks @rkern. Think I understand the idea now. I guess it's in numpydoc, because it should work for any class (nothing from traits.api is imported).

Think I also found a bug in the current implementation - search_for_comment should state block = self.index.get(lineno - 1, None) instead of just lineno. I'll send a PR once I manage to use ast.

[rkern]

comment_eater is only used in traitsdoc which, while it does not import traits itself, does only work for HasTraits subclasses by checking the names of the superclasses.

Thanks for updating all this! We've just got traits ported to Python 3 and this will be very nice to have working there.