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

【问题标题】：How can I get the named parameters from a URL using Flask?如何使用 Flask 从 URL 获取命名参数？
【发布时间】：2014-09-13 13:09:46
【问题描述】：

当用户访问在我的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)

【问题讨论】：

只是一个小小的安全提示：不要在 GET 请求中包含密码。 security.stackexchange.com/questions/147188/…
另一个安全小提示：不要将密码发送到 HTTP 端点（仅限 HTTPS）

标签： python web-services flask url-parameters

【解决方案1】：

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

from flask import request

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

【讨论】：

这与在app.route('/username=<username>&password=<password>') 中使用参数相比如何？这样你就不用写 request.args.get 行了。
@multigoodverse 查看关于为什么不应该通过 GET（在 URL 中）发送密码的问题的第一条评论。更一般地说，一个 GET 请求应该在参数的开头有一个?，所以你会想要app.route('/?username=<username>&password=<password>')，但是 Flask 会将问号后面的所有内容读入request.args，并且不会解释来自路由的变量.如果您想使用 HTML 表单访问您的示例路由，则需要一堆额外的 JavaScript 才能使其工作。最后，路由变量是必须的，request.args 可以是可选的。

【解决方案2】：

URL 参数在request.args 中可用，这是一个ImmutableMultiDict，具有get 方法，具有默认值（default）和类型（type）的可选参数 - 这是一个可调用的将输入值转换为所需的格式。（有关详细信息，请参阅documentation of the method。）

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: '*'

【讨论】：

filter 是保留字，不应使用;)
@IvanCamilitoRamirezVerdes 能否提供此过滤关键字的资源？
@Genius 我认为filter 不是python 中的关键字，而是内置函数的名称。详情请见stackoverflow.com/a/22864250/1552016。

【解决方案3】：

您还可以在视图定义的 URL 上使用方括号，此输入将进入您的视图函数参数

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

【讨论】：

我认为这应该是答案，因为它是 de flask 文档的用途
这是一个 path 参数，而不是 query
这对我不起作用....我从 python 得到错误。

【解决方案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 sn-p:

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

【讨论】：

【解决方案5】：

网址：

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

代码：

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

（编辑：删除格式字符串中的空格）

【讨论】：

【解决方案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)

Here is the referenced link to the code.

【讨论】：

永远不要这样暴露用户名和密码！参见 palsh 和 DerMike cmets 的 TS。
@BasvanOmmen 这只是一个例子
这个正确答案是您需要仍然拥有 basicURI 但想要使用命名参数的场景。我真的很喜欢。

【解决方案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}"

【讨论】：

尽管 URI 样式不常见，但在调用 /login$username=alice123$password=w0nderland 时确实有效，但客户端请求 http://example.com/login 在返回 404 错误时可能会混淆。改用 URL 参数或哈希路由可能更合适。例如，可以将 URI 捕获为 @app.route('/login?username=<username>&password=<password>', ... )。

【解决方案8】：

这真的很简单。让我把这个过程分为两个简单的步骤。

在 html 模板中，您将声明用户名和密码的名称属性，如下所示：

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

然后，像这样修改您的代码：

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

【讨论】：