- - - - - - - - - - - - - - - - - - - -

- +

»
Index
- - -

- -

- +

Index

@@ -346,7 +255,7 @@

A

B

build() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
build() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2]
- (adobe.pdfservices.operation.client_config.ClientConfig.Builder method), [1], [2] @@ -356,7 +265,7 @@
  B

Builder (class in adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials) +
Builder (class in adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials)
- (class in adobe.pdfservices.operation.client_config.ClientConfig) @@ -466,7 +375,7 @@
  F

from_file() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +

from_file() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2]

(adobe.pdfservices.operation.client_config.ClientConfig.Builder method), [1], [2] @@ -479,6 +388,12 @@

G

get_char_info (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions property), [1] +

get_media_type() (adobe.pdfservices.operation.io.file_ref.FileRef method), [1] +
get_options() (adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation method), [1]

@@ -635,11 +550,11 @@

T

W

- + or other required elements. + thead: [ 1, "

with_account_id() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_account_id() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2]
with_client_id() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_client_id() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2]
with_client_secret() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_client_secret() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2]
with_connect_timeout() (adobe.pdfservices.operation.client_config.ClientConfig.Builder method), [1], [2]

W

with_elements_to_extract() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1]

with_elements_to_extract_renditions() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1]

with_get_char_info() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1]
with_include_styling_info() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1]
with_organization_id() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_organization_id() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2]
with_private_key() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_private_key() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2]
with_read_timeout() (adobe.pdfservices.operation.client_config.ClientConfig.Builder method), [1], [2] +
with_region() (adobe.pdfservices.operation.client_config.ClientConfig.Builder method), [1], [2]
with_table_structure_format() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1]

W

- - - - Built with Sphinx using a - + + Built with Sphinx using a theme - - provided by Read the Docs. + provided by Read the Docs. +

pdfservices-sdk — pdfservices-sdk documentation

+ pdfservices-sdk + +

+ + + +

API Reference
- ClientConfig
- ClientConfigBuilder
- Credentials
- ExecutionContext
- ExtractPDFOperation
- ExtractPDFOptions
- FileRef
- Exceptions
- ServiceAccountCredentials
- ServiceAccountCredentialsBuilder
+

+ +

+ + pdfservices-sdk +

+ +

»
pdfservices-sdk
+

+ +

pdfservices-sdk

This is the documentation of all the exposed classes and modules in the SDK. Please click on any Operation Class in the API Reference section on left nav to get started.

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

src — pdfservices-sdk documentation

+ pdfservices-sdk + +

+ + + +

API Reference
- ClientConfig
- ClientConfigBuilder
- Credentials
- ExecutionContext
- ExtractPDFOperation
- ExtractPDFOptions
- FileRef
- Exceptions
- ServiceAccountCredentials
- ServiceAccountCredentialsBuilder
+

+ +

+ + pdfservices-sdk +

+ +

src

adobe package
- Subpackages
  - adobe.pdfservices package
    - Subpackages
    - Module contents
    +
  +
- Module contents
+

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

Python Module Index — pdfservices-sdk documentation

+ pdfservices-sdk + +

+ + + +

API Reference
- ClientConfig
- ClientConfigBuilder
- Credentials
- ExecutionContext
- ExtractPDFOperation
- ExtractPDFOptions
- FileRef
- Exceptions
- ServiceAccountCredentials
- ServiceAccountCredentialsBuilder
+

+ +

+ + pdfservices-sdk +

+ +

»
Python Module Index
+

+ + +

Python Module Index

+ +

