Wrong signature for `KafkaError`'s 1st parameter in `.pyi`

Abierto Apto para principiantes
#2,243 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

@wgu9 ya está trabajando en esto.

Desde el 14/6/2026.

  • #2278 de @wgu9 — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
70/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
c, python

Línea de trabajo

Compara la declaración de KafkaError en src/confluent_kafka/cimpl.pyi con el manejo del constructor en src/confluent_kafka/src/confluent_kafka.c. Reproduce la discrepancia con los comandos de mypy y Python indicados, y luego verifica que la firma elegida sea aceptada de forma coherente tanto por la comprobación de tipos como durante la ejecución.

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

Descripción

The name of the 1st parameter for KafkaError's initialiser in src/confluent_kafka/cimpl.pyi is now code (ref here), however this does not match the underlying code itself.

For example, if we try to create an instance of KafkaError according to the signature:

# kafka_error_test.py

from confluent_kafka import KafkaError

error = KafkaError(code=1)

Then mypy is OK with this

# mypy kafka_error_test.py 
Success: no issues found in 1 source file

But we get a TypeError when it runs

# python kafka_error_test.py 
Traceback (most recent call last):
  File "/workspaces/kafka_error_test.py", line 5, in <module>
    error = KafkaError(code=1)

I'm happy to submit a PR to fix this but which way do we want to go here? Change the signature in the .pyi file so it matches what the underlying C code expects? Or change the underlying C code to match up with the signature?

Lenguaje dominante
Python
Estrellas
528
Forks
977
Merge medio
2 d 19 h
PR fusionados (30 d)
19

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

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 confluentinc/confluent-kafka-python

Todos los issues de confluentinc/confluent-kafka-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.