uvicorn.run() 方法参数解释-趙哥博客-赵哥博客

这个函数是用于运行一个ASGI应用程序的。下面是各个参数的作用:

参数	描述
`app`	要运行的ASGI应用程序,可以是一个ASGI应用、可调用对象或者字符串
`host`	服务器监听的主机地址,默认为”127.0.0.1″
`port`	服务器监听的端口号,默认为8000
`uds`	使用Unix域套接字的路径,如果设置了这个参数,就不使用主机和端口
`fd`	使用现有文件描述符的整数值
`loop`	要使用的事件循环,默认为”auto”自动选择
`http`	HTTP协议的实现,默认为”auto”自动选择
`ws`	WebSocket协议的实现,默认为”auto”自动选择
`ws_max_size`	WebSocket消息的最大尺寸,默认为16777216(16MB)
`ws_max_queue`	WebSocket队列的最大长度,默认为32
`ws_ping_interval`	WebSocket的心跳间隔,默认为20秒
`ws_ping_timeout`	WebSocket心跳超时时间,默认为20秒
`ws_per_message_deflate`	是否启用WebSocket消息压缩,默认为True
`lifespan`	应用程序生命周期的处理方式,默认为”auto”自动选择
`interface`	要使用的接口,默认为”auto”自动选择
`reload`	是否启用代码热重载,默认为False
`reload_dirs`	热重载监视的目录列表或字符串
`reload_includes`	热重载监视的文件扩展名列表或字符串
`reload_excludes`	热重载排除监视的文件扩展名列表或字符串
`reload_delay`	热重载检查的间隔时间,默认为0.25秒
`workers`	要启动的工作进程数,默认为None自动选择
`env_file`	要读取环境变量的配置文件路径
`log_config`	日志配置,可以是字典、字符串、RawConfigParser或文件对象
`log_level`	日志记录的级别
`access_log`	是否启用访问日志,默认为True
`proxy_headers`	是否处理代理头信息,默认为True
`server_header`	是否在响应中添加服务器头信息,默认为True
`date_header`	是否在响应中添加日期头信息,默认为True
`forwarded_allow_ips`	允许的转发IP地址列表或字符串
`root_path`	ASGI应用程序的根路径,默认为空字符串
`limit_concurrency`	并发连接数的上限,默认为None不限制
`backlog`	连接队列的最大长度,默认为2048
`limit_max_requests`	每个工作进程的最大请求数,默认为None不限制
`timeout_keep_alive`	保持连接的超时时间,单位为秒,默认为5
`timeout_graceful_shutdown`	优雅关闭的超时时间,单位为秒,默认为None不限制
`ssl_keyfile`	SSL私钥文件路径
`ssl_certfile`	SSL证书文件路径
`ssl_keyfile_password`	SSL私钥文件的密码
`ssl_version`	SSL/TLS协议版本,默认为TLSv1
`ssl_cert_reqs`	SSL证书验证要求,默认为CERT_NONE不验证
`ssl_ca_certs`	SSL CA证书文件路径
`ssl_ciphers`	可用的SSL密码套件,默认为”TLSv1″
`headers`	要添加到响应头的额外头信息列表
`use_colors`	是否在日志中使用颜色,默认为None自动选择
`app_dir`	ASGI应用程序的根目录路径
`factory`	是否使用工厂函数创建应用程序,默认为False
`h11_max_incomplete_event_size`	h11处理不完整事件的最大尺寸,默认为None不限制

THE END