Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it possible to set options and system options on entry create #27044

Closed
wants to merge 1 commit into from
Closed

Make it possible to set options and system options on entry create #27044

wants to merge 1 commit into from

Conversation

scop
Copy link
Member

@scop scop commented Sep 29, 2019

Description:

Make it possible to create config entries with an initial set of options and system options. This is especially useful on config import, and for some integrations it would be desirable to disable new entities by default as discussed in #26675.

Related issue (if applicable): #26675, #27612 (alternative approach)

Checklist:

  • The code change is tested and works locally.
  • Local tests pass with tox. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the [development checklist][dev-checklist]

@scop scop requested a review from a team as a code owner September 29, 2019 08:26
@probot-home-assistant probot-home-assistant bot added core small-pr PRs with less than 30 lines. labels Sep 29, 2019
@scop
Copy link
Member Author

scop commented Sep 29, 2019

Not sure if passing through kwargs as is in FlowHandler.async_create_entry is desirable like done here, or of we should override async_create_entry in ConfigFlow and add explicit options and system_options handling there instead. No strong opinions, opted for the former because it's less code :P

@@ -219,6 +220,7 @@ def async_create_entry(
"data": data,
"description": description,
"description_placeholders": description_placeholders,
**kwargs,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not a fan because it feels weird. Data should be the data for the config entry, all other is metadata about the step.

Not sure what the correct thing is .

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whatever way that makes it possible to set disable_new_entities to True for a newly created config entry works for me. I wouldn't want to handle disabling the entities manually, and it would be weird if the UI shows new entities being enabled by default where in fact they are created disabled.

Anyway, not sure I understand your concern, but I do think this (options and system_options) is stuff about the config entry, it's not a step thing. It gets persistent with the config entry, UI shows the new entity enablement toggle for the entry, etc.

Or maybe you're concerned about opening the big kwargs possibility to data_entry_flow? As mentioned, that could be left alone and replaced by doing this in ConfigFlow just for options and system_options.

@scop scop mentioned this pull request Oct 5, 2019
9 tasks
@scop
Copy link
Member Author

scop commented Oct 13, 2019

Alternative approach: #27612

@scop
Copy link
Member Author

scop commented Oct 21, 2019

Withdrawing due to concerns, and #26675 uses a different/selective approach now.

@scop scop closed this Oct 21, 2019
@scop scop deleted the config-entry-initial-options branch October 21, 2019 15:12
@lock lock bot locked and limited conversation to collaborators Oct 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed core invalid small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants