allure-framework / allure-framework/allure-python

[Feature request] Make `StepContext` available in public API for annotations

Abierto
#792 0 comentarios 0 reacciones 0 asignados Ver en GitHub
task:improvement theme:core
Lenguaje dominante
Python
Estrellas
814
Forks
260
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

#### I'm submitting a ...
- [x] feature request

#### What is the current behavior?
```python
def allure_step__foo(content: str):
return allure.step(content)
```
Annotating return type of such function is not possible, because `allure.step` returns internal `StepContext` (under `_allure.py`)

#### What is the expected behavior?

Make `StepContext` available in `allure.py`

#### What is the motivation / use case for changing the behavior?

Adding `StepContext` to public API will allow to annotate return type of `allure_step__foo` in a nice and simple way via:

```python
def allure_step__foo(content: str) -> StepContext: ...
```

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza leyendo la definición de StepContext y su uso en _allure.py; después, inspecciona las exportaciones públicas de allure.py. Haz que StepContext esté disponible desde allure.py para que el wrapper de ejemplo pueda usarlo en una anotación de retorno, y verifica que la importación pública funcione.

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

Evaluación

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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.