函数拼写错误检查

祖传代码中函数按CamelCase,snake_case,混合模式命名，存在大量相同概念命名不统一，函数功能重复，单词拼写错误等问题，这里使用Python脚本先将函数拆分问单词，然后检查函数拼写，梳理拼写错误和相同概念的多个不同命名问题。

import re
import csv
from spellchecker import SpellChecker

def split_function_name(name):
    # 处理CamelCase和snake_case
    words = re.findall(r'[A-Z][a-z]*|[a-z]+(?:_[a-z]*)*', name)
    return [word for part in words for word in part.split('_')] if '_' in name else words

def check_function_names(function_names, ignore_list):
    spell = SpellChecker()
    incorrect_functions = {}

    for func in function_names:
        words = split_function_name(func)
        misspelled_words = [word for word in words if spell.unknown([word]) and word not in ignore_list]

        if misspelled_words:
            incorrect_functions[func] = {
                'type': 'Correct Naming Convention',
                'misspelled': misspelled_words
            }

    return incorrect_functions

def load_function_names_from_csv(file_path):
    function_names = []
    with open(file_path, mode='r', encoding='utf-8') as file:
        reader = csv.reader(file)
        for row in reader:
            function_names.extend(row)
    return function_names

def load_ignore_list_from_file(file_path):
    ignore_list = set()
    with open(file_path, mode='r', encoding='utf-8') as file:
        for line in file:
            ignore_list.add(line.strip())
    return ignore_list

def main():
    # 从CSV文件加载函数名
    function_names_file_path = 'function_list.csv'  # 替换为你的CSV文件路径
    function_names = load_function_names_from_csv(function_names_file_path)

    # 从忽略文件加载忽略列表
    ignore_list_file_path = 'ignore_list.txt'  # 替换为你的忽略文件路径
    ignore_list = load_ignore_list_from_file(ignore_list_file_path)

    # 检查函数名
    result = check_function_names(function_names, ignore_list)

    # 输出结果
    for func, details in result.items():
        print(f"Function: {func}, Issue: {details['type']}, Misspelled Words: {details['misspelled']}")

    # 输出所有拼写错误字段
    all_misspelled_words = set()
    for details in result.values():
        all_misspelled_words.update(details['misspelled'])

    print(f"\nAll Misspelled Words: {list(all_misspelled_words)}")


if __name__ == "__main__":
    main()

代码目录结构：

sm/tool/SpellCheck/Function
.
├── functionSpellCheck.py
├── function_spell_check.sh
├── ignore_list.txt
└── sort_ignore_list.py

结果输出到文件：sm/tool/SpellCheck/Function/spell-check-result.txt，允许的命名添加到sm/tool/SpellCheck/Function/ignore_list.txt备案。