ConfigUpdater 3.2

添加和删除选项

假设我们在一个字符串中有一个以下配置

cfg = """
[metadata]
author = Ada Lovelace
summary = The Analytical Engine
"""

我们可以像使用ConfigParser一样添加一个license选项，即键/值对

updater = ConfigUpdater()
updater.read_string(cfg)
updater["metadata"]["license"] = "MIT"

简单的print(updater)将显示新选项已附加到末尾

[metadata]
author = Ada Lovelace
summary = The Analytical Engine
license = MIT

由于许可证对我们来说非常重要，让我们说我们想要在summary之前添加它，甚至在它之前添加一个简短的注释

updater = ConfigUpdater()
updater.read_string(cfg)
(updater["metadata"]["summary"].add_before
                               .comment("Ada would have loved MIT")
                               .option("license", "MIT"))

这将导致

[metadata]
author = Ada Lovelace
# Ada would have loved MIT
license = MIT
summary = Analytical Engine calculating the Bernoulli numbers

使用add_after将产生相同的结果，看起来像

updater = ConfigUpdater()
updater.read_string(cfg)
(updater["metadata"]["author"].add_after
                              .comment("Ada would have loved MIT")
                              .option("license", "MIT"))

假设我们想将summary重命名为更常见的description

updater = ConfigUpdater()
updater.read_string(cfg)
updater["metadata"]["summary"].key = "description"

如果我们想完全删除摘要，我们可以简单地做del updater["metadata"]["summary"]。

添加和删除部分

添加和删除部分的工作方式与添加和删除选项相同，但处于更高层次。继续我们的Ada Lovelace示例，假设我们想在metadata之前添加一个名为options的部分，并添加注释和两个新行以将其与metadata分开

updater = ConfigUpdater()
updater.read_string(cfg)
(updater["metadata"].add_before
                    .section("options")
                    .comment("Some specific project options")
                    .space(2))

如预期，这会产生

[options]
# Some specific project options


[metadata]
author = Ada Lovelace
summary = The Analytical Engine

我们现在可以用我们之前学到的方法在新的部分中填充选项。如果我们想重命名现有部分，我们可以使用name属性来完成此操作

updater["metadata"].name = "MetaData"

有时可能有用的是以更声明性的方式而不是以编程方式注入新部分。假设我们已经这样定义了我们的新部分的多行字符串

sphinx_sect_str = """
[build_sphinx]
source_dir = docs
build_dir = docs/_build
"""

使用两个ConfigUpdater对象，我们可以轻松地将此部分注入到我们的示例中

sphinx = ConfigUpdater()
sphinx.read_string(sphinx_sect_str)
sphinx_sect = sphinx["build_sphinx"]

updater = ConfigUpdater()
updater.read_string(cfg)

(updater["metadata"].add_after
                    .space()
                    .section(sphinx_sect.detach()))

detach方法将从第一个对象中删除build_sphinx部分并将其添加到第二个对象中。这导致

[metadata]
author = Ada Lovelace
summary = The Analytical Engine

[build_sphinx]
source_dir = docs
build_dir = docs/_build

或者，如果您想在两个ConfigUpdater对象中保留build_sphinx（即防止它从第一个对象中删除，同时将其副本添加到第二个对象），您也可以依赖stdlib的copy.deepcopy函数而不是detach。

from copy import deepcopy

(updater["metadata"].add_after
                    .space()
                    .section(deepcopy(sphinx_sect)))

这种技术可用于ConfigUpdater内部的所有对象：部分、选项、注释和空白。

在ConfigUpdater的上下文中不鼓励使用浅拷贝，因为每个配置块都保留对其容器的引用，以便轻松编辑文档。当基于浅拷贝进行编辑（如添加或更改选项和注释）时，结果可能不可靠且出乎意料。

要了解ConfigUpdater API的工作方式，最好的方法是查看单元测试并阅读相关文档。