如何使用Flask从URL获取命名参数？

Question

当用户访问运行在我的 Flask 应用程序上的此 URL 时，我希望 Web 服务能够处理问号后指定的参数：

http://10.1.1.1:5000/login?username=alex&password=pw1

#I just want to be able to manipulate the parameters
@app.route('/login', methods=['GET', 'POST'])
def login():
    username = request.form['username']
    print(username)
    password = request.form['password']
    print(password)

- Alex Stone

---

安全提示：不要在GET请求中包含密码。原文链接：https://security.stackexchange.com/questions/147188/is-it-bad-practice-to-use-get-method-as-login-username-password-for-administrato - palsch

安全的又一个小提示：不要将密码发送到HTTP端点（只使用HTTPS）。 - DerMike

Answer 1

使用request.args来获取解析后的查询字符串内容：

from flask import request

@app.route(...)
def login():
    username = request.args.get('username')
    password = request.args.get('password')

- falsetru

---

使用app.route('/username=<username>&password=<password>')中的参数与使用request.args.get()方法相比如何？这样你完全不需要编写request.args.get()的代码行。 - multigoodverse

请参考问题的第一条评论，了解为什么不应该通过GET方式（在URL中）发送密码。更普遍地说，GET请求应该在参数前加上“?”，所以你需要这样的路由：app.route('/?username=<username>&password=<password>')。但是Flask将把问号后面的所有内容读入request.args，而不会从路由中解释变量。如果你想使用HTML表单访问你的示例路由，你将需要大量的额外JavaScript代码来实现它。最后，路由变量是强制性的，而request.args则可选。 - dericke

也许可以稍微改变一下示例。我认为不应该在查询字符串中传递密码。 - vidstige

Answer 2

URL参数可以在request.args中获得，这是一个ImmutableMultiDict，它具有get方法，可选参数为默认值(default)和类型(type)，其中类型是将输入值转换为所需格式的可调用对象。(有关更多详细信息，请参见该方法的文档。)

from flask import request

@app.route('/my-route')
def my_route():
  page = request.args.get('page', default = 1, type = int)
  filter = request.args.get('filter', default = '*', type = str)

以上代码的示例：

/my-route?page=34               -> page: 34  filter: '*'
/my-route                       -> page:  1  filter: '*'
/my-route?page=10&filter=test   -> page: 10  filter: 'test'
/my-route?page=10&filter=10     -> page: 10  filter: '10'
/my-route?page=*&filter=*       -> page:  1  filter: '*'

- qqbenq

---

filter 是一个保留字，不应使用 ;) - Ivan Camilito Ramirez Verdes

@IvanCamilitoRamirezVerdes，你能否提供一个筛选关键词的资源？ - Deepam Gupta

我认为filter不是Python中的_关键字(keyword)_，而是一个内置函数(built-in function)的名称。有关详细信息，请参见https://dev59.com/AGAh5IYBdhLWcg3wDfyy#22864250。 - qqbenq

Answer 3

您还可以在视图定义的URL上使用尖括号<>，这些输入将进入您的视图函数参数。

@app.route('/<name>')
def my_view_func(name):
    return name

- Inbar Cheffer

---

我认为这应该是答案，因为这符合 Flask 文档的要求。 - Nathan Gavenski

这是一个"path"参数，而不是"query"。 - t3ddys

这对我来说似乎不起作用...我从Python中得到了错误。 - Vladimir Despotovic

Answer 4

如果您在URL中传递了一个参数，可以按照以下方式执行

from flask import request
#url
http://10.1.1.1:5000/login/alex

from flask import request
@app.route('/login/<username>', methods=['GET'])
def login(username):
    print(username)

如果您有多个参数：

#url
http://10.1.1.1:5000/login?username=alex&password=pw1

from flask import request
@app.route('/login', methods=['GET'])
    def login():
        username = request.args.get('username')
        print(username)
        password= request.args.get('password')
        print(password)

在POST请求中，您尝试执行的操作适用于作为表单参数传递且未出现在URL中的参数。如果您实际上正在开发登录API，则建议您使用POST请求而不是GET，并将数据暴露给用户。

在POST请求的情况下，它将按以下方式工作：

#url
http://10.1.1.1:5000/login

HTML片段：

<form action="http://10.1.1.1:5000/login" method="POST">
  Username : <input type="text" name="username"><br>
  Password : <input type="password" name="password"><br>
  <input type="submit" value="submit">
</form>

路由:

from flask import request
@app.route('/login', methods=['POST'])
    def login():
        username = request.form.get('username')
        print(username)
        password= request.form.get('password')
        print(password)

- Suchita Mukherjee

Answer 5

网址：

http://0.0.0.0:5000/user/name/

代码：

@app.route('/user/<string:name>/', methods=['GET', 'POST'])
def user_view(name):
    print(name)

（编辑：去掉格式字符串中的空格）

- Manish Kumar

Answer 6

使用 request.args.get(param)，例如：

http://10.1.1.1:5000/login?username=alex&password=pw1

@app.route('/login', methods=['GET', 'POST'])
def login():
    username = request.args.get('username')
    print(username)
    password = request.args.get('password')
    print(password)

这里是参考代码的链接。

- RAJAHMAD MULANI

---

永远不要像那样暴露用户名和密码！请查看TS上的palsh和DerMike评论。 - Bas van Ommen

@BasvanOmmen 这只是一个例子。 - Xbox One

这个正确回答了一种情况，即您仍需要基本URI但想要使用命名参数。我真的很喜欢它。 - PanDe

Answer 7

这应该可以工作

@app.route('/login$username=<username>$password=<password>', methods=['GET', 'POST'])
def login(username, password):
    # you can add stuff
    return f"Username: {username}\nPassword: {password}"

- NOT kar1m yt

---

尽管URI样式不常见，但当作为/login$username=alice123$password=w0nderland调用时确实有效，但客户端请求http://example.com/login时可能会因返回404错误而感到困惑。使用URL参数或哈希路由可能是合适的选择。例如，可以将URI捕获为@app.route('/login?username=<username>&password=<password>', ... )。 - David Golembiowski

Answer 8

这很简单。让我将这个过程分成两个简单的步骤。

1. 在 HTML 模板中，您需要像这样声明用户名和密码的名称属性：

<form method="POST">
<input type="text" name="user_name"></input>
<input type="text" name="password"></input>
</form>

2. 然后，将您的代码修改为以下内容：

from flask import request

@app.route('/my-route', methods=['POST'])
# you should always parse username and 
# password in a POST method not GET
def my_route():
    username = request.form.get("user_name")
    print(username)
    password = request.form.get("password")
    print(password)
    #now manipulate the username and password variables as you wish
    #Tip: define another method instead of methods=['GET','POST'], if you want to  
    # render the same template with a GET request too

- Mr.bunty