Python的配置管理库pyhocon读取方法

off999 2025-07-19 21:58 81 浏览 0 评论

HOCON（Human-Optimized Config Object Notation）是一个易于使用的配置文件格式，是JSON和properties的一个超集，也就是说完全兼容JSON和properties格式的文件。HOCON 文件通常以 .conf 作为后缀名。它常被用于 Sponge 以及利用 Sponge API 的独立插件以储存重要的数据，比如配置、还有游戏玩家数据。

HOCON组成部分

一个 key 是一个键值对字符串中的前一个值
一个 value 可以是字符串、数字、对象、数组或者布尔值并紧随 key 的后面
一个 key-value separator 把键和值分离，可以是 : 或者 =
一个 comment 以 # 或者 // 开头，通常用于提供反馈或说明

hocon配置文件的具体说明，我不再赘述，请参照我头条写的hocon配置文件快速入门

为了读取和写入hocon配置文件，我们需要借助pyhocon包。首先我们需要先安装pyhocon包。

pyhocon包安装

pip install pyhocon
或者
conda install pyhocon -c conda-forge

hocon文件的读取

我们以default.conf为例，阐述hocon文件内容的读取。

default.conf的内容如下：

default {
  port: 80
  context-path: /context
  uri-encoding: utf-8
}

product { # 生产环境的配置
  server {  # 多级嵌套
    address: 192.168.1.100
    port: ${default.port} # 引用，使用default.port=80的数据替换
  }
}

读取default.conf的代码如下：

from pyhocon import ConfigFactory
conf = ConfigFactory.parse_file('default.conf')
port = conf.get_string('default.port')
context_path = conf.get('default.context-path')
uri_encoding = conf['default.uri-encoding']

server_address = conf['product']['server.address']
server_port = conf['product.server.port']

根据读取的方式不同，有下面三种读取配置的方法：

ConfigFactory.parse_file：读取配置文件
ConfigFactory.parse_URL：读取网络地址的配置文件
ConfigFactory.parse_string：将字符串按照配置文件读取

本例子使用ConfigFactory.parse_file读取配置文件。

读取参数使用，conf.get和conf.get_string读取，他们的方法是一样的。

${default.port}，属于引用，使用default.port=80的数据替换。以生产环境、服务器、端口的读取为例，代码如下：

print(conf['product.server.port']) #80
print(conf['product.server']['port']) #80
print(conf['product.server']['port']) #80
print(conf['product']['server']['port']) #80
print(conf.get('product.server.port')) #80

以上5种表达式，均正确。结果都是80。

hocon文件的写入

有时我们使用python，需要写入hocon文件。这是我们需要用到pyhocon的HOCONConverter和ConfigTree功能函数。代码如下：

from pyhocon.tool import HOCONConverter
from pyhocon.config_tree import ConfigTree

s = {
    "name": "张三",
    "age": 23,
    "dic": {
        "1": "asd",
        "2": "a"
    }
}
data = ConfigTree(s)  # 注意要先转换为ConfigTree对象才能成功

with open("test.conf", "w", encoding="utf-8") as file:
    file.write(HOCONConverter.to_hocon(data))

首先对将典的变量s转换为ConfigTree对象data，然后使用HOCONConverter.to_hocon将data转换为字符串，写入文件即可。

pyhocon里面还有配置文件格式转换，参数追加、插入、删除、排序等功能，这里就不一一阐述了。有兴趣的粉丝可以下评论区里留言讨论。

python读取配置文件