Может ли Flask иметь необязательные параметры URL?

258

Можно ли напрямую объявить необязательный параметр URL фляги?

В настоящее время я иду следующим образом:

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

Как я могу прямо сказать, что usernameэто необязательно?

Noor
источник

Ответы:

342

Другой способ это написать

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

Но я думаю, что вы хотите написать один маршрут и пометить usernameкак необязательный? Если это так, я не думаю, что это возможно.

Аудрюс Кажукаускас
источник
Есть проблемы с использованием этого метода при обращении к конечным точкам и url_for?
2
Не то, что я знаю о. Даже документы Flask содержат похожий пример (вам нужно немного прокрутить вниз, чтобы увидеть его).
Аудрюс Кажукаускас
1
Вы можете попробовать установить pip flask_optional_routes. Я создал пункт для функциональности, которую вы запрашиваете, потому что она мне тоже нужна. Код находится по адресу: github.com/sudouser2010/flask_optional_routes .
sudouser2010
upvoted! если у вас есть несколько вкладок на домашней странице, где каждая из них вызывает что-то вроде / one / two / three / four и вы хотите загружать разное содержимое на одной странице без перезагрузки страницы, следует ли использовать один маршрут или несколько маршрутов?
PirateApp
@PirateApp, который не может быть достигнут с помощью только Flask и является просто функцией
веб-
183

Почти то же самое, что Audrius готовил несколько месяцев назад, но вы можете найти его немного более читаемым со значениями по умолчанию в заголовке функции - как вы привыкли с python:

@app.route('/<user_id>')
@app.route('/<user_id>/<username>')
def show(user_id, username='Anonymous'):
    return user_id + ':' + username
могул
источник
3
Кроме того, это работает, если usernameне является постоянным. defaults=замораживает значение по умолчанию в словаре.
kasperhj
2
Я предпочитаю этот. Мы должны держать код как можно более чистым.
Light.G
Имейте в виду, что здесь есть большая оговорка: если у вас есть несколько позиционных аргументов и не все из них необязательны, колба не поймет, как правильно построить URL. Вы можете получить что-то вроде / page? Arg = foo, где это должно быть / foo / page. @Audrius Kažukauskas ответ работает в этом случае, но это не так
rgargente
73

Если вы используете Flask-Restful, как я, это также возможно:

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

затем в вашем классе ресурсов:

class UserAPI(Resource):

  def get(self, userId, username=None):
    pass
skornos
источник
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
Вы должны добавить сюда информацию из внешней ссылки, потому что, если эта ссылка больше не действительна, ваш ответ будет поврежден.
Томаб
9
@user.route('/<user_id>', defaults={'username': default_value})
@user.route('/<user_id>/<username>')
def show(user_id, username):
   #
   pass
Аман Кумар
источник
5

Почти так же, как скорно, но с объявлениями переменных для более четкого ответа. Может работать с расширением 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_resourceМетод позволяет проход кратные URL. Каждый из них будет перенаправлен на ваш ресурс .

yoelvis
источник
1

Я знаю, что этот пост действительно старый, но я работал над пакетом, который называет это flask_optional_routes. Код находится по адресу: 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
источник
0

Вы можете написать, как показано в примере, но затем вы получите ошибку сборки.

Для исправления этого:

  1. распечатать app.url_map () в корне .py
  2. вы видите что-то вроде:

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

и

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

  1. чем в шаблоне вы можете {{ url_for('.show_0', args) }}и{{ url_for('.show_1', args) }}
lov3catch
источник
-6

Начиная с Flask 0.10, вы не можете добавлять несколько маршрутов к одной конечной точке. Но вы можете добавить поддельную конечную точку

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

@user.route('/<userId>/<username>')
def show_with_username(userId,username=None):
   pass
Сергей Баргамон
источник
5
Какой? Используя колбу 0.10.1, я могу добавить несколько маршрутов к одной конечной точке.
Яапз
-8

Я думаю, что вы можете использовать Blueprint, и это сделает ваш код лучше и аккуратнее.

пример:

from flask import Blueprint

bp = Blueprint(__name__, "example")

@bp.route("/example", methods=["POST"])
def example(self):
   print("example")
Def Putra
источник
Это не отвечает на вопрос.
meyer9