python / python/cpython

Advise to use typing.IO sparingly

未关闭
#92,877 5 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs topic-typing
主要语言
Python
星标
77.2k
派生
36k
PR 合并指标
PR 指标待抓取

描述

Documentation

typing.IO and subclasses typing.TextIO and typing.BinaryIO are a bit of a legacy feature and should be used sparingly. We should document better alternatives. I'm preparing a PR with some suggestions.

(Cc @gvanrossum @JelleZijlstra @AlexWaygood)

贡献指南

打开贡献指南

从这里开始

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

调研方向

该 issue 涉及 typing.IO、typing.TextIO 和 typing.BinaryIO 的文档,但没有指出文件、测试或文档入口。首先定位相关的 typing 文档,并审查报告者正在准备的替代方案。当文档明确说明何时应谨慎使用这些类型,并提供更好的替代方案时,即可视为完成。

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

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

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