Skip to content

feat: Add async/await support for VCS operations - #504

Open
tony wants to merge 15 commits into
masterfrom
pr/async
Open

feat: Add async/await support for VCS operations#504
tony wants to merge 15 commits into
masterfrom
pr/async

Conversation

@tony

@tony tony commented Dec 30, 2025

Copy link
Copy Markdown
Member

Summary

  • Add async equivalents for all sync APIs with Async prefix
  • AsyncGit, AsyncHg, AsyncSvn command classes
  • AsyncGitSync, AsyncHgSync, AsyncSvnSync sync classes
  • Async subprocess wrapper with progress callbacks
  • pytest-asyncio fixtures for async testing

New APIs

Sync Async
Git AsyncGit
Hg AsyncHg
Svn AsyncSvn
GitSync AsyncGitSync
HgSync AsyncHgSync
SvnSync AsyncSvnSync

Test plan

  • Unit tests for async subprocess and run modules
  • Tests for all async command classes
  • Tests for all async sync classes
  • Async fixture tests
  • Documentation with working doctests

@codecov

codecov Bot commented Dec 30, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 65.75476% with 701 lines in your changes missing coverage. Please review.
✅ Project coverage is 60.01%. Comparing base (d9391c3) to head (ef2b9c4).

Files with missing lines Patch % Lines
src/libvcs/cmd/_async/git.py 38.39% 134 Missing and 81 partials ⚠️
src/libvcs/sync/_async/git.py 50.84% 97 Missing and 19 partials ⚠️
tests/sync/_async/test_svn.py 0.00% 106 Missing ⚠️
src/libvcs/cmd/_async/hg.py 23.46% 50 Missing and 25 partials ⚠️
tests/cmd/_async/test_svn.py 0.00% 73 Missing ⚠️
src/libvcs/sync/_async/base.py 33.92% 30 Missing and 7 partials ⚠️
src/libvcs/pytest_plugin.py 32.07% 35 Missing and 1 partial ⚠️
src/libvcs/_internal/async_run.py 69.33% 22 Missing and 1 partial ⚠️
src/libvcs/sync/_async/hg.py 48.14% 14 Missing ⚠️
src/libvcs/_internal/async_subprocess.py 96.20% 3 Missing ⚠️
... and 3 more
Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #504      +/-   ##
==========================================
+ Coverage   58.23%   60.01%   +1.77%     
==========================================
  Files          40       55      +15     
  Lines        6489     8536    +2047     
  Branches     1098     1331     +233     
