使用Python解析配置文件

第一步是选择配置文件的格式:INI、JSON、YAML 或 TOML。

公司主营业务:网站设计制作、网站设计、移动网站开发等业务。帮助企业客户真正实现互联网宣传,提高企业的竞争能力。成都创新互联是一支青春激扬、勤奋敬业、活力青春激扬、勤奋敬业、活力澎湃、和谐高效的团队。公司秉承以“开放、自由、严谨、自律”为核心的企业文化,感谢他们对我们的高要求,感谢他们从不同领域给我们带来的挑战,让我们激情的团队有机会用头脑与智慧不断的给客户带来惊喜。成都创新互联推出兴平免费做网站回馈大家。

有时,程序需要足够的参数,将它们全部作为命令行参数或环境变量既不让人愉快也不可行。 在这些情况下,你将需要使用配置文件。

有几种流行的配置文件格式。其中包括古老的(虽然有时定义不明确)INI 格式,虽然流行但有时难以手写的 JSON 格式,使用广泛但有时在细节方面令人意外的 YAML 格式,以及很多人还没有听说过的最新出现的 TOML。

你的首要任务是选择一种格式,然后记录该选择。解决了这个简单的部分之后就是时候解析配置了。

有时,在配置中拥有一个与“抽象“数据相对应的类是一个不错的想法。因为这段代码不会对配置做任何事情,所以这是展示解析逻辑最简单的方式。

想象一下文件处理器的配置:它包括一个输入目录、一个输出目录和要提取的文件。

配置类的抽象定义可能类似于:

 
 
 
  1. from __future__ import annotations
 
 
 
  1. import attr
  2. @attr.frozen
  3. class Configuration:
  4. @attr.frozen
  5. class Files:
  6. input_dir: str
  7. output_dir: str
  8. files: Files
  9. @attr.frozen
  10. class Parameters:
  11. patterns: List[str]
  12. parameters: Parameters

为了使特定于格式的代码更简单,你还需要编写一个函数来从字典中解析此类。请注意,这假设配置将使用破折号,而不是下划线。 这种差异并不少见。

 
 
 
  1. def configuration_from_dict(details):
  2. files = Configuration.Files(
  3. input_dir=details["files"]["input-dir"],
  4. output_dir=details["files"]["output-dir"],
  5. )
  6. parameters = Configuration.Paraneters(
  7. patterns=details["parameters"]["patterns"]
  8. )
  9. return Configuration(
  10. files=files,
  11. parameters=parameters,
  12. )

JSON

JSON(JavaScript Object Notation)是一种类似于 JavaScript 的格式。

以下是 JSON 格式的示例配置:

 
 
 
  1. json_config = """
  2. {
  3. "files": {
  4. "input-dir": "inputs",
  5. "output-dir": "outputs"
  6. },
  7. "parameters": {
  8. "patterns": [
  9. "*.txt",
  10. "*.md"
  11. ]
  12. }
  13. }
  14. """

解析逻辑使用 json 模块将 JSON 解析为 Python 的内置数据结构(字典、列表、字符串),然后从字典中创建类:

 
 
 
  1. import json
  2. def configuration_from_json(data):
  3. parsed = json.loads(data)
  4. return configuration_from_dict(parsed)

INI

INI 格式,最初只在 Windows 上流行,之后成为配置标准格式。

这是与 INI 相同的配置:

 
 
 
  1. ini_config="""
  2. [files]
  3. input-dir = inputs
  4. output-dir = outputs
  5. [parameters]
  6. patterns = ['*.txt', '*.md']
  7. """

Python 可以使用内置的 configparser 模块解析它。解析器充当类似 dict 的对象,因此可以直接传递给 configuration_from_dict

 
 
 
  1. import configparser
  2. def configuration_from_ini(data):
  3. parser = configparser.ConfigParser()
  4. parser.read_string(data)
  5. return configuration_from_dict(parser)

YAML

YAML(Yet Another Markup Language)是 JSON 的扩展,旨在更易于手动编写。为了实现了这一点,部分原因是有一个很长的规范。

以下是 YAML 中的相同配置:

 
 
 
  1. yaml_config = """
  2. files:
  3. input-dir: inputs
  4. output-dir: outputs
  5. parameters:
  6. patterns:
  7. - '*.txt'
  8. - '*.md'
  9. """

要让 Python 解析它,你需要安装第三方模块。最受欢迎的是PyYAMLpip install pyyaml)。 YAML 解析器还返回可以传递给 configuration_from_dict 的内置 Python 数据类型。但是,YAML 解析器需要一个字节流,因此你需要将字符串转换为字节流。

 
 
 
  1. import io
  2. import yaml
  3. def configuration_from_yaml(data):
  4. fp = io.StringIO(data)
  5. parsed = yaml.safe_load(fp)
  6. return configuration_from_dict(parsed)

TOML

TOML(Tom's Own Markup Language)旨在成为 YAML 的轻量级替代品。其规范比较短,已经在一些地方流行了(比如 Rust 的包管理器 Cargo 就用它来进行包配置)。

这是与 TOML 相同的配置:

 
 
 
  1. toml_config = """
  2. [files]
  3. input-dir = "inputs"
  4. output-dir = "outputs"
  5. [parameters]
  6. patterns = [ "*.txt", "*.md",]
  7. """

为了解析 TOML,你需要安装第三方包。最流行的一种被简单地称为 toml。 与 YAML 和 JSON 一样,它返回基本的 Python 数据类型。

 
 
 
  1. import toml
  2. def configuration_from_toml(data):
  3. parsed = toml.loads(data)
  4. return configuration_from_dict(parsed)

总结

选择配置格式是一种微妙的权衡。但是,一旦你做出决定,Python 就可以使用少量代码来解析大多数流行的格式。

文章名称:使用Python解析配置文件
分享路径:http://www.shufengxianlan.com/qtweb/news36/255736.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联