mirror of
https://github.com/LCTT/TranslateProject.git
synced 2024-12-26 21:30:55 +08:00
Merge pull request #22420 from wxy/20210625-Use-Python-to-parse-configuration-files
PRF&PUB:20210625 use python to parse configuration files
This commit is contained in:
Xingyu.Wang
GitHub
commit
1c3de60fac
@ -3,21 +3,22 @@
|
||||
[#]: author: "Moshe Zadka https://opensource.com/users/moshez"
|
||||
[#]: collector: "lujun9972"
|
||||
[#]: translator: "zepoch"
|
||||
[#]: reviewer: " "
|
||||
[#]: publisher: " "
|
||||
[#]: url: " "
|
||||
[#]: reviewer: "wxy"
|
||||
[#]: publisher: "wxy"
|
||||
[#]: url: "https://linux.cn/article-13551-1.html"
|
||||
|
||||
使用 Python 解析配置文件
|
||||
======
|
||||
第一步是选择配置文件的格式：INI、JSON、YAML 或 TOML。
|
||||
|
||||
![Python programming language logo with question marks][1]
|
||||
> 第一步是选择配置文件的格式：INI、JSON、YAML 或 TOML。
|
||||
|
||||
有时，程序需要足够的参数，将它们全部作为命令行参数或环境变量既不让人愉快也不可行。 在这些情况下，您将需要使用配置文件。
|
||||
|
||||
|
||||
有几种流行的配置文件格式。 其中包括古老的（虽然偶尔定义不足）`INI`格式，虽然流行但有时难以手写的`JSON`格式，广泛但偶尔在细节方面令人惊讶的`YAML`格式，以及最新添加的`TOML `，很多人还没有听说过。
|
||||
有时，程序需要足够的参数，将它们全部作为命令行参数或环境变量既不让人愉快也不可行。 在这些情况下，你将需要使用配置文件。
|
||||
|
||||
您的首要任务是选择一种格式，然后记录该选择。 解决了这个简单的部分之后就是时候解析配置了。
|
||||
有几种流行的配置文件格式。其中包括古老的（虽然有时定义不明确）INI 格式，虽然流行但有时难以手写的 JSON 格式，使用广泛但有时在细节方面令人意外的 YAML 格式，以及很多人还没有听说过的最新出现的 TOML。
|
||||
|
||||
你的首要任务是选择一种格式，然后记录该选择。解决了这个简单的部分之后就是时候解析配置了。
|
||||
|
||||
有时，在配置中拥有一个与“抽象“数据相对应的类是一个不错的想法。因为这段代码不会对配置做任何事情，所以这是展示解析逻辑最简单的方式。
|
||||
|
||||
@ -25,10 +26,11 @@
|
||||
|
||||
配置类的抽象定义可能类似于：
|
||||
|
||||
```
|
||||
from __future__ import annotations
|
||||
```
|
||||
|
||||
```
|
||||
`from __future__ import annotations`[/code] [code]
|
||||
|
||||
import attr
|
||||
|
||||
@attr.frozen
|
||||
@ -44,8 +46,7 @@ class Configuration:
|
||||
parameters: Parameters
|
||||
```
|
||||
|
||||
为了使特定于格式的代码更简单，您还将编写一个函数来从字典中解析此类。 请注意，这假设配置将使用破折号，而不是下划线。 这种差异并不少见。
|
||||
|
||||
为了使特定于格式的代码更简单，你还需要编写一个函数来从字典中解析此类。请注意，这假设配置将使用破折号，而不是下划线。 这种差异并不少见。
|
||||
|
||||
```
|
||||
def configuration_from_dict(details):
|
||||
@ -68,7 +69,6 @@ JSON（JavaScript Object Notation）是一种类似于 JavaScript 的格式。
|
||||
|
||||
以下是 JSON 格式的示例配置：
|
||||
|
||||
|
||||
```
|
||||
json_config = """
|
||||
{
|
||||
@ -88,7 +88,6 @@ json_config = """
|
||||
|
||||
解析逻辑使用 `json` 模块将 JSON 解析为 Python 的内置数据结构（字典、列表、字符串），然后从字典中创建类：
|
||||
|
||||
|
||||
```
|
||||
import json
|
||||
def configuration_from_json(data):
|
||||
@ -102,7 +101,6 @@ INI 格式，最初只在 Windows 上流行，之后成为配置标准格式。
|
||||
|
||||
这是与 INI 相同的配置：
|
||||
|
||||
|
||||
```
|
||||
ini_config="""
|
||||
[files]
|
||||
@ -116,7 +114,6 @@ patterns = ['*.txt', '*.md']
|
||||
|
||||
Python 可以使用内置的 `configparser` 模块解析它。解析器充当类似 `dict` 的对象，因此可以直接传递给 `configuration_from_dict`：
|
||||
|
||||
|
||||
```
|
||||
import configparser
|
||||
|
||||
@ -128,11 +125,10 @@ def configuration_from_ini(data):
|
||||
|
||||
### YAML
|
||||
|
||||
YAML (Yet Another Markup Language) 是 JSON 的扩展，旨在更易于手动编写。 部分 YAML 需要通过具有较长的规范来实现这一点。
|
||||
YAML（Yet Another Markup Language）是 JSON 的扩展，旨在更易于手动编写。为了实现了这一点，部分原因是有一个很长的规范。
|
||||
|
||||
以下是 YAML 中的相同配置：
|
||||
|
||||
|
||||
```
|
||||
yaml_config = """
|
||||
files:
|
||||
@ -145,8 +141,7 @@ parameters:
|
||||
"""
|
||||
```
|
||||
|
||||
要让 Python 解析它，您需要安装第三方模块。 最受欢迎的是`PyYAML`（`pip install pyyaml`）。 YAML 解析器还返回可以传递给 `configuration_from_dict` 的内置 Python 数据类型。 但是，YAML 解析器需要一个字节流，因此您需要将字符串转换为字节流。
|
||||
|
||||
要让 Python 解析它，你需要安装第三方模块。最受欢迎的是`PyYAML`（`pip install pyyaml`）。 YAML 解析器还返回可以传递给 `configuration_from_dict` 的内置 Python 数据类型。但是，YAML 解析器需要一个字节流，因此你需要将字符串转换为字节流。
|
||||
|
||||
```
|
||||
import io
|
||||
@ -159,11 +154,10 @@ def configuration_from_yaml(data):
|
||||
|
||||
### TOML
|
||||
|
||||
TOML（Tom's Own Markup Language）旨在成为 YAML 的轻量级替代品。 规范比较短，已经在一些地方流行了（比如 Rust 的包管理器 Cargo 就用它来进行包配置）。
|
||||
TOML（Tom's Own Markup Language）旨在成为 YAML 的轻量级替代品。其规范比较短，已经在一些地方流行了（比如 Rust 的包管理器 Cargo 就用它来进行包配置）。
|
||||
|
||||
这是与 TOML 相同的配置：
|
||||
|
||||
|
||||
```
|
||||
toml_config = """
|
||||
[files]
|
||||
@ -175,8 +169,7 @@ patterns = [ "*.txt", "*.md",]
|
||||
"""
|
||||
```
|
||||
|
||||
为了解析 TOML，您需要安装第三方包。 最流行的一种被简单地称为 `toml`。 与 YAML 和 JSON 一样，它返回基本的 Python 数据类型。
|
||||
|
||||
为了解析 TOML，你需要安装第三方包。最流行的一种被简单地称为 `toml`。 与 YAML 和 JSON 一样，它返回基本的 Python 数据类型。
|
||||
|
||||
```
|
||||
import toml
|
||||
@ -185,9 +178,9 @@ def configuration_from_toml(data):
|
||||
return configuration_from_dict(parsed)
|
||||
```
|
||||
|
||||
### Summary总结
|
||||
### 总结
|
||||
|
||||
选择配置格式是一种微妙的权衡。 但是，一旦您做出决定，Python 就可以使用少量代码来解析大多数流行的格式。
|
||||
选择配置格式是一种微妙的权衡。但是，一旦你做出决定，Python 就可以使用少量代码来解析大多数流行的格式。
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
@ -196,7 +189,7 @@ via: https://opensource.com/article/21/6/parse-configuration-files-python
|
||||
作者：[Moshe Zadka][a]
|
||||
选题：[lujun9972][b]
|
||||
译者：[zepoch](https://github.com/zepoch)
|
||||
校对：[校对者ID](https://github.com/校对者ID)
|
||||
校对：[wxy](https://github.com/wxy)
|
||||
|
||||
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出
|
||||
|
||||
Loading…
Reference in New Issue
Block a user