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

Migrate EAFM to has entity name #98121

Merged
merged 1 commit into from Aug 9, 2023

Conversation

joostlek
Copy link
Member

@joostlek joostlek commented Aug 9, 2023

Proposed change

Migrate EAFM to has entity name

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

home-assistant bot commented Aug 9, 2023

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

Code owner commands

Code owners of eafm 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 eafm Removes the current integration label and assignees on the pull request, add the integration domain after the command.

Copy link
Member

@Jc2k Jc2k left a comment

Choose a reason for hiding this comment

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

Is it required to set _attr_name to None? (Just want to be sure that's not the default or anything, otherwise this looks good if CI is happy).

@joostlek
Copy link
Member Author

joostlek commented Aug 9, 2023

Is it required to set _attr_name to None? (Just want to be sure that's not the default or anything, otherwise this looks good if CI is happy).

When you set _attr_name to None, it will explicitly use the name of the device as entity name.

And since the device name was already the name of the entity, this doesn't change anything more.

I believe the best benefit you get from this change is that if you edit your device name, your entity name changes as well

@Jc2k
Copy link
Member

Jc2k commented Aug 9, 2023

I thought setting has_entity_name and not defining self.name was enough but it's been a while, so wanted to check.

@joostlek
Copy link
Member Author

joostlek commented Aug 9, 2023

I think in .6 or .7 they added a log message warning that the device name is set as the entity name implicitly and that they should open an issue.

Found an example:
Entity None (<class 'homeassistant.components.tuya.switch.TuyaSwitchEntity'>) is implicitly using device name by not setting its name. Instead, the name should be set to None, please create a bug report at https://github.com/home-assistant/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22integration%3A+tuya%22

@Jc2k
Copy link
Member

Jc2k commented Aug 9, 2023

Lovely thanks for checking!

@joostlek joostlek merged commit 138854a into home-assistant:dev Aug 9, 2023
21 checks passed
@joostlek joostlek deleted the eafm_entity_name branch August 9, 2023 15:44
@github-actions github-actions bot locked and limited conversation to collaborators Aug 10, 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