Renderers – Render HTML, MHTML, EPUB, and SVG in Python

Renderers

The aspose.html.rendering namespace consists of numerous renderer objects and appropriate low-level options classes, which are responsible for rendering documents into IDevice implementation. Aspose.HTML for Python via .NET API provides the following realization of renderers: HtmlRenderer, SvgRenderer, MhtmlRenderer, and EpubRenderer, which are used to render HTML, SVG, MHTML, and EPUB documents, respectively.

The current article describes supported scenarios of HTML-based file conversion to other popular formats using render() methods of the aspose.html.rendering namespace.

HtmlRenderer

The HtmlRenderer class can be used to render HTML files into various popular formats, allowing for customization of rendering options and control over the output of the process. Let’s look at using the HtmlRenderer class to render HTML to PDF with custom output settings:

1. Initialize an HTML document using the HTMLDocument class.
2. Create a new HtmlRenderer object.
3. Create an instance of the PdfRenderingOptions and customize the options for your output PDF document. For example, you can set the any_page property of the PageSetup class to create a new Page object with dimensions of 600 pixels by 200 pixels. Additionally, you can configure the encryption property, specifying user and owner passwords, permitted actions, and the encryption algorithm for the output PDF file.
4. Use PdfDevice(options, savePath) constructor to create an object of the PdfDevice class.
5. Call the render(device, document) method to render HTML to PDF with the specified rendering options.

# Render HTML to PDF with custom page settings using Python

import os
import aspose.html as ah
import aspose.html.rendering as rn
import aspose.html.rendering.pdf as rp
import aspose.html.drawing as dr
import aspose.html.rendering.pdf.encryption as rpe

# Setup input and output directories
data_dir = "data/"
output_dir = "output/"
os.makedirs(output_dir, exist_ok=True)

# Prepare path to the source HTML file
document_path = os.path.join(data_dir, "document.html")

# Initialize an HTML document from the file
doc = ah.HTMLDocument(document_path)

# Create an instance of the HTML Renderer
renderer = rn.HtmlRenderer()

# Prepare path to save the converted PDF
save_path = os.path.join(output_dir, "render-html-with-options.pdf")

# Create PDF rendering options and set custom page size
options = rp.PdfRenderingOptions()
options.page_setup.any_page = dr.Page(dr.Size(600, 200))

# Setup PDF encryption
options.encryption = rpe.PdfEncryptionInfo(
    user_password="user_pwd",
    owner_password="owner_pwd",
    permissions=rpe.PdfPermissions.PRINT_DOCUMENT,
    encryption_algorithm=rpe.PdfEncryptionAlgorithm.RC4_128
)

# Create the PDF device with options and output path
device = rp.PdfDevice(options, save_path)

# Render HTML to PDF
renderer.render(device, doc)

Rendering options give you additional control over the rendering process. To learn more about them, please read the Rendering options article.

To learn more about the rendering process, see the article Rendering Device.

SvgRenderer

The SvgRenderer allows you to render SVG files to other file formats, such as PDF, XPS, DOCX, and image formats. The following example demonstrates how to use SvgRenderer class to render SVG to PNG with a custom page size specifying:

1. Initialize an SVG document. Use one of the SVGDocument() constructors to create an SVGDocument instance.
2. Create a new SvgRenderer object.
3. Create an instance of the ImageRenderingOptions and set custom options for the output PNG image. In the example, we specify the any_page property that sets a new Page object with a page size of 400x300 pixels.
4. Use the ImageDevice(options, savePath) constructor to create an object of the ImageDevice class.
5. Call the render(device, document) method to render SVG to PNG with the specified rendering options.

# Render SVG to PNG with custom page settings using Python

import os
import aspose.html as ah
import aspose.html.rendering.image as ri
import aspose.html.rendering as rn
import aspose.html.drawing as dr

# Setup input and output directories
data_dir = "data/"
output_dir = "output/"
os.makedirs(output_dir, exist_ok=True)

