如何访问 Flask 路由中的查询参数或查询字符串?这从 Flask 文档中并不明显。
下面的示例路由 /data
说明了我想要访问该数据的上下文。如果有人请求 example.com/data?abc=123
之类的东西,我想访问字符串 ?abc=123
或能够检索 abc
等参数的值。
@app.route("/data")
def data():
# query_string = ???
return render_template("data.html")
from flask import request
@app.route('/data')
def data():
# here we want to get the value of user (i.e. ?user=some-value)
user = request.args.get('user')
完整 URL 以 request.url
的形式提供,查询字符串以 request.query_string.decode()
的形式提供。
这是一个例子:
from flask import request
@app.route('/adhoc_test/')
def adhoc_test():
return request.query_string
要访问在查询字符串中传递的单个已知参数,您可以使用 request.args.get('param')
。据我所知,这是“正确”的做法。
ETA:在你更进一步之前,你应该问自己为什么需要查询字符串。我从来不用提取原始字符串——Flask 有以抽象方式访问它的机制。你应该使用这些,除非你有令人信服的理由不这样做。
ETA: Before you go further, you should ask yourself why you want the query string
,因为如果您的 API 具有 OAuth 类型的身份验证机制,我认为您将需要阅读查询参数,(自从我今天开始学习 Flask 以来,我不太确定我是否对 Flask 进行了更正!)
request.args.get
请求这些键。
我来这里是为了寻找查询字符串,而不是如何从查询字符串中获取值。
request.query_string
将 URL 参数作为原始字节字符串返回(参考 1)。
使用 request.query_string
的示例:
from flask import Flask, request
app = Flask(__name__)
@app.route('/data', methods=['GET'])
def get_query_string():
return request.query_string
if __name__ == '__main__':
app.run(debug=True)
输出:
https://i.stack.imgur.com/Pgup1.png
参考:
query_string 上的官方 API 文档
我们可以通过使用 request.query_string 来做到这一点。
例子:
让我们考虑 view.py
from my_script import get_url_params
@app.route('/web_url/', methods=('get', 'post'))
def get_url_params_index():
return Response(get_url_params())
您还可以使用 Flask 蓝图使其更加模块化 - https://flask.palletsprojects.com/en/1.1.x/blueprints/
让我们考虑名字作为查询字符串的一部分传递 /web_url/?first_name=john
## here is my_script.py
## import required flask packages
from flask import request
def get_url_params():
## you might further need to format the URL params through escape.
firstName = request.args.get('first_name')
return firstName
如您所见,这只是一个小示例 - 您可以获取多个值 + 格式化这些值并使用它或将其传递给模板文件。
Werkzeug/Flask 已经为您解析了所有内容。无需使用 urlparse 再次执行相同的工作:
from flask import request
@app.route('/')
@app.route('/data')
def data():
query_string = request.query_string ## There is it
return render_template("data.html")
请求和响应对象的完整文档位于 Werkzeug:http://werkzeug.pocoo.org/docs/wrappers/
像这样尝试查询字符串:
from flask import Flask, request
app = Flask(__name__)
@app.route('/parameters', methods=['GET'])
def query_strings():
args1 = request.args['args1']
args2 = request.args['args2']
args3 = request.args['args3']
return '''<h1>The Query String are...{}:{}:{}</h1>''' .format(args1,args2,args3)
if __name__ == '__main__':
app.run(debug=True)
https://i.stack.imgur.com/qjzUn.png
如 O'Reilly Flask Web Devleopment 中所述,可从烧瓶请求对象中检索的每种形式的查询字符串:
从 O'Reilly Flask Web Development 开始,正如 Manan Gouhari 之前所说,首先您需要导入请求:
from flask import request
request
是一个由 Flask 公开为名为(您猜对了)request
的上下文变量的对象。顾名思义,它包含所有客户端包含在 HTTP 请求中的信息。该对象有许多属性和方法,您可以分别检索和调用它们。
您有很多 request
属性,其中包含可供选择的查询字符串。在这里,我将列出以任何方式包含查询字符串的每个属性,以及 O'Reilly 书中对该属性的描述。
首先是 args
,它是“一个字典,其中包含在 URL 的查询字符串中传递的所有参数。”因此,如果您希望将查询字符串解析为字典,您可以执行以下操作:
from flask import request
@app.route('/'):
queryStringDict = request.args
(正如其他人指出的,您还可以使用 .get('<arg_name>')
从字典中获取特定值)
然后是 form
属性,它 not 包含查询字符串,但它包含在另一个属性的一部分中 does 包含查询字符串,我将暂时列出。不过,首先,form
是“包含随请求提交的所有表单字段的字典”。我这么说是这样说的:烧瓶请求对象中还有另一个可用的字典属性,称为 values
。 values
是“将 form
和 args
中的值组合在一起的字典”。检索看起来像这样:
from flask import request
@app.route('/'):
formFieldsAndQueryStringDict = request.values
(同样,使用 .get('<arg_name>')
从字典中获取特定项目)
另一个选项是 query_string
,它是“URL 的查询字符串部分,作为原始二进制值”。例子:
from flask import request
@app.route('/'):
queryStringRaw = request.query_string
然后作为额外的奖励有 full_path
,它是“URL 的路径和查询字符串部分”。给ejemlo:
from flask import request
@app.route('/'):
pathWithQueryString = request.full_path
最后,url
,“客户端请求的完整 URL”(包括查询字符串):
from flask import request
@app.route('/'):
pathWithQueryString = request.url
快乐的黑客:)
下面的实现对我有用。
from flask import request
def getVerificationStatus():
try:
requestId=int(request.args.get('requestId'))
print(requestId)
status= verificationStepRepository.getVerificationStatus(requestId)
return tb.responsify(200, "success", status)
except Exception as e:
return errorHandler.dispatchInternalServerError(str(e))
我更喜欢
user = request.args['user'] if 'user' in request.args else 'guest'
超过
user = request.args.get('user')
这样,您可以先检查 url 中是否包含查询字符串
这可以使用 request.args.get()
完成。例如,如果您的查询字符串有一个字段 date
,则可以使用
date = request.args.get('date')
不要忘记将“request
”添加到来自烧瓶的导入列表中,即
from flask import request
如果请求是 GET 并且我们传递了一些查询参数,那么,
fro`enter code here`m flask import request
@app.route('/')
@app.route('/data')
def data():
if request.method == 'GET':
# Get the parameters by key
arg1 = request.args.get('arg1')
arg2 = request.args.get('arg2')
# Generate the query string
query_string="?arg1={0}&arg2={1}".format(arg1, arg2)
return render_template("data.html", query_string=query_string)
通常我们只想将整个查询字符串映射到适当的 python 数据结构中并从那里获取它。适当的结构是多字典,因为关键字可以重复,例如我们需要处理 A=123&A=456&B=789
。多字典是 2 元组的列表,其中每个 2 元组包含作为其第一项的键和作为其第二项的值列表,因此上面转到 [('A',['123','456']),('B',['789'])]
。这一切都是通过
qstr = request.args.lists() # A generator for the multi-dict
qstr = list(qstr) # To get the actual multi-dict
如果你想要的只是一个字典,其中第一次出现重复的关键字,你可以去
qstr = request.args.to_dict()