Cyclone-Team/gramps
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add support for embedding comments in ini header

Browse Source
This commit is contained in:
Christopher Horn 2022-06-08 22:02:01 -04:00 committed by Nick Hall
parent c122ccbf9d
commit 12616394b9
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
gramps/gen/test/config_test.py
View File

@ -139,6 +139,19 @@ class CompleteCheck(unittest.TestCase):
self.assertEqual(self.CM.get("section2.dict"), {'a': "apple", "b": "banana"})
self.assertEqual(self.CM.get("section2.unicode"), "Raötröme")
self.assertRaises(AttributeError, self.CM.save, TEST2_INI, comments=123)
self.assertRaises(AttributeError, self.CM.save, TEST2_INI, comments={"key":"pair"})
self.assertRaises(AttributeError, self.CM.save, TEST2_INI, comments=[123])
self.assertRaises(AttributeError, self.CM.save, TEST2_INI, comments=["line1", 123])
self.CM.save(TEST2_INI, comments=["test comment1"])
self.CM.load(TEST2_INI)
self.assertEqual(self.CM.get("section.setting3"), "Another String")
self.CM.save(TEST2_INI, comments=["test comment1", "test comment2"])
self.CM.load(TEST2_INI)
self.assertEqual(self.CM.get("section.setting3"), "Another String")
if __name__ == "__main__":
unittest.main()

10
gramps/gen/utils/configmanager.py
View File

@ -326,7 +326,7 @@ class ConfigManager:
# this could be a third-party setting; add it:
self.data[name][setting] = value
def save(self, filename = None):
def save(self, filename = None, comments = None):
"""
Saves the current section/settings to an .ini file. Optional filename
will override the default filename to save to, if given.
@ -345,6 +345,14 @@ class ConfigManager:
key_file.write(";; Gramps key file\n")
key_file.write(";; Automatically created at %s" %
time.strftime("%Y/%m/%d %H:%M:%S") + "\n\n")
if comments:
if not isinstance(comments, list):
raise AttributeError("Comments should be a list")
key_file.write("\n")
for comment in comments:
if not isinstance(comment, str):
raise AttributeError("Comment should be a string")
key_file.write(";; %s\n" % comment.strip("; \n"))
for section in sorted(self.data):
key_file.write("[%s]\n" % section)
for key in sorted(self.data[section]):