pd4ml 1.0.0__py3-none-any.whl

pd4ml/__init__.py

@@ -0,0 +1,109 @@
+"""PD4ML for Python: HTML to PDF, PDF/A, DOCX, RTF and image conversion.
+
+The public PD4ML API (package ``com.pd4ml``) runs in a Java virtual machine inside this
+process (JPype). The JVM starts on first use with the PD4ML build from ``PD4ML_CLASSPATH`` /
+``PD4ML_CLASSPATH_FILE``, else the one :func:`install` downloaded (with none, the first use
+downloads the most recent PD4ML release); or call :func:`start` first::
+
+    import pd4ml
+
+    pd = pd4ml.PD4ML()                      # the v42 layout engine
+    pd.setPageSize(pd4ml.PageSize.A4)
+    pd.readHTML("https://pd4ml.com")
+    pdf = pd.writePDF()                     # bytes
+
+The Java classes are available under their own names (``PageSize``, ``PageMargins``,
+``PdfSpec``, ``Constants`` and its ``LayoutEngine``/``ErrorPolicy`` enums...); :class:`PD4ML`
+wraps ``com.pd4ml.PD4ML`` and adds Python I/O. Java exceptions are raised as Python
+exceptions and can be caught as the exported exception classes (``InvokeException``...).
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ._api import (
+    DEFAULT_ENGINE,
+    PD4ML,
+    has_layout_engines,
+    html_to_pdf,
+    merge_pdfs,
+    open_pdf,
+    pdf_spec,
+    progress_listener,
+    to_input_stream,
+    to_url,
+    write_pdf,
+)
+from ._jvm import ClasspathError, configured_classpath, is_started, java_class, start
+from ._install import InstallError, install, installed_classpath, installed_jar, installed_version
+
+__version__ = "4.2.0.dev0"
+
+#: Java classes of the public API, loaded on first access (which starts the JVM).
+_JAVA_CLASSES = {
+    "JPD4ML": "com.pd4ml.PD4ML",
+    "Constants": "com.pd4ml.Constants",
+    "LayoutEngine": "com.pd4ml.Constants$LayoutEngine",
+    "ErrorPolicy": "com.pd4ml.Constants$ErrorPolicy",
+    "PageSize": "com.pd4ml.PageSize",
+    "PageMargins": "com.pd4ml.PageMargins",
+    "Dimensions": "com.pd4ml.Dimensions",
+    "Units": "com.pd4ml.Dimensions$Units",
+    "PdfDocument": "com.pd4ml.PdfDocument",
+    "PdfSpec": "com.pd4ml.PdfSpec",
+    "PdfSpecViolationException": "com.pd4ml.PdfSpec$PdfSpecViolationException",
+    "PdfSpecUnsupportedException": "com.pd4ml.PdfSpec$PdfSpecUnsupportedException",
+    "ProgressListener": "com.pd4ml.ProgressListener",
+    "ResourceProvider": "com.pd4ml.ResourceProvider",
+    "CustomTag": "com.pd4ml.CustomTag",
+    "StatusMessage": "com.pd4ml.StatusMessage",
+    "ConflictingParametersException": "com.pd4ml.ConflictingParametersException",
+    "ForcedTerminationException": "com.pd4ml.ForcedTerminationException",
+    "InvalidPasswordException": "com.pd4ml.InvalidPasswordException",
+    "InvokeException": "com.pd4ml.InvokeException",
+}
+
+__all__ = [
+    "PD4ML",
+    "DEFAULT_ENGINE",
+    "start",
+    "is_started",
+    "configured_classpath",
+    "java_class",
+    "ClasspathError",
+    "install",
+    "installed_jar",
+    "installed_classpath",
+    "installed_version",
+    "InstallError",
+    "has_layout_engines",
+    "html_to_pdf",
+    "open_pdf",
+    "write_pdf",
+    "merge_pdfs",
+    "pdf_spec",
+    "progress_listener",
+    "to_input_stream",
+    "to_url",
+    "version",
+    *_JAVA_CLASSES,
+]
+
+
+def __getattr__(name: str) -> Any:
+    qualified = _JAVA_CLASSES.get(name)
+    if qualified is None:
+        raise AttributeError(f"module 'pd4ml' has no attribute {name!r}")
+    cls = java_class(qualified)
+    globals()[name] = cls
+    return cls
+
+
+def __dir__():
+    return sorted(set(globals()) | set(_JAVA_CLASSES))
+
+
+def version() -> str:
+    """The PD4ML (Java) version."""
+    return str(java_class("com.pd4ml.PD4ML").getVersion())