废弃名称
方法和属性的原始命名约定是“驼峰命名法”。自 2013 年左右创建以来,PyMuPDF 的功能大幅增加,对应地增加了类、方法和属性。在许多情况下,这导致了不直观、不合逻辑和难看的名称,难以记忆或猜测。
几个版本之前,我因此决定转变方向,改用“蛇形命名法”标准。这是一项重大工作,需要逐步进行。我认为现在已经完成了(版本 1.18.14)。
以下列表将废弃的名称映射到它们的新版本。例如,属性pageCount
在 Document 类中变为page_count
。还有一些不那么明显的名称变更,例如方法getPNGdata
在 Pixmap 类中被重命名为tobytes
。
类的名称(驼峰命名法)和包范围的常量(大多数是大写)保持不变。
旧名称将保持为废弃的别名,直到 MuPDF 版本 1.19.0,并在随后的版本中被删除 - 可能是版本 1.20.0,但这取决于上游决策(MuPDF)。
从版本 1.19.0 开始,当使用别名方法时,我们将在sys.stderr
上发出废弃警告,例如Deprecation: 'newPage' removed from class 'Document' after v1.19.0 - use 'new_page'。
使用废弃的属性将不会引发此类型的警告。
从现在开始,所有废弃对象(方法和属性)将显示原始文档字符串的副本,并附带废弃消息,例如:
>>> print(pymupdf.Document.pageCount.__doc__) *** Deprecated and removed in version following 1.19.0 - use 'page_count'. *** Number of pages. >>> print(pymupdf.Document.newPage.__doc__) *** Deprecated and removed in version following 1.19.0 - use 'new_page'. *** Create and return a new page object. Args: pno: (int) insert before this page. Default: after last page. width: (float) page width in points. Default: 595 (ISO A4 width). height: (float) page height in points. Default 842 (ISO A4 height). Returns: A Page object.
有一个实用程序脚本alias-changer.py可用于在您的脚本中进行批量重命名。它接受单个文件或文件夹作为参数。如果提供了一个文件夹,则会更改其所有 Python 文件及其子文件夹中的文件。可以选择备份脚本。
对此页面有任何反馈吗?
本软件按原样提供,不附带任何明示或暗示的担保。本软件根据许可证分发,除非根据该许可证的条款明确授权,否则不得复制、修改或分发。有关更多信息,请参阅artifex.com的许可信息,或联系 Artifex Software Inc.,39 Mesa Street,Suite 108A,San Francisco CA 94129,美国。
本文档覆盖了所有版本直到 1.24.4。
[外链图片转存中…(img-U4FfyWzk-1718851464659)]