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
- 星號
- 225
- 分支
- 35
- 平均合併
- 1 天 20 小時
- 30 天內合併 PR
- 34
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
petercorke/machinevision-toolbox-python 的其他 Issue
-
難度 3/5 1-2 天 新手友好度 76/100
petercorke/machinevision-toolbox-python#160 ·
維護者通常 1 天內回覆
-
tech-debt
難度 4/5 3-5 天 新手友好度 39/100
petercorke/machinevision-toolbox-python#159 ·
維護者通常 1 天內回覆
-
難度 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可能重新可做 關聯的 PR 已關閉且未合併。 未關閉bug help wanted
難度 5/5 一週以上 新手友好度 25/100
petercorke/machinevision-toolbox-python#151 ·
維護者通常 1 天內回覆
查看 petercorke/machinevision-toolbox-python 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 82/100
維護者通常 1 天內回覆
-
namespace operations
難度 1/5 1 小時以內 新手友好度 65/100
EclipseFdn/open-vsx.org#15057 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 76/100
FinanceFlash/unvibecode#349 ·
-
Mission statement: why this is free, in the README, Why This Exists and the wiki Home可能已有人在做 @ChiefGyk3D 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 76/100
ChiefGyk3D/Clouds-Against-Humanity#348 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 74/100
vllm-project/vime#508 ·
維護者通常 4 天內回覆