allure-framework / allure-framework/allure-python

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

Aperta
#792 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
task:improvement theme:core
Lingua principale
Python
Stelle
814
Fork
260
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

#### 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: ...
```

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo la definizione di StepContext e il suo utilizzo in _allure.py, quindi esamina le esportazioni pubbliche in allure.py. Rendi StepContext disponibile da allure.py affinché il wrapper di esempio possa utilizzarlo in un’annotazione del valore restituito, e verifica che l’importazione pubblica funzioni.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.