Add config flow to linky

[Quentame]

Breaking Change:

Linky platform moved to integration.

configuration.yaml before :

sensor:
  - platform: linky
    username: __email__
    password: __password__

After :

linky:
  - username: __email__
    password: __password__

Documentation updated : home-assistant/home-assistant.io#10284

Description:

Hi !

Just adding Linky a config flow, but I need some help for 3 things.

I am still learning Python with you guys, while coding for HA ... everyone is pleased to make a review, go for it ! (with cool links if it's something tricky, that would be nice 👍)

I made _LOGGER.error to see it better, screenshots will illustrate 😉 with the actual code.

1 : Make the component actually retrieving the data without stop HA boot

I mean, it's the same working retrieve data code, but the async and timeout part makes it not working I think.

So I got a RuntimeError: cannot be called from within the event loop caused by run_callback_threadsafe call in a async method, then the sensors aren't created.

Actually HA is booting because the sensors try to be added after HA starts with a listener and async_start callback, but without it's not, and no logs are coming.

See the logs, at HA starts (the only way the retrieve the data for now)

This first point should be though with point 2 in mind ⬇️

• fixed

2 : Add the Linky sensors directly after adding the integration by the user in the config flow (not only at boot)

I know that it should be added in async_setup_entry but if I do so, it is gonna block HA start and Linky's data are never gonna be retrieved. That's why there is an async_start.

So I get those logs right after adding my integration :

But no sensors.

• fixed

3 : Here it's more a question but it will permits much less duplicated code

Can/Should I display "computed" errors to the user ? (one's that are not in the strings.json file)

I'am telling that because the LinkyClient can raise multiple functional errors, but they got all the same type PyLinkyError.

PyLinkyErroris raised for (quoting the pylinky lib) :

1. raise PyLinkyError("Can not submit login form")
2. raise PyLinkyError("Login error: Please check your username/password.")
3. raise PyLinkyError("Could not access enedis.fr: " + str(e))
4. raise PyLinkyError("No data")
5. raise PyLinkyError("Site in maintenance")
6. raise PyLinkyError("Impossible to decode response: " + str(e) + "\nResponse was: " + str(raw_res.text))
7. raise PyLinkyError("Enedis.fr answered with an error: " + str(json_output))

So how should I tell the user he has a wrong password ? or if the website is in maintenance and retry later ?

I come up this 3 ideas :

1. Display the message as it is (but meaning no translation)
2. Parse the message (no future proof at all)
3. Change the lib to raise specific Exceptions, wait until the approval and release, update the lib and add specific translations for every exceptions (might be very long)
4. Just say the user to verify its credentials and if the website isn't in maintenance and retry (all in one but not precise and accurate for the user)

• fixed

@MartinHjelmare, if you have some time I will appreciate.

Thanks a lot !

PS : config flow inspired with AdGuard Home (Config flow file, by @frenck) and Cert Expiry (still in PR #25624 by @cereal2nd) code.

---

Pull request with documentation for home-assistant.io (if applicable): home-assistant/home-assistant.io#<home-assistant.io PR number goes here>

Not yet

[Quentame]

I actually get the same issue to make iCloud a config flow.

The integration is added to HA, then, when adding all the platforms, the device_tracker calculate the interval with the current zone and other zone distances, which uses run_callback_threadsafe.

[MartinHjelmare]

Blocking I/O in coroutines, in the event loop, will block the whole home assistant app.

[Quentame]

Ok, now the sensors are added

Exemple

So the integration is like

But the integration is saying there is not devices (platforms), and it should display the sensors, working on it.

I should use ConfigEntry, right ?

[MartinHjelmare]

Devices will show for the config entry if we implement device_info property for the entities. Please do that in a separate PR later.

https://developers.home-assistant.io/docs/en/device_registry_index.html

[Quentame]

How can I see that's wrong with my pipeline ?

Can't find it.

[MartinHjelmare]

Just run black from the project root and commit the changes:

black --fast homeassistant tests

[Quentame]

Response to : #26076 (comment)

black --fast homeassistant tests isn't working on my machine (MacOS 10.14.6) or venv.

I get a "command not found error" on both.

Nothing helped in Set up Development Environment and Testing your code of the developer documentation.

[MartinHjelmare]

Install black.

https://pypi.org/project/black/

[Quentame]

Yep, naturally ... found it odd to be a beta

[Quentame]

pyLinky 0.4.0 just released with my PR into it, that was fast !
It's gonna be better to handle user feedbacks.

https://github.com/Pirionfr/pyLinky/releases/tag/v0.4.0

[Quentame]

I've fixed all reviews, so what's next ? Clicking on "Ready for review" button in order to be merged or open a new PR ?

For me, it misses 2 PRs : add device_info to add devices for the config flow integration + translate the component to French (since the service is only available in France).

[MartinHjelmare]

Don't open a new PR. Just click ready for review.

[Quentame]

Tested with :

• config flow good credentials
• config flow fake credentials
• config flow Enedis technical issue
• config flow existing username
• import unique username
• import Enedis technical issue
• import existing username
• unit test

Component documentation needs to be updated

[MartinHjelmare]

Add pylinky to the TEST_REQUIREMENTS tuple in gen_requirements_all.py script to make the package available during tests.

[Quentame]

Working on tests ...

[MartinHjelmare]

Looks good!

[MartinHjelmare]

Can be merged when build passes.

[MartinHjelmare]

Please don't squash commits after review has started to make it easier for readers to track changes.

[Quentame]

Ok will do, habits.

When I do tox -e py37 -- tests/components/linky/test_config_flow.py I got :

How can I fix this ?

[MartinHjelmare]

Have you rebuilt the tox environment, -r?

[Quentame]

tox -r command :

[MartinHjelmare]

There's too little information in that log excerpt for me to say anything about.

[Quentame]

Ups, wrong image, updated #26076 (comment)

[MartinHjelmare]

Doesn't help, sorry. You can check the tox file logs and see if they say anything more.

[MartinHjelmare]

Good!