Find #pymupdf on Discord

Welcome to PyMuPDF

PyMuPDF 是一个高性能 Python 库，用于提取、分析、转换和处理 PDF （和其他）文档的数据。

PyMuPDF 托管在 GitHub 上，并在 PyPI 上注册。

---

本文档涵盖直至 1.25.4 的所有版本。

---

关于/About

• 功能比较
• 性能
• 许可和版权
• PyMuPDF4LLM
• PyMuPDF Pro

用户指南/User Guide

• 安装
• 基础用法
• 教程
• PyMuPDF、LLM 和 RAG
• 资源

教程/How to Guide

• 打开文件
  • 支持的文件类型
  • 如何打开文件
    • 使用 错误的文件扩展名
  • 打开远程文件
    • 从云服务打开文件
  • 以文本形式打开文件
    • 例子
• 文本
  • 如何提取所有文档文本
  • 如何将文本提取为 Markdown
  • 如何从页面中提取键值对
  • 如何从矩形内提取文本
  • 如何按自然阅读顺序提取文本
  • 如何从文档中 提取表格内容
  • 如何标记提取的文本
  • 如何标记搜索到的文本
  • 如何标记非水平文本
  • 如何分析字体特征
  • 如何插入文本
    • 如何编写文本行
    • 如何填充文本框
    • 如何用 HTML 文本填充文本框
  • 如何提取带颜色的文本
• 图片
  • 如何从文档页面制作图像
  • 如何提高 图像分辨率
  • 如何创建 Partial Pixmaps (部分像素图/剪辑)
  • 如何将剪辑缩放到 GUI 窗口
  • 如何创建或隐藏注释图像
  • 如何提取图像：非 PDF 文档
  • 如何提取图像：PDF 文档
  • 如何处理图像蒙版
  • 如何将所有图片（或文件）制作成一个 PDF
  • 如何创建矢量图片
  • 如何转换图像
  • 如何使用像素图：粘贴图像
  • 如何使用像素图：制作分形
  • 如何与 NumPy 交互
  • 如何将图像添加到 PDF 页面
  • 如何使用像素图：检查文本可见性
• 注释
  • 如何添加和修改注释
  • 如何使用 FreeText
  • 如何使用墨迹注释
• 绘图和图形
  • 如何提取绘图
  • 如何删除绘图
  • 如何绘制图形
• 故事
  • 如何添加一行带格式的文本
  • 如何使用图像
  • 如何读取故事的外部 HTML 和 CSS
  • 如何使用故事模板输出数据库内容
  • 如何与现有 PDF 集成
  • 如何从包 pymupdf-fonts 制作多列布局和访问字体
  • 如何制作环绕预定义“禁区”布局的布局
  • 如何输出 HTML 表格
  • 如何创建简单的网格布局
  • 如何生成目录
  • 如何显示 JSON 数据列表
  • 使用替代的 Story.write*() 函数
    • 如何使用 Story.write() 进行基本布局
    • 如何使用 Story.write_stabilized() 对目录进行迭代布局
    • 如何使用 Story.write_stabilized_links() 进行迭代布局和创建 PDF 链接
• 日记
  • 示例会话 1
  • 示例会话 2
• 多进程
• OCR - 光学字符识别
  • 如何对图像进行 OCR
  • 如何对文档页面进行 OCR
• 可选内容支持
  • 简介：可选内容概念
  • PyMuPDF 支持 PDF 可选内容
  • 如何添加可选内容
  • 如何定义复杂的可选内容条件
• 低级接口
  • 如何遍历 xref 表
  • 如何处理对象流
  • 如何处理页面内容
  • 如何访问 PDF 目录
  • 如何访问 PDF 文件尾部
  • 如何访问 XML 元数据
  • 如何扩展 PDF 元数据
  • 如何读取和更新 PDF 对象
• 常见问题及其解决方案
  • 如何动态清理损坏的 PDF
  • 如何将任何文档转换为 PDF
  • 更改注释：意外行为
    • 问题
    • 原因
    • 解决方案
  • 提取的文本缺失或不可读
    • 问题：未提取任何文本
    • 原因
    • 解决方案
    • 问题：文本不可读
    • 原因
    • 解决方案

API参考/API Reference

• 命令行界面
  • 调用
  • 清理和复制
  • 提取字体和图像
  • 合并 PDF 文档
  • 低级信息
  • 嵌入文件命令
  • 文本提取
• 类
  • Annot
  • Archive
  • Colorspace
  • DisplayList
  • Document
  • DocumentWriter
  • Font
  • Identity
  • IRect
  • Link
  • linkDest
  • Matrix
  • Outline
  • Page
  • Pixmap
  • Point
  • Quad
  • Rect
  • Shape
  • Story
  • TextPage
  • TextWriter
  • Tools
  • Widget
  • Xml
• 几何对象的运算符代数
  • 一般说明
  • 一元运算
  • 二元运算
  • 一些示例
• 低级函数和类
  • 函数
  • 设备
  • 协同工作: DisplayList 和 TextPage
• 术语
  • coordinate
  • matrix_like
  • rect_like
  • irect_like
  • point_like
  • quad_like
  • inheritable
  • MediaBox
  • CropBox
  • catalog
  • trailer
  • contents
  • resources
  • dictionary
  • page
  • pagetree
  • object
  • stream
  • unitvector
  • xref
  • fontsize
  • resolution
  • OCPD
  • OCCD
  • OCG
  • OCMD
  • ligature
• 常量和枚举
  • 常量
  • 文档权限
  • PDF可选内容代码
  • PDF 加密方法代码
  • 字体文件扩展名
  • 文本对齐
  • 字体属性
  • 文本提取标志
  • 链接目标类型
  • 链接目标标志
  • 注释相关常量
  • Widget Constants
  • PDF 标准混合模式
  • 图章注释图标
• 颜色数据库
  • 函数 getColor()
  • 打印颜色数据库

其他/Other

• 附录 1：文本提取详细信息
  • TextPage 的一般结构
  • 纯文本
  • 块
  • 单词
  • HTML
  • 控制 HTML 输出的质量
  • DICT (或 JSON)
  • RAWDICT (或 RAWJSON)
  • XML
  • XHTML
  • 文本提取标志默认值
  • 性能
• 附录 2：嵌入式文件的注意事项
  • 常规
  • MuPDF 支持
  • PyMuPDF 支持
• 附录 3：各类技术信息
  • 图像转换矩阵
  • PDF Base 14 字体
  • Adobe PDF 参考
  • 在 PyMuPDF 中使用 Python 序列作为参数
  • 确保 PyMuPDF 中重要对象的一致性
  • 方法设计 Page.show_pdf_page()
  • 诊断
  • 坐标
• 附录 4：性能比较方法
  • 使用的文件
  • 使用的工具
  • 复制/连接/合并
  • 文本提取
  • 页面渲染
• 更新日志
• 已废弃名称

---

您对此页面有任何反馈吗？

---

本软件按原样提供，不作任何明示或暗示担保。本软件根据许可分发，除非根据该许可条款明确授权，否则不得复制、修改或分发。请参阅 artifex.com 上的许可信息，或联系 Artifex Software Inc., 39 Mesa Street, Suite 108A, San Francisco CA 94129, United States 了解更多信息。

This documentation covers all versions up to 1.25.4.