back up profile's config.py when overwriting

Author: pvsr

CHANGELOG.md

@@ -17,6 +17,7 @@ qbpm now reads configuration options from a `$XDG_CONFIG_HOME/qbpm/config.toml`!
 
 ## other
   - support for symlinking `autoconfig.yml` in addition to or instead of sourcing `config.py`
+  - `qbpm new --overwrite`: back up existing config files by moving to e.g. `config.py.bak`
   - `contrib/qbpm.desktop`: add `MimeType` and `Keywords`, fix incorrect formatting of `Categories`
   - allow help text to be slightly wider to avoid awkward line breaks
   - macOS: fix detection of qutebrowser binary in /Applications

src/qbpm/profiles.py

@@ -45,6 +45,8 @@ def create_config(
     if not source.is_file():
         return
     user_config = profile.root / "config" / "config.py"
+    if overwrite and user_config.exists():
+        back_up(user_config)
     with user_config.open(mode="w" if overwrite else "x") as dest_config:
         out = partial(print, file=dest_config)
         out(
@@ -70,12 +72,16 @@ def link_autoconfig(
     if not source.is_file() or dest.resolve() == source.resolve():
         return
     if overwrite and dest.exists():
-        backup = Path(str(dest) + ".bak")
-        info(f"backing up existing autoconfig to {backup}")
-        dest.replace(backup)
+        back_up(dest)
     dest.symlink_to(source)
 
 
+def back_up(dest: Path) -> None:
+    backup = Path(str(dest) + ".bak")
+    info(f"backing up existing {dest.name} to {backup}")
+    dest.replace(backup)
+
+
 def check(profile: Profile) -> bool:
     if not profile.check_name():
         return False

tests/test_profiles.py

@@ -70,14 +70,13 @@ def test_overwrite_config(tmp_path: Path):
     url = "http://example.com"
     config_dir = profile.root / "config"
     config_dir.mkdir(parents=True)
+    config = config_dir / "config.py"
+    backup = config_dir / "config.py.bak"
     profiles.create_config(profile, tmp_path, "")
     profiles.create_config(profile, tmp_path, "", url, True)
-    assert list(config_dir.iterdir()) == [config_dir / "config.py"]
-    with (config_dir / "config.py").open() as conf:
-        for line in conf:
-            if url in line:
-                return
-    raise AssertionError()
+    assert set(config_dir.iterdir()) == {config, backup}
+    assert url in config.read_text()
+    assert url not in backup.read_text()
 
 
 def test_link_autoconfig(tmp_path: Path):