+ a +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +


	+ a
	+ `adobe`	+
	+ `adobe.pdfservices`	+
	+ `adobe.pdfservices.operation`	+
	+ `adobe.pdfservices.operation.auth`	+
	+ `adobe.pdfservices.operation.auth.credentials`	+
	+ `adobe.pdfservices.operation.auth.service_account_credentials`	+
	+ `adobe.pdfservices.operation.client_config`	+
	+ `adobe.pdfservices.operation.exception`	+
	+ `adobe.pdfservices.operation.exception.exceptions`	+
	+ `adobe.pdfservices.operation.execution_context`	+
	+ `adobe.pdfservices.operation.io`	+
	+ `adobe.pdfservices.operation.io.file_ref`	+
	+ `adobe.pdfservices.operation.operation`	+
	+ `adobe.pdfservices.operation.pdfops`	+
	+ `adobe.pdfservices.operation.pdfops.extract_pdf_operation`	+
	+ `adobe.pdfservices.operation.pdfops.options`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type`	+

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

API Reference — pdfservices-sdk documentation

+ pdfservices-sdk + +

+ + + +

API Reference
- ClientConfig
- ClientConfigBuilder
- Credentials
- ExecutionContext
- ExtractPDFOperation
- ExtractPDFOptions
- FileRef
- Exceptions
- ServiceAccountCredentials
- ServiceAccountCredentialsBuilder
+

+ +

+ + pdfservices-sdk +

+ +

»
API Reference
+

+ +

API Reference

ClientConfig

+class adobe.pdfservices.operation.client_config.ClientConfig

Bases: object

Encapsulates the API request configurations

+class Builder

Bases: object

Builds a ClientConfig instance.

+build()

Returns a new ClientConfig instance built from the current state of this builder.

Returns: A ClientConfig instance.
+
Return type: ClientConfig
+

+ +

+from_file(client_config_file_path: str)

Sets the connect timeout and read timeout using the JSON client config file path. All the keys in the JSON structure are optional.

Parameters: client_config_file_path (str) – JSON client config file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

JSON structure:

{
+    "connectTimeout": "4000",
+    "readTimeout": "20000",
+    "region": "eu"
+}
+

+

+ +

+with_connect_timeout(connect_timeout: int)

Sets the connect timeout. It should be greater than zero.

Parameters: connect_timeout (int) – determines the timeout in milliseconds until a connection is established in the API calls. Default value is 4000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+with_read_timeout(read_timeout: int)

Sets the read timeout. It should be greater than zero.

Parameters: read_timeout (int) – Defines the read timeout in milliseconds, The number of milliseconds the client will wait for the server to send a response after the connection is established. Default value is 10000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+with_region(region: adobe.pdfservices.operation.region.Region)

Updates the relevant value for the region.

Parameters: region (Region) – Service region(US or EU). Default value is US.
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+static builder()

Creates a new ClientConfig builder.

Returns: A ClientConfig.Builder instance.
+
Return type: ClientConfig.Builder
+

+ +

ClientConfigBuilder

+class adobe.pdfservices.operation.client_config.ClientConfig.Builder

Bases: object

Builds a ClientConfig instance.

+build()

Returns a new ClientConfig instance built from the current state of this builder.

Returns: A ClientConfig instance.
+
Return type: ClientConfig
+

+ +

+from_file(client_config_file_path: str)

Sets the connect timeout and read timeout using the JSON client config file path. All the keys in the JSON structure are optional.

Parameters: client_config_file_path (str) – JSON client config file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

JSON structure:

{
+    "connectTimeout": "4000",
+    "readTimeout": "20000",
+    "region": "eu"
+}
+

+

+ +

+with_connect_timeout(connect_timeout: int)

Sets the connect timeout. It should be greater than zero.

Parameters: connect_timeout (int) – determines the timeout in milliseconds until a connection is established in the API calls. Default value is 4000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+with_read_timeout(read_timeout: int)

Sets the read timeout. It should be greater than zero.

Parameters: read_timeout (int) – Defines the read timeout in milliseconds, The number of milliseconds the client will wait for the server to send a response after the connection is established. Default value is 10000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+with_region(region: adobe.pdfservices.operation.region.Region)

Updates the relevant value for the region.

Parameters: region (Region) – Service region(US or EU). Default value is US.
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

Credentials

+class adobe.pdfservices.operation.auth.credentials.Credentials

Bases: abc.ABC

Marker base class for different types of credentials. Currently it supports only ServiceAccountCredentials. +The factory methods within this class can be used to create instances of credentials classes.

+static service_account_credentials_builder()

Creates a new ServiceAccountCredentials builder.

Returns: An instance of ServiceAccountCredentials Builder.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

ExecutionContext

+class adobe.pdfservices.operation.execution_context.ExecutionContext

Bases: object

Represents the execution context of an Operation. +An execution context typically consists of the desired authentication credentials and client configurations such as timeouts.

For each set of credentials, a ExecutionContext instance can be reused across operations.

Sample Usage:

try:
+    base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+    credentials = Credentials.service_account_credentials_builder() \
+        .from_file(base_path + "/pdfservices-api-credentials.json") \
+        .build()
+
+    execution_context = ExecutionContext.create(credentials)
+    extract_pdf_operation = ExtractPDFOperation.create_new()
+
+    source = FileRef.create_from_local_file(base_path + "/resources/extractPdfInput.pdf")
+    extract_pdf_operation.set_input(source)
+
+    extract_pdf_options: ExtractPDFOptions = ExtractPDFOptions.builder() \
+        .with_elements_to_extract([ExtractElementType.TEXT, ExtractElementType.TABLES]) \
+        .with_elements_to_extract_renditions([ExtractRenditionsElementType.TABLES, ExtractRenditionsElementType.FIGURES]) \
+        .with_get_char_info(True) \
+        .build()
+    extract_pdf_operation.set_options(extract_pdf_options)
+
+    result: FileRef = extract_pdf_operation.execute(execution_context)
+
+    result.save_as(base_path + "/output/ExtractTextTableWithFigureTableRendition.zip")
+except (ServiceApiException, ServiceUsageException, SdkException):
+    logging.exception("Exception encountered while executing operation")
+

+

+static create(credentials: adobe.pdfservices.operation.auth.credentials.Credentials, client_config: Optional[adobe.pdfservices.operation.client_config.ClientConfig] = None)

Creates a context instance using the provided Credentials and ClientConfig

Parameters

credentials (Credentials) – A Credentials instance
client_config (ClientConfig, optional) – A ClientConfig instance for providing custom http timeouts, defaults to None

Returns

A new ExecutionContext instance

Return type

ExecutionContext

+ +

ExtractPDFOperation

+class adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation(create_key)

Bases: adobe.pdfservices.operation.operation.Operation

An Operation that extracts pdf elements such as text and tables in a structured format from a PDF, along +with renditions for tables and figures.

Sample usage.

try:
+    base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+    credentials = Credentials.service_account_credentials_builder() \
+        .from_file(base_path + "/pdfservices-api-credentials.json") \
+        .build()
+
+    execution_context = ExecutionContext.create(credentials)
+    extract_pdf_operation = ExtractPDFOperation.create_new()
+
+    source = FileRef.create_from_local_file(base_path + "/resources/extractPdfInput.pdf")
+    extract_pdf_operation.set_input(source)
+
+    extract_pdf_options: ExtractPDFOptions = ExtractPDFOptions.builder() \
+        .with_elements_to_extract([ExtractElementType.TEXT, ExtractElementType.TABLES]) \
+        .with_elements_to_extract_renditions([ExtractRenditionsElementType.TABLES, ExtractRenditionsElementType.FIGURES]) \
+        .with_get_char_info(True) \
+        .with_include_styling_info(True) \
+        .build()
+    extract_pdf_operation.set_options(extract_pdf_options)
+
+    result: FileRef = extract_pdf_operation.execute(execution_context)
+
+    result.save_as(base_path + "/output/ExtractTextTableWithFigureTableRendition.zip")
+except (ServiceApiException, ServiceUsageException, SdkException):
+    logging.exception("Exception encountered while executing operation")
+

+

+SUPPORTED_SOURCE_MEDIA_TYPES = {adobe.pdfservices.operation.internal.extension_media_type_mapping.ExtensionMediaTypeMapping.PDF.mime_type}: Supported source file formats for ExtractPdfOperation is .pdf.
+

+ +

+classmethod create_new()

creates a new instance of ExtractPDFOperation.

Returns: A new instance of ExtractPDFOperation
+
Return type: ExtractPDFOperation
+

+ +

+execute(execution_context: adobe.pdfservices.operation.execution_context.ExecutionContext)

Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting Zip file. +The resulting file may be stored in the system temporary directory. See adobe.pdfservices.operation.io.file_ref.FileRef for how temporary resources are cleaned up.

Parameters: execution_context (ExecutionContext) – The context in which the operation will be executed.
+
Returns: The FileRef to the result.
+
Return type: FileRef
+
Raises: ServiceApiException – if an API call results in an error response.
+

+ +

+get_options()

gets the ExtractPDFOptions.

Returns: The options parameter of the operation
+
Return type: ExtractPDFOptions
+

+ +

+set_input(source_file_ref: adobe.pdfservices.operation.io.file_ref.FileRef)

Sets an input file.

Parameters: source_file_ref (FileRef) – An input file.
+
Returns: This instance to add any additional parameters.
+
Return type: ExtractPDFOperation
+

+ +

+set_options(extract_pdf_options: adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions)

sets the ExtractPDFOptions.

Parameters: extract_pdf_options (ExtractPDFOptions) – ExtractPDFOptions to set.
+
Returns: This instance to add any additional parameters.
+
Return type: ExtractPDFOperation
+

+ +

ExtractPDFOptions

+class adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions(elements_to_extract, elements_to_extract_renditions, get_char_info, table_output_format, include_styling_info=None)

Bases: object

An Options Class that defines the options for ExtractPDFOperation.

extract_pdf_options: ExtractPDFOptions = ExtractPDFOptions.builder() \
+    .with_elements_to_extract([ExtractElementType.TEXT, ExtractElementType.TABLES]) \
+    .with_get_char_info(True) \
+    .with_table_structure_format(TableStructureType.CSV) \
+    .with_elements_to_extract_renditions([ExtractRenditionsElementType.FIGURES, ExtractRenditionsElementType.TABLES]) \
+    .with_include_styling_info(True) \
+    .build()
+

+

+class Builder

Bases: object

The builder for ExtractPDFOptions.

+build()

+ +

+with_element_to_extract(element_to_extract: adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType)

adds a pdf element type for extracting structured information.

Parameters: element_to_extract (ExtractElementType) – ExtractElementType to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if element_to_extract is None.
+

+ +

+with_element_to_extract_renditions(element_to_extract_renditions: adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType)

adds a pdf element type for extracting rendition.

Parameters: element_to_extract_renditions (ExtractRenditionsElementType) – ExtractRenditionsElementType whose renditions have to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if element_to_extract_renditions is None.
+

+ +

+with_elements_to_extract(elements_to_extract: List[adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType])

adds a list of pdf element types for extracting structured information.

Parameters: elements_to_extract (List[ExtractElementType]) – List of ExtractElementType to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if elements_to_extract is None or empty list.
+

+ +

+with_elements_to_extract_renditions(elements_to_extract_renditions: List[adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType])

adds a list of pdf element types for extracting rendition.

Parameters: elements_to_extract_renditions (List[ExtractRenditionsElementType]) – List of ExtractRenditionsElementType whose renditions have to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if elements_to_extract is None or empty list.
+

+ +

+with_get_char_info(get_char_info: bool)

sets the Boolean specifying whether to add character level bounding boxes to output json

Parameters: get_char_info (bool) – Set True to extract character level bounding boxes information
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+

+ +

+with_include_styling_info(include_styling_info: bool)

sets the Boolean specifying whether to add PDF Elements Styling Info to output json

Parameters: include_styling_info (bool) – Set True to extract PDF Elements Styling Info
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+

+ +

+with_table_structure_format(table_structure: adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type.TableStructureType)

adds the table structure format (currently csv only) for extracting structured information.

Parameters: table_structure (TableStructureType) – TableStructureType to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if table_structure is None.
+

+ +

+static builder()

Returns a Builder for ExtractPDFOptions

Returns: The builder class for ExtractPDFOptions
+
Return type: ExtractPDFOptions.Builder
+

+ +

+property elements_to_extract: List of pdf element types to be extracted in a structured format from input file
+

+ +

+property elements_to_extract_renditions: List of pdf element types whose renditions needs to be extracted from input file
+

+ +

+property get_char_info: Boolean specifying whether to add character level bounding boxes to output json
+

+ +

+property include_styling_info: Boolean specifying whether to add PDF Elements Styling Info to output json
+

+ +

+property table_output_format: export table in specified format - currently csv supported
+

+ +

FileRef

+class adobe.pdfservices.operation.io.file_ref.FileRef

Bases: abc.ABC

This class represents a local file. It is typically used by an SDK Operation which accepts or returns files.

When a FileRef instance is created by this SDK while referring to a temporary file location, calling any of the +methods to save the fileRef (For example, create_from_stream() etc.) will delete the temporary file.

+static create_from_local_file(local_source: str, media_type: Optional[str] = None)

Creates a FileRef instance from a local file path. If no media type is provided, it will be inferred +from the file extension.

Parameters

local_source (str) – Local file path, either absolute path or relative to the working directory.
media_type (str, optional, defaults to None) – Media type to identify the local file format, defaults to None

Returns

A FileRef instance.

Return type

FileRef

+ +

+static create_from_stream(input_stream: _io.BufferedReader, media_type: str)

Creates a FileRef instance from a readable stream using the specified media type. +The stream is not read by this method but by consumers of file content i.e. the execute method of an operation +such as execute().

Parameters

input_stream (BufferedReader) – Readable Stream representing the file.
media_type (str) – Media type to identify the file format.

Returns

A FileRef instance.

Return type

FileRef

+ +

+get_media_type(): returns the media type
+

+ +

+abstract save_as(local_file_path: str)

+ +

+abstract write_to_stream(writer_stream)

+ +

Exceptions

+exception adobe.pdfservices.operation.exception.exceptions.SdkException(message, request_tracking_id=None)

Bases: Exception

SdkException is typically thrown for client-side or network errors.

+property request_tracking_id: The request tracking id of the exception.
+

+ +

+exception adobe.pdfservices.operation.exception.exceptions.ServiceApiException(message, request_tracking_id, status_code=0, error_code='UNKNOWN')

Bases: Exception

ServiceApiException is thrown when an underlying service API call results in an error.

+DEFAULT_ERROR_CODE = 'UNKNOWN': Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.
+

+ +

+DEFAULT_STATUS_CODE = 0: The default value of status code if there is no status code for this service exception.
+

+ +

+property error_code: Returns the detailed message of this error.
+

+ +

+property request_tracking_id: The request tracking id of the exception.
+

+ +

+property status_code: Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.
+

+ +

+exception adobe.pdfservices.operation.exception.exceptions.ServiceUsageException(message, request_tracking_id, status_code=429, error_code='UNKNOWN')

Bases: Exception

ServiceUsageError is thrown when either service usage limit has been reached or credentials quota has been exhausted.

+DEFAULT_ERROR_CODE = 'UNKNOWN': The default value of error code if there is no status code for this service failure.
+

+ +

+DEFAULT_STATUS_CODE = 429: The default value of status code if there is no status code for this service failure.
+

+ +

+property error_code: Returns the detailed message of this error.
+

+ +

+property request_tracking_id: The request tracking id of the exception.
+

+ +

+property status_code: Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.
+

+ +

ServiceAccountCredentials

+class adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials(client_id, client_secret, private_key, organization_id, account_id, ims_base_uri=adobe.pdfservices.operation.internal.constants.service_constants.ServiceConstants.JWT_BASE_URI, claim=None)

Bases: adobe.pdfservices.operation.auth.credentials.Credentials, abc.ABC

Service Account credentials allow your application to call PDF Tools Extract API on behalf of the application itself, +or on behalf of an enterprise organization. For getting the credentials, +Click Here.

+class Builder

Bases: object

Builds a ServiceAccountCredentials instance.

+build()

Returns a new ServiceAccountCredentials instance built from the current state of this builder.

Returns: A ServiceAccountCredentials instance.
+
Return type: ServiceAccountCredentials
+

+ +

+from_file(credentials_file_path: str)

Sets Service Account Credentials using the JSON credentials file path. All the keys in the JSON structure are optional.

JSON structure:

{
+    "client_credentials": {
+    "client_id": "CLIENT_ID",
+    "client_secret": "CLIENT_SECRET"
+  },
+  "service_account_credentials": {
+    "organization_id": "org_ident@AdobeOrg",
+    "account_id": "id@techacct.adobe.com",
+    "private_key_file": "private.key"
+  }
+}
+

+

private_key_file is the path of private key file. It will be looked up in the classpath and the directory of JSON credentials file.

Parameters: credentials_file_path (str) – JSON credentials file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_account_id(account_id: str)

Set Account Id (format: id@techacct.adobe.com)

Parameters: account_id (str) – Account ID (format: id@techacct.adobe.com)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_id(client_id: str)

Set Client ID (API Key)

Parameters: client_id (str) – Client Id (API Key)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_secret(client_secret: str)

Set Client Secret

Parameters: client_secret (str) – Client Secret
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_organization_id(organization_id: str)

Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API

Parameters: organization_id (str) – Organization ID (format: org_ident@AdobeOrg)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_private_key(private_key: str)

Set private key

Parameters: private_key (str) – Content of the Private Key (PEM format)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+property account_id: Account ID(format: id@techacct.adobe.com)
+

+ +

+property claim: Identifies the Service for which Authorization(Access) Token will be issued
+

+ +

+property client_id: Client Id (API Key)
+

+ +

+property client_secret: Client Secret
+

+ +

+property organization_id: Identifies the organization(format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API.
+

+ +

+property private_key: Content of the Private Key (PEM format)
+

+ +

ServiceAccountCredentialsBuilder

+class adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder

Bases: object

Builds a ServiceAccountCredentials instance.

+build()

Returns a new ServiceAccountCredentials instance built from the current state of this builder.

Returns: A ServiceAccountCredentials instance.
+
Return type: ServiceAccountCredentials
+

+ +

+from_file(credentials_file_path: str)

Sets Service Account Credentials using the JSON credentials file path. All the keys in the JSON structure are optional.

JSON structure:

{
+    "client_credentials": {
+    "client_id": "CLIENT_ID",
+    "client_secret": "CLIENT_SECRET"
+  },
+  "service_account_credentials": {
+    "organization_id": "org_ident@AdobeOrg",
+    "account_id": "id@techacct.adobe.com",
+    "private_key_file": "private.key"
+  }
+}
+

+

private_key_file is the path of private key file. It will be looked up in the classpath and the directory of JSON credentials file.

Parameters: credentials_file_path (str) – JSON credentials file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_account_id(account_id: str)

Set Account Id (format: id@techacct.adobe.com)

Parameters: account_id (str) – Account ID (format: id@techacct.adobe.com)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_id(client_id: str)

Set Client ID (API Key)

Parameters: client_id (str) – Client Id (API Key)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_secret(client_secret: str)

Set Client Secret

Parameters: client_secret (str) – Client Secret
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_organization_id(organization_id: str)

Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API

Parameters: organization_id (str) – Organization ID (format: org_ident@AdobeOrg)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_private_key(private_key: str)

Set private key

Parameters: private_key (str) – Content of the Private Key (PEM format)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

Search — pdfservices-sdk documentation

+ pdfservices-sdk + +

+ + + +

API Reference
- ClientConfig
- ClientConfigBuilder
- Credentials
- ExecutionContext
- ExtractPDFOperation
- ExtractPDFOptions
- FileRef
- Exceptions
- ServiceAccountCredentials
- ServiceAccountCredentialsBuilder
+

+ +

+ + pdfservices-sdk +

+ +

+ + + + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

\u00B6

' + _('Hide Search Matches') + '

", "

" ], + col: [ 2, "", "

" ], + tr: [ 2, "", "

" ], + td: [ 3, "", "

" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
adobe package
+

+ +

adobe package

Subpackages

adobe.pdfservices package
- Subpackages
  - adobe.pdfservices.operation package
    +
  +
- Module contents
+

Module contents

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/adobe.pdfservices.html b/docs/apidocs/2.1.2b1/adobe.pdfservices.html new file mode 100644 index 0000000..12add3c --- /dev/null +++ b/docs/apidocs/2.1.2b1/adobe.pdfservices.html @@ -0,0 +1,176 @@ + + + + + + adobe.pdfservices package — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
adobe.pdfservices package
+

+ +

adobe.pdfservices package

Subpackages

adobe.pdfservices.operation package
+

Module contents

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.auth.html b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.auth.html new file mode 100644 index 0000000..611bbfc --- /dev/null +++ b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.auth.html @@ -0,0 +1,346 @@ + + + + + + adobe.pdfservices.operation.auth package — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
adobe.pdfservices.operation.auth package
+

+ +

adobe.pdfservices.operation.auth package

Submodules

adobe.pdfservices.operation.auth.credentials module

+class adobe.pdfservices.operation.auth.credentials.Credentials

Bases: abc.ABC

+static service_account_credentials_builder()

Creates a new ServiceAccountCredentials builder.

Returns: An instance of ServiceAccountCredentials Builder.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

adobe.pdfservices.operation.auth.service_account_credentials module

Bases: adobe.pdfservices.operation.auth.credentials.Credentials, abc.ABC

+class Builder

Bases: object

Builds a ServiceAccountCredentials instance.

+build()

Returns a new ServiceAccountCredentials instance built from the current state of this builder.

Returns: A ServiceAccountCredentials instance.
+
Return type: ServiceAccountCredentials
+

+ +

+from_file(credentials_file_path: str)

Sets Service Account Credentials using the JSON credentials file path. All the keys in the JSON structure are optional.

JSON structure:

{
+    "client_credentials": {
+    "client_id": "CLIENT_ID",
+    "client_secret": "CLIENT_SECRET"
+  },
+  "service_account_credentials": {
+    "organization_id": "org_ident@AdobeOrg",
+    "account_id": "id@techacct.adobe.com",
+    "private_key_file": "private.key"
+  }
+}
+

+

private_key_file is the path of private key file. It will be looked up in the classpath and the directory of JSON credentials file.

Parameters: credentials_file_path (str) – JSON credentials file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_account_id(account_id: str)

Set Account Id (format: id@techacct.adobe.com)

Parameters: account_id (str) – Account ID (format: id@techacct.adobe.com)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_id(client_id: str)

Set Client ID (API Key)

Parameters: client_id (str) – Client Id (API Key)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_secret(client_secret: str)

Set Client Secret

Parameters: client_secret (str) – Client Secret
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_organization_id(organization_id: str)

Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API

Parameters: organization_id (str) – Organization ID (format: org_ident@AdobeOrg)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_private_key(private_key: str)

Set private key

Parameters: private_key (str) – Content of the Private Key (PEM format)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+property account_id: Account ID(format: id@techacct.adobe.com)
+

+ +

+property claim: Identifies the Service for which Authorization(Access) Token will be issued
+

+ +

+property client_id: Client Id (API Key)
+

+ +

+property client_secret: Client Secret
+

+ +

+property organization_id: Identifies the organization(format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API.
+

+ +

+property private_key: Content of the Private Key (PEM format)
+

+ +

Module contents

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.exception.html b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.exception.html new file mode 100644 index 0000000..7776d95 --- /dev/null +++ b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.exception.html @@ -0,0 +1,225 @@ + + + + + + adobe.pdfservices.operation.exception package — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
adobe.pdfservices.operation.exception package
+

+ +

adobe.pdfservices.operation.exception package

Submodules

adobe.pdfservices.operation.exception.exceptions module

+exception adobe.pdfservices.operation.exception.exceptions.SdkException(message, request_tracking_id=None)

Bases: Exception

SdkException is typically thrown for client-side or network errors.

+property request_tracking_id: The request tracking id of the exception.
+

+ +

+exception adobe.pdfservices.operation.exception.exceptions.ServiceApiException(message, request_tracking_id, status_code=0, error_code='UNKNOWN')

Bases: Exception

ServiceApiException is thrown when an underlying service API call results in an error.

+DEFAULT_ERROR_CODE = 'UNKNOWN': Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.
+

+ +

+DEFAULT_STATUS_CODE = 0: The default value of status code if there is no status code for this service exception.
+

+ +

+property error_code: Returns the detailed message of this error.
+

+ +

+property request_tracking_id: The request tracking id of the exception.
+

+ +

+property status_code: Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.
+

+ +

+exception adobe.pdfservices.operation.exception.exceptions.ServiceUsageException(message, request_tracking_id, status_code=429, error_code='UNKNOWN')

Bases: Exception

ServiceUsageError is thrown when either service usage limit has been reached or credentials quota has been exhausted.

+DEFAULT_ERROR_CODE = 'UNKNOWN': The default value of error code if there is no status code for this service failure.
+

+ +

+DEFAULT_STATUS_CODE = 429: The default value of status code if there is no status code for this service failure.
+

+ +

+property error_code: Returns the detailed message of this error.
+

+ +

+property request_tracking_id: The request tracking id of the exception.
+

+ +

+property status_code: Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.
+

+ +

Module contents

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.html b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.html new file mode 100644 index 0000000..2ca8396 --- /dev/null +++ b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.html @@ -0,0 +1,352 @@ + + + + + + adobe.pdfservices.operation package — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
adobe.pdfservices.operation package
+

+ +

adobe.pdfservices.operation package

Subpackages

adobe.pdfservices.operation.auth package
+
adobe.pdfservices.operation.exception package
+
adobe.pdfservices.operation.io package
+
adobe.pdfservices.operation.pdfops package
+

Submodules

adobe.pdfservices.operation.client_config module

+class adobe.pdfservices.operation.client_config.ClientConfig

Bases: object

Encapsulates the API request configurations

+class Builder

Bases: object

Builds a ClientConfig instance.

+build()

Returns a new ClientConfig instance built from the current state of this builder.

Returns: A ClientConfig instance.
+
Return type: ClientConfig
+

+ +

+from_file(client_config_file_path: str)

Sets the connect timeout and read timeout using the JSON client config file path. All the keys in the JSON structure are optional.

Parameters: client_config_file_path (str) – JSON client config file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

JSON structure:

{
+    "connectTimeout": "4000",
+    "readTimeout": "20000"
+}
+

+

+ +

+with_connect_timeout(connect_timeout: int)

Sets the connect timeout. It should be greater than zero.

Parameters: connect_timeout (int) – determines the timeout in milliseconds until a connection is established in the API calls. Default value is 4000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+with_read_timeout(read_timeout: int)

Sets the read timeout. It should be greater than zero.

Parameters: read_timeout (int) – Defines the read timeout in milliseconds, The number of milliseconds the client will wait for the server to send a response after the connection is established. Default value is 10000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+static builder()

Creates a new ClientConfig builder.

Returns: A ClientConfig.Builder instance.
+
Return type: ClientConfig.Builder
+

+ +

adobe.pdfservices.operation.execution_context module

+class adobe.pdfservices.operation.execution_context.ExecutionContext

Bases: object

Represents the execution context of an Operation. +An execution context typically consists of the desired authentication credentials and client configurations such as timeouts.

For each set of credentials, a ExecutionContext instance can be reused across operations.

Sample Usage:

try:
+    base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+    credentials = Credentials.service_account_credentials_builder() \
+        .from_file(base_path + "/pdfservices-api-credentials.json") \
+        .build()
+
+    execution_context = ExecutionContext.create(credentials)
+    extract_pdf_operation = ExtractPDFOperation.create_new()
+
+    source = FileRef.create_from_local_file(base_path + "/resources/extractPdfInput.pdf")
+    extract_pdf_operation.set_input(source)
+
+    extract_pdf_options: ExtractPDFOptions = ExtractPDFOptions.builder() \
+        .with_elements_to_extract([ExtractElementType.TEXT, ExtractElementType.TABLES]) \
+        .with_elements_to_extract_renditions([ExtractRenditionsElementType.TABLES, ExtractRenditionsElementType.FIGURES]) \
+        .with_get_char_info(True) \
+        .build()
+    extract_pdf_operation.set_options(extract_pdf_options)
+
+    result: FileRef = extract_pdf_operation.execute(execution_context)
+
+    result.save_as(base_path + "/output/ExtractTextTableWithFigureTableRendition.zip")
+except (ServiceApiException, ServiceUsageException, SdkException):
+    logging.exception("Exception encountered while executing operation")
+

+

+static create(credentials: adobe.pdfservices.operation.auth.credentials.Credentials, client_config: Optional[adobe.pdfservices.operation.client_config.ClientConfig] = None)

Creates a context instance using the provided Credentials and ClientConfig

Parameters

credentials (Credentials) – A Credentials instance
client_config (ClientConfig, optional) – A ClientConfig instance for providing custom http timeouts, defaults to None

Returns

A new ExecutionContext instance

Return type

ExecutionContext

+ +

adobe.pdfservices.operation.operation module

+class adobe.pdfservices.operation.operation.Operation

Bases: abc.ABC

+abstract execute(execution_context: adobe.pdfservices.operation.execution_context.ExecutionContext)

+ +

Module contents

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.io.html b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.io.html new file mode 100644 index 0000000..8b89e2a --- /dev/null +++ b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.io.html @@ -0,0 +1,206 @@ + + + + + + adobe.pdfservices.operation.io package — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
adobe.pdfservices.operation.io package
+

+ +

adobe.pdfservices.operation.io package

Submodules

adobe.pdfservices.operation.io.file_ref module

+class adobe.pdfservices.operation.io.file_ref.FileRef

Bases: abc.ABC

This class represents a local file. It is typically used by an SDK Operation which accepts or returns files.

+static create_from_local_file(local_source: str, media_type: Optional[str] = None)

Creates a FileRef instance from a local file path. If no media type is provided, it will be inferred +from the file extension.

Parameters

local_source (str) – Local file path, either absolute path or relative to the working directory.
media_type (str, optional, defaults to None) – Media type to identify the local file format, defaults to None

Returns

A FileRef instance.

Return type

FileRef

+ +

+static create_from_stream(input_stream: _io.BufferedReader, media_type: str)

Parameters

input_stream (BufferedReader) – Readable Stream representing the file.
media_type (str) – Media type to identify the file format.

Returns

A FileRef instance.

Return type

FileRef

+ +

+get_media_type(): returns the media type
+

+ +

+abstract save_as(local_file_path: str)

+ +

+abstract write_to_stream(writer_stream)

+ +

Module contents

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.pdfops.html b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.pdfops.html new file mode 100644 index 0000000..9e85ab8 --- /dev/null +++ b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.pdfops.html @@ -0,0 +1,287 @@ + + + + + + adobe.pdfservices.operation.pdfops package — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
adobe.pdfservices.operation.pdfops package
+

+ +

adobe.pdfservices.operation.pdfops package

Subpackages

adobe.pdfservices.operation.pdfops.options package
- Subpackages
  - adobe.pdfservices.operation.pdfops.options.extractpdf package
    +
  +
- Module contents
+

Submodules

adobe.pdfservices.operation.pdfops.extract_pdf_operation module

+class adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation(create_key)

Bases: adobe.pdfservices.operation.operation.Operation

An Operation that extracts pdf elements such as text and tables in a structured format from a PDF, along +with renditions for tables and figures.

Sample usage.

try:
+    base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+    credentials = Credentials.service_account_credentials_builder() \
+        .from_file(base_path + "/pdfservices-api-credentials.json") \
+        .build()
+
+    execution_context = ExecutionContext.create(credentials)
+    extract_pdf_operation = ExtractPDFOperation.create_new()
+
+    source = FileRef.create_from_local_file(base_path + "/resources/extractPdfInput.pdf")
+    extract_pdf_operation.set_input(source)
+
+    extract_pdf_options: ExtractPDFOptions = ExtractPDFOptions.builder() \
+        .with_elements_to_extract([ExtractElementType.TEXT, ExtractElementType.TABLES]) \
+        .with_elements_to_extract_renditions([ExtractRenditionsElementType.TABLES, ExtractRenditionsElementType.FIGURES]) \
+        .with_get_char_info(True) \
+        .with_include_styling_info(True) \
+        .build()
+    extract_pdf_operation.set_options(extract_pdf_options)
+
+    result: FileRef = extract_pdf_operation.execute(execution_context)
+
+    result.save_as(base_path + "/output/ExtractTextTableWithFigureTableRendition.zip")
+except (ServiceApiException, ServiceUsageException, SdkException):
+    logging.exception("Exception encountered while executing operation")
+

+

+SUPPORTED_SOURCE_MEDIA_TYPES = {adobe.pdfservices.operation.internal.extension_media_type_mapping.ExtensionMediaTypeMapping.PDF.mime_type}: Supported source file formats for ExtractPdfOperation is .pdf.
+

+ +

+classmethod create_new()

creates a new instance of ExtractPDFOperation.

Returns: A new instance of ExtractPDFOperation
+
Return type: ExtractPDFOperation
+

+ +

+execute(execution_context: adobe.pdfservices.operation.execution_context.ExecutionContext)

Parameters: execution_context (ExecutionContext) – The context in which the operation will be executed.
+
Returns: The FileRef to the result.
+
Return type: FileRef
+
Raises: ServiceApiException – if an API call results in an error response.
+

+ +

+get_options()

gets the ExtractPDFOptions.

Returns: The options parameter of the operation
+
Return type: ExtractPDFOptions
+

+ +

+set_input(source_file_ref: adobe.pdfservices.operation.io.file_ref.FileRef)

Sets an input file.

Parameters: source_file_ref (FileRef) – An input file.
+
Returns: This instance to add any additional parameters.
+
Return type: ExtractPDFOperation
+

+ +

+set_options(extract_pdf_options: adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions)

sets the ExtractPDFOptions.

Parameters: extract_pdf_options (ExtractPDFOptions) – ExtractPDFOptions to set.
+
Returns: This instance to add any additional parameters.
+
Return type: ExtractPDFOperation
+

+ +

Module contents

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.pdfops.options.extractpdf.html b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.pdfops.options.extractpdf.html new file mode 100644 index 0000000..bc28a4c --- /dev/null +++ b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.pdfops.options.extractpdf.html @@ -0,0 +1,399 @@ + + + + + + adobe.pdfservices.operation.pdfops.options.extractpdf package — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
adobe.pdfservices.operation.pdfops.options.extractpdf package
+

+ +

adobe.pdfservices.operation.pdfops.options.extractpdf package

Submodules

adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options module

Bases: object

An Options Class that defines the options for ExtractPDFOperation.

extract_pdf_options: ExtractPDFOptions = ExtractPDFOptions.builder() \
+    .with_elements_to_extract([ExtractElementType.TEXT, ExtractElementType.TABLES]) \
+    .with_get_char_info(True) \
+    .with_table_structure_format(TableStructureType.CSV) \
+    .with_elements_to_extract_renditions([ExtractRenditionsElementType.FIGURES, ExtractRenditionsElementType.TABLES]) \
+    .with_include_styling_info(True) \
+    .build()
+

+

+class Builder

Bases: object

The builder for ExtractPDFOptions.

+build()

+ +

+with_element_to_extract(element_to_extract: adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType)

adds a pdf element type for extracting structured information.

Parameters: element_to_extract (ExtractElementType) – ExtractElementType to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if element_to_extract is None.
+

+ +

+with_element_to_extract_renditions(element_to_extract_renditions: adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType)

adds a pdf element type for extracting rendition.

Parameters: element_to_extract_renditions (ExtractRenditionsElementType) – ExtractRenditionsElementType whose renditions have to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if element_to_extract_renditions is None.
+

+ +

+with_elements_to_extract(elements_to_extract: List[adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType])

adds a list of pdf element types for extracting structured information.

Parameters: elements_to_extract (List[ExtractElementType]) – List of ExtractElementType to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if elements_to_extract is None or empty list.
+

+ +

+with_elements_to_extract_renditions(elements_to_extract_renditions: List[adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType])

adds a list of pdf element types for extracting rendition.

Parameters: elements_to_extract_renditions (List[ExtractRenditionsElementType]) – List of ExtractRenditionsElementType whose renditions have to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if elements_to_extract is None or empty list.
+

+ +

+with_get_char_info(get_char_info: bool)

sets the Boolean specifying whether to add character level bounding boxes to output json

Parameters: get_char_info (bool) – Set True to extract character level bounding boxes information
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+

+ +

+with_include_styling_info(include_styling_info: bool)

sets the Boolean specifying whether to add PDF Elements Styling Info to output json

Parameters: include_styling_info (bool) – Set True to extract PDF Elements Styling Info
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+

+ +

+with_table_structure_format(table_structure: adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type.TableStructureType)

adds the table structure format (currently csv only) for extracting structured information.

Parameters: table_structure (TableStructureType) – TableStructureType to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if table_structure is None.
+

+ +

+static builder()

Returns a Builder for ExtractPDFOptions

Returns: The builder class for ExtractPDFOptions
+
Return type: ExtractPDFOptions.Builder
+

+ +

+property elements_to_extract: List of pdf element types to be extracted in a structured format from input file
+

+ +

+property elements_to_extract_renditions: List of pdf element types whose renditions needs to be extracted from input file
+

+ +

+property get_char_info: Boolean specifying whether to add character level bounding boxes to output json
+

+ +

+property include_styling_info: Boolean specifying whether to add PDF Elements Styling Info to output json
+

+ +

+property table_output_format: export table in specified format - currently csv supported
+

+ +

adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type module

+class adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType(value)

Bases: str, enum.Enum

enum of ElementTypes in a PDF which can be extracted as json.

+TABLES = 'tables'

+ +

+TEXT = 'text'

+ +

adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type module

+class adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType(value)

Bases: str, enum.Enum

enum of ElementTypes in a PDF which can be extracted as renditions.

+FIGURES = 'figures'

+ +

+TABLES = 'tables'

+ +

adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type module

+class adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type.TableStructureType(value)

Bases: str, enum.Enum

enum of TableStructureType in a PDF.

+CSV = 'csv'

+ +

Module contents

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.pdfops.options.html b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.pdfops.options.html new file mode 100644 index 0000000..68c1f2e --- /dev/null +++ b/docs/apidocs/2.1.2b1/adobe.pdfservices.operation.pdfops.options.html @@ -0,0 +1,148 @@ + + + + + + adobe.pdfservices.operation.pdfops.options package — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
adobe.pdfservices.operation.pdfops.options package
+

+ +

adobe.pdfservices.operation.pdfops.options package

Subpackages

adobe.pdfservices.operation.pdfops.options.extractpdf package
+

Module contents

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/genindex.html b/docs/apidocs/2.1.2b1/genindex.html new file mode 100644 index 0000000..8ad8f33 --- /dev/null +++ b/docs/apidocs/2.1.2b1/genindex.html @@ -0,0 +1,677 @@ + + + + + + Index — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
Index
+

+ + +

Index

+ +

+ A + | B + | C + | D + | E + | F + | G + | I + | M + | O + | P + | R + | S + | T + | W + +

A

+ + + +

account_id (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials property), [1] +
+ adobe + +
- module +
+ adobe.pdfservices + +
- module +
+ adobe.pdfservices.operation + +
- module +
+ adobe.pdfservices.operation.auth + +
- module +
+ adobe.pdfservices.operation.auth.credentials + +
- module +
+ adobe.pdfservices.operation.auth.service_account_credentials + +
- module +
+ adobe.pdfservices.operation.client_config + +
- module +
+ adobe.pdfservices.operation.exception + +
- module +
+ adobe.pdfservices.operation.exception.exceptions + +
- module, [1] +
+ adobe.pdfservices.operation.execution_context + +
- module +
+ adobe.pdfservices.operation.io + +
- module +

+ adobe.pdfservices.operation.io.file_ref + +
- module +
+ adobe.pdfservices.operation.operation + +
- module +
+ adobe.pdfservices.operation.pdfops + +
- module +
+ adobe.pdfservices.operation.pdfops.extract_pdf_operation + +
- module +
+ adobe.pdfservices.operation.pdfops.options + +
- module +
+ adobe.pdfservices.operation.pdfops.options.extractpdf + +
- module +
+ adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type + +
- module +
+ adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options + +
- module +
+ adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type + +
- module +
+ adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type + +
- module +
AutotagPDFOperation (class in adobe.pdfservices.operation.pdfops.autotag_pdf_operation) +
AutotagPDFOptions (class in adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options) +
AutotagPDFOptions.Builder (class in adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options) +

+ +

B

+ + + +

build() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] + +

Builder (class in adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials) + +
- (class in adobe.pdfservices.operation.client_config.ClientConfig) +
builder() (adobe.pdfservices.operation.client_config.ClientConfig static method), [1] + +
- (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions static method) +
- (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions static method), [1] +

+ +

C

+ + + +

claim (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials property), [1] +
client_id (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials property), [1] +
client_secret (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials property), [1] +
ClientConfig (class in adobe.pdfservices.operation.client_config), [1] +
ClientConfig.Builder (class in adobe.pdfservices.operation.client_config), [1] +
create() (adobe.pdfservices.operation.execution_context.ExecutionContext static method), [1] +

create_from_local_file() (adobe.pdfservices.operation.io.file_ref.FileRef static method), [1] +
create_from_stream() (adobe.pdfservices.operation.io.file_ref.FileRef static method), [1] +
create_new() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation class method) + +
- (adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation class method), [1] +
Credentials (class in adobe.pdfservices.operation.auth.credentials), [1] +
CSV (adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type.TableStructureType attribute) +

+ +

D

+ + + +

DEFAULT_ERROR_CODE (adobe.pdfservices.operation.exception.exceptions.ServiceApiException attribute), [1] + +
- (adobe.pdfservices.operation.exception.exceptions.ServiceUsageException attribute), [1] +

DEFAULT_STATUS_CODE (adobe.pdfservices.operation.exception.exceptions.ServiceApiException attribute), [1] + +
- (adobe.pdfservices.operation.exception.exceptions.ServiceUsageException attribute), [1] +

+ +

E

+ + + +

elements_to_extract (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions property), [1] +
elements_to_extract_renditions (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions property), [1] +
error_code (adobe.pdfservices.operation.exception.exceptions.ServiceApiException property), [1] + +
- (adobe.pdfservices.operation.exception.exceptions.ServiceUsageException property), [1] +
execute() (adobe.pdfservices.operation.operation.Operation method) + +
- (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation method) +
- (adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation method), [1] +

ExecutionContext (class in adobe.pdfservices.operation.execution_context), [1] +
ExtractElementType (class in adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type) +
ExtractPDFOperation (class in adobe.pdfservices.operation.pdfops.extract_pdf_operation), [1] +
ExtractPDFOptions (class in adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options), [1] +
ExtractPDFOptions.Builder (class in adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options), [1] +
ExtractRenditionsElementType (class in adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type) +

+ +

F

+ + + +

FIGURES (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType attribute) +
FileRef (class in adobe.pdfservices.operation.io.file_ref), [1] +

from_file() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] + +
- (adobe.pdfservices.operation.client_config.ClientConfig.Builder method), [1], [2] +

+ +

G

+ + + +

generate_report (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions property) +
get_char_info (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions property), [1] +

get_media_type() (adobe.pdfservices.operation.io.file_ref.FileRef method), [1] +
get_options() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation method) + +
- (adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation method), [1] +

+ +

I

+ + +

include_styling_info (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions property), [1] +

+ +

M

+ + +

+ module + +

+ +

O

+ + + +

Operation (class in adobe.pdfservices.operation.operation) +

organization_id (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials property), [1] +

+ +

P

+ + +

private_key (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials property), [1] +

+ +

R

+ + +

request_tracking_id (adobe.pdfservices.operation.exception.exceptions.SdkException property), [1] + +
- (adobe.pdfservices.operation.exception.exceptions.ServiceApiException property), [1] +
- (adobe.pdfservices.operation.exception.exceptions.ServiceUsageException property), [1] +

+ +

S

+ + + +

save_as() (adobe.pdfservices.operation.io.file_ref.FileRef method), [1] +
SdkException, [1] +
service_account_credentials_builder() (adobe.pdfservices.operation.auth.credentials.Credentials static method), [1] +
ServiceAccountCredentials (class in adobe.pdfservices.operation.auth.service_account_credentials), [1] +
ServiceAccountCredentials.Builder (class in adobe.pdfservices.operation.auth.service_account_credentials), [1] +
ServiceApiException, [1] +
ServiceUsageException, [1] +
set_input() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation method) + +
- (adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation method), [1] +

set_options() (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation method) + +
- (adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation method), [1] +
shift_headings (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions property) +
status_code (adobe.pdfservices.operation.exception.exceptions.ServiceApiException property), [1] + +
- (adobe.pdfservices.operation.exception.exceptions.ServiceUsageException property), [1] +
SUPPORTED_SOURCE_MEDIA_TYPES (adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation attribute) + +
- (adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation attribute), [1] +

+ +

T

+ + + +

table_output_format (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions property), [1] +
TABLES (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType attribute) + +
- (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType attribute) +

TableStructureType (class in adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type) +
TEXT (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType attribute) +

+ +

W

+ + + +

with_account_id() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_client_id() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_client_secret() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_connect_timeout() (adobe.pdfservices.operation.client_config.ClientConfig.Builder method), [1], [2] +
with_element_to_extract() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1] +
with_element_to_extract_renditions() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1] +
with_elements_to_extract() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1] +
with_elements_to_extract_renditions() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1] +

with_generate_report() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder method) +
with_get_char_info() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1] +
with_include_styling_info() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1] +
with_organization_id() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_private_key() (adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder method), [1], [2] +
with_read_timeout() (adobe.pdfservices.operation.client_config.ClientConfig.Builder method), [1], [2] +
with_shift_headings() (adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder method) +
with_table_structure_format() (adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder method), [1] +
write_to_stream() (adobe.pdfservices.operation.io.file_ref.FileRef method), [1] +

+ + + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/index.html b/docs/apidocs/2.1.2b1/index.html new file mode 100644 index 0000000..604d957 --- /dev/null +++ b/docs/apidocs/2.1.2b1/index.html @@ -0,0 +1,133 @@ + + + + + + pdfservices-sdk — pdfservices-sdk documentation + + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
pdfservices-sdk
+

+ +

pdfservices-sdk

This is the documentation of all the exposed classes and modules in the SDK. Please click on any Operation Class in the API Reference section on left nav to get started.

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/modules.html b/docs/apidocs/2.1.2b1/modules.html new file mode 100644 index 0000000..87a3ba5 --- /dev/null +++ b/docs/apidocs/2.1.2b1/modules.html @@ -0,0 +1,145 @@ + + + + + + src — pdfservices-sdk documentation + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

src

adobe package
- Subpackages
  - adobe.pdfservices package
    - Subpackages
    - Module contents
    +
  +
- Module contents
+

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/objects.inv b/docs/apidocs/2.1.2b1/objects.inv new file mode 100644 index 0000000..891e0ac Binary files /dev/null and b/docs/apidocs/2.1.2b1/objects.inv differ diff --git a/docs/apidocs/2.1.2b1/py-modindex.html b/docs/apidocs/2.1.2b1/py-modindex.html new file mode 100644 index 0000000..9aaf036 --- /dev/null +++ b/docs/apidocs/2.1.2b1/py-modindex.html @@ -0,0 +1,247 @@ + + + + + + Python Module Index — pdfservices-sdk documentation + + + + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
Python Module Index
+

+ + +

Python Module Index

+ +

+ a +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +


	+ a
	+ `adobe`	+
	+ `adobe.pdfservices`	+
	+ `adobe.pdfservices.operation`	+
	+ `adobe.pdfservices.operation.auth`	+
	+ `adobe.pdfservices.operation.auth.credentials`	+
	+ `adobe.pdfservices.operation.auth.service_account_credentials`	+
	+ `adobe.pdfservices.operation.client_config`	+
	+ `adobe.pdfservices.operation.exception`	+
	+ `adobe.pdfservices.operation.exception.exceptions`	+
	+ `adobe.pdfservices.operation.execution_context`	+
	+ `adobe.pdfservices.operation.io`	+
	+ `adobe.pdfservices.operation.io.file_ref`	+
	+ `adobe.pdfservices.operation.operation`	+
	+ `adobe.pdfservices.operation.pdfops`	+
	+ `adobe.pdfservices.operation.pdfops.extract_pdf_operation`	+
	+ `adobe.pdfservices.operation.pdfops.options`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type`	+
	+ `adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type`	+

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/reference/index.html b/docs/apidocs/2.1.2b1/reference/index.html new file mode 100644 index 0000000..8908c9c --- /dev/null +++ b/docs/apidocs/2.1.2b1/reference/index.html @@ -0,0 +1,1470 @@ + + + + + + Overview — pdfservices-sdk documentation + + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

