[BUG] `TypeError: 'ContentFile' object is not subscriptable` in mod_upload when creating GitHub issue

未關閉
#1,261 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 4 天內回覆

@garv-sanveria 已經在處理了。

開始於 2026年11月5日。

  • #1262 來自 @garv-sanveria —— 未關閉

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
30/100
Issue 類型
缺陷
描述清晰度
描述清楚
活躍度
停滯
技術堆疊
python
領域
backend

研究方向

Read mod_upload/controllers.py around lines 259–267 and the existing test in tests/test_upload/test_controllers.py around lines 80–83. Reproduce the failure with PyGithub’s ContentFile return type, then update the handling and test it for both supported encodings. Done when reporting a GitHub issue completes without a 500 error; pull request #1262 is already open.

由索引模型根據 Issue 內容生成。

描述

In mod_upload/controllers.py, when a user completes an upload with the option to report a GitHub issue (form.report.data == 'y'), the platform attempts to fetch .github/ISSUE_TEMPLATE.md via PyGithub:

# mod_upload/controllers.py:259-264
response = repository.get_contents(".github/ISSUE_TEMPLATE.md")
encoded_data = response['content']
if response['encoding'] == 'base64':
    data = base64.b64decode(encoded_data).decode()

Since the migration to PyGithub in commit 74ef5e2 (#774), repository.get_contents(...) returns an instance of github.ContentFile.ContentFile rather than a dictionary.

Because ContentFile does not implement __getitem__, indexing response['content'] raises an unhandled TypeError: 'ContentFile' object is not subscriptable, causing the HTTP request to abort with a 500 Internal Server Error.

In addition, if response.encoding != 'base64', data is left unassigned, resulting in an UnboundLocalError on line 267 (data.replace(...)).

Why Existing Unit Tests Did Not Catch This

In tests/test_upload/test_controllers.py (lines 80–83), the test mocks get_contents to return a plain Python dictionary:

mock_github.return_value.get_repo.return_value.get_contents = mock.MagicMock(return_value={
    "content": base64.b64encode("test".encode("ascii")).decode("ascii"),
    "encoding": 'base64'
})

Because the mock returned a dictionary instead of a ContentFile object, the unit test passes even though real execution against PyGithub fails.

Minimal Reproduction Script

Run the following against PyGithub (as installed from requirements.txt):

from unittest.mock import MagicMock
from github.ContentFile import ContentFile

# PyGithub's actual return type for get_contents()
cf = ContentFile(
    requester=MagicMock(),
    headers={},
    attributes={"content": "dGVzdA==", "encoding": "base64"},
    completed=True
)

# Line 260 of mod_upload/controllers.py:
encoded_data = cf['content']

Output:

Traceback (most recent call last):
  File "repro.py", line 12, in <module>
    encoded_data = cf['content']
                   ~~^^^^^^^^^^^
TypeError: 'ContentFile' object is not subscriptable
Proposed Fix

PyGithub's ContentFile provides a decoded_content property that automatically handles decoding:

response = repository.get_contents(".github/ISSUE_TEMPLATE.md")
data = response.decoded_content.decode('utf-8')

I would be happy to submit a pull request with the fix and an updated unit test using a proper ContentFile mock if this looks good to maintainers.

主要語言
Python
星號
31
分支
92
平均合併
4 天 9 小時
30 天內合併 PR
29

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

CCExtractor/sample-platform 的其他 Issue

查看 CCExtractor/sample-platform 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。