# Prepare path to the source SVG file
doc_path = os.path.join(data_dir, "flower.svg")
save_path = os.path.join(output_dir, "render-svg-with-options.png")

# Initialize an SVG document from the file
doc = ah.dom.svg.SVGDocument(doc_path)

# Create an instance of the SVG Renderer
renderer = rn.SvgRenderer()

# Create the instance of Rendering Options and set a custom page-size
options = ri.ImageRenderingOptions()
options.page_setup.any_page = dr.Page(dr.Size(400, 300))

# Create the PNG device with options and output path
device = ri.ImageDevice(options, save_path)

# Render SVG to PNG
renderer.render(device, doc)

MhtmlRenderer

This example illustrates how to convert an MHTML document to PDF using the MhtmlRenderer class with specified rendering options:

1. Open an existing MHTML document.
2. Create an instance of the MhtmlRenderer class using the MhtmlRenderer() constructor.
3. Initialize the PdfRenderingOptions class and set rendering options.
4. Create an instance of the PdfDevice class.
5. Call the render(device, stream) method to render MHTML to PDF.

# Render MHTML to PDF with custom page settings using Python

import os
import aspose.html.rendering.pdf as rp
import aspose.html.rendering as rn
import aspose.html.drawing as dr
import aspose.pydrawing as pd

# Setup input and output directories
data_dir = "data/"
output_dir = "output/"
os.makedirs(output_dir, exist_ok=True)

# Prepare path to the source MHTML file
epub_path = os.path.join(data_dir, "document.mht")
save_path = os.path.join(output_dir, "render-mhtml-with-options.pdf")

# Open the MHTML file in binary mode
with open("document.mht", 'rb') as stream:

    # Create an instance of MHTML Renderer
    renderer = rn.MhtmlRenderer()

    # Create PDF rendering options and set a custom page size and background color
    options = rp.PdfRenderingOptions()
    options.page_setup.any_page = dr.Page(dr.Size(800, 400))
    options.background_color = pd.Color.bisque

    # Create an instance of PdfDevice for output
    device = rp.PdfDevice(options, save_path)

    # Render MHTML to PDF
    renderer.render(device, stream)

EpubRenderer

The EpubRenderer class allows you to convert EPUB files to other formats such as PDF, XPS, DOCX, and images. The following Python examples shows how to convert EPUB to DOCX with a custom page size setting:

1. Open an existing EPUB file.
2. Create an instance of EpubRenderer class.
3. Initialize the DocRenderingOptions class and set rendering options.
4. Create an instance of the DocDevice class.
5. Call the render(device, stream) method to render EPUB to DOCX.

# Render EPUB to DOCX with custom page settings using Python

import os
import aspose.html.rendering.doc as rd
import aspose.html.rendering as rn
import aspose.html.drawing as dr

# Setup input and output directories
data_dir = "data/"
output_dir = "output/"
os.makedirs(output_dir, exist_ok=True)

# Prepare path to the source EPUB file
epub_path = os.path.join(data_dir, "input.epub")
save_path = os.path.join(output_dir, "render-epub-with-options.docx")

# Open the EPUB file in binary mode
with open(epub_path, "rb") as stream:

    # Create an instance of EPUB Renderer
    renderer = rn.EpubRenderer()

    # Create DOC rendering options and set a custom page size
    options = rd.DocRenderingOptions()
    options.page_setup.any_page = dr.Page(dr.Size(800, 400))

    # Create an instance of DocDevice for output
    device = rd.DocDevice(options, save_path)

    # Render EPUB to DOCX
    renderer.render(device, stream)

Aspose.HTML offers free online Converters that can convert HTML, XHTML, MHTML, EPUB, XML, and Markdown files to a range of popular formats. You can easily convert your HTML-based documents to PDF, XPS, DOCX, JPG, PNG, GIF, TIFF, and others. Just select a file, choose the format to convert, and you’re done.