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

Improve formatting of config validation errors #103957

Merged
merged 2 commits into from Nov 14, 2023

Conversation

emontnemery
Copy link
Contributor

Proposed change

Improve formatting of config validation errors:

With this PR:

Invalid config for [iot_domain.non_adr_0007] at configuration.yaml, line 7: expected str for dictionary value 'option1', got 123.
Invalid config for [iot_domain] at configuration.yaml, line 9: required key not provided 'platform', got None.
Invalid config for [adr_0007_2] at configuration.yaml, line 16: required key not provided 'adr_0007_2->host', got None.
Invalid config for [adr_0007_3] at configuration.yaml, line 21: expected int for dictionary value 'adr_0007_3->port', got 'foo'.

Without this PR:

Invalid config for [iot_domain.non_adr_0007] at configuration.yaml, line 7: expected str for dictionary value @ data['option1']. Got 123.",
Invalid config for [iot_domain] at configuration.yaml, line 9: required key not provided @ data['platform']. Got None.
Invalid config for [adr_0007_2] at configuration.yaml, line 16: required key not provided @ data['adr_0007_2']['host']. Got None.
Invalid config for [adr_0007_3] at configuration.yaml, line 21: expected int for dictionary value @ data['adr_0007_3']['port']. Got 'foo'.

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:

@home-assistant
Copy link

Hey there @PhracturedBlue, @tetienne, @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (template) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of template can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign template Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@emontnemery
Copy link
Contributor Author

Note: This PR will need to be rebased once #103959 is merged

@MartinHjelmare
Copy link
Member

Do you have a preferred order of merging of these PRs?

is to format the path delimited by -> instead of @data[].
"""
path = "->".join(str(m) for m in ex.path)
output = Exception.__str__(ex)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
output = Exception.__str__(ex)
output = str(ex)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That won't work because this function is meant as an alternative to the stringification done by vol.Invalid.__str__. I'll add a comment explaining this.

Copy link
Member

Choose a reason for hiding this comment

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

We'll explain this further in a follow up.

homeassistant/config.py Outdated Show resolved Hide resolved
homeassistant/config.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft November 14, 2023 10:17
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@emontnemery
Copy link
Contributor Author

emontnemery commented Nov 14, 2023

Do you have a preferred order of merging of these PRs?

Yes, I want to merge #103959 before this one. PR #103955 is also related, but should not cause any conflicts.

@emontnemery emontnemery force-pushed the config_errors_improve_formatting branch from dca3b8e to 3c2992b Compare November 14, 2023 10:46
@emontnemery emontnemery marked this pull request as ready for review November 14, 2023 10:49
@MartinHjelmare MartinHjelmare merged commit 94a2087 into dev Nov 14, 2023
53 checks passed
@MartinHjelmare MartinHjelmare deleted the config_errors_improve_formatting branch November 14, 2023 11:48
@github-actions github-actions bot locked and limited conversation to collaborators Nov 15, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants