simvue-io / simvue-io/python-api

Be Consistent in Python API Print Outs

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

还没有人认领这个 Issue。

主要语言
Python
星标
4
派生
1
平均合并
5 天 8 小时
30 天内合并 PR
4

描述

Currently the Python API has two forms of information display:

  • Logging with the built-in logging Python module.
  • Custom printouts which are displayed in colour using click.

The issue here is that logging statements are sent as Events to the server, but these printouts are not.
Discussion needs to be had on how to handle these two cases.

Image

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先阅读 Python API 对内置 logging 模块的使用情况，以及基于 Click 的彩色输出。比较哪些消息会成为 server Events、哪些不会，然后在定义完成标准之前，明确这两种情况下预期的处理方式。

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

评估

技术栈
python
领域
api, backend-api-design
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

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