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

Break apart Contents Abstraction

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

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
停滞
技术栈
github, python
领域
api

调研方向

从 GithubRepo.get_contents 和链接的 GitHub Contents API 文档开始，然后追踪其调用方，以区分目录和文件的意图。为目录和文件定义不同的行为，包括对 1MB 到 100MB 文件的 raw-media fallback；该 issue 还要求决定是否必须支持超过 100MB 的文件。

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

描述

We currently have GithubRepo.get_contents as an abstraction around GitHub's Contents API endpoint. However, this endpoint behaves differently depending on what you're asking it for, in particular:

  • a directory
  • a file
  • a file whose size is between 1MB and 100MB
  • a file whose size is above 100MB

The method tries to handle those all in one place and the flow suffers because of it.

Instead we should pick apart this abstraction into two, based on the caller's intent:

  • a directory
  • a file, with fallbacks for larger files

For instance, file content for files between 1MB and 100MB can be retrieved with the application/vnd.github.v3.raw custom media type (as the Accept header). Since we already want the metadata from the initial call (it's not provided with a raw call) this seems like a nice fallback. We can discuss whether we need to support retrieving file content which is >100MB.

主要语言
Python
星标
0
派生
0
平均合并
2 天 20 小时
30 天内合并 PR
9

贡献指南

这个仓库没有索引到贡献指南

从这里开始

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

opensafely-core/osgithub 的其他 Issue

查看 opensafely-core/osgithub 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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