»
Overview
+

+ +

Overview

Extract PDF

ExtractPDFOperation

+class adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation(create_key)

Bases: adobe.pdfservices.operation.operation.Operation

An Operation that extracts pdf elements such as text and tables in a structured format from a PDF, along +with renditions for tables and figures.

Sample usage.

try:
+    base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+    credentials = Credentials.service_account_credentials_builder() \
+        .from_file(base_path + "/pdfservices-api-credentials.json") \
+        .build()
+
+    execution_context = ExecutionContext.create(credentials)
+    extract_pdf_operation = ExtractPDFOperation.create_new()
+
+    source = FileRef.create_from_local_file(base_path + "/resources/extractPdfInput.pdf")
+    extract_pdf_operation.set_input(source)
+
+    extract_pdf_options: ExtractPDFOptions = ExtractPDFOptions.builder() \
+        .with_elements_to_extract([ExtractElementType.TEXT, ExtractElementType.TABLES]) \
+        .with_elements_to_extract_renditions([ExtractRenditionsElementType.TABLES, ExtractRenditionsElementType.FIGURES]) \
+        .with_get_char_info(True) \
+        .with_include_styling_info(True) \
+        .build()
+    extract_pdf_operation.set_options(extract_pdf_options)
+
+    result: FileRef = extract_pdf_operation.execute(execution_context)
+
+    result.save_as(base_path + "/output/ExtractTextTableWithFigureTableRendition.zip")
+except (ServiceApiException, ServiceUsageException, SdkException):
+    logging.exception("Exception encountered while executing operation")
+

