Merge remote-tracking branch 'origin/master' into nightly

overhangio · Sep 6, 2023 · d58df5c · d58df5c
2 parents 6941021 + 51928b0
commit d58df5c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/changelog.d/20230906_105044_regis_parse_pound_keys_in_settings.md b/changelog.d/20230906_105044_regis_parse_pound_keys_in_settings.md
@@ -0,0 +1 @@
+- [Bugfix] Correctly parse strings prefixed with pound "#" key in `tutor config save --set KEY=#value` commands. (by @regisb)
diff --git a/tests/test_serialize.py b/tests/test_serialize.py
@@ -41,6 +41,10 @@ def test_parse_key_value(self) -> None:
                 "x=key1:\n  subkey: value\nkey2:\n  subkey: value"
             ),
         )
+        self.assertEqual(
+            ("INDIGO_PRIMARY_COLOR", "#225522"),
+            serialize.parse_key_value("INDIGO_PRIMARY_COLOR=#225522"),
+        )
 
     def test_str_format(self) -> None:
         self.assertEqual("true", serialize.str_format(True))

diff --git a/tutor/serialize.py b/tutor/serialize.py
@@ -73,4 +73,8 @@ def parse_key_value(text: str) -> t.Optional[tuple[str, t.Any]]:
     if not value:
         # Empty strings are interpreted as null values, which is incorrect.
         value = "''"
+    elif "\n" not in value and value.startswith("#"):
+        # Single-line string that starts with a pound # key
+        # We need to escape the string, otherwise pound will be interpreted as a comment.
+        value = f'"{value}"'
     return key, parse(value)