슈퍼 완료! Python에서 구성 파일을 작성하는 일반적인 방법

구성 파일을 작성하는 이유

개발 과정에서 우리는 고정된 매개변수나 상수를 사용하는 경우가 많습니다. 이러한 고정되고 일반적으로 사용되는 부분의 경우 다른 모듈 코드의 반복을 방지하고 핵심 코드를 깔끔하게 유지하기 위해 고정 파일에 기록되는 경우가 많습니다.

이 고정된 파일을 settings.py 또는 config.py와 같은 .py 파일에 직접 작성할 수 있습니다. 이것의 장점은 동일한 프로젝트에서 가져오기를 통해 해당 파일의 일부를 직접 가져올 수 있다는 것입니다. Python이 아닌 다른 곳에서 사용하세요. 플랫폼이 구성 파일을 공유하는 경우 단일 .py를 작성하는 것은 좋은 선택이 아닙니다.

이때 이러한 고정된 부분을 저장하려면 공통 구성 파일 형식을 선택해야 합니다. 현재 일반적으로 사용되고 널리 사용되는 구성 파일 형식 유형에는 주로 ini, json, toml, yaml, xml 등이 포함됩니다. 표준 라이브러리 또는 타사 라이브러리를 통해 이러한 유형의 구성 파일을 구문 분석할 수 있습니다.

ini

ini는 초기에는 Windows에서 구성 파일의 저장 형식이었습니다. ini 파일의 작성 방법은 이해하기 쉽고 비교적 간단한 경우가 많습니다. 일반적으로 다음 형식과 같이 섹션, 키 및 값으로 구성됩니다.

[localdb]
host = 127.0.0.1
user = root
password = 123456
port = 3306
database = mysql

Python 자체에는 configparser 표준 라이브러리가 내장되어 있어 직접 구문 분석하는 데 사용됩니다. ini 파일. 예를 들어 위의 내용을 db.ini라는 파일에 저장한 후 read() 메서드를 사용하여 구문 분석하고 읽은 다음 마지막으로 items() 메서드를 사용하여 지정된 노드 아래의 모든 키-값 쌍을 가져옵니다.

>>> from configparser import ConfigParser
>>> cfg = ConfigParser()
>>> cfg.read("/Users/Bobot/db.ini")
['/Users/Bobot/db.ini']
>>> cfg.items("localdb")
[('host', '127.0.0.1'), ('user', 'root'), ('password', '123456'), ('port', '3306'), ('database', 'mysql')]

주의할 점은 configparser는 기본적으로 문자열 형식으로 값을 제공하기 때문에 db.ini 파일에 따옴표를 추가하지 않고 위에서 리터럴을 직접 작성하는 이유입니다.

키-값 쌍을 얻은 후 실제로 사전으로 직접 변환한 다음 매개변수의 압축을 풀어 코드를 단순하게 유지했습니다.

#!pip install pymysql
import pymysql
from configparser import ConfigParser
cfg = ConfigParser()
cfg.read("/Users/Bobot/db.ini")
db_cfg = dict(cfg.items("localdb"))
con = pymysql.connect(**db_cfg)

json

json 형식은 우리 형식의 공통 파일이라고 할 수 있습니다. 이는 인터넷에서 널리 사용되는 데이터 교환 형식이기도 합니다. 또한 json은 구성 파일 유형이기도 합니다.

예를 들어 npm(Python의 pip와 유사한 JavaScript 패키지 관리 도구)과 Microsoft에서 제작하여 널리 사용되는 VSCode 편집기는 모두 json을 사용하여 구성 매개변수를 작성합니다.

configparser와 마찬가지로 Python에는 load() 및 load() 메서드를 통해 파일 및 문자열 json 콘텐츠를 가져올 수 있는 내장 json 표준 라이브러리도 있습니다.

{
 "localdb":{
 "host": "127.0.0.1",
 "user": "root",
 "password": "123456",
 "port": 3306,
 "database": "mysql"
 }
}

