Function get_text

src_classic/utils.py:761–854

Extract text from a page or an annotation. This is a unifying wrapper for various methods of the TextPage class. Args: option: (str) text, words, blocks, html, dict, json, rawdict, xhtml or xml. clip: (rect-like) restrict output to this area. flags: bit switches to

(
    page: Page,
    option: str = "text",
    clip: rect_like = None,
    flags: OptInt = None,
    textpage: TextPage = None,
    sort: bool = False,
    delimiters=None,
)

def get_text(
    page: Page,
    option: str = "text",
    clip: rect_like = None,
    flags: OptInt = None,
    textpage: TextPage = None,
    sort: bool = False,
    delimiters=None,
):
    """Extract text from a page or an annotation.

    This is a unifying wrapper for various methods of the TextPage class.

    Args:
        option: (str) text, words, blocks, html, dict, json, rawdict, xhtml or xml.
        clip: (rect-like) restrict output to this area.
        flags: bit switches to e.g. exclude images or decompose ligatures.
        textpage: reuse this TextPage and make no new one. If specified,
            'flags' and 'clip' are ignored.

    Returns:
        the output of methods get_text_words / get_text_blocks or TextPage
        methods extractText, extractHTML, extractDICT, extractJSON, extractRAWDICT,
        extractXHTML or etractXML respectively.
        Default and misspelling choice is "text".
    """
    formats = {
        "text": fitz.TEXTFLAGS_TEXT,
        "html": fitz.TEXTFLAGS_HTML,
        "json": fitz.TEXTFLAGS_DICT,
        "rawjson": fitz.TEXTFLAGS_RAWDICT,
        "xml": fitz.TEXTFLAGS_XML,
        "xhtml": fitz.TEXTFLAGS_XHTML,
        "dict": fitz.TEXTFLAGS_DICT,
        "rawdict": fitz.TEXTFLAGS_RAWDICT,
        "words": fitz.TEXTFLAGS_WORDS,
        "blocks": fitz.TEXTFLAGS_BLOCKS,
    }
    option = option.lower()
    if option not in formats:
        option = "text"
    if flags is None:
        flags = formats[option]

    if option == "words":
        return get_text_words(
            page,
            clip=clip,
            flags=flags,
            textpage=textpage,
            sort=sort,
            delimiters=delimiters,
        )
    if option == "blocks":
        return get_text_blocks(
            page, clip=clip, flags=flags, textpage=textpage, sort=sort
        )
    CheckParent(page)