已弃用的名称#

方法和属性的原始命名约定是“camelCase”。自2013年左右创建以来,PyMuPDF的功能大幅增加——随之而来的是类、方法和属性的相应增加。在太多情况下,这导致了不直观、不合逻辑和难看的名称,难以记忆或猜测。

几次版本之前,我因此决定改变方向,转向“snake_cased”命名标准。 这是一个重大努力,需要逐步进行。我想我现在已经完成了(版本 1.18.14)。

以下列表将已弃用的名称映射到它们的新版本。例如,属性 pageCountDocument 类中变为 page_count。还有一些不那么明显的名称更改,例如方法 getPNGdataPixmap 类中被重命名为 tobytes

类的名称(驼峰命名法)和包内常量(大多数为大写)保持不变。

旧名称将通过 MuPDF 版本 1.19.0 作为弃用别名继续可用,并将在随后版本中被移除 - 可能是版本 1.20.0,但这取决于上游的决定 (MuPDF)。

从版本 1.19.0 开始,当使用别名方法时,我们将在 sys.stderr 上发出弃用警告,如 弃用: 'newPage' 已从 'Document' 移除 v1.19.0 - 请使用 '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, United States以获取更多信息。