Provide an import shim for 'vcstool' API compatibility #94
+9
−1
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
Signed-off-by: Scott K Logan <[email protected]>
cottsay
force-pushed
the
cottsay/vcstool-shim-alt
branch
from
849e3d6 to
a84055d
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #94 +/- ##
=======================================
Coverage 26.96% 26.96%
=======================================
Files 31 31
Lines 2240 2240
Branches 393 393
=======================================
Hits 604 604
Misses 1576 1576
Partials 60 60 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
mjcarroll
approved these changes
Jan 16, 2026
claraberendsen
approved these changes
Jan 20, 2026
|
|
||
| import vcs2l | ||
| from vcs2l import * # noqa: F403 | ||
|
|
Member
There was a problem hiding this comment.
I am not sure whether this would count as an improvement, but we can add a warning that the shim will be removed in the future when the API breaks.
Suggested change
| warnings.warn( | |
| "The 'vcstool' import is deprecated. Please update your code to use 'vcs2l' instead. " | |
| 'This shim will be removed in a future version.', | |
| DeprecationWarning, | |
| stacklevel=2, | |
| ) |
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.
Basic Info
Description of contribution in a few bullet points
This presents vcs2l as a wholesale replacement for vcstool and should satisfy any existing dependencies on vcstool without requiring changes to vcs2l itself. It operates under the fact that the existing vcs2l API is similar enough to vcstool that it can simply be installed and used under that name.
When the vcs2l API deviates from vcstool enough, this commit may be reverted and the shim module dropped.
Thanks to @j-rivero for presenting this as a significantly lighter-weight alternative to #90
Description of how this change was tested
pre-commit run --allpython3 -m pytest -s -v testpython3-vcstool