Czy Flask może mieć opcjonalne parametry adresu URL?


258

Czy można bezpośrednio zadeklarować opcjonalny parametr adresu URL kolby?

Obecnie postępuję następująco:

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

Jak mogę bezpośrednio powiedzieć, że usernamejest to opcjonalne?

Odpowiedzi:


341

Innym sposobem jest pisanie

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

Ale myślę, że chcesz napisać jedną trasę i oznaczyć ją usernamejako opcjonalną? Jeśli tak jest, nie sądzę, że to możliwe.


Masz problemy z użyciem tej metody podczas odwoływania się do punktów końcowych i adresu URL?

2
Nie żebym o tym wiedział. Nawet dokumenty Flask zawierają podobny przykład (musisz trochę przewinąć w dół, aby go zobaczyć).
Audrius Kažukauskas,

1
Możesz wypróbować pip install flask_optional_routes. Stworzyłem pip dla funkcji, o którą prosisz, bo ja również go potrzebowałem. Kod znajduje się na stronie: github.com/sudouser2010/flask_optional_routes .
sudouser2010

entuzjastycznie! jeśli masz wiele zakładek na stronie głównej, z których każda uruchamia coś takiego jak / one / two / three / four i chcesz załadować inną treść na tej samej stronie bez ponownego ładowania strony, czy powinieneś użyć jednej trasy lub wielu tras?
PirateApp

@PirateApp, którego nie da się osiągnąć za pomocą Flask i jest to wyłącznie funkcja frontendowa
qaisjp

183

Prawie taki sam, jak Audrius, ugotowany kilka miesięcy temu, ale może być nieco bardziej czytelny z domyślnymi ustawieniami w funkcji head - tak jak jesteś przyzwyczajony do Pythona:

@app.route('/<user_id>')
@app.route('/<user_id>/<username>')
def show(user_id, username='Anonymous'):
    return user_id + ':' + username

3
Działa to również, jeśli usernamenie jest stałe. defaults=zamraża wartość domyślną w słowniku.
kasperhj

2
Wolę tą. Powinniśmy zachować kod tak czysty, jak to tylko możliwe.
Light.G

Pamiętaj, że jest tu duże zastrzeżenie: jeśli masz wiele argumentów pozycyjnych i nie wszystkie są opcjonalne, kolba nie zrozumie, jak poprawnie zbudować adres URL. Możesz uzyskać coś takiego jak / page? Arg = foo gdzie powinno być / foo / page. @Audrius Kažukauskas odpowiedź działa w takim przypadku, ale tak nie jest
rgargente

73

Jeśli używasz Flask-Restful jak ja, jest to również możliwe w ten sposób:

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

a następnie w twojej klasie zasobów:

class UserAPI(Resource):

  def get(self, userId, username=None):
    pass


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/


3
Powinieneś dodać tutaj informacje z linku zewnętrznego, ponieważ jeśli ten link nie będzie już ważny, twoja odpowiedź zostanie uszkodzona.
tomab

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

5

Prawie to samo co skornos, ale ze zmiennymi deklaracjami, aby uzyskać bardziej jednoznaczną odpowiedź. Może współpracować z rozszerzeniem Flask-RESTful :

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()

add_resourceMetoda pozwala wielokrotności przepustowe URL. Każdy zostanie przekierowany do Twojego zasobu .


1

Wiem, że ten post jest naprawdę stary, ale pracowałem nad pakietem o nazwie flask_optional_routes. Kod znajduje się na stronie : 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)

0

Możesz pisać tak, jak pokazano w przykładzie, ale wtedy pojawia się błąd kompilacji.

Aby to naprawić:

  1. wypisz app.url_map () w swoim katalogu głównym .py
  2. widzisz coś takiego:

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

i

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

  1. niż w szablonie możesz {{ url_for('.show_0', args) }}i{{ url_for('.show_1', args) }}

-6

Od wersji Flask 0.10 nie można dodawać wielu tras do jednego punktu końcowego. Ale możesz dodać fałszywy punkt końcowy

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

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

5
Co? Używając kolby 0.10.1 tutaj i mogę dodać wiele tras do jednego punktu końcowego w porządku.
jaapz

-8

Myślę, że możesz używać Blueprint, dzięki czemu Twój kod będzie wyglądał lepiej i ładniej.

przykład:

from flask import Blueprint

bp = Blueprint(__name__, "example")

@bp.route("/example", methods=["POST"])
def example(self):
   print("example")

To nie odpowiada na pytanie.
meyer9
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.