Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Sources.py: quick wins, split into a package, and API unification

未关闭
#150 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@zw1915 已经在做这个了。

开始于 2026年10月17日。

  • #156 来自 @zw1915 —— 未关闭

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
opencv, python

调研方向

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 内容生成。

描述

help wanted tech-debt

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 with AttributeError on a None capture.
  • LabelMeReader: raise on bad input instead of return None.
  • ImageSource: the hasattr(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 (ROSBag URL download, LabelMeReader) and to the Event.wait() calls in ROSTopic, so a stalled connection cannot hang forever.
  • Delete the unused _PC2_DTYPE table and the if __name__ == "__main__": block at the bottom.
  • Fix docstring errors: prop/property in the camera-property methods, the duplicated show_allowed entry in ROSBag.print, tol/tolerance, and the "coolumn" typo.
  • docs/source/sources.rst documents a read() method that does not exist; docs/source/ros.rst call signatures need checking against the code.
  • Collapse the repeated colororder branching (about ten copies) into one helper that wraps an array as an Image.
  • ROSBag: replace print() with logging (about 30 print calls 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__.py must re-export every public name and the private availability flags that tests read via getattr.
  • Update test patch targets that name Sources.safe_plt_show, and check the Sphinx currentmodule directives.
  • Verify with an import of every public name from both machinevisiontoolbox and machinevisiontoolbox.Sources, then tests/test_image_sources.py and tests/test_ros.py (needs the ros extra).
  • Optional follow-up: lazy-import rosbags / roslibpy so import machinevisiontoolbox stops 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, dtype and 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, retire grab().
  • 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.py are tracked in #60; about 50 are missing today).
  • Add mocked tests for VideoCamera, WebCam and EarthView.

Notes for contributors

  • Branch from main and 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 (EarthView key lookup), which touches this file; it should land first.
主要语言
Python
星标
224
派生
31
平均合并
1 天 20 小时
30 天内合并 PR
28

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

petercorke/machinevision-toolbox-python 的其他 Issue

查看 petercorke/machinevision-toolbox-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。