Sources.py: quick wins, split into a package, and API unification
维护者通常 1 天内回复
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 重构
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- opencv, python
- 领域
- api, backend, computer-vision
调研方向
Start with the ordered quick wins in src/machinevisiontoolbox/Sources.py; each is scoped as a separate small PR, and the file itself is the entry point. For the package split, first land the quick wins, then move the classes into the named modules and preserve public exports and private availability flags. Verify imports and run tests/test_image_sources.py and tests/test_ros.py (the latter needs the ros extra); the API unification items need discussion before work starts.
由索引模型根据 Issue 内容生成。
描述
src/machinevisiontoolbox/Sources.py is about 4250 lines and holds every image source class: VideoFile, VideoCamera, WebCam, EarthView, FileCollection, FileArchive, ImageSequence, TensorStack, PointCloudSequence, LabelMeReader, and the ROS classes (ROSTopic, SyncROSStreams, ROSBag). The ROS code alone is roughly 40% of the file, and depends one-way on the rest. This issue collects the work to tidy it up. Contributions are welcome: items are ordered, and the first group needs no design decisions.
The RealSense ROSBag decoding bug is tracked separately (#151), because it is a user-facing defect and can be fixed independently.
1. Quick wins (no API change, one small PR each is fine)
-
VideoFile: raise a clear error when the file cannot be opened, instead of failing later withAttributeErroron aNonecapture. -
LabelMeReader: raise on bad input instead ofreturn None. -
ImageSource: thehasattr(self, "__len__")checks (in__init__and the iteration setup) are dead code, since the class defines the attribute; replace them with a real test. - Add timeouts to
urllib.request.urlretrieve/urlopen(ROSBagURL download,LabelMeReader) and to theEvent.wait()calls inROSTopic, so a stalled connection cannot hang forever. - Delete the unused
_PC2_DTYPEtable and theif __name__ == "__main__":block at the bottom. - Fix docstring errors:
prop/propertyin the camera-property methods, the duplicatedshow_allowedentry inROSBag.print,tol/tolerance, and the "coolumn" typo. -
docs/source/sources.rstdocuments aread()method that does not exist;docs/source/ros.rstcall signatures need checking against the code. - Collapse the repeated
colororderbranching (about ten copies) into one helper that wraps an array as anImage. -
ROSBag: replaceprint()withlogging(about 30printcalls in the file).
2. Split into a package (pure move, its own PR, no behaviour change)
git mv Sources.py Sources/__init__.py, then move classes into _base.py (ImageSource and shared helpers), video.py, files.py, archive.py, web.py, tensor.py, labelme.py, pointcloud.py and ros.py.
-
__init__.pymust re-export every public name and the private availability flags that tests read viagetattr. - Update test patch targets that name
Sources.safe_plt_show, and check the Sphinxcurrentmoduledirectives. - Verify with an import of every public name from both
machinevisiontoolboxandmachinevisiontoolbox.Sources, thentests/test_image_sources.pyandtests/test_ros.py(needs therosextra). - Optional follow-up: lazy-import
rosbags/roslibpysoimport machinevisiontoolboxstops paying for them.
Please do the split after the quick wins, in a PR containing nothing else, so it is easy to review as a pure move. Other work (for example making optional data files downloadable on demand) will also edit this file's call sites, so landing the split first avoids painful rebases.
3. API unification (changes behaviour, needs design discussion first)
- Shared
loop,rgb/colororder,dtypeand start/stop/step options on the base class. -
__iter__returns a fresh iterator each time. - One live-source API:
close()plus context-manager support everywhere, retiregrab(). - Lock
ROSTopic's latest-frame and timestamp state.
Any of these should come with deprecation warnings for the old behaviour. Please open a discussion or comment here before starting.
4. After the split
- Annotate the split modules (the parameter annotations for
Sources.pyare tracked in #60; about 50 are missing today). - Add mocked tests for
VideoCamera,WebCamandEarthView.
Notes for contributors
- Branch from
mainand open a PR; titles follow Conventional Commits (fix:,refactor:,docs:). - Please keep each PR to one of the items above.
- Related open work: #125 is fixed by PR #149 (
EarthViewkey lookup), which touches this file; it should land first.
- 主要语言
- Python
- 星标
- 224
- 派生
- 31
- 平均合并
- 1 天 20 小时
- 30 天内合并 PR
- 28
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
petercorke/machinevision-toolbox-python 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 42/100
petercorke/machinevision-toolbox-python#157 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 48/100
petercorke/machinevision-toolbox-python#152 ·
维护者通常 1 天内回复
-
ROSBag: RealSense bags have a 4-byte depth-units trailer that is guessed, not parsed可能已有人在做 @theluckystrike 于 3 天前认领。 未关闭bug help wanted
难度 5/5 一周以上 新手友好度 25/100
petercorke/machinevision-toolbox-python#151 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 43/100
petercorke/machinevision-toolbox-python#148 ·
维护者通常 1 天内回复
-
tech-debt
难度 2/5 1-3 小时 新手友好度 30/100
petercorke/machinevision-toolbox-python#147 ·
维护者通常 1 天内回复
查看 petercorke/machinevision-toolbox-python 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 76/100
-
[Device Support Request] HOBEIAN ZG-204ZL (Tuya PIR motion sensor with illuminance)可能已有人在做 @lenucksi 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
zigpy/zha-device-handlers#5493 ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
drevendev/BeautifulRepo#42 ·
维护者通常 1 天内回复
-
enhancement good first issue
难度 2/5 1-3 小时 新手友好度 84/100
writerslogic/holographic-memory#93 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 66/100
antoine-tena/kiln#47 ·
维护者通常 1 天内回复