本文来源公众号“python”，仅用于学术分享，侵权删，干货满满。
原文链接：werkzeug，一个不可思议的 Python 库！
大家好，今天为大家分享一个不可思议的 Python 库 - werkzeug。
Github地址：https://github.com/pallets/werkzeug
Werkzeug是一个全面的WSGI（Web服务器网关接口）工具库，最初由Armin Ronacher开发，现已成为Python Web开发中不可或缺的基础组件。作为Flask框架的核心依赖，Werkzeug提供了构建Web应用所需的大量底层功能，包括请求和响应对象的封装、URL路由、开发服务器等核心特性。它的设计理念是提供灵活且模块化的工具集，让开发者能够构建出高质量的Web应用。
安装
Werkzeug的安装过程简单直接，支持多种Python版本。
以下是详细的安装步骤：
# 使用pip安装
pip install werkzeug
# 使用pip安装特定版本
pip install werkzeug==2.3.7
# 验证安装
python -c "import werkzeug; print(werkzeug.__version__)"
安装完成后，建议通过简单的测试脚本验证安装是否成功：
from werkzeug.wrappers import Request, Response
def application(environ, start_response):
request = Request(environ)
response = Response('Hello, Werkzeug!')
return response(environ, start_response)
if __name__ == '__main__':
from werkzeug.serving import run_simple
run_simple('localhost', 4000, application)
特性
-
完整的WSGI实现：提供了符合PEP 3333规范的WSGI工具集
-
请求/响应对象：封装了HTTP请求和响应的处理
-
URL路由系统：支持复杂的URL模式匹配和参数提取
-
开发服务器：内置调试功能的测试服务器
-
中间件组件：支持请求预处理和响应后处理
-
安全工具：提供防御常见Web攻击的工具
-
文件上传处理：简化文件上传的处理流程
-
Session管理：提供安全的会话处理机制
基本功能
1. 请求处理
以下示例展示了如何使用Werkzeug处理HTTP请求，包括获取请求参数、表单数据和请求头信息。这些功能在构建Web API时经常使用，可以帮助开发者更好地处理客户端发来的各种请求数据。
from werkzeug.wrappers import Request, Response
from werkzeug.serving import run_simple
@Request.application
def application(request):
# 获取URL参数
name = request.args.get('name', 'Guest')
# 获取POST数据
if request.method == 'POST':
data = request.form.get('data')
# 获取请求头
user_agent = request.headers.get('User-Agent')
return Response(f'Hello, {name}! Your browser is: {user_agent}')
if __name__ == '__main__':
run_simple('localhost', 4000, application, use_debugger=True)
2. URL路由
下面的代码展示了Werkzeug的URL路由功能，通过Map和Rule类创建URL路由规则，实现灵活的URL匹配和参数提取。这对于构建RESTful API特别有用。
from werkzeug.routing import Map, Rule
from werkzeug.wrappers import Request, Response
url_map = Map([
Rule('/', endpoint='index'),
Rule('/user/<username>', endpoint='user_profile'),
Rule('/post/<int:post_id>', endpoint='show_post')
])
def application(environ, start_response):
request = Request(environ)
urls = url_map.bind_to_environ(environ)
try:
endpoint, values = urls.match()
if endpoint == 'index':
response = Response('Welcome to homepage')
elif endpoint == 'user_profile':
response = Response(f'User profile: {values["username"]}')
elif endpoint == 'show_post':
response = Response(f'Post ID: {values["post_id"]}')
except Exception as e:
response = Response('Not Found', status=404)
return response(environ, start_response)
高级功能
1. 中间件实现
以下示例展示了如何使用Werkzeug实现中间件，用于请求预处理和响应后处理。这个示例实现了一个简单的性能监控中间件，记录请求处理时间。
from werkzeug.wrappers import Request, Response
import time
class PerformanceMiddleware:
def __init__(self, app):
self.app = app
def __call__(self, environ, start_response):
start_time = time.time()
response = self.app(environ, start_response)
end_time = time.time()
duration = end_time - start_time
print(f'Request processed in {duration:.4f} seconds')
return response
@Request.application
def application(request):
return Response('Hello, World!')
app = PerformanceMiddleware(application)
2. 文件上传处理
这个示例展示了Werkzeug处理文件上传的高级功能，包括文件类型验证、大小限制和安全存储。
from werkzeug.utils import secure_filename
from werkzeug.wrappers import Request, Response
import os
UPLOAD_FOLDER = '/path/to/uploads'
ALLOWED_EXTENSIONS = {'txt', 'pdf', 'png', 'jpg'}
def allowed_file(filename):
return '.' in filename and \
filename.rsplit('.', 1)[1].lower() in ALLOWED_EXTENSIONS
@Request.application
def application(request):
if request.method == 'POST':
if 'file' not in request.files:
return Response('No file part', status=400)
file = request.files['file']
if file.filename == '':
return Response('No selected file', status=400)
if file and allowed_file(file.filename):
filename = secure_filename(file.filename)
file.save(os.path.join(UPLOAD_FOLDER, filename))
return Response('File uploaded successfully')
return Response('''
<form method="post" enctype="multipart/form-data">
<input type="file" name="file">
<input type="submit" value="Upload">
</form>
''')
实际应用场景
RESTful API服务器
在实际工作中，Werkzeug常用于构建轻量级的RESTful API服务。以下是一个实际的应用示例，实现了一个简单的用户管理API：
from werkzeug.wrappers import Request, Response
from werkzeug.routing import Map, Rule
import json
# 模拟数据库
users = {}
url_map = Map([
Rule('/users', endpoint='users_list', methods=['GET']),
Rule('/users/<username>', endpoint='user_detail', methods=['GET', 'POST', 'DELETE'])
])
class UserAPI:
def __init__(self):
self.url_map = url_map
def dispatch_request(self, request):
urls = self.url_map.bind_to_environ(request.environ)
try:
endpoint, values = urls.match()
return getattr(self, f'on_{endpoint}')(request, **values)
except Exception as e:
return Response('Not Found', status=404)
def on_users_list(self, request):
return Response(json.dumps(list(users.keys())), mimetype='application/json')
def on_user_detail(self, request, username):
if request.method == 'GET':
user = users.get(username)
if user:
return Response(json.dumps(user), mimetype='application/json')
return Response('User not found', status=404)
elif request.method == 'POST':
users[username] = json.loads(request.data.decode())
return Response('User created', status=201)
elif request.method == 'DELETE':
if username in users:
del users[username]
return Response('User deleted')
return Response('User not found', status=404)
def application(environ, start_response):
request = Request(environ)
app = UserAPI()
response = app.dispatch_request(request)
return response(environ, start_response)
总结
Werkzeug作为Python Web开发的基础工具库，提供了构建Web应用所需的全套功能。通过本文的介绍，可以深入了解了Werkzeug的核心特性和使用方法，从基本的请求处理到高级的中间件实现和文件上传处理。它的模块化设计和灵活的API使得开发者能够根据需求选择合适的组件，构建出高效且可维护的Web应用。作为Flask等流行Web框架的基础，Werkzeug的重要性不言而喻。通过掌握Werkzeug，开发者不仅能更好地理解Web框架的工作原理，还能够在需要时构建自己的轻量级Web应用。在实际开发中，Werkzeug的各种工具和特性能够帮助更好地处理Web请求、管理会话、处理文件上传等常见需求，是Python Web开发不可或缺的工具。
THE END !
文章结束，感谢阅读。您的点赞，收藏，评论是我继续更新的动力。大家有推荐的公众号可以评论区留言，共同学习，一起进步。
扫一扫
2232
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
