flet-printing 0.2.0__py3-none-any.whl

flet_printing/__init__.py

@@ -0,0 +1,5 @@
+from flet_printing.pdf_preview import PdfPreview
+from flet_printing.printing import Printing
+
+__version__ = "0.2.0"
+__all__ = ["Printing", "PdfPreview", "__version__"]

flet_printing/pdf_preview.py

@@ -0,0 +1,80 @@
+"""PdfPreview visual control — display a PDF with built-in print/share
+actions (wraps `printing`'s PdfPreview widget).
+
+Together with :class:`~flet_printing.Printing` this answers
+`flet-dev/flet#894 <https://github.com/flet-dev/flet/issues/894>`_ in
+full: the original 2023 request asked to *"display a PDF in a widget
+that allows printing or saving it"*.
+"""
+
+from typing import Optional, Union
+
+import flet as ft
+
+__all__ = ["PdfPreview"]
+
+
+@ft.control("PdfPreview")
+class PdfPreview(ft.LayoutControl):
+    """Display a PDF document with print / share actions.
+
+    Renders the pages of a PDF (scrollable) and, by default, shows an
+    action bar with print and share buttons — no extra wiring needed::
+
+        import flet as ft
+        from flet_printing import PdfPreview
+
+        def main(page: ft.Page):
+            pdf = open("document.pdf", "rb").read()
+            page.add(PdfPreview(src=pdf, expand=True))
+
+        ft.run(main)
+    """
+
+    src: Optional[Union[str, bytes]] = None
+    """
+    The PDF document: raw ``bytes`` or a base64-encoded string.
+    """
+
+    allow_printing: bool = True
+    """
+    Show the print action button.
+    """
+
+    allow_sharing: bool = True
+    """
+    Show the share action button (share sheet on mobile,
+    save dialog on desktop).
+    """
+
+    use_actions: bool = True
+    """
+    Show the action bar at all. Set to ``False`` for a bare preview.
+    """
+
+    can_change_page_format: bool = False
+    """
+    Let the viewer switch page formats. Off by default: the PDF passed
+    in ``src`` is already laid out, so reflowing is usually meaningless.
+    """
+
+    can_change_orientation: bool = False
+    """
+    Let the viewer switch page orientation. Off by default, same
+    reasoning as ``can_change_page_format``.
+    """
+
+    pdf_file_name: Optional[str] = None
+    """
+    Suggested file name when the viewer shares/saves the document.
+    """
+
+    on_printed: Optional[ft.ControlEventHandler["PdfPreview"]] = None
+    """
+    Fires after the document was sent to the printer.
+    """
+
+    on_shared: Optional[ft.ControlEventHandler["PdfPreview"]] = None
+    """
+    Fires after the document was shared/saved.
+    """

flet_printing/printing.py

