Uvicorn配置文件详解

老丽同学_5538

老丽同学_5538

2026-10-24

707人浏览

原创

uvicorn配置文件非必须但生产环境强烈推荐,需命名为uvicorn_config.py等并用--config显式加载,核心是定义名为uvicorn_config的字典,键名对应命令行参数(短横变下划线),优先级为命令行>配置文件>环境变量。

uvicorn配置文件详解

Uvicorn配置文件不是必须的,但生产环境强烈建议用 —— 它能规避命令行参数拼接错误、避免敏感配置硬编码、统一管理多环境差异。

配置文件怎么命名和加载

Uvicorn不强制文件名,但惯例是uvicorn_config.py或config.py;加载时必须用--config参数,不能靠文件名自动识别:

uvicorn main:app --config uvicorn_config.py

注意:--config-file是旧版参数名,已弃用;新版只认--config。如果误写成--config-file,Uvicorn会静默忽略,仍按默认值启动,容易误以为配置生效了。

  • 配置文件必须是合法的Python模块,能被import(不能有语法错误,不能依赖未安装的包)
  • 文件里定义的变量名无关紧要,关键是要把配置项组织成字典并赋给uvicorn_config变量(这是Uvicorn约定的入口名)
  • 不支持YAML/JSON直接加载;想用YAML需额外装pyyaml,且仍得通过--log-config传给日志系统,而非主配置

配置项必须用字典形式暴露为uvicorn_config

Uvicorn只认一个全局变量名:uvicorn_config。它必须是dict类型,键名要和命令行参数一一对应(去掉--前缀,短横变下划线):

# uvicorn_config.py
uvicorn_config = {
    "app": "main:app",
    "host": "0.0.0.0",
    "port": 8000,
    "workers": 4,
    "log_level": "info",
    "timeout_keep_alive": 5,
    "access_log": True,
}

常见错法:

Uvicorn 0.52.1
Uvicorn 0.52.1

Uvicorn 0.52.1 是 Python ASGI Web 服务器,提供异步应用服务及 WebSocket 支持,常用于 FastAPI、Starlette 等应用的开发和部署。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理所需依赖。

下载
  • 写成config = {...} → Uvicorn完全无视
  • 键名写成--timeout-keep-alive或timeout_keep_alive_sec → 启动报unexpected keyword argument
  • 把reload=True和workers=4同时设 → Uvicorn会启动失败,因为reload模式下workers只能为1

环境变量与配置文件混用时的优先级

命令行参数 > 配置文件 > 环境变量。这意味着:

  • 如果配置文件里写了"port": 8000,但命令行又加了--port 9000,最终监听9000
  • UVICORN_PORT环境变量不会覆盖配置文件里的port,除非你根本没传--config
  • 想让环境变量生效,得删掉配置文件里的对应项,或改用纯环境变量方式(不带--config)

典型陷阱:Docker部署时,在docker-compose.yml里设了UVICORN_WORKERS=8,又挂载了uvicorn_config.py且里面写了"workers": 4 → 最终还是4,环境变量没起作用。

配置文件里怎么安全读取环境变量

别在配置文件里直接用os.environ.get("PORT")裸调用,否则启动时出错会导致整个服务无法启动。推荐封装默认值和类型转换:

# uvicorn_config.py
import os
<p>def env_int(key: str, default: int) -> int:
try:
return int(os.environ.get(key, default))
except (ValueError, TypeError):
return default</p><p>uvicorn_config = {
"app": "main:app",
"host": os.environ.get("UVICORN_HOST", "0.0.0.0"),
"port": env_int("UVICORN_PORT", 8000),
"workers": env_int("UVICORN_WORKERS", 2),
"log_level": os.environ.get("UVICORN_LOG_LEVEL", "info"),
}</p>

这样既保留了配置文件的可维护性,又支持Docker/K8s通过环境变量动态覆盖,还防了类型错误崩溃。

真正难的不是写配置,而是让不同环境下的配置变更不互相干扰 —— 比如开发机上reload=True必须关掉,而CI流水线里又要校验配置文件语法是否合法。这些边界情况,往往比参数本身更耗时间。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

uvicorn 配置文件

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1791

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4704

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27917

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3367

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3367

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2603

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方部署指南
Uvicorn官方部署指南

共0课时 | 0人学习

Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习