Fix async IO in Sesame lock component.

[veleek]

Description:

Switch Sesame lock component to use async_add_devices and force the object to cache all it's properties. Unless someone manually overrides the value of use_cached_state on the internal sesame instance there will be no async IO in the component properties.

Checklist:

If the code communicates with devices, web services, or third-party tools:

• Local tests with tox run successfully. Your PR cannot be merged unless tests pass
• New dependencies have been added to the REQUIREMENTS variable ([example][ex-requir]).
• New dependencies are only imported inside functions that use them ([example][ex-import]).
• New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
• New files were added to .coveragerc.

[homeassistant]

Hi @veleek,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

[houndci-bot]

trailing whitespace

[houndci-bot]

trailing whitespace

[emlove]

Also, please get rid of the phrase "fixes #4210" from the PR description, or that issue will be closed when this is merged.

[emlove]

Don't switch to async_setup_platform. This isn't an async platform. Adding update_before_add=True should be the only necessary change.

[veleek]

@armills. Got it, so this would only be needed if the actual update methods (and the underlying update in pysesame) was async, correct?

[emlove]

Exactly. You'd need to switch to the async equivalents if you had other async coroutines you needed to call from setup/update on the external lib.

[balloob]

This won't work as properties are always evaluated in an asyncio context. The correct fix is to assign all properties that we want to read from self._sesame to instance variables inside the update method.

[veleek]

@balloob I'm not sure what won't work. Pysesame defines the properties like this:

    @property
    def nickname(self):
        """Return the Sesame nickname."""
        if not self.use_cached_state:
            self.update_state(False)
    return self._nickname

So since I'm adding update_before_add, self.use_cached_state will always be true and it will just return the local value of self._nickname. I guess I'm not sure what you mean by "always evaluated in an asyncio context".

I'm happy to change to caching all of the pysesame properties inside the HA Sesame object, I just want to make sure that I understand why I'm doing it (my first commit to the project an all 😄).

[emlove]

It would be best as @balloob said to use the update method to cache everything into the home assistant class. Although this does correct the problem, it's cleanest not to depend on the upstream behavior of sometimes blocks sometimes returns immediately.

[veleek]

Sounds good. Thanks for the feedback. I'll make the changes.

[emlove]

One small request, otherwise looks great!

[emlove]

Declare these inside of __init__ instead of here. Variables declared under the class are static for all instances of the class. We can get rid of the _sesame = None above as well. Should just look like this in __init__:

self._sesame = sesame
self._device_id = None
self._nickname = None
...