Add link to error message if validation err 8000 or occurs #3530
Merged
Conversation
This file contains hidden or 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
balloob
reviewed
Sep 27, 2016
8000
| @@ -408,6 +409,9 @@ def log_exception(ex, domain, config): | |||
| message += " (See {}:{})".format(config.__config_file__, | |||
| config.__line__ or '?') | |||
|
|
|||
| message += '. Please check the docs at ' | |||
There was a problem hiding this comment.
We should not append this to the message when domain == 'homeassistant'
balloob
reviewed
Sep 27, 2016
| @@ -408,6 +409,9 @@ def log_exception(ex, domain, config): | |||
| message += " (See {}:{})".format(config.__config_file__, | |||
| config.__line__ or '?') | |||
|
|
|||
| message += '. Please check the docs at ' | |||
| message += 'https://home-assistant.io/components/{}/ '.format(domain) | |||
There was a problem hiding this comment.
Can you make it 1 string concatenation instead of 2 (slightly better performance). Python has implicit string concatenation within parentheses:
if domain != 'homeassistant':
message += ('. Please check the docs at '
'https://home-assistant.io/components/{}/ '.format(domain))
balloob
reviewed
Sep 27, 2016
| @@ -408,6 +409,10 @@ def log_exception(ex, domain, config): | |||
| message += " (See {}:{})".format(config.__config_file__, | |||
| config.__line__ or '?') | |||
|
|
|||
| if domain != 'homeassistant': | |||
| message += ('. Please check the docs at ' | |||
There was a problem hiding this comment.
You will an extra period if extra keys not allowed is NOT in ex.error_message
There was a problem hiding this comment.
I reviewed the adding of periods. The output will look like the samples below.
16-09-28 00:29:38 ERROR (MainThread) [homeassistant.bootstrap] Invalid config for [homeassistant]: expected int for dictionary value @ data['elevation']. Got 'abcd'. (See /home/fab/.homeassistant/configuration.yaml:3)
16-09-28 00:30:24 ERROR (Thread-1) [homeassistant.bootstrap] Invalid config for [http]: [api_password1] is an invalid option for [http]. Check: http->http->api_password1. Please check the docs at https://home-assistant.io/components/http/
16-09-28 00:31:07 ERROR (Thread-1) [homeassistant.bootstrap] Invalid config for [zone]: expected float for dictionary value @ data['radius']. Got {}. Please check the docs at https://home-assistant.io/components/zone/
16-09-28 00:32:40 ERROR (Thread-1) [homeassistant.bootstrap] Invalid config for [lock.mqtt]: [name1] is an invalid option for [lock.mqtt]. Check: lock.mqtt->name1. Please check the docs at https://home-assistant.io/components/lock.mqtt/
2 tasks
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.
Description:
Add the link to the documentation to the error message.
Related issue (if applicable): fixes https://www.pivotaltracker.com/story/show/130296315
Example entry for
configuration.yaml(if applicable):Checklist:
If the code does not interact with devices:
toxrun successfully. Your PR cannot be merged unless tests pass