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

Rename gather_with_concurrency to gather_with_limited_concurrency #102241

Merged
merged 2 commits into from
Oct 19, 2023

Conversation

emontnemery
Copy link
Contributor

Proposed change

Rename gather_with_concurrency to gather_with_limited_concurrency

Rationale

asyncio.gather executes awaitables concurrently, the point of gather_with_concurrency is to limit the concurrency

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

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

Code owner commands

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

@home-assistant
Copy link

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

Code owner commands

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

@home-assistant
Copy link

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

Code owner commands

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

@jbouwh
Copy link
Contributor

jbouwh commented Oct 18, 2023

@emontnemery you need to update the test as it calls the renamed method directly

Copy link
Contributor

@esev esev left a comment

Choose a reason for hiding this comment

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

LGTM for Wemo.

@@ -171,7 +171,7 @@ def protected_loop_func(*args: _P.args, **kwargs: _P.kwargs) -> _R:
return protected_loop_func


async def gather_with_concurrency(
Copy link
Member

Choose a reason for hiding this comment

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

Its possible a custom component is also using this. Maybe make gather_with_concurrency = gather_with_limited_concurrency below and remove in 6 moths?

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Are there any custom integrations using this util?

@bdraco
Copy link
Member

bdraco commented Oct 19, 2023

Are there any custom integrations using this util?

I've seen modified version of the bond integration in the wild.. not sure if we need to be concerned about that though

@emontnemery
Copy link
Contributor Author

Are there any custom integrations using this util?

I checked HACS, and there's no integration published there calling it. I don't think we need to worry about old modified versions of a core integration floating around.

@MartinHjelmare
Copy link
Member

Ok. 👍

@emontnemery emontnemery reopened this Oct 19, 2023
@emontnemery emontnemery merged commit dff18b4 into dev Oct 19, 2023
@emontnemery emontnemery deleted the rename_gather_with_concurrency branch October 19, 2023 13:08
@github-actions github-actions bot locked and limited conversation to collaborators Oct 20, 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.

6 participants