حاشیه نویسی فایل های Word با استفاده از پایتون

به‌عنوان یک توسعه‌دهنده پایتون، می‌توانید هر فایل Word (.doc یا .docx) را به‌صورت برنامه‌نویسی در فضای ابری حاشیه‌نویسی کنید. حاشیه‌نویسی‌ها معمولاً ابرداده‌هایی هستند که در قالب نظرات، یادداشت‌ها، توضیحات، یا انواع دیگر اظهارات خارجی در سند ارائه می‌شوند که اطلاعات اضافی درباره یک قطعه داده موجود را ارائه می‌کنند. این مقاله بر نحوه حاشیه نویسی فایل های DOCX با استفاده از REST API در پایتون تمرکز خواهد داشت.

موضوعات زیر در این مقاله پوشش داده خواهد شد:

• API REST Annotation Document و Python SDK
• فایل های DOCX را با استفاده از REST API حاشیه نویسی کنید
• اضافه کردن چند حاشیه با استفاده از پایتون

API REST Annotation Document و Python SDK

برای حاشیه نویسی اسناد DOC یا DOCX، از Python SDK of GroupDocs.Annotation Cloud API استفاده خواهم کرد. این به شما اجازه می دهد تا به صورت برنامه ریزی شده ابزارهای حاشیه نویسی آنلاین سند و تصویر بسازید. از چنین ابزارهایی می توان برای افزودن حاشیه نویسی، پوشش واترمارک، جایگزینی متن، ویرایش، یادداشت های چسبناک و نشانه گذاری متن به اسناد تجاری همه فرمت های رایج استفاده کرد. همچنین SDKهای دات نت، جاوا، PHP، روبی و Node.js را به عنوان [اعضای خانواده حاشیه نویسی سند4 برای Cloud API فراهم می کند.

می توانید با استفاده از دستور زیر در کنسول، GroupDocs.Annotation Cloud را در پروژه پایتون خود نصب کنید:

pip install groupdocs_annotation_cloud

لطفاً قبل از شروع به دنبال کردن مراحل و نمونه کدهای موجود، شناسه مشتری و راز مشتری خود را از داشبورد دریافت کنید. شناسه و راز خود را به شکل زیر در کد اضافه کنید:

client_id = "112f0f38-9dae-42d5-b4fc-cc84ae644972"
client_secret = "16ad3fe0bdc39c910f57d2fd48a5d618"
my_storage = ""

configurations = groupdocs_annotation_cloud.Configuration(client_id, client_secret)
configurations.api_base_url = "https://api.groupdocs.cloud"

فایل‌های DOCX را با استفاده از REST API در پایتون حاشیه‌نویسی کنید

می‌توانید با دنبال کردن مراحل ساده زیر، حاشیه‌نویسی را به فایل DOCX اضافه کنید:

• آپلود فایل DOCX در Cloud
• افزودن حاشیه نویسی به فایل های DOCX در پایتون
• دانلود فایل به روز شده

سند را آپلود کنید

اول از همه، فایل DOCX را با استفاده از مثال کد زیر در Cloud آپلود کنید:

# نمونه ای از API ایجاد کنید
file_api = groupdocs_annotation_cloud.FileApi.from_config(configurations)

request = groupdocs_annotation_cloud.UploadFileRequest("one-page.docx", "C:\\Files\\one-page.docx", my_storage)
response = file_api.upload_file(request)

در نتیجه، فایل DOCX آپلود شده در بخش فایل ها داشبورد شما در فضای ابری در دسترس خواهد بود.

اضافه کردن حاشیه نویسی به فایل های DOCX در پایتون

لطفاً مراحل ذکر شده در زیر را برای درج حاشیه نویسی در سند Word به صورت برنامه ای دنبال کنید.

• یک نمونه از AnnotationInfo ایجاد کنید
• ویژگی های مختلف حاشیه نویسی مانند موقعیت، نوع، متن و غیره را تنظیم کنید.
• یک نمونه FileInfo ایجاد کنید
• مسیر فایل را تنظیم کنید
• یک نمونه از AnnotateOptions ایجاد کنید
• اطلاعات فایل را روی AnnotateOptions تنظیم کنید
• Annotation را روی AnnotateOptions قرار دهید
• با فراخوانی روش AnnotateRequest یک درخواست ایجاد کنید
• با فراخوانی روش AnnotateApi.annotate() نتیجه بگیرید

قطعه کد زیر نحوه درج حاشیه نویسی ناحیه را در سند Word با استفاده از REST API نشان می دهد.

api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)

a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 100
a1.box.y = 100
a1.box.width = 200
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.7

# اضافه کردن حاشیه نویسی منطقه
a1.type = "Area"
a1.text = "This is area annotation"
a1.creator_name = "Anonym A."

file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "one-page.docx"
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "Output\\output.docx"

request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)

در نتیجه، حاشیه نویسی ناحیه مطابق شکل زیر در سند درج می شود.

انواع حاشیه نویسی پشتیبانی شده

لطفاً در زیر لیست انواع حاشیه نویسی پشتیبانی شده را بیابید، می توانید با دنبال کردن مراحل ذکر شده قبلی، به فایل های DOCX خود اضافه کنید:

• حوزه
• فاصله
• ارتباط دادن
• نقطه
• پلی لاین
• تصویر
• متن
• واترمارک
• فلش

فایل به روز شده را دانلود کنید

نمونه کد بالا فایل DOCX مشروح شده را در ابر ذخیره می کند. با استفاده از نمونه کد زیر می توانید آن را دانلود کنید:

# نمونه ای از API ایجاد کنید
file_api = groupdocs_annotation_cloud.FileApi.from_config(configurations)

request = groupdocs_annotation_cloud.DownloadFileRequest("Output\\output.docx", my_storage)
response = file_api.download_file(request)

# فایل دانلود شده را به دایرکتوری کاری خود منتقل کنید
shutil.move(response, "C:\\Files\\")

اضافه کردن چند حاشیه با استفاده از پایتون

لطفاً مراحل ذکر شده در زیر را دنبال کنید تا چندین حاشیه نویسی را به صورت برنامه ریزی شده به فایل های DOCX خود اضافه کنید.

• اولین نمونه از AnnotationInfo را ایجاد کنید
• ویژگی های مختلف Annotation را برای نمونه اول تنظیم کنید مانند موقعیت، نوع، متن و غیره.
• نمونه دوم AnnotationInfo را ایجاد کنید
• ویژگی های حاشیه نویسی مختلف را برای نمونه دوم تنظیم کنید مانند موقعیت، نوع، متن و غیره.
• یک نمونه FileInfo ایجاد کنید
• مسیر فایل را تنظیم کنید
• یک نمونه از AnnotateOptions ایجاد کنید
• اطلاعات فایل را روی AnnotateOptions تنظیم کنید
• حاشیه نویسی اول و دوم را روی AnnotateOptions قرار دهید
• با فراخوانی روش AnnotateRequest یک درخواست ایجاد کنید
• با فراخوانی روش AnnotateApi.annotate() نتیجه بگیرید

قطعه کد زیر نشان می دهد که چگونه می توان با استفاده از یک REST API یادداشت های متعدد به فایل DOCX اضافه کرد. لطفاً برای آپلود و دانلود یک فایل مراحل ذکر شده را دنبال کنید.

api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)
  
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 200
a1.box.y = 200
a1.box.width = 300
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.2
a1.type = "Watermark"
a1.text = "This is watermark annotation"
a1.creator_name = "Anonym A."
    
a2 = groupdocs_annotation_cloud.AnnotationInfo()
a2.annotation_position = groupdocs_annotation_cloud.Point()
a2.annotation_position.x = 852
a2.annotation_position.y = 59.38
a2.box = groupdocs_annotation_cloud.Rectangle()
a2.box.x = 375.8
a2.box.y = 59.38
a2.box.width = 88
a2.box.height = 37
a2.page_number = 2
a2.pen_color = 1201033
a2.pen_style = "Solid"
a2.pen_width = 1
a2.opacity = 0.9
a2.type = "Image"
a2.text = "This is Image annotation"
a2.creator_name = "Anonym A."
a2.image_path = "JohnSmith.png"
    
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "ten-pages.docx"
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1, a2]
options.output_path = "Output\\output.docx"

request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)

در نتیجه، حاشیه‌نویسی تصویر و واترمارک مطابق شکل زیر در سند درج می‌شود.

نتیجه

در این مقاله، نحوه افزودن انواع حاشیه نویسی به اسناد Word در فضای ابری با Document Annotation REST API را با استفاده از پایتون آموختید. همچنین یاد گرفتید که چگونه فایل DOCX را به صورت برنامه‌نویسی در فضای ابری آپلود کنید و سپس فایل مشروح شده را از ابر دانلود کنید. می‌توانید با استفاده از مستندات درباره GroupDocs.Annotation Cloud API بیشتر بیاموزید. ما همچنین یک بخش API Reference ارائه می‌کنیم که به شما امکان می‌دهد API‌های ما را مستقیماً از طریق مرورگر تجسم کرده و با آن‌ها تعامل داشته باشید. در صورت وجود هرگونه ابهام، لطفاً با ما در [تالار] تماس حاصل فرمایید14.