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

avoid using print() function

未关闭 适合新手
#141 2 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
68/100
Issue 类型
重构
描述清晰度
描述清楚
活跃度
冷清
技术栈
python
领域
backend

调研方向

打开 brping/device.py 并检查 connect_serial(),包括两处 print 调用和现有的异常路径。测试设备缺失和成功打开这两种情况,以确认前者会按描述引发异常,而后者不再写入 stdout。

由索引模型根据 Issue 内容生成。

描述

This is just a copy of connect_serial() method from brping/device.py (ver 0.1.5)

def connect_serial(self, device_name: str, baudrate: int =115200):
    if device_name is None:
        print("Device name is required")
        return

    try:
        print("Opening %s at %d bps" % (device_name, baudrate))

        ## Serial object for device communication
        # write_timeout fixes it getting stuck forever atempting to write to
        # /dev/ttyAMA0 on Raspberry Pis, this raises an exception instead.
        self.iodev = serial.Serial(device_name, baudrate, write_timeout=1.0)
        self.iodev.send_break()
        time.sleep(0.001)
        self.iodev.write("U".encode("ascii"))

    except Exception as exception:
        raise Exception("Failed to open the given serial port: {0}".format(exception))

The request here is:
Kindly avoid using the print function in a library like this. If the device name is required, it should be handled as an exception, not with a print and return:

raise ValueError("Device name is required")

And the next print is indeed a logging:

logger.info("Opening %s at %d bps", device_name, baudrate)

I've had to use workarounds to prevent these prints from being sent to my app's stdout:

def brping_muted_print(*args, **kw):
    if len(args) == 1:
        args = args[0]
    log('brping: %s', args)
# brping module uses raw print statements for logging
# with this trick, we turn them into proper logs
brping.device.print = brping_muted_print

Thanks

主要语言
Python
星标
60
派生
39
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

bluerobotics/ping-python 的其他 Issue

查看 bluerobotics/ping-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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