foxwebsite 0.1.0

A sample Python package

📘 foxwebsite Web 框架官方文档

一个轻量级、异步、Flask 风格的 Python Web 框架 —— 由中学生独立开发并持续维护 ❤️
项目邮箱：[e-mail]

(Foxwebsite Official Documentation)

A lightweight, asynchronous, Flask-style Python web framework — independently developed and maintained by a high school student ❤️
Contact: [e-mail]

---

✅ 1. 安装与快速启动

Installation & Quick Start

安装依赖

Install Dependencies

pip install uvicorn

（可选）如需使用 Jinja2 模板引擎(虽然是可选，但我还是推荐您使用)：
(Optional) If you want to use the Jinja2 template engine:

pip install jinja2

foxwebsite 自带 string.Template 引擎，不装 Jinja2 也能用基础模板功能。
(Foxwebsite comes with built-in string.Template engine; basic templating works even without Jinja2.)

---

创建第一个应用

Create Your First Application

新建 app.py：

from foxwebsite import create_app

app = create_app(secret_key="your-secret-here")

@app.route("/")
def home(request):
    return "<h1>Hello, foxwebsite!</h1>"

@app.route("/user/{name}")
def user_profile(request):
    name = request.params["name"]
    return f"<h2>Welcome, {name}!</h2>"

if __name__ == "__main__":
    app.run(host="127.0.0.1", port=8000)

运行：
Run:

python app.py

