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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix password type in Aussie Broadband #134612

Draft
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

Bre77
Copy link
Contributor

@Bre77 Bre77 commented Jan 4, 2025

Proposed change

Fix password type in Aussie Broadband since Pydantic migration

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

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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Jan 4, 2025

Hey there @nickw444, mind taking a look at this pull request as it has been labeled with an integration (aussie_broadband) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of aussie_broadband can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign aussie_broadband Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@Bre77 Bre77 changed the title Fix password type Fix password type in Aussie Broadband Jan 4, 2025
@Bre77
Copy link
Contributor Author

Bre77 commented Jan 4, 2025

I do not know why CI tests are failing, pytest passes locally, and I dont understand which part of the test is failing.

@ZephireNZ
Copy link
Contributor

I do not know why CI tests are failing, pytest passes locally, and I dont understand which part of the test is failing.

Try merging in the latest upstream changes from dev branch. I find occasionally I have really weird behaviour and it was a bug from elsewhere causing it.

@@ -27,7 +28,7 @@ async def async_setup_entry(
# Login to the Aussie Broadband API and retrieve the current service list
client = AussieBB(
entry.data[CONF_USERNAME],
entry.data[CONF_PASSWORD],
SecretStr(entry.data[CONF_PASSWORD]),
Copy link
Member

Choose a reason for hiding this comment

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

Ideally our code does not depend on pydantic. HA does not rely on pydantic iirc, so we should not reference them here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does that mean I need to fork the library and shim the init?

We can't roll back the library change because that was done in the Pydantic migration.

Copy link
Member

Choose a reason for hiding this comment

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

Why can't we change the library?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not maintained by either code owner, we can raise a PR and see what happens.

Copy link
Contributor

@ZephireNZ ZephireNZ Jan 5, 2025

Choose a reason for hiding this comment

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

Alternatively, could we use duck typing here?

Would just need a wrapper around the string ie:

class SecretStr:
  """Fake secret string to avoid dependency on Pydantic."""
  def __init__(self, value: string):
    self._value = value
  
  def get_secret_value(self):
    return self._value

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yaleman/pyaussiebb#233 raised, if published I'll change this PR to a bump.

@home-assistant
Copy link

home-assistant bot commented Jan 5, 2025

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft January 5, 2025 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants