Skip to content

Add async_iterator util#153194

Merged
MartinHjelmare merged 1 commit into
devfrom
async_iterator_util
Sep 29, 2025
Merged

Add async_iterator util#153194
MartinHjelmare merged 1 commit into
devfrom
async_iterator_util

Conversation

@emontnemery
Copy link
Copy Markdown
Contributor

Proposed change

Add async_iterator util with classes AsyncIteratorReader and AsyncIteratorWriter

Rationale: The helper classes are useful outside the backup integration

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:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

Checklist

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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
Copy Markdown
Contributor

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (backup) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of backup 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 backup 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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR extracts async iterator utility classes from the backup integration and moves them to a shared location in homeassistant.util.async_iterator, making them available for reuse across the codebase.

  • Adds new AsyncIteratorReader and AsyncIteratorWriter classes to homeassistant/util/async_iterator.py
  • Updates the backup integration to use the shared utilities instead of local implementations
  • Replaces the backup-specific AbortCipher exception with a generic Abort exception

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
homeassistant/util/async_iterator.py New module containing AsyncIteratorReader, AsyncIteratorWriter classes and Abort exception
tests/util/test_async_iterator.py Comprehensive test suite for the new async iterator utilities
homeassistant/components/backup/util.py Removes local implementations and imports from shared module, updates exception handling
homeassistant/components/backup/manager.py Updates import and constructor call to use shared AsyncIteratorReader
homeassistant/components/backup/http.py Updates imports and constructor calls to use shared utilities

Comment on lines +78 to +79
"""Close the iterator."""

Copy link

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

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

The close method has an empty implementation. Consider adding documentation to clarify that this is intentionally a no-op or implement proper cleanup if needed.

Suggested change
"""Close the iterator."""
"""Close the iterator.
This method is intentionally a no-op as no cleanup is required.
"""

Copilot uses AI. Check for mistakes.
@MartinHjelmare MartinHjelmare merged commit 2b4b46e into dev Sep 29, 2025
48 checks passed
@MartinHjelmare MartinHjelmare deleted the async_iterator_util branch September 29, 2025 16:54
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 30, 2025
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.

3 participants