@@ -0,0 +1,106 @@
+"""Printing service control for Flet — native print dialog via the Flutter
+``printing`` package.
+
+Flet has no built-in printing API (verified against Flet 0.85: nothing
+print/PDF-related is exposed), while Flutter has a mature ``printing``
+package (native print dialog, share sheet, PDF rasterization). This
+extension bridges the two, the same way official extensions like
+``flet-audio`` wrap ``audioplayers``.
+
+Usage::
+
+    import flet as ft
+    from flet_printing import Printing
+
+    def main(page: ft.Page):
+        printing = Printing()
+        page.services.append(printing)
+
+        async def print_click(e):
+            pdf = open("document.pdf", "rb").read()
+            await printing.print_pdf(pdf, name="document")
+
+        page.add(ft.FilledButton("印刷…", on_click=print_click))
+
+    ft.run(main)
+
+Note:
+    Like every third-party Flet extension, this works with apps compiled
+    via ``flet build`` (the prebuilt ``flet run`` client only bundles
+    official extensions).
+"""
+
+from typing import Optional, Union
+
+import flet as ft
+
+__all__ = ["Printing"]
+
+
+@ft.control("Printing")
+class Printing(ft.Service):
+    """Native printing — print dialog and share sheet for PDF documents.
+
+    A non-visual service control. Add it to ``page.services`` and call its
+    async methods. Wraps the Flutter `printing
+    <https://pub.dev/packages/printing>`_ package.
+    """
+
+    async def print_pdf(
+        self,
+        pdf: Union[bytes, str],
+        name: str = "document",
+        timeout: Optional[float] = None,
+    ) -> bool:
+        """Open the platform print dialog for a PDF document.
+
+        The dialog offers printer selection, copies, duplex, page ranges
+        and (on most platforms) "save as PDF" — everything a word
+        processor's File→Print is expected to provide.
+
+        Args:
+            pdf: PDF document bytes (or a base64-encoded string).
+            name: Print job name shown in the printer queue.
+            timeout: Seconds to wait for the dialog to be dismissed.
+                ``None`` waits indefinitely (the method returns after the
+                user prints or cancels).
+
+        Returns:
+            ``True`` if the document was sent to the printer,
+            ``False`` if the user cancelled the dialog.
+        """
+        return await self._invoke_method(
+            "print_pdf",
+            arguments={"pdf": pdf, "name": name},
+            timeout=timeout,
+        )
+
+    async def share_pdf(
+        self,
+        pdf: Union[bytes, str],
+        filename: str = "document.pdf",
+        timeout: Optional[float] = None,
+    ) -> bool:
+        """Open the platform share sheet for a PDF document.
+
+        On desktop this typically shows a save dialog; on mobile the
+        share sheet (mail, files, AirDrop, …).
+
+        Args:
+            pdf: PDF document bytes (or a base64-encoded string).
+            filename: Suggested file name.
+            timeout: Seconds to wait. ``None`` waits indefinitely.
+
+        Returns:
+            ``True`` on success.
+        """
+        return await self._invoke_method(
+            "share_pdf",
+            arguments={"pdf": pdf, "filename": filename},
+            timeout=timeout,
+        )
+
+# print_html は載せない: printingパッケージのconvertHtmlは非推奨
+# (deprecated)になっており、推奨経路は「PDFは自前で生成してprint_pdfへ
+# 渡す」。HTMLの組版が要るならヘッドレスChrome等で確定的なPDFを作る方が
+# 忠実度も高い(このパッケージの出自であるAISeed工房もその方式)。

