Improve esphome state property decorator typing

[cdce8p]

Proposed change

At the moment, it's quite difficult to type decorators which return a property. The much better solution is to apply the @property decorator afterwards.

For now, mypy will still emit an error Decorated property not supported [misc]. However that will be fixed with the next release later this month. At that point, the type: ignore comments can be removed.

Ref python/mypy#13475 (comment)

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

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.

[probot-home-assistant]

Hey there @OttoWinter, @jesserockz, mind taking a look at this pull request as it has been labeled with an integration (esphome) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

[ilevkivskyi]

Btw there is a hack (up to you whether you want to use it):

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    custom_property = property
else:
    def custom_property(f):
        # actual definition
        ...

[cdce8p]

Btw there is a hack (up to you whether you want to use it):

from typing import TYPE_CHECKING



if TYPE_CHECKING:

    custom_property = property

else:

    def custom_property(f):

        # actual definition

        ...

Thanks! In this case I think the refactor is slightly better since it can express the change in the return type (add | None).

[epenet]

LGTM