Add caching logging packaging and annotation management
This commit is contained in:
@@ -1,5 +1,6 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from collections import OrderedDict
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
from tempfile import NamedTemporaryFile
|
||||
@@ -22,6 +23,14 @@ class FormField:
|
||||
value: str
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class AnnotationInfo:
|
||||
page_index: int
|
||||
xref: int
|
||||
annotation_type: str
|
||||
content: str
|
||||
|
||||
|
||||
class EncryptedPdfError(RuntimeError):
|
||||
pass
|
||||
|
||||
@@ -30,6 +39,9 @@ class PdfDocument:
|
||||
def __init__(self) -> None:
|
||||
self.path: Path | None = None
|
||||
self._doc: fitz.Document | None = None
|
||||
self._revision = 0
|
||||
self._render_cache: OrderedDict[tuple[int, int, float], QImage] = OrderedDict()
|
||||
self._thumbnail_cache: OrderedDict[tuple[int, int, int], QImage] = OrderedDict()
|
||||
|
||||
@property
|
||||
def is_open(self) -> bool:
|
||||
@@ -59,8 +71,14 @@ class PdfDocument:
|
||||
self._doc.close()
|
||||
self._doc = None
|
||||
self.path = None
|
||||
self.clear_cache()
|
||||
|
||||
def render_page(self, page_index: int, zoom: float) -> QImage:
|
||||
cache_key = (self._revision, page_index, round(zoom, 3))
|
||||
if cache_key in self._render_cache:
|
||||
self._render_cache.move_to_end(cache_key)
|
||||
return self._render_cache[cache_key].copy()
|
||||
|
||||
page = self._page(page_index)
|
||||
matrix = fitz.Matrix(zoom, zoom)
|
||||
pixmap = page.get_pixmap(matrix=matrix, alpha=False)
|
||||
@@ -71,13 +89,22 @@ class PdfDocument:
|
||||
pixmap.stride,
|
||||
QImage.Format.Format_RGB888,
|
||||
)
|
||||
return image.copy()
|
||||
cached = image.copy()
|
||||
self._remember_cache_item(self._render_cache, cache_key, cached, max_items=16)
|
||||
return cached.copy()
|
||||
|
||||
def render_thumbnail(self, page_index: int, width: int = 150) -> QImage:
|
||||
cache_key = (self._revision, page_index, width)
|
||||
if cache_key in self._thumbnail_cache:
|
||||
self._thumbnail_cache.move_to_end(cache_key)
|
||||
return self._thumbnail_cache[cache_key].copy()
|
||||
|
||||
page = self._page(page_index)
|
||||
rect = page.rect
|
||||
zoom = width / rect.width
|
||||
return self.render_page(page_index, zoom)
|
||||
thumbnail = self.render_page(page_index, zoom)
|
||||
self._remember_cache_item(self._thumbnail_cache, cache_key, thumbnail, max_items=80)
|
||||
return thumbnail.copy()
|
||||
|
||||
def search(self, text: str, limit: int = 200) -> list[SearchMatch]:
|
||||
if not self._doc or not text.strip():
|
||||
@@ -103,6 +130,7 @@ class PdfDocument:
|
||||
def rotate_page(self, page_index: int, degrees: int = 90) -> None:
|
||||
page = self._page(page_index)
|
||||
page.set_rotation((page.rotation + degrees) % 360)
|
||||
self.mark_changed()
|
||||
|
||||
def highlight_text(self, page_index: int, text: str) -> int:
|
||||
page = self._page(page_index)
|
||||
@@ -110,6 +138,8 @@ class PdfDocument:
|
||||
for rect in rects:
|
||||
annot = page.add_highlight_annot(rect)
|
||||
annot.update()
|
||||
if rects:
|
||||
self.mark_changed()
|
||||
return len(rects)
|
||||
|
||||
def underline_text(self, page_index: int, text: str) -> int:
|
||||
@@ -118,6 +148,8 @@ class PdfDocument:
|
||||
for rect in rects:
|
||||
annot = page.add_underline_annot(rect)
|
||||
annot.update()
|
||||
if rects:
|
||||
self.mark_changed()
|
||||
return len(rects)
|
||||
|
||||
def strikeout_text(self, page_index: int, text: str) -> int:
|
||||
@@ -126,6 +158,8 @@ class PdfDocument:
|
||||
for rect in rects:
|
||||
annot = page.add_strikeout_annot(rect)
|
||||
annot.update()
|
||||
if rects:
|
||||
self.mark_changed()
|
||||
return len(rects)
|
||||
|
||||
def add_note(self, page_index: int, text: str) -> None:
|
||||
@@ -133,11 +167,13 @@ class PdfDocument:
|
||||
point = fitz.Point(72, 72)
|
||||
annot = page.add_text_annot(point, text)
|
||||
annot.update()
|
||||
self.mark_changed()
|
||||
|
||||
def add_text(self, page_index: int, text: str) -> None:
|
||||
page = self._page(page_index)
|
||||
point = fitz.Point(72, 96)
|
||||
page.insert_text(point, text, fontsize=14, fontname="china-s", color=(0, 0, 0))
|
||||
self.mark_changed()
|
||||
|
||||
def insert_image(self, page_index: int, image_path: str | Path) -> None:
|
||||
page = self._page(page_index)
|
||||
@@ -146,6 +182,7 @@ class PdfDocument:
|
||||
height = width * 0.75
|
||||
rect = fitz.Rect(72, 120, 72 + width, 120 + height)
|
||||
page.insert_image(rect, filename=str(image_path), keep_proportion=True)
|
||||
self.mark_changed()
|
||||
|
||||
def add_signature(self, page_index: int, image_path: str | Path) -> None:
|
||||
page = self._page(page_index)
|
||||
@@ -160,6 +197,7 @@ class PdfDocument:
|
||||
page_rect.height - margin,
|
||||
)
|
||||
page.insert_image(rect, filename=str(image_path), keep_proportion=True)
|
||||
self.mark_changed()
|
||||
|
||||
def add_rectangle(self, page_index: int) -> None:
|
||||
page = self._page(page_index)
|
||||
@@ -168,6 +206,7 @@ class PdfDocument:
|
||||
annot.set_colors(stroke=(0.9, 0.1, 0.1))
|
||||
annot.set_border(width=2)
|
||||
annot.update()
|
||||
self.mark_changed()
|
||||
|
||||
def add_circle(self, page_index: int) -> None:
|
||||
page = self._page(page_index)
|
||||
@@ -176,6 +215,7 @@ class PdfDocument:
|
||||
annot.set_colors(stroke=(0.1, 0.3, 0.9))
|
||||
annot.set_border(width=2)
|
||||
annot.update()
|
||||
self.mark_changed()
|
||||
|
||||
def add_line(self, page_index: int, arrow: bool = False) -> None:
|
||||
page = self._page(page_index)
|
||||
@@ -188,6 +228,7 @@ class PdfDocument:
|
||||
if arrow:
|
||||
annot.set_line_ends(fitz.PDF_ANNOT_LE_NONE, fitz.PDF_ANNOT_LE_CLOSED_ARROW)
|
||||
annot.update()
|
||||
self.mark_changed()
|
||||
|
||||
def add_cover_area(self, page_index: int) -> None:
|
||||
page = self._page(page_index)
|
||||
@@ -196,6 +237,7 @@ class PdfDocument:
|
||||
annot.set_colors(stroke=(1, 1, 1), fill=(1, 1, 1))
|
||||
annot.set_border(width=0)
|
||||
annot.update()
|
||||
self.mark_changed()
|
||||
|
||||
def insert_blank_page(self, after_page_index: int | None = None) -> int:
|
||||
if not self._doc:
|
||||
@@ -209,6 +251,7 @@ class PdfDocument:
|
||||
height = 842
|
||||
insert_at = self.page_count if after_page_index is None else after_page_index + 1
|
||||
self._doc.new_page(pno=insert_at, width=width, height=height)
|
||||
self.mark_changed()
|
||||
return insert_at
|
||||
|
||||
def insert_pdf(self, source_path: str | Path, after_page_index: int | None = None) -> int:
|
||||
@@ -218,6 +261,7 @@ class PdfDocument:
|
||||
with fitz.open(source_path) as source:
|
||||
count = source.page_count
|
||||
self._doc.insert_pdf(source, start_at=insert_at)
|
||||
self.mark_changed()
|
||||
return count
|
||||
|
||||
def extract_pages(self, page_numbers: list[int], target_path: str | Path) -> None:
|
||||
@@ -328,6 +372,38 @@ class PdfDocument:
|
||||
}
|
||||
)
|
||||
self._doc.set_metadata(metadata)
|
||||
self.mark_changed()
|
||||
|
||||
def annotations(self) -> list[AnnotationInfo]:
|
||||
if not self._doc:
|
||||
raise RuntimeError("没有打开 PDF")
|
||||
items: list[AnnotationInfo] = []
|
||||
for page_index in range(self.page_count):
|
||||
page = self._page(page_index)
|
||||
annot = page.first_annot
|
||||
while annot:
|
||||
content = annot.info.get("content", "") if annot.info else ""
|
||||
items.append(
|
||||
AnnotationInfo(
|
||||
page_index=page_index,
|
||||
xref=annot.xref,
|
||||
annotation_type=annot.type[1],
|
||||
content=content,
|
||||
)
|
||||
)
|
||||
annot = annot.next
|
||||
return items
|
||||
|
||||
def delete_annotation(self, page_index: int, xref: int) -> bool:
|
||||
page = self._page(page_index)
|
||||
annot = page.first_annot
|
||||
while annot:
|
||||
if annot.xref == xref:
|
||||
page.delete_annot(annot)
|
||||
self.mark_changed()
|
||||
return True
|
||||
annot = annot.next
|
||||
return False
|
||||
|
||||
def form_fields(self) -> list[FormField]:
|
||||
if not self._doc:
|
||||
@@ -358,6 +434,7 @@ class PdfDocument:
|
||||
if widget.field_name == field_name:
|
||||
widget.field_value = value
|
||||
widget.update()
|
||||
self.mark_changed()
|
||||
return True
|
||||
return False
|
||||
|
||||
@@ -365,6 +442,7 @@ class PdfDocument:
|
||||
if not self._doc:
|
||||
raise RuntimeError("没有打开 PDF")
|
||||
self._doc.delete_page(page_index)
|
||||
self.mark_changed()
|
||||
|
||||
def save(self) -> None:
|
||||
if not self.path:
|
||||
@@ -378,20 +456,25 @@ class PdfDocument:
|
||||
target = Path(path)
|
||||
target.parent.mkdir(parents=True, exist_ok=True)
|
||||
original_path = self.path
|
||||
if original_path and target.resolve() == original_path.resolve():
|
||||
self._doc.saveIncr()
|
||||
self._doc.close()
|
||||
self.path = target
|
||||
self._doc = fitz.open(target)
|
||||
self.mark_changed()
|
||||
return
|
||||
|
||||
with NamedTemporaryFile(delete=False, suffix=".pdf", dir=target.parent) as tmp:
|
||||
temp_path = Path(tmp.name)
|
||||
|
||||
try:
|
||||
self._doc.save(temp_path, garbage=4, deflate=True)
|
||||
if original_path and target.resolve() == original_path.resolve():
|
||||
self._doc.close()
|
||||
self._doc = None
|
||||
temp_path.replace(target)
|
||||
self.path = target
|
||||
if self._doc:
|
||||
self._doc.close()
|
||||
self._doc = fitz.open(target)
|
||||
self.mark_changed()
|
||||
finally:
|
||||
if temp_path.exists():
|
||||
temp_path.unlink()
|
||||
@@ -421,6 +504,26 @@ class PdfDocument:
|
||||
raise IndexError("页码超出范围")
|
||||
return self._doc.load_page(page_index)
|
||||
|
||||
def mark_changed(self) -> None:
|
||||
self._revision += 1
|
||||
self.clear_cache()
|
||||
|
||||
def clear_cache(self) -> None:
|
||||
self._render_cache.clear()
|
||||
self._thumbnail_cache.clear()
|
||||
|
||||
@staticmethod
|
||||
def _remember_cache_item(
|
||||
cache: OrderedDict,
|
||||
key: tuple,
|
||||
image: QImage,
|
||||
max_items: int,
|
||||
) -> None:
|
||||
cache[key] = image
|
||||
cache.move_to_end(key)
|
||||
while len(cache) > max_items:
|
||||
cache.popitem(last=False)
|
||||
|
||||
@staticmethod
|
||||
def _default_rect(page: fitz.Page) -> fitz.Rect:
|
||||
width = min(220, page.rect.width * 0.45)
|
||||
|
||||
Reference in New Issue
Block a user