python / python/cpython

unittest.mock spec and create_autospec should support type-hints

Abierto
#124,816 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

type-feature
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Feature or enhancement

Proposal:

Current recommendation for spec=... and create_autospec is to set a default class value in case of attributes created within an instance's __init__():

Probably the best way of solving the problem is to add class attributes as default values for instance members initialised in __init__()

The problem is that like written, Nones are never useful and together with spec_set=True it just results in a regular mock that accepts everything.

That recommendation and method are unfortunately very old and they existed long before the type hinting system was so developed. I believe type hints can now be reliably used to infer the spec, at least in simple terms, and in the other cases the same behavior as None can be implemented.

from unittest.mock import create_autospec

class A:
  a: dict[str, int]
  b: Iterator[str]
  c: int | str | complex

mock = create_autospec(A)
mock().a  # should be supported, with a dict spec.
mock().b  # Iterator spec
mock().c  # Too complex... Any spec (just like current behavior for None)

It will lead into more accurate unit tests, and we can optionally hide the behavior behind a boolean such as infer_types=True.

Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

No response

Guía de contribución

Abrir la 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.

Línea de trabajo

Empieza rastreando los puntos de entrada de unittest.mock y create_autospec, incluido cómo spec_set=True gestiona actualmente los atributos de instancia inicializados en init. Define el comportamiento para las indicaciones de tipo simples, las uniones complejas y la bandera opcional de inferencia propuesta; se considera terminado cuando las anotaciones solicitadas producen especificaciones adecuadas sin cambiar el comportamiento alternativo para los casos no compatibles.

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

Evaluación

Stack tecnológico
python
Área
testing-qa
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.