+

+SUPPORTED_SOURCE_MEDIA_TYPES = {adobe.pdfservices.operation.internal.extension_media_type_mapping.ExtensionMediaTypeMapping.PDF.mime_type}: Supported source file formats for ExtractPdfOperation is .pdf.
+

+ +

+classmethod create_new()

creates a new instance of ExtractPDFOperation.

Returns: A new instance of ExtractPDFOperation
+
Return type: ExtractPDFOperation
+

+ +

+execute(execution_context: adobe.pdfservices.operation.execution_context.ExecutionContext)

Parameters: execution_context (ExecutionContext) – The context in which the operation will be executed.
+
Returns: The FileRef to the result.
+
Return type: FileRef
+
Raises: ServiceApiException – if an API call results in an error response.
+

+ +

+get_options()

gets the ExtractPDFOptions.

Returns: The options parameter of the operation
+
Return type: ExtractPDFOptions
+

+ +

+set_input(source_file_ref: adobe.pdfservices.operation.io.file_ref.FileRef)

Sets an input file.

Parameters: source_file_ref (FileRef) – An input file.
+
Returns: This instance to add any additional parameters.
+
Return type: ExtractPDFOperation
+

+ +

+set_options(extract_pdf_options: adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions)

sets the ExtractPDFOptions.

Parameters: extract_pdf_options (ExtractPDFOptions) – ExtractPDFOptions to set.
+
Returns: This instance to add any additional parameters.
+
Return type: ExtractPDFOperation
+

+ +

ExtractPDFOptions

Bases: object

An Options Class that defines the options for ExtractPDFOperation.

extract_pdf_options: ExtractPDFOptions = ExtractPDFOptions.builder() \
+    .with_elements_to_extract([ExtractElementType.TEXT, ExtractElementType.TABLES]) \
+    .with_get_char_info(True) \
+    .with_table_structure_format(TableStructureType.CSV) \
+    .with_elements_to_extract_renditions([ExtractRenditionsElementType.FIGURES, ExtractRenditionsElementType.TABLES]) \
+    .with_include_styling_info(True) \
+    .build()
+

+

+class Builder

Bases: object

The builder for ExtractPDFOptions.

+build()

+ +

+with_element_to_extract(element_to_extract: adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType)

adds a pdf element type for extracting structured information.

Parameters: element_to_extract (ExtractElementType) – ExtractElementType to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if element_to_extract is None.
+

+ +

+with_element_to_extract_renditions(element_to_extract_renditions: adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType)

adds a pdf element type for extracting rendition.

Parameters: element_to_extract_renditions (ExtractRenditionsElementType) – ExtractRenditionsElementType whose renditions have to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if element_to_extract_renditions is None.
+

+ +

+with_elements_to_extract(elements_to_extract: List[adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType])

adds a list of pdf element types for extracting structured information.

Parameters: elements_to_extract (List[ExtractElementType]) – List of ExtractElementType to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if elements_to_extract is None or empty list.
+

+ +

+with_elements_to_extract_renditions(elements_to_extract_renditions: List[adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType])

adds a list of pdf element types for extracting rendition.

Parameters: elements_to_extract_renditions (List[ExtractRenditionsElementType]) – List of ExtractRenditionsElementType whose renditions have to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if elements_to_extract is None or empty list.
+

+ +

+with_get_char_info(get_char_info: bool)

sets the Boolean specifying whether to add character level bounding boxes to output json

Parameters: get_char_info (bool) – Set True to extract character level bounding boxes information
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+

+ +

+with_include_styling_info(include_styling_info: bool)

sets the Boolean specifying whether to add PDF Elements Styling Info to output json

Parameters: include_styling_info (bool) – Set True to extract PDF Elements Styling Info
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+

+ +

+with_table_structure_format(table_structure: adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type.TableStructureType)

adds the table structure format (currently csv only) for extracting structured information.

Parameters: table_structure (TableStructureType) – TableStructureType to be extracted
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ExtractPDFOptions.Builder
+
Raises: ValueError – if table_structure is None.
+

+ +

+static builder()

Returns a Builder for ExtractPDFOptions

Returns: The builder class for ExtractPDFOptions
+
Return type: ExtractPDFOptions.Builder
+

+ +

+property elements_to_extract: List of pdf element types to be extracted in a structured format from input file
+

+ +

+property elements_to_extract_renditions: List of pdf element types whose renditions needs to be extracted from input file
+

+ +

+property get_char_info: Boolean specifying whether to add character level bounding boxes to output json
+

+ +

+property include_styling_info: Boolean specifying whether to add PDF Elements Styling Info to output json
+

+ +

+property table_output_format: export table in specified format - currently csv supported
+

+ +

Autotag PDF

AutotagPDFOperation

+class adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation(create_key)

Bases: adobe.pdfservices.operation.operation.Operation

An operation that enables clients to improve accessibility of the PDF document. It generates the tagged PDF, +along with an optional XLSX report providing detailed information about the added tags. The operation replaces any +existing tags within the input document, so it provides the most benefit for PDFs that have no tags or low-quality +tags.

Sample usage.

try:
+    base_path = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+    credentials = Credentials.service_account_credentials_builder() \
+        .from_file(base_path + "/pdfservices-api-credentials.json") \
+        .build()
+
+    execution_context = ExecutionContext.create(credentials)
+    autotag_pdf_operation = AutotagPDFOperation.create_new()
+
+    input_file_path = 'autotagPdfInput.pdf'
+    source = FileRef.create_from_local_file(base_path + "/resources/" + input_file_path)
+    autotag_pdf_operation.set_input(source)
+
+    autotag_pdf_options: AutotagPDFOptions = AutotagPDFOptions.builder() \
+        .with_shift_headings() \
+        .with_generate_report() \
+        .build()
+    autotag_pdf_operation.set_options(autotag_pdf_options)
+
+    autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context)
+
+    input_file_name = Path(input_file_path).stem
+    base_output_path = base_path + "/output/AutotagPDFWithOptions/"
+
+    Path(base_output_path).mkdir(parents=True, exist_ok=True)
+    tagged_pdf_path = f'{base_output_path}{input_file_name}-tagged.pdf'
+    report_path = f'{base_output_path}{input_file_name}-report.xlsx'
+
+    autotag_output_files.save_pdf_file(tagged_pdf_path)
+    autotag_output_files.save_xls_file(report_path)
+
+except (ServiceApiException, ServiceUsageException, SdkException) as e:
+    logging.exception(f'Exception encountered while executing operation: {e}')
+

+

+SUPPORTED_SOURCE_MEDIA_TYPES = {adobe.pdfservices.operation.internal.extension_media_type_mapping.ExtensionMediaTypeMapping.PDF.mime_type}: Supported source file formats for AutotagPdfOperation is .pdf.
+

+ +

+classmethod create_new()

creates a new instance of AutotagPDFOperation.

Returns: A new instance of AutotagPDFOperation
+
Return type: AutotagPDFOperation
+

+ +

+execute(execution_context: adobe.pdfservices.operation.execution_context.ExecutionContext)

Executes this operation synchronously using the supplied context and returns a new AutotagPDFOutputFiles +instance for the generated tagged pdf file and XLSX report file. The resulting file may be stored in the system +temporary directory. +See adobe.pdfservices.operation.io.file_ref.FileRef for how temporary resources are cleaned up.

Parameters: execution_context (ExecutionContext) – The context in which the operation will be executed.
+
Returns: The instance of AutotagPDFOutputFiles.
+
Return type: AutotagPDFOutputFiles
+
Raises: ServiceApiException – if an API call results in an error response.
+

+ +

+get_options()

gets the AutotagPDFOptions.

Returns: The options parameter of the operation
+
Return type: AutotagPDFOptions
+

+ +

+set_input(source_file_ref: adobe.pdfservices.operation.io.file_ref.FileRef)

Sets an input file.

Parameters: source_file_ref (FileRef) – An input file.
+
Returns: This instance to add any additional parameters.
+
Return type: AutotagPDFOperation
+

+ +

+set_options(autotag_pdf_options: adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions)

sets the AutotagPDFOptions.

Parameters: autotag_pdf_options (AutotagPDFOptions) – AutotagPDFOptions to set.
+
Returns: This instance to add any additional parameters.
+
Return type: AutotagPDFOperation
+

+ +

AutotagPDFOptions

+class adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions(generate_report, shift_headings)

Bases: object

An Options Class that defines the options for AutotagPDFOperation.

autotag_pdf_options: AutotagPDFOptions = AutotagPDFOptions.builder() \
+    .generate_report() \
+    .shift_headings() \
+    .build()
+

+

+class Builder

Bases: object

The builder for AutotagPDFOptions.

+build(): builds and returns the AutotagPDFOptions instance
+

+ +

+with_generate_report()

sets the Boolean specifying whether to generate an XLSX report containing the information about the tags

Returns: This Builder instance to add any additional parameters.
+
Return type: AutotagPDFOptions.Builder
+

+ +

+with_shift_headings()

sets the Boolean specifying whether to shift headings in the output PDF file

Returns: This Builder instance to add any additional parameters.
+
Return type: AutotagPDFOptions.Builder
+

+ +

+static builder()

Returns a Builder for AutotagPDFOptions

Returns: The builder class for AutotagPDFOptions
+
Return type: AutotagPDFOptions.Builder
+

+ +

+property generate_report: Boolean specifying whether to generate an XLSX report as an output
+

+ +

+property shift_headings: Boolean specifying whether to shift the headings in the output PDF file
+

+ +

Config

ClientConfig

+class adobe.pdfservices.operation.client_config.ClientConfig

Bases: object

Encapsulates the API request configurations

+class Builder

Bases: object

Builds a ClientConfig instance.

+build()

Returns a new ClientConfig instance built from the current state of this builder.

Returns: A ClientConfig instance.
+
Return type: ClientConfig
+

+ +

+from_file(client_config_file_path: str)

Sets the connect timeout and read timeout using the JSON client config file path. All the keys in the JSON structure are optional.

