Sphinx Autoflask – Unterscheiden Sie Dokumentzeichenfolgen für GET- und POST-Anfragen für dieselbe Funktion ⇐ Python

[Anonymous]

Ich habe eine Flask-Anwendung, für die ich über Python-Sphinx eine Dokumentation erstelle.

Ich verwende derzeit die Autoflask-Erweiterung von sphinxcontrib.autohttp.flask

Meine Frage ist: Wie kann ich einen Dokumentstring vorbereiten, der unterschiedliche Informationen ordnungsgemäß auf eine GET-Version und eine POST-Version derselben Route anwendet?

Zum Beispiel eine kleine Funktion:

Code: Select all

@app.route('/add_event', methods=['GET', 'POST'])
def add_event():
"""
..http:get:: /add_event
:return: Test
..http:post:: /add_event
:return: Test2
"""
if request.method == 'GET':
# get some things
person_id = request.args.get('id')
return render_template('create_event.html', race_event_form=test_form)
if request.method == 'POST':
# post some things

return redirect('/person_profile/id/{0}'.format(request.args.get('id')))

Meine aktuellen Erweiterungen in conf.py

Code: Select all

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinxcontrib.httpdomain',
'sphinxcontrib.autohttp.flask',
'sphinxcontrib.autohttp.flaskqref'
]

Die Sphinx-Ausgabe sieht aus wie




Ist es möglich, eine Sache für einen GET und eine andere für einen POST zu korrigieren? Ich möchte wirklich vermeiden, jede Funktion in zwei separate Get-/Post-Funktionen aufzuteilen.

Ist es außerdem möglich, dass die Autoflask-Ausgabe erforderliche Argumente über request.args oder request.form weiterleitet, wie die Variable person_id in der GET-Anfrage?