Files
lightning/devtools/blockreplace.py
Christian Decker 744d111cea doc: Create a blockreplace tool to update generated blocks in docs
We introduced a minor issue in #5757 that was causing the manpages to
be added every time we regenerate instead of replacing them. The
script was a bit unscrutable, and we do this block-replacement in
several places I thought it might be a good idea to have a dedicated
tool to do it.

This allows us to have simpler Makefiles whenever we update a
generated block inside another file. It's python, but does not have
dependencies :-)

Changelog-None
2022-12-06 11:39:53 +10:30

63 lines
1.6 KiB
Python

#!/usr/bin/env python3
# A rather simple script to replace a block of text, delimited by
# markers, with new contents from stdin. Importantly the markers are
# left in the file so future runs can update the file without
# requiring a separate template. The markers are currently for
# reStructuredText only, but more can be added.
import argparse
import os
import sys
import textwrap
def replace(filename, blockname, content):
start = f".. block_start {blockname}"
stop = f".. block_end {blockname}"
tempfile = f"{filename}.tmp"
with open(filename, 'r') as i, open(tempfile, 'w') as o:
lines = i.readlines()
# Read lines up to the marker
while lines != []:
l = lines.pop(0)
o.write(l)
if l.strip() == start:
break
o.write(content)
# Skip lines until we get the end marker
while lines != []:
l = lines.pop(0)
if l.strip() == stop:
o.write(l)
break
# Now flush the rest of the file
for l in lines:
o.write(l)
# Move the temp file over the old one for an atomic replacement
os.rename(tempfile, filename)
def main(args):
parser = argparse.ArgumentParser(
prog='blockreplace'
)
parser.add_argument('filename')
parser.add_argument('blockname')
parser.add_argument('--indent', dest="indent", default="")
args = parser.parse_args()
content = sys.stdin.read()
content = textwrap.indent(content, args.indent)
replace(args.filename, args.blockname, content)
if __name__ == "__main__":
main(sys.argv)