Parameters: client_config_file_path (str) – JSON client config file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

JSON structure:

{
+    "connectTimeout": "4000",
+    "readTimeout": "20000"
+}
+

+

+ +

+with_connect_timeout(connect_timeout: int)

Sets the connect timeout. It should be greater than zero.

Parameters: connect_timeout (int) – determines the timeout in milliseconds until a connection is established in the API calls. Default value is 4000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+with_read_timeout(read_timeout: int)

Sets the read timeout. It should be greater than zero.

Parameters: read_timeout (int) – Defines the read timeout in milliseconds, The number of milliseconds the client will wait for the server to send a response after the connection is established. Default value is 10000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+static builder()

Creates a new ClientConfig builder.

Returns: A ClientConfig.Builder instance.
+
Return type: ClientConfig.Builder
+

+ +

ClientConfigBuilder

+class adobe.pdfservices.operation.client_config.ClientConfig.Builder

Bases: object

Builds a ClientConfig instance.

+build()

Returns a new ClientConfig instance built from the current state of this builder.

Returns: A ClientConfig instance.
+
Return type: ClientConfig
+

+ +

+from_file(client_config_file_path: str)

Sets the connect timeout and read timeout using the JSON client config file path. All the keys in the JSON structure are optional.

Parameters: client_config_file_path (str) – JSON client config file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

JSON structure:

{
+    "connectTimeout": "4000",
+    "readTimeout": "20000"
+}
+

+

+ +

+with_connect_timeout(connect_timeout: int)

Sets the connect timeout. It should be greater than zero.

Parameters: connect_timeout (int) – determines the timeout in milliseconds until a connection is established in the API calls. Default value is 4000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

+with_read_timeout(read_timeout: int)

Sets the read timeout. It should be greater than zero.

Parameters: read_timeout (int) – Defines the read timeout in milliseconds, The number of milliseconds the client will wait for the server to send a response after the connection is established. Default value is 10000 milliseconds
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ClientConfig.Builder
+

+ +

ExecutionContext

+class adobe.pdfservices.operation.execution_context.ExecutionContext

Bases: object

Represents the execution context of an Operation. +An execution context typically consists of the desired authentication credentials and client configurations such as timeouts.

For each set of credentials, a ExecutionContext instance can be reused across operations.

Sample Usage:

try:
+    base_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+    credentials = Credentials.service_account_credentials_builder() \
+        .from_file(base_path + "/pdfservices-api-credentials.json") \
+        .build()
+
+    execution_context = ExecutionContext.create(credentials)
+    extract_pdf_operation = ExtractPDFOperation.create_new()
+
+    source = FileRef.create_from_local_file(base_path + "/resources/extractPdfInput.pdf")
+    extract_pdf_operation.set_input(source)
+
+    extract_pdf_options: ExtractPDFOptions = ExtractPDFOptions.builder() \
+        .with_elements_to_extract([ExtractElementType.TEXT, ExtractElementType.TABLES]) \
+        .with_elements_to_extract_renditions([ExtractRenditionsElementType.TABLES, ExtractRenditionsElementType.FIGURES]) \
+        .with_get_char_info(True) \
+        .build()
+    extract_pdf_operation.set_options(extract_pdf_options)
+
+    result: FileRef = extract_pdf_operation.execute(execution_context)
+
+    result.save_as(base_path + "/output/ExtractTextTableWithFigureTableRendition.zip")
+except (ServiceApiException, ServiceUsageException, SdkException):
+    logging.exception("Exception encountered while executing operation")
+

+

+static create(credentials: adobe.pdfservices.operation.auth.credentials.Credentials, client_config: Optional[adobe.pdfservices.operation.client_config.ClientConfig] = None)

Creates a context instance using the provided Credentials and ClientConfig

Parameters

credentials (Credentials) – A Credentials instance
client_config (ClientConfig, optional) – A ClientConfig instance for providing custom http timeouts, defaults to None

Returns

A new ExecutionContext instance

Return type

ExecutionContext

+ +

Auth

Credentials

+class adobe.pdfservices.operation.auth.credentials.Credentials

Bases: abc.ABC

+static service_account_credentials_builder()

Creates a new ServiceAccountCredentials builder.

Returns: An instance of ServiceAccountCredentials Builder.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

ServiceAccountCredentials

Bases: adobe.pdfservices.operation.auth.credentials.Credentials, abc.ABC

+class Builder

Bases: object

Builds a ServiceAccountCredentials instance.

+build()

Returns a new ServiceAccountCredentials instance built from the current state of this builder.

Returns: A ServiceAccountCredentials instance.
+
Return type: ServiceAccountCredentials
+

+ +

+from_file(credentials_file_path: str)

Sets Service Account Credentials using the JSON credentials file path. All the keys in the JSON structure are optional.

JSON structure:

{
+    "client_credentials": {
+    "client_id": "CLIENT_ID",
+    "client_secret": "CLIENT_SECRET"
+  },
+  "service_account_credentials": {
+    "organization_id": "org_ident@AdobeOrg",
+    "account_id": "id@techacct.adobe.com",
+    "private_key_file": "private.key"
+  }
+}
+

+

private_key_file is the path of private key file. It will be looked up in the classpath and the directory of JSON credentials file.

Parameters: credentials_file_path (str) – JSON credentials file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_account_id(account_id: str)

Set Account Id (format: id@techacct.adobe.com)

Parameters: account_id (str) – Account ID (format: id@techacct.adobe.com)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_id(client_id: str)

Set Client ID (API Key)

Parameters: client_id (str) – Client Id (API Key)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_secret(client_secret: str)

Set Client Secret

Parameters: client_secret (str) – Client Secret
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_organization_id(organization_id: str)

Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API

Parameters: organization_id (str) – Organization ID (format: org_ident@AdobeOrg)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_private_key(private_key: str)

Set private key

Parameters: private_key (str) – Content of the Private Key (PEM format)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+property account_id: Account ID(format: id@techacct.adobe.com)
+

+ +

+property claim: Identifies the Service for which Authorization(Access) Token will be issued
+

+ +

+property client_id: Client Id (API Key)
+

+ +

+property client_secret: Client Secret
+

+ +

