一日一技:优雅地加载Yaml配置文件

本文涉及的产品
云数据库 Tair(兼容Redis),内存型 2GB
Redis 开源版,标准版 2GB
推荐场景:
搭建游戏排行榜
简介: 一日一技:优雅地加载Yaml配置文件

我在多篇文章里面都说过,我非常喜欢使用Yaml格式来写配置文件。Yaml是一个对人非常友好的配置格式。


有时候,我们在开发环境、测试环境和线上环境会有多套不同的配置文件,如何在不修改代码的情况下方便的切换配置文件呢?我以前的文章讲过一种方法,使用环境变量来指定配置文件名。今天我们来介绍一个更先进的工具,专门用来高效加载配置文件。这就是Facebook开源的Hydra。


这个工具有多简单呢?我们先写两个配置文件,然后看看怎么读取它:


640.png


使用pip安装Hydra:


python3 -m pip install hydra-core


接下来,我们写一段代码,来读取配置文件:


import os
import hydra
from omegaconf import DictConfig
env = os.getenv('DATA_CENTER', 'dev')
@hydra.main(config_path="config", config_name=env)
def main(cfg: DictConfig):
    print('MongoDB链接地址是:', cfg.mongo.uri)
    print('Redis的key是:', cfg.redis.key)
    print('黑名单是:', cfg.detail.black_list)
if __name__ == '__main__':
    main()


运行效果如下图所示:


640 (1).png


其中,装饰器hydra.main的参数config_path指定存放配置文件的文件夹,

config_name用来指定配置文件的名字(去掉.yaml)。


这样一来,我们可以通过环境变量指定要使用哪个配置文件。


这样看起来似乎跟我以前讲的方法没什么区别啊。那么,高级的功能来了。例如现在我使用dev环境时,临时想修改一下Redis的Key怎么办呢?以前的方法,我就必须去修改Yaml文件,把Key改掉。但是,既然是临时修改,测试完了又要改回来,显然非常麻烦。

使用Hydra,这个问题就不再是问题了。我们来看看直接在命令中覆盖数据的方法:


640 (2).png


请看图中,我代码没有做任何修改,Yaml也没有做任何修改。只需要在启动命令的时候增加一个参数redis.key=new_key,那么程序读取到的就是新的值了。这对临时测试的时候非常有用。


除了我上面介绍的这些,Hydra还可以实现自动补全,自动提示参数名,自动以多个不同的配置连续运行等等功能。大家可以在它的官方文档[1]中看到使用方法。


最后,我补充一个点。有同学在公众号粉丝群提问,Hydra为什么不能在调用函数的时候,传递额外的参数,例如下面这样写就会报错:


640 (3).png


这是因为,Hydra的装饰对象应该是程序的入口函数。给入口函数传递参数是很奇怪的。如果你的入口函数要根据参数的不同值执行不同的逻辑,那么这个参数你完全可以放到配置文件中。而不是用函数参数来传入。


所以,这里报错应该是功能而不是bug。本来就不应该在入口函数中添加额外的参数。


参考文献


[1] 官方文档: https://hydra.cc/docs/intro/


请关注微信公众号【未闻Code】获取更多精彩文章。

相关实践学习
基于Redis实现在线游戏积分排行榜
本场景将介绍如何基于Redis数据库实现在线游戏中的游戏玩家积分排行榜功能。
云数据库 Redis 版使用教程
云数据库Redis版是兼容Redis协议标准的、提供持久化的内存数据库服务,基于高可靠双机热备架构及可无缝扩展的集群架构,满足高读写性能场景及容量需弹性变配的业务需求。 产品详情:https://www.aliyun.com/product/kvstore     ------------------------------------------------------------------------- 阿里云数据库体验:数据库上云实战 开发者云会免费提供一台带自建MySQL的源数据库 ECS 实例和一台目标数据库 RDS实例。跟着指引,您可以一步步实现将ECS自建数据库迁移到目标数据库RDS。 点击下方链接,领取免费ECS&RDS资源,30分钟完成数据库上云实战!https://developer.aliyun.com/adc/scenario/51eefbd1894e42f6bb9acacadd3f9121?spm=a2c6h.13788135.J_3257954370.9.4ba85f24utseFl
目录
相关文章
|
XML JSON Java
SpringBoot入门(三) 之springboot的配置配置文件以及yaml的使用
SpringBoot入门(三) 之springboot的配置配置文件以及yaml的使用
227 0
SpringBoot入门(三) 之springboot的配置配置文件以及yaml的使用
|
20天前
|
关系型数据库 MySQL Go
go抽取mysql配置到yaml配置文件
go抽取mysql配置到yaml配置文件
|
2月前
|
Java Go
go如何读取yaml配置文件?
本文介绍了如何在Go项目中利用YAML文件进行配置管理,以简化变量更改及维护工作。首先,通过`go get gopkg.in/yaml.v3`命令安装YAML处理库。接着,展示了如何创建并解析YAML配置文件,包括定义结构体映射YAML字段、读取文件内容以及错误处理等步骤。此外,还提供了通过Go代码生成YAML文件的方法。使用`gopkg.in/yaml.v3`库能够有效提升项目的可维护性和开发效率。
153 1
go如何读取yaml配置文件?
|
17天前
|
Python
Python 解析 yaml 配置文件
Python 解析 yaml 配置文件
29 0
|
2月前
|
机器学习/深度学习 计算机视觉 Python
深度学习项目中在yaml文件中定义配置,以及使用的python的PyYAML库包读取解析yaml配置文件
深度学习项目中在yaml文件中定义配置,以及使用的python的PyYAML库包读取解析yaml配置文件
58 0
|
3月前
|
消息中间件 SQL Kafka
实时计算 Flink版产品使用问题之从检查点重启任务,怎么在YAML配置文件中添加检查点的路径
实时计算Flink版作为一种强大的流处理和批处理统一的计算框架,广泛应用于各种需要实时数据处理和分析的场景。实时计算Flink版通常结合SQL接口、DataStream API、以及与上下游数据源和存储系统的丰富连接器,提供了一套全面的解决方案,以应对各种实时计算需求。其低延迟、高吞吐、容错性强的特点,使其成为众多企业和组织实时数据处理首选的技术平台。以下是实时计算Flink版的一些典型使用合集。
实时计算 Flink版产品使用问题之从检查点重启任务,怎么在YAML配置文件中添加检查点的路径
|
5月前
|
存储 JSON JavaScript
【YAML语法规范指南】从入门到精通,揭秘神秘语法,引领配置文件解析指南(基础结构篇)
"YAML Ain't Markup Language"(简称YAML)是一种专为人类设计的数据序列化语言,适用于多种现代编程语言,可广泛应用于各类日常任务。它是一种以人类可读形式呈现的、适用于多种语言的Unicode数据序列化标准。它基于敏捷编程中常见的本地数据结构,广泛应用于配置文件、互联网消息传递、对象持久化以及数据审计等多个领域。遵循Unicode标准、
615 8
【YAML语法规范指南】从入门到精通,揭秘神秘语法,引领配置文件解析指南(基础结构篇)
|
前端开发 Java 数据库
SpringBoot解析指定Yaml配置文件
最近在看某个开源项目代码并准备参与其中,代码过了一遍后发现多个自定义的配置文件用来装载业务配置代替数据库查询,直接响应给前端,这里简单记录一下实现过程。
395 0
|
JSON Go 数据格式
Go 读取 YAML 配置文件的两种方式
本文介绍了读取 YAML 配置文件的两种方式,第一种是通过 yaml.v3 包,第二种是通过 viper 包。如果是在项目里解析配置文件,推荐使用 viper 包,它支持解析多种格式的配置文件,监听配置文件的更新,修改配置文件等。
1479 1
Go 读取 YAML 配置文件的两种方式
Viper中的yaml配置文件入门,Viper开发环境和生产环境的隔离
Viper中的yaml配置文件入门,Viper开发环境和生产环境的隔离