Replace Entity.device_state_attributes with Entity.extra_state_attributes

[emontnemery]

Proposed change

Replace Entity.device_state_attributes with Entity.extra_state_attributes.
The name device_state_attributes is confusing and the actual device attributes are available from Entity.device_info.

To be backwards compatible, Entity.device_state_attributes is still called if it is implemented and Entity.extra_state_attributes returns None.

Planned follow-up PRs:

• Mark Entity.state_attributes as @final in component base classes
  • Fixed in Mark base components' state_attribute @final, rename others to extra_state_attributes #48161
• Update integrations to override Entity.extra_state_attributes instead of Entity.device_state_attributes
  • Fixed in Update integrations a-e to override extra_state_attributes() #47756, Update integrations f-i to override extra_state_attributes() #47757, Update integrations j-o to override extra_state_attributes() #47758, Update integrations p-s to override extra_state_attributes() #47759, Update integrations t-z to override extra_state_attributes() #47760
• Update integrations to override Entity.extra_state_attributes instead of Entity.state_attributes
  • Fixed in Mark base components' state_attribute @final, rename others to extra_state_attributes #48161

Suggested plan for deprecation:

• Start logging a warning in 2021.6
• Remove backwards compatibility in 2021.10

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)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

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
• 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

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.
• Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

• No score or internal
• 🥈 Silver
• 🥇 Gold
• 🏆 Platinum

To help with the load of incoming pull requests:

• I have reviewed two other open pull requests in this repository.

[frenck]

I think this makes sense, however, this also opens up the opportunity to do something about

state_attributes versus device_state_attributes/entity_state_attributes.

Out developer documentation does not really help either as it seems 😓

And a quick search through our codebase, it is all used mixed up 😢

For example, the twinkly integration actually defines a state_attributes property, while lights is a platform that actually implements that (so it has non-default behavior now, which is not wished for either).

[emontnemery]

this also opens up the opportunity to do something about state_attributes versus device_state_attributes/entity_state_attributes.

You mean integrations which override state_attributes instead of device_state_attributes/entity_state_attributes should be updated? Sure, that should be done as well, but maybe not in this PR?

[frenck]

No, I mean; maybe we can reduce it to a single thing: state_attributes. In that case; it won't be confusing anymore. My concern is that having entity_state_attributes and state_attributes both; would still be confusing.

[emontnemery]

After some discussion, the conclusion is:

• Keep state_attributes but make it clearer it should not be overridden
• Rename Entity.device_state_attributes to Entity.extra_state_attributes

[frenck]

✅ LGTM

[frenck]

Created a documentation PR in: home-assistant/developers.home-assistant#837