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

[color] Fix crash when hex color parses as int, improve error reporting. #6707

Merged
merged 4 commits into from
May 9, 2024

Conversation

clydebarrow
Copy link
Contributor

What does this implement/fix?

The current color schema has two problems:

  • hex: 800000 causes a config-time crash since the value is parsed as an int:
    if len(value) != 6:
       ^^^^^^^^^^
TypeError: object of type 'EInt' has no len()
  • An invalid hex value gives a misleading message:
  - id: kbx_green

    [hex] is an invalid option for [2]. Please check the indentation.
    hex: F800000

due to the use of cv.Any() which is indiscriminate in its error reporting.

This PR fixes both those.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other

Related issue or feature (if applicable): fixes

Pull request in esphome-docs with documentation (if applicable): esphome/esphome-docs#

Test Environment

  • ESP32
  • ESP32 IDF
  • ESP8266
  • RP2040
  • BK72xx
  • RTL87xx

Example entry for config.yaml:

# Example config.yaml

Checklist:

  • The code change is tested and works locally.
  • Tests have been added to verify that the new code works (under tests/ folder).

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

@codecov-commenter
Copy link

codecov-commenter commented May 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.18%. Comparing base (4d8b5ed) to head (28471fa).
Report is 542 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #6707      +/-   ##
==========================================
+ Coverage   53.70%   54.18%   +0.47%     
==========================================
  Files          50       50              
  Lines        9408     9579     +171     
  Branches     1654     1687      +33     
==========================================
+ Hits         5053     5190     +137     
- Misses       4056     4065       +9     
- Partials      299      324      +25     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@probot-esphome probot-esphome bot removed the small-pr label May 9, 2024
@jesserockz jesserockz added this to the 2024.5.0b3 milestone May 9, 2024
@jesserockz jesserockz enabled auto-merge (squash) May 9, 2024 03:08
@jesserockz jesserockz merged commit 5956beb into esphome:dev May 9, 2024
57 checks passed
@jesserockz jesserockz mentioned this pull request May 9, 2024
@github-actions github-actions bot locked and limited conversation to collaborators May 11, 2024
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

3 participants