위 내용을 db.json으로 저장한 후 읽고 구문 분석하는 것은 json 라이브러리가 json 파일을 읽는 것이 비교적 간단하고 쉬우며, Python 사전 객체로 구문 분석하는 것도 쉽습니다.

>>> import json
>>> from pprint import pprint
>>>
>>> with open('/Users/Bobot/db.json') as j:
... cfg = json.load(j)['localdb']
...
>>> pprint(cfg)
{'database': 'mysql',
'host': '127.0.0.1',
'password': '123456',
'port': 3306,
'user': 'root'}

json 파일 구성을 사용할 때의 단점은 구문 표준이 엄격하게 제한되어 있다는 것입니다. 비판 중 하나는 json 유형의 다른 상위 집합이 대안으로 사용되지 않는 한 주석을 작성할 수 없다는 것입니다(json 매개변수 구성 파일). VSCode에서는 주석을 작성할 수 있습니다.) 동시에 중첩이 너무 깊어 오류가 발생하기 쉽고 길거나 복잡한 매개변수 구성 정보를 작성하는 데 사용하기에는 적합하지 않습니다.

toml

toml 형식(또는 tml 형식)은 Github 공동 창립자 Tom Preston-Werner가 제안한 구성 파일 형식입니다. Wikipedia에 따르면 toml은 7년 전인 2013년 7월에 처음 제안되었으며, 또한 일부 측면에서 나중에 논의할 yaml 파일과 다소 유사하지만 yaml을 알고 있다면 사양이 수십 페이지(예, 정말 수십 페이지...), 이렇게 복잡한 구성 파일을 작성하고 싶지 않을 수도 있으므로 toml 형식을 선택하는 것이 좋습니다.

toml 형식은 대략 다음과 같습니다.

01-toml style

여기에서 toml이 앞서 언급한 ini 파일과 다소 유사하다는 것을 알 수 있습니다. 그러나 이는 ini보다 훨씬 더 확장됩니다.

샘플 사진을 보면 기본 문자열 외에 타임스탬프, 부울 값, 배열 등이 추가로 지원되고 스타일이 Python의 기본 작성 방법과 매우 유사하다는 것을 알 수 있습니다.

물론 여기서 toml 형식의 사양을 너무 많이 소개하지는 않겠습니다. 누군가가 이미 공식 사양 문서를 번역해 놓았으니 관심 있는 친구들이 직접 확인해 보세요.

개발자는 Python에 적합한 구성 파일 형식에 해당하는 "바퀴"를 만들었습니다. 현재 Github에서 가장 많은 별을 받은 버전은 uiri/toml 버전이지만 이 버전은 v0.5 버전 toml 사양만 통과했습니다. 하지만 사용 방법은 매우 간단합니다. pip 명령을 통해 설치할 수 있습니다

pip install toml

이 라이브러리의 구문 분석 방법은 매우 간단하며, load()를 통한 json 라이브러리의 구문 분석 사용법과 다소 유사합니다. 또는 load() 분석도 유사하며 변환 및 내보내기도 유사하게 사용됩니다.

예를 들어 이제 config.toml에 다음 내용을 작성합니다.

[mysql]
host = "127.0.0.1"
user = "root"
port = 3306
database = "test"
 [mysql.parameters]
 pool_size = 5
 charset = "utf8"
 [mysql.fields]
 pandas_cols = [ "id", "name", "age", "date"]

紧接着我们就可以通过 toml 库中的 load() 方法来进行读取：

>>> import toml
>>> import os
>>> from pprint import pprint
>>> cfg = toml.load(os.path.expanduser("~/Desktop/config.toml"))
>>> pprint(cfg)
{'mysql': {'database': 'test',
'fields': {'pandas_cols': ['id', 'name', 'age', 'date']},
'host': '127.0.0.1',
'parameters': {'charset': 'utf8', 'pool_size': 5},
'port': 3306,
'user': 'root'}}

