Repository: home-assistant/core
Pull request: Create abstraction for Generic YeeLight
<!--
  You are amazing! Thanks for contributing to our project!
  Please, DO NOT DELETE ANY TEXT from this template! (unless instructed).
-->
## Proposed change
<!--
  Describe the big picture of your changes here to communicate to the
  maintainers why we should accept this pull request. If it fixes a bug
  or resolves a feature request, be sure to link to that issue in the
  additional information section.
-->
Create abstraction for Generic YeeLight to fix entity naming

## Type of change
<!--
  What type of change does your PR introduce to Home Assistant?
  NOTE: Please, check only 1! box!
  If your PR requires multiple boxes to be checked, you'll most likely need to
  split it into multiple PRs. This makes things easier and faster to code review.
-->

- [ ] Dependency upgrade
- [x] 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
<!--
  Details are important, and help maintainers processing your PR.
  Please be sure to fill out additional details, if applicable.
-->

- This PR fixes or closes issue: fixes #97922
- This PR is related to issue: 
- Link to documentation pull request: 

## Checklist
<!--
  Put an `x` in the boxes that apply. You can also fill these out after
  creating the PR. If you're unsure about any of them, don't hesitate to ask.
  We're here to help! This is simply a reminder of what we are going to look
  for before merging your code.
-->

- [ ] The code change is tested and works locally.
- [x] Local tests pass. **Your PR cannot be merged unless tests pass**
- [x] There is no commented out code in this PR.
- [x] I have followed the [development checklist][dev-checklist]
- [x] I have followed the [perfect PR recommendations][perfect-pr]
- [x] 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:

- [ ] Documentation added/updated for [www.home-assistant.io][docs-repository]

If the code communicates with devices, web services, or third-party tools:

- [ ] The [manifest file][manifest-docs] 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`.

<!--
  This project is very active and we have a high turnover of pull requests.

  Unfortunately, the number of incoming pull requests is higher than what our
  reviewers can review and merge so there is a long backlog of pull requests
  waiting for review. You can help here!
  
  By reviewing another pull request, you will help raise the code quality of
  that pull request and the final review will be faster. This way the general
  pace of pull request reviews will go up and your wait time will go down.
  
  When picking a pull request to review, try to choose one that hasn't yet
  been reviewed.

  Thanks for helping out!
-->

To help with the load of incoming pull requests:

- [ ] I have reviewed two other [open pull requests][prs] in this repository.

[prs]: https://github.com/home-assistant/core/pulls?q=is%3Aopen+is%3Apr+-author%3A%40me+-draft%3Atrue+-label%3Awaiting-for-upstream+sort%3Acreated-desc+review%3Anone+-status%3Afailure

<!--
  Thank you for contributing <3

  Below, some useful links you could explore:
-->
[dev-checklist]: https://developers.home-assistant.io/docs/development_checklist/
[manifest-docs]: https://developers.home-assistant.io/docs/creating_integration_manifest/
[quality-scale]: https://developers.home-assistant.io/docs/integration_quality_scale_index/
[docs-repository]: https://github.com/home-assistant/home-assistant.io
[perfect-pr]: https://developers.home-assistant.io/docs/review-process/#creating-the-perfect-pr


Problem statement:
yeelight integration failed using proper name convention
### The problem

Entity None (<class 'homeassistant.components.yeelight.light.YeelightGenericLight'>) is implicitly using device name by not setting its name. Instead, the name should be set to None,

### What version of Home Assistant Core has the issue?

2023.8.1

### What was the last working version of Home Assistant Core?

2023.7.3

### What type of installation are you running?

Home Assistant OS

### Integration causing the issue

yeelight

### Link to integration documentation on our website

_No response_

### Diagnostics information

Logger: homeassistant.helpers.entity
Source: helpers/entity.py:375
First occurred: 12:39:21 (1 occurrences)
Last logged: 12:39:21

### Example YAML snippet

```yaml
.
```


### Anything in the logs that might be useful for us?

```txt
.
```


### Additional information

.

Hints from issue discussion:
Hey there @zewelor, @shenxn, @starkillerog, @alexyao2015, mind taking a look at this issue as it has been labeled with an integration (`yeelight`) you are listed as a [code owner](https://github.com/home-assistant/core/blob/dev/CODEOWNERS#L1439) for? Thanks!

<details>
<summary>Code owner commands</summary>


Code owners of `yeelight` can trigger bot actions by commenting:

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

</details>


<sub><sup>(message by CodeOwnersMention)</sup></sub>

---

[yeelight documentation](https://www.home-assistant.io/integrations/yeelight)
[yeelight source](https://github.com/home-assistant/core/tree/dev/homeassistant/components/yeelight)
<sub><sup>(message by IssueLinks)</sup></sub>
Same error started with 2023.8.0, but it was supposed to be solved by[https://github.com/home-assistant/core/pull/97649](url), but I saw the same error under 2023.8.1

Commit message: Create abstraction for Generic YeeLight

Patch to review:
diff --git a/homeassistant/components/yeelight/light.py b/homeassistant/components/yeelight/light.py
index f5f39e9997d07..8f8a8d78f8322 100644
--- a/homeassistant/components/yeelight/light.py
+++ b/homeassistant/components/yeelight/light.py
@@ -238,7 +238,7 @@ def _parse_custom_effects(effects_config) -> dict[str, dict[str, Any]]:
 def _async_cmd(func):
     """Define a wrapper to catch exceptions from the bulb."""
 
-    async def _async_wrap(self: YeelightGenericLight, *args, **kwargs):
+    async def _async_wrap(self: YeelightBaseLight, *args, **kwargs):
         for attempts in range(2):
             try:
                 _LOGGER.debug("Calling %s with %s %s", func, args, kwargs)
@@ -291,7 +291,7 @@ def _lights_setup_helper(klass):
         lights.append(klass(device, config_entry, custom_effects=custom_effects))
 
     if device_type == BulbType.White:
-        _lights_setup_helper(YeelightGenericLight)
+        _lights_setup_helper(YeeLightGenericLight)
     elif device_type == BulbType.Color:
         if nl_switch_light and device.is_nightlight_supported:
             _lights_setup_helper(YeelightColorLightWithNightlightSwitch)
@@ -312,7 +312,7 @@ def _lights_setup_helper(klass):
             _lights_setup_helper(YeelightWithAmbientWithoutNightlight)
         _lights_setup_helper(YeelightAmbientLight)
     else:
-        _lights_setup_helper(YeelightGenericLight)
+        _lights_setup_helper(YeeLightGenericLight)
         _LOGGER.warning(
             "Cannot determine device type for %s, %s. Falling back to white only",
             device.host,
@@ -403,8 +403,8 @@ async def _async_set_auto_delay_off_scene(entity, service_call):
     )
 
 
-class YeelightGenericLight(YeelightEntity, LightEntity):
-    """Representation of a Yeelight generic light."""
+class YeelightBaseLight(YeelightEntity, LightEntity):
+    """Abstract Yeelight light."""
 
     _attr_color_mode = ColorMode.BRIGHTNESS
     _attr_supported_color_modes = {ColorMode.BRIGHTNESS}
@@ -861,7 +861,13 @@ async def async_set_scene(self, scene_class, *args):
         await self._bulb.async_set_scene(scene_class, *args)
 
 
-class YeelightColorLightSupport(YeelightGenericLight):
+class YeeLightGenericLight(YeelightBaseLight):
+    """Representation of a generic YeeLight."""
+
+    _attr_name = None
+
+
+class YeelightColorLightSupport(YeelightBaseLight):
     """Representation of a Color Yeelight light support."""
 
     _attr_supported_color_modes = {ColorMode.COLOR_TEMP, ColorMode.HS, ColorMode.RGB}
@@ -884,7 +890,7 @@ def _predefined_effects(self) -> list[str]:
         return YEELIGHT_COLOR_EFFECT_LIST
 
 
-class YeelightWhiteTempLightSupport(YeelightGenericLight):
+class YeelightWhiteTempLightSupport(YeelightBaseLight):
     """Representation of a White temp Yeelight light."""
 
     _attr_name = None
@@ -904,7 +910,7 @@ def _turn_on_power_mode(self) -> PowerMode:
         return PowerMode.NORMAL
 
 
-class YeelightWithoutNightlightSwitchMixIn(YeelightGenericLight):
+class YeelightWithoutNightlightSwitchMixIn(YeelightBaseLight):
     """A mix-in for yeelights without a nightlight switch."""
 
     @property
@@ -940,7 +946,7 @@ class YeelightColorLightWithoutNightlightSwitchLight(
 
 
 class YeelightColorLightWithNightlightSwitch(
-    YeelightNightLightSupport, YeelightColorLightSupport, YeelightGenericLight
+    YeelightNightLightSupport, YeelightColorLightSupport, YeelightBaseLight
 ):
     """Representation of a Yeelight with rgb support and nightlight.
 
@@ -964,7 +970,7 @@ class YeelightWhiteTempWithoutNightlightSwitch(
 
 
 class YeelightWithNightLight(
-    YeelightNightLightSupport, YeelightWhiteTempLightSupport, YeelightGenericLight
+    YeelightNightLightSupport, YeelightWhiteTempLightSupport, YeelightBaseLight
 ):
     """Representation of a Yeelight with temp only support and nightlight.
 
@@ -979,7 +985,7 @@ def is_on(self) -> bool:
         return super().is_on and not self.device.is_nightlight_enabled
 
 
-class YeelightNightLightMode(YeelightGenericLight):
+class YeelightNightLightMode(YeelightBaseLight):
     """Representation of a Yeelight when in nightlight mode."""
 
     _attr_color_mode = ColorMode.BRIGHTNESS


Code review comments:
diff_hunk: @@ -291,7 +291,7 @@ def _lights_setup_helper(klass):
         lights.append(klass(device, config_entry, custom_effects=custom_effects))
 
     if device_type == BulbType.White:
-        _lights_setup_helper(YeelightGenericLight)
+        _lights_setup_helper(YeeLightGenericLight)
path: homeassistant/components/yeelight/light.py
text: @user1:
Why change the case here?

@author:
Oh lol, force of habit.