Kann Flask optionale URL-Parameter haben?

258

Ist es möglich, einen optionalen Parameter für die Kolben-URL direkt zu deklarieren?

Derzeit gehe ich folgendermaßen vor:

@user.route('/<userId>')
@user.route('/<userId>/<username>')
def show(userId, username=None):
    pass

Wie kann ich direkt sagen, dass dies usernameoptional ist?

Noor
quelle

Antworten:

341

Ein anderer Weg ist zu schreiben

@user.route('/<user_id>', defaults={'username': None})
@user.route('/<user_id>/<username>')
def show(user_id, username):
    pass

Aber ich denke, Sie möchten eine einzelne Route schreiben und usernameals optional markieren ? Wenn das der Fall ist, denke ich nicht, dass es möglich ist.

Audrius Kažukauskas
quelle
Probleme bei der Verwendung dieser Methode beim Verweisen auf Endpunkte und url_for?
2
Nicht, dass ich davon Wüste. Sogar Flask- Dokumente enthalten ein ähnliches Beispiel (Sie müssen ein wenig nach unten scrollen, um es zu sehen).
Audrius Kažukauskas
1
Sie können versuchen, flask_optional_routes zu installieren. Ich habe einen Pip für die Funktionalität erstellt, die Sie anfordern. B / C Ich brauchte ihn auch. Der Code befindet sich unter: github.com/sudouser2010/flask_optional_routes .
Sudouser2010
upvoted! Wenn Ihre Startseite mehrere Registerkarten enthält, auf denen jede so etwas wie / eins / zwei / drei / vier auslöst, und Sie unterschiedliche Inhalte auf dieselbe Seite laden möchten, ohne die Seite neu zu laden, sollten Sie eine einzelne Route oder mehrere Routen verwenden?
PirateApp
@ PirateApp, die nicht nur mit Flask erreicht werden kann und nur ein Frontend-Feature ist
qaisjp
183

Fast das gleiche wie Audrius vor einigen Monaten, aber vielleicht finden Sie es mit den Standardeinstellungen im Funktionskopf etwas besser lesbar - so wie Sie es von Python gewohnt sind:

@app.route('/<user_id>')
@app.route('/<user_id>/<username>')
def show(user_id, username='Anonymous'):
    return user_id + ':' + username
Mogul
quelle
3
Auch das funktioniert wenn usernamenicht konstant ist. defaults=friert den Standardwert in einem Wörterbuch ein.
Kasperhj
2
Ich bevorzuge dieses hier. Wir sollten den Code so sauber wie möglich halten.
Light.G
Beachten Sie, dass hier eine große Einschränkung besteht: Wenn Sie mehrere Positionsargumente haben und nicht alle optional sind, versteht flask nicht, wie die URL richtig erstellt wird. Sie können so etwas wie / page? Arg = foo bekommen, wo es / foo / page sein sollte. @Audrius Kažukauskas Antwort funktioniert in diesem Fall, aber das nicht
rgargente
73

Wenn Sie Flask-Restful wie ich verwenden, ist dies auch folgendermaßen möglich:

api.add_resource(UserAPI, '/<userId>', '/<userId>/<username>', endpoint = 'user')

a dann in Ihrer Ressourcenklasse:

class UserAPI(Resource):

  def get(self, userId, username=None):
    pass
Skornos
quelle
11
@app.route('/', defaults={'path': ''})
@app.route('/< path:path >')
def catch_all(path):
    return 'You want path: %s' % path

http://flask.pocoo.org/snippets/57/

Sona
quelle
3
Sie sollten hier die Informationen aus dem externen Link hinzufügen, da Ihre Antwort beschädigt wird, wenn dieser Link nicht mehr gültig ist.
Tomab
9
@user.route('/<user_id>', defaults={'username': default_value})
@user.route('/<user_id>/<username>')
def show(user_id, username):
   #
   pass
Aman Kumar
quelle
5

Fast das gleiche wie Skornos, jedoch mit variablen Deklarationen für eine explizitere Antwort. Es kann mit der Flask-RESTful-Erweiterung funktionieren :

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class UserAPI(Resource):
    def show(userId, username=None):
    pass

api.add_resource(UserAPI, '/<userId>', '/<userId>/<username>', endpoint='user')

if __name__ == '__main__':
    app.run()

Die add_resourceMethode ermöglicht die Übergabe mehrerer URLs. Jeder wird an Ihre Ressource weitergeleitet .

Yoelvis
quelle
1

Ich weiß, dass dieser Beitrag wirklich alt ist, aber ich habe an einem Paket namens flask_optional_routes gearbeitet, das dies tut. Der Code befindet sich unter: https://github.com/sudouser2010/flask_optional_routes .

from flask import Flask

from flask_optional_routes import OptionalRoutes


app = Flask(__name__)
optional = OptionalRoutes(app)

@optional.routes('/<user_id>/<user_name>?/')
def foobar(user_id, user_name=None):
    return 'it worked!'

if __name__ == "__main__":
    app.run(host='0.0.0.0', port=5000)
sudouser2010
quelle
0

Sie können schreiben, wie Sie im Beispiel zeigen, aber dann erhalten Sie einen Build-Fehler.

Um dies zu beheben:

  1. drucke app.url_map () in deine root .py
  2. Sie sehen so etwas wie:

<Rule '/<userId>/<username>' (HEAD, POST, OPTIONS, GET) -> user.show_0>

und

<Rule '/<userId>' (HEAD, POST, OPTIONS, GET) -> .show_1>

  1. als in Vorlage können Sie {{ url_for('.show_0', args) }}und{{ url_for('.show_1', args) }}
lov3catch
quelle
-6

Seit Flask 0.10 können Sie einem Endpunkt nicht mehrere Routen hinzufügen. Sie können jedoch einen gefälschten Endpunkt hinzufügen

@user.route('/<userId>')
def show(userId):
   return show_with_username(userId)

@user.route('/<userId>/<username>')
def show_with_username(userId,username=None):
   pass
Sergey Bargamon
quelle
5
Was? Wenn Sie hier den Kolben 0.10.1 verwenden, kann ich einem Endpunkt problemlos mehrere Routen hinzufügen.
Jaapz
-8

Ich denke, Sie können Blueprint verwenden, und dadurch sieht Ihr Code besser und ordentlicher aus.

Beispiel:

from flask import Blueprint

bp = Blueprint(__name__, "example")

@bp.route("/example", methods=["POST"])
def example(self):
   print("example")
Def Putra
quelle
Dies beantwortet die Frage nicht.
Meyer9