Codespaces Python 项目模板教程
1. 项目的目录结构及介绍
codespaces-project-template-py/
├── devcontainer/
│ ├── devcontainer.json
│ └── Dockerfile
├── webapp/
│ ├── __init__.py
│ ├── main.py
│ └── ...
├── .gitignore
├── README.md
└── ...
- devcontainer/: 包含用于配置 Codespaces 环境的文件。
- devcontainer.json: 配置 Visual Studio Code 设置和扩展。
- Dockerfile: 配置操作系统和运行时环境。
- webapp/: 包含使用 FastAPI 构建的 HTTP API 代码。
- init.py: 模块初始化文件。
- main.py: 项目的主启动文件。
- .gitignore: 指定 Git 忽略的文件和目录。
- README.md: 项目说明文档。
2. 项目的启动文件介绍
项目的主启动文件位于 webapp/main.py
。该文件使用 FastAPI 框架构建 HTTP API。以下是 main.py
的基本结构:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
def read_root():
return {"message": "Hello World"}
- FastAPI 实例化:
app = FastAPI()
创建一个 FastAPI 实例。 - 路由定义:
@app.get("/")
定义了一个根路径的路由,返回一个简单的 JSON 消息。
3. 项目的配置文件介绍
devcontainer.json
devcontainer.json
文件用于配置 Codespaces 环境,包括 Visual Studio Code 设置和扩展。以下是一个示例配置:
{
"name": "Python 3.9",
"build": {
"dockerfile": "Dockerfile",
"context": ".."
},
"settings": {
"python.pythonPath": "/usr/local/bin/python",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true
},
"extensions": [
"ms-python.python"
]
}
- name: 环境的名称。
- build: 指定 Dockerfile 和构建上下文。
- settings: 配置 Visual Studio Code 的设置,如 Python 路径和 linting 设置。
- extensions: 指定预安装的扩展。
Dockerfile
Dockerfile
文件用于配置 Codespaces 的操作系统和运行时环境。以下是一个示例配置:
FROM mcr.microsoft.com/vscode/devcontainers/python:3.9-bullseye
RUN pip install fastapi uvicorn
- 基础镜像:
FROM mcr.microsoft.com/vscode/devcontainers/python:3.9-bullseye
指定基础镜像。 - 安装依赖:
RUN pip install fastapi uvicorn
安装 FastAPI 和 Uvicorn。
通过以上配置,Codespaces 将提供一个预配置的开发环境,包含所需的运行时和库。