plotly / plotly/plotly.py

Request: add type hints and `py.typed` for type checkers and tab complete

未关闭
#4,927 9 条评论 4 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

feature P2 size: 3
主要语言
Python
星标
18.8k
派生
2.8k
平均合并
16 小时 26 分钟
30 天内合并 PR
21

描述

With plotly==5.24.1, running mypy==1.13.0 on a module importing plotly:

error: Cannot find implementation or library stub for module named "plotly.express" [import-not-found]
    import plotly.express as px
    ^

The request is can plotly add type hints, and a py.typed so type checkers can use them?

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先,使用 plotly 5.24.1 和 import plotly.express as px 入口复现 mypy 1.13.0 的错误。检查该包如何提供类型信息,并确定类型检查器和 Tab 补全所需提示的范围。当 mypy 能够解析该导入且该包包含 py.typed 支持时,即视为完成。

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

评估

技术栈
python
领域
data-visualization, developer-experience
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
冷清
描述清晰度
需要澄清
新手友好度
30/100

把新 issue 发到你的邮箱

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