2.1.0 update

Author: funnygeeker

README.ZH-CN.md

@@ -6,7 +6,7 @@
 
 ### 特点
 - 尽可能模仿了 `Flask` 框架的风格
-- 集成了常用的：GET 请求解析，表单解析，HTML渲染，文件发送等功能
+- 集成了常用的：GET 请求参数解析，表单解析，HTML渲染，文件发送，Cookies设置，Cookies获取，动态路由 等常用功能
 
 ### 使用说明
 - 本项目一共有三个版本的文件，请根据实际需要进行选择：
@@ -21,8 +21,18 @@
 
 
 ### 示例代码
+- 这里我们使用 [micropython-easynetwork](https://github.com/funnygeeker/micropython-easynetwork) 作为示例，连接局域网（也可以工作在AP模式，使用其他设备连接开发板）
 ```python
-from libs.easyweb import EasyWeb
+import time
+from libs.easynetwork import Client
+from libs.easyweb import EasyWeb, render_template, send_file, make_response
+
+client = Client()
+client.connect("ssid", "password")  # 或者 client.connect("ssid", "")
+
+while not client.isconnected():
+    pass
+print('IP Address: {}'.format(client.ifconfig()[0]))
 
 ew = EasyWeb()  # 初始化 EasyWeb
 
@@ -37,13 +47,23 @@ def home(request):
     print('Json: ', request.json)
     print('Path: ', request.path)
     print('Header: ', request.headers)
+    print('Cookies: ', request.cookies)
     print('Full_Path: ', request.full_path)
-    return ew.render_template("/web/wifi.html")
+    return render_template("/web/wifi.html")
 
 # 发送文件
 @ew.route('/easyweb.png')
 def img(request):
-    return ew.send_file("/web/EasyWeb_256px.png")
+    # 访问网页的 /easyweb.png 试试？
+    return send_file("/web/EasyWeb_256px.png")
+
+# 下载文件
+@ew.route('/download')
+def download(request):
+    # 访问网页的 /easyweb.png 试试？
+    # as_attachment: 是否作为附件发送文件，作为附件时会被下载
+    # attachment_filename: 下载文件时向用户显示的文件名。如果未提供，将使用原始文件名
+    return send_file("/web/EasyWeb_256px.png", as_attachment=True, attachment_filename='easyweb.png')
 
 # 停止 EasyWeb
 @ew.route('/stop')
@@ -52,14 +72,51 @@ def stop(request):
 
 # 获取字符串
 @ew.route('/user/<string>')
-def welcome(request):
+def user(request):
+    # 访问网页的 /user/123456 试试？
     return "<h1>Hello {}</h1>".format(request.match)
 
 # 获取路径
-@ew.route('/download/<path>')
-def download(request):
-    return "<h1>Download {}</h1>".format(request.match)
+@ew.route('/path/<path>')
+def path(request):
+    # 访问网页的 /path/123/456 试试？
+    return "<h1>Path {}</h1>".format(request.match)
+
+# 渲染 HTML
+@ew.route('/time')
+def the_time(request):
+    # 访问网页的 /time 然后刷新几遍页面，观察网页的变化
+    return render_template("/web/time.html", time=time.time())
+
+# 获取与设置 Cookies
+@ew.route('/cookie')
+def cookie(request):
+    # 访问网页的 /cookie 然后刷新几遍页面，观察网页的变化
+    response = make_response('<h2>Cookies: {}</h2>'.format(str(request.cookies)))
+    response.set_cookie('cookie_name', 'cookie_value')
+    return response
+
+# 自定义状态码
+@ew.route('/404')
+def status_code(request):
+    # 访问网页的 /404，打开开发人员工具观察状态码
+    return '<h2>404 Not Found</h2>', 404
+
+# 获取与设置 Cookies，同时自定义状态码
+@ew.route('/cookie2')
+def cookie2(request):
+    # 访问网页的 /cookie 然后刷新几遍页面，观察网页的变化
+    response = make_response()  # 也可以在后面为 response.data 赋值，来代替初始化时赋值
+    response.data = '<h2>Cookies: {}</h2></br><h2>404 Not Found</h2>'.format(str(request.cookies))
+    response.set_cookie('cookie_name', 'cookie_value')
+    return response, 404
+
+# 获取 JSON 格式的内容
+@ew.route('/json')
+def cookie2(request):
+    # 访问网页的 /json
+    return {'type': 'json', 'num': 123}
 
 ew.run()
-print('======END======')
+print('======END======')  # 访问 /stop
 ```

README.md

@@ -1,26 +1,38 @@
 [简体中文 (Chinese)](./README.ZH-CN.md)
 # micropython-easyweb
+# micropython-easyweb
+
 ![EasyWeb](./web/EasyWeb_256px.png)
-- Web Server library for `Micropython`: Simple, easy-to-use, versatile, highly compatible
+- Web Server Library for Micropython: Easy to use, versatile, highly compatible
 
 ### Features
-- Aims to mimic the style of the `Flask` framework as much as possible
-- Integrates commonly used functionalities such as parsing GET requests, form parsing, HTML rendering, and file sending
+- Aims to mimic the style of the Flask framework as much as possible
+- Integrates common functionalities such as GET request parameter parsing, form parsing, HTML rendering, file sending, cookie setting, cookie retrieval, dynamic routing, and more.
 
-### Usage Instructions
-- There are three versions of files available in this project, please choose according to your specific needs:
-- `thread`: `/libs/easyweb_thread.py` implemented using multi-threading
-- `asyncio`: `/libs/easyweb.py` implemented using asynchronous programming, with good compatibility and reliability
-- `single`: `/libs/easyweb_single.py` implemented using single-threaded looping, with good compatibility
+### Instructions
+- There are three versions of the project files, please choose the one that suits your needs:
+- `thread`: `/libs/easyweb_thread.py` - implemented with multithreading
+- `asyncio`: `/libs/easyweb.py` - implemented with asynchronous support, provides better compatibility and reliability
+- `single`: `/libs/easyweb_single.py` - implemented with a single thread loop, provides good compatibility
 
 ### Compatibility
 #### Tested Devices
 - `ESP-01S`: `single`
 - `ESP32-C3`: `single`, `thread`, `asyncio`
 
-### Example Code
+### Sample Code
+- Here we use [micropython-easynetwork](https://github.com/funnygeeker/micropython-easynetwork) as an example to connect to the local network (it can also work in AP mode, allowing other devices to connect to the development board).
 ```python
-from libs.easyweb import EasyWeb
+import time
+from libs.easynetwork import Client
+from libs.easyweb import EasyWeb, render_template, send_file, make_response
+
+client = Client()
+client.connect("ssid", "password")  # or client.connect("ssid", "")
+
+while not client.isconnected():
+    pass
+print('IP Address: {}'.format(client.ifconfig()[0]))
 
 ew = EasyWeb()  # Initialize EasyWeb
 
@@ -35,29 +47,76 @@ def home(request):
     print('Json: ', request.json)
     print('Path: ', request.path)
     print('Header: ', request.headers)
+    print('Cookies: ', request.cookies)
     print('Full_Path: ', request.full_path)
-    return ew.render_template("/web/wifi.html")
+    return render_template("/web/wifi.html")
 
-# Send a file
+# Send file
 @ew.route('/easyweb.png')
 def img(request):
-    return ew.send_file("/web/EasyWeb_256px.png")
+    # Try accessing /easyweb.png on the website
+    return send_file("/web/EasyWeb_256px.png")
+
+# Download file
+@ew.route('/download')
+def download(request):
+    # Try accessing /easyweb.png on the website
+    # as_attachment: Whether to send the file as an attachment, it will be downloaded when sent as an attachment
+    # attachment_filename: The filename displayed to the user when downloading. If not provided, the original filename will be used
+    return send_file("/web/EasyWeb_256px.png", as_attachment=True, attachment_filename='easyweb.png')
 
 # Stop EasyWeb
 @ew.route('/stop')
 def stop(request):
     ew.stop()
 
-# Get a string
+# Get string
 @ew.route('/user/<string>')
-def welcome(request):
+def user(request):
+    # Try accessing /user/123456 on the website
     return "<h1>Hello {}</h1>".format(request.match)
 
-# Get a path
-@ew.route('/download/<path>')
-def download(request):
-    return "<h1>Download {}</h1>".format(request.match)
+# Get path
+@ew.route('/path/<path>')
+def path(request):
+    # Try accessing /path/123/456 on the website
+    return "<h1>Path {}</h1>".format(request.match)
+
+# Render HTML
+@ew.route('/time')
+def the_time(request):
+    # Access /time on the website and refresh the page a few times to observe the changes on the webpage
+    return render_template("/web/time.html", time=time.time())
+
+# Get and set Cookies
+@ew.route('/cookie')
+def cookie(request):
+    # Access /cookie on the website and refresh the page a few times to observe the changes on the webpage
+    response = make_response('<h2>Cookies: {}</h2>'.format(str(request.cookies)))
+    response.set_cookie('cookie_name', 'cookie_value')
+    return response
+
+# Custom status code
+@ew.route('/404')
+def status_code(request):
+    # Access /404 on the website, open the developer tools to observe the status code
+    return '<h2>404 Not Found</h2>', 404
+
+# Get and set Cookies, while customizing the status code
+@ew.route('/cookie2')
+def cookie2(request):
+    # Access /cookie on the website and refresh the page a few times to observe the changes on the webpage
+    response = make_response()  # You can also assign a value to response.data later instead of initializing it during initialization
+    response.data = '<h2>Cookies: {}</h2></br><h2>404 Not Found</h2>'.format(str(request.cookies))
+    response.set_cookie('cookie_name', 'cookie_value')
+    return response, 404
+
+# Get content in JSON format
+@ew.route('/json')
+def cookie2(request):
+    # Access /json on the website
+    return {'type': 'json', 'num': 123}
 
 ew.run()
-print('======END======')
+print('======END======')  # Access /stop
 ```