访问 http://127.0.0.1:8000 查看效果！
(Visit http://127.0.0.1:8000 to see the result!)

---

🧭 2. 路由系统

Routing System

基础路由

Basic Routes

@app.route("/about")
def about(request):
    return "About Page"

支持多个 HTTP 方法：
Support multiple HTTP methods:

@app.route("/submit", methods=["GET", "POST"])
def submit(request):
    if request.method == "POST":
        return "Submitted!"
    return "<form method='post'><button>Submit</button></form>"

快捷装饰器（@app.get, @app.post 等）：
Shortcut decorators (@app.get, @app.post, etc.):

@app.get("/info")
def get_info(request):
    return "This is GET only"

@app.post("/login")
async def login(request):  # 支持异步函数  
    data = await request.json()  # 异步读取 JSON 数据  
    return {"message": "Login received", "data": data}

# (Supports async functions)  
# (Asynchronously read JSON data)

路径参数支持类型转换（如 {id:int}）：
Path parameters support type conversion (e.g., {id:int}):

@app.route("/post/{post_id:int}")
def view_post(request):
    post_id = request.params["post_id"]
    return f"<h3>Viewing post #{post_id}</h3>"

---

📥📤 3. 请求与响应

Request & Response

请求对象（Request）

Request Object

每个处理函数接收一个 request 对象，包含以下属性：
Each handler receives a request object with the following attributes:

• request.method — 请求方法（GET、POST 等）
  (HTTP method: GET, POST, etc.)
• request.path — 请求路径
  (Requested path)
• request.query — 查询参数字典（如 ?name=Bob → {"name": "Bob"}）
  (Query parameters as dict)
• request.params — 路径参数（如 /user/{name} → {"name": "Alice"}）
  (Path parameters)
• request.headers — 请求头字典
  (Request headers as dict)
• request.body — 原始请求体（bytes）
  (Raw request body in bytes)
• await request.json() — 异步解析 JSON 数据
  (Parse JSON body asynchronously)
• await request.form() — 异步解析表单数据
  (Parse form data asynchronously)

示例：
Example:

@app.post("/api/data")
async def handle_data(request):
    json_data = await request.json()
    name = json_data.get("name")
    return {"hello": name}

响应（Response）

Response

支持多种返回类型：
Supports multiple return types:

• 字符串 → 返回 HTML 文本
  (String → returns HTML text)
• 字典 → 自动序列化为 JSON，设置 Content-Type: application/json
  (Dict → auto-serialized to JSON with proper header)
• Response 对象 → 自定义状态码、头、内容类型等
  (Response object → custom status, headers, content-type, etc.)

from foxwebsite import Response

@app.get("/custom")
def custom_response(request):
    return Response(
        body="<h1>Custom!</h1>",
        status=201,
        headers={"X-Frame-Options": "DENY"},
        content_type="text/html"
    )

---

🔐 4. Session 会话

Session Management

启用 Session 需在创建应用时传入 secret_key：
Enable sessions by providing a secret_key when creating the app:

app = create_app(secret_key="your-super-secret-key-here")

在路由中使用 session：
Use session in routes:

@app.get("/set")
def set_session(request):
    request.session["user"] = "Alice"
    return "Session set!"

@app.get("/get")
def get_session(request):
    user = request.session.get("user", "Guest")
    return f"Hello, {user}"

Session 基于签名 Cookie 实现，数据存储在客户端。
(Sessions are cookie-based and signed; data is stored on the client side.)

---

🎨 5. 模板渲染

Template Rendering

支持两种模板引擎：
Supports two template engines:

1. 内置：string.Template（无需额外依赖）
   (Built-in: string.Template — no extra dependencies)
2. 可选：Jinja2（功能更强大）
   (Optional: Jinja2 — more powerful features)

使用内置模板（string.Template）

Using Built-in Template (string.Template)

@app.get("/hello/{name}")
def hello(request):
    name = request.params["name"]
    return app.render_string("Hello, $name!", name=name)

使用 Jinja2 模板

Using Jinja2 Templates

确保已安装 Jinja2，并将模板文件放在 templates/ 目录下。
Ensure Jinja2 is installed and templates are in the templates/ folder.

@app.get("/profile/{name}")
def profile(request):
    name = request.params["name"]
    return app.render_template("profile.html", name=name, age=16)

templates/profile.html 示例：
Example templates/profile.html:

<h1>Hello, {{ name }}!</h1>
<p>You are {{ age }} years old.</p>

---

🖼️ 6. 静态文件

Static Files

自动提供 static/ 目录下的文件（如 CSS、JS、图片）。
Serves files from the static/ directory (CSS, JS, images, etc.).

例如：
For example:

• 文件路径：static/style.css
  (File path: static/style.css)
• 可通过 URL 访问：http://localhost:8000/static/style.css
  (Accessible via URL: http://localhost:8000/static/style.css)

可通过 static_dir 参数自定义目录：
Customize directory via static_dir:

app = create_app(secret_key="...", static_dir="public")

---

❌ 7. 错误处理

Error Handling

使用 @app.errorhandler 注册错误处理器：
Use @app.errorhandler to register error handlers:

@app.errorhandler(404)
def not_found(request):
    return "<h1>Page Not Found 😢</h1>", 404

@app.errorhandler(500)
def server_error(request):
    return "<h1>Server Error 🛠️</h1>", 500

也可处理自定义异常：
Can also handle custom exceptions:

class UnauthorizedError(Exception):
    pass

@app.errorhandler(UnauthorizedError)
def handle_unauthorized(request, exception):
    return "Access denied!", 401

---

🚀 8. 部署运行

Deployment

开发期间使用内置 app.run()：
During development, use built-in app.run():

app.run(host="127.0.0.1", port=8000)

生产环境推荐使用 Uvicorn 托管 ASGI 应用：
In production, run with Uvicorn as ASGI app:

uvicorn app:app

支持 Gunicorn + Uvicorn 多进程部署：
Supports Gunicorn + Uvicorn for multi-process deployment:

gunicorn -w 4 -k uvicorn.workers.UvicornWorker app:app

---

❓ 9. 常见问题

Frequently Asked Questions

Q: foxwebsite 是同步还是异步框架？
Is foxwebsite synchronous or asynchronous?

A: 完全异步（基于 async/await），支持同步和异步混合编写路由。
(Fully asynchronous based on async/await, supports both sync and async route handlers.)

Q: 是否兼容 WSGI？
Is it compatible with WSGI?

A: 不兼容。foxwebsite 是 ASGI 框架，需使用 Uvicorn、Hypercorn 等 ASGI 服务器。
(No. Foxwebsite is an ASGI framework; requires ASGI servers like Uvicorn or Hypercorn.)

Q: 能否连接数据库？
Can I connect to a database?

A: 可以！推荐搭配 aiomysql、asyncpg 或 Tortoise ORM 使用异步数据库。
(Yes! Recommended with async DB libraries like aiomysql, asyncpg, or Tortoise ORM.)

Q: 模板必须用 Jinja2 吗？
Do I have to use Jinja2 for templates?

A: 不是必须的。内置 string.Template 可满足简单需求，Jinja2 用于复杂逻辑。
(No. Built-in string.Template suffices for simple cases; Jinja2 for complex logic.)

Q: 如何测试？
How to test?

A: 可使用 requests 或 httpx 发起测试请求，未来将提供测试客户端。
(Use requests or httpx to send test requests; a test client will be provided in the future.)

---

🌱 正在成长中的框架，欢迎提交 Issue 或 PR！
(A growing framework — issues and PRs are welcome!)
GitHub: https://github.com/shunianssy/foxwebsite