Skip to content

Rename zeroconf service info#59467

Merged
frenck merged 1 commit intohome-assistant:devfrom
epenet:zeroconf-serviceinfo
Nov 10, 2021
Merged

Rename zeroconf service info#59467
frenck merged 1 commit intohome-assistant:devfrom
epenet:zeroconf-serviceinfo

Conversation

@epenet
Copy link
Copy Markdown
Contributor

@epenet epenet commented Nov 10, 2021

Proposed change

Rename HaServiceInfo to ZeroconfServiceInfo.
As discussed in #58958 (comment)
cc @frenck @bdraco @KapJI

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:



class HaServiceInfo(TypedDict):
class ZeroconfServiceInfo(TypedDict):
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Or maybe we could use ZeroconfDiscoveryInfo to match the generic DiscoveryInfoType?

Suggested change
class ZeroconfServiceInfo(TypedDict):
class ZeroconfDiscoveryInfo(TypedDict):

Copy link
Copy Markdown
Member

@frenck frenck Nov 10, 2021

Choose a reason for hiding this comment

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

I think the current suggestion (ZeroconfServiceInfo) is fine. It matches what is represented in Zeroconfig itself.

If anything, I would maybe even call it just "ServiceInfo", as it is already in the Zeroconf package namespace.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Should I wait for @bdraco to confirm that he too prefers just ServiceInfo?
I've marked the other PRs as draft until this one gets merged.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I like the ZeroconfServiceInfo name because there are some integrations that have multiple discovery sources and it will easier to differentiate with something like SSDPServiceInfo, DHCPserviceInfo.

Copy link
Copy Markdown
Member

@frenck frenck Nov 10, 2021

Choose a reason for hiding this comment

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

I'm ok with that :)
Do you approve otherwise @bdraco ?

Copy link
Copy Markdown
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

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

LGTM

@frenck frenck merged commit ab1e142 into home-assistant:dev Nov 10, 2021
@epenet epenet deleted the zeroconf-serviceinfo branch November 10, 2021 14:40
@github-actions github-actions bot locked and limited conversation to collaborators Nov 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants