Replace Links in PDF in Python SDK
Replace a Links to a PDF Document using Cloud Python SDK.
Get StartedHow to Replace Links in PDF via Cloud Python SDK
To replace links in PDF, we’ll use Aspose.PDF Cloud Python SDK. This Cloud SDK assists Python programmers in developing cloud-based PDF creator, annotator, editor, and converter apps using Python programming language via Aspose.PDF REST API. Simply create an account at Aspose for Cloud and get your application information. Once you have the App SID & key, you are ready to give the Aspose.PDF Cloud Python SDK. If the python package is hosted on Github, you can install directly from Github:
Installation from Github
pip install git+https://github.com/aspose-pdf-cloud/aspose-pdf-cloud-python.git
Package Manager Console Command
pip install asposepdfcloud
Steps to replace Links in PDF via Python
Aspose.PDF Cloud developers can easily load & replace links in PDF in just a few lines of code.
- Install Python SDK
- Upload a PDF document to the Aspose Cloud server
- Download the processed PDF document from the Aspose Cloud server
- Show all hyperlink annotations for a specific PDF document
- Get all hyperlink annotations for a specific PDF document
- Replace link annotation
Replace Links in PDF using Python
import shutil
import json
import logging
from pathlib import Path
from asposepdfcloud import ApiClient, PdfApi, LinkAnnotationsResponse, LinkAnnotationResponse
class Config:
"""Configuration parameters."""
CREDENTIALS_FILE = Path(r"C:\\Projects\\ASPOSE\\Pdf.Cloud\\Credentials\\credentials.json")
LOCAL_FOLDER = Path(r"C:\\Samples")
PDF_DOCUMENT_NAME = "sample.pdf"
LOCAL_RESULT_DOCUMENT_NAME = "output_sample.pdf"
NEW_LINK_ACTION = "https://reference.aspose.cloud/pdf/"
PAGE_NUMBER = 2
LINK_FIND_ID = "GI5UO32UN5KVESKBMN2GS33OHMZTEMJMGUYDQLBTGYYCYNJSGE"
# Configure logging
logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
class PdfLinks:
"""Class for managing PDF links using Aspose PDF Cloud API."""
def __init__(self, credentials_file: Path = Config.CREDENTIALS_FILE):
self.pdf_api = None
self._init_api(credentials_file)
def _init_api(self, credentials_file: Path):
"""Initialize the API client."""
try:
with credentials_file.open("r", encoding="utf-8") as file:
credentials = json.load(file)
api_key, app_id = credentials.get("key"), credentials.get("id")
if not api_key or not app_id:
raise ValueError("Error: Missing API keys in the credentials file.")
self.pdf_api = PdfApi(ApiClient(api_key, app_id))
except (FileNotFoundError, json.JSONDecodeError, ValueError) as e:
logging.error(f"Failed to load credentials: {e}")
def upload_document(self):
"""Upload a PDF document to the Aspose Cloud server."""
if self.pdf_api:
file_path = Config.LOCAL_FOLDER / Config.PDF_DOCUMENT_NAME
try:
self.pdf_api.upload_file(Config.PDF_DOCUMENT_NAME, str(file_path))
logging.info(f"File {Config.PDF_DOCUMENT_NAME} uploaded successfully.")
except Exception as e:
logging.error(f"Failed to upload file: {e}")
def download_result(self):
"""Download the processed PDF document from the Aspose Cloud server."""
if self.pdf_api:
try:
temp_file = self.pdf_api.download_file(Config.PDF_DOCUMENT_NAME)
local_path = Config.LOCAL_FOLDER / Config.LOCAL_RESULT_DOCUMENT_NAME
shutil.move(temp_file, str(local_path))
logging.info(f"download_result(): File successfully downloaded: {local_path}")
except Exception as e:
logging.error(f"download_result(): Failed to download file: {e}")
def show_links_array(self, links, prefix):
"""Show all hyperlink annotations for a specific PDF document."""
for item in links:
logging.info(f"{prefix} Link ID: '{item.id}' - Link Action: '{item.action}'")
def get_all_links(self):
"""Get all hyperlink annotations for a specific PDF document."""
if self.pdf_api:
try:
response = self.pdf_api.get_page_link_annotations( Config.PDF_DOCUMENT_NAME, Config.PAGE_NUMBER)
if response.code == 200:
self.show_links_array(response.links.list, "All: ")
else:
logging.error(f"Failed to add link to the page. Response code: {response.code}")
except Exception as e:
logging.error(f"Error while adding link: No links found - {e}")
def get_link_by_id(self) -> LinkAnnotationResponse:
if self.pdf_api:
result_link: LinkAnnotationResponse = self.pdf_api.get_link_annotation(Config.PDF_DOCUMENT_NAME, Config.LINK_FIND_ID)
if result_link.code == 200:
return result_link
print("Link not found.")
return None
def replace_link(self):
if self.pdf_api:
link_annotation: LinkAnnotationResponse = self.get_link_by_id()
if not link_annotation:
return
link_annotation.link.action = Config.NEW_LINK_ACTION
response: LinkAnnotationsResponse = self.pdf_api.put_link_annotation(
Config.PDF_DOCUMENT_NAME,
Config.LINK_FIND_ID,
link_annotation.link,
)
if response.code == 200:
print("Link annotation replaced successfully.")
else:
print("Failed to replace link annotation.")
if __name__ == "__main__":
pdf_links = PdfLinks()
pdf_links.upload_document()
pdf_links.get_all_links()
pdf_links.replace_link()
pdf_links.download_result()
Work with links in PDF
By regularly reviewing and updating the hyperlinks in your PDF documents, you can maintain their relevance, accuracy, and security, thereby providing a better experience for your readers. Replave the links in PDF documents with Aspose.PDF Cloud Python SDK.
With our Python library you can:
- Combine PDF documents.
- Split PDF Files.
- Convert PDF to other formats, and vice versa.
- Manipulate Annotations.
- Work with Images in PDF, etc.
- You can try out our free App to test the functionality online.