flet_printing-0.2.0.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: flet-printing
+Version: 0.2.0
+Summary: Native print dialog, share sheet and PDF preview for Flet apps — wraps the Flutter printing package
+Author: aiseed-dev
+Project-URL: Homepage, https://github.com/aiseed-dev/flet-printing
+Project-URL: Documentation, https://github.com/aiseed-dev/flet-printing
+Project-URL: Repository, https://github.com/aiseed-dev/flet-printing
+Project-URL: Issues, https://github.com/aiseed-dev/flet-printing/issues
+Keywords: flet,flutter,printing,print,pdf
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: flet>=0.85.3
+
+# flet-printing
+
+Native print dialog / share sheet for [Flet](https://flet.dev) apps —
+wraps the Flutter [printing](https://pub.dev/packages/printing) package.
+
+Flet has no built-in printing API. Flutter has a mature one. This
+extension bridges the gap, the same way official extensions like
+`flet-audio` wrap `audioplayers`.
+
+The demand is documented:
+[flet-dev/flet#894](https://github.com/flet-dev/flet/issues/894)
+(Jan 2023) asked for exactly this — PDF printing via the `printing`
+package — was closed as "completed" without a shipped solution, and the
+follow-up question *"What's the completed solution for this?"* (Feb
+2024) was never answered. This package is that answer.
+
+日本語補足: Fletには印刷APIがありません（0.85時点・全API確認済み）。
+Flutterの`printing`パッケージ（ネイティブ印刷ダイアログ・共有シート）を
+Flet拡張として包んだものです。ワープロ的なアプリの「ファイル→印刷…」を
+Fletで実装できます。
+
+## Usage
+
+```python
+import flet as ft
+from flet_printing import Printing
+
+def main(page: ft.Page):
+    printing = Printing()
+    page.services.append(printing)
+
+    async def print_click(e):
+        pdf = open("document.pdf", "rb").read()
+        sent = await printing.print_pdf(pdf, name="document")
+        # sent=True: 印刷された / False: ダイアログでキャンセル
+
+    page.add(ft.FilledButton("印刷…", on_click=print_click))
+
+ft.run(main)
+```
+
+API:
+
+- `await printing.print_pdf(pdf, name="document")` — open the platform
+  print dialog (printer selection / copies / duplex / save-as-PDF) for
+  the given PDF bytes. Returns `False` if the user cancelled.
+- `await printing.share_pdf(pdf, filename="document.pdf")` — open the
+  platform share sheet (mobile) / save dialog (desktop).
+
+### PdfPreview — display a PDF with print/share built in
+
+```python
+from flet_printing import PdfPreview
+
+page.add(PdfPreview(src=pdf_bytes, pdf_file_name="document.pdf",
+                    expand=True))
+```
+
+Renders the PDF pages (scrollable) with an action bar: print and share
+buttons work out of the box. Properties: `src` (bytes or base64),
+`allow_printing`, `allow_sharing`, `use_actions`, `pdf_file_name`,
+`on_printed`/`on_shared` events. `can_change_page_format` /
+`can_change_orientation` are off by default (the PDF you pass is
+already laid out).
+
+There is deliberately no HTML-to-PDF here: `printing`'s `convertHtml` is
+deprecated. Generate the PDF yourself (e.g. headless Chrome for exact
+CJK typesetting) and pass the bytes to `print_pdf`.
+
+## Installation
+
+Like every third-party Flet extension, this works with apps compiled via
+`flet build` (the prebuilt `flet run` client only bundles official
+extensions).
+
+Add to your app's `pyproject.toml`:
+
+```toml
+dependencies = [
+  "flet-printing",
+  "flet>=0.85.3",
+]
+```
+
+then `flet build linux` (or `windows` / `macos` / `apk` / `ipa`).
+
+A runnable example lives in `examples/flet_printing_example`
+(build verified on Linux: extension registers, app launches, print
+dialog opens from the button).
+
+## Platform support
+
+Follows the `printing` package: Android / iOS / macOS / Windows / Linux
+(via CUPS) / web. See the
+[printing package docs](https://pub.dev/packages/printing) for details.
+
+## License
+
+MIT

flet_printing-0.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+flet_printing/__init__.py,sha256=fdAULf9wcgVfZidXR9NN0A2h3fCCQA2ZZ2Pz1K9G2oQ,168
+flet_printing/pdf_preview.py,sha256=ex-mYlq7kr2cz34KJBMJXZkzLA2m0lrcl1M7yJwYZ8o,2177
+flet_printing/printing.py,sha256=_3etZoKQuZIbq97mI3nha4KHuPjLCjNx23ZbCfvfGXU,3570
+flutter/flet_printing/pubspec.yaml,sha256=UEzjC51PvRmh6TPrilrB5HI6nz1te0E1YjMOlgJuL0c,358
+flutter/flet_printing/lib/flet_printing.dart,sha256=a9SiWWuIvlxmMupdiG_BY9pMFGgJPWh8D-lzQNtJ6ho,68
+flutter/flet_printing/lib/src/extension.dart,sha256=4CQ6ZbxNTyLiSkwqR3-uIVs9MRsWXqIt91mJeJJazFw,616
+flutter/flet_printing/lib/src/pdf_preview_control.dart,sha256=EZ5vQinBPyZ9jvLwgsOknFWmukDSjo7d1fZFrA6LPI8,1426
+flutter/flet_printing/lib/src/printing_service.dart,sha256=ce8iguOGczDZdtFOT2GHJzuzVtl_zdcdAtXUcqcVhvw,1639
+flet_printing-0.2.0.dist-info/METADATA,sha256=5N_uzjPvMrSwNYVxNZ0jQKHRsmlrAwYUaGxdlRhfbAs,3898
+flet_printing-0.2.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+flet_printing-0.2.0.dist-info/top_level.txt,sha256=daF6i7TsfdlBG6gw82ou32Eod9qMDmdddLizHfvUKEw,22
+flet_printing-0.2.0.dist-info/RECORD,,

flet_printing-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

flet_printing-0.2.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+flet_printing
+flutter

flutter/flet_printing/lib/flet_printing.dart

@@ -0,0 +1,3 @@
+library flet_printing;
+
+export "src/extension.dart" show Extension;

flutter/flet_printing/lib/src/extension.dart

@@ -0,0 +1,27 @@
+import 'package:flet/flet.dart';
+import 'package:flutter/widgets.dart';
+
+import 'pdf_preview_control.dart';
+import 'printing_service.dart';
+
+class Extension extends FletExtension {
+  @override
+  FletService? createService(Control control) {
+    switch (control.type) {
+      case "Printing":
+        return PrintingService(control: control);
+      default:
+        return null;
+    }
+  }
+
+  @override
+  Widget? createWidget(Key? key, Control control) {
+    switch (control.type) {
+      case "PdfPreview":
+        return PdfPreviewControl(key: key, control: control);
+      default:
+        return null;
+    }
+  }
+}

flutter/flet_printing/lib/src/pdf_preview_control.dart

@@ -0,0 +1,39 @@
+import 'package:flet/flet.dart';
+import 'package:flutter/material.dart';
+import 'package:printing/printing.dart';
+
+/// Visual PDF preview with built-in print/share actions
+/// (wraps `printing`'s PdfPreview widget).
+class PdfPreviewControl extends StatelessWidget {
+  final Control control;
+
+  const PdfPreviewControl({super.key, required this.control});
+
+  @override
+  Widget build(BuildContext context) {
+    final resolvedSrc = control.getSrc("src");
+    if (resolvedSrc.error != null) {
+      throw Exception("PdfPreview src decode error: ${resolvedSrc.error}");
+    }
+    final bytes = resolvedSrc.bytes;
+    if (bytes == null) {
+      throw Exception(
+          "PdfPreview must have \"src\" specified as PDF bytes or base64.");
+    }
+
+    final preview = PdfPreview(
+      build: (format) async => bytes,
+      allowPrinting: control.getBool("allow_printing", true)!,
+      allowSharing: control.getBool("allow_sharing", true)!,
+      canChangePageFormat: control.getBool("can_change_page_format", false)!,
+      canChangeOrientation: control.getBool("can_change_orientation", false)!,
+      canDebug: false,
+      useActions: control.getBool("use_actions", true)!,
+      pdfFileName: control.getString("pdf_file_name"),
+      onPrinted: (context) => control.triggerEvent("printed"),
+      onShared: (context) => control.triggerEvent("shared"),
+    );
+
+    return LayoutControl(control: control, child: preview);
+  }
+}

flutter/flet_printing/lib/src/printing_service.dart

@@ -0,0 +1,52 @@
+import 'dart:convert';
+
+import 'package:flet/flet.dart';
+import 'package:flutter/foundation.dart';
+import 'package:printing/printing.dart';
+
+/// Non-visual service wrapping the `printing` package:
+/// native print dialog / share sheet for PDF documents.
+class PrintingService extends FletService {
+  PrintingService({required super.control});
+
+  @override
+  void init() {
+    super.init();
+    debugPrint("Printing(${control.id}).init");
+    control.addInvokeMethodListener(_invokeMethod);
+  }
+
+  /// PDF bytes arrive either as raw binary (msgpack) or base64 string.
+  Uint8List _pdfBytes(dynamic value) {
+    if (value is Uint8List) return value;
+    if (value is List<int>) return Uint8List.fromList(value);
+    if (value is String) return base64Decode(value);
+    throw Exception("printing: unsupported pdf argument type: "
+        "${value.runtimeType}");
+  }
+
+  Future<dynamic> _invokeMethod(String name, dynamic args) async {
+    debugPrint("Printing.$name()");
+    switch (name) {
+      case "print_pdf":
+        final pdf = _pdfBytes(args["pdf"]);
+        return Printing.layoutPdf(
+            onLayout: (format) async => pdf,
+            name: args["name"] as String? ?? "document");
+      case "share_pdf":
+        final pdf = _pdfBytes(args["pdf"]);
+        return Printing.sharePdf(
+            bytes: pdf,
+            filename: args["filename"] as String? ?? "document.pdf");
+      default:
+        throw Exception("Unknown Printing method: $name");
+    }
+  }
+
+  @override
+  void dispose() {
+    debugPrint("Printing(${control.id}).dispose");
+    control.removeInvokeMethodListener(_invokeMethod);
+    super.dispose();
+  }
+}

flutter/flet_printing/pubspec.yaml

@@ -0,0 +1,20 @@
+name: flet_printing
+description: Native print dialog / share sheet for Flet apps (wraps the printing package)
+version: 0.2.0
+publish_to: none
+
+environment:
+  sdk: '>=3.3.0 <4.0.0'
+  flutter: ">=1.17.0"
+
+dependencies:
+  flet: ^0.85.3
+  flutter:
+    sdk: flutter
+
+  printing: ^5.14.0
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+  flutter_lints: ^3.0.0