如何访问 Flask 路由中的查询字符串?
- 2025-01-21 09:01:00
- admin 原创
- 71
问题描述:
如何访问 Flask 路由中的查询参数或查询字符串?Flask 文档中没有明确说明。
下面的示例路由/data
说明了我想要访问该数据的环境。如果有人请求类似的东西example.com/data?abc=123
,我希望访问字符串?abc=123
或能够检索类似参数的值abc
。
@app.route("/data")
def data():
# query_string = ???
return render_template("data.html")
解决方案 1:
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')
解决方案 2:
完整 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 有以抽象方式访问它的机制。除非您有令人信服的理由不这样做,否则您应该使用这些。
解决方案 3:
我来这里是为了寻找查询字符串,而不是如何从查询字符串中获取值。
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)
输出:
参考:
query_string 的官方 API 文档
解决方案 4:
我们可以通过使用 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 Blueprints - 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
如您所见,这只是一个小例子 - 您可以获取多个值+格式化它们并使用它或将其传递给模板文件。
解决方案 5:
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/
解决方案 6:
对查询字符串进行如下尝试:
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)
输出:
解决方案 7:
可以从 Flask 请求对象中检索到的每种形式的查询字符串,如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
属性,它不包含查询字符串,但它包含在另一个包含查询字符串的属性中,我将立即列出。不过,首先form
是“包含随请求提交的所有表单字段的字典”。我这么说是为了说明这一点:Flask 请求对象中还有另一个可用的字典属性,称为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 的路径和查询字符串部分”。例如:
from flask import request
@app.route('/'):
pathWithQueryString = request.full_path
最后,url
“客户端请求的完整 URL”(其中包括查询字符串):
from flask import request
@app.route('/'):
pathWithQueryString = request.url
祝你黑客愉快:)
解决方案 8:
我更喜欢
user = request.args['user'] if 'user' in request.args else 'guest'
超过
user = request.args.get('user')
这样,你可以先检查 url 是否包含查询字符串
解决方案 9:
通常,我们只想将整个查询字符串映射到适当的 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()
解决方案 10:
下面的实现对我有用。
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))
解决方案 11:
如果请求的方法是 get,那么您可以考虑以下内容
from flask import Flask, request, render_template
app = Flask(__name__)
@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 = f"?arg1={arg1}&arg2={arg2}"
return render_template("data.html", query_string=query_string)
if __name__ == '__main__':
app.run(debug=True)
解决方案 12:
这可以使用 来完成request.args.get()
。例如,如果您的查询字符串有一个字段date
,则可以使用
date = request.args.get('date')
不要忘记将“ request
”添加到 Flask 的导入列表中,即
from flask import request
解决方案 13:
该代码对我有用:
from flask import Flask, request
app = Flask(__name__)
@app.route('/')
def search():
query = request.args
for key,value in query.items():
print(key,value)
return "Hello World"
if __name__ == '__main__':
app.run(debug=True)