# Copyright (C) 2009-2018 pdfcrowd.com
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
try:
from urllib import urlencode
PYTHON_3 = False
except ImportError:
from urllib.parse import urlencode
PYTHON_3 = True
try:
import httplib
except:
import http.client as httplib
import mimetypes
import socket
import base64
import re
import argparse
import sys
import os
import ssl
import time
__version__ = '5.18.1'
# ======================================
# === PDFCrowd legacy version client ===
# ======================================
if PYTHON_3:
# constants for Client.setPageLayout()
SINGLE_PAGE, CONTINUOUS, CONTINUOUS_FACING = range(1, 4)
# constants for Client.setPageMode()
NONE_VISIBLE, THUMBNAILS_VISIBLE, FULLSCREEN = range(1, 4)
# constants for setInitialPdfZoomType()
FIT_WIDTH, FIT_HEIGHT, FIT_PAGE = range(1, 4)
class Error(Exception):
"""Thrown when an error occurs."""
def __init__(self, error, http_code=None):
self.http_code = http_code
self.error = error if isinstance(error, str) else str(error, "utf-8")
def __str__(self):
if self.http_code:
return "%d - %s" % (self.http_code, self.error)
else:
return self.error
def getCode(self):
return self.http_code
def getMessage(self):
return self.error
class Client:
"""Pdfcrowd API client."""
def __init__(self, username, apikey, host=None, http_port=None):
"""Client constructor.
username -- your username at Pdfcrowd
apikey -- your API key
host -- API host, defaults to pdfcrowd.com
"""
self.fields = dict(username=username, key=apikey,
pdf_scaling_factor=1, html_zoom=200)
self.host = host or HOST_LEGACY
self.http_port = http_port or HTTP_PORT
self.useSSL(False)
self.setProxy(None, None)
def setProxy(self, host, port, username=None, password=None):
self.proxy_host = host
self.proxy_port = port
self.proxy_username = username
self.proxy_password = password
def convertURI(self, uri, outstream=None):
"""Converts a web page.
uri -- a web page URL
outstream -- an object having method 'write(data)' - e.g. file,
StringIO, etc.; if None then the return value is a string
containing the PDF.
"""
body = urlencode(self._prepare_fields(dict(src=uri)))
content_type = 'application/x-www-form-urlencoded'
return self._post(body, content_type, 'pdf/convert/uri/', outstream)
def convertHtml(self, html, outstream=None):
"""Converts an in-memory html document.
html -- a string containing an html document
outstream -- an object having method 'write(data)' - e.g. file,
StringIO, etc.; if None then the return value is a string
containing the PDF.
"""
if not isinstance(html, str):
html = html.encode('utf-8')
body = urlencode(self._prepare_fields(dict(src=html)))
content_type = 'application/x-www-form-urlencoded'
return self._post(body, content_type, 'pdf/convert/html/', outstream)
def convertFile(self, fpath, outstream=None):
"""Converts an html file.
fpath -- a path to an html file
outstream -- an object having method 'write(data)' - e.g. file,
StringIO, etc.; if None then the return value is a string
containing the PDF.
"""
body, content_type = self._encode_multipart_post_data(fpath)
return self._post(body, content_type, 'pdf/convert/html/', outstream)
def numTokens(self):
"""Returns the number of available conversion tokens."""
body = urlencode(self._prepare_fields())
content_type = 'application/x-www-form-urlencoded'
return int(self._post(body, content_type, 'user/%s/tokens/' % self.fields['username']))
def useSSL(self, use_ssl):
if use_ssl:
self.port = HTTPS_PORT
scheme = 'https'
self.conn_type = httplib.HTTPSConnection
else:
self.port = self.http_port
scheme = 'http'
self.conn_type = httplib.HTTPConnection
self.api_uri = '%s://%s:%d%s' % (scheme, self.host, self.port, API_SELECTOR_BASE)
def setUsername(self, username):
self.fields['username'] = username
def setApiKey(self, key):
self.fields['key'] = key
def setPageWidth(self, value):
self.fields['width'] = value
def setPageHeight(self, value):
self.fields['height'] = value
def setHorizontalMargin(self, value):
self.fields['margin_right'] = self.fields['margin_left'] = str(value)
def setVerticalMargin(self, value):
self.fields['margin_top'] = self.fields['margin_bottom'] = str(value)
def setPageMargins(self, top, right, bottom, left):
self.fields['margin_top'] = str(top)
self.fields['margin_right'] = str(right)
self.fields['margin_bottom'] = str(bottom)
self.fields['margin_left'] = str(left)
def setEncrypted(self, val=True):
self.fields['encrypted'] = val
def setUserPassword(self, pwd):
self.fields['user_pwd'] = pwd
def setOwnerPassword(self, pwd):
self.fields['owner_pwd'] = pwd
def setNoPrint(self, val=True):
self.fields['no_print'] = val
def setNoModify(self, val=True):
self.fields['no_modify'] = val
def setNoCopy(self, val=True):
self.fields['no_copy'] = val
def setPageLayout(self, value):
assert value > 0 and value <= 3
self.fields['page_layout'] = value
def setPageMode(self, value):
assert value > 0 and value <= 3
self.fields['page_mode'] = value
def setFooterText(self, value):
self.fields['footer_text'] = value
def enableImages(self, value=True):
self.fields['no_images'] = not value
def enableBackgrounds(self, value=True):
self.fields['no_backgrounds'] = not value
def setHtmlZoom(self, value):
self.fields['html_zoom'] = value
def enableJavaScript(self, value=True):
self.fields['no_javascript'] = not value
def enableHyperlinks(self, value=True):
self.fields['no_hyperlinks'] = not value
def setDefaultTextEncoding(self, value):
self.fields['text_encoding'] = value
def usePrintMedia(self, value=True):
self.fields['use_print_media'] = value
def setMaxPages(self, value):
self.fields['max_pages'] = value
def enablePdfcrowdLogo(self, value=True):
self.fields['pdfcrowd_logo'] = value
def setInitialPdfZoomType(self, value):
assert value>0 and value<=3
self.fields['initial_pdf_zoom_type'] = value
def setInitialPdfExactZoom(self, value):
self.fields['initial_pdf_zoom_type'] = 4
self.fields['initial_pdf_zoom'] = value
def setAuthor(self, value):
self.fields['author'] = value
def setFailOnNon200(self, value):
self.fields['fail_on_non200'] = value
def setPdfScalingFactor(self, value):
self.fields['pdf_scaling_factor'] = value
def setFooterHtml(self, value):
self.fields['footer_html'] = value
def setFooterUrl(self, value):
self.fields['footer_url'] = value
def setHeaderHtml(self, value):
self.fields['header_html'] = value
def setHeaderUrl(self, value):
self.fields['header_url'] = value
def setPageBackgroundColor(self, value):
self.fields['page_background_color'] = value
def setTransparentBackground(self, value=True):
self.fields['transparent_background'] = value
def setPageNumberingOffset(self, value):
self.fields['page_numbering_offset'] = value
def setHeaderFooterPageExcludeList(self, value):
self.fields['header_footer_page_exclude_list'] = value
def setWatermark(self, url, offset_x=0, offset_y=0):
self.fields["watermark_url"] = url
self.fields["watermark_offset_x"] = offset_x
self.fields["watermark_offset_y"] = offset_y
def setWatermarkRotation(self, angle):
self.fields["watermark_rotation"] = angle
def setWatermarkInBackground(self, val=True):
self.fields["watermark_in_background"] = val
# ----------------------------------------------------------------------
#
# Private stuff
#
def _prepare_fields(self, extra_data={}):
result = extra_data.copy()
for key, val in iter(self.fields.items()):
if val:
if type(val) == float:
val = str(val).replace(',', '.')
result[key] = val
return result
def _encode_multipart_post_data(self, filename):
boundary = '----------ThIs_Is_tHe_bOUnDary_$'
head, tail = [], []
for field, value in iter(self._prepare_fields().items()):
head.append('--' + boundary)
head.append('Content-Disposition: form-data; name="%s"' % field)
head.append('')
head.append(str(value))
# filename
head.append('--' + boundary)
head.append('Content-Disposition: form-data; name="src"; filename="%s"' % filename)
mime_type = mimetypes.guess_type(filename)[0] or 'application/octet-stream'
head.append('Content-Type: ' + mime_type)
head.append('')
content = open(filename, 'rb').read()
# finalize
tail.append('--' + boundary + '--')
tail.append('')
body = ["\r\n".join(head).encode("utf-8"), content, "\r\n".join(tail).encode("utf-8")]
body = b"\r\n".join(body)
content_type = 'multipart/form-data; boundary=%s' % boundary
return body, content_type
# sends a POST to the API
def _post(self, body, content_type, api_path, outstream=None):
try:
if self.proxy_host:
if self.conn_type == httplib.HTTPSConnection:
raise Error("HTTPS over a proxy is not supported.")
conn = self.conn_type(self.proxy_host, self.proxy_port)
conn.putrequest('POST', "http://%s:%d%s" % (self.host, self.port, API_SELECTOR_BASE + api_path))
if self.proxy_username:
user_string = "%s:%s" % (self.proxy_username, self.proxy_password)
proxy_auth = "Basic " + base64.b64encode(user_string)
conn.putheader('Proxy-Authorization', proxy_auth)
else:
conn = self.conn_type(self.host, self.port)
conn.putrequest('POST', API_SELECTOR_BASE + api_path)
conn.putheader('content-type', content_type)
body = body if isinstance(body, bytes) else body.encode()
conn.putheader('content-length', str(len(body)))
conn.endheaders()
conn.send(body)
response = conn.getresponse()
if response.status != 200:
raise Error(response.read(), response.status)
if outstream:
while True:
data = response.read(16384)
if data:
outstream.write(data)
else:
break
return outstream
else:
return response.read()
except httplib.HTTPException as err:
raise Error(str(err))
except socket.gaierror as err:
raise Error(str(err))
API_SELECTOR_BASE = '/api/'
HOST_LEGACY = os.environ.get('PDFCROWD_HOST', 'pdfcrowd.com')
HTTP_PORT = 80
HTTPS_PORT = 443
else:
# constants for Client.setPageLayout()
SINGLE_PAGE, CONTINUOUS, CONTINUOUS_FACING = range(1,4)
# constants for Client.setPageMode()
NONE_VISIBLE, THUMBNAILS_VISIBLE, FULLSCREEN = range(1,4)
# constants for setInitialPdfZoomType()
FIT_WIDTH, FIT_HEIGHT, FIT_PAGE = range(1, 4)
class Error(Exception):
"""Thrown when an error occurs."""
def __init__(self, error, http_code=None):
self.http_code = http_code
self.error = error
def __str__(self):
if self.http_code:
return "%d - %s" % (self.http_code, self.error)
else:
return self.error
def getCode(self):
return self.http_code
def getMessage(self):
return self.error
class Client:
"""Pdfcrowd API client."""
def __init__(self, username, apikey, host=None, http_port=None):
"""Client constructor.
username -- your username at Pdfcrowd
apikey -- your API key
host -- API host, defaults to pdfcrowd.com
"""
self.fields = dict(username=username, key=apikey, \
pdf_scaling_factor=1, html_zoom=200)
self.host = host or HOST_LEGACY
self.http_port = http_port or HTTP_PORT
self.useSSL(False)
self.setProxy(None, None)
def setProxy(self, host, port, username=None, password=None):
self.proxy_host = host
self.proxy_port = port
self.proxy_username = username
self.proxy_password = password
def convertURI(self, uri, outstream=None):
"""Converts a web page.
uri -- a web page URL
outstream -- an object having method 'write(data)' - e.g. file,
StringIO, etc.; if None then the return value is a string
containing the PDF.
"""
body = urlencode(self._prepare_fields(dict(src=uri)))
content_type = 'application/x-www-form-urlencoded'
return self._post(body, content_type, 'pdf/convert/uri/', outstream)
def convertHtml(self, html, outstream=None):
"""Converts an in-memory html document.
html -- a string containing an html document
outstream -- an object having method 'write(data)' - e.g. file,
StringIO, etc.; if None then the return value is a string
containing the PDF.
"""
if isinstance(html, unicode):
html = html.encode('utf-8')
body = urlencode(self._prepare_fields(dict(src=html)))
content_type = 'application/x-www-form-urlencoded'
return self._post(body, content_type, 'pdf/convert/html/', outstream)
def convertFile(self, fpath, outstream=None):
"""Converts an html file.
fpath -- a path to an html file
outstream -- an object having method 'write(data)' - e.g. file,
StringIO, etc.; if None then the return value is a string
containing the PDF.
"""
body, content_type = self._encode_multipart_post_data(fpath)
return self._post(body, content_type, 'pdf/convert/html/', outstream)
def numTokens(self):
"""Returns the number of available conversion tokens."""
body = urlencode(self._prepare_fields())
content_type = 'application/x-www-form-urlencoded'
return int(self._post(body, content_type, 'user/%s/tokens/' % self.fields['username']))
def useSSL(self, use_ssl):
if use_ssl:
self.port = HTTPS_PORT
scheme = 'https'
self.conn_type = httplib.HTTPSConnection
else:
self.port = self.http_port
scheme = 'http'
self.conn_type = httplib.HTTPConnection
self.api_uri = '%s://%s:%d%s' % (scheme, self.host, self.port, API_SELECTOR_BASE)
def setUsername(self, username):
self.fields['username'] = username
def setApiKey(self, key):
self.fields['key'] = key
def setPageWidth(self, value):
self.fields['width'] = value
def setPageHeight(self, value):
self.fields['height'] = value
def setHorizontalMargin(self, value):
self.fields['margin_right'] = self.fields['margin_left'] = str(value)
def setVerticalMargin(self, value):
self.fields['margin_top'] = self.fields['margin_bottom'] = str(value)
def setPageMargins(self, top, right, bottom, left):
self.fields['margin_top'] = str(top)
self.fields['margin_right'] = str(right)
self.fields['margin_bottom'] = str(bottom)
self.fields['margin_left'] = str(left)
def setEncrypted(self, val=True):
self.fields['encrypted'] = val
def setUserPassword(self, pwd):
self.fields['user_pwd'] = pwd
def setOwnerPassword(self, pwd):
self.fields['owner_pwd'] = pwd
def setNoPrint(self, val=True):
self.fields['no_print'] = val
def setNoModify(self, val=True):
self.fields['no_modify'] = val
def setNoCopy(self, val=True):
self.fields['no_copy'] = val
def setPageLayout(self, value):
assert value > 0 and value <= 3
self.fields['page_layout'] = value
def setPageMode(self, value):
assert value > 0 and value <= 3
self.fields['page_mode'] = value
def setFooterText(self, value):
self.fields['footer_text'] = value
def enableImages(self, value=True):
self.fields['no_images'] = not value
def enableBackgrounds(self, value=True):
self.fields['no_backgrounds'] = not value
def setHtmlZoom(self, value):
self.fields['html_zoom'] = value
def enableJavaScript(self, value=True):
self.fields['no_javascript'] = not value
def enableHyperlinks(self, value=True):
self.fields['no_hyperlinks'] = not value
def setDefaultTextEncoding(self, value):
self.fields['text_encoding'] = value
def usePrintMedia(self, value=True):
self.fields['use_print_media'] = value
def setMaxPages(self, value):
self.fields['max_pages'] = value
def enablePdfcrowdLogo(self, value=True):
self.fields['pdfcrowd_logo'] = value
def setInitialPdfZoomType(self, value):
assert value>0 and value<=3
self.fields['initial_pdf_zoom_type'] = value
def setInitialPdfExactZoom(self, value):
self.fields['initial_pdf_zoom_type'] = 4
self.fields['initial_pdf_zoom'] = value
def setAuthor(self, value):
self.fields['author'] = value
def setFailOnNon200(self, value):
self.fields['fail_on_non200'] = value
def setPdfScalingFactor(self, value):
self.fields['pdf_scaling_factor'] = value
def setFooterHtml(self, value):
self.fields['footer_html'] = value
def setFooterUrl(self, value):
self.fields['footer_url'] = value
def setHeaderHtml(self, value):
self.fields['header_html'] = value
def setHeaderUrl(self, value):
self.fields['header_url'] = value
def setPageBackgroundColor(self, value):
self.fields['page_background_color'] = value
def setTransparentBackground(self, value=True):
self.fields['transparent_background'] = value
def setPageNumberingOffset(self, value):
self.fields['page_numbering_offset'] = value
def setHeaderFooterPageExcludeList(self, value):
self.fields['header_footer_page_exclude_list'] = value
def setWatermark(self, url, offset_x=0, offset_y=0):
self.fields["watermark_url"] = url
self.fields["watermark_offset_x"] = offset_x
self.fields["watermark_offset_y"] = offset_y
def setWatermarkRotation(self, angle):
self.fields["watermark_rotation"] = angle
def setWatermarkInBackground(self, val=True):
self.fields["watermark_in_background"] = val
# ----------------------------------------------------------------------
#
# Private stuff
#
def _prepare_fields(self, extra_data={}):
result = extra_data.copy()
for key, val in self.fields.iteritems():
if val:
if type(val) == float:
val = str(val).replace(',', '.')
result[key] = val
return result
def _encode_multipart_post_data(self, filename):
boundary = '----------ThIs_Is_tHe_bOUnDary_$'
body = []
for field, value in self._prepare_fields().iteritems():
body.append('--' + boundary)
body.append('Content-Disposition: form-data; name="%s"' % field)
body.append('')
body.append(str(value))
# filename
body.append('--' + boundary)
body.append('Content-Disposition: form-data; name="src"; filename="%s"' % filename)
mime_type = mimetypes.guess_type(filename)[0] or 'application/octet-stream'
body.append('Content-Type: ' + str(mime_type))
body.append('')
body.append(open(filename, 'rb').read())
# finalize
body.append('--' + boundary + '--')
body.append('')
body = '\r\n'.join(body)
content_type = 'multipart/form-data; boundary=%s' % boundary
return body, content_type
# sends a POST to the API
def _post(self, body, content_type, api_path, outstream=None):
try:
if self.proxy_host:
if self.conn_type == httplib.HTTPSConnection:
raise Error("HTTPS over a proxy is not supported.")
conn = self.conn_type(self.proxy_host, self.proxy_port)
conn.putrequest('POST', "http://%s:%d%s" % (self.host, self.port, API_SELECTOR_BASE + api_path))
if self.proxy_username:
user_string = "%s:%s" % (self.proxy_username, self.proxy_password)
proxy_auth = "Basic " + base64.b64encode(user_string)
conn.putheader('Proxy-Authorization', proxy_auth)
else:
conn = self.conn_type(self.host, self.port)
conn.putrequest('POST', API_SELECTOR_BASE + api_path)
conn.putheader('content-type', content_type)
conn.putheader('content-length', str(len(body)))
conn.endheaders()
conn.send(body)
response = conn.getresponse()
if response.status != 200:
raise Error(response.read(), response.status)
if outstream:
while True:
data = response.read(16384)
if data:
outstream.write(data)
else:
break
return outstream
else:
return response.read()
except httplib.HTTPException as err:
raise Error(str(err))
except socket.gaierror as err:
raise Error(str(err))
API_SELECTOR_BASE = '/api/'
HOST_LEGACY = os.environ.get('PDFCROWD_HOST', 'pdfcrowd.com')
HTTP_PORT = 80
HTTPS_PORT = 443
# =====================================
# === PDFCrowd cloud version client ===
# =====================================
HOST = os.environ.get('PDFCROWD_HOST', 'api.pdfcrowd.com')
MULTIPART_BOUNDARY = '----------ThIs_Is_tHe_bOUnDary_$'
CLIENT_VERSION = '5.18.1'
def get_utf8_string(string):
if PYTHON_3:
# get Python3 string
try:
return string.decode()
except AttributeError:
pass
else:
# get Python2 string
if isinstance(string, unicode):
return string.encode('utf-8')
return string
def create_invalid_value_message(value, field, converter, hint, id):
message = "Invalid value '%s' for %s." % (value, field)
if hint:
message += " " + hint
return message + ' ' + "Details: https://www.pdfcrowd.com/api/%s-python/ref/#%s" % (converter, id)
def iter_items(dictionary):
if PYTHON_3:
return dictionary.items()
return dictionary.iteritems()
def gen_fields(fields):
for key, val in iter_items(fields):
if val:
yield key, str(val)
def add_file_field(name, file_name, data, body, mime_type = None):
# file field
head = []
head.append('--' + MULTIPART_BOUNDARY)
head.append('Content-Disposition: form-data; name="{}"; filename="{}"'.format(name, file_name))
if not mime_type:
mime_type = 'application/octet-stream'
head.append('Content-Type: {}'.format(mime_type))
head.append('')
if PYTHON_3:
body.append('\r\n'.join(head).encode('utf-8'))
else:
body.append('\r\n'.join(head))
body.append(data)
def encode_multipart_post_data(fields, files, raw_data):
head, tail = [], []
body = []
for field, value in gen_fields(fields):
head.append('--' + MULTIPART_BOUNDARY)
head.append('Content-Disposition: form-data; name="%s"' % field)
head.append('')
head.append(value)
if PYTHON_3:
body.append('\r\n'.join(head).encode('utf-8'))
else:
body.append('\r\n'.join(head))
for name, file_name in iter_items(files):
with open(file_name, 'rb') as f:
add_file_field(name, file_name, f.read(), body, mimetypes.guess_type(file_name)[0])
for name, data in iter_items(raw_data):
add_file_field(name, name, data, body)
# finalize
tail.append('--' + MULTIPART_BOUNDARY + '--')
tail.append('')
body.append('\r\n'.join(tail).encode('utf-8'))
return b'\r\n'.join(body)
def base64_encode(value):
if not isinstance(value, bytes):
value = value.encode()
value = base64.b64encode(value)
if PYTHON_3:
return value.decode()
return value
def encode_credentials(user_name, password):
auth = '%s:%s' % (user_name, password)
return 'Basic ' + base64_encode(auth)
class ConnectionHelper:
def __init__(self, user_name, api_key):
self.user_name = user_name
self.api_key = api_key
self._reset_response_data()
self.setProxy(None, None, None, None)
self.setUseHttp(False)
self.setUserAgent('pdfcrowd_python_client/5.18.1 (https://pdfcrowd.com)')
self.retry_count = 1
self.converter_version = '20.10'
def _reset_response_data(self):
self.debug_log_url = None
self.credits = 999999
self.consumed_credits = 0
self.job_id = ''
self.page_count = 0
self.total_page_count = 0
self.output_size = 0
self.retry = 0
def post(self, fields, files, raw_data, out_stream = None):
body = encode_multipart_post_data(fields, files, raw_data)
content_type = 'multipart/form-data; boundary=' + MULTIPART_BOUNDARY
return self._do_post(body, content_type, out_stream)
def _create_connection(self, host, port):
kwargs = {}
if not self.use_http and host != 'api.pdfcrowd.com':
kwargs['context'] = ssl._create_unverified_context()
return self.conn_type(host, port, **kwargs)
def _get_connection(self):
conv_selector = '/convert/{}/'.format(self.converter_version)
if self.proxy_host:
conn = self._create_connection(self.proxy_host, self.proxy_port)
conn.putrequest('POST', 'http://{}:{}{}'.format(
HOST, self.port, conv_selector))
if self.proxy_user_name:
conn.putheader('Proxy-Authorization',
encode_credentials(self.proxy_user_name,
self.proxy_password))
else:
conn = self._create_connection(HOST, self.port)
conn.putrequest('POST', conv_selector)
return conn
# sends a POST to the API
def _do_post(self, body, content_type, out_stream=None):
if not self.use_http and self.proxy_host:
raise Error('HTTPS over a proxy is not supported.')
self._reset_response_data()
while True:
try:
return self._exec_request(body, content_type, out_stream)
except Error as err:
if (err.getCode() == 502 or err.getCode() == 503) and self.retry_count > self.retry:
self.retry += 1
time.sleep(self.retry * 0.1)
else:
raise
def _exec_request(self, body, content_type, out_stream):
try:
conn = self._get_connection()
conn.putheader('Content-Type', content_type)
conn.putheader('Content-Length', str(len(body)))
if self.user_agent != None:
conn.putheader('User-Agent', self.user_agent)
conn.putheader('Authorization',
encode_credentials(self.user_name, self.api_key))
conn.endheaders()
body = body if isinstance(body, bytes) else body.encode()
conn.send(body)
response = conn.getresponse()
self.debug_log_url = response.getheader('X-Pdfcrowd-Debug-Log', '')
self.credits = int(response.getheader('X-Pdfcrowd-Remaining-Credits', 999999))
self.consumed_credits = int(response.getheader('X-Pdfcrowd-Consumed-Credits', 0))
self.job_id = response.getheader('X-Pdfcrowd-Job-Id', '')
self.page_count = int(response.getheader('X-Pdfcrowd-Pages', 0))
self.total_page_count = int(response.getheader('X-Pdfcrowd-Total-Pages', 0))
self.output_size = int(response.getheader('X-Pdfcrowd-Output-Size', 0))
if response.status > 299:
raise Error(response.read(), response.status)
if out_stream:
while True:
data = response.read(16384)
if data:
out_stream.write(data)
else:
break
return out_stream
return response.read()
except httplib.HTTPException as err:
raise Error(str(err))
except ssl.SSLError as err:
raise Error("There was a problem connecting to Pdfcrowd servers over HTTPS:\n" +
"{} ({})".format(err.reason, err.errno) +
"\nYou can still use the API over HTTP, you just need to add the following line right after Pdfcrowd client initialization:\nclient.setUseHttp(True)",
481)
except socket.gaierror as err:
raise Error(str(err))
except socket.error as err:
raise Error(str(err))
def setUseHttp(self, use_http):
if use_http:
self.port = 80
self.conn_type = httplib.HTTPConnection
else:
self.port = 443
self.conn_type = httplib.HTTPSConnection
self.use_http = use_http
def setUserAgent(self, user_agent):
self.user_agent = user_agent
def setRetryCount(self, retry_count):
self.retry_count = retry_count
def setConverterVersion(self, converter_version):
self.converter_version = converter_version
def setProxy(self, host, port, user_name, password):
self.proxy_host = host
self.proxy_port = port
self.proxy_user_name = user_name
self.proxy_password = password
def getDebugLogUrl(self):
return self.debug_log_url
def getRemainingCreditCount(self):
return self.credits
def getConsumedCreditCount(self):
return self.consumed_credits
def getJobId(self):
return self.job_id
def getPageCount(self):
return self.page_count
def getTotalPageCount(self):
return self.total_page_count
def getOutputSize(self):
return self.output_size
def getConverterVersion(self):
return self.converter_version
# generated code
class HtmlToPdfClient:
"""
Conversion from HTML to PDF.
"""
def __init__(self, user_name, api_key):
"""
Constructor for the Pdfcrowd API client.
user_name - Your username at Pdfcrowd.
api_key - Your API key.
"""
self.helper = ConnectionHelper(user_name, api_key)
self.fields = {
'input_format': 'html',
'output_format': 'pdf'
}
self.file_id = 1
self.files = {}
self.raw_data = {}
def convertUrl(self, url):
"""
Convert a web page.
url - The address of the web page to convert. The supported protocols are http:// and https://.
return - Byte array containing the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrl", "html-to-pdf", 'The supported protocols are http:// and https://.', "convert_url"), 470);
self.fields['url'] = get_utf8_string(url)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertUrlToStream(self, url, out_stream):
"""
Convert a web page and write the result to an output stream.
url - The address of the web page to convert. The supported protocols are http:// and https://.
out_stream - The output stream that will contain the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrlToStream::url", "html-to-pdf", 'The supported protocols are http:// and https://.', "convert_url_to_stream"), 470);
self.fields['url'] = get_utf8_string(url)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertUrlToFile(self, url, file_path):
"""
Convert a web page and write the result to a local file.
url - The address of the web page to convert. The supported protocols are http:// and https://.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertUrlToFile::file_path", "html-to-pdf", 'The string must not be empty.', "convert_url_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertUrlToStream(url, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertFile(self, file):
"""
Convert a local file.
file - The path to a local file to convert. The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip). If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.
return - Byte array containing the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFile", "html-to-pdf", 'The file must exist and not be empty.', "convert_file"), 470);
self.files['file'] = get_utf8_string(file)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertFileToStream(self, file, out_stream):
"""
Convert a local file and write the result to an output stream.
file - The path to a local file to convert. The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip). If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.
out_stream - The output stream that will contain the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFileToStream::file", "html-to-pdf", 'The file must exist and not be empty.', "convert_file_to_stream"), 470);
self.files['file'] = get_utf8_string(file)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertFileToFile(self, file, file_path):
"""
Convert a local file and write the result to a local file.
file - The path to a local file to convert. The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip). If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertFileToFile::file_path", "html-to-pdf", 'The string must not be empty.', "convert_file_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertFileToStream(file, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertString(self, text):
"""
Convert a string.
text - The string content to convert. The string must not be empty.
return - Byte array containing the conversion output.
"""
if not (text):
raise Error(create_invalid_value_message(text, "convertString", "html-to-pdf", 'The string must not be empty.', "convert_string"), 470);
self.fields['text'] = get_utf8_string(text)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertStringToStream(self, text, out_stream):
"""
Convert a string and write the output to an output stream.
text - The string content to convert. The string must not be empty.
out_stream - The output stream that will contain the conversion output.
"""
if not (text):
raise Error(create_invalid_value_message(text, "convertStringToStream::text", "html-to-pdf", 'The string must not be empty.', "convert_string_to_stream"), 470);
self.fields['text'] = get_utf8_string(text)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertStringToFile(self, text, file_path):
"""
Convert a string and write the output to a file.
text - The string content to convert. The string must not be empty.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertStringToFile::file_path", "html-to-pdf", 'The string must not be empty.', "convert_string_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertStringToStream(text, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertStream(self, in_stream):
"""
Convert the contents of an input stream.
in_stream - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
return - Byte array containing the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
return self.helper.post(self.fields, self.files, self.raw_data)
def convertStreamToStream(self, in_stream, out_stream):
"""
Convert the contents of an input stream and write the result to an output stream.
in_stream - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertStreamToFile(self, in_stream, file_path):
"""
Convert the contents of an input stream and write the result to a local file.
in_stream - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertStreamToFile::file_path", "html-to-pdf", 'The string must not be empty.', "convert_stream_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertStreamToStream(in_stream, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def setZipMainFilename(self, filename):
"""
Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.
filename - The file name.
return - The converter object.
"""
self.fields['zip_main_filename'] = get_utf8_string(filename)
return self
def setPageSize(self, size):
"""
Set the output page size.
size - Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.
return - The converter object.
"""
if not re.match('(?i)^(A0|A1|A2|A3|A4|A5|A6|Letter)$', size):
raise Error(create_invalid_value_message(size, "setPageSize", "html-to-pdf", 'Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.', "set_page_size"), 470);
self.fields['page_size'] = get_utf8_string(size)
return self
def setPageWidth(self, width):
"""
Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.
width - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', width):
raise Error(create_invalid_value_message(width, "setPageWidth", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_page_width"), 470);
self.fields['page_width'] = get_utf8_string(width)
return self
def setPageHeight(self, height):
"""
Set the output page height. Use -1 for a single page PDF. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.
height - The value must be -1 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^\-1$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', height):
raise Error(create_invalid_value_message(height, "setPageHeight", "html-to-pdf", 'The value must be -1 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_page_height"), 470);
self.fields['page_height'] = get_utf8_string(height)
return self
def setPageDimensions(self, width, height):
"""
Set the output page dimensions.
width - Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
height - Set the output page height. Use -1 for a single page PDF. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF. The value must be -1 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
self.setPageWidth(width)
self.setPageHeight(height)
return self
def setOrientation(self, orientation):
"""
Set the output page orientation.
orientation - Allowed values are landscape, portrait.
return - The converter object.
"""
if not re.match('(?i)^(landscape|portrait)$', orientation):
raise Error(create_invalid_value_message(orientation, "setOrientation", "html-to-pdf", 'Allowed values are landscape, portrait.', "set_orientation"), 470);
self.fields['orientation'] = get_utf8_string(orientation)
return self
def setMarginTop(self, top):
"""
Set the output page top margin.
top - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', top):
raise Error(create_invalid_value_message(top, "setMarginTop", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_top"), 470);
self.fields['margin_top'] = get_utf8_string(top)
return self
def setMarginRight(self, right):
"""
Set the output page right margin.
right - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', right):
raise Error(create_invalid_value_message(right, "setMarginRight", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_right"), 470);
self.fields['margin_right'] = get_utf8_string(right)
return self
def setMarginBottom(self, bottom):
"""
Set the output page bottom margin.
bottom - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', bottom):
raise Error(create_invalid_value_message(bottom, "setMarginBottom", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_bottom"), 470);
self.fields['margin_bottom'] = get_utf8_string(bottom)
return self
def setMarginLeft(self, left):
"""
Set the output page left margin.
left - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', left):
raise Error(create_invalid_value_message(left, "setMarginLeft", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_left"), 470);
self.fields['margin_left'] = get_utf8_string(left)
return self
def setNoMargins(self, value):
"""
Disable page margins.
value - Set to True to disable margins.
return - The converter object.
"""
self.fields['no_margins'] = value
return self
def setPageMargins(self, top, right, bottom, left):
"""
Set the output page margins.
top - Set the output page top margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
right - Set the output page right margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
bottom - Set the output page bottom margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
left - Set the output page left margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
self.setMarginTop(top)
self.setMarginRight(right)
self.setMarginBottom(bottom)
self.setMarginLeft(left)
return self
def setPrintPageRange(self, pages):
"""
Set the page range to print.
pages - A comma separated list of page numbers or ranges.
return - The converter object.
"""
if not re.match('^(?:\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*,\s*)*\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*$', pages):
raise Error(create_invalid_value_message(pages, "setPrintPageRange", "html-to-pdf", 'A comma separated list of page numbers or ranges.', "set_print_page_range"), 470);
self.fields['print_page_range'] = get_utf8_string(pages)
return self
def setPageNumberingOffset(self, offset):
"""
Set an offset between physical and logical page numbers.
offset - Integer specifying page offset.
return - The converter object.
"""
self.fields['page_numbering_offset'] = offset
return self
def setContentAreaX(self, x):
"""
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
x - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
return - The converter object.
"""
if not re.match('(?i)^0$|^\-?[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', x):
raise Error(create_invalid_value_message(x, "setContentAreaX", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.', "set_content_area_x"), 470);
self.fields['content_area_x'] = get_utf8_string(x)
return self
def setContentAreaY(self, y):
"""
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
y - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
return - The converter object.
"""
if not re.match('(?i)^0$|^\-?[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', y):
raise Error(create_invalid_value_message(y, "setContentAreaY", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.', "set_content_area_y"), 470);
self.fields['content_area_y'] = get_utf8_string(y)
return self
def setContentAreaWidth(self, width):
"""
Set the width of the content area. It should be at least 1 inch.
width - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', width):
raise Error(create_invalid_value_message(width, "setContentAreaWidth", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_content_area_width"), 470);
self.fields['content_area_width'] = get_utf8_string(width)
return self
def setContentAreaHeight(self, height):
"""
Set the height of the content area. It should be at least 1 inch.
height - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', height):
raise Error(create_invalid_value_message(height, "setContentAreaHeight", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_content_area_height"), 470);
self.fields['content_area_height'] = get_utf8_string(height)
return self
def setContentArea(self, x, y, width, height):
"""
Set the content area position and size. The content area enables to specify a web page area to be converted.
x - Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
y - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
width - Set the width of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
height - Set the height of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
self.setContentAreaX(x)
self.setContentAreaY(y)
self.setContentAreaWidth(width)
self.setContentAreaHeight(height)
return self
def setCssPageRuleMode(self, mode):
"""
Specifies behavior in presence of CSS @page rules. It may affect the page size, margins and orientation.
mode - The page rule mode. Allowed values are default, mode1, mode2.
return - The converter object.
"""
if not re.match('(?i)^(default|mode1|mode2)$', mode):
raise Error(create_invalid_value_message(mode, "setCssPageRuleMode", "html-to-pdf", 'Allowed values are default, mode1, mode2.', "set_css_page_rule_mode"), 470);
self.fields['css_page_rule_mode'] = get_utf8_string(mode)
return self
def setRemoveBlankPages(self, pages):
"""
Specifies which blank pages to exclude from the output document.
pages - The empty page behavior. Allowed values are trailing, none.
return - The converter object.
"""
if not re.match('(?i)^(trailing|none)$', pages):
raise Error(create_invalid_value_message(pages, "setRemoveBlankPages", "html-to-pdf", 'Allowed values are trailing, none.', "set_remove_blank_pages"), 470);
self.fields['remove_blank_pages'] = get_utf8_string(pages)
return self
def setHeaderUrl(self, url):
"""
Load an HTML code from the specified URL and use it as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: will produce http://example.com href - the URL is set to the href attribute Example: Link to source will produce Link to source href-and-content - the URL is set to the href attribute and to the content Example: will produce http://example.com
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setHeaderUrl", "html-to-pdf", 'The supported protocols are http:// and https://.', "set_header_url"), 470);
self.fields['header_url'] = get_utf8_string(url)
return self
def setHeaderHtml(self, html):
"""
Use the specified HTML code as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: will produce http://example.com href - the URL is set to the href attribute Example: Link to source will produce Link to source href-and-content - the URL is set to the href attribute and to the content Example: will produce http://example.com
html - The string must not be empty.
return - The converter object.
"""
if not (html):
raise Error(create_invalid_value_message(html, "setHeaderHtml", "html-to-pdf", 'The string must not be empty.', "set_header_html"), 470);
self.fields['header_html'] = get_utf8_string(html)
return self
def setHeaderHeight(self, height):
"""
Set the header height.
height - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', height):
raise Error(create_invalid_value_message(height, "setHeaderHeight", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_header_height"), 470);
self.fields['header_height'] = get_utf8_string(height)
return self
def setZipHeaderFilename(self, filename):
"""
Set the file name of the header HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.
filename - The file name.
return - The converter object.
"""
self.fields['zip_header_filename'] = get_utf8_string(filename)
return self
def setFooterUrl(self, url):
"""
Load an HTML code from the specified URL and use it as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: will produce http://example.com href - the URL is set to the href attribute Example: Link to source will produce Link to source href-and-content - the URL is set to the href attribute and to the content Example: will produce http://example.com
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setFooterUrl", "html-to-pdf", 'The supported protocols are http:// and https://.', "set_footer_url"), 470);
self.fields['footer_url'] = get_utf8_string(url)
return self
def setFooterHtml(self, html):
"""
Use the specified HTML as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: will produce http://example.com href - the URL is set to the href attribute Example: Link to source will produce Link to source href-and-content - the URL is set to the href attribute and to the content Example: will produce http://example.com
html - The string must not be empty.
return - The converter object.
"""
if not (html):
raise Error(create_invalid_value_message(html, "setFooterHtml", "html-to-pdf", 'The string must not be empty.', "set_footer_html"), 470);
self.fields['footer_html'] = get_utf8_string(html)
return self
def setFooterHeight(self, height):
"""
Set the footer height.
height - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', height):
raise Error(create_invalid_value_message(height, "setFooterHeight", "html-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_footer_height"), 470);
self.fields['footer_height'] = get_utf8_string(height)
return self
def setZipFooterFilename(self, filename):
"""
Set the file name of the footer HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.
filename - The file name.
return - The converter object.
"""
self.fields['zip_footer_filename'] = get_utf8_string(filename)
return self
def setNoHeaderFooterHorizontalMargins(self, value):
"""
Disable horizontal page margins for header and footer. The header/footer contents width will be equal to the physical page width.
value - Set to True to disable horizontal margins for header and footer.
return - The converter object.
"""
self.fields['no_header_footer_horizontal_margins'] = value
return self
def setExcludeHeaderOnPages(self, pages):
"""
The page header is not printed on the specified pages.
pages - List of physical page numbers. Negative numbers count backwards from the last page: -1 is the last page, -2 is the last but one page, and so on. A comma separated list of page numbers.
return - The converter object.
"""
if not re.match('^(?:\s*\-?\d+\s*,)*\s*\-?\d+\s*$', pages):
raise Error(create_invalid_value_message(pages, "setExcludeHeaderOnPages", "html-to-pdf", 'A comma separated list of page numbers.', "set_exclude_header_on_pages"), 470);
self.fields['exclude_header_on_pages'] = get_utf8_string(pages)
return self
def setExcludeFooterOnPages(self, pages):
"""
The page footer is not printed on the specified pages.
pages - List of physical page numbers. Negative numbers count backwards from the last page: -1 is the last page, -2 is the last but one page, and so on. A comma separated list of page numbers.
return - The converter object.
"""
if not re.match('^(?:\s*\-?\d+\s*,)*\s*\-?\d+\s*$', pages):
raise Error(create_invalid_value_message(pages, "setExcludeFooterOnPages", "html-to-pdf", 'A comma separated list of page numbers.', "set_exclude_footer_on_pages"), 470);
self.fields['exclude_footer_on_pages'] = get_utf8_string(pages)
return self
def setHeaderFooterScaleFactor(self, factor):
"""
Set the scaling factor (zoom) for the header and footer.
factor - The percentage value. The value must be in the range 10-500.
return - The converter object.
"""
if not (int(factor) >= 10 and int(factor) <= 500):
raise Error(create_invalid_value_message(factor, "setHeaderFooterScaleFactor", "html-to-pdf", 'The value must be in the range 10-500.', "set_header_footer_scale_factor"), 470);
self.fields['header_footer_scale_factor'] = factor
return self
def setPageWatermark(self, watermark):
"""
Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
watermark - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(watermark) and os.path.getsize(watermark)):
raise Error(create_invalid_value_message(watermark, "setPageWatermark", "html-to-pdf", 'The file must exist and not be empty.', "set_page_watermark"), 470);
self.files['page_watermark'] = get_utf8_string(watermark)
return self
def setPageWatermarkUrl(self, url):
"""
Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setPageWatermarkUrl", "html-to-pdf", 'The supported protocols are http:// and https://.', "set_page_watermark_url"), 470);
self.fields['page_watermark_url'] = get_utf8_string(url)
return self
def setMultipageWatermark(self, watermark):
"""
Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
watermark - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(watermark) and os.path.getsize(watermark)):
raise Error(create_invalid_value_message(watermark, "setMultipageWatermark", "html-to-pdf", 'The file must exist and not be empty.', "set_multipage_watermark"), 470);
self.files['multipage_watermark'] = get_utf8_string(watermark)
return self
def setMultipageWatermarkUrl(self, url):
"""
Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setMultipageWatermarkUrl", "html-to-pdf", 'The supported protocols are http:// and https://.', "set_multipage_watermark_url"), 470);
self.fields['multipage_watermark_url'] = get_utf8_string(url)
return self
def setPageBackground(self, background):
"""
Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
background - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(background) and os.path.getsize(background)):
raise Error(create_invalid_value_message(background, "setPageBackground", "html-to-pdf", 'The file must exist and not be empty.', "set_page_background"), 470);
self.files['page_background'] = get_utf8_string(background)
return self
def setPageBackgroundUrl(self, url):
"""
Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setPageBackgroundUrl", "html-to-pdf", 'The supported protocols are http:// and https://.', "set_page_background_url"), 470);
self.fields['page_background_url'] = get_utf8_string(url)
return self
def setMultipageBackground(self, background):
"""
Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
background - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(background) and os.path.getsize(background)):
raise Error(create_invalid_value_message(background, "setMultipageBackground", "html-to-pdf", 'The file must exist and not be empty.', "set_multipage_background"), 470);
self.files['multipage_background'] = get_utf8_string(background)
return self
def setMultipageBackgroundUrl(self, url):
"""
Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setMultipageBackgroundUrl", "html-to-pdf", 'The supported protocols are http:// and https://.', "set_multipage_background_url"), 470);
self.fields['multipage_background_url'] = get_utf8_string(url)
return self
def setPageBackgroundColor(self, color):
"""
The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins.
color - The value must be in RRGGBB or RRGGBBAA hexadecimal format.
return - The converter object.
"""
if not re.match('^[0-9a-fA-F]{6,8}$', color):
raise Error(create_invalid_value_message(color, "setPageBackgroundColor", "html-to-pdf", 'The value must be in RRGGBB or RRGGBBAA hexadecimal format.', "set_page_background_color"), 470);
self.fields['page_background_color'] = get_utf8_string(color)
return self
def setUsePrintMedia(self, value):
"""
Use the print version of the page if available (@media print).
value - Set to True to use the print version of the page.
return - The converter object.
"""
self.fields['use_print_media'] = value
return self
def setNoBackground(self, value):
"""
Do not print the background graphics.
value - Set to True to disable the background graphics.
return - The converter object.
"""
self.fields['no_background'] = value
return self
def setDisableJavascript(self, value):
"""
Do not execute JavaScript.
value - Set to True to disable JavaScript in web pages.
return - The converter object.
"""
self.fields['disable_javascript'] = value
return self
def setDisableImageLoading(self, value):
"""
Do not load images.
value - Set to True to disable loading of images.
return - The converter object.
"""
self.fields['disable_image_loading'] = value
return self
def setDisableRemoteFonts(self, value):
"""
Disable loading fonts from remote sources.
value - Set to True disable loading remote fonts.
return - The converter object.
"""
self.fields['disable_remote_fonts'] = value
return self
def setUseMobileUserAgent(self, value):
"""
Use a mobile user agent.
value - Set to True to use a mobile user agent.
return - The converter object.
"""
self.fields['use_mobile_user_agent'] = value
return self
def setLoadIframes(self, iframes):
"""
Specifies how iframes are handled.
iframes - Allowed values are all, same-origin, none.
return - The converter object.
"""
if not re.match('(?i)^(all|same-origin|none)$', iframes):
raise Error(create_invalid_value_message(iframes, "setLoadIframes", "html-to-pdf", 'Allowed values are all, same-origin, none.', "set_load_iframes"), 470);
self.fields['load_iframes'] = get_utf8_string(iframes)
return self
def setBlockAds(self, value):
"""
Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
value - Set to True to block ads in web pages.
return - The converter object.
"""
self.fields['block_ads'] = value
return self
def setDefaultEncoding(self, encoding):
"""
Set the default HTML content text encoding.
encoding - The text encoding of the HTML content.
return - The converter object.
"""
self.fields['default_encoding'] = get_utf8_string(encoding)
return self
def setLocale(self, locale):
"""
Set the locale for the conversion. This may affect the output format of dates, times and numbers.
locale - The locale code according to ISO 639.
return - The converter object.
"""
self.fields['locale'] = get_utf8_string(locale)
return self
def setHttpAuthUserName(self, user_name):
"""
Set the HTTP authentication user name.
user_name - The user name.
return - The converter object.
"""
self.fields['http_auth_user_name'] = get_utf8_string(user_name)
return self
def setHttpAuthPassword(self, password):
"""
Set the HTTP authentication password.
password - The password.
return - The converter object.
"""
self.fields['http_auth_password'] = get_utf8_string(password)
return self
def setHttpAuth(self, user_name, password):
"""
Set credentials to access HTTP base authentication protected websites.
user_name - Set the HTTP authentication user name.
password - Set the HTTP authentication password.
return - The converter object.
"""
self.setHttpAuthUserName(user_name)
self.setHttpAuthPassword(password)
return self
def setCookies(self, cookies):
"""
Set cookies that are sent in Pdfcrowd HTTP requests.
cookies - The cookie string.
return - The converter object.
"""
self.fields['cookies'] = get_utf8_string(cookies)
return self
def setVerifySslCertificates(self, value):
"""
Do not allow insecure HTTPS connections.
value - Set to True to enable SSL certificate verification.
return - The converter object.
"""
self.fields['verify_ssl_certificates'] = value
return self
def setFailOnMainUrlError(self, fail_on_error):
"""
Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
fail_on_error - Set to True to abort the conversion.
return - The converter object.
"""
self.fields['fail_on_main_url_error'] = fail_on_error
return self
def setFailOnAnyUrlError(self, fail_on_error):
"""
Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.
fail_on_error - Set to True to abort the conversion.
return - The converter object.
"""
self.fields['fail_on_any_url_error'] = fail_on_error
return self
def setNoXpdfcrowdHeader(self, value):
"""
Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.
value - Set to True to disable sending X-Pdfcrowd HTTP header.
return - The converter object.
"""
self.fields['no_xpdfcrowd_header'] = value
return self
def setCustomCss(self, css):
"""
Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.
css - A string containing valid CSS. The string must not be empty.
return - The converter object.
"""
if not (css):
raise Error(create_invalid_value_message(css, "setCustomCss", "html-to-pdf", 'The string must not be empty.', "set_custom_css"), 470);
self.fields['custom_css'] = get_utf8_string(css)
return self
def setCustomJavascript(self, javascript):
"""
Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
javascript - A string containing a JavaScript code. The string must not be empty.
return - The converter object.
"""
if not (javascript):
raise Error(create_invalid_value_message(javascript, "setCustomJavascript", "html-to-pdf", 'The string must not be empty.', "set_custom_javascript"), 470);
self.fields['custom_javascript'] = get_utf8_string(javascript)
return self
def setOnLoadJavascript(self, javascript):
"""
Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
javascript - A string containing a JavaScript code. The string must not be empty.
return - The converter object.
"""
if not (javascript):
raise Error(create_invalid_value_message(javascript, "setOnLoadJavascript", "html-to-pdf", 'The string must not be empty.', "set_on_load_javascript"), 470);
self.fields['on_load_javascript'] = get_utf8_string(javascript)
return self
def setCustomHttpHeader(self, header):
"""
Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
header - A string containing the header name and value separated by a colon.
return - The converter object.
"""
if not re.match('^.+:.+$', header):
raise Error(create_invalid_value_message(header, "setCustomHttpHeader", "html-to-pdf", 'A string containing the header name and value separated by a colon.', "set_custom_http_header"), 470);
self.fields['custom_http_header'] = get_utf8_string(header)
return self
def setJavascriptDelay(self, delay):
"""
Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter.
delay - The number of milliseconds to wait. Must be a positive integer number or 0.
return - The converter object.
"""
if not (int(delay) >= 0):
raise Error(create_invalid_value_message(delay, "setJavascriptDelay", "html-to-pdf", 'Must be a positive integer number or 0.', "set_javascript_delay"), 470);
self.fields['javascript_delay'] = delay
return self
def setElementToConvert(self, selectors):
"""
Convert only the specified element from the main document and its children. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used.
selectors - One or more CSS selectors separated by commas. The string must not be empty.
return - The converter object.
"""
if not (selectors):
raise Error(create_invalid_value_message(selectors, "setElementToConvert", "html-to-pdf", 'The string must not be empty.', "set_element_to_convert"), 470);
self.fields['element_to_convert'] = get_utf8_string(selectors)
return self
def setElementToConvertMode(self, mode):
"""
Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
mode - Allowed values are cut-out, remove-siblings, hide-siblings.
return - The converter object.
"""
if not re.match('(?i)^(cut-out|remove-siblings|hide-siblings)$', mode):
raise Error(create_invalid_value_message(mode, "setElementToConvertMode", "html-to-pdf", 'Allowed values are cut-out, remove-siblings, hide-siblings.', "set_element_to_convert_mode"), 470);
self.fields['element_to_convert_mode'] = get_utf8_string(mode)
return self
def setWaitForElement(self, selectors):
"""
Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by "Max Delay" parameter.
selectors - One or more CSS selectors separated by commas. The string must not be empty.
return - The converter object.
"""
if not (selectors):
raise Error(create_invalid_value_message(selectors, "setWaitForElement", "html-to-pdf", 'The string must not be empty.', "set_wait_for_element"), 470);
self.fields['wait_for_element'] = get_utf8_string(selectors)
return self
def setAutoDetectElementToConvert(self, value):
"""
The main HTML element for conversion is detected automatically.
value - Set to True to detect the main element.
return - The converter object.
"""
self.fields['auto_detect_element_to_convert'] = value
return self
def setReadabilityEnhancements(self, enhancements):
"""
The input HTML is automatically enhanced to improve the readability.
enhancements - Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.
return - The converter object.
"""
if not re.match('(?i)^(none|readability-v1|readability-v2|readability-v3|readability-v4)$', enhancements):
raise Error(create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-pdf", 'Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.', "set_readability_enhancements"), 470);
self.fields['readability_enhancements'] = get_utf8_string(enhancements)
return self
def setViewportWidth(self, width):
"""
Set the viewport width in pixels. The viewport is the user's visible area of the page.
width - The value must be in the range 96-65000.
return - The converter object.
"""
if not (int(width) >= 96 and int(width) <= 65000):
raise Error(create_invalid_value_message(width, "setViewportWidth", "html-to-pdf", 'The value must be in the range 96-65000.', "set_viewport_width"), 470);
self.fields['viewport_width'] = width
return self
def setViewportHeight(self, height):
"""
Set the viewport height in pixels. The viewport is the user's visible area of the page. If the input HTML uses lazily loaded images, try using a large value that covers the entire height of the HTML, e.g. 100000.
height - Must be a positive integer number.
return - The converter object.
"""
if not (int(height) > 0):
raise Error(create_invalid_value_message(height, "setViewportHeight", "html-to-pdf", 'Must be a positive integer number.', "set_viewport_height"), 470);
self.fields['viewport_height'] = height
return self
def setViewport(self, width, height):
"""
Set the viewport size. The viewport is the user's visible area of the page.
width - Set the viewport width in pixels. The viewport is the user's visible area of the page. The value must be in the range 96-65000.
height - Set the viewport height in pixels. The viewport is the user's visible area of the page. If the input HTML uses lazily loaded images, try using a large value that covers the entire height of the HTML, e.g. 100000. Must be a positive integer number.
return - The converter object.
"""
self.setViewportWidth(width)
self.setViewportHeight(height)
return self
def setRenderingMode(self, mode):
"""
Set the rendering mode.
mode - The rendering mode. Allowed values are default, viewport.
return - The converter object.
"""
if not re.match('(?i)^(default|viewport)$', mode):
raise Error(create_invalid_value_message(mode, "setRenderingMode", "html-to-pdf", 'Allowed values are default, viewport.', "set_rendering_mode"), 470);
self.fields['rendering_mode'] = get_utf8_string(mode)
return self
def setSmartScalingMode(self, mode):
"""
Specifies the scaling mode used for fitting the HTML contents to the print area.
mode - The smart scaling mode. Allowed values are default, disabled, viewport-fit, content-fit, single-page-fit, single-page-fit-ex, mode1.
return - The converter object.
"""
if not re.match('(?i)^(default|disabled|viewport-fit|content-fit|single-page-fit|single-page-fit-ex|mode1)$', mode):
raise Error(create_invalid_value_message(mode, "setSmartScalingMode", "html-to-pdf", 'Allowed values are default, disabled, viewport-fit, content-fit, single-page-fit, single-page-fit-ex, mode1.', "set_smart_scaling_mode"), 470);
self.fields['smart_scaling_mode'] = get_utf8_string(mode)
return self
def setScaleFactor(self, factor):
"""
Set the scaling factor (zoom) for the main page area.
factor - The percentage value. The value must be in the range 10-500.
return - The converter object.
"""
if not (int(factor) >= 10 and int(factor) <= 500):
raise Error(create_invalid_value_message(factor, "setScaleFactor", "html-to-pdf", 'The value must be in the range 10-500.', "set_scale_factor"), 470);
self.fields['scale_factor'] = factor
return self
def setJpegQuality(self, quality):
"""
Set the quality of embedded JPEG images. A lower quality results in a smaller PDF file but can lead to compression artifacts.
quality - The percentage value. The value must be in the range 1-100.
return - The converter object.
"""
if not (int(quality) >= 1 and int(quality) <= 100):
raise Error(create_invalid_value_message(quality, "setJpegQuality", "html-to-pdf", 'The value must be in the range 1-100.', "set_jpeg_quality"), 470);
self.fields['jpeg_quality'] = quality
return self
def setConvertImagesToJpeg(self, images):
"""
Specify which image types will be converted to JPEG. Converting lossless compression image formats (PNG, GIF, ...) to JPEG may result in a smaller PDF file.
images - The image category. Allowed values are none, opaque, all.
return - The converter object.
"""
if not re.match('(?i)^(none|opaque|all)$', images):
raise Error(create_invalid_value_message(images, "setConvertImagesToJpeg", "html-to-pdf", 'Allowed values are none, opaque, all.', "set_convert_images_to_jpeg"), 470);
self.fields['convert_images_to_jpeg'] = get_utf8_string(images)
return self
def setImageDpi(self, dpi):
"""
Set the DPI of images in PDF. A lower DPI may result in a smaller PDF file. If the specified DPI is higher than the actual image DPI, the original image DPI is retained (no upscaling is performed). Use 0 to leave the images unaltered.
dpi - The DPI value. Must be a positive integer number or 0.
return - The converter object.
"""
if not (int(dpi) >= 0):
raise Error(create_invalid_value_message(dpi, "setImageDpi", "html-to-pdf", 'Must be a positive integer number or 0.', "set_image_dpi"), 470);
self.fields['image_dpi'] = dpi
return self
def setEnablePdfForms(self, value):
"""
Convert HTML forms to fillable PDF forms. Details can be found in the blog post.
value - Set to True to make fillable PDF forms.
return - The converter object.
"""
self.fields['enable_pdf_forms'] = value
return self
def setLinearize(self, value):
"""
Create linearized PDF. This is also known as Fast Web View.
value - Set to True to create linearized PDF.
return - The converter object.
"""
self.fields['linearize'] = value
return self
def setEncrypt(self, value):
"""
Encrypt the PDF. This prevents search engines from indexing the contents.
value - Set to True to enable PDF encryption.
return - The converter object.
"""
self.fields['encrypt'] = value
return self
def setUserPassword(self, password):
"""
Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.
password - The user password.
return - The converter object.
"""
self.fields['user_password'] = get_utf8_string(password)
return self
def setOwnerPassword(self, password):
"""
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
password - The owner password.
return - The converter object.
"""
self.fields['owner_password'] = get_utf8_string(password)
return self
def setNoPrint(self, value):
"""
Disallow printing of the output PDF.
value - Set to True to set the no-print flag in the output PDF.
return - The converter object.
"""
self.fields['no_print'] = value
return self
def setNoModify(self, value):
"""
Disallow modification of the output PDF.
value - Set to True to set the read-only only flag in the output PDF.
return - The converter object.
"""
self.fields['no_modify'] = value
return self
def setNoCopy(self, value):
"""
Disallow text and graphics extraction from the output PDF.
value - Set to True to set the no-copy flag in the output PDF.
return - The converter object.
"""
self.fields['no_copy'] = value
return self
def setTitle(self, title):
"""
Set the title of the PDF.
title - The title.
return - The converter object.
"""
self.fields['title'] = get_utf8_string(title)
return self
def setSubject(self, subject):
"""
Set the subject of the PDF.
subject - The subject.
return - The converter object.
"""
self.fields['subject'] = get_utf8_string(subject)
return self
def setAuthor(self, author):
"""
Set the author of the PDF.
author - The author.
return - The converter object.
"""
self.fields['author'] = get_utf8_string(author)
return self
def setKeywords(self, keywords):
"""
Associate keywords with the document.
keywords - The string with the keywords.
return - The converter object.
"""
self.fields['keywords'] = get_utf8_string(keywords)
return self
def setExtractMetaTags(self, value):
"""
Extract meta tags (author, keywords and description) from the input HTML and use them in the output PDF.
value - Set to True to extract meta tags.
return - The converter object.
"""
self.fields['extract_meta_tags'] = value
return self
def setPageLayout(self, layout):
"""
Specify the page layout to be used when the document is opened.
layout - Allowed values are single-page, one-column, two-column-left, two-column-right.
return - The converter object.
"""
if not re.match('(?i)^(single-page|one-column|two-column-left|two-column-right)$', layout):
raise Error(create_invalid_value_message(layout, "setPageLayout", "html-to-pdf", 'Allowed values are single-page, one-column, two-column-left, two-column-right.', "set_page_layout"), 470);
self.fields['page_layout'] = get_utf8_string(layout)
return self
def setPageMode(self, mode):
"""
Specify how the document should be displayed when opened.
mode - Allowed values are full-screen, thumbnails, outlines.
return - The converter object.
"""
if not re.match('(?i)^(full-screen|thumbnails|outlines)$', mode):
raise Error(create_invalid_value_message(mode, "setPageMode", "html-to-pdf", 'Allowed values are full-screen, thumbnails, outlines.', "set_page_mode"), 470);
self.fields['page_mode'] = get_utf8_string(mode)
return self
def setInitialZoomType(self, zoom_type):
"""
Specify how the page should be displayed when opened.
zoom_type - Allowed values are fit-width, fit-height, fit-page.
return - The converter object.
"""
if not re.match('(?i)^(fit-width|fit-height|fit-page)$', zoom_type):
raise Error(create_invalid_value_message(zoom_type, "setInitialZoomType", "html-to-pdf", 'Allowed values are fit-width, fit-height, fit-page.', "set_initial_zoom_type"), 470);
self.fields['initial_zoom_type'] = get_utf8_string(zoom_type)
return self
def setInitialPage(self, page):
"""
Display the specified page when the document is opened.
page - Must be a positive integer number.
return - The converter object.
"""
if not (int(page) > 0):
raise Error(create_invalid_value_message(page, "setInitialPage", "html-to-pdf", 'Must be a positive integer number.', "set_initial_page"), 470);
self.fields['initial_page'] = page
return self
def setInitialZoom(self, zoom):
"""
Specify the initial page zoom in percents when the document is opened.
zoom - Must be a positive integer number.
return - The converter object.
"""
if not (int(zoom) > 0):
raise Error(create_invalid_value_message(zoom, "setInitialZoom", "html-to-pdf", 'Must be a positive integer number.', "set_initial_zoom"), 470);
self.fields['initial_zoom'] = zoom
return self
def setHideToolbar(self, value):
"""
Specify whether to hide the viewer application's tool bars when the document is active.
value - Set to True to hide tool bars.
return - The converter object.
"""
self.fields['hide_toolbar'] = value
return self
def setHideMenubar(self, value):
"""
Specify whether to hide the viewer application's menu bar when the document is active.
value - Set to True to hide the menu bar.
return - The converter object.
"""
self.fields['hide_menubar'] = value
return self
def setHideWindowUi(self, value):
"""
Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
value - Set to True to hide ui elements.
return - The converter object.
"""
self.fields['hide_window_ui'] = value
return self
def setFitWindow(self, value):
"""
Specify whether to resize the document's window to fit the size of the first displayed page.
value - Set to True to resize the window.
return - The converter object.
"""
self.fields['fit_window'] = value
return self
def setCenterWindow(self, value):
"""
Specify whether to position the document's window in the center of the screen.
value - Set to True to center the window.
return - The converter object.
"""
self.fields['center_window'] = value
return self
def setDisplayTitle(self, value):
"""
Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.
value - Set to True to display the title.
return - The converter object.
"""
self.fields['display_title'] = value
return self
def setRightToLeft(self, value):
"""
Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up
value - Set to True to set right-to-left reading order.
return - The converter object.
"""
self.fields['right_to_left'] = value
return self
def setDataString(self, data_string):
"""
Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
data_string - The input data string.
return - The converter object.
"""
self.fields['data_string'] = get_utf8_string(data_string)
return self
def setDataFile(self, data_file):
"""
Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
data_file - The file path to a local file containing the input data.
return - The converter object.
"""
self.files['data_file'] = get_utf8_string(data_file)
return self
def setDataFormat(self, data_format):
"""
Specify the input data format.
data_format - The data format. Allowed values are auto, json, xml, yaml, csv.
return - The converter object.
"""
if not re.match('(?i)^(auto|json|xml|yaml|csv)$', data_format):
raise Error(create_invalid_value_message(data_format, "setDataFormat", "html-to-pdf", 'Allowed values are auto, json, xml, yaml, csv.', "set_data_format"), 470);
self.fields['data_format'] = get_utf8_string(data_format)
return self
def setDataEncoding(self, encoding):
"""
Set the encoding of the data file set by setDataFile.
encoding - The data file encoding.
return - The converter object.
"""
self.fields['data_encoding'] = get_utf8_string(encoding)
return self
def setDataIgnoreUndefined(self, value):
"""
Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
value - Set to True to ignore undefined variables.
return - The converter object.
"""
self.fields['data_ignore_undefined'] = value
return self
def setDataAutoEscape(self, value):
"""
Auto escape HTML symbols in the input data before placing them into the output.
value - Set to True to turn auto escaping on.
return - The converter object.
"""
self.fields['data_auto_escape'] = value
return self
def setDataTrimBlocks(self, value):
"""
Auto trim whitespace around each template command block.
value - Set to True to turn auto trimming on.
return - The converter object.
"""
self.fields['data_trim_blocks'] = value
return self
def setDataOptions(self, options):
"""
Set the advanced data options:csv_delimiter - The CSV data delimiter, the default is ,.xml_remove_root - Remove the root XML element from the input data.data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
options - Comma separated list of options.
return - The converter object.
"""
self.fields['data_options'] = get_utf8_string(options)
return self
def setDebugLog(self, value):
"""
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
value - Set to True to enable the debug logging.
return - The converter object.
"""
self.fields['debug_log'] = value
return self
def getDebugLogUrl(self):
"""
Get the URL of the debug log for the last conversion.
return - The link to the debug log.
"""
return self.helper.getDebugLogUrl()
def getRemainingCreditCount(self):
"""
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
return - The number of credits.
"""
return self.helper.getRemainingCreditCount()
def getConsumedCreditCount(self):
"""
Get the number of credits consumed by the last conversion.
return - The number of credits.
"""
return self.helper.getConsumedCreditCount()
def getJobId(self):
"""
Get the job id.
return - The unique job identifier.
"""
return self.helper.getJobId()
def getPageCount(self):
"""
Get the number of pages in the output document.
return - The page count.
"""
return self.helper.getPageCount()
def getTotalPageCount(self):
"""
Get the total number of pages in the original output document, including the pages excluded by setPrintPageRange().
return - The total page count.
"""
return self.helper.getTotalPageCount()
def getOutputSize(self):
"""
Get the size of the output in bytes.
return - The count of bytes.
"""
return self.helper.getOutputSize()
def getVersion(self):
"""
Get the version details.
return - API version, converter version, and client version.
"""
return 'client {}, API v2, converter {}'.format(CLIENT_VERSION, self.helper.getConverterVersion())
def setTag(self, tag):
"""
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag - A string with the custom tag.
return - The converter object.
"""
self.fields['tag'] = get_utf8_string(tag)
return self
def setHttpProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpProxy", "html-to-pdf", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_http_proxy"), 470);
self.fields['http_proxy'] = get_utf8_string(proxy)
return self
def setHttpsProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpsProxy", "html-to-pdf", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_https_proxy"), 470);
self.fields['https_proxy'] = get_utf8_string(proxy)
return self
def setClientCertificate(self, certificate):
"""
A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.
certificate - The file must be in PKCS12 format. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(certificate) and os.path.getsize(certificate)):
raise Error(create_invalid_value_message(certificate, "setClientCertificate", "html-to-pdf", 'The file must exist and not be empty.', "set_client_certificate"), 470);
self.files['client_certificate'] = get_utf8_string(certificate)
return self
def setClientCertificatePassword(self, password):
"""
A password for PKCS12 file with a client certificate if it is needed.
password -
return - The converter object.
"""
self.fields['client_certificate_password'] = get_utf8_string(password)
return self
def setLayoutDpi(self, dpi):
"""
Set the internal DPI resolution used for positioning of PDF contents. It can help in situations when there are small inaccuracies in the PDF. It is recommended to use values that are a multiple of 72, such as 288 or 360.
dpi - The DPI value. The value must be in the range of 72-600.
return - The converter object.
"""
if not (int(dpi) >= 72 and int(dpi) <= 600):
raise Error(create_invalid_value_message(dpi, "setLayoutDpi", "html-to-pdf", 'The value must be in the range of 72-600.', "set_layout_dpi"), 470);
self.fields['layout_dpi'] = dpi
return self
def setContentsMatrix(self, matrix):
"""
A 2D transformation matrix applied to the main contents on each page. The origin [0,0] is located at the top-left corner of the contents. The resolution is 72 dpi.
matrix - A comma separated string of matrix elements: "scaleX,skewX,transX,skewY,scaleY,transY"
return - The converter object.
"""
self.fields['contents_matrix'] = get_utf8_string(matrix)
return self
def setHeaderMatrix(self, matrix):
"""
A 2D transformation matrix applied to the page header contents. The origin [0,0] is located at the top-left corner of the header. The resolution is 72 dpi.
matrix - A comma separated string of matrix elements: "scaleX,skewX,transX,skewY,scaleY,transY"
return - The converter object.
"""
self.fields['header_matrix'] = get_utf8_string(matrix)
return self
def setFooterMatrix(self, matrix):
"""
A 2D transformation matrix applied to the page footer contents. The origin [0,0] is located at the top-left corner of the footer. The resolution is 72 dpi.
matrix - A comma separated string of matrix elements: "scaleX,skewX,transX,skewY,scaleY,transY"
return - The converter object.
"""
self.fields['footer_matrix'] = get_utf8_string(matrix)
return self
def setDisablePageHeightOptimization(self, value):
"""
Disable automatic height adjustment that compensates for pixel to point rounding errors.
value - Set to True to disable automatic height scale.
return - The converter object.
"""
self.fields['disable_page_height_optimization'] = value
return self
def setMainDocumentCssAnnotation(self, value):
"""
Add special CSS classes to the main document's body element. This allows applying custom styling based on these classes: pdfcrowd-page-X - where X is the current page number pdfcrowd-page-odd - odd page pdfcrowd-page-even - even page
Warning: If your custom styling affects the contents area size (e.g. by using different margins, padding, border width), the resulting PDF may contain duplicit contents or some contents may be missing.
value - Set to True to add the special CSS classes.
return - The converter object.
"""
self.fields['main_document_css_annotation'] = value
return self
def setHeaderFooterCssAnnotation(self, value):
"""
Add special CSS classes to the header/footer's body element. This allows applying custom styling based on these classes: pdfcrowd-page-X - where X is the current page number pdfcrowd-page-count-X - where X is the total page count pdfcrowd-page-first - the first page pdfcrowd-page-last - the last page pdfcrowd-page-odd - odd page pdfcrowd-page-even - even page
value - Set to True to add the special CSS classes.
return - The converter object.
"""
self.fields['header_footer_css_annotation'] = value
return self
def setMaxLoadingTime(self, max_time):
"""
Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.
max_time - The number of seconds to wait. The value must be in the range 10-30.
return - The converter object.
"""
if not (int(max_time) >= 10 and int(max_time) <= 30):
raise Error(create_invalid_value_message(max_time, "setMaxLoadingTime", "html-to-pdf", 'The value must be in the range 10-30.', "set_max_loading_time"), 470);
self.fields['max_loading_time'] = max_time
return self
def setConverterVersion(self, version):
"""
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
version - The version identifier. Allowed values are latest, 20.10, 18.10.
return - The converter object.
"""
if not re.match('(?i)^(latest|20.10|18.10)$', version):
raise Error(create_invalid_value_message(version, "setConverterVersion", "html-to-pdf", 'Allowed values are latest, 20.10, 18.10.', "set_converter_version"), 470);
self.helper.setConverterVersion(version)
return self
def setUseHttp(self, value):
"""
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
value - Set to True to use HTTP.
return - The converter object.
"""
self.helper.setUseHttp(value)
return self
def setUserAgent(self, agent):
"""
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent - The user agent string.
return - The converter object.
"""
self.helper.setUserAgent(agent)
return self
def setProxy(self, host, port, user_name, password):
"""
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host - The proxy hostname.
port - The proxy port.
user_name - The username.
password - The password.
return - The converter object.
"""
self.helper.setProxy(host, port, user_name, password)
return self
def setRetryCount(self, count):
"""
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
count - Number of retries.
return - The converter object.
"""
self.helper.setRetryCount(count)
return self
class HtmlToImageClient:
"""
Conversion from HTML to image.
"""
def __init__(self, user_name, api_key):
"""
Constructor for the Pdfcrowd API client.
user_name - Your username at Pdfcrowd.
api_key - Your API key.
"""
self.helper = ConnectionHelper(user_name, api_key)
self.fields = {
'input_format': 'html',
'output_format': 'png'
}
self.file_id = 1
self.files = {}
self.raw_data = {}
def setOutputFormat(self, output_format):
"""
The format of the output file.
output_format - Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.
return - The converter object.
"""
if not re.match('(?i)^(png|jpg|gif|tiff|bmp|ico|ppm|pgm|pbm|pnm|psb|pct|ras|tga|sgi|sun|webp)$', output_format):
raise Error(create_invalid_value_message(output_format, "setOutputFormat", "html-to-image", 'Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.', "set_output_format"), 470);
self.fields['output_format'] = get_utf8_string(output_format)
return self
def convertUrl(self, url):
"""
Convert a web page.
url - The address of the web page to convert. The supported protocols are http:// and https://.
return - Byte array containing the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrl", "html-to-image", 'The supported protocols are http:// and https://.', "convert_url"), 470);
self.fields['url'] = get_utf8_string(url)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertUrlToStream(self, url, out_stream):
"""
Convert a web page and write the result to an output stream.
url - The address of the web page to convert. The supported protocols are http:// and https://.
out_stream - The output stream that will contain the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrlToStream::url", "html-to-image", 'The supported protocols are http:// and https://.', "convert_url_to_stream"), 470);
self.fields['url'] = get_utf8_string(url)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertUrlToFile(self, url, file_path):
"""
Convert a web page and write the result to a local file.
url - The address of the web page to convert. The supported protocols are http:// and https://.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertUrlToFile::file_path", "html-to-image", 'The string must not be empty.', "convert_url_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertUrlToStream(url, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertFile(self, file):
"""
Convert a local file.
file - The path to a local file to convert. The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip). If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.
return - Byte array containing the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFile", "html-to-image", 'The file must exist and not be empty.', "convert_file"), 470);
self.files['file'] = get_utf8_string(file)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertFileToStream(self, file, out_stream):
"""
Convert a local file and write the result to an output stream.
file - The path to a local file to convert. The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip). If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.
out_stream - The output stream that will contain the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFileToStream::file", "html-to-image", 'The file must exist and not be empty.', "convert_file_to_stream"), 470);
self.files['file'] = get_utf8_string(file)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertFileToFile(self, file, file_path):
"""
Convert a local file and write the result to a local file.
file - The path to a local file to convert. The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip). If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertFileToFile::file_path", "html-to-image", 'The string must not be empty.', "convert_file_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertFileToStream(file, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertString(self, text):
"""
Convert a string.
text - The string content to convert. The string must not be empty.
return - Byte array containing the conversion output.
"""
if not (text):
raise Error(create_invalid_value_message(text, "convertString", "html-to-image", 'The string must not be empty.', "convert_string"), 470);
self.fields['text'] = get_utf8_string(text)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertStringToStream(self, text, out_stream):
"""
Convert a string and write the output to an output stream.
text - The string content to convert. The string must not be empty.
out_stream - The output stream that will contain the conversion output.
"""
if not (text):
raise Error(create_invalid_value_message(text, "convertStringToStream::text", "html-to-image", 'The string must not be empty.', "convert_string_to_stream"), 470);
self.fields['text'] = get_utf8_string(text)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertStringToFile(self, text, file_path):
"""
Convert a string and write the output to a file.
text - The string content to convert. The string must not be empty.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertStringToFile::file_path", "html-to-image", 'The string must not be empty.', "convert_string_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertStringToStream(text, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertStream(self, in_stream):
"""
Convert the contents of an input stream.
in_stream - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
return - Byte array containing the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
return self.helper.post(self.fields, self.files, self.raw_data)
def convertStreamToStream(self, in_stream, out_stream):
"""
Convert the contents of an input stream and write the result to an output stream.
in_stream - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertStreamToFile(self, in_stream, file_path):
"""
Convert the contents of an input stream and write the result to a local file.
in_stream - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertStreamToFile::file_path", "html-to-image", 'The string must not be empty.', "convert_stream_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertStreamToStream(in_stream, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def setZipMainFilename(self, filename):
"""
Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.
filename - The file name.
return - The converter object.
"""
self.fields['zip_main_filename'] = get_utf8_string(filename)
return self
def setScreenshotWidth(self, width):
"""
Set the output image width in pixels.
width - The value must be in the range 96-65000.
return - The converter object.
"""
if not (int(width) >= 96 and int(width) <= 65000):
raise Error(create_invalid_value_message(width, "setScreenshotWidth", "html-to-image", 'The value must be in the range 96-65000.', "set_screenshot_width"), 470);
self.fields['screenshot_width'] = width
return self
def setScreenshotHeight(self, height):
"""
Set the output image height in pixels. If it is not specified, actual document height is used.
height - Must be a positive integer number.
return - The converter object.
"""
if not (int(height) > 0):
raise Error(create_invalid_value_message(height, "setScreenshotHeight", "html-to-image", 'Must be a positive integer number.', "set_screenshot_height"), 470);
self.fields['screenshot_height'] = height
return self
def setScaleFactor(self, factor):
"""
Set the scaling factor (zoom) for the output image.
factor - The percentage value. Must be a positive integer number.
return - The converter object.
"""
if not (int(factor) > 0):
raise Error(create_invalid_value_message(factor, "setScaleFactor", "html-to-image", 'Must be a positive integer number.', "set_scale_factor"), 470);
self.fields['scale_factor'] = factor
return self
def setBackgroundColor(self, color):
"""
The output image background color.
color - The value must be in RRGGBB or RRGGBBAA hexadecimal format.
return - The converter object.
"""
if not re.match('^[0-9a-fA-F]{6,8}$', color):
raise Error(create_invalid_value_message(color, "setBackgroundColor", "html-to-image", 'The value must be in RRGGBB or RRGGBBAA hexadecimal format.', "set_background_color"), 470);
self.fields['background_color'] = get_utf8_string(color)
return self
def setUsePrintMedia(self, value):
"""
Use the print version of the page if available (@media print).
value - Set to True to use the print version of the page.
return - The converter object.
"""
self.fields['use_print_media'] = value
return self
def setNoBackground(self, value):
"""
Do not print the background graphics.
value - Set to True to disable the background graphics.
return - The converter object.
"""
self.fields['no_background'] = value
return self
def setDisableJavascript(self, value):
"""
Do not execute JavaScript.
value - Set to True to disable JavaScript in web pages.
return - The converter object.
"""
self.fields['disable_javascript'] = value
return self
def setDisableImageLoading(self, value):
"""
Do not load images.
value - Set to True to disable loading of images.
return - The converter object.
"""
self.fields['disable_image_loading'] = value
return self
def setDisableRemoteFonts(self, value):
"""
Disable loading fonts from remote sources.
value - Set to True disable loading remote fonts.
return - The converter object.
"""
self.fields['disable_remote_fonts'] = value
return self
def setUseMobileUserAgent(self, value):
"""
Use a mobile user agent.
value - Set to True to use a mobile user agent.
return - The converter object.
"""
self.fields['use_mobile_user_agent'] = value
return self
def setLoadIframes(self, iframes):
"""
Specifies how iframes are handled.
iframes - Allowed values are all, same-origin, none.
return - The converter object.
"""
if not re.match('(?i)^(all|same-origin|none)$', iframes):
raise Error(create_invalid_value_message(iframes, "setLoadIframes", "html-to-image", 'Allowed values are all, same-origin, none.', "set_load_iframes"), 470);
self.fields['load_iframes'] = get_utf8_string(iframes)
return self
def setBlockAds(self, value):
"""
Try to block ads. Enabling this option can produce smaller output and speed up the conversion.
value - Set to True to block ads in web pages.
return - The converter object.
"""
self.fields['block_ads'] = value
return self
def setDefaultEncoding(self, encoding):
"""
Set the default HTML content text encoding.
encoding - The text encoding of the HTML content.
return - The converter object.
"""
self.fields['default_encoding'] = get_utf8_string(encoding)
return self
def setLocale(self, locale):
"""
Set the locale for the conversion. This may affect the output format of dates, times and numbers.
locale - The locale code according to ISO 639.
return - The converter object.
"""
self.fields['locale'] = get_utf8_string(locale)
return self
def setHttpAuthUserName(self, user_name):
"""
Set the HTTP authentication user name.
user_name - The user name.
return - The converter object.
"""
self.fields['http_auth_user_name'] = get_utf8_string(user_name)
return self
def setHttpAuthPassword(self, password):
"""
Set the HTTP authentication password.
password - The password.
return - The converter object.
"""
self.fields['http_auth_password'] = get_utf8_string(password)
return self
def setHttpAuth(self, user_name, password):
"""
Set credentials to access HTTP base authentication protected websites.
user_name - Set the HTTP authentication user name.
password - Set the HTTP authentication password.
return - The converter object.
"""
self.setHttpAuthUserName(user_name)
self.setHttpAuthPassword(password)
return self
def setCookies(self, cookies):
"""
Set cookies that are sent in Pdfcrowd HTTP requests.
cookies - The cookie string.
return - The converter object.
"""
self.fields['cookies'] = get_utf8_string(cookies)
return self
def setVerifySslCertificates(self, value):
"""
Do not allow insecure HTTPS connections.
value - Set to True to enable SSL certificate verification.
return - The converter object.
"""
self.fields['verify_ssl_certificates'] = value
return self
def setFailOnMainUrlError(self, fail_on_error):
"""
Abort the conversion if the main URL HTTP status code is greater than or equal to 400.
fail_on_error - Set to True to abort the conversion.
return - The converter object.
"""
self.fields['fail_on_main_url_error'] = fail_on_error
return self
def setFailOnAnyUrlError(self, fail_on_error):
"""
Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.
fail_on_error - Set to True to abort the conversion.
return - The converter object.
"""
self.fields['fail_on_any_url_error'] = fail_on_error
return self
def setNoXpdfcrowdHeader(self, value):
"""
Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.
value - Set to True to disable sending X-Pdfcrowd HTTP header.
return - The converter object.
"""
self.fields['no_xpdfcrowd_header'] = value
return self
def setCustomCss(self, css):
"""
Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.
css - A string containing valid CSS. The string must not be empty.
return - The converter object.
"""
if not (css):
raise Error(create_invalid_value_message(css, "setCustomCss", "html-to-image", 'The string must not be empty.', "set_custom_css"), 470);
self.fields['custom_css'] = get_utf8_string(css)
return self
def setCustomJavascript(self, javascript):
"""
Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
javascript - A string containing a JavaScript code. The string must not be empty.
return - The converter object.
"""
if not (javascript):
raise Error(create_invalid_value_message(javascript, "setCustomJavascript", "html-to-image", 'The string must not be empty.', "set_custom_javascript"), 470);
self.fields['custom_javascript'] = get_utf8_string(javascript)
return self
def setOnLoadJavascript(self, javascript):
"""
Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
javascript - A string containing a JavaScript code. The string must not be empty.
return - The converter object.
"""
if not (javascript):
raise Error(create_invalid_value_message(javascript, "setOnLoadJavascript", "html-to-image", 'The string must not be empty.', "set_on_load_javascript"), 470);
self.fields['on_load_javascript'] = get_utf8_string(javascript)
return self
def setCustomHttpHeader(self, header):
"""
Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
header - A string containing the header name and value separated by a colon.
return - The converter object.
"""
if not re.match('^.+:.+$', header):
raise Error(create_invalid_value_message(header, "setCustomHttpHeader", "html-to-image", 'A string containing the header name and value separated by a colon.', "set_custom_http_header"), 470);
self.fields['custom_http_header'] = get_utf8_string(header)
return self
def setJavascriptDelay(self, delay):
"""
Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter.
delay - The number of milliseconds to wait. Must be a positive integer number or 0.
return - The converter object.
"""
if not (int(delay) >= 0):
raise Error(create_invalid_value_message(delay, "setJavascriptDelay", "html-to-image", 'Must be a positive integer number or 0.', "set_javascript_delay"), 470);
self.fields['javascript_delay'] = delay
return self
def setElementToConvert(self, selectors):
"""
Convert only the specified element from the main document and its children. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used.
selectors - One or more CSS selectors separated by commas. The string must not be empty.
return - The converter object.
"""
if not (selectors):
raise Error(create_invalid_value_message(selectors, "setElementToConvert", "html-to-image", 'The string must not be empty.', "set_element_to_convert"), 470);
self.fields['element_to_convert'] = get_utf8_string(selectors)
return self
def setElementToConvertMode(self, mode):
"""
Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
mode - Allowed values are cut-out, remove-siblings, hide-siblings.
return - The converter object.
"""
if not re.match('(?i)^(cut-out|remove-siblings|hide-siblings)$', mode):
raise Error(create_invalid_value_message(mode, "setElementToConvertMode", "html-to-image", 'Allowed values are cut-out, remove-siblings, hide-siblings.', "set_element_to_convert_mode"), 470);
self.fields['element_to_convert_mode'] = get_utf8_string(mode)
return self
def setWaitForElement(self, selectors):
"""
Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by "Max Delay" parameter.
selectors - One or more CSS selectors separated by commas. The string must not be empty.
return - The converter object.
"""
if not (selectors):
raise Error(create_invalid_value_message(selectors, "setWaitForElement", "html-to-image", 'The string must not be empty.', "set_wait_for_element"), 470);
self.fields['wait_for_element'] = get_utf8_string(selectors)
return self
def setAutoDetectElementToConvert(self, value):
"""
The main HTML element for conversion is detected automatically.
value - Set to True to detect the main element.
return - The converter object.
"""
self.fields['auto_detect_element_to_convert'] = value
return self
def setReadabilityEnhancements(self, enhancements):
"""
The input HTML is automatically enhanced to improve the readability.
enhancements - Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.
return - The converter object.
"""
if not re.match('(?i)^(none|readability-v1|readability-v2|readability-v3|readability-v4)$', enhancements):
raise Error(create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-image", 'Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.', "set_readability_enhancements"), 470);
self.fields['readability_enhancements'] = get_utf8_string(enhancements)
return self
def setDataString(self, data_string):
"""
Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
data_string - The input data string.
return - The converter object.
"""
self.fields['data_string'] = get_utf8_string(data_string)
return self
def setDataFile(self, data_file):
"""
Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
data_file - The file path to a local file containing the input data.
return - The converter object.
"""
self.files['data_file'] = get_utf8_string(data_file)
return self
def setDataFormat(self, data_format):
"""
Specify the input data format.
data_format - The data format. Allowed values are auto, json, xml, yaml, csv.
return - The converter object.
"""
if not re.match('(?i)^(auto|json|xml|yaml|csv)$', data_format):
raise Error(create_invalid_value_message(data_format, "setDataFormat", "html-to-image", 'Allowed values are auto, json, xml, yaml, csv.', "set_data_format"), 470);
self.fields['data_format'] = get_utf8_string(data_format)
return self
def setDataEncoding(self, encoding):
"""
Set the encoding of the data file set by setDataFile.
encoding - The data file encoding.
return - The converter object.
"""
self.fields['data_encoding'] = get_utf8_string(encoding)
return self
def setDataIgnoreUndefined(self, value):
"""
Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
value - Set to True to ignore undefined variables.
return - The converter object.
"""
self.fields['data_ignore_undefined'] = value
return self
def setDataAutoEscape(self, value):
"""
Auto escape HTML symbols in the input data before placing them into the output.
value - Set to True to turn auto escaping on.
return - The converter object.
"""
self.fields['data_auto_escape'] = value
return self
def setDataTrimBlocks(self, value):
"""
Auto trim whitespace around each template command block.
value - Set to True to turn auto trimming on.
return - The converter object.
"""
self.fields['data_trim_blocks'] = value
return self
def setDataOptions(self, options):
"""
Set the advanced data options:csv_delimiter - The CSV data delimiter, the default is ,.xml_remove_root - Remove the root XML element from the input data.data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
options - Comma separated list of options.
return - The converter object.
"""
self.fields['data_options'] = get_utf8_string(options)
return self
def setDebugLog(self, value):
"""
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
value - Set to True to enable the debug logging.
return - The converter object.
"""
self.fields['debug_log'] = value
return self
def getDebugLogUrl(self):
"""
Get the URL of the debug log for the last conversion.
return - The link to the debug log.
"""
return self.helper.getDebugLogUrl()
def getRemainingCreditCount(self):
"""
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
return - The number of credits.
"""
return self.helper.getRemainingCreditCount()
def getConsumedCreditCount(self):
"""
Get the number of credits consumed by the last conversion.
return - The number of credits.
"""
return self.helper.getConsumedCreditCount()
def getJobId(self):
"""
Get the job id.
return - The unique job identifier.
"""
return self.helper.getJobId()
def getOutputSize(self):
"""
Get the size of the output in bytes.
return - The count of bytes.
"""
return self.helper.getOutputSize()
def getVersion(self):
"""
Get the version details.
return - API version, converter version, and client version.
"""
return 'client {}, API v2, converter {}'.format(CLIENT_VERSION, self.helper.getConverterVersion())
def setTag(self, tag):
"""
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag - A string with the custom tag.
return - The converter object.
"""
self.fields['tag'] = get_utf8_string(tag)
return self
def setHttpProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpProxy", "html-to-image", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_http_proxy"), 470);
self.fields['http_proxy'] = get_utf8_string(proxy)
return self
def setHttpsProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpsProxy", "html-to-image", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_https_proxy"), 470);
self.fields['https_proxy'] = get_utf8_string(proxy)
return self
def setClientCertificate(self, certificate):
"""
A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.
certificate - The file must be in PKCS12 format. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(certificate) and os.path.getsize(certificate)):
raise Error(create_invalid_value_message(certificate, "setClientCertificate", "html-to-image", 'The file must exist and not be empty.', "set_client_certificate"), 470);
self.files['client_certificate'] = get_utf8_string(certificate)
return self
def setClientCertificatePassword(self, password):
"""
A password for PKCS12 file with a client certificate if it is needed.
password -
return - The converter object.
"""
self.fields['client_certificate_password'] = get_utf8_string(password)
return self
def setMaxLoadingTime(self, max_time):
"""
Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.
max_time - The number of seconds to wait. The value must be in the range 10-30.
return - The converter object.
"""
if not (int(max_time) >= 10 and int(max_time) <= 30):
raise Error(create_invalid_value_message(max_time, "setMaxLoadingTime", "html-to-image", 'The value must be in the range 10-30.', "set_max_loading_time"), 470);
self.fields['max_loading_time'] = max_time
return self
def setConverterVersion(self, version):
"""
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
version - The version identifier. Allowed values are latest, 20.10, 18.10.
return - The converter object.
"""
if not re.match('(?i)^(latest|20.10|18.10)$', version):
raise Error(create_invalid_value_message(version, "setConverterVersion", "html-to-image", 'Allowed values are latest, 20.10, 18.10.', "set_converter_version"), 470);
self.helper.setConverterVersion(version)
return self
def setUseHttp(self, value):
"""
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
value - Set to True to use HTTP.
return - The converter object.
"""
self.helper.setUseHttp(value)
return self
def setUserAgent(self, agent):
"""
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent - The user agent string.
return - The converter object.
"""
self.helper.setUserAgent(agent)
return self
def setProxy(self, host, port, user_name, password):
"""
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host - The proxy hostname.
port - The proxy port.
user_name - The username.
password - The password.
return - The converter object.
"""
self.helper.setProxy(host, port, user_name, password)
return self
def setRetryCount(self, count):
"""
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
count - Number of retries.
return - The converter object.
"""
self.helper.setRetryCount(count)
return self
class ImageToImageClient:
"""
Conversion from one image format to another image format.
"""
def __init__(self, user_name, api_key):
"""
Constructor for the Pdfcrowd API client.
user_name - Your username at Pdfcrowd.
api_key - Your API key.
"""
self.helper = ConnectionHelper(user_name, api_key)
self.fields = {
'input_format': 'image',
'output_format': 'png'
}
self.file_id = 1
self.files = {}
self.raw_data = {}
def convertUrl(self, url):
"""
Convert an image.
url - The address of the image to convert. The supported protocols are http:// and https://.
return - Byte array containing the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrl", "image-to-image", 'The supported protocols are http:// and https://.', "convert_url"), 470);
self.fields['url'] = get_utf8_string(url)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertUrlToStream(self, url, out_stream):
"""
Convert an image and write the result to an output stream.
url - The address of the image to convert. The supported protocols are http:// and https://.
out_stream - The output stream that will contain the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrlToStream::url", "image-to-image", 'The supported protocols are http:// and https://.', "convert_url_to_stream"), 470);
self.fields['url'] = get_utf8_string(url)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertUrlToFile(self, url, file_path):
"""
Convert an image and write the result to a local file.
url - The address of the image to convert. The supported protocols are http:// and https://.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertUrlToFile::file_path", "image-to-image", 'The string must not be empty.', "convert_url_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertUrlToStream(url, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertFile(self, file):
"""
Convert a local file.
file - The path to a local file to convert. The file must exist and not be empty.
return - Byte array containing the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFile", "image-to-image", 'The file must exist and not be empty.', "convert_file"), 470);
self.files['file'] = get_utf8_string(file)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertFileToStream(self, file, out_stream):
"""
Convert a local file and write the result to an output stream.
file - The path to a local file to convert. The file must exist and not be empty.
out_stream - The output stream that will contain the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFileToStream::file", "image-to-image", 'The file must exist and not be empty.', "convert_file_to_stream"), 470);
self.files['file'] = get_utf8_string(file)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertFileToFile(self, file, file_path):
"""
Convert a local file and write the result to a local file.
file - The path to a local file to convert. The file must exist and not be empty.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertFileToFile::file_path", "image-to-image", 'The string must not be empty.', "convert_file_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertFileToStream(file, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertRawData(self, data):
"""
Convert raw data.
data - The raw content to be converted.
return - Byte array with the output.
"""
self.raw_data['file'] = data
return self.helper.post(self.fields, self.files, self.raw_data)
def convertRawDataToStream(self, data, out_stream):
"""
Convert raw data and write the result to an output stream.
data - The raw content to be converted.
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['file'] = data
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertRawDataToFile(self, data, file_path):
"""
Convert raw data to a file.
data - The raw content to be converted.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertRawDataToFile::file_path", "image-to-image", 'The string must not be empty.', "convert_raw_data_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertRawDataToStream(data, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertStream(self, in_stream):
"""
Convert the contents of an input stream.
in_stream - The input stream with source data.
return - Byte array containing the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
return self.helper.post(self.fields, self.files, self.raw_data)
def convertStreamToStream(self, in_stream, out_stream):
"""
Convert the contents of an input stream and write the result to an output stream.
in_stream - The input stream with source data.
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertStreamToFile(self, in_stream, file_path):
"""
Convert the contents of an input stream and write the result to a local file.
in_stream - The input stream with source data.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertStreamToFile::file_path", "image-to-image", 'The string must not be empty.', "convert_stream_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertStreamToStream(in_stream, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def setOutputFormat(self, output_format):
"""
The format of the output file.
output_format - Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.
return - The converter object.
"""
if not re.match('(?i)^(png|jpg|gif|tiff|bmp|ico|ppm|pgm|pbm|pnm|psb|pct|ras|tga|sgi|sun|webp)$', output_format):
raise Error(create_invalid_value_message(output_format, "setOutputFormat", "image-to-image", 'Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.', "set_output_format"), 470);
self.fields['output_format'] = get_utf8_string(output_format)
return self
def setResize(self, resize):
"""
Resize the image.
resize - The resize percentage or new image dimensions.
return - The converter object.
"""
self.fields['resize'] = get_utf8_string(resize)
return self
def setRotate(self, rotate):
"""
Rotate the image.
rotate - The rotation specified in degrees.
return - The converter object.
"""
self.fields['rotate'] = get_utf8_string(rotate)
return self
def setCropAreaX(self, x):
"""
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
x - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', x):
raise Error(create_invalid_value_message(x, "setCropAreaX", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_crop_area_x"), 470);
self.fields['crop_area_x'] = get_utf8_string(x)
return self
def setCropAreaY(self, y):
"""
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
y - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', y):
raise Error(create_invalid_value_message(y, "setCropAreaY", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_crop_area_y"), 470);
self.fields['crop_area_y'] = get_utf8_string(y)
return self
def setCropAreaWidth(self, width):
"""
Set the width of the content area. It should be at least 1 inch.
width - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', width):
raise Error(create_invalid_value_message(width, "setCropAreaWidth", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_crop_area_width"), 470);
self.fields['crop_area_width'] = get_utf8_string(width)
return self
def setCropAreaHeight(self, height):
"""
Set the height of the content area. It should be at least 1 inch.
height - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', height):
raise Error(create_invalid_value_message(height, "setCropAreaHeight", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_crop_area_height"), 470);
self.fields['crop_area_height'] = get_utf8_string(height)
return self
def setCropArea(self, x, y, width, height):
"""
Set the content area position and size. The content area enables to specify the part to be converted.
x - Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
y - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
width - Set the width of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
height - Set the height of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
self.setCropAreaX(x)
self.setCropAreaY(y)
self.setCropAreaWidth(width)
self.setCropAreaHeight(height)
return self
def setRemoveBorders(self, value):
"""
Remove borders of an image which does not change in color.
value - Set to True to remove borders.
return - The converter object.
"""
self.fields['remove_borders'] = value
return self
def setCanvasSize(self, size):
"""
Set the output canvas size.
size - Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.
return - The converter object.
"""
if not re.match('(?i)^(A0|A1|A2|A3|A4|A5|A6|Letter)$', size):
raise Error(create_invalid_value_message(size, "setCanvasSize", "image-to-image", 'Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.', "set_canvas_size"), 470);
self.fields['canvas_size'] = get_utf8_string(size)
return self
def setCanvasWidth(self, width):
"""
Set the output canvas width.
width - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', width):
raise Error(create_invalid_value_message(width, "setCanvasWidth", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_canvas_width"), 470);
self.fields['canvas_width'] = get_utf8_string(width)
return self
def setCanvasHeight(self, height):
"""
Set the output canvas height.
height - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', height):
raise Error(create_invalid_value_message(height, "setCanvasHeight", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_canvas_height"), 470);
self.fields['canvas_height'] = get_utf8_string(height)
return self
def setCanvasDimensions(self, width, height):
"""
Set the output canvas dimensions. If no canvas size is specified, margins are applied as a border around the image.
width - Set the output canvas width. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
height - Set the output canvas height. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
self.setCanvasWidth(width)
self.setCanvasHeight(height)
return self
def setOrientation(self, orientation):
"""
Set the output canvas orientation.
orientation - Allowed values are landscape, portrait.
return - The converter object.
"""
if not re.match('(?i)^(landscape|portrait)$', orientation):
raise Error(create_invalid_value_message(orientation, "setOrientation", "image-to-image", 'Allowed values are landscape, portrait.', "set_orientation"), 470);
self.fields['orientation'] = get_utf8_string(orientation)
return self
def setPosition(self, position):
"""
Set the image position on the canvas.
position - Allowed values are center, top, bottom, left, right, top-left, top-right, bottom-left, bottom-right.
return - The converter object.
"""
if not re.match('(?i)^(center|top|bottom|left|right|top-left|top-right|bottom-left|bottom-right)$', position):
raise Error(create_invalid_value_message(position, "setPosition", "image-to-image", 'Allowed values are center, top, bottom, left, right, top-left, top-right, bottom-left, bottom-right.', "set_position"), 470);
self.fields['position'] = get_utf8_string(position)
return self
def setPrintCanvasMode(self, mode):
"""
Set the mode to print the image on the canvas.
mode - Allowed values are default, fit, stretch.
return - The converter object.
"""
if not re.match('(?i)^(default|fit|stretch)$', mode):
raise Error(create_invalid_value_message(mode, "setPrintCanvasMode", "image-to-image", 'Allowed values are default, fit, stretch.', "set_print_canvas_mode"), 470);
self.fields['print_canvas_mode'] = get_utf8_string(mode)
return self
def setMarginTop(self, top):
"""
Set the output canvas top margin.
top - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', top):
raise Error(create_invalid_value_message(top, "setMarginTop", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_top"), 470);
self.fields['margin_top'] = get_utf8_string(top)
return self
def setMarginRight(self, right):
"""
Set the output canvas right margin.
right - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', right):
raise Error(create_invalid_value_message(right, "setMarginRight", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_right"), 470);
self.fields['margin_right'] = get_utf8_string(right)
return self
def setMarginBottom(self, bottom):
"""
Set the output canvas bottom margin.
bottom - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', bottom):
raise Error(create_invalid_value_message(bottom, "setMarginBottom", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_bottom"), 470);
self.fields['margin_bottom'] = get_utf8_string(bottom)
return self
def setMarginLeft(self, left):
"""
Set the output canvas left margin.
left - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', left):
raise Error(create_invalid_value_message(left, "setMarginLeft", "image-to-image", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_left"), 470);
self.fields['margin_left'] = get_utf8_string(left)
return self
def setMargins(self, top, right, bottom, left):
"""
Set the output canvas margins.
top - Set the output canvas top margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
right - Set the output canvas right margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
bottom - Set the output canvas bottom margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
left - Set the output canvas left margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
self.setMarginTop(top)
self.setMarginRight(right)
self.setMarginBottom(bottom)
self.setMarginLeft(left)
return self
def setCanvasBackgroundColor(self, color):
"""
The canvas background color in RGB or RGBA hexadecimal format. The color fills the entire canvas regardless of margins. If no canvas size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.
color - The value must be in RRGGBB or RRGGBBAA hexadecimal format.
return - The converter object.
"""
if not re.match('^[0-9a-fA-F]{6,8}$', color):
raise Error(create_invalid_value_message(color, "setCanvasBackgroundColor", "image-to-image", 'The value must be in RRGGBB or RRGGBBAA hexadecimal format.', "set_canvas_background_color"), 470);
self.fields['canvas_background_color'] = get_utf8_string(color)
return self
def setDpi(self, dpi):
"""
Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).
dpi - The DPI value.
return - The converter object.
"""
self.fields['dpi'] = dpi
return self
def setDebugLog(self, value):
"""
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
value - Set to True to enable the debug logging.
return - The converter object.
"""
self.fields['debug_log'] = value
return self
def getDebugLogUrl(self):
"""
Get the URL of the debug log for the last conversion.
return - The link to the debug log.
"""
return self.helper.getDebugLogUrl()
def getRemainingCreditCount(self):
"""
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
return - The number of credits.
"""
return self.helper.getRemainingCreditCount()
def getConsumedCreditCount(self):
"""
Get the number of credits consumed by the last conversion.
return - The number of credits.
"""
return self.helper.getConsumedCreditCount()
def getJobId(self):
"""
Get the job id.
return - The unique job identifier.
"""
return self.helper.getJobId()
def getOutputSize(self):
"""
Get the size of the output in bytes.
return - The count of bytes.
"""
return self.helper.getOutputSize()
def getVersion(self):
"""
Get the version details.
return - API version, converter version, and client version.
"""
return 'client {}, API v2, converter {}'.format(CLIENT_VERSION, self.helper.getConverterVersion())
def setTag(self, tag):
"""
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag - A string with the custom tag.
return - The converter object.
"""
self.fields['tag'] = get_utf8_string(tag)
return self
def setHttpProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpProxy", "image-to-image", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_http_proxy"), 470);
self.fields['http_proxy'] = get_utf8_string(proxy)
return self
def setHttpsProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpsProxy", "image-to-image", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_https_proxy"), 470);
self.fields['https_proxy'] = get_utf8_string(proxy)
return self
def setConverterVersion(self, version):
"""
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
version - The version identifier. Allowed values are latest, 20.10, 18.10.
return - The converter object.
"""
if not re.match('(?i)^(latest|20.10|18.10)$', version):
raise Error(create_invalid_value_message(version, "setConverterVersion", "image-to-image", 'Allowed values are latest, 20.10, 18.10.', "set_converter_version"), 470);
self.helper.setConverterVersion(version)
return self
def setUseHttp(self, value):
"""
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
value - Set to True to use HTTP.
return - The converter object.
"""
self.helper.setUseHttp(value)
return self
def setUserAgent(self, agent):
"""
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent - The user agent string.
return - The converter object.
"""
self.helper.setUserAgent(agent)
return self
def setProxy(self, host, port, user_name, password):
"""
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host - The proxy hostname.
port - The proxy port.
user_name - The username.
password - The password.
return - The converter object.
"""
self.helper.setProxy(host, port, user_name, password)
return self
def setRetryCount(self, count):
"""
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
count - Number of retries.
return - The converter object.
"""
self.helper.setRetryCount(count)
return self
class PdfToPdfClient:
"""
Conversion from PDF to PDF.
"""
def __init__(self, user_name, api_key):
"""
Constructor for the Pdfcrowd API client.
user_name - Your username at Pdfcrowd.
api_key - Your API key.
"""
self.helper = ConnectionHelper(user_name, api_key)
self.fields = {
'input_format': 'pdf',
'output_format': 'pdf'
}
self.file_id = 1
self.files = {}
self.raw_data = {}
def setAction(self, action):
"""
Specifies the action to be performed on the input PDFs.
action - Allowed values are join, shuffle, extract, delete.
return - The converter object.
"""
if not re.match('(?i)^(join|shuffle|extract|delete)$', action):
raise Error(create_invalid_value_message(action, "setAction", "pdf-to-pdf", 'Allowed values are join, shuffle, extract, delete.', "set_action"), 470);
self.fields['action'] = get_utf8_string(action)
return self
def convert(self):
"""
Perform an action on the input files.
return - Byte array containing the output PDF.
"""
return self.helper.post(self.fields, self.files, self.raw_data)
def convertToStream(self, out_stream):
"""
Perform an action on the input files and write the output PDF to an output stream.
out_stream - The output stream that will contain the output PDF.
"""
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertToFile(self, file_path):
"""
Perform an action on the input files and write the output PDF to a file.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertToFile", "pdf-to-pdf", 'The string must not be empty.', "convert_to_file"), 470);
output_file = open(file_path, 'wb')
self.convertToStream(output_file)
output_file.close()
def addPdfFile(self, file_path):
"""
Add a PDF file to the list of the input PDFs.
file_path - The file path to a local PDF file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(file_path) and os.path.getsize(file_path)):
raise Error(create_invalid_value_message(file_path, "addPdfFile", "pdf-to-pdf", 'The file must exist and not be empty.', "add_pdf_file"), 470);
self.files['f_{}'.format(self.file_id)] = file_path
self.file_id += 1
return self
def addPdfRawData(self, data):
"""
Add in-memory raw PDF data to the list of the input PDFs.Typical usage is for adding PDF created by another Pdfcrowd converter. Example in PHP: $clientPdf2Pdf->addPdfRawData($clientHtml2Pdf->convertUrl('http://www.example.com'));
data - The raw PDF data. The input data must be PDF content.
return - The converter object.
"""
if not (data and len(data) > 300 and (data[0:4] == '%PDF' or data[0:4] == u'%PDF' or data[0:4] == b'%PDF')):
raise Error(create_invalid_value_message("raw PDF data", "addPdfRawData", "pdf-to-pdf", 'The input data must be PDF content.', "add_pdf_raw_data"), 470);
self.raw_data['f_{}'.format(self.file_id)] = data
self.file_id += 1
return self
def setInputPdfPassword(self, password):
"""
Password to open the encrypted PDF file.
password - The input PDF password.
return - The converter object.
"""
self.fields['input_pdf_password'] = get_utf8_string(password)
return self
def setPageRange(self, pages):
"""
Set the page range for extract or delete action.
pages - A comma separated list of page numbers or ranges.
return - The converter object.
"""
if not re.match('^(?:\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*,\s*)*\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*$', pages):
raise Error(create_invalid_value_message(pages, "setPageRange", "pdf-to-pdf", 'A comma separated list of page numbers or ranges.', "set_page_range"), 470);
self.fields['page_range'] = get_utf8_string(pages)
return self
def setPageWatermark(self, watermark):
"""
Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
watermark - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(watermark) and os.path.getsize(watermark)):
raise Error(create_invalid_value_message(watermark, "setPageWatermark", "pdf-to-pdf", 'The file must exist and not be empty.', "set_page_watermark"), 470);
self.files['page_watermark'] = get_utf8_string(watermark)
return self
def setPageWatermarkUrl(self, url):
"""
Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setPageWatermarkUrl", "pdf-to-pdf", 'The supported protocols are http:// and https://.', "set_page_watermark_url"), 470);
self.fields['page_watermark_url'] = get_utf8_string(url)
return self
def setMultipageWatermark(self, watermark):
"""
Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
watermark - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(watermark) and os.path.getsize(watermark)):
raise Error(create_invalid_value_message(watermark, "setMultipageWatermark", "pdf-to-pdf", 'The file must exist and not be empty.', "set_multipage_watermark"), 470);
self.files['multipage_watermark'] = get_utf8_string(watermark)
return self
def setMultipageWatermarkUrl(self, url):
"""
Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setMultipageWatermarkUrl", "pdf-to-pdf", 'The supported protocols are http:// and https://.', "set_multipage_watermark_url"), 470);
self.fields['multipage_watermark_url'] = get_utf8_string(url)
return self
def setPageBackground(self, background):
"""
Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
background - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(background) and os.path.getsize(background)):
raise Error(create_invalid_value_message(background, "setPageBackground", "pdf-to-pdf", 'The file must exist and not be empty.', "set_page_background"), 470);
self.files['page_background'] = get_utf8_string(background)
return self
def setPageBackgroundUrl(self, url):
"""
Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setPageBackgroundUrl", "pdf-to-pdf", 'The supported protocols are http:// and https://.', "set_page_background_url"), 470);
self.fields['page_background_url'] = get_utf8_string(url)
return self
def setMultipageBackground(self, background):
"""
Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
background - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(background) and os.path.getsize(background)):
raise Error(create_invalid_value_message(background, "setMultipageBackground", "pdf-to-pdf", 'The file must exist and not be empty.', "set_multipage_background"), 470);
self.files['multipage_background'] = get_utf8_string(background)
return self
def setMultipageBackgroundUrl(self, url):
"""
Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setMultipageBackgroundUrl", "pdf-to-pdf", 'The supported protocols are http:// and https://.', "set_multipage_background_url"), 470);
self.fields['multipage_background_url'] = get_utf8_string(url)
return self
def setLinearize(self, value):
"""
Create linearized PDF. This is also known as Fast Web View.
value - Set to True to create linearized PDF.
return - The converter object.
"""
self.fields['linearize'] = value
return self
def setEncrypt(self, value):
"""
Encrypt the PDF. This prevents search engines from indexing the contents.
value - Set to True to enable PDF encryption.
return - The converter object.
"""
self.fields['encrypt'] = value
return self
def setUserPassword(self, password):
"""
Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.
password - The user password.
return - The converter object.
"""
self.fields['user_password'] = get_utf8_string(password)
return self
def setOwnerPassword(self, password):
"""
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
password - The owner password.
return - The converter object.
"""
self.fields['owner_password'] = get_utf8_string(password)
return self
def setNoPrint(self, value):
"""
Disallow printing of the output PDF.
value - Set to True to set the no-print flag in the output PDF.
return - The converter object.
"""
self.fields['no_print'] = value
return self
def setNoModify(self, value):
"""
Disallow modification of the output PDF.
value - Set to True to set the read-only only flag in the output PDF.
return - The converter object.
"""
self.fields['no_modify'] = value
return self
def setNoCopy(self, value):
"""
Disallow text and graphics extraction from the output PDF.
value - Set to True to set the no-copy flag in the output PDF.
return - The converter object.
"""
self.fields['no_copy'] = value
return self
def setTitle(self, title):
"""
Set the title of the PDF.
title - The title.
return - The converter object.
"""
self.fields['title'] = get_utf8_string(title)
return self
def setSubject(self, subject):
"""
Set the subject of the PDF.
subject - The subject.
return - The converter object.
"""
self.fields['subject'] = get_utf8_string(subject)
return self
def setAuthor(self, author):
"""
Set the author of the PDF.
author - The author.
return - The converter object.
"""
self.fields['author'] = get_utf8_string(author)
return self
def setKeywords(self, keywords):
"""
Associate keywords with the document.
keywords - The string with the keywords.
return - The converter object.
"""
self.fields['keywords'] = get_utf8_string(keywords)
return self
def setUseMetadataFrom(self, index):
"""
Use metadata (title, subject, author and keywords) from the n-th input PDF.
index - Set the index of the input PDF file from which to use the metadata. 0 means no metadata. Must be a positive integer number or 0.
return - The converter object.
"""
if not (int(index) >= 0):
raise Error(create_invalid_value_message(index, "setUseMetadataFrom", "pdf-to-pdf", 'Must be a positive integer number or 0.', "set_use_metadata_from"), 470);
self.fields['use_metadata_from'] = index
return self
def setPageLayout(self, layout):
"""
Specify the page layout to be used when the document is opened.
layout - Allowed values are single-page, one-column, two-column-left, two-column-right.
return - The converter object.
"""
if not re.match('(?i)^(single-page|one-column|two-column-left|two-column-right)$', layout):
raise Error(create_invalid_value_message(layout, "setPageLayout", "pdf-to-pdf", 'Allowed values are single-page, one-column, two-column-left, two-column-right.', "set_page_layout"), 470);
self.fields['page_layout'] = get_utf8_string(layout)
return self
def setPageMode(self, mode):
"""
Specify how the document should be displayed when opened.
mode - Allowed values are full-screen, thumbnails, outlines.
return - The converter object.
"""
if not re.match('(?i)^(full-screen|thumbnails|outlines)$', mode):
raise Error(create_invalid_value_message(mode, "setPageMode", "pdf-to-pdf", 'Allowed values are full-screen, thumbnails, outlines.', "set_page_mode"), 470);
self.fields['page_mode'] = get_utf8_string(mode)
return self
def setInitialZoomType(self, zoom_type):
"""
Specify how the page should be displayed when opened.
zoom_type - Allowed values are fit-width, fit-height, fit-page.
return - The converter object.
"""
if not re.match('(?i)^(fit-width|fit-height|fit-page)$', zoom_type):
raise Error(create_invalid_value_message(zoom_type, "setInitialZoomType", "pdf-to-pdf", 'Allowed values are fit-width, fit-height, fit-page.', "set_initial_zoom_type"), 470);
self.fields['initial_zoom_type'] = get_utf8_string(zoom_type)
return self
def setInitialPage(self, page):
"""
Display the specified page when the document is opened.
page - Must be a positive integer number.
return - The converter object.
"""
if not (int(page) > 0):
raise Error(create_invalid_value_message(page, "setInitialPage", "pdf-to-pdf", 'Must be a positive integer number.', "set_initial_page"), 470);
self.fields['initial_page'] = page
return self
def setInitialZoom(self, zoom):
"""
Specify the initial page zoom in percents when the document is opened.
zoom - Must be a positive integer number.
return - The converter object.
"""
if not (int(zoom) > 0):
raise Error(create_invalid_value_message(zoom, "setInitialZoom", "pdf-to-pdf", 'Must be a positive integer number.', "set_initial_zoom"), 470);
self.fields['initial_zoom'] = zoom
return self
def setHideToolbar(self, value):
"""
Specify whether to hide the viewer application's tool bars when the document is active.
value - Set to True to hide tool bars.
return - The converter object.
"""
self.fields['hide_toolbar'] = value
return self
def setHideMenubar(self, value):
"""
Specify whether to hide the viewer application's menu bar when the document is active.
value - Set to True to hide the menu bar.
return - The converter object.
"""
self.fields['hide_menubar'] = value
return self
def setHideWindowUi(self, value):
"""
Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
value - Set to True to hide ui elements.
return - The converter object.
"""
self.fields['hide_window_ui'] = value
return self
def setFitWindow(self, value):
"""
Specify whether to resize the document's window to fit the size of the first displayed page.
value - Set to True to resize the window.
return - The converter object.
"""
self.fields['fit_window'] = value
return self
def setCenterWindow(self, value):
"""
Specify whether to position the document's window in the center of the screen.
value - Set to True to center the window.
return - The converter object.
"""
self.fields['center_window'] = value
return self
def setDisplayTitle(self, value):
"""
Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.
value - Set to True to display the title.
return - The converter object.
"""
self.fields['display_title'] = value
return self
def setRightToLeft(self, value):
"""
Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up
value - Set to True to set right-to-left reading order.
return - The converter object.
"""
self.fields['right_to_left'] = value
return self
def setDebugLog(self, value):
"""
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
value - Set to True to enable the debug logging.
return - The converter object.
"""
self.fields['debug_log'] = value
return self
def getDebugLogUrl(self):
"""
Get the URL of the debug log for the last conversion.
return - The link to the debug log.
"""
return self.helper.getDebugLogUrl()
def getRemainingCreditCount(self):
"""
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
return - The number of credits.
"""
return self.helper.getRemainingCreditCount()
def getConsumedCreditCount(self):
"""
Get the number of credits consumed by the last conversion.
return - The number of credits.
"""
return self.helper.getConsumedCreditCount()
def getJobId(self):
"""
Get the job id.
return - The unique job identifier.
"""
return self.helper.getJobId()
def getPageCount(self):
"""
Get the number of pages in the output document.
return - The page count.
"""
return self.helper.getPageCount()
def getOutputSize(self):
"""
Get the size of the output in bytes.
return - The count of bytes.
"""
return self.helper.getOutputSize()
def getVersion(self):
"""
Get the version details.
return - API version, converter version, and client version.
"""
return 'client {}, API v2, converter {}'.format(CLIENT_VERSION, self.helper.getConverterVersion())
def setTag(self, tag):
"""
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag - A string with the custom tag.
return - The converter object.
"""
self.fields['tag'] = get_utf8_string(tag)
return self
def setConverterVersion(self, version):
"""
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
version - The version identifier. Allowed values are latest, 20.10, 18.10.
return - The converter object.
"""
if not re.match('(?i)^(latest|20.10|18.10)$', version):
raise Error(create_invalid_value_message(version, "setConverterVersion", "pdf-to-pdf", 'Allowed values are latest, 20.10, 18.10.', "set_converter_version"), 470);
self.helper.setConverterVersion(version)
return self
def setUseHttp(self, value):
"""
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
value - Set to True to use HTTP.
return - The converter object.
"""
self.helper.setUseHttp(value)
return self
def setUserAgent(self, agent):
"""
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent - The user agent string.
return - The converter object.
"""
self.helper.setUserAgent(agent)
return self
def setProxy(self, host, port, user_name, password):
"""
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host - The proxy hostname.
port - The proxy port.
user_name - The username.
password - The password.
return - The converter object.
"""
self.helper.setProxy(host, port, user_name, password)
return self
def setRetryCount(self, count):
"""
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
count - Number of retries.
return - The converter object.
"""
self.helper.setRetryCount(count)
return self
class ImageToPdfClient:
"""
Conversion from an image to PDF.
"""
def __init__(self, user_name, api_key):
"""
Constructor for the Pdfcrowd API client.
user_name - Your username at Pdfcrowd.
api_key - Your API key.
"""
self.helper = ConnectionHelper(user_name, api_key)
self.fields = {
'input_format': 'image',
'output_format': 'pdf'
}
self.file_id = 1
self.files = {}
self.raw_data = {}
def convertUrl(self, url):
"""
Convert an image.
url - The address of the image to convert. The supported protocols are http:// and https://.
return - Byte array containing the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrl", "image-to-pdf", 'The supported protocols are http:// and https://.', "convert_url"), 470);
self.fields['url'] = get_utf8_string(url)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertUrlToStream(self, url, out_stream):
"""
Convert an image and write the result to an output stream.
url - The address of the image to convert. The supported protocols are http:// and https://.
out_stream - The output stream that will contain the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrlToStream::url", "image-to-pdf", 'The supported protocols are http:// and https://.', "convert_url_to_stream"), 470);
self.fields['url'] = get_utf8_string(url)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertUrlToFile(self, url, file_path):
"""
Convert an image and write the result to a local file.
url - The address of the image to convert. The supported protocols are http:// and https://.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertUrlToFile::file_path", "image-to-pdf", 'The string must not be empty.', "convert_url_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertUrlToStream(url, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertFile(self, file):
"""
Convert a local file.
file - The path to a local file to convert. The file must exist and not be empty.
return - Byte array containing the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFile", "image-to-pdf", 'The file must exist and not be empty.', "convert_file"), 470);
self.files['file'] = get_utf8_string(file)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertFileToStream(self, file, out_stream):
"""
Convert a local file and write the result to an output stream.
file - The path to a local file to convert. The file must exist and not be empty.
out_stream - The output stream that will contain the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFileToStream::file", "image-to-pdf", 'The file must exist and not be empty.', "convert_file_to_stream"), 470);
self.files['file'] = get_utf8_string(file)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertFileToFile(self, file, file_path):
"""
Convert a local file and write the result to a local file.
file - The path to a local file to convert. The file must exist and not be empty.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertFileToFile::file_path", "image-to-pdf", 'The string must not be empty.', "convert_file_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertFileToStream(file, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertRawData(self, data):
"""
Convert raw data.
data - The raw content to be converted.
return - Byte array with the output.
"""
self.raw_data['file'] = data
return self.helper.post(self.fields, self.files, self.raw_data)
def convertRawDataToStream(self, data, out_stream):
"""
Convert raw data and write the result to an output stream.
data - The raw content to be converted.
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['file'] = data
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertRawDataToFile(self, data, file_path):
"""
Convert raw data to a file.
data - The raw content to be converted.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertRawDataToFile::file_path", "image-to-pdf", 'The string must not be empty.', "convert_raw_data_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertRawDataToStream(data, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertStream(self, in_stream):
"""
Convert the contents of an input stream.
in_stream - The input stream with source data.
return - Byte array containing the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
return self.helper.post(self.fields, self.files, self.raw_data)
def convertStreamToStream(self, in_stream, out_stream):
"""
Convert the contents of an input stream and write the result to an output stream.
in_stream - The input stream with source data.
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertStreamToFile(self, in_stream, file_path):
"""
Convert the contents of an input stream and write the result to a local file.
in_stream - The input stream with source data.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertStreamToFile::file_path", "image-to-pdf", 'The string must not be empty.', "convert_stream_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertStreamToStream(in_stream, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def setResize(self, resize):
"""
Resize the image.
resize - The resize percentage or new image dimensions.
return - The converter object.
"""
self.fields['resize'] = get_utf8_string(resize)
return self
def setRotate(self, rotate):
"""
Rotate the image.
rotate - The rotation specified in degrees.
return - The converter object.
"""
self.fields['rotate'] = get_utf8_string(rotate)
return self
def setCropAreaX(self, x):
"""
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
x - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', x):
raise Error(create_invalid_value_message(x, "setCropAreaX", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_crop_area_x"), 470);
self.fields['crop_area_x'] = get_utf8_string(x)
return self
def setCropAreaY(self, y):
"""
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
y - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', y):
raise Error(create_invalid_value_message(y, "setCropAreaY", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_crop_area_y"), 470);
self.fields['crop_area_y'] = get_utf8_string(y)
return self
def setCropAreaWidth(self, width):
"""
Set the width of the content area. It should be at least 1 inch.
width - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', width):
raise Error(create_invalid_value_message(width, "setCropAreaWidth", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_crop_area_width"), 470);
self.fields['crop_area_width'] = get_utf8_string(width)
return self
def setCropAreaHeight(self, height):
"""
Set the height of the content area. It should be at least 1 inch.
height - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', height):
raise Error(create_invalid_value_message(height, "setCropAreaHeight", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_crop_area_height"), 470);
self.fields['crop_area_height'] = get_utf8_string(height)
return self
def setCropArea(self, x, y, width, height):
"""
Set the content area position and size. The content area enables to specify the part to be converted.
x - Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
y - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
width - Set the width of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
height - Set the height of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
self.setCropAreaX(x)
self.setCropAreaY(y)
self.setCropAreaWidth(width)
self.setCropAreaHeight(height)
return self
def setRemoveBorders(self, value):
"""
Remove borders of an image which does not change in color.
value - Set to True to remove borders.
return - The converter object.
"""
self.fields['remove_borders'] = value
return self
def setPageSize(self, size):
"""
Set the output page size.
size - Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.
return - The converter object.
"""
if not re.match('(?i)^(A0|A1|A2|A3|A4|A5|A6|Letter)$', size):
raise Error(create_invalid_value_message(size, "setPageSize", "image-to-pdf", 'Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.', "set_page_size"), 470);
self.fields['page_size'] = get_utf8_string(size)
return self
def setPageWidth(self, width):
"""
Set the output page width.
width - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', width):
raise Error(create_invalid_value_message(width, "setPageWidth", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_page_width"), 470);
self.fields['page_width'] = get_utf8_string(width)
return self
def setPageHeight(self, height):
"""
Set the output page height.
height - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', height):
raise Error(create_invalid_value_message(height, "setPageHeight", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_page_height"), 470);
self.fields['page_height'] = get_utf8_string(height)
return self
def setPageDimensions(self, width, height):
"""
Set the output page dimensions. If no page size is specified, margins are applied as a border around the image.
width - Set the output page width. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
height - Set the output page height. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
self.setPageWidth(width)
self.setPageHeight(height)
return self
def setOrientation(self, orientation):
"""
Set the output page orientation.
orientation - Allowed values are landscape, portrait.
return - The converter object.
"""
if not re.match('(?i)^(landscape|portrait)$', orientation):
raise Error(create_invalid_value_message(orientation, "setOrientation", "image-to-pdf", 'Allowed values are landscape, portrait.', "set_orientation"), 470);
self.fields['orientation'] = get_utf8_string(orientation)
return self
def setPosition(self, position):
"""
Set the image position on the page.
position - Allowed values are center, top, bottom, left, right, top-left, top-right, bottom-left, bottom-right.
return - The converter object.
"""
if not re.match('(?i)^(center|top|bottom|left|right|top-left|top-right|bottom-left|bottom-right)$', position):
raise Error(create_invalid_value_message(position, "setPosition", "image-to-pdf", 'Allowed values are center, top, bottom, left, right, top-left, top-right, bottom-left, bottom-right.', "set_position"), 470);
self.fields['position'] = get_utf8_string(position)
return self
def setPrintPageMode(self, mode):
"""
Set the mode to print the image on the content area of the page.
mode - Allowed values are default, fit, stretch.
return - The converter object.
"""
if not re.match('(?i)^(default|fit|stretch)$', mode):
raise Error(create_invalid_value_message(mode, "setPrintPageMode", "image-to-pdf", 'Allowed values are default, fit, stretch.', "set_print_page_mode"), 470);
self.fields['print_page_mode'] = get_utf8_string(mode)
return self
def setMarginTop(self, top):
"""
Set the output page top margin.
top - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', top):
raise Error(create_invalid_value_message(top, "setMarginTop", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_top"), 470);
self.fields['margin_top'] = get_utf8_string(top)
return self
def setMarginRight(self, right):
"""
Set the output page right margin.
right - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', right):
raise Error(create_invalid_value_message(right, "setMarginRight", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_right"), 470);
self.fields['margin_right'] = get_utf8_string(right)
return self
def setMarginBottom(self, bottom):
"""
Set the output page bottom margin.
bottom - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', bottom):
raise Error(create_invalid_value_message(bottom, "setMarginBottom", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_bottom"), 470);
self.fields['margin_bottom'] = get_utf8_string(bottom)
return self
def setMarginLeft(self, left):
"""
Set the output page left margin.
left - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$', left):
raise Error(create_invalid_value_message(left, "setMarginLeft", "image-to-pdf", 'The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".', "set_margin_left"), 470);
self.fields['margin_left'] = get_utf8_string(left)
return self
def setPageMargins(self, top, right, bottom, left):
"""
Set the output page margins.
top - Set the output page top margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
right - Set the output page right margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
bottom - Set the output page bottom margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
left - Set the output page left margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
return - The converter object.
"""
self.setMarginTop(top)
self.setMarginRight(right)
self.setMarginBottom(bottom)
self.setMarginLeft(left)
return self
def setPageBackgroundColor(self, color):
"""
The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins. If not page size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.
color - The value must be in RRGGBB or RRGGBBAA hexadecimal format.
return - The converter object.
"""
if not re.match('^[0-9a-fA-F]{6,8}$', color):
raise Error(create_invalid_value_message(color, "setPageBackgroundColor", "image-to-pdf", 'The value must be in RRGGBB or RRGGBBAA hexadecimal format.', "set_page_background_color"), 470);
self.fields['page_background_color'] = get_utf8_string(color)
return self
def setDpi(self, dpi):
"""
Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).
dpi - The DPI value.
return - The converter object.
"""
self.fields['dpi'] = dpi
return self
def setPageWatermark(self, watermark):
"""
Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
watermark - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(watermark) and os.path.getsize(watermark)):
raise Error(create_invalid_value_message(watermark, "setPageWatermark", "image-to-pdf", 'The file must exist and not be empty.', "set_page_watermark"), 470);
self.files['page_watermark'] = get_utf8_string(watermark)
return self
def setPageWatermarkUrl(self, url):
"""
Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setPageWatermarkUrl", "image-to-pdf", 'The supported protocols are http:// and https://.', "set_page_watermark_url"), 470);
self.fields['page_watermark_url'] = get_utf8_string(url)
return self
def setMultipageWatermark(self, watermark):
"""
Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
watermark - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(watermark) and os.path.getsize(watermark)):
raise Error(create_invalid_value_message(watermark, "setMultipageWatermark", "image-to-pdf", 'The file must exist and not be empty.', "set_multipage_watermark"), 470);
self.files['multipage_watermark'] = get_utf8_string(watermark)
return self
def setMultipageWatermarkUrl(self, url):
"""
Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setMultipageWatermarkUrl", "image-to-pdf", 'The supported protocols are http:// and https://.', "set_multipage_watermark_url"), 470);
self.fields['multipage_watermark_url'] = get_utf8_string(url)
return self
def setPageBackground(self, background):
"""
Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
background - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(background) and os.path.getsize(background)):
raise Error(create_invalid_value_message(background, "setPageBackground", "image-to-pdf", 'The file must exist and not be empty.', "set_page_background"), 470);
self.files['page_background'] = get_utf8_string(background)
return self
def setPageBackgroundUrl(self, url):
"""
Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setPageBackgroundUrl", "image-to-pdf", 'The supported protocols are http:// and https://.', "set_page_background_url"), 470);
self.fields['page_background_url'] = get_utf8_string(url)
return self
def setMultipageBackground(self, background):
"""
Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
background - The file path to a local file. The file must exist and not be empty.
return - The converter object.
"""
if not (os.path.isfile(background) and os.path.getsize(background)):
raise Error(create_invalid_value_message(background, "setMultipageBackground", "image-to-pdf", 'The file must exist and not be empty.', "set_multipage_background"), 470);
self.files['multipage_background'] = get_utf8_string(background)
return self
def setMultipageBackgroundUrl(self, url):
"""
Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
url - The supported protocols are http:// and https://.
return - The converter object.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "setMultipageBackgroundUrl", "image-to-pdf", 'The supported protocols are http:// and https://.', "set_multipage_background_url"), 470);
self.fields['multipage_background_url'] = get_utf8_string(url)
return self
def setLinearize(self, value):
"""
Create linearized PDF. This is also known as Fast Web View.
value - Set to True to create linearized PDF.
return - The converter object.
"""
self.fields['linearize'] = value
return self
def setEncrypt(self, value):
"""
Encrypt the PDF. This prevents search engines from indexing the contents.
value - Set to True to enable PDF encryption.
return - The converter object.
"""
self.fields['encrypt'] = value
return self
def setUserPassword(self, password):
"""
Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.
password - The user password.
return - The converter object.
"""
self.fields['user_password'] = get_utf8_string(password)
return self
def setOwnerPassword(self, password):
"""
Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.
password - The owner password.
return - The converter object.
"""
self.fields['owner_password'] = get_utf8_string(password)
return self
def setNoPrint(self, value):
"""
Disallow printing of the output PDF.
value - Set to True to set the no-print flag in the output PDF.
return - The converter object.
"""
self.fields['no_print'] = value
return self
def setNoModify(self, value):
"""
Disallow modification of the output PDF.
value - Set to True to set the read-only only flag in the output PDF.
return - The converter object.
"""
self.fields['no_modify'] = value
return self
def setNoCopy(self, value):
"""
Disallow text and graphics extraction from the output PDF.
value - Set to True to set the no-copy flag in the output PDF.
return - The converter object.
"""
self.fields['no_copy'] = value
return self
def setTitle(self, title):
"""
Set the title of the PDF.
title - The title.
return - The converter object.
"""
self.fields['title'] = get_utf8_string(title)
return self
def setSubject(self, subject):
"""
Set the subject of the PDF.
subject - The subject.
return - The converter object.
"""
self.fields['subject'] = get_utf8_string(subject)
return self
def setAuthor(self, author):
"""
Set the author of the PDF.
author - The author.
return - The converter object.
"""
self.fields['author'] = get_utf8_string(author)
return self
def setKeywords(self, keywords):
"""
Associate keywords with the document.
keywords - The string with the keywords.
return - The converter object.
"""
self.fields['keywords'] = get_utf8_string(keywords)
return self
def setPageLayout(self, layout):
"""
Specify the page layout to be used when the document is opened.
layout - Allowed values are single-page, one-column, two-column-left, two-column-right.
return - The converter object.
"""
if not re.match('(?i)^(single-page|one-column|two-column-left|two-column-right)$', layout):
raise Error(create_invalid_value_message(layout, "setPageLayout", "image-to-pdf", 'Allowed values are single-page, one-column, two-column-left, two-column-right.', "set_page_layout"), 470);
self.fields['page_layout'] = get_utf8_string(layout)
return self
def setPageMode(self, mode):
"""
Specify how the document should be displayed when opened.
mode - Allowed values are full-screen, thumbnails, outlines.
return - The converter object.
"""
if not re.match('(?i)^(full-screen|thumbnails|outlines)$', mode):
raise Error(create_invalid_value_message(mode, "setPageMode", "image-to-pdf", 'Allowed values are full-screen, thumbnails, outlines.', "set_page_mode"), 470);
self.fields['page_mode'] = get_utf8_string(mode)
return self
def setInitialZoomType(self, zoom_type):
"""
Specify how the page should be displayed when opened.
zoom_type - Allowed values are fit-width, fit-height, fit-page.
return - The converter object.
"""
if not re.match('(?i)^(fit-width|fit-height|fit-page)$', zoom_type):
raise Error(create_invalid_value_message(zoom_type, "setInitialZoomType", "image-to-pdf", 'Allowed values are fit-width, fit-height, fit-page.', "set_initial_zoom_type"), 470);
self.fields['initial_zoom_type'] = get_utf8_string(zoom_type)
return self
def setInitialPage(self, page):
"""
Display the specified page when the document is opened.
page - Must be a positive integer number.
return - The converter object.
"""
if not (int(page) > 0):
raise Error(create_invalid_value_message(page, "setInitialPage", "image-to-pdf", 'Must be a positive integer number.', "set_initial_page"), 470);
self.fields['initial_page'] = page
return self
def setInitialZoom(self, zoom):
"""
Specify the initial page zoom in percents when the document is opened.
zoom - Must be a positive integer number.
return - The converter object.
"""
if not (int(zoom) > 0):
raise Error(create_invalid_value_message(zoom, "setInitialZoom", "image-to-pdf", 'Must be a positive integer number.', "set_initial_zoom"), 470);
self.fields['initial_zoom'] = zoom
return self
def setHideToolbar(self, value):
"""
Specify whether to hide the viewer application's tool bars when the document is active.
value - Set to True to hide tool bars.
return - The converter object.
"""
self.fields['hide_toolbar'] = value
return self
def setHideMenubar(self, value):
"""
Specify whether to hide the viewer application's menu bar when the document is active.
value - Set to True to hide the menu bar.
return - The converter object.
"""
self.fields['hide_menubar'] = value
return self
def setHideWindowUi(self, value):
"""
Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
value - Set to True to hide ui elements.
return - The converter object.
"""
self.fields['hide_window_ui'] = value
return self
def setFitWindow(self, value):
"""
Specify whether to resize the document's window to fit the size of the first displayed page.
value - Set to True to resize the window.
return - The converter object.
"""
self.fields['fit_window'] = value
return self
def setCenterWindow(self, value):
"""
Specify whether to position the document's window in the center of the screen.
value - Set to True to center the window.
return - The converter object.
"""
self.fields['center_window'] = value
return self
def setDisplayTitle(self, value):
"""
Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.
value - Set to True to display the title.
return - The converter object.
"""
self.fields['display_title'] = value
return self
def setDebugLog(self, value):
"""
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
value - Set to True to enable the debug logging.
return - The converter object.
"""
self.fields['debug_log'] = value
return self
def getDebugLogUrl(self):
"""
Get the URL of the debug log for the last conversion.
return - The link to the debug log.
"""
return self.helper.getDebugLogUrl()
def getRemainingCreditCount(self):
"""
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
return - The number of credits.
"""
return self.helper.getRemainingCreditCount()
def getConsumedCreditCount(self):
"""
Get the number of credits consumed by the last conversion.
return - The number of credits.
"""
return self.helper.getConsumedCreditCount()
def getJobId(self):
"""
Get the job id.
return - The unique job identifier.
"""
return self.helper.getJobId()
def getOutputSize(self):
"""
Get the size of the output in bytes.
return - The count of bytes.
"""
return self.helper.getOutputSize()
def getVersion(self):
"""
Get the version details.
return - API version, converter version, and client version.
"""
return 'client {}, API v2, converter {}'.format(CLIENT_VERSION, self.helper.getConverterVersion())
def setTag(self, tag):
"""
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag - A string with the custom tag.
return - The converter object.
"""
self.fields['tag'] = get_utf8_string(tag)
return self
def setHttpProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpProxy", "image-to-pdf", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_http_proxy"), 470);
self.fields['http_proxy'] = get_utf8_string(proxy)
return self
def setHttpsProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpsProxy", "image-to-pdf", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_https_proxy"), 470);
self.fields['https_proxy'] = get_utf8_string(proxy)
return self
def setConverterVersion(self, version):
"""
Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
version - The version identifier. Allowed values are latest, 20.10, 18.10.
return - The converter object.
"""
if not re.match('(?i)^(latest|20.10|18.10)$', version):
raise Error(create_invalid_value_message(version, "setConverterVersion", "image-to-pdf", 'Allowed values are latest, 20.10, 18.10.', "set_converter_version"), 470);
self.helper.setConverterVersion(version)
return self
def setUseHttp(self, value):
"""
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
value - Set to True to use HTTP.
return - The converter object.
"""
self.helper.setUseHttp(value)
return self
def setUserAgent(self, agent):
"""
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent - The user agent string.
return - The converter object.
"""
self.helper.setUserAgent(agent)
return self
def setProxy(self, host, port, user_name, password):
"""
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host - The proxy hostname.
port - The proxy port.
user_name - The username.
password - The password.
return - The converter object.
"""
self.helper.setProxy(host, port, user_name, password)
return self
def setRetryCount(self, count):
"""
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
count - Number of retries.
return - The converter object.
"""
self.helper.setRetryCount(count)
return self
class PdfToHtmlClient:
"""
Conversion from PDF to HTML.
"""
def __init__(self, user_name, api_key):
"""
Constructor for the Pdfcrowd API client.
user_name - Your username at Pdfcrowd.
api_key - Your API key.
"""
self.helper = ConnectionHelper(user_name, api_key)
self.fields = {
'input_format': 'pdf',
'output_format': 'html'
}
self.file_id = 1
self.files = {}
self.raw_data = {}
def convertUrl(self, url):
"""
Convert a PDF.
url - The address of the PDF to convert. The supported protocols are http:// and https://.
return - Byte array containing the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrl", "pdf-to-html", 'The supported protocols are http:// and https://.', "convert_url"), 470);
self.fields['url'] = get_utf8_string(url)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertUrlToStream(self, url, out_stream):
"""
Convert a PDF and write the result to an output stream.
url - The address of the PDF to convert. The supported protocols are http:// and https://.
out_stream - The output stream that will contain the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrlToStream::url", "pdf-to-html", 'The supported protocols are http:// and https://.', "convert_url_to_stream"), 470);
self.fields['url'] = get_utf8_string(url)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertUrlToFile(self, url, file_path):
"""
Convert a PDF and write the result to a local file.
url - The address of the PDF to convert. The supported protocols are http:// and https://.
file_path - The output file path. The string must not be empty. The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertUrlToFile::file_path", "pdf-to-html", 'The string must not be empty.', "convert_url_to_file"), 470);
if not (self._isOutputTypeValid(file_path)):
raise Error(create_invalid_value_message(file_path, "convertUrlToFile::file_path", "pdf-to-html", 'The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.', "convert_url_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertUrlToStream(url, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertFile(self, file):
"""
Convert a local file.
file - The path to a local file to convert. The file must exist and not be empty.
return - Byte array containing the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFile", "pdf-to-html", 'The file must exist and not be empty.', "convert_file"), 470);
self.files['file'] = get_utf8_string(file)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertFileToStream(self, file, out_stream):
"""
Convert a local file and write the result to an output stream.
file - The path to a local file to convert. The file must exist and not be empty.
out_stream - The output stream that will contain the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFileToStream::file", "pdf-to-html", 'The file must exist and not be empty.', "convert_file_to_stream"), 470);
self.files['file'] = get_utf8_string(file)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertFileToFile(self, file, file_path):
"""
Convert a local file and write the result to a local file.
file - The path to a local file to convert. The file must exist and not be empty.
file_path - The output file path. The string must not be empty. The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertFileToFile::file_path", "pdf-to-html", 'The string must not be empty.', "convert_file_to_file"), 470);
if not (self._isOutputTypeValid(file_path)):
raise Error(create_invalid_value_message(file_path, "convertFileToFile::file_path", "pdf-to-html", 'The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.', "convert_file_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertFileToStream(file, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertRawData(self, data):
"""
Convert raw data.
data - The raw content to be converted.
return - Byte array with the output.
"""
self.raw_data['file'] = data
return self.helper.post(self.fields, self.files, self.raw_data)
def convertRawDataToStream(self, data, out_stream):
"""
Convert raw data and write the result to an output stream.
data - The raw content to be converted.
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['file'] = data
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertRawDataToFile(self, data, file_path):
"""
Convert raw data to a file.
data - The raw content to be converted.
file_path - The output file path. The string must not be empty. The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertRawDataToFile::file_path", "pdf-to-html", 'The string must not be empty.', "convert_raw_data_to_file"), 470);
if not (self._isOutputTypeValid(file_path)):
raise Error(create_invalid_value_message(file_path, "convertRawDataToFile::file_path", "pdf-to-html", 'The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.', "convert_raw_data_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertRawDataToStream(data, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertStream(self, in_stream):
"""
Convert the contents of an input stream.
in_stream - The input stream with source data.
return - Byte array containing the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
return self.helper.post(self.fields, self.files, self.raw_data)
def convertStreamToStream(self, in_stream, out_stream):
"""
Convert the contents of an input stream and write the result to an output stream.
in_stream - The input stream with source data.
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertStreamToFile(self, in_stream, file_path):
"""
Convert the contents of an input stream and write the result to a local file.
in_stream - The input stream with source data.
file_path - The output file path. The string must not be empty. The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertStreamToFile::file_path", "pdf-to-html", 'The string must not be empty.', "convert_stream_to_file"), 470);
if not (self._isOutputTypeValid(file_path)):
raise Error(create_invalid_value_message(file_path, "convertStreamToFile::file_path", "pdf-to-html", 'The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.', "convert_stream_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertStreamToStream(in_stream, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def setPdfPassword(self, password):
"""
Password to open the encrypted PDF file.
password - The input PDF password.
return - The converter object.
"""
self.fields['pdf_password'] = get_utf8_string(password)
return self
def setScaleFactor(self, factor):
"""
Set the scaling factor (zoom) for the main page area.
factor - The percentage value. Must be a positive integer number.
return - The converter object.
"""
if not (int(factor) > 0):
raise Error(create_invalid_value_message(factor, "setScaleFactor", "pdf-to-html", 'Must be a positive integer number.', "set_scale_factor"), 470);
self.fields['scale_factor'] = factor
return self
def setPrintPageRange(self, pages):
"""
Set the page range to print.
pages - A comma separated list of page numbers or ranges.
return - The converter object.
"""
if not re.match('^(?:\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*,\s*)*\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*$', pages):
raise Error(create_invalid_value_message(pages, "setPrintPageRange", "pdf-to-html", 'A comma separated list of page numbers or ranges.', "set_print_page_range"), 470);
self.fields['print_page_range'] = get_utf8_string(pages)
return self
def setDpi(self, dpi):
"""
Set the output graphics DPI.
dpi - The DPI value.
return - The converter object.
"""
self.fields['dpi'] = dpi
return self
def setImageMode(self, mode):
"""
Specifies where the images are stored.
mode - The image storage mode. Allowed values are embed, separate, none.
return - The converter object.
"""
if not re.match('(?i)^(embed|separate|none)$', mode):
raise Error(create_invalid_value_message(mode, "setImageMode", "pdf-to-html", 'Allowed values are embed, separate, none.', "set_image_mode"), 470);
self.fields['image_mode'] = get_utf8_string(mode)
return self
def setImageFormat(self, image_format):
"""
Specifies the format for the output images.
image_format - The image format. Allowed values are png, jpg, svg.
return - The converter object.
"""
if not re.match('(?i)^(png|jpg|svg)$', image_format):
raise Error(create_invalid_value_message(image_format, "setImageFormat", "pdf-to-html", 'Allowed values are png, jpg, svg.', "set_image_format"), 470);
self.fields['image_format'] = get_utf8_string(image_format)
return self
def setCssMode(self, mode):
"""
Specifies where the style sheets are stored.
mode - The style sheet storage mode. Allowed values are embed, separate.
return - The converter object.
"""
if not re.match('(?i)^(embed|separate)$', mode):
raise Error(create_invalid_value_message(mode, "setCssMode", "pdf-to-html", 'Allowed values are embed, separate.', "set_css_mode"), 470);
self.fields['css_mode'] = get_utf8_string(mode)
return self
def setFontMode(self, mode):
"""
Specifies where the fonts are stored.
mode - The font storage mode. Allowed values are embed, separate.
return - The converter object.
"""
if not re.match('(?i)^(embed|separate)$', mode):
raise Error(create_invalid_value_message(mode, "setFontMode", "pdf-to-html", 'Allowed values are embed, separate.', "set_font_mode"), 470);
self.fields['font_mode'] = get_utf8_string(mode)
return self
def setSplitLigatures(self, value):
"""
Converts ligatures, two or more letters combined into a single glyph, back into their individual ASCII characters.
value - Set to True to split ligatures.
return - The converter object.
"""
self.fields['split_ligatures'] = value
return self
def isZippedOutput(self):
"""
A helper method to determine if the output file is a zip archive. The output of the conversion may be either an HTML file or a zip file containing the HTML and its external assets.
return - True if the conversion output is a zip file, otherwise False.
"""
return self.fields.get('image_mode') == 'separate' or self.fields.get('css_mode') == 'separate' or self.fields.get('font_mode') == 'separate' or self.fields.get('force_zip') == True
def setForceZip(self, value):
"""
Enforces the zip output format.
value - Set to True to get the output as a zip archive.
return - The converter object.
"""
self.fields['force_zip'] = value
return self
def setTitle(self, title):
"""
Set the HTML title. The title from the input PDF is used by default.
title - The HTML title.
return - The converter object.
"""
self.fields['title'] = get_utf8_string(title)
return self
def setSubject(self, subject):
"""
Set the HTML subject. The subject from the input PDF is used by default.
subject - The HTML subject.
return - The converter object.
"""
self.fields['subject'] = get_utf8_string(subject)
return self
def setAuthor(self, author):
"""
Set the HTML author. The author from the input PDF is used by default.
author - The HTML author.
return - The converter object.
"""
self.fields['author'] = get_utf8_string(author)
return self
def setKeywords(self, keywords):
"""
Associate keywords with the HTML document. Keywords from the input PDF are used by default.
keywords - The string containing the keywords.
return - The converter object.
"""
self.fields['keywords'] = get_utf8_string(keywords)
return self
def setDebugLog(self, value):
"""
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
value - Set to True to enable the debug logging.
return - The converter object.
"""
self.fields['debug_log'] = value
return self
def getDebugLogUrl(self):
"""
Get the URL of the debug log for the last conversion.
return - The link to the debug log.
"""
return self.helper.getDebugLogUrl()
def getRemainingCreditCount(self):
"""
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
return - The number of credits.
"""
return self.helper.getRemainingCreditCount()
def getConsumedCreditCount(self):
"""
Get the number of credits consumed by the last conversion.
return - The number of credits.
"""
return self.helper.getConsumedCreditCount()
def getJobId(self):
"""
Get the job id.
return - The unique job identifier.
"""
return self.helper.getJobId()
def getPageCount(self):
"""
Get the number of pages in the output document.
return - The page count.
"""
return self.helper.getPageCount()
def getOutputSize(self):
"""
Get the size of the output in bytes.
return - The count of bytes.
"""
return self.helper.getOutputSize()
def getVersion(self):
"""
Get the version details.
return - API version, converter version, and client version.
"""
return 'client {}, API v2, converter {}'.format(CLIENT_VERSION, self.helper.getConverterVersion())
def setTag(self, tag):
"""
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag - A string with the custom tag.
return - The converter object.
"""
self.fields['tag'] = get_utf8_string(tag)
return self
def setHttpProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpProxy", "pdf-to-html", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_http_proxy"), 470);
self.fields['http_proxy'] = get_utf8_string(proxy)
return self
def setHttpsProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpsProxy", "pdf-to-html", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_https_proxy"), 470);
self.fields['https_proxy'] = get_utf8_string(proxy)
return self
def setUseHttp(self, value):
"""
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
value - Set to True to use HTTP.
return - The converter object.
"""
self.helper.setUseHttp(value)
return self
def setUserAgent(self, agent):
"""
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent - The user agent string.
return - The converter object.
"""
self.helper.setUserAgent(agent)
return self
def setProxy(self, host, port, user_name, password):
"""
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host - The proxy hostname.
port - The proxy port.
user_name - The username.
password - The password.
return - The converter object.
"""
self.helper.setProxy(host, port, user_name, password)
return self
def setRetryCount(self, count):
"""
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
count - Number of retries.
return - The converter object.
"""
self.helper.setRetryCount(count)
return self
def _isOutputTypeValid(self, file_path):
extension = os.path.splitext(file_path)[1].lower()
return (extension == '.zip') == self.isZippedOutput()
class PdfToTextClient:
"""
Conversion from PDF to text.
"""
def __init__(self, user_name, api_key):
"""
Constructor for the Pdfcrowd API client.
user_name - Your username at Pdfcrowd.
api_key - Your API key.
"""
self.helper = ConnectionHelper(user_name, api_key)
self.fields = {
'input_format': 'pdf',
'output_format': 'txt'
}
self.file_id = 1
self.files = {}
self.raw_data = {}
def convertUrl(self, url):
"""
Convert a PDF.
url - The address of the PDF to convert. The supported protocols are http:// and https://.
return - Byte array containing the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrl", "pdf-to-text", 'The supported protocols are http:// and https://.', "convert_url"), 470);
self.fields['url'] = get_utf8_string(url)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertUrlToStream(self, url, out_stream):
"""
Convert a PDF and write the result to an output stream.
url - The address of the PDF to convert. The supported protocols are http:// and https://.
out_stream - The output stream that will contain the conversion output.
"""
if not re.match('(?i)^https?://.*$', url):
raise Error(create_invalid_value_message(url, "convertUrlToStream::url", "pdf-to-text", 'The supported protocols are http:// and https://.', "convert_url_to_stream"), 470);
self.fields['url'] = get_utf8_string(url)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertUrlToFile(self, url, file_path):
"""
Convert a PDF and write the result to a local file.
url - The address of the PDF to convert. The supported protocols are http:// and https://.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertUrlToFile::file_path", "pdf-to-text", 'The string must not be empty.', "convert_url_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertUrlToStream(url, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertFile(self, file):
"""
Convert a local file.
file - The path to a local file to convert. The file must exist and not be empty.
return - Byte array containing the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFile", "pdf-to-text", 'The file must exist and not be empty.', "convert_file"), 470);
self.files['file'] = get_utf8_string(file)
return self.helper.post(self.fields, self.files, self.raw_data)
def convertFileToStream(self, file, out_stream):
"""
Convert a local file and write the result to an output stream.
file - The path to a local file to convert. The file must exist and not be empty.
out_stream - The output stream that will contain the conversion output.
"""
if not (os.path.isfile(file) and os.path.getsize(file)):
raise Error(create_invalid_value_message(file, "convertFileToStream::file", "pdf-to-text", 'The file must exist and not be empty.', "convert_file_to_stream"), 470);
self.files['file'] = get_utf8_string(file)
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertFileToFile(self, file, file_path):
"""
Convert a local file and write the result to a local file.
file - The path to a local file to convert. The file must exist and not be empty.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertFileToFile::file_path", "pdf-to-text", 'The string must not be empty.', "convert_file_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertFileToStream(file, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertRawData(self, data):
"""
Convert raw data.
data - The raw content to be converted.
return - Byte array with the output.
"""
self.raw_data['file'] = data
return self.helper.post(self.fields, self.files, self.raw_data)
def convertRawDataToStream(self, data, out_stream):
"""
Convert raw data and write the result to an output stream.
data - The raw content to be converted.
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['file'] = data
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertRawDataToFile(self, data, file_path):
"""
Convert raw data to a file.
data - The raw content to be converted.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertRawDataToFile::file_path", "pdf-to-text", 'The string must not be empty.', "convert_raw_data_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertRawDataToStream(data, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def convertStream(self, in_stream):
"""
Convert the contents of an input stream.
in_stream - The input stream with source data.
return - Byte array containing the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
return self.helper.post(self.fields, self.files, self.raw_data)
def convertStreamToStream(self, in_stream, out_stream):
"""
Convert the contents of an input stream and write the result to an output stream.
in_stream - The input stream with source data.
out_stream - The output stream that will contain the conversion output.
"""
self.raw_data['stream'] = in_stream.read()
self.helper.post(self.fields, self.files, self.raw_data, out_stream)
def convertStreamToFile(self, in_stream, file_path):
"""
Convert the contents of an input stream and write the result to a local file.
in_stream - The input stream with source data.
file_path - The output file path. The string must not be empty.
"""
if not (file_path):
raise Error(create_invalid_value_message(file_path, "convertStreamToFile::file_path", "pdf-to-text", 'The string must not be empty.', "convert_stream_to_file"), 470);
output_file = open(file_path, 'wb')
try:
self.convertStreamToStream(in_stream, output_file)
output_file.close()
except Error:
output_file.close()
os.remove(file_path)
raise
def setPdfPassword(self, password):
"""
The password to open the encrypted PDF file.
password - The input PDF password.
return - The converter object.
"""
self.fields['pdf_password'] = get_utf8_string(password)
return self
def setPrintPageRange(self, pages):
"""
Set the page range to print.
pages - A comma separated list of page numbers or ranges.
return - The converter object.
"""
if not re.match('^(?:\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*,\s*)*\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*$', pages):
raise Error(create_invalid_value_message(pages, "setPrintPageRange", "pdf-to-text", 'A comma separated list of page numbers or ranges.', "set_print_page_range"), 470);
self.fields['print_page_range'] = get_utf8_string(pages)
return self
def setNoLayout(self, value):
"""
Ignore the original PDF layout.
value - Set to True to ignore the layout.
return - The converter object.
"""
self.fields['no_layout'] = value
return self
def setEol(self, eol):
"""
The end-of-line convention for the text output.
eol - Allowed values are unix, dos, mac.
return - The converter object.
"""
if not re.match('(?i)^(unix|dos|mac)$', eol):
raise Error(create_invalid_value_message(eol, "setEol", "pdf-to-text", 'Allowed values are unix, dos, mac.', "set_eol"), 470);
self.fields['eol'] = get_utf8_string(eol)
return self
def setPageBreakMode(self, mode):
"""
Specify the page break mode for the text output.
mode - Allowed values are none, default, custom.
return - The converter object.
"""
if not re.match('(?i)^(none|default|custom)$', mode):
raise Error(create_invalid_value_message(mode, "setPageBreakMode", "pdf-to-text", 'Allowed values are none, default, custom.', "set_page_break_mode"), 470);
self.fields['page_break_mode'] = get_utf8_string(mode)
return self
def setCustomPageBreak(self, page_break):
"""
Specify the custom page break.
page_break - String to insert between the pages.
return - The converter object.
"""
self.fields['custom_page_break'] = get_utf8_string(page_break)
return self
def setParagraphMode(self, mode):
"""
Specify the paragraph detection mode.
mode - Allowed values are none, bounding-box, characters.
return - The converter object.
"""
if not re.match('(?i)^(none|bounding-box|characters)$', mode):
raise Error(create_invalid_value_message(mode, "setParagraphMode", "pdf-to-text", 'Allowed values are none, bounding-box, characters.', "set_paragraph_mode"), 470);
self.fields['paragraph_mode'] = get_utf8_string(mode)
return self
def setLineSpacingThreshold(self, threshold):
"""
Set the maximum line spacing when the paragraph detection mode is enabled.
threshold - The value must be a positive integer percentage.
return - The converter object.
"""
if not re.match('(?i)^0$|^[0-9]+%$', threshold):
raise Error(create_invalid_value_message(threshold, "setLineSpacingThreshold", "pdf-to-text", 'The value must be a positive integer percentage.', "set_line_spacing_threshold"), 470);
self.fields['line_spacing_threshold'] = get_utf8_string(threshold)
return self
def setRemoveHyphenation(self, value):
"""
Remove the hyphen character from the end of lines.
value - Set to True to remove hyphens.
return - The converter object.
"""
self.fields['remove_hyphenation'] = value
return self
def setRemoveEmptyLines(self, value):
"""
Remove empty lines from the text output.
value - Set to True to remove empty lines.
return - The converter object.
"""
self.fields['remove_empty_lines'] = value
return self
def setCropAreaX(self, x):
"""
Set the top left X coordinate of the crop area in points.
x - Must be a positive integer number or 0.
return - The converter object.
"""
if not (int(x) >= 0):
raise Error(create_invalid_value_message(x, "setCropAreaX", "pdf-to-text", 'Must be a positive integer number or 0.', "set_crop_area_x"), 470);
self.fields['crop_area_x'] = x
return self
def setCropAreaY(self, y):
"""
Set the top left Y coordinate of the crop area in points.
y - Must be a positive integer number or 0.
return - The converter object.
"""
if not (int(y) >= 0):
raise Error(create_invalid_value_message(y, "setCropAreaY", "pdf-to-text", 'Must be a positive integer number or 0.', "set_crop_area_y"), 470);
self.fields['crop_area_y'] = y
return self
def setCropAreaWidth(self, width):
"""
Set the width of the crop area in points.
width - Must be a positive integer number or 0.
return - The converter object.
"""
if not (int(width) >= 0):
raise Error(create_invalid_value_message(width, "setCropAreaWidth", "pdf-to-text", 'Must be a positive integer number or 0.', "set_crop_area_width"), 470);
self.fields['crop_area_width'] = width
return self
def setCropAreaHeight(self, height):
"""
Set the height of the crop area in points.
height - Must be a positive integer number or 0.
return - The converter object.
"""
if not (int(height) >= 0):
raise Error(create_invalid_value_message(height, "setCropAreaHeight", "pdf-to-text", 'Must be a positive integer number or 0.', "set_crop_area_height"), 470);
self.fields['crop_area_height'] = height
return self
def setCropArea(self, x, y, width, height):
"""
Set the crop area. It allows to extract just a part of a PDF page.
x - Set the top left X coordinate of the crop area in points. Must be a positive integer number or 0.
y - Set the top left Y coordinate of the crop area in points. Must be a positive integer number or 0.
width - Set the width of the crop area in points. Must be a positive integer number or 0.
height - Set the height of the crop area in points. Must be a positive integer number or 0.
return - The converter object.
"""
self.setCropAreaX(x)
self.setCropAreaY(y)
self.setCropAreaWidth(width)
self.setCropAreaHeight(height)
return self
def setDebugLog(self, value):
"""
Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
value - Set to True to enable the debug logging.
return - The converter object.
"""
self.fields['debug_log'] = value
return self
def getDebugLogUrl(self):
"""
Get the URL of the debug log for the last conversion.
return - The link to the debug log.
"""
return self.helper.getDebugLogUrl()
def getRemainingCreditCount(self):
"""
Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.
return - The number of credits.
"""
return self.helper.getRemainingCreditCount()
def getConsumedCreditCount(self):
"""
Get the number of credits consumed by the last conversion.
return - The number of credits.
"""
return self.helper.getConsumedCreditCount()
def getJobId(self):
"""
Get the job id.
return - The unique job identifier.
"""
return self.helper.getJobId()
def getPageCount(self):
"""
Get the number of pages in the output document.
return - The page count.
"""
return self.helper.getPageCount()
def getOutputSize(self):
"""
Get the size of the output in bytes.
return - The count of bytes.
"""
return self.helper.getOutputSize()
def getVersion(self):
"""
Get the version details.
return - API version, converter version, and client version.
"""
return 'client {}, API v2, converter {}'.format(CLIENT_VERSION, self.helper.getConverterVersion())
def setTag(self, tag):
"""
Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.
tag - A string with the custom tag.
return - The converter object.
"""
self.fields['tag'] = get_utf8_string(tag)
return self
def setHttpProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpProxy", "pdf-to-text", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_http_proxy"), 470);
self.fields['http_proxy'] = get_utf8_string(proxy)
return self
def setHttpsProxy(self, proxy):
"""
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
return - The converter object.
"""
if not re.match('(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$', proxy):
raise Error(create_invalid_value_message(proxy, "setHttpsProxy", "pdf-to-text", 'The value must have format DOMAIN_OR_IP_ADDRESS:PORT.', "set_https_proxy"), 470);
self.fields['https_proxy'] = get_utf8_string(proxy)
return self
def setUseHttp(self, value):
"""
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
value - Set to True to use HTTP.
return - The converter object.
"""
self.helper.setUseHttp(value)
return self
def setUserAgent(self, agent):
"""
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent - The user agent string.
return - The converter object.
"""
self.helper.setUserAgent(agent)
return self
def setProxy(self, host, port, user_name, password):
"""
Specifies an HTTP proxy that the API client library will use to connect to the internet.
host - The proxy hostname.
port - The proxy port.
user_name - The username.
password - The password.
return - The converter object.
"""
self.helper.setProxy(host, port, user_name, password)
return self
def setRetryCount(self, count):
"""
Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.
count - Number of retries.
return - The converter object.
"""
self.helper.setRetryCount(count)
return self
def main(argv, converter_known = False):
def show_help():
print("""
usage: pdfcrowd.py [options] [args]
help: pdfcrowd.py help
available converters:
html2pdf - Conversion from HTML to PDF.
html2image - Conversion from HTML to image.
image2image - Conversion from one image format to another image format.
pdf2pdf - Conversion from PDF to PDF.
image2pdf - Conversion from an image to PDF.
pdf2html - Conversion from PDF to HTML.
pdf2text - Conversion from PDF to text.
""")
def term_error(message):
sys.stderr.write(message + '\n')
sys.exit(1)
def add_generic_args(parser, nsource = 1):
parser.add_argument('source',
help = "Source to be converted. It can be URL, path to a local file or '-' to use stdin as an input text." if nsource == 1 else "Input files used for a conversion.",
nargs = nsource)
parser.add_argument('-user-name', help = 'Your user name at pdfcrowd.com.')
parser.add_argument('-api-key', help = 'Your API key at pdfcrowd.com.')
if not len(argv):
show_help()
sys.exit()
help_wanted = False
converter = argv[0]
if len(argv) == 1:
if argv[0] == 'help':
show_help()
sys.exit()
help_wanted = True
elif argv[0] == 'help':
converter = argv[1]
help_wanted = True
parser = None
usage = '%(prog)s'
if not converter_known:
usage += ' ' + converter
usage += ' [options] source'
epilog = 'produced by: www.pdfcrowd.com'
multi_args = {}
if converter == 'html2pdf':
converter_name = 'HtmlToPdfClient'
parser = argparse.ArgumentParser(usage = usage,
description = 'Conversion from HTML to PDF.',
add_help = False,
epilog = epilog)
add_generic_args(parser)
parser.add_argument('-zip-main-filename',
help = 'Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents. The file name.')
parser.add_argument('-page-size',
help = 'Set the output page size. Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter. Default is A4.')
parser.add_argument('-page-width',
help = 'Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 8.27in.')
parser.add_argument('-page-height',
help = 'Set the output page height. Use -1 for a single page PDF. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF. The value must be -1 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 11.7in.')
multi_args['page_dimensions'] = 2
parser.add_argument('-page-dimensions',
help = 'Set the output page dimensions. PAGE_DIMENSIONS must contain 2 values separated by a semicolon. Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Set the output page height. Use -1 for a single page PDF. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF. The value must be -1 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-orientation',
help = 'Set the output page orientation. Allowed values are landscape, portrait. Default is portrait.')
parser.add_argument('-margin-top',
help = 'Set the output page top margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0.4in.')
parser.add_argument('-margin-right',
help = 'Set the output page right margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0.4in.')
parser.add_argument('-margin-bottom',
help = 'Set the output page bottom margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0.4in.')
parser.add_argument('-margin-left',
help = 'Set the output page left margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0.4in.')
parser.add_argument('-no-margins',
action = 'store_true',
help = 'Disable page margins.')
multi_args['page_margins'] = 4
parser.add_argument('-page-margins',
help = 'Set the output page margins. PAGE_MARGINS must contain 4 values separated by a semicolon. Set the output page top margin. Set the output page right margin. Set the output page bottom margin. Set the output page left margin. All values the value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-print-page-range',
help = 'Set the page range to print. A comma separated list of page numbers or ranges.')
parser.add_argument('-page-numbering-offset',
help = 'Set an offset between physical and logical page numbers. Integer specifying page offset.')
parser.add_argument('-content-area-x',
help = 'Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value. Default is 0in.')
parser.add_argument('-content-area-y',
help = 'Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value. Default is 0in.')
parser.add_argument('-content-area-width',
help = 'Set the width of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is The width of the print area..')
parser.add_argument('-content-area-height',
help = 'Set the height of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is The height of the print area..')
multi_args['content_area'] = 4
parser.add_argument('-content-area',
help = 'Set the content area position and size. The content area enables to specify a web page area to be converted. CONTENT_AREA must contain 4 values separated by a semicolon. Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value. Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value. Set the width of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Set the height of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-css-page-rule-mode',
help = 'Specifies behavior in presence of CSS @page rules. It may affect the page size, margins and orientation. The page rule mode. Allowed values are default, mode1, mode2. Default is default.')
parser.add_argument('-remove-blank-pages',
help = 'Specifies which blank pages to exclude from the output document. The empty page behavior. Allowed values are trailing, none. Default is trailing.')
parser.add_argument('-header-url',
help = 'Load an HTML code from the specified URL and use it as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: will produce http://example.com href - the URL is set to the href attribute Example: Link to source will produce Link to source href-and-content - the URL is set to the href attribute and to the content Example: will produce http://example.com The supported protocols are http:// and https://.')
parser.add_argument('-header-html',
help = 'Use the specified HTML code as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: will produce http://example.com href - the URL is set to the href attribute Example: Link to source will produce Link to source href-and-content - the URL is set to the href attribute and to the content Example: will produce http://example.com The string must not be empty.')
parser.add_argument('-header-height',
help = 'Set the header height. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0.5in.')
parser.add_argument('-zip-header-filename',
help = 'Set the file name of the header HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents. The file name.')
parser.add_argument('-footer-url',
help = 'Load an HTML code from the specified URL and use it as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: will produce http://example.com href - the URL is set to the href attribute Example: Link to source will produce Link to source href-and-content - the URL is set to the href attribute and to the content Example: will produce http://example.com The supported protocols are http:// and https://.')
parser.add_argument('-footer-html',
help = 'Use the specified HTML as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: will produce http://example.com href - the URL is set to the href attribute Example: Link to source will produce Link to source href-and-content - the URL is set to the href attribute and to the content Example: will produce http://example.com The string must not be empty.')
parser.add_argument('-footer-height',
help = 'Set the footer height. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0.5in.')
parser.add_argument('-zip-footer-filename',
help = 'Set the file name of the footer HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents. The file name.')
parser.add_argument('-no-header-footer-horizontal-margins',
action = 'store_true',
help = 'Disable horizontal page margins for header and footer. The header/footer contents width will be equal to the physical page width.')
parser.add_argument('-exclude-header-on-pages',
help = 'The page header is not printed on the specified pages. List of physical page numbers. Negative numbers count backwards from the last page: -1 is the last page, -2 is the last but one page, and so on. A comma separated list of page numbers.')
parser.add_argument('-exclude-footer-on-pages',
help = 'The page footer is not printed on the specified pages. List of physical page numbers. Negative numbers count backwards from the last page: -1 is the last page, -2 is the last but one page, and so on. A comma separated list of page numbers.')
parser.add_argument('-header-footer-scale-factor',
help = 'Set the scaling factor (zoom) for the header and footer. The percentage value. The value must be in the range 10-500. Default is 100.')
parser.add_argument('-page-watermark',
help = 'Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-page-watermark-url',
help = 'Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark. The supported protocols are http:// and https://.')
parser.add_argument('-multipage-watermark',
help = 'Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-multipage-watermark-url',
help = 'Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image. The supported protocols are http:// and https://.')
parser.add_argument('-page-background',
help = 'Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-page-background-url',
help = 'Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background. The supported protocols are http:// and https://.')
parser.add_argument('-multipage-background',
help = 'Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-multipage-background-url',
help = 'Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image. The supported protocols are http:// and https://.')
parser.add_argument('-page-background-color',
help = 'The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins. The value must be in RRGGBB or RRGGBBAA hexadecimal format.')
parser.add_argument('-use-print-media',
action = 'store_true',
help = 'Use the print version of the page if available (@media print).')
parser.add_argument('-no-background',
action = 'store_true',
help = 'Do not print the background graphics.')
parser.add_argument('-disable-javascript',
action = 'store_true',
help = 'Do not execute JavaScript.')
parser.add_argument('-disable-image-loading',
action = 'store_true',
help = 'Do not load images.')
parser.add_argument('-disable-remote-fonts',
action = 'store_true',
help = 'Disable loading fonts from remote sources.')
parser.add_argument('-use-mobile-user-agent',
action = 'store_true',
help = 'Use a mobile user agent.')
parser.add_argument('-load-iframes',
help = 'Specifies how iframes are handled. Allowed values are all, same-origin, none. Default is all.')
parser.add_argument('-block-ads',
action = 'store_true',
help = 'Try to block ads. Enabling this option can produce smaller output and speed up the conversion.')
parser.add_argument('-default-encoding',
help = 'Set the default HTML content text encoding. The text encoding of the HTML content. Default is auto detect.')
parser.add_argument('-locale',
help = 'Set the locale for the conversion. This may affect the output format of dates, times and numbers. The locale code according to ISO 639. Default is en-US.')
parser.add_argument('-http-auth-user-name',
help = argparse.SUPPRESS
)
parser.add_argument('-http-auth-password',
help = argparse.SUPPRESS
)
multi_args['http_auth'] = 2
parser.add_argument('-http-auth',
help = 'Set credentials to access HTTP base authentication protected websites. HTTP_AUTH must contain 2 values separated by a semicolon. Set the HTTP authentication user name. Set the HTTP authentication password.')
parser.add_argument('-cookies',
help = 'Set cookies that are sent in Pdfcrowd HTTP requests. The cookie string.')
parser.add_argument('-verify-ssl-certificates',
action = 'store_true',
help = 'Do not allow insecure HTTPS connections.')
parser.add_argument('-fail-on-main-url-error',
action = 'store_true',
help = 'Abort the conversion if the main URL HTTP status code is greater than or equal to 400.')
parser.add_argument('-fail-on-any-url-error',
action = 'store_true',
help = 'Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.')
parser.add_argument('-no-xpdfcrowd-header',
action = 'store_true',
help = 'Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.')
parser.add_argument('-custom-css',
help = 'Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles. A string containing valid CSS. The string must not be empty.')
parser.add_argument('-custom-javascript',
help = 'Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library. A string containing a JavaScript code. The string must not be empty.')
parser.add_argument('-on-load-javascript',
help = 'Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library. A string containing a JavaScript code. The string must not be empty.')
parser.add_argument('-custom-http-header',
help = 'Set a custom HTTP header that is sent in Pdfcrowd HTTP requests. A string containing the header name and value separated by a colon.')
parser.add_argument('-javascript-delay',
help = 'Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter. The number of milliseconds to wait. Must be a positive integer number or 0. Default is 200.')
parser.add_argument('-element-to-convert',
help = 'Convert only the specified element from the main document and its children. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used. One or more CSS selectors separated by commas. The string must not be empty.')
parser.add_argument('-element-to-convert-mode',
help = 'Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used. Allowed values are cut-out, remove-siblings, hide-siblings. Default is cut-out.')
parser.add_argument('-wait-for-element',
help = 'Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by "Max Delay" parameter. One or more CSS selectors separated by commas. The string must not be empty.')
parser.add_argument('-auto-detect-element-to-convert',
action = 'store_true',
help = 'The main HTML element for conversion is detected automatically.')
parser.add_argument('-readability-enhancements',
help = 'The input HTML is automatically enhanced to improve the readability. Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4. Default is none.')
parser.add_argument('-viewport-width',
help = 'Set the viewport width in pixels. The viewport is the user\'s visible area of the page. The value must be in the range 96-65000. Default is 1024.')
parser.add_argument('-viewport-height',
help = 'Set the viewport height in pixels. The viewport is the user\'s visible area of the page. If the input HTML uses lazily loaded images, try using a large value that covers the entire height of the HTML, e.g. 100000. Must be a positive integer number. Default is 768.')
multi_args['viewport'] = 2
parser.add_argument('-viewport',
help = 'Set the viewport size. The viewport is the user\'s visible area of the page. VIEWPORT must contain 2 values separated by a semicolon. Set the viewport width in pixels. The viewport is the user\'s visible area of the page. The value must be in the range 96-65000. Set the viewport height in pixels. The viewport is the user\'s visible area of the page. If the input HTML uses lazily loaded images, try using a large value that covers the entire height of the HTML, e.g. 100000. Must be a positive integer number.')
parser.add_argument('-rendering-mode',
help = 'Set the rendering mode. The rendering mode. Allowed values are default, viewport. Default is default.')
parser.add_argument('-smart-scaling-mode',
help = 'Specifies the scaling mode used for fitting the HTML contents to the print area. The smart scaling mode. Allowed values are default, disabled, viewport-fit, content-fit, single-page-fit, single-page-fit-ex, mode1. Default is default.')
parser.add_argument('-scale-factor',
help = 'Set the scaling factor (zoom) for the main page area. The percentage value. The value must be in the range 10-500. Default is 100.')
parser.add_argument('-jpeg-quality',
help = 'Set the quality of embedded JPEG images. A lower quality results in a smaller PDF file but can lead to compression artifacts. The percentage value. The value must be in the range 1-100. Default is 100.')
parser.add_argument('-convert-images-to-jpeg',
help = 'Specify which image types will be converted to JPEG. Converting lossless compression image formats (PNG, GIF, ...) to JPEG may result in a smaller PDF file. The image category. Allowed values are none, opaque, all. Default is none.')
parser.add_argument('-image-dpi',
help = 'Set the DPI of images in PDF. A lower DPI may result in a smaller PDF file. If the specified DPI is higher than the actual image DPI, the original image DPI is retained (no upscaling is performed). Use 0 to leave the images unaltered. The DPI value. Must be a positive integer number or 0.')
parser.add_argument('-enable-pdf-forms',
action = 'store_true',
help = 'Convert HTML forms to fillable PDF forms. Details can be found in the blog post.')
parser.add_argument('-linearize',
action = 'store_true',
help = 'Create linearized PDF. This is also known as Fast Web View.')
parser.add_argument('-encrypt',
action = 'store_true',
help = 'Encrypt the PDF. This prevents search engines from indexing the contents.')
parser.add_argument('-user-password',
help = 'Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions. The user password.')
parser.add_argument('-owner-password',
help = 'Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions. The owner password.')
parser.add_argument('-no-print',
action = 'store_true',
help = 'Disallow printing of the output PDF.')
parser.add_argument('-no-modify',
action = 'store_true',
help = 'Disallow modification of the output PDF.')
parser.add_argument('-no-copy',
action = 'store_true',
help = 'Disallow text and graphics extraction from the output PDF.')
parser.add_argument('-title',
help = 'Set the title of the PDF. The title.')
parser.add_argument('-subject',
help = 'Set the subject of the PDF. The subject.')
parser.add_argument('-author',
help = 'Set the author of the PDF. The author.')
parser.add_argument('-keywords',
help = 'Associate keywords with the document. The string with the keywords.')
parser.add_argument('-extract-meta-tags',
action = 'store_true',
help = 'Extract meta tags (author, keywords and description) from the input HTML and use them in the output PDF.')
parser.add_argument('-page-layout',
help = 'Specify the page layout to be used when the document is opened. Allowed values are single-page, one-column, two-column-left, two-column-right.')
parser.add_argument('-page-mode',
help = 'Specify how the document should be displayed when opened. Allowed values are full-screen, thumbnails, outlines.')
parser.add_argument('-initial-zoom-type',
help = 'Specify how the page should be displayed when opened. Allowed values are fit-width, fit-height, fit-page.')
parser.add_argument('-initial-page',
help = 'Display the specified page when the document is opened. Must be a positive integer number.')
parser.add_argument('-initial-zoom',
help = 'Specify the initial page zoom in percents when the document is opened. Must be a positive integer number.')
parser.add_argument('-hide-toolbar',
action = 'store_true',
help = 'Specify whether to hide the viewer application\'s tool bars when the document is active.')
parser.add_argument('-hide-menubar',
action = 'store_true',
help = 'Specify whether to hide the viewer application\'s menu bar when the document is active.')
parser.add_argument('-hide-window-ui',
action = 'store_true',
help = 'Specify whether to hide user interface elements in the document\'s window (such as scroll bars and navigation controls), leaving only the document\'s contents displayed.')
parser.add_argument('-fit-window',
action = 'store_true',
help = 'Specify whether to resize the document\'s window to fit the size of the first displayed page.')
parser.add_argument('-center-window',
action = 'store_true',
help = 'Specify whether to position the document\'s window in the center of the screen.')
parser.add_argument('-display-title',
action = 'store_true',
help = 'Specify whether the window\'s title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.')
parser.add_argument('-right-to-left',
action = 'store_true',
help = 'Set the predominant reading order for text to right-to-left. This option has no direct effect on the document\'s contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up')
parser.add_argument('-data-string',
help = 'Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV. The input data string.')
parser.add_argument('-data-file',
help = 'Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV. The file path to a local file containing the input data.')
parser.add_argument('-data-format',
help = 'Specify the input data format. The data format. Allowed values are auto, json, xml, yaml, csv. Default is auto.')
parser.add_argument('-data-encoding',
help = 'Set the encoding of the data file set by setDataFile. The data file encoding. Default is utf-8.')
parser.add_argument('-data-ignore-undefined',
action = 'store_true',
help = 'Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {%% if variable is defined %%} to check if the variable is defined.')
parser.add_argument('-data-auto-escape',
action = 'store_true',
help = 'Auto escape HTML symbols in the input data before placing them into the output.')
parser.add_argument('-data-trim-blocks',
action = 'store_true',
help = 'Auto trim whitespace around each template command block.')
parser.add_argument('-data-options',
help = 'Set the advanced data options:csv_delimiter - The CSV data delimiter, the default is ,.xml_remove_root - Remove the root XML element from the input data.data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data. Comma separated list of options.')
parser.add_argument('-debug-log',
action = 'store_true',
help = 'Turn on the debug logging. Details about the conversion are stored in the debug log.')
parser.add_argument('-tag',
help = 'Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off. A string with the custom tag.')
parser.add_argument('-http-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-https-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-client-certificate',
help = 'A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security. The file must be in PKCS12 format. The file must exist and not be empty.')
parser.add_argument('-client-certificate-password',
help = 'A password for PKCS12 file with a client certificate if it is needed.')
parser.add_argument('-layout-dpi',
help = 'Set the internal DPI resolution used for positioning of PDF contents. It can help in situations when there are small inaccuracies in the PDF. It is recommended to use values that are a multiple of 72, such as 288 or 360. The DPI value. The value must be in the range of 72-600. Default is 300.')
parser.add_argument('-contents-matrix',
help = 'A 2D transformation matrix applied to the main contents on each page. The origin [0,0] is located at the top-left corner of the contents. The resolution is 72 dpi. A comma separated string of matrix elements: "scaleX,skewX,transX,skewY,scaleY,transY" Default is 1,0,0,0,1,0.')
parser.add_argument('-header-matrix',
help = 'A 2D transformation matrix applied to the page header contents. The origin [0,0] is located at the top-left corner of the header. The resolution is 72 dpi. A comma separated string of matrix elements: "scaleX,skewX,transX,skewY,scaleY,transY" Default is 1,0,0,0,1,0.')
parser.add_argument('-footer-matrix',
help = 'A 2D transformation matrix applied to the page footer contents. The origin [0,0] is located at the top-left corner of the footer. The resolution is 72 dpi. A comma separated string of matrix elements: "scaleX,skewX,transX,skewY,scaleY,transY" Default is 1,0,0,0,1,0.')
parser.add_argument('-disable-page-height-optimization',
action = 'store_true',
help = 'Disable automatic height adjustment that compensates for pixel to point rounding errors.')
parser.add_argument('-main-document-css-annotation',
action = 'store_true',
help = 'Add special CSS classes to the main document\'s body element. This allows applying custom styling based on these classes: pdfcrowd-page-X - where X is the current page number pdfcrowd-page-odd - odd page pdfcrowd-page-even - even page Warning: If your custom styling affects the contents area size (e.g. by using different margins, padding, border width), the resulting PDF may contain duplicit contents or some contents may be missing.')
parser.add_argument('-header-footer-css-annotation',
action = 'store_true',
help = 'Add special CSS classes to the header/footer\'s body element. This allows applying custom styling based on these classes: pdfcrowd-page-X - where X is the current page number pdfcrowd-page-count-X - where X is the total page count pdfcrowd-page-first - the first page pdfcrowd-page-last - the last page pdfcrowd-page-odd - odd page pdfcrowd-page-even - even page')
parser.add_argument('-max-loading-time',
help = 'Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading. The number of seconds to wait. The value must be in the range 10-30.')
parser.add_argument('-converter-version',
help = 'Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case. The version identifier. Allowed values are latest, 20.10, 18.10. Default is 20.10.')
parser.add_argument('-use-http',
action = 'store_true',
help = 'Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.')
parser.add_argument('-user-agent',
help = 'Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall. The user agent string.')
multi_args['proxy'] = 4
parser.add_argument('-proxy',
help = 'Specifies an HTTP proxy that the API client library will use to connect to the internet. PROXY must contain 4 values separated by a semicolon. The proxy hostname. The proxy port. The username. The password.')
parser.add_argument('-retry-count',
help = 'Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0. Number of retries. Default is 1.')
if converter == 'html2image':
converter_name = 'HtmlToImageClient'
parser = argparse.ArgumentParser(usage = usage,
description = 'Conversion from HTML to image.',
add_help = False,
epilog = epilog)
add_generic_args(parser)
parser.add_argument('-output-format',
help = 'The format of the output file. Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp. Default is png.')
parser.add_argument('-zip-main-filename',
help = 'Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents. The file name.')
parser.add_argument('-screenshot-width',
help = 'Set the output image width in pixels. The value must be in the range 96-65000. Default is 1024.')
parser.add_argument('-screenshot-height',
help = 'Set the output image height in pixels. If it is not specified, actual document height is used. Must be a positive integer number.')
parser.add_argument('-scale-factor',
help = 'Set the scaling factor (zoom) for the output image. The percentage value. Must be a positive integer number. Default is 100.')
parser.add_argument('-background-color',
help = 'The output image background color. The value must be in RRGGBB or RRGGBBAA hexadecimal format.')
parser.add_argument('-use-print-media',
action = 'store_true',
help = 'Use the print version of the page if available (@media print).')
parser.add_argument('-no-background',
action = 'store_true',
help = 'Do not print the background graphics.')
parser.add_argument('-disable-javascript',
action = 'store_true',
help = 'Do not execute JavaScript.')
parser.add_argument('-disable-image-loading',
action = 'store_true',
help = 'Do not load images.')
parser.add_argument('-disable-remote-fonts',
action = 'store_true',
help = 'Disable loading fonts from remote sources.')
parser.add_argument('-use-mobile-user-agent',
action = 'store_true',
help = 'Use a mobile user agent.')
parser.add_argument('-load-iframes',
help = 'Specifies how iframes are handled. Allowed values are all, same-origin, none. Default is all.')
parser.add_argument('-block-ads',
action = 'store_true',
help = 'Try to block ads. Enabling this option can produce smaller output and speed up the conversion.')
parser.add_argument('-default-encoding',
help = 'Set the default HTML content text encoding. The text encoding of the HTML content. Default is auto detect.')
parser.add_argument('-locale',
help = 'Set the locale for the conversion. This may affect the output format of dates, times and numbers. The locale code according to ISO 639. Default is en-US.')
parser.add_argument('-http-auth-user-name',
help = argparse.SUPPRESS
)
parser.add_argument('-http-auth-password',
help = argparse.SUPPRESS
)
multi_args['http_auth'] = 2
parser.add_argument('-http-auth',
help = 'Set credentials to access HTTP base authentication protected websites. HTTP_AUTH must contain 2 values separated by a semicolon. Set the HTTP authentication user name. Set the HTTP authentication password.')
parser.add_argument('-cookies',
help = 'Set cookies that are sent in Pdfcrowd HTTP requests. The cookie string.')
parser.add_argument('-verify-ssl-certificates',
action = 'store_true',
help = 'Do not allow insecure HTTPS connections.')
parser.add_argument('-fail-on-main-url-error',
action = 'store_true',
help = 'Abort the conversion if the main URL HTTP status code is greater than or equal to 400.')
parser.add_argument('-fail-on-any-url-error',
action = 'store_true',
help = 'Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.')
parser.add_argument('-no-xpdfcrowd-header',
action = 'store_true',
help = 'Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.')
parser.add_argument('-custom-css',
help = 'Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles. A string containing valid CSS. The string must not be empty.')
parser.add_argument('-custom-javascript',
help = 'Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library. A string containing a JavaScript code. The string must not be empty.')
parser.add_argument('-on-load-javascript',
help = 'Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library. A string containing a JavaScript code. The string must not be empty.')
parser.add_argument('-custom-http-header',
help = 'Set a custom HTTP header that is sent in Pdfcrowd HTTP requests. A string containing the header name and value separated by a colon.')
parser.add_argument('-javascript-delay',
help = 'Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter. The number of milliseconds to wait. Must be a positive integer number or 0. Default is 200.')
parser.add_argument('-element-to-convert',
help = 'Convert only the specified element from the main document and its children. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used. One or more CSS selectors separated by commas. The string must not be empty.')
parser.add_argument('-element-to-convert-mode',
help = 'Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used. Allowed values are cut-out, remove-siblings, hide-siblings. Default is cut-out.')
parser.add_argument('-wait-for-element',
help = 'Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by "Max Delay" parameter. One or more CSS selectors separated by commas. The string must not be empty.')
parser.add_argument('-auto-detect-element-to-convert',
action = 'store_true',
help = 'The main HTML element for conversion is detected automatically.')
parser.add_argument('-readability-enhancements',
help = 'The input HTML is automatically enhanced to improve the readability. Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4. Default is none.')
parser.add_argument('-data-string',
help = 'Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV. The input data string.')
parser.add_argument('-data-file',
help = 'Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV. The file path to a local file containing the input data.')
parser.add_argument('-data-format',
help = 'Specify the input data format. The data format. Allowed values are auto, json, xml, yaml, csv. Default is auto.')
parser.add_argument('-data-encoding',
help = 'Set the encoding of the data file set by setDataFile. The data file encoding. Default is utf-8.')
parser.add_argument('-data-ignore-undefined',
action = 'store_true',
help = 'Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {%% if variable is defined %%} to check if the variable is defined.')
parser.add_argument('-data-auto-escape',
action = 'store_true',
help = 'Auto escape HTML symbols in the input data before placing them into the output.')
parser.add_argument('-data-trim-blocks',
action = 'store_true',
help = 'Auto trim whitespace around each template command block.')
parser.add_argument('-data-options',
help = 'Set the advanced data options:csv_delimiter - The CSV data delimiter, the default is ,.xml_remove_root - Remove the root XML element from the input data.data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data. Comma separated list of options.')
parser.add_argument('-debug-log',
action = 'store_true',
help = 'Turn on the debug logging. Details about the conversion are stored in the debug log.')
parser.add_argument('-tag',
help = 'Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off. A string with the custom tag.')
parser.add_argument('-http-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-https-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-client-certificate',
help = 'A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security. The file must be in PKCS12 format. The file must exist and not be empty.')
parser.add_argument('-client-certificate-password',
help = 'A password for PKCS12 file with a client certificate if it is needed.')
parser.add_argument('-max-loading-time',
help = 'Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading. The number of seconds to wait. The value must be in the range 10-30.')
parser.add_argument('-converter-version',
help = 'Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case. The version identifier. Allowed values are latest, 20.10, 18.10. Default is 20.10.')
parser.add_argument('-use-http',
action = 'store_true',
help = 'Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.')
parser.add_argument('-user-agent',
help = 'Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall. The user agent string.')
multi_args['proxy'] = 4
parser.add_argument('-proxy',
help = 'Specifies an HTTP proxy that the API client library will use to connect to the internet. PROXY must contain 4 values separated by a semicolon. The proxy hostname. The proxy port. The username. The password.')
parser.add_argument('-retry-count',
help = 'Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0. Number of retries. Default is 1.')
if converter == 'image2image':
converter_name = 'ImageToImageClient'
parser = argparse.ArgumentParser(usage = usage,
description = 'Conversion from one image format to another image format.',
add_help = False,
epilog = epilog)
add_generic_args(parser)
parser.add_argument('-output-format',
help = 'The format of the output file. Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp. Default is png.')
parser.add_argument('-resize',
help = 'Resize the image. The resize percentage or new image dimensions. Default is 100%%.')
parser.add_argument('-rotate',
help = 'Rotate the image. The rotation specified in degrees.')
parser.add_argument('-crop-area-x',
help = 'Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0px.')
parser.add_argument('-crop-area-y',
help = 'Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0px.')
parser.add_argument('-crop-area-width',
help = 'Set the width of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is The width of the print area..')
parser.add_argument('-crop-area-height',
help = 'Set the height of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is The height of the print area..')
multi_args['crop_area'] = 4
parser.add_argument('-crop-area',
help = 'Set the content area position and size. The content area enables to specify the part to be converted. CROP_AREA must contain 4 values separated by a semicolon. Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. Set the width of the content area. It should be at least 1 inch. Set the height of the content area. It should be at least 1 inch. All values the value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-remove-borders',
action = 'store_true',
help = 'Remove borders of an image which does not change in color.')
parser.add_argument('-canvas-size',
help = 'Set the output canvas size. Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.')
parser.add_argument('-canvas-width',
help = 'Set the output canvas width. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-canvas-height',
help = 'Set the output canvas height. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
multi_args['canvas_dimensions'] = 2
parser.add_argument('-canvas-dimensions',
help = 'Set the output canvas dimensions. If no canvas size is specified, margins are applied as a border around the image. CANVAS_DIMENSIONS must contain 2 values separated by a semicolon. Set the output canvas width. Set the output canvas height. All values the value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-orientation',
help = 'Set the output canvas orientation. Allowed values are landscape, portrait. Default is portrait.')
parser.add_argument('-position',
help = 'Set the image position on the canvas. Allowed values are center, top, bottom, left, right, top-left, top-right, bottom-left, bottom-right. Default is center.')
parser.add_argument('-print-canvas-mode',
help = 'Set the mode to print the image on the canvas. Allowed values are default, fit, stretch. Default is default.')
parser.add_argument('-margin-top',
help = 'Set the output canvas top margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-margin-right',
help = 'Set the output canvas right margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-margin-bottom',
help = 'Set the output canvas bottom margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-margin-left',
help = 'Set the output canvas left margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
multi_args['margins'] = 4
parser.add_argument('-margins',
help = 'Set the output canvas margins. MARGINS must contain 4 values separated by a semicolon. Set the output canvas top margin. Set the output canvas right margin. Set the output canvas bottom margin. Set the output canvas left margin. All values the value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-canvas-background-color',
help = 'The canvas background color in RGB or RGBA hexadecimal format. The color fills the entire canvas regardless of margins. If no canvas size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too. The value must be in RRGGBB or RRGGBBAA hexadecimal format.')
parser.add_argument('-dpi',
help = 'Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI). The DPI value. Default is 96.')
parser.add_argument('-debug-log',
action = 'store_true',
help = 'Turn on the debug logging. Details about the conversion are stored in the debug log.')
parser.add_argument('-tag',
help = 'Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off. A string with the custom tag.')
parser.add_argument('-http-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-https-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-converter-version',
help = 'Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case. The version identifier. Allowed values are latest, 20.10, 18.10. Default is 20.10.')
parser.add_argument('-use-http',
action = 'store_true',
help = 'Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.')
parser.add_argument('-user-agent',
help = 'Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall. The user agent string.')
multi_args['proxy'] = 4
parser.add_argument('-proxy',
help = 'Specifies an HTTP proxy that the API client library will use to connect to the internet. PROXY must contain 4 values separated by a semicolon. The proxy hostname. The proxy port. The username. The password.')
parser.add_argument('-retry-count',
help = 'Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0. Number of retries. Default is 1.')
if converter == 'pdf2pdf':
converter_name = 'PdfToPdfClient'
parser = argparse.ArgumentParser(usage = usage,
description = 'Conversion from PDF to PDF.',
add_help = False,
epilog = epilog)
add_generic_args(parser, '+')
parser.add_argument('-action',
help = 'Specifies the action to be performed on the input PDFs. Allowed values are join, shuffle, extract, delete. Default is join.')
parser.add_argument('-input-pdf-password',
help = 'Password to open the encrypted PDF file. The input PDF password.')
parser.add_argument('-page-range',
help = 'Set the page range for extract or delete action. A comma separated list of page numbers or ranges.')
parser.add_argument('-page-watermark',
help = 'Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-page-watermark-url',
help = 'Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark. The supported protocols are http:// and https://.')
parser.add_argument('-multipage-watermark',
help = 'Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-multipage-watermark-url',
help = 'Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image. The supported protocols are http:// and https://.')
parser.add_argument('-page-background',
help = 'Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-page-background-url',
help = 'Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background. The supported protocols are http:// and https://.')
parser.add_argument('-multipage-background',
help = 'Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-multipage-background-url',
help = 'Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image. The supported protocols are http:// and https://.')
parser.add_argument('-linearize',
action = 'store_true',
help = 'Create linearized PDF. This is also known as Fast Web View.')
parser.add_argument('-encrypt',
action = 'store_true',
help = 'Encrypt the PDF. This prevents search engines from indexing the contents.')
parser.add_argument('-user-password',
help = 'Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions. The user password.')
parser.add_argument('-owner-password',
help = 'Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions. The owner password.')
parser.add_argument('-no-print',
action = 'store_true',
help = 'Disallow printing of the output PDF.')
parser.add_argument('-no-modify',
action = 'store_true',
help = 'Disallow modification of the output PDF.')
parser.add_argument('-no-copy',
action = 'store_true',
help = 'Disallow text and graphics extraction from the output PDF.')
parser.add_argument('-title',
help = 'Set the title of the PDF. The title.')
parser.add_argument('-subject',
help = 'Set the subject of the PDF. The subject.')
parser.add_argument('-author',
help = 'Set the author of the PDF. The author.')
parser.add_argument('-keywords',
help = 'Associate keywords with the document. The string with the keywords.')
parser.add_argument('-use-metadata-from',
help = 'Use metadata (title, subject, author and keywords) from the n-th input PDF. Set the index of the input PDF file from which to use the metadata. 0 means no metadata. Must be a positive integer number or 0.')
parser.add_argument('-page-layout',
help = 'Specify the page layout to be used when the document is opened. Allowed values are single-page, one-column, two-column-left, two-column-right.')
parser.add_argument('-page-mode',
help = 'Specify how the document should be displayed when opened. Allowed values are full-screen, thumbnails, outlines.')
parser.add_argument('-initial-zoom-type',
help = 'Specify how the page should be displayed when opened. Allowed values are fit-width, fit-height, fit-page.')
parser.add_argument('-initial-page',
help = 'Display the specified page when the document is opened. Must be a positive integer number.')
parser.add_argument('-initial-zoom',
help = 'Specify the initial page zoom in percents when the document is opened. Must be a positive integer number.')
parser.add_argument('-hide-toolbar',
action = 'store_true',
help = 'Specify whether to hide the viewer application\'s tool bars when the document is active.')
parser.add_argument('-hide-menubar',
action = 'store_true',
help = 'Specify whether to hide the viewer application\'s menu bar when the document is active.')
parser.add_argument('-hide-window-ui',
action = 'store_true',
help = 'Specify whether to hide user interface elements in the document\'s window (such as scroll bars and navigation controls), leaving only the document\'s contents displayed.')
parser.add_argument('-fit-window',
action = 'store_true',
help = 'Specify whether to resize the document\'s window to fit the size of the first displayed page.')
parser.add_argument('-center-window',
action = 'store_true',
help = 'Specify whether to position the document\'s window in the center of the screen.')
parser.add_argument('-display-title',
action = 'store_true',
help = 'Specify whether the window\'s title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.')
parser.add_argument('-right-to-left',
action = 'store_true',
help = 'Set the predominant reading order for text to right-to-left. This option has no direct effect on the document\'s contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up')
parser.add_argument('-debug-log',
action = 'store_true',
help = 'Turn on the debug logging. Details about the conversion are stored in the debug log.')
parser.add_argument('-tag',
help = 'Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off. A string with the custom tag.')
parser.add_argument('-converter-version',
help = 'Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case. The version identifier. Allowed values are latest, 20.10, 18.10. Default is 20.10.')
parser.add_argument('-use-http',
action = 'store_true',
help = 'Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.')
parser.add_argument('-user-agent',
help = 'Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall. The user agent string.')
multi_args['proxy'] = 4
parser.add_argument('-proxy',
help = 'Specifies an HTTP proxy that the API client library will use to connect to the internet. PROXY must contain 4 values separated by a semicolon. The proxy hostname. The proxy port. The username. The password.')
parser.add_argument('-retry-count',
help = 'Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0. Number of retries. Default is 1.')
if converter == 'image2pdf':
converter_name = 'ImageToPdfClient'
parser = argparse.ArgumentParser(usage = usage,
description = 'Conversion from an image to PDF.',
add_help = False,
epilog = epilog)
add_generic_args(parser)
parser.add_argument('-resize',
help = 'Resize the image. The resize percentage or new image dimensions. Default is 100%%.')
parser.add_argument('-rotate',
help = 'Rotate the image. The rotation specified in degrees.')
parser.add_argument('-crop-area-x',
help = 'Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0px.')
parser.add_argument('-crop-area-y',
help = 'Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is 0px.')
parser.add_argument('-crop-area-width',
help = 'Set the width of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is The width of the print area..')
parser.add_argument('-crop-area-height',
help = 'Set the height of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". Default is The height of the print area..')
multi_args['crop_area'] = 4
parser.add_argument('-crop-area',
help = 'Set the content area position and size. The content area enables to specify the part to be converted. CROP_AREA must contain 4 values separated by a semicolon. Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. Set the width of the content area. It should be at least 1 inch. Set the height of the content area. It should be at least 1 inch. All values the value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-remove-borders',
action = 'store_true',
help = 'Remove borders of an image which does not change in color.')
parser.add_argument('-page-size',
help = 'Set the output page size. Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.')
parser.add_argument('-page-width',
help = 'Set the output page width. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-page-height',
help = 'Set the output page height. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
multi_args['page_dimensions'] = 2
parser.add_argument('-page-dimensions',
help = 'Set the output page dimensions. If no page size is specified, margins are applied as a border around the image. PAGE_DIMENSIONS must contain 2 values separated by a semicolon. Set the output page width. Set the output page height. All values the value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-orientation',
help = 'Set the output page orientation. Allowed values are landscape, portrait. Default is portrait.')
parser.add_argument('-position',
help = 'Set the image position on the page. Allowed values are center, top, bottom, left, right, top-left, top-right, bottom-left, bottom-right. Default is center.')
parser.add_argument('-print-page-mode',
help = 'Set the mode to print the image on the content area of the page. Allowed values are default, fit, stretch. Default is default.')
parser.add_argument('-margin-top',
help = 'Set the output page top margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-margin-right',
help = 'Set the output page right margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-margin-bottom',
help = 'Set the output page bottom margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-margin-left',
help = 'Set the output page left margin. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
multi_args['page_margins'] = 4
parser.add_argument('-page-margins',
help = 'Set the output page margins. PAGE_MARGINS must contain 4 values separated by a semicolon. Set the output page top margin. Set the output page right margin. Set the output page bottom margin. Set the output page left margin. All values the value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".')
parser.add_argument('-page-background-color',
help = 'The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins. If not page size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too. The value must be in RRGGBB or RRGGBBAA hexadecimal format.')
parser.add_argument('-dpi',
help = 'Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI). The DPI value. Default is 96.')
parser.add_argument('-page-watermark',
help = 'Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-page-watermark-url',
help = 'Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark. The supported protocols are http:// and https://.')
parser.add_argument('-multipage-watermark',
help = 'Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-multipage-watermark-url',
help = 'Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image. The supported protocols are http:// and https://.')
parser.add_argument('-page-background',
help = 'Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-page-background-url',
help = 'Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background. The supported protocols are http:// and https://.')
parser.add_argument('-multipage-background',
help = 'Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image. The file path to a local file. The file must exist and not be empty.')
parser.add_argument('-multipage-background-url',
help = 'Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image. The supported protocols are http:// and https://.')
parser.add_argument('-linearize',
action = 'store_true',
help = 'Create linearized PDF. This is also known as Fast Web View.')
parser.add_argument('-encrypt',
action = 'store_true',
help = 'Encrypt the PDF. This prevents search engines from indexing the contents.')
parser.add_argument('-user-password',
help = 'Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions. The user password.')
parser.add_argument('-owner-password',
help = 'Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions. The owner password.')
parser.add_argument('-no-print',
action = 'store_true',
help = 'Disallow printing of the output PDF.')
parser.add_argument('-no-modify',
action = 'store_true',
help = 'Disallow modification of the output PDF.')
parser.add_argument('-no-copy',
action = 'store_true',
help = 'Disallow text and graphics extraction from the output PDF.')
parser.add_argument('-title',
help = 'Set the title of the PDF. The title.')
parser.add_argument('-subject',
help = 'Set the subject of the PDF. The subject.')
parser.add_argument('-author',
help = 'Set the author of the PDF. The author.')
parser.add_argument('-keywords',
help = 'Associate keywords with the document. The string with the keywords.')
parser.add_argument('-page-layout',
help = 'Specify the page layout to be used when the document is opened. Allowed values are single-page, one-column, two-column-left, two-column-right.')
parser.add_argument('-page-mode',
help = 'Specify how the document should be displayed when opened. Allowed values are full-screen, thumbnails, outlines.')
parser.add_argument('-initial-zoom-type',
help = 'Specify how the page should be displayed when opened. Allowed values are fit-width, fit-height, fit-page.')
parser.add_argument('-initial-page',
help = 'Display the specified page when the document is opened. Must be a positive integer number.')
parser.add_argument('-initial-zoom',
help = 'Specify the initial page zoom in percents when the document is opened. Must be a positive integer number.')
parser.add_argument('-hide-toolbar',
action = 'store_true',
help = 'Specify whether to hide the viewer application\'s tool bars when the document is active.')
parser.add_argument('-hide-menubar',
action = 'store_true',
help = 'Specify whether to hide the viewer application\'s menu bar when the document is active.')
parser.add_argument('-hide-window-ui',
action = 'store_true',
help = 'Specify whether to hide user interface elements in the document\'s window (such as scroll bars and navigation controls), leaving only the document\'s contents displayed.')
parser.add_argument('-fit-window',
action = 'store_true',
help = 'Specify whether to resize the document\'s window to fit the size of the first displayed page.')
parser.add_argument('-center-window',
action = 'store_true',
help = 'Specify whether to position the document\'s window in the center of the screen.')
parser.add_argument('-display-title',
action = 'store_true',
help = 'Specify whether the window\'s title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.')
parser.add_argument('-debug-log',
action = 'store_true',
help = 'Turn on the debug logging. Details about the conversion are stored in the debug log.')
parser.add_argument('-tag',
help = 'Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off. A string with the custom tag.')
parser.add_argument('-http-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-https-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-converter-version',
help = 'Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case. The version identifier. Allowed values are latest, 20.10, 18.10. Default is 20.10.')
parser.add_argument('-use-http',
action = 'store_true',
help = 'Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.')
parser.add_argument('-user-agent',
help = 'Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall. The user agent string.')
multi_args['proxy'] = 4
parser.add_argument('-proxy',
help = 'Specifies an HTTP proxy that the API client library will use to connect to the internet. PROXY must contain 4 values separated by a semicolon. The proxy hostname. The proxy port. The username. The password.')
parser.add_argument('-retry-count',
help = 'Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0. Number of retries. Default is 1.')
if converter == 'pdf2html':
converter_name = 'PdfToHtmlClient'
parser = argparse.ArgumentParser(usage = usage,
description = 'Conversion from PDF to HTML.',
add_help = False,
epilog = epilog)
add_generic_args(parser)
parser.add_argument('-pdf-password',
help = 'Password to open the encrypted PDF file. The input PDF password.')
parser.add_argument('-scale-factor',
help = 'Set the scaling factor (zoom) for the main page area. The percentage value. Must be a positive integer number. Default is 100.')
parser.add_argument('-print-page-range',
help = 'Set the page range to print. A comma separated list of page numbers or ranges.')
parser.add_argument('-dpi',
help = 'Set the output graphics DPI. The DPI value. Default is 144.')
parser.add_argument('-image-mode',
help = 'Specifies where the images are stored. The image storage mode. Allowed values are embed, separate, none. Default is embed.')
parser.add_argument('-image-format',
help = 'Specifies the format for the output images. The image format. Allowed values are png, jpg, svg. Default is png.')
parser.add_argument('-css-mode',
help = 'Specifies where the style sheets are stored. The style sheet storage mode. Allowed values are embed, separate. Default is embed.')
parser.add_argument('-font-mode',
help = 'Specifies where the fonts are stored. The font storage mode. Allowed values are embed, separate. Default is embed.')
parser.add_argument('-split-ligatures',
action = 'store_true',
help = 'Converts ligatures, two or more letters combined into a single glyph, back into their individual ASCII characters.')
parser.add_argument('-force-zip',
action = 'store_true',
help = 'Enforces the zip output format.')
parser.add_argument('-title',
help = 'Set the HTML title. The title from the input PDF is used by default. The HTML title.')
parser.add_argument('-subject',
help = 'Set the HTML subject. The subject from the input PDF is used by default. The HTML subject.')
parser.add_argument('-author',
help = 'Set the HTML author. The author from the input PDF is used by default. The HTML author.')
parser.add_argument('-keywords',
help = 'Associate keywords with the HTML document. Keywords from the input PDF are used by default. The string containing the keywords.')
parser.add_argument('-debug-log',
action = 'store_true',
help = 'Turn on the debug logging. Details about the conversion are stored in the debug log.')
parser.add_argument('-tag',
help = 'Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off. A string with the custom tag.')
parser.add_argument('-http-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-https-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-use-http',
action = 'store_true',
help = 'Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.')
parser.add_argument('-user-agent',
help = 'Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall. The user agent string.')
multi_args['proxy'] = 4
parser.add_argument('-proxy',
help = 'Specifies an HTTP proxy that the API client library will use to connect to the internet. PROXY must contain 4 values separated by a semicolon. The proxy hostname. The proxy port. The username. The password.')
parser.add_argument('-retry-count',
help = 'Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0. Number of retries. Default is 1.')
if converter == 'pdf2text':
converter_name = 'PdfToTextClient'
parser = argparse.ArgumentParser(usage = usage,
description = 'Conversion from PDF to text.',
add_help = False,
epilog = epilog)
add_generic_args(parser)
parser.add_argument('-pdf-password',
help = 'The password to open the encrypted PDF file. The input PDF password.')
parser.add_argument('-print-page-range',
help = 'Set the page range to print. A comma separated list of page numbers or ranges.')
parser.add_argument('-no-layout',
action = 'store_true',
help = 'Ignore the original PDF layout.')
parser.add_argument('-eol',
help = 'The end-of-line convention for the text output. Allowed values are unix, dos, mac. Default is unix.')
parser.add_argument('-page-break-mode',
help = 'Specify the page break mode for the text output. Allowed values are none, default, custom. Default is none.')
parser.add_argument('-custom-page-break',
help = 'Specify the custom page break. String to insert between the pages.')
parser.add_argument('-paragraph-mode',
help = 'Specify the paragraph detection mode. Allowed values are none, bounding-box, characters. Default is none.')
parser.add_argument('-line-spacing-threshold',
help = 'Set the maximum line spacing when the paragraph detection mode is enabled. The value must be a positive integer percentage. Default is 10%%.')
parser.add_argument('-remove-hyphenation',
action = 'store_true',
help = 'Remove the hyphen character from the end of lines.')
parser.add_argument('-remove-empty-lines',
action = 'store_true',
help = 'Remove empty lines from the text output.')
parser.add_argument('-crop-area-x',
help = 'Set the top left X coordinate of the crop area in points. Must be a positive integer number or 0.')
parser.add_argument('-crop-area-y',
help = 'Set the top left Y coordinate of the crop area in points. Must be a positive integer number or 0.')
parser.add_argument('-crop-area-width',
help = 'Set the width of the crop area in points. Must be a positive integer number or 0. Default is PDF page width..')
parser.add_argument('-crop-area-height',
help = 'Set the height of the crop area in points. Must be a positive integer number or 0. Default is PDF page height..')
multi_args['crop_area'] = 4
parser.add_argument('-crop-area',
help = 'Set the crop area. It allows to extract just a part of a PDF page. CROP_AREA must contain 4 values separated by a semicolon. Set the top left X coordinate of the crop area in points. Set the top left Y coordinate of the crop area in points. Set the width of the crop area in points. Set the height of the crop area in points. All values must be a positive integer number or 0.')
parser.add_argument('-debug-log',
action = 'store_true',
help = 'Turn on the debug logging. Details about the conversion are stored in the debug log.')
parser.add_argument('-tag',
help = 'Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off. A string with the custom tag.')
parser.add_argument('-http-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-https-proxy',
help = 'A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.')
parser.add_argument('-use-http',
action = 'store_true',
help = 'Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.')
parser.add_argument('-user-agent',
help = 'Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall. The user agent string.')
multi_args['proxy'] = 4
parser.add_argument('-proxy',
help = 'Specifies an HTTP proxy that the API client library will use to connect to the internet. PROXY must contain 4 values separated by a semicolon. The proxy hostname. The proxy port. The username. The password.')
parser.add_argument('-retry-count',
help = 'Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0. Number of retries. Default is 1.')
if not parser:
term_error("Unknown converter '%s'." % converter)
if help_wanted:
parser.print_help()
sys.exit()
args = parser.parse_args(argv[1:])
if not args.user_name:
term_error('Missing user name.')
if not args.api_key:
term_error('Missing API key.')
converter = getattr(sys.modules[__name__], converter_name)(args.user_name, args.api_key)
def invoke_method(method, value, arg):
if arg in multi_args.keys():
values = value.split(';')
if len(values) != multi_args[arg]:
raise Error("Invalid number of arguments for '%s': %s" % (arg, value))
getattr(converter, method)(*values)
else:
getattr(converter, method)(value)
def get_input(source):
if source == '-':
lines = (line for line in sys.stdin)
return 'convertString', ''.join(lines)
if re.match('(?i)^https?://.*$', source):
return 'convertUrl', source
if os.path.isfile(source):
return 'convertFile', source
term_error("Invalid source '{}'. Must be valid file, URL or '-'.".format(source))
args.user_name = None
args.api_key = None
for arg in vars(args):
if not arg.startswith('_') and arg != 'source':
value = getattr(args, arg)
if value:
method = ''.join([w.title() if w.islower() else w for w in arg.split('_')])
try:
invoke_method('set' + method, value, arg)
except AttributeError:
invoke_method(method[0].lower() + method[1:], value, arg)
if converter_name == 'PdfToPdfClient':
for in_file in args.source:
converter.addPdfFile(in_file)
out = converter.convert()
else:
method, args = get_input(args.source[0])
out = getattr(converter, method)(args)
if PYTHON_3:
sys.stdout.buffer.write(out)
else:
sys.stdout.write(out)
if __name__ == "__main__":
main(sys.argv[1:])