allure-framework / allure-framework/allure-python

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

Offen
#792 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
task:improvement theme:core
Vorherrschende Sprache
Python
Sterne
814
Forks
260
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie mit dem Lesen der Definition von StepContext und seiner Verwendung in _allure.py. Untersuchen Sie anschließend die öffentlichen Exporte in allure.py. Machen Sie StepContext über allure.py verfügbar, damit der Beispiel-Wrapper es in einer Rückgabeannotation verwenden kann, und überprüfen Sie, dass der öffentliche Import funktioniert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api
Issue-Typ
Feature
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.