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

Abierto
#1,261 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 4 días

@garv-sanveria ya está trabajando en esto.

Desde el 5/11/2026.

  • #1262 de @garv-sanveria — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
30/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
python
Área
backend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
31
Forks
92
Merge medio
4 d 9 h
PR fusionados (30 d)
29

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de CCExtractor/sample-platform

Todos los issues de CCExtractor/sample-platform

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.