Feature/gui get

[krisgesling]

Description

Currently if a Skill attempts to access a value on the GUI interface that doesn't exist a KeyError will be raised.

This implements the Pythonic behaviour of a dict.get() method to provide a safer mechanism for accessing those keys including an optional parameter for returning a default value.

While there, I added some extra unittests for the SkillGUI class.

How to test

Unit tests included. Or you can drop the following into a Skills initialize method

        self.gui['some'] = 'value'
        self.log.info(self.gui['some'])
        self.log.info(self.gui.get('thing', "WORKING"))
        self.log.info(self.gui['thing'])  # Raises KeyError

Contributor license agreement signed?

• CLA (Whether you have signed a CLA - Contributor Licensing Agreement

[devops-mycroft]

Voight Kampff Integration Test Failed (Results).
Mycroft logs are also available: skills.log, audio.log, voice.log, bus.log, enclosure.log

[devops-mycroft]

Voight Kampff Integration Test Succeeded (Results)

[forslund]

Looks good. For some history, this was originally left out to make the class as different as possible to the standard dict since we didn't wish to implement it fully. For example it has no __in__() or iterator methods and merge operations can't be performed, etc.

I would encourage to also add at least __in__() and possibly the iter methods.

edit:
in is implemented it's __contains__() not __in__(), My bad

[forslund]

Suggestion:

Instead of this implementation just forward to __session_data.get

    def get(self, *args, **kwargs):
        return self.__session_data.get(*args, **kwargs)

[krisgesling]

I changed to your suggested implementation and thought of adding __iter__ however then I started wondering about keys, items, values, pop, etc.

So I thought it worth deciding what we really want here and whether it would be easier to inherit from dict rather than re-adding everything or if that will introduce it's own strange behaviour.

[devops-mycroft]

Voight Kampff Integration Test Failed (Results).
Mycroft logs are also available: skills.log, audio.log, voice.log, bus.log, enclosure.log

[forslund]

Indeed, this was what we thought when we created it. Limit it to the basics and then if needed make it a subclass of dict.

[devops-mycroft]

Voight Kampff Integration Test Succeeded (Results)