particle-os/debian-forge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

util/toml: support writing comment headers

Browse source 
The containers.storage.conf stage writes a header explaining what the
configuration is doing and its origin.  It also supports adding extra
comments via stage options, which we need to support.  Add support for
writing comments at the top of the file in the toml.dump_to_file()
function.
This commit is contained in:
Achilleas Koutsou 2024-08-15 16:59:53 +02:00 • committed by Michael Vogt
parent 94cdcecafb
commit 123b23fb66
1 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
osbuild/util/toml.py
View file

@ -51,12 +51,23 @@ def load_from_file(path):
return toml.load(tomlfile)
def dump_to_file(data, path, pre=None):
def dump_to_file(data, path, header=""):
if tomlw is None:
raise RuntimeError("no toml module available with write support")
with open(path, wmode) as tomlfile:
if pre:
tomlfile.write(pre)
if header:
_write_comment(tomlfile, header)
tomlw.dump(data, tomlfile)
def _write_comment(f, comment: list):
if not comment:
return
data = "\n".join(map(lambda c: f"# {c}", comment)) + "\n\n"
if "b" in f.mode:
f.write(data.encode())
else:
f.write(data)