Changeset e60c643 in trunk

Timestamp:

2020-11-18T15:57:38Z (5 years ago)

Author:

Jean-Paul Calderone <exarkun@…>

Branches:

master

Children:

aedac9d

Parents:

dc611bf

Message:

Make configutil.write_config atomic and also make it take a FilePath?

Location:

src/allmydata

Files:

• test/test_configutil.py (modified) (3 diffs)
• util/configutil.py (modified) (1 diff)

src/allmydata/test/test_configutil.py ¶

@@ -16 +16 @@
 import os.path
 
+from twisted.python.filepath import (
+    FilePath,
+)
 from twisted.trial import unittest
 
@@ -56 +59 @@
         # test that set_config can mutate an existing option
         configutil.set_config(config, "node", "nickname", "Alice!")
-        configutil.write_config(tahoe_cfg, config)
+        configutil.write_config(FilePath(tahoe_cfg), config)
 
         config = configutil.get_config(tahoe_cfg)
@@ -64 +67 @@
         descriptor = "Twas brillig, and the slithy toves Did gyre and gimble in the wabe"
         configutil.set_config(config, "node", "descriptor", descriptor)
-        configutil.write_config(tahoe_cfg, config)
+        configutil.write_config(FilePath(tahoe_cfg), config)
 
         config = configutil.get_config(tahoe_cfg)

src/allmydata/util/configutil.py ¶

@@ -60 +60 @@
 
 def write_config(tahoe_cfg, config):
-    with open(tahoe_cfg, "w") as f:
-        config.write(f)
+    """
+    Write a configuration to a file.
+
+    :param FilePath tahoe_cfg: The path to which to write the config.
+
+    :param ConfigParser config: The configuration to write.
+
+    :return: ``None``
+    """
+    tmp = tahoe_cfg.temporarySibling()
+    # FilePath.open can only open files in binary mode which does not work
+    # with ConfigParser.write.
+    with open(tmp.path, "wt") as fp:
+        config.write(fp)
+    tmp.moveTo(tahoe_cfg)
 
 def validate_config(fname, cfg, valid_config):