==========================================
+ Hits         3779     5123    +1344     
- Misses       2177     2743     +566     
- Partials      533      670     +137

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tony added a commit that referenced this pull request Dec 30, 2025
@tony
CHANGES: Add async support entry (#504)
3f468c3
tony added a commit that referenced this pull request Dec 30, 2025
@tony
CHANGES: Add async support entry (#504)
88880e8
@tony

tony commented Dec 30, 2025

Copy link
Copy Markdown
Member Author

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

🤖 Generated with Claude Code

@tony tony mentioned this pull request Apr 26, 2026
Closed
tony added 15 commits April 26, 2026 07:11
@tony
AGENTS(docs[asyncio]): Add asyncio development guidelines
0440ee6 
why: Document async patterns and conventions for contributors.
what:
- Add async architecture overview (_async/ subpackages)
- Add async subprocess patterns (communicate, timeout, BrokenPipeError)
- Add async API conventions (naming, callbacks, shared logic)
- Add async testing patterns with pytest-asyncio
- Add async anti-patterns to avoid
@tony
_internal(feat[async]): Add async subprocess and run modules
51ccffc 
why: Provide async subprocess execution primitives for building
async VCS command wrappers.

what:
- Add async_subprocess.py with AsyncSubprocessCommand class
- Add async_run.py with async run() and callback support
- Support timeout, check, and streaming output
@tony
cmd/_async(feat): Add AsyncGit, AsyncHg, AsyncSvn command classes
a346a71 
why: Enable non-blocking VCS command execution for better concurrency.

what:
- Add AsyncGit with async run(), clone(), fetch(), etc.
- Add AsyncHg with async run(), clone(), pull(), etc.
- Add AsyncSvn with async run(), checkout(), update(), etc.
@tony
sync/_async(feat): Add AsyncGitSync, AsyncHgSync, AsyncSvnSync classes
f44e877 
why: Enable async repository cloning, updating, and synchronization
for concurrent multi-repo operations.

what:
- Add AsyncGitSync with async obtain(), update_repo(), etc.
- Add AsyncHgSync with async obtain(), update_repo(), etc.
- Add AsyncSvnSync with async obtain(), update_repo(), etc.
- Add shared async base class
@tony
pytest_plugin(feat): Add async fixtures and doctest support
8395531 
what:
- Add async_git_repo, async_hg_repo, async_svn_repo fixtures
- Add asyncio to doctest_namespace for async doctests
- Add conditional pytest_asyncio import
@tony
tests(_internal[async]): Add tests for async subprocess and run modules
9e9725b 
what:
- Add AsyncSubprocessCommand tests (run, timeout, concurrent)
- Add async run() tests (callbacks, error handling)
- Add AsyncProgressCallbackProtocol tests
@tony
tests(cmd/_async): Add tests for async command classes
f33c69c 
what:
- Add AsyncGit tests (init, clone, status, etc.)
- Add AsyncHg tests (init, clone, status, etc.)
- Add AsyncSvn tests (checkout, update, status, etc.)
@tony
tests(sync/_async): Add tests for async sync classes
fff4f8c 
what:
- Add AsyncGitSync tests (obtain, update_repo, remotes)
- Add AsyncHgSync tests (obtain, update_repo)
- Add AsyncSvnSync tests (obtain, update_repo)
@tony
docs(internals): Add async_run and async_subprocess documentation
c5bb300 
what:
- Add docs/internals/async_run.md with API reference
- Add docs/internals/async_subprocess.md with API reference
- Add async modules to internals toctree
@tony
docs(topics): Add comprehensive asyncio guide
e716417 
what:
- Add docs/topics/asyncio.md with patterns and examples
- Cover concurrent cloning, progress callbacks, error handling
- Add asyncio to topics toctree
@tony
docs(cmd,sync): Add async variant references
7bb64c0 
why: Document the new async command and sync classes.
what:
- Add AsyncGit, AsyncHg, AsyncSvn to cmd/index.md
- Add AsyncGitSync, AsyncHgSync, AsyncSvnSync to sync/index.md
@tony
docs(guides): Add async examples to README, quickstart, pytest-plugin
a808742 
why: Help users discover and adopt async APIs.
what:
- Add async section to README with concurrent clone example
- Add async quickstart examples with asyncio.run() patterns
- Document async pytest fixtures in pytest-plugin guide
@tony
py(deps[test]): Add pytest-asyncio
146c404 
why: Required for async test support with pytest.
what:
- Add pytest-asyncio to dev and testing dependency groups
@tony
py(pytest): Configure asyncio mode and filter deprecation warning
faa7dd0 
why: Enable proper async test support with strict mode.
what:
- Set asyncio_mode = "strict" for explicit async marking
- Set asyncio_default_fixture_loop_scope = "function"
- Filter pytest-asyncio deprecation warning for loop scope
@tony
CHANGES: Add async support entry (#504)
ef2b9c4
@tony

tony commented Aug 22, 2026

Copy link
Copy Markdown
Member Author

Automated review finding. Recorded here so it is not lost. Nothing has been pushed to this branch and no fix is applied — this is a note, not a change request.

Async clone()/fetch() omit the -- end-of-options separator

src/libvcs/cmd/_async/git.py builds argv without the -- separator that every sync equivalent in src/libvcs/cmd/git.py uses before positional arguments (see clone, fetch, pull, init, reset there — all of them pass ["--", *required_flags]).

A url or repository beginning with - is then parsed by git as an option rather than a path or URL. --upload-pack=... is the classic case: it turns a clone target into command execution on the client.

Suggested fix, matching the sync path:

-            ["clone", *local_flags, url, str(self.path)],
+            ["clone", *local_flags, "--", url, str(self.path)],

fetch() needs the same treatment, collecting repository and refspec into a required_flags list emitted after --.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tony