""" Demo script PyMuPDF Story class ------------------------------- Read the Python sources in the script directory and create a PDF of all their source codes. The following features are included as a specialty: 1. HTML source for pymupdf.Story created via Python API exclusively 2. Separate Story objects for page headers and footers 3. Use of HTML "id" elements for identifying source start pages 4. Generate a Table of Contents pointing to source file starts. This - uses the new Stoy callback feature - uses Story also for making the TOC page(s) """ import io import os import time import pymupdf THISDIR = os.path.dirname(os.path.abspath(__file__)) TOC = [] # this will contain the TOC list items CURRENT_ID = "" # currently processed filename - stored by recorder func MEDIABOX = pymupdf.paper_rect("a4-l") # chosen page size WHERE = MEDIABOX + (36, 50, -36, -36) # sub rectangle for source content # location of the header rectangle HDR_WHERE = (36, 5, MEDIABOX.width - 36, 40) # location of the footer rectangle FTR_WHERE = (36, MEDIABOX.height - 36, MEDIABOX.width - 36, MEDIABOX.height) def recorder(elpos): """Callback function invoked during story.place(). This function generates / collects all TOC items and updates the value of CURRENT_ID - which is used to update the footer line of each page. """ global TOC, CURRENT_ID if not elpos.open_close & 1: # only consider "open" items return level = elpos.heading y0 = elpos.rect[1] # top of written rectangle (use for TOC) if level > 0: # this is a header (h1 - h6) pno = elpos.page + 1 # the page number TOC.append( ( level, elpos.text, elpos.page + 1, y0, ) ) return CURRENT_ID = elpos.id if elpos.id else "" # update for footer line return def header_story(text): """Make the page header""" header = pymupdf.Story() hdr_body = header.body hdr_body.add_paragraph().set_properties( align=pymupdf.TEXT_ALIGN_CENTER, bgcolor="#eee", font="sans-serif", bold=True, fontsize=12, color="green", ).add_text(text) return header def footer_story(text): """Make the page footer""" footer = pymupdf.Story() ftr_body = footer.body ftr_body.add_paragraph().set_properties( bgcolor="#eee", align=pymupdf.TEXT_ALIGN_CENTER, color="blue", fontsize=10, font="sans-serif", ).add_text(text) return footer def code_printer(outfile): """Output the generated PDF to outfile.""" global MAX_TITLE_LEN where = +WHERE writer = pymupdf.DocumentWriter(outfile, "") print_time = time.strftime("%Y-%m-%d %H:%M:%S (%z)") thispath = os.path.abspath(os.curdir) basename = os.path.basename(thispath) story = pymupdf.Story() body = story.body body.set_properties(font="sans-serif") text = f"Python sources in folder '{THISDIR}'" body.add_header(1).add_text(text) # the only h1 item in the story files = os.listdir(THISDIR) # list / select Python files in our directory i = 1 for code_file in files: if not code_file.endswith(".py"): continue # read Python file source fileinput = open(os.path.join(THISDIR, code_file), "rb") text = fileinput.read().decode() fileinput.close() # make level 2 header hdr = body.add_header(2) if i > 1: hdr.set_pagebreak_before() hdr.add_text(f"{i}. Listing of file '{code_file}'") # Write the file code body.add_codeblock().set_bgcolor((240, 255, 210)).set_color("blue").set_id( code_file ).set_fontsize(10).add_text(text) # Indicate end of a source file body.add_paragraph().set_align(pymupdf.TEXT_ALIGN_CENTER).add_text( f"---------- End of File '{code_file}' ----------" ) i += 1 # update file counter i = 0 while True: i += 1 device = writer.begin_page(MEDIABOX) # create Story objects for header, footer and the rest. header = header_story(f"Python Files in '{THISDIR}'") hdr_ok, _ = header.place(HDR_WHERE) if hdr_ok != 0: raise ValueError("header does not fit") header.draw(device, None) # -------------------------------------------------------------- # Write the file content. # -------------------------------------------------------------- more, filled = story.place(where) # Inform the callback function # Args: # recorder: the Python function to call # {}: dictionary containing anything - we pass the page number story.element_positions(recorder, {"page": i - 1}) story.draw(device, None) # -------------------------------------------------------------- # Make / write page footer. # We MUST have a paragraph b/o background color / alignment # -------------------------------------------------------------- if CURRENT_ID: text = f"File '{CURRENT_ID}' printed at {print_time}{chr(160)*5}{'-'*10}{chr(160)*5}Page {i}" else: text = f"Printed at {print_time}{chr(160)*5}{'-'*10}{chr(160)*5}Page {i}" footer = footer_story(text) # write the page footer ftr_ok, _ = footer.place(FTR_WHERE) if ftr_ok != 0: raise ValueError("footer does not fit") footer.draw(device, None) writer.end_page() if more == 0: break writer.close() if __name__ == "__main__" or os.environ.get('PYTEST_CURRENT_TEST'): fileptr1 = io.BytesIO() t0 = time.perf_counter() code_printer(fileptr1) # make the PDF t1 = time.perf_counter() doc = pymupdf.open("pdf", fileptr1) old_count = doc.page_count # ----------------------------------------------------------------------------- # Post-processing step to make / insert the toc # This also works using pymupdf.Story: # - make a new PDF in memory which contains pages with the TOC text # - add these TOC pages to the end of the original file # - search item text on the inserted pages and cover each with a PDF link # - move the TOC pages to the front of the document # ----------------------------------------------------------------------------- story = pymupdf.Story() body = story.body body.add_header(1).set_font("sans-serif").add_text("Table of Contents") # prefix TOC with an entry pointing to this page TOC.insert(0, [1, "Table of Contents", old_count + 1, 36]) for item in TOC[1:]: # write the file name headers as TOC lines body.add_paragraph().set_font("sans-serif").add_text( item[1] + f" - ({item[2]})" ) fileptr2 = io.BytesIO() # put TOC pages to a separate PDF initially writer = pymupdf.DocumentWriter(fileptr2) i = 1 more = 1 while more: device = writer.begin_page(MEDIABOX) header = header_story(f"Python Files in '{THISDIR}'") # write the page header hdr_ok, _ = header.place(HDR_WHERE) header.draw(device, None) more, filled = story.place(WHERE) story.draw(device, None) footer = footer_story(f"TOC-{i}") # separate page numbering scheme # write the page footer ftr_ok, _ = footer.place(FTR_WHERE) footer.draw(device, None) writer.end_page() i += 1 writer.close() doc2 = pymupdf.open("pdf", fileptr2) # open TOC pages as another PDF doc.insert_pdf(doc2) # and append to the main PDF new_range = range(old_count, doc.page_count) # the TOC page numbers pages = [doc[i] for i in new_range] # these are the TOC pages within main PDF for item in TOC: # search for TOC item text to get its rectangle for page in pages: rl = page.search_for(item[1], flags=pymupdf.TEXTFLAGS_SEARCH) if rl != []: # this text must be on next page break else: assert 0, f'Cannot find {item[1]=} in {len(pages)=}.' rect = rl[0] # rectangle of TOC item text link = { # make a link from it "kind": pymupdf.LINK_GOTO, "from": rect, "to": pymupdf.Point(0, item[3]), "page": item[2] - 1, } page.insert_link(link) # insert the TOC in the main PDF doc.set_toc(TOC) # move all the TOC pages to the desired place (1st page here) for i in new_range: doc.move_page(doc.page_count - 1, 0) doc.ez_save(__file__.replace(".py", ".pdf"))