Add SFTP Client #147300
Open
Add SFTP Client #147300
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jun 22, 2025
|
There's already an open PR for SFTP support for backups #135844 |
|
The CI / Run tests Python 3.13 (9) error test (pull_request) is not related to my code |
zweckj
requested changes
Jun 22, 2025
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Damn, I just saw it now. |
8 tasks
There was a problem hiding this comment.
Pull Request Overview
Adds a new SFTPClient integration to perform Home Assistant backups over SFTP.
- Introduces SSH and SFTP connection helpers with error handling and streaming utilities
- Implements a user-driven config flow and translation strings for configuration and setup errors
- Provides a
BackupAgentimplementation for listing, uploading, downloading, and deleting backups, along with comprehensive tests and type checking
Reviewed Changes
Copilot reviewed 20 out of 22 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| homeassistant/components/sftp_client/helpers.py | SSH and SFTP connection helpers, path operations, JSON streaming, and error classes |
| homeassistant/components/sftp_client/config_flow.py | Config flow schema, validation (InvalidAuth, CannotConnect), and entry creation |
| homeassistant/components/sftp_client/backup.py | BackupAgent implementation for managing backups over SFTP |
| homeassistant/components/sftp_client/strings.json | Localization strings for UI steps and exception messages |
| homeassistant/components/sftp_client/manifest.json | Integration metadata, dependencies, and quality scale setting |
| homeassistant/components/sftp_client/quality_scale.yaml | Quality scale compliance for Bronze through Platinum levels |
| tests/components/sftp_client/conftest.py | Common fixtures mocking SFTP connections and file streams |
| tests/components/sftp_client/test_init.py | Tests for setup and teardown behavior of the integration |
| tests/components/sftp_client/test_helpers.py | Tests for helper error handling (permission denied path) |
| tests/components/sftp_client/test_config_flow.py | Config flow tests covering success, auth errors, connection errors, and duplicates |
| tests/components/sftp_client/test_backup.py | Tests for backup agent API: list, details, upload, download, delete, and error cases |
| requirements_all.txt & requirements_test_all.txt | Added asyncssh==2.21.0 dependency |
| mypy.ini | Strict typing rules enabled for the new integration |
| CODEOWNERS & .strict-typing | Ownership assignment and strict typing registration for SFTP client |
Comments suppressed due to low confidence (1)
tests/components/sftp_client/test_helpers.py:14
- [nitpick] This test name duplicates
test_load_config_entryintest_init.pybut tests a permission-denied scenario. Rename it to something liketest_permission_denied_on_connectto reflect its purpose.
async def test_load_config_entry(
| """Open SFTP Connection.""" | ||
| await self.async_ssh_connect() | ||
| if self._conn is None: | ||
| raise RuntimeError("SHH Connection is failed") |
There was a problem hiding this comment.
The error message has a typo (“SHH”) and awkward phrasing. Consider using something like RuntimeError("SSH connection failed") for clarity.
Suggested change
| raise RuntimeError("SHH Connection is failed") | |
| raise RuntimeError("SSH connection failed") |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
SFTP Client allows you to specify an SFTP source to perform Home Assistant backups
Brand for new integration : home-assistant/brands#7312
Documentation: home-assistant/home-assistant.io#39676
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: