Windows 下基于 vscode 和 poetry 搭建 FastAPI 的开发环境

设置 Windows 的默认编码为 UTF-8

因为 Windows 的中文环境默认编码是 GBK,这会在后面导致一些其他的问题,所以首先需要将操作系统的默认编码设置为 UTF-8

点击开始菜单,直接输入 control pannel 打开控制面板,选择 时钟和区域-区域,弹窗页面打开管理页面,点击 更改系统区域设置按钮,弹窗页面勾选Beta 版:使用 Unicode UTF-8 提供全球语言支持,完成后系统会提示重启电脑后才能生效,直接点击重启。

配置 pip

配置 pip,设置国内镜像,因为 poetry 在下载过程中,会使用到 pip 下载一些安装包,如果不设置安装过程可能会很漫长甚至会失败。这里直接粘贴设置方法:

Pip的配置文件为用户根目录下的:~/.pip/pip.conf(Windows路径为:C:\Users<UserName>\pip\pip.ini), 您可以配置如下内容:

[global]
index-url = https://repo.huaweicloud.com/repository/pypi/simple
trusted-host = repo.huaweicloud.com
timeout = 120

安装 poetry

因为国内网络的关系,导致 poetry 的安装可能比较困难,这里建议将安装的步骤进行拆解。

  • 下载 poetry 的源码
    git clone https://github.com/python-poetry/poetry.git
    
  • 开始安装
    cd poetry
    python install-poetry.py
    
    网络上有一些方法,是去 https://github.com/python-poetry/release 下载安装包后进行本地安装,但是此方法无法生成 poetry.exe 文件,如果使用 pycharm 的最新版本,会无法找到 poetry 的路径,同时手动指定 poetry.cmd 也无效,故不要使用那些方法。

vscode 安装插件

vscode 安装 Python Extension Pack

生成项目

首先生成项目:

mkdir -p fastapi
cd fastapi
poetry init(会有一些交互问题,基本上直接回车即可)

项目生成后,手动修改 pyproject.toml。将以下内容追加到文件的最后:

[[tool.poetry.source]]
name = "aliyun"
default = true
url = "https://mirrors.aliyun.com/pypi/simple/"

最后,产生虚拟环境:

poetry install(此步骤会真正的创建基于 poetry 的虚拟环境)

虚拟环境产生后,在 vscode 中手动选择对应的虚拟环境即可(截至当前,vscode 可以自动识别到 poetry 的虚拟环境目录)。

Hello world

fastapi 下建立一个 src 目录用于存储所有的代码。

src 目录下创建名为 app 的 python 包。同时在此包中创建 main.py 文件。

最终目录样式如下:

FastAPIDemo$ tree
.
├── poetry.lock
├── pyproject.toml
└── src
    └── app
        ├── __init__.py
        └── main.py

编辑 main.py 文件,将以下的内容复制进去(文件由 pycharm 自动生成):

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def root():
    return {"message": "Hello World"}


@app.get("/hello/{name}")
async def say_hello(name: str):
    return {"message": f"Hello {name}"}

因为虚拟环境还没有安装依赖,所以首先我们先安装依赖:

poetry add fastapi uvicorn

安装完毕后,运行以下命令启动服务:

cd src
poetry run uvicorn app.main:app --reload
## 注释
# app.                        main:            app
# 名为 app 的 python 包        main.py          main.py 中的 app = FastAPI()

使用 vscode 的运行和调试功能执行程序

打开 运行和调试侧边栏,选择新建 launch.json,输入以下内容后保存即可:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Run FastAPI server",
            "type": "python",
            "request": "launch",
            "module": "uvicorn",
            "args": [
                "app.main:app",
                "--reload"
            ],
            "cwd": "${workspaceFolder}\\src"
        }
    ]
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,794评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,050评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,587评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,861评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,901评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,898评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,832评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,617评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,077评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,349评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,483评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,199评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,824评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,442评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,632评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,474评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,393评论 2 352

推荐阅读更多精彩内容