RFC: Use annotations for parsing arguments

Aperta
  • Qualcosa non va?
#353 6 commenti 6 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

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

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.

Descrizione

feedback welcome

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.

@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).

Lingua principale
Python
Stelle
1.4k
Fork
171
Merge medio
8h 47m
PR unite (30g)
12

Preparare l'ambiente

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.

Altre issue di marshmallow-code/webargs

Tutte le issue di marshmallow-code/webargs

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.