+property organization_id: Identifies the organization(format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API.
+

+ +

+property private_key: Content of the Private Key (PEM format)
+

+ +

ServiceAccountCredentialsBuilder

+class adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder

Bases: object

Builds a ServiceAccountCredentials instance.

+build()

Returns a new ServiceAccountCredentials instance built from the current state of this builder.

Returns: A ServiceAccountCredentials instance.
+
Return type: ServiceAccountCredentials
+

+ +

+from_file(credentials_file_path: str)

Sets Service Account Credentials using the JSON credentials file path. All the keys in the JSON structure are optional.

JSON structure:

{
+    "client_credentials": {
+    "client_id": "CLIENT_ID",
+    "client_secret": "CLIENT_SECRET"
+  },
+  "service_account_credentials": {
+    "organization_id": "org_ident@AdobeOrg",
+    "account_id": "id@techacct.adobe.com",
+    "private_key_file": "private.key"
+  }
+}
+

+

private_key_file is the path of private key file. It will be looked up in the classpath and the directory of JSON credentials file.

Parameters: credentials_file_path (str) – JSON credentials file path
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_account_id(account_id: str)

Set Account Id (format: id@techacct.adobe.com)

Parameters: account_id (str) – Account ID (format: id@techacct.adobe.com)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_id(client_id: str)

Set Client ID (API Key)

Parameters: client_id (str) – Client Id (API Key)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_client_secret(client_secret: str)

Set Client Secret

Parameters: client_secret (str) – Client Secret
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_organization_id(organization_id: str)

Set Organization Id (format: org_ident@AdobeOrg) that has been configured for access to PDF Tools API

Parameters: organization_id (str) – Organization ID (format: org_ident@AdobeOrg)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

+with_private_key(private_key: str)

Set private key

Parameters: private_key (str) – Content of the Private Key (PEM format)
+
Returns: This Builder instance to add any additional parameters.
+
Return type: ServiceAccountCredentials.Builder
+

+ +

IO

FileRef

+class adobe.pdfservices.operation.io.file_ref.FileRef

Bases: abc.ABC

This class represents a local file. It is typically used by an SDK Operation which accepts or returns files.

+static create_from_local_file(local_source: str, media_type: Optional[str] = None)

Creates a FileRef instance from a local file path. If no media type is provided, it will be inferred +from the file extension.

Parameters

local_source (str) – Local file path, either absolute path or relative to the working directory.
media_type (str, optional, defaults to None) – Media type to identify the local file format, defaults to None

Returns

A FileRef instance.

Return type

FileRef

+ +

+static create_from_stream(input_stream: _io.BufferedReader, media_type: str)

Parameters

input_stream (BufferedReader) – Readable Stream representing the file.
media_type (str) – Media type to identify the file format.

Returns

A FileRef instance.

Return type

FileRef

+ +

+get_media_type(): returns the media type
+

+ +

+abstract save_as(local_file_path: str)

+ +

+abstract write_to_stream(writer_stream)

+ +

Exceptions

+exception adobe.pdfservices.operation.exception.exceptions.SdkException(message, request_tracking_id=None)

Bases: Exception

SdkException is typically thrown for client-side or network errors.

+property request_tracking_id: The request tracking id of the exception.
+

+ +

+exception adobe.pdfservices.operation.exception.exceptions.ServiceApiException(message, request_tracking_id, status_code=0, error_code='UNKNOWN')

Bases: Exception

ServiceApiException is thrown when an underlying service API call results in an error.

+DEFAULT_ERROR_CODE = 'UNKNOWN': Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.
+

+ +

+DEFAULT_STATUS_CODE = 0: The default value of status code if there is no status code for this service exception.
+

+ +

+property error_code: Returns the detailed message of this error.
+

+ +

+property request_tracking_id: The request tracking id of the exception.
+

+ +

+property status_code: Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.
+

+ +

+exception adobe.pdfservices.operation.exception.exceptions.ServiceUsageException(message, request_tracking_id, status_code=429, error_code='UNKNOWN')

Bases: Exception

ServiceUsageError is thrown when either service usage limit has been reached or credentials quota has been exhausted.

+DEFAULT_ERROR_CODE = 'UNKNOWN': The default value of error code if there is no status code for this service failure.
+

+ +

+DEFAULT_STATUS_CODE = 429: The default value of status code if there is no status code for this service failure.
+

+ +

+property error_code: Returns the detailed message of this error.
+

+ +

+property request_tracking_id: The request tracking id of the exception.
+

+ +

+property status_code: Returns the HTTP Status code or DEFAULT_STATUS_CODE if the status code doesn’t adequately represent the error.
+

+ +

+ + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/search.html b/docs/apidocs/2.1.2b1/search.html new file mode 100644 index 0000000..0c49346 --- /dev/null +++ b/docs/apidocs/2.1.2b1/search.html @@ -0,0 +1,147 @@ + + + + + + Search — pdfservices-sdk documentation + + + + + + + + + + + + + + + + + + +

+ pdfservices-sdk + +

+ + + +

Overview
- Extract PDF
  - ExtractPDFOperation
  - ExtractPDFOptions
  +
- Autotag PDF
  - AutotagPDFOperation
  - AutotagPDFOptions
  +
- Config
  - ClientConfig
  - ClientConfigBuilder
  - ExecutionContext
  +
- Auth
  +
- IO
  - FileRef
  +
- Exceptions
  - Exceptions
  +
+

+ +

+ + pdfservices-sdk +

+ +

+ + + + +

+ +

+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +

+ + + + + + + + + \ No newline at end of file diff --git a/docs/apidocs/2.1.2b1/searchindex.js b/docs/apidocs/2.1.2b1/searchindex.js new file mode 100644 index 0000000..b82d794 --- /dev/null +++ b/docs/apidocs/2.1.2b1/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["adobe","adobe.pdfservices","adobe.pdfservices.operation","adobe.pdfservices.operation.auth","adobe.pdfservices.operation.exception","adobe.pdfservices.operation.io","adobe.pdfservices.operation.pdfops","adobe.pdfservices.operation.pdfops.options","adobe.pdfservices.operation.pdfops.options.extractpdf","index","modules","reference/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["adobe.rst","adobe.pdfservices.rst","adobe.pdfservices.operation.rst","adobe.pdfservices.operation.auth.rst","adobe.pdfservices.operation.exception.rst","adobe.pdfservices.operation.io.rst","adobe.pdfservices.operation.pdfops.rst","adobe.pdfservices.operation.pdfops.options.rst","adobe.pdfservices.operation.pdfops.options.extractpdf.rst","index.rst","modules.rst","reference/index.rst"],objects:{"":[[0,0,0,"-","adobe"]],"adobe.pdfservices":[[2,0,0,"-","operation"]],"adobe.pdfservices.operation":[[3,0,0,"-","auth"],[2,0,0,"-","client_config"],[4,0,0,"-","exception"],[2,0,0,"-","execution_context"],[5,0,0,"-","io"],[2,0,0,"-","operation"],[6,0,0,"-","pdfops"]],"adobe.pdfservices.operation.auth":[[3,0,0,"-","credentials"],[3,0,0,"-","service_account_credentials"]],"adobe.pdfservices.operation.auth.credentials":[[11,1,1,"","Credentials"]],"adobe.pdfservices.operation.auth.credentials.Credentials":[[11,2,1,"","service_account_credentials_builder"]],"adobe.pdfservices.operation.auth.service_account_credentials":[[11,1,1,"","ServiceAccountCredentials"]],"adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials":[[11,1,1,"id5","Builder"],[11,3,1,"","account_id"],[11,3,1,"","claim"],[11,3,1,"","client_id"],[11,3,1,"","client_secret"],[11,3,1,"","organization_id"],[11,3,1,"","private_key"]],"adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder":[[11,2,1,"id6","build"],[11,2,1,"id7","from_file"],[11,2,1,"id8","with_account_id"],[11,2,1,"id9","with_client_id"],[11,2,1,"id10","with_client_secret"],[11,2,1,"id11","with_organization_id"],[11,2,1,"id12","with_private_key"]],"adobe.pdfservices.operation.client_config":[[11,1,1,"","ClientConfig"]],"adobe.pdfservices.operation.client_config.ClientConfig":[[11,1,1,"id0","Builder"],[11,2,1,"","builder"]],"adobe.pdfservices.operation.client_config.ClientConfig.Builder":[[11,2,1,"id1","build"],[11,2,1,"id2","from_file"],[11,2,1,"id3","with_connect_timeout"],[11,2,1,"id4","with_read_timeout"]],"adobe.pdfservices.operation.exception":[[11,0,0,"-","exceptions"]],"adobe.pdfservices.operation.exception.exceptions":[[11,4,1,"","SdkException"],[11,4,1,"","ServiceApiException"],[11,4,1,"","ServiceUsageException"]],"adobe.pdfservices.operation.exception.exceptions.SdkException":[[11,3,1,"","request_tracking_id"]],"adobe.pdfservices.operation.exception.exceptions.ServiceApiException":[[11,5,1,"","DEFAULT_ERROR_CODE"],[11,5,1,"","DEFAULT_STATUS_CODE"],[11,3,1,"","error_code"],[11,3,1,"","request_tracking_id"],[11,3,1,"","status_code"]],"adobe.pdfservices.operation.exception.exceptions.ServiceUsageException":[[11,5,1,"","DEFAULT_ERROR_CODE"],[11,5,1,"","DEFAULT_STATUS_CODE"],[11,3,1,"","error_code"],[11,3,1,"","request_tracking_id"],[11,3,1,"","status_code"]],"adobe.pdfservices.operation.execution_context":[[11,1,1,"","ExecutionContext"]],"adobe.pdfservices.operation.execution_context.ExecutionContext":[[11,2,1,"","create"]],"adobe.pdfservices.operation.io":[[5,0,0,"-","file_ref"]],"adobe.pdfservices.operation.io.file_ref":[[11,1,1,"","FileRef"]],"adobe.pdfservices.operation.io.file_ref.FileRef":[[11,2,1,"","create_from_local_file"],[11,2,1,"","create_from_stream"],[11,2,1,"","get_media_type"],[11,2,1,"","save_as"],[11,2,1,"","write_to_stream"]],"adobe.pdfservices.operation.operation":[[2,1,1,"","Operation"]],"adobe.pdfservices.operation.operation.Operation":[[2,2,1,"","execute"]],"adobe.pdfservices.operation.pdfops":[[6,0,0,"-","extract_pdf_operation"],[7,0,0,"-","options"]],"adobe.pdfservices.operation.pdfops.autotag_pdf_operation":[[11,1,1,"","AutotagPDFOperation"]],"adobe.pdfservices.operation.pdfops.autotag_pdf_operation.AutotagPDFOperation":[[11,5,1,"","SUPPORTED_SOURCE_MEDIA_TYPES"],[11,2,1,"","create_new"],[11,2,1,"","execute"],[11,2,1,"","get_options"],[11,2,1,"","set_input"],[11,2,1,"","set_options"]],"adobe.pdfservices.operation.pdfops.extract_pdf_operation":[[11,1,1,"","ExtractPDFOperation"]],"adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation":[[11,5,1,"","SUPPORTED_SOURCE_MEDIA_TYPES"],[11,2,1,"","create_new"],[11,2,1,"","execute"],[11,2,1,"","get_options"],[11,2,1,"","set_input"],[11,2,1,"","set_options"]],"adobe.pdfservices.operation.pdfops.options":[[8,0,0,"-","extractpdf"]],"adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options":[[11,1,1,"","AutotagPDFOptions"]],"adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions":[[11,1,1,"","Builder"],[11,2,1,"","builder"],[11,3,1,"","generate_report"],[11,3,1,"","shift_headings"]],"adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options.AutotagPDFOptions.Builder":[[11,2,1,"","build"],[11,2,1,"","with_generate_report"],[11,2,1,"","with_shift_headings"]],"adobe.pdfservices.operation.pdfops.options.extractpdf":[[8,0,0,"-","extract_element_type"],[8,0,0,"-","extract_pdf_options"],[8,0,0,"-","extract_renditions_element_type"],[8,0,0,"-","table_structure_type"]],"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type":[[8,1,1,"","ExtractElementType"]],"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType":[[8,5,1,"","TABLES"],[8,5,1,"","TEXT"]],"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options":[[11,1,1,"","ExtractPDFOptions"]],"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions":[[11,1,1,"","Builder"],[11,2,1,"","builder"],[11,3,1,"","elements_to_extract"],[11,3,1,"","elements_to_extract_renditions"],[11,3,1,"","get_char_info"],[11,3,1,"","include_styling_info"],[11,3,1,"","table_output_format"]],"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder":[[11,2,1,"","build"],[11,2,1,"","with_element_to_extract"],[11,2,1,"","with_element_to_extract_renditions"],[11,2,1,"","with_elements_to_extract"],[11,2,1,"","with_elements_to_extract_renditions"],[11,2,1,"","with_get_char_info"],[11,2,1,"","with_include_styling_info"],[11,2,1,"","with_table_structure_format"]],"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type":[[8,1,1,"","ExtractRenditionsElementType"]],"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType":[[8,5,1,"","FIGURES"],[8,5,1,"","TABLES"]],"adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type":[[8,1,1,"","TableStructureType"]],"adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type.TableStructureType":[[8,5,1,"","CSV"]],adobe:[[1,0,0,"-","pdfservices"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","property","Python property"],"4":["py","exception","Python exception"],"5":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:property","4":"py:exception","5":"py:attribute"},terms:{"0":[4,11],"10000":[2,11],"20000":[2,11],"4000":[2,11],"429":[4,11],"abstract":[2,5,11],"boolean":[8,11],"class":[2,3,5,6,8,9,11],"default":[2,4,5,11],"enum":8,"export":[8,11],"int":[2,11],"new":[2,3,6,11],"return":[2,3,4,5,6,8,11],"static":[2,3,5,8,11],"true":[2,6,8,11],"try":[2,6,11],"while":[2,5,6,11],A:[2,3,5,6,11],For:[2,3,5,11],If:[5,11],It:[2,3,5,11],The:[2,3,4,5,6,8,11],__file__:[2,6,11],_io:[5,11],abc:[2,3,5,11],about:11,absolut:[5,11],abspath:[2,6,11],accept:[5,11],access:[3,11],account:[3,11],account_id:[3,11],across:[2,11],ad:11,add:[2,3,6,8,11],addit:[2,3,6,8,11],adequ:[4,11],adob:[10,11],adobeorg:[3,11],after:[2,11],all:[2,3,9,11],allow:[3,11],along:[6,11],an:[2,3,4,5,6,8,11],ani:[2,3,5,6,8,9,11],api:[2,3,4,6,9,11],applic:[3,11],ar:[2,3,6,11],auth:[1,2],authent:[2,11],author:[3,11],autotag_output_fil:11,autotag_pdf_oper:11,autotag_pdf_opt:11,autotagpdf:11,autotagpdfinput:11,autotagpdfoutputfil:11,autotagpdfwithopt:11,base:[2,3,4,5,6,8,11],base_output_path:11,base_path:[2,6,11],been:[3,4,11],behalf:[3,11],benefit:11,bool:[8,11],bound:[8,11],box:[8,11],bufferedread:[5,11],build:[2,3,6,8,11],builder:[2,3,6,8,11],built:[2,3,11],call:[2,3,4,5,6,11],can:[2,3,8,11],charact:[8,11],claim:[3,11],classmethod:[6,11],classpath:[3,11],clean:[6,11],click:[3,9,11],client:[2,3,4,11],client_config:[0,1,11],client_config_file_path:[2,11],client_credenti:[3,11],client_id:[3,11],client_secret:[3,11],clientconfig:2,code:[4,11],com:[3,11],config:2,configur:[2,3,11],connect:[2,11],connect_timeout:[2,11],connecttimeout:[2,11],consist:[2,11],constant:[3,11],consum:[5,11],contain:11,content:[10,11],context:[2,6,11],creat:[2,3,5,6,11],create_from_local_fil:[2,5,6,11],create_from_stream:[5,11],create_kei:[6,11],create_new:[2,6,11],credenti:[1,2,4,6],credentials_file_path:[3,11],csv:[8,11],current:[2,3,8,11],custom:[2,11],default_error_cod:[4,11],default_status_cod:[4,11],defin:[2,8,11],delet:[5,11],desir:[2,11],detail:[4,11],determin:[2,11],differ:[3,11],directori:[3,5,6,11],dirnam:[2,6,11],document:[9,11],doesn:[4,11],e:[5,11],each:[2,11],either:[4,5,11],element:[6,8,11],element_to_extract:[8,11],element_to_extract_rendit:[8,11],elements_to_extract:[8,11],elements_to_extract_rendit:[8,11],elementtyp:8,empti:[8,11],enabl:11,encapsul:[2,11],encount:[2,6,11],enterpris:[3,11],error:[4,6,11],error_cod:[4,11],establish:[2,11],etc:[5,11],eu:[],exampl:[5,11],except:[1,2,6],execut:[2,5,6,11],execution_context:[0,1,6,11],executioncontext:[2,6],exhaust:[4,11],exist:11,exist_ok:11,expos:9,extens:[5,11],extension_media_type_map:[6,11],extensionmediatypemap:[6,11],extract:[3,6,8],extract_element_typ:[6,7,11],extract_pdf_oper:[1,2,11],extract_pdf_opt:[2,6,7,11],extract_renditions_element_typ:[6,7,11],extractelementtyp:[2,6,8,11],extractpdf:[6,7,11],extractpdfinput:[2,6,11],extractpdfoper:[2,6,8],extractpdfopt:[2,6,8],extractrenditionselementtyp:[2,6,8,11],extracttexttablewithfiguretablerendit:[2,6,11],f:11,factori:[3,11],failur:[4,11],figur:[2,6,8,11],file:[2,3,5,6,8,11],file_ref:[1,2,6,11],fileref:[2,5,6],format:[3,5,6,8,11],from:[2,3,5,6,8,11],from_fil:[2,3,6,11],gener:11,generate_report:11,get:[3,6,9,11],get_char_info:[8,11],get_media_typ:[5,11],get_opt:[6,11],greater:[2,11],ha:[3,4,11],have:[8,11],head:11,here:[3,11],how:[6,11],http:[2,4,11],i:[5,11],id:[3,4,11],identifi:[3,5,11],improv:11,ims_base_uri:[3,11],include_styling_info:[8,11],infer:[5,11],info:[8,11],inform:[8,11],input:[6,8,11],input_file_nam:11,input_file_path:11,input_stream:[5,11],instanc:[2,3,5,6,8,11],intern:[3,6,11],io:[1,2,6],issu:[3,11],itself:[3,11],json:[2,3,6,8,11],jwt_base_uri:[3,11],kei:[2,3,11],left:9,level:[8,11],limit:[4,11],link:[],list:[8,11],local:[5,11],local_file_path:[5,11],local_sourc:[5,11],locat:[5,11],log:[2,6,11],look:[3,11],low:11,mai:[6,11],marker:[3,11],media:[5,11],media_typ:[5,11],messag:[4,11],method:[3,5,11],millisecond:[2,11],mime_typ:[6,11],mkdir:11,modul:[9,10],most:11,nav:9,need:[8,11],network:[4,11],none:[2,3,4,5,8,11],number:[2,11],object:[2,3,8,11],onli:[3,8,11],oper:[0,1,9,11],option:[2,3,5,6,11],org_id:[3,11],organ:[3,11],organization_id:[3,11],os:[2,6,11],output:[2,6,8,11],packag:10,param:[],paramet:[2,3,5,6,8,11],parent:11,path:[2,3,5,6,11],pdf:[2,3,6,8],pdf_services_uri:[],pdf_services_url:[],pdfop:[1,2,11],pdfservic:[0,10,11],pem:[3,11],pleas:9,privat:[3,11],private_kei:[3,11],private_key_fil:[3,11],properti:[3,4,8,11],provid:[2,5,11],qualiti:11,quota:[4,11],rais:[6,8,11],reach:[4,11],read:[2,5,11],read_timeout:[2,11],readabl:[5,11],readtimeout:[2,11],refer:[5,9,11],region:[],rel:[5,11],relev:[],rendit:[6,8,11],replac:11,report:11,report_path:11,repres:[2,4,5,11],request:[2,4,11],request_tracking_id:[4,11],resourc:[2,6,11],respons:[2,6,11],rest:[],result:[2,4,6,11],reus:[2,11],rtype:[],sampl:[2,6,11],save:[5,11],save_a:[2,5,6,11],save_pdf_fil:11,save_xls_fil:11,sdk:[5,11],sdkexcept:[2,4,6,11],secret:[3,11],section:9,see:[6,11],send:[2,11],server:[2,11],servic:[3,4,11],service_account_credenti:[1,2,11],service_account_credentials_build:[2,3,6,11],service_const:[3,11],serviceaccountcredenti:3,serviceapiexcept:[2,4,6,11],serviceconst:[3,11],serviceusageerror:[4,11],serviceusageexcept:[2,4,6,11],set:[2,3,6,8,11],set_input:[2,6,11],set_opt:[2,6,11],shift:11,shift_head:11,should:[2,11],side:[4,11],so:11,sourc:[2,6,11],source_file_ref:[6,11],specifi:[5,8,11],start:9,state:[2,3,11],statu:[4,11],status_cod:[4,11],stem:11,store:[6,11],str:[2,3,5,8,11],stream:[5,11],structur:[2,3,6,8,11],style:[8,11],submodul:[0,1,7],subpackag:10,suppli:[6,11],support:[3,6,8,11],supported_source_media_typ:[6,11],synchron:[6,11],system:[6,11],t:[4,11],tabl:[2,6,8,11],table_output_format:[8,11],table_structur:[8,11],table_structure_typ:[6,7,11],tablestructuretyp:[8,11],tag:11,tagged_pdf_path:11,techacct:[3,11],temporari:[5,6,11],text:[2,6,8,11],than:[2,11],thi:[2,3,4,5,6,8,9,11],thrown:[4,11],timeout:[2,11],token:[3,11],tool:[3,11],track:[4,11],type:[2,3,5,6,8,11],typic:[2,4,5,11],underli:[4,11],unknown:[4,11],until:[2,11],up:[3,6,11],updat:[],uri:[],url:[],us:[2,3,5,6,11],usag:[2,4,6,11],valu:[2,4,8,11],valueerror:[8,11],wait:[2,11],when:[4,5,11],whether:[8,11],which:[3,5,6,8,11],whose:[8,11],with_account_id:[3,11],with_client_id:[3,11],with_client_secret:[3,11],with_connect_timeout:[2,11],with_element_to_extract:[8,11],with_element_to_extract_rendit:[8,11],with_elements_to_extract:[2,6,8,11],with_elements_to_extract_rendit:[2,6,8,11],with_generate_report:11,with_get_char_info:[2,6,8,11],with_include_styling_info:[6,8,11],with_organization_id:[3,11],with_pdf_services_uri:[],with_private_kei:[3,11],with_read_timeout:[2,11],with_region:[],with_shift_head:11,with_table_structure_format:[8,11],within:[3,11],work:[5,11],write_to_stream:[5,11],writer_stream:[5,11],xlsx:11,your:[3,11],zero:[2,11],zip:[2,6,11]},titles:["adobe package","adobe.pdfservices package","adobe.pdfservices.operation package","adobe.pdfservices.operation.auth package","adobe.pdfservices.operation.exception package","adobe.pdfservices.operation.io package","adobe.pdfservices.operation.pdfops package","adobe.pdfservices.operation.pdfops.options package","adobe.pdfservices.operation.pdfops.options.extractpdf package","pdfservices-sdk","src","Overview"],titleterms:{adob:[0,1,2,3,4,5,6,7,8],auth:[3,11],autotag:11,autotagpdfoper:11,autotagpdfopt:11,client_config:2,clientconfig:11,clientconfigbuild:11,config:11,content:[0,1,2,3,4,5,6,7,8],credenti:[3,11],except:[4,11],execution_context:2,executioncontext:11,extract:11,extract_element_typ:8,extract_pdf_oper:6,extract_pdf_opt:8,extract_renditions_element_typ:8,extractpdf:8,extractpdfoper:11,extractpdfopt:11,file_ref:5,fileref:11,io:[5,11],modul:[0,1,2,3,4,5,6,7,8],oper:[2,3,4,5,6,7,8],option:[7,8],overview:11,packag:[0,1,2,3,4,5,6,7,8],pdf:11,pdfop:[6,7,8],pdfservic:[1,2,3,4,5,6,7,8,9],sdk:9,service_account_credenti:3,serviceaccountcredenti:11,serviceaccountcredentialsbuild:11,src:10,submodul:[2,3,4,5,6,8],subpackag:[0,1,2,6,7],table_structure_typ:8}}) \ No newline at end of file diff --git a/docs/apidocs/beta b/docs/apidocs/beta new file mode 120000 index 0000000..42e8d27 --- /dev/null +++ b/docs/apidocs/beta @@ -0,0 +1 @@ +2.1.2b1/ \ No newline at end of file diff --git a/docs/apidocs/latest b/docs/apidocs/latest new file mode 120000 index 0000000..1652a67 --- /dev/null +++ b/docs/apidocs/latest @@ -0,0 +1 @@ +2.1.2/ \ No newline at end of file diff --git a/docs/apidocs/latest/objects.inv b/docs/apidocs/latest/objects.inv deleted file mode 100644 index bd345f5..0000000 Binary files a/docs/apidocs/latest/objects.inv and /dev/null differ diff --git a/docs/apidocs/latest/searchindex.js b/docs/apidocs/latest/searchindex.js deleted file mode 100644 index 9180435..0000000 --- a/docs/apidocs/latest/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({docnames:["adobe","adobe.pdfservices","adobe.pdfservices.operation","adobe.pdfservices.operation.auth","adobe.pdfservices.operation.exception","adobe.pdfservices.operation.io","adobe.pdfservices.operation.pdfops","adobe.pdfservices.operation.pdfops.options","adobe.pdfservices.operation.pdfops.options.extractpdf","index","modules","reference/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["adobe.rst","adobe.pdfservices.rst","adobe.pdfservices.operation.rst","adobe.pdfservices.operation.auth.rst","adobe.pdfservices.operation.exception.rst","adobe.pdfservices.operation.io.rst","adobe.pdfservices.operation.pdfops.rst","adobe.pdfservices.operation.pdfops.options.rst","adobe.pdfservices.operation.pdfops.options.extractpdf.rst","index.rst","modules.rst","reference/index.rst"],objects:{"":{adobe:[0,0,0,"-"]},"adobe.pdfservices":{operation:[2,0,0,"-"]},"adobe.pdfservices.operation":{auth:[3,0,0,"-"],client_config:[2,0,0,"-"],exception:[4,0,0,"-"],execution_context:[2,0,0,"-"],io:[5,0,0,"-"],operation:[2,0,0,"-"],pdfops:[6,0,0,"-"]},"adobe.pdfservices.operation.auth":{credentials:[3,0,0,"-"],service_account_credentials:[3,0,0,"-"]},"adobe.pdfservices.operation.auth.credentials":{Credentials:[11,1,1,""]},"adobe.pdfservices.operation.auth.credentials.Credentials":{service_account_credentials_builder:[11,2,1,""]},"adobe.pdfservices.operation.auth.service_account_credentials":{ServiceAccountCredentials:[11,1,1,""]},"adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials":{Builder:[11,1,1,"id5"],account_id:[11,3,1,""],claim:[11,3,1,""],client_id:[11,3,1,""],client_secret:[11,3,1,""],organization_id:[11,3,1,""],private_key:[11,3,1,""]},"adobe.pdfservices.operation.auth.service_account_credentials.ServiceAccountCredentials.Builder":{build:[11,2,1,"id6"],from_file:[11,2,1,"id7"],with_account_id:[11,2,1,"id8"],with_client_id:[11,2,1,"id9"],with_client_secret:[11,2,1,"id10"],with_organization_id:[11,2,1,"id11"],with_private_key:[11,2,1,"id12"]},"adobe.pdfservices.operation.client_config":{ClientConfig:[11,1,1,""]},"adobe.pdfservices.operation.client_config.ClientConfig":{Builder:[11,1,1,"id0"],builder:[11,2,1,""]},"adobe.pdfservices.operation.client_config.ClientConfig.Builder":{build:[11,2,1,"id1"],from_file:[11,2,1,"id2"],with_connect_timeout:[11,2,1,"id3"],with_read_timeout:[11,2,1,"id4"]},"adobe.pdfservices.operation.exception":{exceptions:[11,0,0,"-"]},"adobe.pdfservices.operation.exception.exceptions":{SdkException:[11,4,1,""],ServiceApiException:[11,4,1,""],ServiceUsageException:[11,4,1,""]},"adobe.pdfservices.operation.exception.exceptions.SdkException":{request_tracking_id:[11,3,1,""]},"adobe.pdfservices.operation.exception.exceptions.ServiceApiException":{DEFAULT_ERROR_CODE:[11,5,1,""],DEFAULT_STATUS_CODE:[11,5,1,""],error_code:[11,3,1,""],request_tracking_id:[11,3,1,""],status_code:[11,3,1,""]},"adobe.pdfservices.operation.exception.exceptions.ServiceUsageException":{DEFAULT_ERROR_CODE:[11,5,1,""],DEFAULT_STATUS_CODE:[11,5,1,""],error_code:[11,3,1,""],request_tracking_id:[11,3,1,""],status_code:[11,3,1,""]},"adobe.pdfservices.operation.execution_context":{ExecutionContext:[11,1,1,""]},"adobe.pdfservices.operation.execution_context.ExecutionContext":{create:[11,2,1,""]},"adobe.pdfservices.operation.io":{file_ref:[5,0,0,"-"]},"adobe.pdfservices.operation.io.file_ref":{FileRef:[11,1,1,""]},"adobe.pdfservices.operation.io.file_ref.FileRef":{create_from_local_file:[11,2,1,""],create_from_stream:[11,2,1,""],save_as:[11,2,1,""],write_to_stream:[11,2,1,""]},"adobe.pdfservices.operation.operation":{Operation:[2,1,1,""]},"adobe.pdfservices.operation.operation.Operation":{execute:[2,2,1,""]},"adobe.pdfservices.operation.pdfops":{extract_pdf_operation:[6,0,0,"-"],options:[7,0,0,"-"]},"adobe.pdfservices.operation.pdfops.extract_pdf_operation":{ExtractPDFOperation:[11,1,1,""]},"adobe.pdfservices.operation.pdfops.extract_pdf_operation.ExtractPDFOperation":{SUPPORTED_SOURCE_MEDIA_TYPES:[11,5,1,""],create_new:[11,2,1,""],execute:[11,2,1,""],set_input:[11,2,1,""],set_options:[11,2,1,""]},"adobe.pdfservices.operation.pdfops.options":{extractpdf:[8,0,0,"-"]},"adobe.pdfservices.operation.pdfops.options.extractpdf":{extract_element_type:[8,0,0,"-"],extract_pdf_options:[8,0,0,"-"],extract_renditions_element_type:[8,0,0,"-"],table_structure_type:[8,0,0,"-"]},"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type":{ExtractElementType:[8,1,1,""]},"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_element_type.ExtractElementType":{TABLES:[8,5,1,""],TEXT:[8,5,1,""]},"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options":{ExtractPDFOptions:[11,1,1,""]},"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions":{Builder:[11,1,1,""],builder:[11,2,1,""],elements_to_extract:[11,3,1,""],elements_to_extract_renditions:[11,3,1,""],get_char_info:[11,3,1,""],include_styling_info:[11,3,1,""],table_output_format:[11,3,1,""]},"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options.ExtractPDFOptions.Builder":{build:[11,2,1,""],with_element_to_extract:[11,2,1,""],with_element_to_extract_renditions:[11,2,1,""],with_elements_to_extract:[11,2,1,""],with_elements_to_extract_renditions:[11,2,1,""],with_get_char_info:[11,2,1,""],with_include_styling_info:[11,2,1,""],with_table_structure_format:[11,2,1,""]},"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type":{ExtractRenditionsElementType:[8,1,1,""]},"adobe.pdfservices.operation.pdfops.options.extractpdf.extract_renditions_element_type.ExtractRenditionsElementType":{FIGURES:[8,5,1,""],TABLES:[8,5,1,""]},"adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type":{TableStructureType:[8,1,1,""]},"adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type.TableStructureType":{CSV:[8,5,1,""]},adobe:{pdfservices:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","property","Python property"],"4":["py","exception","Python exception"],"5":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:property","4":"py:exception","5":"py:attribute"},terms:{"0":[4,11],"10000":[2,11],"20000":[2,11],"4000":[2,11],"429":[4,11],"abstract":[2,5,11],"boolean":[8,11],"class":[2,3,5,6,8,9,11],"default":[2,4,5,11],"enum":8,"export":[8,11],"int":[2,11],"new":[2,3,6,11],"return":[2,3,4,5,6,8,11],"static":[2,3,5,8,11],"true":[2,6,8,11],"try":[2,6,11],"while":[2,5,6,11],A:[2,3,5,6,11],For:[2,3,5,11],If:[5,11],It:[2,3,5,11],The:[2,3,4,5,6,8,11],__file__:[2,6,11],_io:[5,11],abc:[2,3,5,11],absolut:[5,11],abspath:[2,6,11],accept:[5,11],access:[3,11],account:[3,11],account_id:[3,11],across:[2,11],add:[2,3,6,8,11],addit:[2,3,6,8,11],adequ:[4,11],adob:[10,11],adobeorg:[3,11],after:[2,11],all:[2,3,9,11],allow:[3,11],along:[6,11],an:[2,3,4,5,6,8,11],ani:[2,3,5,6,8,9,11],api:[2,3,4,6,9],applic:[3,11],ar:[2,3,6,11],auth:[1,2,11],authent:[2,11],author:[3,11],base:[2,3,4,5,6,8,11],base_path:[2,6,11],been:[3,4,11],behalf:[3,11],bool:[8,11],bound:[8,11],box:[8,11],bufferedread:[5,11],build:[2,3,6,8,11],builder:[2,3,6,8,11],built:[2,3,11],call:[2,3,4,5,6,11],can:[2,3,8,11],charact:[8,11],claim:[3,11],classmethod:[6,11],classpath:[3,11],clean:[6,11],click:[3,9,11],client:[2,3,4,11],client_config:[0,1,11],client_config_file_path:[2,11],client_credenti:[3,11],client_id:[3,11],client_secret:[3,11],clientconfig:2,code:[4,11],com:[3,11],config:[2,11],configur:[2,3,11],connect:[2,11],connect_timeout:[2,11],connecttimeout:[2,11],consist:[2,11],consum:[5,11],content:[10,11],context:[2,6,11],creat:[2,3,5,6,11],create_from_local_fil:[2,5,6,11],create_from_stream:[5,11],create_kei:[6,11],create_new:[2,6,11],credenti:[1,2,4,6],credentials_file_path:[3,11],csv:[8,11],current:[2,3,8,11],custom:[2,11],default_error_cod:[4,11],default_status_cod:[4,11],defin:[2,8,11],delet:[5,11],desir:[2,11],detail:[4,11],determin:[2,11],differ:[3,11],directori:[3,5,6,11],dirnam:[2,6,11],document:9,doesn:[4,11],e:[5,11],each:[2,11],either:[4,5,11],element:[6,8,11],element_to_extract:[8,11],element_to_extract_rendit:[8,11],elements_to_extract:[8,11],elements_to_extract_rendit:[8,11],elementtyp:8,empti:[8,11],encapsul:[2,11],encount:[2,6,11],enterpris:[3,11],error:[4,6,11],error_cod:[4,11],establish:[2,11],etc:[5,11],exampl:[5,11],except:[1,2,6],execut:[2,5,6,11],execution_context:[0,1,6,11],executioncontext:[2,6],exhaust:[4,11],expos:9,extens:[5,11],extension_media_type_map:[6,11],extensionmediatypemap:[6,11],extract:[3,6,8,11],extract_element_typ:[6,7,11],extract_pdf_oper:[1,2,11],extract_pdf_opt:[2,6,7,11],extract_renditions_element_typ:[6,7,11],extractelementtyp:[2,6,8,11],extractpdf:[6,7,11],extractpdfinput:[2,6,11],extractpdfoper:[2,6,8],extractpdfopt:[2,6,8],extractrenditionselementtyp:[2,6,8,11],extracttexttablewithfiguretablerendit:[2,6,11],factori:[3,11],failur:[4,11],figur:[2,6,8,11],file:[2,3,5,6,8,11],file_ref:[1,2,6,11],fileref:[2,5,6],format:[3,5,6,8,11],from:[2,3,5,6,8,11],from_fil:[2,3,6,11],get:[3,9,11],get_char_info:[8,11],greater:[2,11],ha:[3,4,11],have:[8,11],here:[3,11],how:[6,11],http:[2,4,11],i:[5,11],id:[3,4,11],identifi:[3,5,11],ims_base_uri:[3,11],include_styling_info:[8,11],infer:[5,11],info:[8,11],inform:[8,11],input:[6,8,11],input_stream:[5,11],instanc:[2,3,5,6,8,11],intern:[3,6,11],io:[1,2,6,11],issu:[3,11],itself:[3,11],json:[2,3,6,8,11],jwt_base_uri:[3,11],kei:[2,3,11],left:9,level:[8,11],limit:[4,11],list:[8,11],local:[5,11],local_file_path:[5,11],local_sourc:[5,11],locat:[5,11],log:[2,6,11],look:[3,11],mai:[6,11],marker:[3,11],media:[5,11],media_typ:[5,11],messag:[4,11],method:[3,5,11],millisecond:[2,11],mime_typ:[6,11],modul:[9,10],nav:9,need:[8,11],network:[4,11],none:[2,3,4,5,8,11],number:[2,11],object:[2,3,8,11],onli:[3,8,11],oper:[0,1,9,11],option:[2,3,5,6,11],org_id:[3,11],organ:[3,11],organization_id:[3,11],os:[2,6,11],output:[2,6,8,11],packag:10,paramet:[2,3,5,6,8,11],path:[2,3,5,6,11],pdf:[2,3,6,8,11],pdfop:[1,2,11],pdfservic:[0,10,11],pem:[3,11],pleas:9,privat:[3,11],private_kei:[3,11],private_key_fil:[3,11],properti:[3,4,8,11],provid:[2,5,11],quota:[4,11],rais:[6,8,11],reach:[4,11],read:[2,5,11],read_timeout:[2,11],readabl:[5,11],readtimeout:[2,11],refer:[5,9],rel:[5,11],rendit:[6,8,11],repres:[2,4,5,11],request:[2,4,11],request_tracking_id:[4,11],resourc:[2,6,11],respons:[2,6,11],result:[2,4,6,11],reus:[2,11],sampl:[2,6,11],save:[5,11],save_a:[2,5,6,11],sdk:[5,11],sdkexcept:[2,4,6,11],secret:[3,11],section:9,see:[6,11],send:[2,11],server:[2,11],servic:[3,4,11],service_account_credenti:[1,2,11],service_account_credentials_build:[2,3,6,11],service_const:[3,11],serviceaccountcredenti:3,serviceapiexcept:[2,4,6,11],serviceconst:[3,11],serviceusageerror:[4,11],serviceusageexcept:[2,4,6,11],set:[2,3,6,8,11],set_input:[2,6,11],set_opt:[2,6,11],should:[2,11],side:[4,11],sourc:[2,6,11],source_file_ref:[6,11],specifi:[5,8,11],start:9,state:[2,3,11],statu:[4,11],status_cod:[4,11],store:[6,11],str:[2,3,5,8,11],stream:[5,11],structur:[2,3,6,8,11],style:[8,11],submodul:[0,1,7],subpackag:10,suppli:[6,11],support:[3,6,8,11],supported_source_media_typ:[6,11],synchron:[6,11],system:[6,11],t:[4,11],tabl:[2,6,8,11],table_output_format:[8,11],table_structur:[8,11],table_structure_typ:[6,7,11],tablestructuretyp:[8,11],techacct:[3,11],temporari:[5,6,11],text:[2,6,8,11],than:[2,11],thi:[2,3,4,5,6,8,9,11],thrown:[4,11],timeout:[2,11],token:[3,11],tool:[3,11],track:[4,11],type:[2,3,5,6,8,11],typic:[2,4,5,11],underli:[4,11],unknown:[4,11],until:[2,11],up:[3,6,11],us:[2,3,5,6,11],usag:[2,4,6,11],valu:[2,4,8,11],valueerror:[8,11],wait:[2,11],when:[4,5,11],whether:[8,11],which:[3,5,6,8,11],whose:[8,11],with_account_id:[3,11],with_client_id:[3,11],with_client_secret:[3,11],with_connect_timeout:[2,11],with_element_to_extract:[8,11],with_element_to_extract_rendit:[8,11],with_elements_to_extract:[2,6,8,11],with_elements_to_extract_rendit:[2,6,8,11],with_get_char_info:[2,6,8,11],with_include_styling_info:[6,8,11],with_organization_id:[3,11],with_private_kei:[3,11],with_read_timeout:[2,11],with_table_structure_format:[8,11],within:[3,11],work:[5,11],write_to_stream:[5,11],writer_stream:[5,11],your:[3,11],zero:[2,11],zip:[2,6,11]},titles:["adobe package","adobe.pdfservices package","adobe.pdfservices.operation package","adobe.pdfservices.operation.auth package","adobe.pdfservices.operation.exception package","adobe.pdfservices.operation.io package","adobe.pdfservices.operation.pdfops package","adobe.pdfservices.operation.pdfops.options package","adobe.pdfservices.operation.pdfops.options.extractpdf package","pdfservices-sdk","src","API Reference"],titleterms:{adob:[0,1,2,3,4,5,6,7,8],api:11,auth:3,client_config:2,clientconfig:11,clientconfigbuild:11,content:[0,1,2,3,4,5,6,7,8],credenti:[3,11],except:[4,11],execution_context:2,executioncontext:11,extract_element_typ:8,extract_pdf_oper:6,extract_pdf_opt:8,extract_renditions_element_typ:8,extractpdf:8,extractpdfoper:11,extractpdfopt:11,file_ref:5,fileref:11,io:5,modul:[0,1,2,3,4,5,6,7,8],oper:[2,3,4,5,6,7,8],option:[7,8],packag:[0,1,2,3,4,5,6,7,8],pdfop:[6,7,8],pdfservic:[1,2,3,4,5,6,7,8,9],refer:11,sdk:9,service_account_credenti:3,serviceaccountcredenti:11,serviceaccountcredentialsbuild:11,src:10,submodul:[2,3,4,5,6,8],subpackag:[0,1,2,6,7],table_structure_typ:8}}) \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index b02f2cf..7d71ef2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1 @@ -pdfservices-sdk==1.0.1 +pdfservices-sdk==2.1.2b1 diff --git a/resources/autotagPdfInput.pdf b/resources/autotagPdfInput.pdf new file mode 100644 index 0000000..5bf65c6 Binary files /dev/null and b/resources/autotagPdfInput.pdf differ diff --git a/src/autotagpdf/autotag_pdf.py b/src/autotagpdf/autotag_pdf.py new file mode 100644 index 0000000..978d285 --- /dev/null +++ b/src/autotagpdf/autotag_pdf.py @@ -0,0 +1,57 @@ +# Copyright 2022 Adobe. All rights reserved. +# This file is licensed to you under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. You may obtain a copy +# of the License at http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed under +# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS +# OF ANY KIND, either express or implied. See the License for the specific language +# governing permissions and limitations under the License. + +import logging +import os.path +from pathlib import Path + +from adobe.pdfservices.operation.auth.credentials import Credentials +from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException +from adobe.pdfservices.operation.execution_context import ExecutionContext +from adobe.pdfservices.operation.io.file_ref import FileRef + +from adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_output_files import \ + AutotagPDFOutputFiles +from adobe.pdfservices.operation.pdfops.autotag_pdf_operation import AutotagPDFOperation + +logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO')) + +try: + # get base path. + base_path = str(Path(__file__).parents[2]) + + # Initial setup, create credentials instance. + credentials = Credentials.service_account_credentials_builder() \ + .from_file(base_path + '/pdfservices-api-credentials.json') \ + .build() + + # Create an ExecutionContext using credentials and create a new operation instance. + execution_context = ExecutionContext.create(credentials) + autotag_pdf_operation = AutotagPDFOperation.create_new() + + # Set operation input from a source file. + input_file_path = 'autotagPdfInput.pdf' + source = FileRef.create_from_local_file(base_path + '/resources/' + input_file_path) + autotag_pdf_operation.set_input(source) + + # Execute the operation. + autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context) + + input_file_name = Path(input_file_path).stem + base_output_path = base_path + '/output/AutotagPDF/' + + Path(base_output_path).mkdir(parents=True, exist_ok=True) + tagged_pdf_path = f'{base_output_path}{input_file_name}-tagged.pdf' + + # Save the result to the specified location. + autotag_output_files.save_pdf_file(tagged_pdf_path) + +except (ServiceApiException, ServiceUsageException, SdkException) as e: + logging.exception(f'Exception encountered while executing operation: {e}') diff --git a/src/autotagpdf/autotag_pdf_parameterised.py b/src/autotagpdf/autotag_pdf_parameterised.py new file mode 100644 index 0000000..6bbe5c5 --- /dev/null +++ b/src/autotagpdf/autotag_pdf_parameterised.py @@ -0,0 +1,122 @@ +# Copyright 2022 Adobe. All rights reserved. +# This file is licensed to you under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. You may obtain a copy +# of the License at http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed under +# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS +# OF ANY KIND, either express or implied. See the License for the specific language +# governing permissions and limitations under the License. + +import logging +import os.path +import sys +import argparse +from pathlib import Path + +from adobe.pdfservices.operation.auth.credentials import Credentials +from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException +from adobe.pdfservices.operation.execution_context import ExecutionContext +from adobe.pdfservices.operation.io.file_ref import FileRef + +from adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_output_files import \ + AutotagPDFOutputFiles +from adobe.pdfservices.operation.pdfops.autotag_pdf_operation import AutotagPDFOperation +from adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options import AutotagPDFOptions + +logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO')) + + +class AutotagPDFParameterised: + + _input_path: str + _output_path: str + _generate_report: bool + _shift_headings: bool + + base_path = str(Path(__file__).parents[2]) + + def __init__(self): + pass + + @staticmethod + def parse_args(*args: str): + if not args: + args = sys.argv[1:] + parser = argparse.ArgumentParser(description='Autotag PDF') + + parser.add_argument('--input', help='Input file path', type=Path, metavar='input') + parser.add_argument('--output', help='Output path', type=Path, dest='output') + parser.add_argument('--report', dest='report', action='store_true', help='Generate report(in XLSX format)', + default=False) + parser.add_argument('--shift_headings', dest='shift_headings', action='store_true', help='Shift headings', + default=False) + + return parser.parse_args(args) + + def get_default_input_file_path(self) -> str: + return self.base_path + '/resources/autotagPdfInput.pdf' + + def get_default_output_file_path(self) -> str: + return self.base_path + '/output/AutotagPDFParameterised' + + def get_autotag_pdf_options(self) -> AutotagPDFOptions: + shift_headings = self._shift_headings + generate_report = self._generate_report + + builder: AutotagPDFOptions.Builder = AutotagPDFOptions.builder() + if shift_headings: + builder.with_shift_headings() + if generate_report: + builder.with_generate_report() + return builder.build() + + def execute(self, *args: str) -> None: + args = self.parse_args(*args) + self._input_path = args.input if args.input else self.get_default_input_file_path() + self._output_path = args.output if args.output else self.get_default_output_file_path() + self._generate_report = args.report + self._shift_headings = args.shift_headings + + self.autotag_pdf() + + def autotag_pdf(self): + try: + # Initial setup, create credentials instance. + credentials = Credentials.service_account_credentials_builder() \ + .from_file(self.base_path + '/pdfservices-api-credentials.json') \ + .build() + + # Create an ExecutionContext using credentials and create a new operation instance. + execution_context = ExecutionContext.create(credentials) + autotag_pdf_operation = AutotagPDFOperation.create_new() + + # Set operation input from a source file. + source = FileRef.create_from_local_file(self._input_path) + autotag_pdf_operation.set_input(source) + + # Build AutotagPDF options and set them into the operation + autotag_pdf_operation.set_options(self.get_autotag_pdf_options()) + + # Execute the operation. + autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context) + + input_file_name = Path(self._input_path).stem + base_output_path = self._output_path + + Path(base_output_path).mkdir(parents=True, exist_ok=True) + + # Save the result to the specified location. + tagged_pdf_path = f'{base_output_path}/{input_file_name}-tagged.pdf' + autotag_output_files.save_pdf_file(tagged_pdf_path) + if self._generate_report: + report_path = f'{base_output_path}/{input_file_name}-report.xlsx' + autotag_output_files.save_xls_file(report_path) + + except (ServiceApiException, ServiceUsageException, SdkException) as e: + logging.exception(f'Exception encountered while executing operation: {e}') + + +if __name__ == "__main__": + autotag_pdf_parameterised = AutotagPDFParameterised() + autotag_pdf_parameterised.execute() diff --git a/src/autotagpdf/autotag_pdf_with_options.py b/src/autotagpdf/autotag_pdf_with_options.py new file mode 100644 index 0000000..363c9ed --- /dev/null +++ b/src/autotagpdf/autotag_pdf_with_options.py @@ -0,0 +1,65 @@ +# Copyright 2022 Adobe. All rights reserved. +# This file is licensed to you under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. You may obtain a copy +# of the License at http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software distributed under +# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS +# OF ANY KIND, either express or implied. See the License for the specific language +# governing permissions and limitations under the License. + +import logging +import os.path +from pathlib import Path + +from adobe.pdfservices.operation.auth.credentials import Credentials +from adobe.pdfservices.operation.exception.exceptions import ServiceApiException, ServiceUsageException, SdkException +from adobe.pdfservices.operation.execution_context import ExecutionContext +from adobe.pdfservices.operation.io.file_ref import FileRef +from adobe.pdfservices.operation.pdfops.options.autotagpdf.autotag_pdf_options import AutotagPDFOptions +from adobe.pdfservices.operation.internal.api.dto.request.autotagpdf.autotag_pdf_output_files import AutotagPDFOutputFiles +from adobe.pdfservices.operation.pdfops.autotag_pdf_operation import AutotagPDFOperation + +logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO')) + +try: + # get base path. + base_path = str(Path(__file__).parents[2]) + + # Initial setup, create credentials instance. + credentials = Credentials.service_account_credentials_builder() \ + .from_file(base_path + '/pdfservices-api-credentials.json') \ + .build() + + # Create an ExecutionContext using credentials and create a new operation instance. + execution_context = ExecutionContext.create(credentials) + autotag_pdf_operation = AutotagPDFOperation.create_new() + + # Set operation input from a source file. + input_file_path = 'autotagPdfInput.pdf' + source = FileRef.create_from_local_file(base_path + '/resources/' + input_file_path) + autotag_pdf_operation.set_input(source) + + # Build AutotagPDF options and set them into the operation + autotag_pdf_options: AutotagPDFOptions = AutotagPDFOptions.builder()\ + .with_shift_headings()\ + .with_generate_report()\ + .build() + autotag_pdf_operation.set_options(autotag_pdf_options) + + # Execute the operation. + autotag_output_files: AutotagPDFOutputFiles = autotag_pdf_operation.execute(execution_context) + + input_file_name = Path(input_file_path).stem + base_output_path = base_path + '/output/AutotagPDFWithOptions/' + + Path(base_output_path).mkdir(parents=True, exist_ok=True) + tagged_pdf_path = f'{base_output_path}{input_file_name}-tagged.pdf' + report_path = f'{base_output_path}{input_file_name}-report.xlsx' + + # Save the result to the specified location. + autotag_output_files.save_pdf_file(tagged_pdf_path) + autotag_output_files.save_xls_file(report_path) + +except (ServiceApiException, ServiceUsageException, SdkException) as e: + logging.exception(f'Exception encountered while executing operation: {e}') diff --git a/src/extractpdf/extract_txt_from_pdf_with_custom_timeouts.py b/src/extractpdf/extract_txt_from_pdf_with_custom_timeouts.py index 3b50fbc..6b7b836 100644 --- a/src/extractpdf/extract_txt_from_pdf_with_custom_timeouts.py +++ b/src/extractpdf/extract_txt_from_pdf_with_custom_timeouts.py @@ -32,7 +32,8 @@ .build() # Create client config instance with custom time-outs. - client_config = ClientConfig.builder().with_connect_timeout(10000).with_read_timeout(40000).build() + client_config = ClientConfig.builder().with_connect_timeout(10000).with_read_timeout(40000) \ + .build() # Create an ExecutionContext using credentials and create a new operation instance. execution_context = ExecutionContext.create(credentials, client_config)

