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

Add domain key config validation #104242

Merged
merged 8 commits into from Dec 5, 2023
Merged

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Nov 20, 2023

Proposed change

Use a common validator, cv.domain_key to validate a top level config key with an optional label and return the domain.

A domain is separated from a label by one or more spaces, empty labels are not allowed.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

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

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@emontnemery emontnemery requested a review from a team as a code owner November 20, 2023 09:36
@home-assistant home-assistant bot added cla-signed core small-pr PRs with less than 30 lines. labels Nov 20, 2023
@emontnemery
Copy link
Contributor Author

I'll rework the PR to use the same method everywhere, and it seems the opinion is python is better than regex in this case

@emontnemery emontnemery marked this pull request as draft November 22, 2023 13:04
@emontnemery emontnemery force-pushed the extract_domain_configs_remove_regex branch from 5fb3f67 to f5e5fc3 Compare December 4, 2023 12:09
@emontnemery emontnemery marked this pull request as ready for review December 4, 2023 12:09
@emontnemery emontnemery marked this pull request as draft December 4, 2023 16:45
@emontnemery emontnemery marked this pull request as ready for review December 5, 2023 12:26
@MartinHjelmare MartinHjelmare changed the title Drop use of regex in helpers.extract_domain_configs Add domain key config validation Dec 5, 2023
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Great!

Maybe update the PR description a bit. I changed the PR title.

@emontnemery emontnemery merged commit 3bcc619 into dev Dec 5, 2023
53 checks passed
@emontnemery emontnemery deleted the extract_domain_configs_remove_regex branch December 5, 2023 14:07
@github-actions github-actions bot locked and limited conversation to collaborators Dec 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed core small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants