Python 文件操作:Markdown 格式

Markdown 是一种轻量级标记语言,用于以纯文本形式编写格式化文档。

它使用简洁的符号表示标题、列表、表格、链接、代码块等结构,易于阅读与编辑,同时可通过渲染生成 HTML、PDF、幻灯片等格式。

Markdown 广泛应用于技术文档、博客、GitHub README、笔记管理以及学术写作等场景。

一、Markdown 格式特点

Markdown 文件扩展名通常为 .md 或 .markdown。

主要特点:

(1)纯文本

文件内容可直接在任何文本编辑器中查看。

(2)可读性强

即使不渲染,也能理解文档结构。

(3)轻量化标记

使用符号表示格式,如 # 表示标题,* 或 - 表示列表。

(4)可扩展

支持表格、脚注、数学公式(需扩展)、代码高亮等。

(5)跨平台

兼容 Git、博客平台、文档生成器等。

示例 Markdown 内容:

# 学生成绩表| ID | Name  | Score ||----|-------|-------|| 1  | Alice | 95    || 2  | Bob   | 88    || 3  | Carol | 90    |- 高分学生:成绩 >= 90- 平均分:91.0> 注:Markdown 文件支持引用、列表、表格及代码块。

该示例展示了 Markdown 的基本语法:标题、表格、列表与引用。

二、在 Python 中表示 Markdown 数据

(1)使用字符串与内存文件对象

当我们想在内存中操作 Markdown,而不立即写入磁盘时,可使用 io.StringIO。

from io import StringIO md_text = """# 学生成绩表 | ID | Name  | Score ||----|-------|-------|| 1  | Alice | 95    || 2  | Bob   | 88    || 3  | Carol | 90    |""" # 创建内存中文本文件对象buf = StringIO(md_text)print(buf.read())

StringIO 适合测试、临时存储或处理网络请求中的 Markdown 内容。

(2)使用列表/字典在内存中表示表格数据

在生成 Markdown 表格前,通常先在内存中准备数据:

students = [    {"id": 1, "name": "Alice", "score": 95},    {"id": 2, "name": "Bob", "score": 88},    {"id": 3, "name": "Carol", "score": 90},]

这种结构便于程序化生成 Markdown 表格或列表。

三、使用 Python 标准库生成 Markdown

虽然 Python 标准库没有专门的 Markdown 模块,但可以直接通过字符串操作生成 Markdown 文件。

(1)生成 Markdown 表格

students = [    {"id": 1, "name": "Alice", "score": 95},    {"id": 2, "name": "Bob", "score": 88},    {"id": 3, "name": "Carol", "score": 90},] # 表头md_lines = ["| ID | Name | Score |", "|----|------|-------|"] # 添加每一行for s in students:    md_lines.append(f"| {s['id']} | {s['name']} | {s['score']} |") # 写入 Markdown 文件with open("students.md", "w", encoding="utf-8") as f:    f.write("\n".join(md_lines)) print("students.md 文件已保存。")

输出 Markdown 文件内容:

| ID | Name | Score ||----|------|-------|| 1 | Alice | 95 || 2 | Bob | 88 || 3 | Carol | 90 |

(2)生成标题、列表与代码块

students = [    {"id": 1, "name": "Alice", "score": 95},    {"id": 2, "name": "Bob", "score": 88},    {"id": 3, "name": "Carol", "score": 90},] md_lines = [] # 标题md_lines.append("# 学生成绩分析") # 列表top_students = [s for s in students if s["score"] >= 90]md_lines.append("- 高分学生:")for s in top_students:    md_lines.append(f"  - {s['name']}:{s['score']}") # 代码块md_lines.append("\n```python")md_lines.append("print('Hello, Markdown!')")md_lines.append("```") # 写入文件with open("analysis.md", "w", encoding="utf-8") as f:    f.write("\n".join(md_lines)) print("analysis.md 文件已保存。")

生成文件可直接渲染为带列表和代码块的 Markdown 文档。

四、使用第三方库处理 Markdown

(1)将 Markdown 转换为 HTML

import markdown with open("students.md", "r", encoding="utf-8") as f:    md_content = f.read() html_content = markdown.markdown(md_content) # 保存 HTML 文件with open("students.html", "w", encoding="utf-8") as f:    f.write(html_content) print("students.html 已生成,可在浏览器中查看。")

说明:markdown 库支持表格、代码块、标题和列表渲染为 HTML,方便展示。

(2)使用 pandas 直接生成 Markdown 表格

import pandas as pd df = pd.DataFrame(students) # 生成 Markdown 表格md_table = df.to_markdown(index=False)print(md_table) # 保存到文件with open("students_table.md", "w", encoding="utf-8") as f:    f.write(md_table)

输出示例:

|   ID | Name  |   Score ||------|-------|---------||    1 | Alice |      95 ||    2 | Bob   |      88 ||    3 | Carol |      90 |

pandas to_markdown 方法可快速将 DataFrame 输出为 Markdown 表格。

(3)案例:Markdown 文件生成与分析

以下示例展示从内存数据 → Markdown 表格 → HTML 渲染 → 保存文件的完整流程。

import pandas as pdimport markdown # 构造原始数据students = [    {"id": 1, "name": "Alice", "score": 95},    {"id": 2, "name": "Bob", "score": 88},    {"id": 3, "name": "Carol", "score": 90},    {"id": 4, "name": "David", "score": 70},] df = pd.DataFrame(students) # 筛选高分学生top_students = df[df["score"] >= 90] # 生成 Markdown 表格md_lines = ["# 高分学生表", top_students.to_markdown(index=False)]with open("top_students.md", "w", encoding="utf-8") as f:    f.write("\n".join(md_lines)) # 渲染为 HTMLwith open("top_students.md", "r", encoding="utf-8") as f:    md_content = f.read() html_content = markdown.markdown(md_content)with open("top_students.html", "w", encoding="utf-8") as f:    f.write(html_content) print("top_students.md 与 top_students.html 已生成。")

Markdown 文件内容示例:

# 高分学生表|   id | Name  |   score ||------|-------|---------||    1 | Alice |      95 ||    3 | Carol |      90 |

五、解析 Markdown 文件并提取内容

在某些场景下,我们需要读取并解析 Markdown 内容,将标题、列表、表格或代码块转换为 Python 数据结构,以便进一步分析。

(1)使用 markdown + BeautifulSoup 提取 HTML 内容

import markdownfrom bs4 import BeautifulSoup # 读取 Markdown 文件with open("top_students.md", "r", encoding="utf-8") as f:    md_content = f.read() # 渲染为 HTMLhtml_content = markdown.markdown(md_content) # 使用 BeautifulSoup 解析 HTMLsoup = BeautifulSoup(html_content, "html.parser") # 提取标题title = soup.find(["h1", "h2", "h3"])print("标题:", title.text) # 提取表格table = soup.find("table")rows = []for tr in table.find_all("tr"):    cells = [td.get_text(strip=True) for td in tr.find_all(["th", "td"])]    rows.append(cells) print("表格内容:")for r in rows:    print(r)

输出示例:

标题: 高分学生表表格内容:['id', 'Name', 'score']['1', 'Alice', '95']['3', 'Carol', '90']

(2)使用正则表达式(re 标准库)提取表格内容

import re with open("top_students.md", "r", encoding="utf-8") as f:    md_content = f.read() # 匹配 Markdown 表格行lines = md_content.splitlines()table_rows = [] for line in lines:    if "|" in line and not re.match(r"^\s*#|^-{2,}", line):        cells = [cell.strip() for cell in line.strip("|").split("|")]        table_rows.append(cells) print("解析表格:")for row in table_rows:    print(row)

说明:

正则方法适合简单表格,但不支持嵌套或复杂 Markdown 结构。

对于多级列表、代码块或引用,推荐 HTML 渲染 + BeautifulSoup 方法。

(3)案例:Markdown 表格 → Python 数据 → 数据分析

import pandas as pdimport markdownfrom bs4 import BeautifulSoup # 读取 Markdown 并渲染为 HTMLwith open("top_students.md", "r", encoding="utf-8") as f:    md_content = f.read() html_content = markdown.markdown(md_content)soup = BeautifulSoup(html_content, "html.parser") # 提取表格数据table = soup.find("table")rows = []for tr in table.find_all("tr"):    cells = [td.get_text(strip=True) for td in tr.find_all(["th", "td"])]    rows.append(cells) # 转换为 DataFramedf = pd.DataFrame(rows[1:], columns=rows[0])df["score"] = df["score"].astype(int) # 统计平均分avg_score = df["score"].mean()print(df)print(f"平均分:{avg_score:.1f}")