adobe package¶

Subpackages¶

Subpackages +

adobe.pdfservices package¶

Subpackages¶

Subpackages +

adobe.pdfservices.operation.auth package¶

Submodules¶

adobe.pdfservices.operation.auth.credentials module¶

Submodules +

Module contents¶

adobe.pdfservices.operation.exception package¶

Submodules¶

adobe.pdfservices.operation.exception.exceptions module¶

Module contents¶

adobe.pdfservices.operation package¶

Subpackages¶

Subpackages +

adobe.pdfservices.operation.client_config module¶

Submodules - -static builder()¶ + +static builder()¶ Creates a new ClientConfig builder. Returns @@ -313,12 +309,12 @@ Submodules +

Submodules +

Submodules +

Module contents¶

adobe.pdfservices.operation.io package¶

Submodules¶

adobe.pdfservices.operation.io.file_ref module¶

Submodules - -abstract save_as(local_file_path: str)¶ + +abstract save_as(local_file_path: str)¶

Module contents¶

adobe.pdfservices.operation.pdfops package¶

Subpackages¶

Subpackages +

adobe.pdfservices.operation.pdfops.extract_pdf_operation module¶

Submodules - -SUPPORTED_SOURCE_MEDIA_TYPES = {adobe.pdfservices.operation.internal.extension_media_type_mapping.ExtensionMediaTypeMapping.PDF.mime_type}¶ + +SUPPORTED_SOURCE_MEDIA_TYPES = {'application/pdf'}¶ Supported source file formats for ExtractPdfOperation is .pdf.

