BCL easyPDF SDK
easyPDF SDK Usermanual
PDF Creator Programming API  |  Download Free Trial  |  Contact Us to Purchase

Native Python PDFConverter API

Usage

The native Python API, which is written in Python 3, is a thin interface around a binary executable. It is very similar to the native .NET API, with the exception of some language-specific differences.

Note: there is no native Python 2 API. That was a very different language than Python 3.

In order to use easyPDF, just import the library by adding import easyPDFConverter. The PDFConverter SDK is inside the easyPDFConverter. namespace. easyPDFConverter.py can be found under C:\Program Files\Common Files\BCL Technologies\easyPDF 8.

When an error occurs, an exception of type PDFConverterException is thrown.

The PDFConverter class has a destructor, which means it is automatically disposed when the object goes out of scope. That makes memory management trivial, just make sure you are not holding on to the variable when you are no longer using the SDK.

If the customer's application crashes, the system automatically closes all pipes belonging to the process, which means all related worker processes automatically quit as well.

The minimal Python sample code looks like this:

import easyPDFConverter
converter = easyPDFConverter.PDFConverter()
try:
   pdf2image = converter.getPDF2Image()
   pdf2image.Convert("c:\\test\\input.pdf", "c:\\test\\output.jpg", "", -1, -1)
except easyPDFConverter.PDFConverterException as ex:
   print(ex)

PDFConverter's constructor is designed to never throw exceptions. That's because it does not launch a worker process and does not create a named pipe, it merely initializes a few variables to their default values. In other words, creating a PDFConverter object is extremely lightweight, like creating a Color object.

However, as soon as you do anything else, it instantly launches a worker process.

Notification Events

Notification events in the native Python API are slightly different than in the native .NET API. Here is an example that catches OnPageStart, which is called before printing each page:

def PageStart(pageNumber, pageCount, fileName):
   print("Page %d of %d..." % (pageNumber + 1, pageCount))
   return easyPDFConverter.cnvMonitorResponse.CNV_MON_CONTINUE_CONVERSION

converter = easyPDFConverter.PDFConverter()
try:
   monitor = converter.getPDFConverterMonitor()
   monitor.OnPageStart = PageStart
   pdf2image = converter.getPDF2Image()
   pdf2image.Convert("c:\\test\\input.pdf", "c:\\test\\output.jpg", "", -1, -1)
except easyPDFConverter.PDFConverterException as ex:
   print(ex)

Alternatively, the event handler can be a class method:

class Handler:
   def PageStart(self, pageNumber, pageCount, fileName):
      print("Page %d of %d..." % (pageNumber + 1, pageCount))
      return easyPDFConverter.cnvMonitorResponse.CNV_MON_CONTINUE_CONVERSION

converter = easyPDFConverter.PDFConverter()
handler = Handler()
try:
   monitor = converter.getPDFConverterMonitor()
   monitor.OnPageStart = handler.PageStart
   pdf2image = converter.getPDF2Image()
   pdf2image.Convert("c:\\test\\input.pdf", "c:\\test\\output.jpg", "", -1, -1)
except easyPDFConverter.PDFConverterException as ex:
   print(ex)

Launch Timeout

Launching the worker process and connecting the named pipe should happen very fast, in milliseconds. However, under an abnormally heavy load, the computer may not have enough cycles to perform this task in a timely fashion.

The Native Python API has an internal timeout built-in. The default value is 1 minute. This is because a server may momentarily slow down so much that it is not responding for seconds, but it usually recovers after a while.

The default timeout value can be changed via PDFConverter's launchTimeout member (in milliseconds). This must be performed immediately after the creation of the PDFConverter object.

converter = easyPDFConverter.PDFConverter()
try:
   converter.launchTimeout = 60000
   pdf2image = converter.getPDF2Image()
   pdf2image.Convert("c:\\test\\input.pdf", "c:\\test\\output.jpg", "", -1, -1)
except easyPDFConverter.PDFConverterException as ex:
   print(ex)

Upon timeout an exception is thrown, and the SDK cannot be used. Another attempt may be made later.