-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
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
Add check for integration config schema to hassfest #93587
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced May 26, 2023
epenet
reviewed
May 26, 2023
This was referenced May 26, 2023
472a79f
to
0a918f1
Compare
epenet
reviewed
May 29, 2023
This was referenced May 31, 2023
36f9505
to
0765fbd
Compare
This was referenced Jun 1, 2023
7abffdd
to
11657fd
Compare
20 tasks
This was referenced Jun 2, 2023
Co-authored-by: epenet <[email protected]>
f1ed98c
to
b461faa
Compare
frenck
approved these changes
Jun 12, 2023
mover85
pushed a commit
to mover85/core
that referenced
this pull request
Jun 12, 2023
…3587) Co-authored-by: epenet <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Add check for integration config schema to hassfest
Background:
Integrations which can be setup via YAML but don't support any configuration parameters commonly don't declare any CONFIG_SCHEMA. This means useless configurations such as this won't be warned against:
Also, there is no warning if integrations which can not be setup via YAML are referenced in the configuration.
There are two cases, integrations which define an
async_setup
orsetup
but can't be setup via YAML and integrations which don't declareasync_setup
orsetup
.Suggestion:
async_setup
orsetup
has either ofCONFIG_SCHEMA
,PLATFORM_SCHEMA
,PLATFORM_SCHEMA_BASE
or aconfig
platformapi
), or a schema which logs a warning / repair saying yaml configuration is not supported (for examplediscord
)Updating integrations will be handled in separate PRs
async_setup
orsetup
but are referenced in the config we log a warning / repairType of change
Additional information
Checklist
black --fast homeassistant tests
)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest
.requirements_all.txt
.Updated by running
python3 -m script.gen_requirements_all
..coveragerc
.To help with the load of incoming pull requests: