পাইথনে পাইডক মডিউল ব্যবহার করে ডকুমেন্টেশন জেনারেশন

পরিচয়

pydoc মডিউল স্বয়ংক্রিয়ভাবে পাইথন মডিউল থেকে ডকুমেন্টেশন তৈরি করে। ডকুমেন্টেশন কনসোলে পাঠ্যের পৃষ্ঠা হিসাবে সংরক্ষণ করা যেতে পারে, ওয়েব ব্রাউজারে প্রদর্শিত হয়, এমনকি HTML ফাইল হিসাবেও।

এই নিবন্ধে আপনি বিভিন্ন ক্ষেত্রে এই ডকুমেন্টেশনগুলি দেখার পদ্ধতি শিখবেন এবং এমনকি ডকস্ট্রিংগুলি সম্পর্কেও শিখবেন যা আপনাকে আপনার পাইথন স্ক্রিপ্টগুলির জন্য আপনার নিজস্ব ডকুমেন্টেশন তৈরি করতে সহায়তা করে৷

এখন যেহেতু আপনি pydoc এর ব্যবহার জানেন, আসুন শুরু করা যাক।

শুরু করা

পাইডক মডিউলটি পাইথনের সাথে প্যাকেজ করা হয়, যার অর্থ আপনাকে আলাদাভাবে ডাউনলোড এবং ইনস্টল করতে হবে না।

pydoc অ্যাক্সেস করার জন্য, আপনাকে প্রথমে এটি আমদানি করতে হবে৷

import pydoc

হেল্প() ফাংশন ব্যবহার করে ইন্টারেক্টিভ শেল অ্যাক্সেস করা

আপনি এটির হেল্প ফাংশন ব্যবহার করে pydoc-এ ইন্টারেক্টিভ শেল অ্যাক্সেস করতে পারেন।

এটি করার জন্য, আপনার টার্মিনাল চালু করুন, এবং পাইথন ইন্টারেক্টিভ শেল প্রবেশ করুন।

এখন, pydoc আমদানি করুন এবং তারপর ইন্টারেক্টিভ শেল চালু করতে pydoc.help() কমান্ডটি ব্যবহার করুন৷

উদাহরণ

>>>import pydoc
>>>pydoc.help()

এখন, আপনি সরাসরি ইন্টারেক্টিভ স্ক্রিপ্ট থেকে এর ডকুমেন্টেশন পেতে মডিউল, ডেটাটাইপ, ফাংশন, ক্লাস ইত্যাদির নাম লিখতে পারেন।

ব্রাউজার থেকে ডকুমেন্টেশন দেখা

আপনি যদি ব্রাউজার থেকে ডকুমেন্টেশন দেখতে চান, তাহলে আপনি সহজেই pydoc ব্যবহার করে করতে পারেন।

এই সময়, আপনাকে পাইথন শেল দিয়ে কমান্ড চালানোর দরকার নেই। বরং আপনি এটিকে যুক্তি প্রদান করতে পারেন এবং সরাসরি এটি চালু করতে পারেন৷

এটি করতে, আপনার টার্মিনাল চালু করুন এবং নীচের কমান্ডটি টাইপ করুন৷

python −m pydoc −b

এটি ব্রাউজারে আপনার স্থানীয় সিস্টেমে উপস্থিত সমস্ত পাইথন মডিউল, ফাংশন, অবজেক্টের জন্য ডকুমেন্টেশন তৈরি করবে৷

এমনকি আপনি এইভাবে নির্দিষ্ট কীওয়ার্ড অনুসন্ধান এবং পুনরুদ্ধার করতে পারেন।

C:\Users\vijay>python −m pydoc −b
Server ready at https://localhost:50621/
Server commands: [b]rowser, [q]uit
server> q
Server stopped

ডকস্ট্রিং এর সাথে কাজ করা

উদাহরণ

def documentation():
   '''Documentation using docstrings'''
print(documentation.__doc__)
help(documentation)

আউটপুট

Documentation using docstrings
Help on function documentation in module __main__:

documentation()
Documentation using docstrings

উপসংহার

আপনি এখন জানেন কিভাবে পাইডক ফাংশন ব্যবহার করে বিভিন্ন পাইথন কীওয়ার্ড, ফাংশন, মডিউল, পদ্ধতি অফলাইনে ডকুমেন্টেশন দেখতে এবং পড়তে হয়।

আপনি ডকস্ট্রিং ব্যবহার করে আপনার নিজস্ব ডকুমেন্টেশন তৈরি এবং তৈরি করতে শিখেছেন৷

আপনি কোথায় কী করছেন তা জানতে এবং ভবিষ্যতে বিভ্রান্তি এড়াতে বড় আকারের প্রকল্পগুলিতে কাজ করার সময় ভাল ডকুমেন্টেশন বজায় রাখা অপরিহার্য। এটি বিভিন্ন অজানা বা রানটাইম ত্রুটি প্রতিরোধ করতে সাহায্য করে।