feat(mvtbtool): add 'tool' extra for IPython/pygments - #24
Merged
Conversation
…r message when missing mvtbtool imports IPython, pygments, and traitlets inside main(), but none of the three were declared as a dependency anywhere -- pip install machinevision-toolbox-python followed by running mvtbtool crashed with a raw ModuleNotFoundError unless IPython happened to already be present transitively (e.g. via Jupyter). Same gap as roboticstoolbox-python's rtbtool, fixed there first. Wrap the imports in a try/except that points the user at the new 'tool' extra instead. Added as an extra (matching the existing ros/jupyter/torch pattern) rather than a core dependency, since mvtbtool is an opt-in interactive shell. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
Pull in #26's ci.yml fix so this PR's own workflow file (loaded from this branch's head, not main, for pull_request-triggered runs) actually tests against opencv4 instead of the unpinned conda-forge opencv5 drift.
This PR adds a `tool` extra (ipython, pygments) to pyproject.toml for mvtbtool's interactive shell, but ci.yml's conda create-args list is a separate, hand-maintained package list that pip's --no-deps install never populates from pyproject.toml's extras -- so test_bin.py:: TestMvtbtool::test_help failed with "IPython and pygments...not installed" even though the feature code itself is correct. Add both packages directly to create-args in the test and codecov jobs, matching how opencv<5 was already handled the same way. Same underlying gap as the opencv5 CI drift incident: pyproject.toml's dependency spec and ci.yml's conda list can silently diverge because they're two separate sources of truth (see tech-debt.md).
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
1 participant
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.
Summary
mvtbtoolimportsIPython,pygments, andtraitletsinsidemain(), but none were declared as a dependency anywhere —pip install machinevision-toolbox-pythonfollowed by runningmvtbtoolcrashed with a rawModuleNotFoundErrorunless IPython happened to already be present transitively (e.g. via Jupyter). Same gap found and fixed in roboticstoolbox-python'srtbtool(companion PR).toolextra (pip install machinevision-toolbox-python[tool]) instead of a bare traceback.tool = ["ipython", "pygments"]topyproject.toml, folded intoall, and documented indocs/source/installation.rst's extras table alongside the existingros/jupyter/torchextras.Test plan
pip install machinevision-toolbox-python[tool]python -m machinevisiontoolbox.bin.mvtbtool) still drops into an IPython shell correctly🤖 Generated with Claude Code