不到100行代码实现json文件注释功能

Posted 2023-02-02 穿越临界点

在学习资料满天飞的大环境下，知识变得非常零散，体系化的知识并不多，这就导致很多人每天都努力学习到感动自己，最终却收效甚微，甚至放弃学习。我的使命就是过滤掉大量的无效信息，将知识体系化，以短平快的方式直达问题本质，把大家从大海捞针的痛苦中解脱出来。

文章目录

• • 0 前言
  • 1 实现

0 前言

使用json做配置文件感觉最不方便的一件事就是不支持方便的注释。

下面用python和正则表达式做一个小工具解决这个问题。

1 实现

# -*- coding=utf-8 -*-
# file name: strip_off_json_comment.py
# function: strip off comments of json files; comments start with '#'
# author: chuanyuelinjiedian

import sys
import os
import argparse
import re

def get_lines_of_file(file_name):
    f = open(file_name, encoding='utf-8')
    lines = f.readlines()
    f.close()

    return lines

def write_lines_into_file(file_name, lines):
    f = open(file_name, 'w', encoding='utf-8')
    f.writelines(lines)
    f.close()

def strip_off_comment(lines):
    out_lines = []

    for line in lines:
        reg = re.compile(r'.*(?=#)')
        ret = re.findall(reg, line)
        if (len(ret) >= 1):
            out_lines.append(ret[0]+'\\n')
        else:
            out_lines.append(line)
    #print(out_lines)
    return out_lines

def strip_off_comment_of_file(input_file_path, output_file_path):
    lines = get_lines_of_file(input_file_path)
    ret = strip_off_comment(lines)
    write_lines_into_file(output_file_path, ret)

def strip_off_comment_of_files(input_dir, output_dir):
    print(f'input_dir:input_dir')
    print(f'output_dir:output_dir\\n')
    if input_dir == output_dir:
        return False
    if not os.path.exists(output_dir):
        os.makedirs(output_dir)

    file_names = os.listdir(input_dir)
    input_files_num = 0
    output_files_num = 0
    # deal with files one by one
    for file_name in file_names:
        if not file_name.endswith(".json"):
            continue
        input_files_num += 1
        input_file_path = input_dir + "/" + file_name
        output_file_path = output_dir + "/" + file_name
        print(f'input_file_path: input_file_path')
        print(f'output_file_path: output_file_path\\n')
        
        strip_off_comment_of_file(input_file_path, output_file_path)
        output_files_num += 1

    if (input_files_num == output_files_num):
        return True
    else:
        print(f'input_files_num(input_files_num) is not equal output_files_num(output_files_num)')
        return False

def main():
    parser = argparse.ArgumentParser(description="Strip off comments of json files (comments start with '#')",
                                     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
    parser.add_argument('-i', '--input_dir',
                        help='Input directory to look up files.',
                        default='.')
    parser.add_argument('-o', '--output_dir',
                        help='Output directory - will overwrite existing file.',
                        default='./output')
    args = parser.parse_args()

    if strip_off_comment_of_files(args.input_dir, args.output_dir):
        print("Strip success!")
        return True
    else:
        print("Strip Failed!")
        return False
    

if __name__ == "__main__":
    main()

---

恭喜你又坚持看完了一篇博客，又进步了一点点！如果感觉还不错就点个赞再走吧，你的点赞和关注将是我持续输出的哒哒哒动力~~