Submodules +

adobe.pdfservices.operation.pdfops.options.extractpdf package¶

Submodules¶

adobe.pdfservices.operation.pdfops.options.extractpdf.extract_pdf_options module¶

adobe.pdfservices.operation.pdfops.options.extractpdf.pdf_element_type module¶

adobe.pdfservices.operation.pdfops.options.extractpdf.table_structure_type module¶

Module contents¶

adobe.pdfservices.operation.pdfops.options package¶

Subpackages¶

Module contents¶

Index

A

B

C

D

E

F

G

M

O

P

R

S

T

W

pdfservices-sdk¶

pdfservices-extract-sdk¶

src¶

src¶

Python Module Index

Python Module Index

Python Module Index

API Reference¶

ClientConfig¶

ClientConfig - -static builder()¶ + +static builder()¶ Creates a new ClientConfig builder. Returns @@ -273,17 +269,17 @@ ClientConfig +

ClientConfig +

ClientConfigBuilder - -with_read_timeout(read_timeout: int)¶ + +with_read_timeout(read_timeout: int)¶ Sets the read timeout. It should be greater than zero. Parameters @@ -355,18 +351,18 @@ ClientConfigBuilder +

ClientConfigBuilder +

Credentials +

ExecutionContext +

ExtractPDFOperation - -SUPPORTED_SOURCE_MEDIA_TYPES = {adobe.pdfservices.operation.internal.extension_media_type_mapping.ExtensionMediaTypeMapping.PDF.mime_type}¶ + +SUPPORTED_SOURCE_MEDIA_TYPES = {'application/pdf'}¶ Supported source file formats for ExtractPdfOperation is .pdf.

ExtractPDFOperation +

FileRef¶

FileRef - -abstract save_as(local_file_path: str)¶ + +abstract save_as(local_file_path: str)¶

Exceptions¶

ServiceAccountCredentials¶

ServiceAccountCredentialsBuilder¶

Submodules -
-static builder()¶
+
+static `builder`()¶

Creates a new `ClientConfig` builder.

Returns
@@ -313,12 +309,12 @@
Submodules +

Submodules -
-abstract save_as(local_file_path: str)¶
+
+abstract `save_as`(local_file_path: str)¶

Submodules -
-SUPPORTED_SOURCE_MEDIA_TYPES = {adobe.pdfservices.operation.internal.extension_media_type_mapping.ExtensionMediaTypeMapping.PDF.mime_type}¶
+
+`SUPPORTED_SOURCE_MEDIA_TYPES` = {'application/pdf'}¶

Supported source file formats for `ExtractPdfOperation` is .pdf.

ClientConfig -
-static builder()¶
+
+static `builder`()¶

Creates a new `ClientConfig` builder.

Returns
@@ -273,17 +269,17 @@
ClientConfig +

ClientConfigBuilder -
-with_read_timeout(read_timeout: int)¶
+
+`with_read_timeout`(read_timeout: int)¶

Sets the read timeout. It should be greater than zero.

Parameters
@@ -355,18 +351,18 @@
ClientConfigBuilder +

ExtractPDFOperation -
-SUPPORTED_SOURCE_MEDIA_TYPES = {adobe.pdfservices.operation.internal.extension_media_type_mapping.ExtensionMediaTypeMapping.PDF.mime_type}¶
+
+`SUPPORTED_SOURCE_MEDIA_TYPES` = {'application/pdf'}¶

Supported source file formats for `ExtractPdfOperation` is .pdf.

FileRef -
-abstract save_as(local_file_path: str)¶
+
+abstract `save_as`(local_file_path: str)¶