Filter Members Exposed via Control Interface

[MikeHart85]

Fixes #194.

Filters members exposed by default (not overridden via the members param) via ExposedObject.

Members filtered, in addition to the previous "starting with _" condition, are anything defined or inherited in Device or StateMachineDevice and specifically "log".

log had to be done explicitly since it is added dynamically by a decorator.

Also fixed an error in control.py... not sure how that slipped past both of us! 😆

[MichaelWedel]

I tested a bit and found that now all the values are gone from lewis-control (see the comment above).

Also, the unit tests for ExposedObject need to be updated.

[MichaelWedel]

Good catch, really weird that we did not see it earlier. But it's not enough to just change this, now all the values are gone if the string is below 40 characters. It took me a while to see that and I still don't quite understand what's going on,

[MikeHart85]

What you describe is the behaviour I was getting before making this change... it's exactly what it's supposed to fix (:40 means "from beginning to index 40", 40: means "from index 40 to end").

Are you sure you're using the correct version of lewis-control?

If you have lewis installed, you have to be careful to use $ ./lewis-control.py, and not simply $ lewis-control... otherwise you're using the installed version without this change. I think this may also be how this slipped passed us in the first place?

[MichaelWedel]

You might be right, I just tried again on a different machine being careful to use the right script. So forget everything I wrote except for "good catch" and add another "good catch".

[MichaelWedel]

I don't think getting the device bases classes and 'log' in here is necessary, it just makes the control_server depend on this one very specific thing. I played around a bit and I think it can be made entirely general, what do you think about this:

    def __init__(self, obj, members=None, exclude=None, expose_bases=False):
        super(ExposedObject, self).__init__()

        self._object = obj
        self._function_map = {}

        self._add_function(':api', self.get_api)

        exposed_members = members if members else self._public_members()
        exclude_final = list(exclude or []) + dir(inspect.getmro(type(obj))[1]) if not expose_bases else []

        for method in exposed_members:
            if not exclude_final or method not in exclude_final:
                self._add_member_wrappers(method)

This automatically catches 'log' for all subclasses of DeviceBase because it's in the dict of that type. For simulation and interfaces it's necessary to list 'log' in Simulation explicitly where they are exposed, but in my opinion that's the "lesser evil", because it keeps ExposedObject general.

[MikeHart85]

Great review suggestion!

Made updates accordingly, with some tweaks as discussed on slack.