marshmallow-code / marshmallow-code/webargs

RFC: Use annotations for parsing arguments

Aperta
#353 6 commenti 6 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

feedback welcome
Lingua principale
Python
Stelle
1.4k
Fork
167
Merge medio
17h 8m
PR unite (30g)
4

Descrizione

Add a decorator that will parse request arguments from the view function's type annotations.

I've built a working proof of concept of this idea in [webargs-starlette](https://github.com/sloria/webargs-starlette).

```python
@app.route("/")
@use_annotations(locations=("query",))
async def index(request, name: str = "World"):
return JSONResponse({"Hello": name})
```

A marshmallow `Schema` is generated from the annotations using `Schema.TYPE_MAPPING` to construct fields.

The code for `use_annotations` mostly isn't tied to Starlette and could be adapted for `AsyncParser` (and `core.Parser` when we drop Python 2 support).

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando la proof of concept in webargs-starlette, quindi analizza AsyncParser e core.Parser e il modo in cui marshmallow Schema.TYPE_MAPPING costruisce i campi. Il lavoro è completato quando l’approccio use_annotations basato sulle annotazioni viene adattato ai parser pertinenti, in modo che gli argomenti della richiesta vengano analizzati a partire dalle annotazioni delle funzioni view.

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

Valutazione

Stack tecnologico
python
Ambito
api, backend
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
28/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.