Python3: ini 配置文件解析器 ConfigParser

古城微笑少年丶 2021-09-22 00:26 396阅读 0赞

本文链接: https://xiets.blog.csdn.net/article/details/117579793

Python3 学习笔记（目录）

configparser 配置文件解析器。此模块用于处理类似于 Windows 的 .ini 配置文件。配置文件中有多个节（section），每个节下可以存储多个 name=value 的字段（option）。

Python 官网文档: configparser — 配置文件解析器

1. ConfigParser 解析器

configparser.ConfigParser 类的常用属性和方法：

构造方法：

  1. # 解析器的构造方法, 创建一个解析器
  2. class configparser.ConfigParser(defaults=None,
  3.                                 dict_type=dict, 
  4.                                 allow_no_value=False, 
  5.                                 delimiters=('=', ':'), 
  6.                                 comment_prefixes=('#', ';'), 
  7.                                 inline_comment_prefixes=None, 
  8.                                 strict=True, 
  9.                                 empty_lines_in_values=True, 
  10.                                 default_section=configparser.DEFAULTSECT, 
  11.                                 interpolation=BasicInterpolation(), 
  12.                                 converters={ })

读取方法：

  1. # 读取并解析 ini 格式的配置文件（可以是单个文件/str 或 多个文件组成的文件列表/list）
  2. read(filenames, encoding=None)
  4. # 从 f 读取并解析配置数据, 它必须是一个产生 Unicode 字符串的可迭代对象（例如以文本模式打开的文件）。
  5. read_file(f, source=None)
  7. # 从字符串中解析配置数据
  8. read_string(string, source='<string>')
  10. # 从任意一个提供了类似于字典的 items() 方法的对象加载配置
  11. read_dict(dictionary, source='<dict>')
  14. # 返回可用节的列表（由节的名称组成）, 不包括 [DEFAULT] 节, 
  15. # 如: ['section_name1', 'section_name2', ...]
  16. sections()
  19. # 返回由 [DEFAULT] 节的 options 组成的字典
  20. defaults()
  23. # 是否有指定名称的节, 不包括 [DEFAULT] 节
  24. has_section(section)
  27. # 返回指定节名称的可选项列表（由字段名称组成）, 包括 [DEFAULT] 中的 options
  28. # 如: ['option_name1', 'option_name2', ...]
  29. # 不存在将抛出 NoSectionError 异常。
  30. options(section)
  33. # 指定节名称的 section 中是否有一个 option 字段
  34. has_option(section, option)
  37. # 返回 section 中的所有 option 的 (name, value) 对组成的列表, 包括 [DEFAULT]
  38. items(section, raw=False, vars=None)
  41. # 获取指定名称的 section 中的一个 option 的值, 返回 str 类型。不存在将抛出 KeyError 异常。
  42. get(section, option, *, raw=False, vars=None[, fallback])
  44. # get() 方法获取的值转换为 int
  45. getint(section, option, *, raw=False, vars=None[, fallback])
  47. # get() 方法获取的值转换为 float
  48. getfloat(section, option, *, raw=False, vars=None[, fallback])
  50. # get() 方法获取的值转换为 bool。
  51. # '1', 'yes', 'true' 和 'on' 将返回 True;
  52. # '0', 'no', 'false' 和 'off' 将返回 False。
  53. getboolean(section, option, *, raw=False, vars=None[, fallback])

写入方法：

  1. # 如果给定的 section 存在，则将所给出的 option 设为指定的 value 值
  2. set(section, option, value)
  5. # 添加名名称为 section 的节, 如果已存在将抛出异常
  6. add_section(section)
  9. # 移除 section 中的 option
  10. remove_option(section, option)
  13. # 移除指定的 section
  14. remove_section(section)
  17. # 将所有配置写入指定的 file object, 该对象必须以文本模式打开。 
  18. write(fileobject, space_around_delimiters=True)

2. 解析 ini 配置文件

一个 ini 配置文件：config.ini

  1. [DEFAULT]
  2. common1 = common default
  3. common2 = 1000
  5. [Hello]
  6. ki = 100
  7. kf = 3.14
  8. ks = hello world
  9. kb1 = yes
  10. kb2 = no
  11. aa.bb = = cc [ dd
  13. [github.com]
  14. User = System
  15. Passwd = 123456

解析 config.ini 配置文件：

  1. import configparser
  3. # 创建配置文件解析器
  4. config = configparser.ConfigParser()
  6. # 读取并解析配置文件
  7. config.read("config.ini")
  9. # [DEFAULT] 节的字典
  10. print(config.defaults())        # {'common1': 'common default', 'common2': '1000'}
  12. # [DEFAULT] 除外的所有节
  13. print(config.sections())        # ['Hello', 'github.com']
  15. # [github.com] 节中的所有 option 的 names, 包括 [DEFAULT]
  16. print(config.options("github.com"))     # ['user', 'passwd', 'common1', 'common2']
  18. # 判断是否有指定名称的节
  19. print(config.has_section("Hello"))      # True
  20. print(config.has_section("hello"))      # False（区分大小写）
  22. # 判断指定 section 中是否存在指定 option
  23. print(config.has_option("github.com", "User"))  # True
  24. print(config.has_option("github.com", "UsEr"))  # True（不区分大小写）
  26. # 获取 option 的值
  27. print(config.get("DEFAULT", "common1"))     # 'common default'
  28. print(config.get("Hello", "common1"))       # 'common default'
  30. print(config["DEFAULT"]["common2"])         # '1000'（可以直接使用索引访问）
  32. print(config.get("Hello", "ki"))            # '100'
  33. print(config.get("Hello", "kf"))            # '3.14'
  34. print(config.get("Hello", "ks"))            # 'hello world 你好 世界'（自动移除首位空格）
  35. print(config.get("Hello", "kb1"))           # 'yes'
  36. print(config.get("Hello", "kb2"))           # 'no'
  37. print(config.get("Hello", "aa.bb"))         # '= cc [ dd'
  39. print(config.get("github.com", "User"))     # 'System'
  40. print(config.get("github.com", "uSeR"))     # 'System'（不区分大小写）
  42. print(config.getint("Hello", "ki"))         # 100
  43. print(config.getfloat("Hello", "kf"))       # 3.14
  44. print(config.getfloat("Hello", "ki"))       # 100.0
  45. print(config.getboolean("Hello", "kb1"))    # True
  46. print(config.getboolean("Hello", "kb2"))    # False

3. 配置保存为 ini 文件

沿用前面示例的 config.ini 文件：

  1. import configparser
  3. # 创建配置文件解析器
  4. config = configparser.ConfigParser()
  6. # 读取并解析配置文件
  7. config.read("config.ini")
  9. # 移除 节
  10. config.remove_section("Hello")
  11. # 移除 option
  12. config.remove_option("DEFAULT", "common1")
  14. # 设置 节 的 option 的值
  15. config.set("github.com", "User", "Hello")
  17. # 添加 节
  18. config.add_section("World")
  19. # 设置 节 的 option 的值
  20. config.set("World", "names", "bb")
  22. # 将所有配置写入文件
  23. with open("config2.ini", "wt") as f:
  24.     config.write(f)

查看 config2.ini 文件：

  1. [DEFAULT]
  2. common2 = 1000
  4. [github.com]
  5. user = Hello
  6. passwd = 123456
  8. [World]
  9. names = bb

发表评论

表情：
评论列表 （有 0 条评论，396人围观）

还没有评论，来说两句吧...

相关阅读