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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use dataclass properties in yamaha_musiccast discovery #60749

Merged
merged 1 commit into from Dec 1, 2021

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Dec 1, 2021

Proposed change

Use dataclass properties in yamaha_musiccast discovery.

Linked to #60540

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

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:

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:

@probot-home-assistant
Copy link

Hey there @vigonotion, @micha91, mind taking a look at this pull request as it has been labeled with an integration (yamaha_musiccast) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@project-bot project-bot bot added this to Needs review in Dev Dec 1, 2021
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @epenet 馃憤

Dev automation moved this from Needs review to Reviewer approved Dec 1, 2021
@frenck frenck merged commit 824b313 into home-assistant:dev Dec 1, 2021
Dev automation moved this from Reviewer approved to Done Dec 1, 2021
@epenet epenet deleted the yamaha-discovery branch December 1, 2021 17:36
self.host = urlparse(discovery_info[ssdp.ATTR_SSDP_LOCATION]).hostname
self.upnp_description = discovery_info[ssdp.ATTR_SSDP_LOCATION]
self.serial_number = discovery_info.upnp[ssdp.ATTR_UPNP_SERIAL]
self.host = urlparse(discovery_info.ssdp_location or "").hostname or ""
Copy link
Member

Choose a reason for hiding this comment

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

Does this mean we can update the config entry host to be an empty string? Is that valid?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @MartinHjelmare
This change was to satisfy mypy:

  • urlparse reacts differently if it is passed str versus str | None
  • then the generated hostname can still be None

This should be caught on line 87 though, so maybe using the form if TYPE_CHECKING twice (once for ssdp_location, and then again for hostname) would have been better?
https://github.com/epenet/home-assistant-core/blob/3b0d984959beef06a29a620815de4f3e810c73e5/homeassistant/components/yamaha_musiccast/config_flow.py#L87

I think using the standard form if discovery_info.ssdp_location is None it would have become impossible to build a test for it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can refactor as part of #60787 if needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the discussion around urlparse, see this comment from a previous hue PR: #60598 (comment)

Copy link
Member

Choose a reason for hiding this comment

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

We shouldn't accommodate bugs or write code that looks like a bug to satisfy typing. Either use if TYPE_CHECKING or some other explicit way of setting the type without allowing a potential bug to sneak in.

@github-actions github-actions bot locked and limited conversation to collaborators Dec 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants