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 entity base class in Habitica integration #121320

Merged
merged 5 commits into from
Jul 8, 2024

Conversation

tr4nt0r
Copy link
Contributor

@tr4nt0r tr4nt0r commented Jul 5, 2024

Proposed change

This introduces a base class for all entities to reduce code duplication:

  • Refactoring of the sensor platform to be able to use base entity and reduce code duplication.
  • Replaced previous method of recursively walking over the dictionary tree to access sensor values with a simple lambda function
  • Moved DeviceInfo to the base class to reduce repetition of code
  • Changed the task sensors to use the base class and added entity_description, which also reduces some duplicate code

Edit 1: Updated todos to also use the base entity class
Edit 2: Updated button platform to use the entity base class
Edit 3: Updated switch platform to use the entity base class

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 Ruff (ruff format 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Jul 5, 2024

Hey there @ASMfreaK, @leikoilja, mind taking a look at this pull request as it has been labeled with an integration (habitica) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of habitica 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 habitica Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Jul 5, 2024
@tr4nt0r tr4nt0r marked this pull request as draft July 7, 2024 16:10
@tr4nt0r tr4nt0r force-pushed the sensor_platform_refactoring branch from 4489aec to 38e23f5 Compare July 7, 2024 16:33
@tr4nt0r tr4nt0r marked this pull request as ready for review July 7, 2024 17:26
@tr4nt0r tr4nt0r changed the title Refactor sensor platform in Habitica integration Add entity base class in Habitica integration Jul 7, 2024
homeassistant/components/habitica/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/habitica/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/habitica/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/habitica/sensor.py Show resolved Hide resolved
@home-assistant
Copy link

home-assistant bot commented Jul 7, 2024

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.

@home-assistant home-assistant bot marked this pull request as draft July 7, 2024 20:59
@tr4nt0r tr4nt0r marked this pull request as ready for review July 7, 2024 22:12
@home-assistant home-assistant bot requested a review from joostlek July 7, 2024 22:12
@tr4nt0r tr4nt0r force-pushed the sensor_platform_refactoring branch from 12fdbaa to 0a4b71b Compare July 8, 2024 07:26
@tr4nt0r tr4nt0r force-pushed the sensor_platform_refactoring branch from 0a4b71b to 092423d Compare July 8, 2024 08:07
@joostlek joostlek merged commit 00aafc0 into home-assistant:dev Jul 8, 2024
26 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jul 9, 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