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

Use decorator for AsusWrt api calls #103690

Merged
merged 6 commits into from
Nov 13, 2023

Conversation

ollo69
Copy link
Contributor

@ollo69 ollo69 commented Nov 9, 2023

Proposed change

Use a decorator to avoid repetition of same code in the API calls inside bridge.py module.

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
  • I have followed the perfect PR recommendations
  • 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Nov 9, 2023

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

Code owner commands

Code owners of asuswrt 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 asuswrt Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@ollo69 ollo69 force-pushed the asuswrt-use-decorator branch from 280f965 to ad2851a Compare November 9, 2023 18:56
@@ -52,6 +54,28 @@ def _get_dict(keys: list, values: list) -> dict[str, Any]:
return dict(zip(keys, values))


def handle_errors_and_zip(exceptions: Any, keys: list | None) -> Callable:
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you please improve the typing by setting the arguments and return value of the callable

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Improved. Let me know if it looks good.

homeassistant/components/asuswrt/bridge.py Outdated Show resolved Hide resolved
homeassistant/components/asuswrt/bridge.py Show resolved Hide resolved
homeassistant/components/asuswrt/bridge.py Outdated Show resolved Hide resolved
homeassistant/components/asuswrt/bridge.py Show resolved Hide resolved
homeassistant/components/asuswrt/bridge.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft November 10, 2023 08:17
@home-assistant
Copy link

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.

@ollo69 ollo69 marked this pull request as ready for review November 10, 2023 10:48
@home-assistant home-assistant bot requested a review from edenhaus November 10, 2023 10:48
Copy link
Contributor

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

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

Please add tests for the new decorator

"""Create a dict from a list of keys and values."""
return dict(zip(keys, values))
def handle_errors_and_zip(
exceptions: Union[type[Exception], tuple[type[Exception], ...]],
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
exceptions: Union[type[Exception], tuple[type[Exception], ...]],
exceptions: type[Exception] | tuple[type[Exception], ...],

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 improved a little bit more typing defining 2 type alias,

@home-assistant home-assistant bot marked this pull request as draft November 10, 2023 12:27
@ollo69 ollo69 marked this pull request as ready for review November 10, 2023 23:38
@home-assistant home-assistant bot requested a review from edenhaus November 10, 2023 23:38
Copy link
Contributor

@edenhaus edenhaus left a comment

Choose a reason for hiding this comment

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

Thanks @ollo69 👍

@edenhaus edenhaus merged commit 1e37535 into home-assistant:dev Nov 13, 2023
20 checks passed
@ollo69 ollo69 deleted the asuswrt-use-decorator branch November 13, 2023 12:57
@github-actions github-actions bot locked and limited conversation to collaborators Nov 14, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants