Python 3.12下替代已弃用pymarkdownlint检查Markdown语法错误

问题根源 #

你调用的markdownlint命令绑定了已弃用的pymarkdownlint库，该库依赖Python 2的ConfigParser模块，在Python 3.12中因模块重命名（Python 3中为configparser）导致兼容性报错，且该库已停止维护。

可行替代方案 #

以下两个库均维护活跃、完全适配Python 3.12：

1. markdownlint-cli（Node.js生态，规则最全面） #

这是当前最主流的Markdown语法检查工具，规则覆盖广泛，更新频繁。

• 前置依赖：需先安装Node.js
• 安装命令：

npm install -g markdownlint-cli

• Python调用代码：

import subprocess
import json

def lint_markdown_file(file_path):
    command = ['markdownlint', '--json', file_path]
    process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    output, error = process.communicate()

    if process.returncode != 0:
        if output:
            lint_results = json.loads(output.decode().strip())
            print('Linting errors:')
            for file_errors in lint_results.values():
                for err in file_errors:
                    print(f"Line {err['line']}: {err['ruleNames'][0]} - {err['ruleDescription']}")
        else:
            print('Linting error:', error.decode().strip())
    else:
        print('No linting errors.')

# 调用示例
lint_markdown_file('text.md')

2. pymarkdown（纯Python实现，无需额外环境） #

纯Python编写的Markdown检查库，轻量且原生支持Python 3.12。

• 安装命令：

pip install pymarkdown

• Python调用代码：

from pymarkdown.main import PyMarkdown
from pymarkdown.config.logger_config import LoggerConfig

def lint_markdown_file(file_path):
    markdown_checker = PyMarkdown()
    logger_config = LoggerConfig()
    logger_config.enable_json_logging()
    
    # 执行文件检查
    error_entries = markdown_checker.parse_file(file_path, logger_config)
    
    if error_entries:
        print('Linting errors:')
        for entry in error_entries:
            print(f"Line {entry['line_number']}: {entry['rule_code']} - {entry['rule_description']}")
    else:
        print('No linting errors.')

# 调用示例
lint_markdown_file('text.md')

清理旧环境 #

先卸载不兼容的废弃库，避免命令冲突：

pip uninstall pymarkdownlint -y

内容的提问来源于stack exchange，提问作者user1223334