From 85c749826d0e0526a0797bdc5898f528af6a80ff Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sun, 1 Oct 2023 17:18:40 -0500 Subject: [PATCH] Fix to capture comments at the end of a file Technically, this shouldn't be necessary because the convention is to declare the comment and then use it. So no comment replacment text should be at the end of the file. But having a function makes the code more clear and no harm in having code that always works. --- db/schemas/gen_comments.py | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/db/schemas/gen_comments.py b/db/schemas/gen_comments.py index 8e2f96d..b52d1d4 100755 --- a/db/schemas/gen_comments.py +++ b/db/schemas/gen_comments.py @@ -211,6 +211,16 @@ def close_objs(db_objs): cf.shutdown() +def comment_obj(db_objs, obj_name, column, comment): + """Write the comments for a database object""" + db_obj = db_objs[obj_name] + if column: + sql = [SQL["column"].format(name=obj)] + else: + sql = db_obj.sql + db_obj.cf.write(sql, "".join(comment).rstrip()) + + def comments_from_file(file, db_objs): """Read the file and process all comments""" with file.open("r") as fd: @@ -221,12 +231,7 @@ def comments_from_file(file, db_objs): if line[0:indent] == prefix or line == "\n": comment.append(line[indent:]) else: - db_obj = db_objs[obj_name] - if column: - sql = [SQL["column"].format(name=obj)] - else: - sql = db_obj.sql - db_obj.cf.write(sql, "".join(comment).rstrip()) + comment_obj(db_objs, obj_name, column, comment) in_match = False if not in_match: match = OBJ_SUMMARY.match(line) @@ -249,6 +254,8 @@ def comments_from_file(file, db_objs): ) ) lineno += 1 + if in_match: + comment_obj(db_objs, obj_name, column, comment) def traverse_rst(rst_dir, db_objs): -- 2.34.1