feat(utils): implement async rsync wrapper with RsyncOptions - #460
Merged
Conversation
Signed-off-by: sushant-suse <sushant.gaurav@suse.com>
Coverage ReportFor commit 124ae24 Click to expand Coverage Report Name Stmts Miss Branch BrPart Cover
-------------------------------------------------------------------------------
+ src/docbuild/tasks/portal.py 140 0 50 1 99.5%
+ src/docbuild/models/manifest.py 156 1 32 1 98.9%
+ src/docbuild/logging.py 104 1 26 1 98.5%
+ src/docbuild/utils/pidlock.py 79 1 14 1 97.8%
+ src/docbuild/cli/cmd_config/list.py 28 0 10 1 97.4%
+ src/docbuild/cli/cmd_portal/cmd_list.py 168 1 86 7 96.9%
+ src/docbuild/models/deliverable/__init__.py 95 2 14 2 96.3%
+ src/docbuild/models/deliverable/view.py 175 3 48 6 96.0%
+ src/docbuild/cli/callback.py 35 0 10 2 95.6%
+ src/docbuild/utils/concurrency.py 65 3 18 1 95.2%
+ src/docbuild/tasks/metadata/runner.py 65 3 16 1 95.1%
+ src/docbuild/cli/cmd_cli.py 142 7 28 6 92.4%
+ src/docbuild/utils/sync.py 46 3 14 2 91.7%
+ src/docbuild/cli/cmd_metadata/__init__.py 41 2 4 2 91.1%
- src/docbuild/cli/cmd_doctor.py 37 4 10 2 87.2%
- src/docbuild/tasks/build/runner.py 88 14 16 3 83.7%
- src/docbuild/tasks/metadata/manifest.py 130 16 48 6 83.1%
- src/docbuild/cli/cmd_config/validate.py 21 2 12 3 78.8%
- src/docbuild/cli/cmd_check/__init__.py 22 9 4 0 50.0%
- src/docbuild/cli/cmd_build/__init__.py 59 38 8 0 31.3%
-------------------------------------------------------------------------------
+ TOTAL 3983 110 1088 48 96.5%
58 files skipped due to complete coverage. |
tomschr
requested changes
Aug 20, 2026
tomschr
left a comment
Contributor
There was a problem hiding this comment.
Great work! 👍
I have some small comments for you.
Signed-off-by: sushant-suse <sushant.gaurav@suse.com>
tomschr
approved these changes
Aug 20, 2026
tomschr
left a comment
Contributor
There was a problem hiding this comment.
Looks great! Thank you very much, Sushant! 👍
Please merge it!
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
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.
Addresses #452
What was done:
docbuild.utils.syncto handle common rsync flags (archive,delete,dry_run, etc.) alongside anextra_argslist, preventing function signature bloat while maintaining full CLI flexibility.rsyncWrapper: Created an asynchronousrsync()function that wrapsdocbuild.utils.shell.run_commandto execute synchronization tasks safely and concurrently.content_onlyoverride parameter.rsyncto theSYSTEM_DEPENDENCIESdictionary inconstants.pyso it is automatically verified by thedocbuild doctorcommand.Pathobject compatibility.Enum.nametypes inconstants.py.@tomschr, as we discussed, I kept this PR strictly focused on the core
rsyncutility implementation to keep a clean separation of concerns. Once this is merged, I will open the next PR to actually integrate this into thebuildsubcommand logic.Checklist
uvx ruff check --fixanduvx ruff format)changelog.d/