可以看到 toml 文件被间接地转化成了字典类型，当然这也就是 json 版的写法（将单引号替换成双引号即可），方便我们后续调用或者传参。

yaml

yaml 格式（或 yml 格式）是目前较为流行的一种配置文件，它早在 2001 由一个名为 Clark Evans 的人提出；同时它也是目前被广泛使用的配置文件类型，典型的就是 Docker 容器里的 docker-compose.yml 配置文件，如果经常使用 Docker 进行部署的人对此不会陌生。

yaml 文件的设计从 Python、XML 等地方获取灵感，所以在使用时能很清楚地看到这些部分的影子。

在上一节 toml 内容里我曾提到，yaml 的规范内容可以说是冗长和复杂，足足有80页之多（斗尊强者，恐怖如斯……）。

02-yaml规范页数

所以感兴趣的朋友可以再自行了解相关用法。

YAML 官方早已经提供了相应的 Python 库进行支持，即 PyYAML；当然也同样需要我们事先进行安装：

pip install pyyaml

同 json 库和 toml 库一样，通过 load() 方法来进行加载。

需要注意的是，使用 load() 方法会存在一定的安全隐患，从思科 Talos 的这份报告中我们可以看到，如果加载了未知或不信任的 yaml 文件，那么有可能会存在被攻击的风险和网络安全隐患，因为它能够直接调用相应的 Python 函数来执行为攻击者所需要的命令，比如说在 yaml 文件中写入这么一段：

# 使用Linux和macOS的朋友不要轻易尝试
!!python/object/apply:os.system ["rm -rf /"]

因此最好是使用 safe_load() 来代替 load() 方法。

这和 Python 内置的 string 标准库中 Template 类的 substitute() 模板方法一样存在着同样的安全隐患，所以使用 safe_substitute() 来替代是一样的道理。

如我们现在将之前的一些配置信息写入 config.yaml 文件中：

mysql:
 host: "127.0.0.1"
 port: 3306
 user: "root"
 password: "123456"
 database: "test"
 parameter:
 pool_size: 5
 charset: "utf8"
 fields:
pandas_cols:
 - id
 - name
 - age
 - date

然后我们通过 safe_load() 方法进行解析：

>>> import os
>>> from pprint import pprint
>>>
>>> with open(os.path.expanduser("~/config.yaml"), "r") as config:
... cfg = yaml.safe_load(config)
...
>>> pprint(cfg)
{'mysql': {'database': 'test',
'fields': {'pandas_cols': ['id', 'name', 'age', 'date']},
'host': '127.0.0.1',
'parameter': {'charset': 'utf8', 'pool_size': 5},
'password': '123456',
'port': 3306,
'user': 'root'}}

可以看到最后结果和前面的 toml 库的解析结果基本一致。

结尾

本文列举了一些主流且常见的配置文件类型及其 Python 的读取方法，可能有的读者会发现当中没有 xml 格式类型的内容。对于 xml 配置文件可能与 Java 系语言打交道的朋友遇见得会多一些，但 xml 文件的可读性实在是让人望而生畏；对 xml 文件不了解的朋友可以使用 Chrome 浏览器随便进入一个网站然后按下 F12 进入开发者后查看那密密麻麻的 html 元素便是 .xml 的缩影。

除了这些主流的配置文件类型之外，像一些 .cfg、.properties 等都可以作为配置文件，甚至和开头提到的那样，你单独用一个 .py 文件来书写各类配置信息作为配置文件进行导入都是没问题，只是在跨语言共享时可能会有些障碍。因此本文就不过多介绍，感兴趣的朋友可以进一步自行了解。

在本文里列举的配置文件类型其复杂性由上到下依次增加：ini

위 내용은 슈퍼 완료! Python에서 구성 파일을 작성하는 일반적인 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!