运行结果:

id   Name  score0   1  Alice     951   3  Carol     90平均分:92.5

📘 小结

Markdown 是轻量级、可读性强、跨平台的文档格式。Python 标准库通过字符串操作即可生成 Markdown 文件。

第三方库 markdown 可将 Markdown 渲染为 HTML,方便展示和解析。pandas to_markdown 方法可快速生成 Markdown 表格。

综合流程包括:生成 Markdown → 渲染/解析 → 转换数据结构 → 数据分析 → 输出结果,适合文档化与数据处理相结合的场景。

图片

“点赞有美意,赞赏是鼓励”

Read more

【Linux/C++多进程篇(一) 】一个变两个?揭秘 C/C++ 程序中神奇的“分身术”

【Linux/C++多进程篇(一) 】一个变两个?揭秘 C/C++ 程序中神奇的“分身术”

⭐️在这个怀疑的年代,我们依然需要信仰。 个人主页:YYYing. ⭐️Linux/C++进阶系列专栏:【从零开始的linux/c++进阶编程】 ⭐️其他专栏:【linux基础】【数据结构与算法】【从零开始的计算机网络学习】 系列上期内容:【Linux/C++文件篇(一) 】标准I/O与文件I/O基础  系列下期内容:【Linux/C++多进程篇(二) 】万字解析linux系统编程之进程间通信 (IPC) 目录 前言:        多进程理论基础 一、为什么要引入多进程 二、多进程相关概念 三、进程的内存管理 四、进程与程序的区别 五、进程的种类 六、进程PID 七、特殊的进程 八、linux中有关进程的指令 九、进程状态的切换

By Ne0inhk
C++11 面试题插入(左值引用和右值引用的区别)移动构造和移动赋值C++新标准如何解决传值返回但对象销毁问题

C++11 面试题插入(左值引用和右值引用的区别)移动构造和移动赋值C++新标准如何解决传值返回但对象销毁问题

🎬 胖咕噜的稞达鸭:个人主页 🔥 个人专栏: 《数据结构》《C++初阶高阶》《算法入门》 ⛺️技术的杠杆,撬动整个世界! 列表初始化 1. 内置类型初始化 int x{2};int x1=2; 3. 自定义类型初始化 * 2.1 直接构造 本质是先构造一个Date临时对象, 再拷贝构造d1;但编译器会优化这个过程,直接用列表参数构造d1(即不会调用拷贝构造函数)。 //2.自定义类型(类)的列表初始化// 2.1可以直接构造,本质是先构造一个Date临时对象,// 再拷贝构造d1;但编译器会优化这个过程,直接用列表参数构造d1(即不会调用拷贝构造函数)。 Date d1 ={2025,11,01}; Date d2{2025,05,28}; * 2.

By Ne0inhk

C++KMP算法

KMP 算法详解:从暴力匹配到高效字符串查找(附 C++ 代码) 作者:poplar 标签:C++ / 字符串 / KMP / 算法 / 面试 在 LeetCode 第 28 题 「实现 strStr()」 中,要求我们在一个字符串(haystack)中查找另一个字符串(needle)首次出现的位置。 如果用暴力法,时间复杂度是 O(n×m),但在实际工程和面试中,我们更希望用 O(n + m) 的高效算法 —— 这就是 KMP(Knuth-Morris-Pratt)算法。 本文将带你从零彻底搞懂 KMP,包括: * 为什么需要 KMP? * 什么是前缀表(Prefix Table)

By Ne0inhk
【C++篇】面向对象编程的三大特性:深入解析继承机制

【C++篇】面向对象编程的三大特性:深入解析继承机制

目录 一、继承的概念  二、继承的基本定义 2.1 继承的定义格式 2.2 三大继承方式与访问限定符 三、基类与派生类的对象赋值转换 3.1 合法的赋值转换 小tip:子类对象赋值给父类对象不会产生临时变量 3.2 非法的赋值转换 3.3 强制类型转换的注意事项(了解) 四、继承中的作用域 4.1 成员变量的隐藏 4.2 成员函数的隐藏 五、派生类的默认成员函数 5.1 核心规则 5.2 代码演示 问题:为何析构函数的调用顺序是:派生类、基类? 六、继承的特殊场景:友元与静态成员 6.1

By Ne0inhk