O Flask pode ter parâmetros de URL opcionais?

258

É possível declarar diretamente um parâmetro opcional do URL do balão?

Atualmente, estou procedendo da seguinte maneira:

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

Como posso dizer diretamente que usernameé opcional?

Noor
fonte

Respostas:

341

Outra maneira é escrever

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

Mas acho que você deseja escrever uma única rota e marcar usernamecomo opcional? Se for esse o caso, não acho possível.

Audrius Kažukauskas
fonte
Algum problema ao usar esse método ao referenciar endpoints e url_for?
2
Não que eu saiba. Até os documentos do Flask contêm exemplo semelhante (você precisa rolar um pouco para baixo para vê-lo).
Audrius Kažukauskas
1
Você pode tentar instalar o pip flask_optional_routes. Eu criei um pip para a funcionalidade que você está solicitando porque eu também precisava. O código está localizado em: github.com/sudouser2010/flask_optional_routes .
sudouser2010
votado! se você tiver várias guias em sua página inicial, nas quais cada uma dispara algo como / um / dois / três / quatro e deseja carregar conteúdo diferente na mesma página sem recarregar a página, você deve usar uma única rota ou várias rotas?
PirateApp 25/07
@PirateApp que não pode ser alcançado com apenas Flask e é puramente um recurso de frontend
qaisjp
183

Quase o mesmo que o Audrius inventou alguns meses atrás, mas você pode achar um pouco mais legível com os padrões no cabeçote da função - da maneira como você está acostumado com o python:

@app.route('/<user_id>')
@app.route('/<user_id>/<username>')
def show(user_id, username='Anonymous'):
    return user_id + ':' + username
magnata
fonte
3
Além disso, isso funciona se usernamenão for constante. defaults=congela o valor padrão em um dicionário.
kasperhj
2
Eu prefiro este. Devemos manter o código o mais limpo possível.
Light.G 21/03/19
Lembre-se de que há uma grande ressalva aqui: se você tiver vários argumentos posicionais e nem todos opcionais, o balão não entenderá como criar o URL corretamente. Você pode obter algo como / page? Arg = foo onde deveria estar / foo / page. @Audrius Kažukauskas resposta funciona nesse caso, mas isso não faz
rgargente
73

Se você estiver usando o Flask-Restful como eu, também é possível desta maneira:

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

a então na sua classe Resource:

class UserAPI(Resource):

  def get(self, userId, username=None):
    pass
skornos
fonte
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
fonte
3
Você deve adicionar aqui as informações do link externo, pois se esse link não for mais válido, sua resposta será danificada.
tomab
9
@user.route('/<user_id>', defaults={'username': default_value})
@user.route('/<user_id>/<username>')
def show(user_id, username):
   #
   pass
aman kumar
fonte
5

Quase o mesmo que skornos, mas com declarações variáveis ​​para uma resposta mais explícita. Pode funcionar com a extensão 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()

O add_resourcemétodo permite passar URLs múltiplos. Cada um será roteado para o seu Recurso .

yoelvis
fonte
1

Eu sei que este post é muito antigo, mas trabalhei em um pacote que faz isso chamado flask_optional_routes. O código está localizado em: 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
fonte
0

Você pode escrever como mostra no exemplo, mas obtém um erro de construção.

Para corrigir isso:

  1. imprima app.url_map () no seu root .py
  2. você vê algo como:

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

e

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

  1. do que no modelo você pode {{ url_for('.show_0', args) }}e{{ url_for('.show_1', args) }}
lov3catch
fonte
-6

Desde o Flask 0.10, você não pode adicionar várias rotas a um ponto final. Mas você pode adicionar um ponto de extremidade falso

@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
fonte
5
O que? Usando o balão 0.10.1 aqui, posso adicionar várias rotas a um ponto final.
jaapz
-8

Eu acho que você pode usar o Blueprint e isso fará com que seu código tenha uma aparência melhor e ordenada.

exemplo:

from flask import Blueprint

bp = Blueprint(__name__, "example")

@bp.route("/example", methods=["POST"])
def example(self):
   print("example")
Def Putra
fonte
Isso não responde à pergunta.
meyer9