অধ্যায় 4 · ডিজাইন ও কোড
রক্ষণাবেক্ষণযোগ্য কোড লেখা
- পৃষ্ঠা 13 / 18
- 17 মিনিট পড়া
কাজ করে এমন কোড কেবল প্রথম ধাপ। ClinicQueue বহুবার বদলাবে: নতুন সার্ভিস, দ্বিতীয় একটা ক্লিনিক, AI রিমাইন্ডার টেক্সট। প্রতিটা পরিবর্তন শুরু হয় কারও বিদ্যমান কোড পড়া আর সেটা কী করে তা বোঝা দিয়ে। প্রতি দশ মিনিট বদলানোর জন্য যদি এক ঘণ্টা মাথা খাটাতে হয়, টিমের গতি কমে যায়, আর প্রতিটা পরিবর্তনে এমন কিছু ভেঙে যাওয়ার ঝুঁকি থাকে যা কেউ বোঝেনি। রক্ষণাবেক্ষণযোগ্য কোড (maintainable code) হলো এমন কোড, যা আরেকজন মানুষ (বা কয়েক মাস পরের আপনি) পড়তে, বুঝতে আর নিরাপদে বদলাতে পারেন।
আগের পাতা এনটিটি–রিলেশনশিপ ডায়াগ্রাম দিয়ে ডেটা মডেলিং-এ আপনি ঠিক করেছেন ClinicQueue কোন ডেটা রাখবে। এই পাতা তার ওপরের কোড নিয়ে। ফারহানের প্রথম প্রোটোটাইপ থেকে একটা অগোছালো কিন্তু কাজ করা Python ফাংশন নিয়ে আপনি ধাপে ধাপে সেটাকে উন্নত করবেন, আর প্রতিটা ধাপের পর যাচাই করবেন যে আউটপুট হুবহু একই আছে। রোগীদের সব ডেটা কাল্পনিক।
যা শিখবেন
- কোডকে কী পড়ার উপযোগী করে: নাম, একটা কাজের ছোট ফাংশন, আর পরিষ্কার কন্ট্রোল ফ্লো।
- কীভাবে এমন কমেন্ট আর ডকস্ট্রিং লিখবেন যা "কেন" ব্যাখ্যা করে, আর মিথ্যা বলা কমেন্ট কীভাবে এড়াবেন।
- PEP 8-এর মতো স্টাইল গাইড কীসের জন্য, আর ফরম্যাটার ও লিন্টার কী করে।
- একটা অগোছালো ফাংশনকে ছোট, নিরাপদ ধাপে কীভাবে রিফ্যাক্টরিং করবেন, আর প্রমাণ করবেন যে আউটপুট বদলায়নি।
- ইনপুট যাচাই আর এরর সামলানোর মূল কথা, আর ম্যাজিক নম্বর ও ডুপ্লিকেশন কেন বাগ তৈরি করে।
পড়ার উপযোগী কোড
এটা সেই ফাংশন, যা ফারহান প্রথম সপ্তাহে লিখেছিলেন: একটা দিনের ফ্রন্ট-ডেস্ক কিউ আর রিমাইন্ডার SMS-এর লাইনগুলো প্রিন্ট করার জন্য। এটা কাজ করে। আউটপুট পড়ার আগে কোডটা পড়ে বলার চেষ্টা করুন এটা কী করে।
উদাহরণ:
appointments = [
("Ayesha Khan", "09:30", "2026-11-10", "booked", "01700000001"),
("Rafi Ahmed", "09:00", "2026-11-10", "booked", ""),
("Mim Akter", "10:00", "2026-11-10", "cancelled", "01700000003"),
("Joseph Das", "09:15", "2026-11-10", "booked", "01700000004"),
("Sara Islam", "09:00", "2026-11-11", "booked", "01700000005"),
]
def proc(l, t):
# loop
r = []
c = 0
for x in l:
if x[2] == t:
if x[3] != "cancelled":
if x[4] == "":
p = "no phone"
else:
p = x[4]
r.append(x[1] + " " + x[0] + " (" + p + ")")
c = c + 1 # add 1 to c
r.sort()
for i in r:
print(i)
print("patients: " + str(c) + ", minutes: " + str(c * 15))
if c > 12:
print("over limit!")
for x in l:
if x[2] == t and x[3] != "cancelled":
if x[4] == "":
print("SMS skipped: " + x[0])
else:
print("SMS to " + x[4] + ": see you at " + x[1])
proc(appointments, "2026-11-10")09:00 Rafi Ahmed (no phone)
09:15 Joseph Das (01700000004)
09:30 Ayesha Khan (01700000001)
patients: 3, minutes: 45
SMS to 01700000001: see you at 09:30
SMS skipped: Rafi Ahmed
SMS to 01700000004: see you at 09:15সম্ভবত বেশ খানিকটা সময় লেগেছে। এতে কিছুই ভুল নেই, কিন্তু প্রায় সবকিছুই পাঠককে খাটায়: proc, l, t, x, r, c আর p কিছুই বলে না; x[3] মানে "স্ট্যাটাস", তবে কেবল যদি টাপলের ক্রম মনে থাকে; 15 আর 12 কোনো ব্যাখ্যা ছাড়াই আসে; "ফোন নেই" যাচাই দুবার লেখা; আর ফাংশনটা খোঁজা, ফরম্যাট করা আর প্রিন্ট করা সব মিশিয়ে ফেলেছে। তিনটা অভ্যাস এর বেশিরভাগ ঠিক করে দেয়।
এমন নাম, যা বলে জিনিসটা কী
ভালো নাম পাঠককে অন্য কোথাও না তাকিয়েই "এটা কী?" প্রশ্নের উত্তর দেয়। তুলনা করুন:
| অস্পষ্ট | স্পষ্ট | কেন |
|---|---|---|
proc(l, t) | print_day(appointments, day) | ফাংশনের নাম বলে সেটা কী করে (একটা ক্রিয়া); আর্গুমেন্ট বলে সেগুলোতে কী আছে। |
c | count বা len(active) | এক অক্ষরের নাম শুধু ছোট, স্পষ্ট লুপে চলে। |
x[3] | a.status | নাম দেওয়া ফিল্ডকে পাশের ফিল্ডের সাথে গুলিয়ে ফেলা যায় না। |
data2, tmp | cancelled_today | সংখ্যা আর "tmp" অর্থটা লুকিয়ে ফেলে। |
সমস্যার নিজের শব্দগুলো ব্যবহার করুন: নাদিয়া আর রিনা যদি "অ্যাপয়েন্টমেন্ট" আর "কিউ" বলেন, কোডও তা-ই বলবে। আগের পাতার ER ডায়াগ্রামে আপনি এই শব্দভান্ডারই ঠিক করেছিলেন।
একটা কাজের ছোট ফাংশন
একটা ফাংশন এমন একটা কাজ করবে, যা "এবং" ছাড়া একটা ছোট বাক্যে বর্ণনা করা যায়। "আজকের সক্রিয় অ্যাপয়েন্টমেন্টগুলো খুঁজে বের করা" একটা কাজ; "খোঁজা, সাজানো, গোনা, সতর্ক করা আর প্রিন্ট করা" পাঁচটা। ছোট ফাংশনের নাম দেওয়া, পড়া, টেস্ট করা আর আবার ব্যবহার করা সহজ। এটা সফটওয়্যার ডিজাইনের মূল কথা: রিকোয়ারমেন্ট থেকে মডিউল-এর উচ্চ কোহেশনের ধারণা, একটা ফাইলের ভেতরে প্রয়োগ করা: একটা ফাংশনের সবকিছু একটা উদ্দেশ্যেরই অংশ।
ছোট মানে নির্দিষ্ট কয়েক লাইন নয়। অভিজ্ঞতার একটা নিয়ম: যদি স্ক্রল করতে হয়, বা মাঝখানে "এবার দ্বিতীয় অংশ" ধরনের কমেন্ট দিতে ইচ্ছা করে, তাহলে ফাংশনটা সম্ভবত দুটো কাজ করছে।
পরিষ্কার কন্ট্রোল ফ্লো
গভীর নেস্টিং (একটা for-এর ভেতরে if, তার ভেতরে আরেকটা if) পাঠককে প্রতিটা শর্ত মাথায় রাখতে বাধ্য করে। দুটো সহজ কৌশল একে সমতল করে:
- যে শর্তগুলো একসাথে যায়, সেগুলো জুড়ে দিন: দুটো নেস্টেড
if-এর বদলেif date == day and status != "cancelled":। - আগেভাগে return বা continue করুন (একে প্রায়ই গার্ড ক্লজ বলে): বিশেষ ক্ষেত্রটা আগে সামলে বেরিয়ে যান, যাতে মূল পথটা ইন্ডেন্টের ভেতরে না পড়ে। আগে
if not a.phone: return "SMS skipped: ...", তারপর স্বাভাবিক ক্ষেত্র।
কমেন্ট আর ডকস্ট্রিং
কোড নিজেই বলে দেয় সেটা কী করে; কমেন্টের উচিত এমন কিছু যোগ করা যা কোড বলতে পারে না: সেটা কেন করে, কোনো সতর্কতা, বা নিয়মটা কোথা থেকে এসেছে। ডকস্ট্রিং (docstring) হলো ফাংশনের ভেতরের প্রথম লাইনের স্ট্রিং; Python এটা রেখে দেয় আর help()-এ দেখায়। এক বা দুই বাক্যে বলুন ফাংশনটা কী করে, কী আশা করে আর কী ফেরত দেয়।
উদাহরণ:
c = c + 1 # add 1 to c <- repeats the code: delete it
# slots are 10 minutes <- stale: the next line says 15
MINUTES_PER_PATIENT = 15
for a in active: # reminders keep booking order, as before
<- why: tells a reader not to "fix" it
def active_on(appointments, day):
"""Appointments on `day` that are not cancelled, in booking order."""পুরোনো হয়ে যাওয়া কমেন্টটাই বিপজ্জনক। পরিবর্তনের পর আপডেট না হওয়া কমেন্ট কোনো কমেন্ট না থাকার চেয়েও খারাপ, কারণ পাঠক তাকে বিশ্বাস করেন। কোড বদলালে তার চারপাশের কমেন্টগুলো পড়ুন, আর একই পরিবর্তনে সেগুলো আপডেট বা মুছে ফেলুন।
কতগুলো কমেন্ট স্বাস্থ্যকর, তা নিয়ে অভিজ্ঞদের মত আলাদা। এক মত বলে, ভালো নাম আর ছোট ফাংশন বেশিরভাগ কমেন্টকে অপ্রয়োজনীয় করে দেয়, তাই কমেন্ট থাকা মানে কোডটা আরও পরিষ্কার হতে পারত। আরেক মত বলে, কারণ, সিদ্ধান্ত আর রিকোয়ারমেন্টের সূত্র কেউ লিখে না রাখলে হারিয়ে যায়। দুই পক্ষই মাঝখানে একমত: আগে কোডকে যতটা সম্ভব পরিষ্কার করুন, তারপর যা এখনো স্পষ্ট নয় তার ওপর কমেন্ট দিন, মূলত "কেন"।
কোডিং স্ট্যান্ডার্ড আর স্টাইল গাইড
স্টাইল গাইড হলো কোড দেখতে কেমন হবে তার লিখিত চুক্তি: ইন্ডেন্টেশন, লাইনের দৈর্ঘ্য, নামকরণ, ফাঁকা লাইন, ইমপোর্টের ক্রম। Python-এর জন্য প্রচলিতটা হলো PEP 8, Python Enhancement Proposals-এর স্টাইল গাইড। এর কারণটা সোজাসুজি বলা আছে: "code is read much more often than it is written" (কোড যতবার লেখা হয়, তার চেয়ে অনেক বেশিবার পড়া হয়)। এর কয়েকটা নিয়ম:
| বিষয় | PEP 8 |
|---|---|
| ইন্ডেন্টেশন | "Use 4 spaces per indentation level." (প্রতি ইন্ডেন্টেশন স্তরে ৪টা স্পেস।) "Spaces are the preferred indentation method." (ইন্ডেন্টেশনের পছন্দের পদ্ধতি স্পেস।) |
| লাইনের দৈর্ঘ্য | "Limit all lines to a maximum of 79 characters." (সব লাইন সর্বোচ্চ ৭৯ অক্ষরে সীমিত রাখুন।) ডকস্ট্রিং আর কমেন্ট ৭২-এ ভাঙে। টিম একমত হলে ৯৯ পর্যন্ত যেতে পারে। |
| নাম | ফাংশন আর ভেরিয়েবল ছোট হাতের অক্ষরে, আন্ডারস্কোরসহ (print_day); ক্লাস "CapWords"-এ (Appointment); কনস্ট্যান্ট বড় হাতের অক্ষরে, আন্ডারস্কোরসহ (MAX_PATIENTS_PER_DAY); মডিউলের "short, all-lowercase names" (ছোট, পুরোটা ছোট হাতের নাম)। |
| বিন্যাস | "Surround top-level function and class definitions with two blank lines." (টপ-লেভেল ফাংশন আর ক্লাসের সংজ্ঞার চারপাশে দুটো ফাঁকা লাইন।) ইমপোর্ট আলাদা আলাদা লাইনে। |
PEP 8-এ "A Foolish Consistency is the Hobgoblin of Little Minds" নামে একটা অংশও আছে। এর মূল কথা: একটা প্রজেক্ট বা মডিউলের ভেতরের সামঞ্জস্য গাইডের চেয়েও বেশি গুরুত্বপূর্ণ। ClinicQueue-এর কোডবেস যদি কোনো কাজ এক নির্দিষ্ট ভাবে করে, নতুন কোডও সেভাবেই হবে, আর কনভেনশন কখন বদলাবে তা টিম একসাথে ঠিক করবে।
ফরম্যাটার আর লিন্টার
স্পেস আর কমা নিয়ে রিভিউয়ের সময় নষ্ট করা কারও উচিত নয়। দুই ধরনের টুল সেই কাজটা সরিয়ে নেয়:
- ফরম্যাটার (formatter) আপনার কোডের বিন্যাস (ইন্ডেন্টেশন, লাইন ভাঙা, উদ্ধৃতিচিহ্ন) নিজে থেকেই নতুন করে লেখে, যাতে সবার কোড দেখতে একই রকম হয়।
- লিন্টার (linter) কোড না চালিয়ে পড়ে আর সম্ভাব্য সমস্যা নিয়ে সতর্ক করে: ব্যবহার না হওয়া ভেরিয়েবল, সংজ্ঞার আগে ব্যবহার করা নাম, সব এরর লুকিয়ে ফেলা একটা
except, স্টাইল গাইড ভাঙা একটা লাইন।
টুলের চেয়ে অভ্যাসটা বেশি জরুরি: টিম একটা ফরম্যাটার আর একটা লিন্টার বেছে নেয়, সেটিংস প্রজেক্টে লিখে রাখে, আর প্রতিটা পরিবর্তনে চালায়, ভালো হয় কোড রিভিউতে পৌঁছানোর আগে স্বয়ংক্রিয়ভাবে। তখন রিভিউ লজিক আর ডিজাইনে মন দিতে পারে।
ধাপে ধাপে রিফ্যাক্টরিং
রিফ্যাক্টরিং (refactoring) মানে কোড কী করে তা না বদলে তার গঠন বদলানো। যে নিয়ম এটাকে নিরাপদ করে: ছোট ধাপ, আর প্রতিটা ধাপের পর আচরণ যাচাই। কোনো যাচাই ব্যর্থ হলে আপনি জানেন, শেষ ছোট ধাপটাই সেটা ভেঙেছে।
ধাপ ০: এখন এটা কী করে তা রেকর্ড করুন
proc-এ হাত দেওয়ার আগে ফারহান একটা জানা ইনপুটের জন্য এর হুবহু আউটপুট রেকর্ড করেন। এটাই নিরাপত্তা জাল। (সত্যিকারের স্বয়ংক্রিয় টেস্ট এই কাজটা আরও ভালোভাবে করে; সেগুলো আসছে সফটওয়্যারের মান, টেস্টিং ও QA-তে।)
import contextlib
import io
def captured(func, *args):
"""Run func and return everything it printed, as one string."""
buffer = io.StringIO()
with contextlib.redirect_stdout(buffer):
func(*args)
return buffer.getvalue()
before = captured(proc, appointments, "2026-11-10")
print(len(before.splitlines()), "lines recorded")7 lines recordedধাপ ১: নাম আর কনস্ট্যান্ট
শুধু নাম বদলায়, দুটো ম্যাজিক নম্বর নাম পায়, আর নেস্টেড if-গুলো জুড়ে যায়। প্রতিটা টাপলকে নাম দেওয়া ভেরিয়েবলে খুলে নেওয়ায় x[3]-এর ধাঁধাগুলো দূর হয়। শেষ লাইন যাচাই করে যে আউটপুট বদলায়নি।
MINUTES_PER_PATIENT = 15
MAX_PATIENTS_PER_DAY = 12
def print_day(appointments, day):
queue = []
count = 0
for patient, time, date, status, phone in appointments:
if date == day and status != "cancelled":
shown_phone = phone if phone else "no phone"
queue.append(f"{time} {patient} ({shown_phone})")
count += 1
for line in sorted(queue):
print(line)
minutes = count * MINUTES_PER_PATIENT
print(f"patients: {count}, minutes: {minutes}")
if count > MAX_PATIENTS_PER_DAY:
print("over limit!")
for patient, time, date, status, phone in appointments:
if date == day and status != "cancelled":
if phone:
print(f"SMS to {phone}: see you at {time}")
else:
print(f"SMS skipped: {patient}")
print(captured(print_day, appointments, "2026-11-10") == before)Trueধাপ ২: নাম দেওয়া ফিল্ড আর প্রতি ফাংশনে একটা কাজ
এবার গঠন বদলায়। শুধু টাপলের জায়গায় আসে নাম দেওয়া ফিল্ডসহ ছোট একটা Appointment ক্লাস, ফিল্টারটা দুবারের বদলে একবার লেখা হয় active_on-এ, আর আউটপুটের প্রতিটা লাইনের জন্য একটা করে ফাংশন থাকে যা লাইনটা বানায়। print_day হয়ে যায় কয়েকটা ধাপের ছোট একটা তালিকা, যা প্রায় কাজটার বর্ণনার মতোই পড়া যায়।
from typing import NamedTuple
class Appointment(NamedTuple):
patient: str
time: str # "HH:MM", clinic time zone
date: str # ISO date, "YYYY-MM-DD"
status: str
phone: str # "" when the patient gave no phone number
def active_on(appointments, day):
"""Appointments on `day` that are not cancelled, in booking order."""
return [a for a in appointments
if a.date == day and a.status != "cancelled"]
def queue_line(a):
return f"{a.time} {a.patient} ({a.phone or 'no phone'})"
def reminder_line(a):
if not a.phone:
return f"SMS skipped: {a.patient}"
return f"SMS to {a.phone}: see you at {a.time}"
def summary_line(count):
return f"patients: {count}, minutes: {count * MINUTES_PER_PATIENT}"
def print_day(appointments, day):
"""Print the front-desk queue for `day`, then the reminder SMS lines."""
active = active_on(appointments, day)
for line in sorted(queue_line(a) for a in active):
print(line)
print(summary_line(len(active)))
if len(active) > MAX_PATIENTS_PER_DAY:
print("over limit!")
for a in active: # reminders keep booking order, as before
print(reminder_line(a))
records = [Appointment(*row) for row in appointments]
after = captured(print_day, records, "2026-11-10")
print(after == before)
print(after, end="")True
09:00 Rafi Ahmed (no phone)
09:15 Joseph Das (01700000004)
09:30 Ayesha Khan (01700000001)
patients: 3, minutes: 45
SMS to 01700000001: see you at 09:30
SMS skipped: Rafi Ahmed
SMS to 01700000004: see you at 09:15একটা অদ্ভুত খুঁটিনাটি খেয়াল করুন, যা রিফ্যাক্টরিং ইচ্ছা করেই রেখে দিয়েছে: কিউ সময় অনুযায়ী সাজানো, কিন্তু SMS-এর লাইনগুলো বুকিংয়ের ক্রমেই থাকে। হয়তো এটা বাগ, হয়তো রিনা এটাই চান। রিফ্যাক্টরিং সেটা ঠিক করে না; সে আচরণটা রেখে দেয়। আচরণ বদলানো আলাদা, ভেবেচিন্তে নেওয়া একটা ধাপ, যার নিজস্ব যাচাই আর নিজস্ব কমিট থাকে, যাতে রিভিউয়ার প্রতিটা ধরনের পরিবর্তন পরিষ্কারভাবে দেখতে পান।
এতে লাভ হলো তো?
নতুন ভার্সনটা লম্বা। এটা স্বাভাবিক আর ঠিক আছে: আসল বিষয় হলো পরের পরিবর্তনের খরচ। নাদিয়া যখন স্লট ২০ মিনিট করবেন, তখন একটা কনস্ট্যান্ট বদলালেই হবে। রিমাইন্ডারের ভাষা বদলালে (যেমন AI-এর খসড়া করা টেক্সটের জন্য), বদলে টেস্ট করার জন্য একটা ছোট ফাংশন, reminder_line, আছে। "ফোন নেই"-এর নিয়ম বদলালে সেটা এক জায়গাতেই বদলায়। রিফ্যাক্টরিং করুন যখন কোড বদলাতে যাচ্ছেন বা সবে কাজ করিয়েছেন; এটাকে এমন বড় আলাদা প্রজেক্ট বানাবেন না, যা সপ্তাহের পর সপ্তাহ ফিচারের কাজ থামিয়ে রাখে।
এরর, যাচাই, ম্যাজিক নম্বর আর ডুপ্লিকেশন
সীমানাতেই ইনপুট যাচাই করুন
প্রোগ্রামের বাইরে থেকে আসা ডেটা (ফর্ম, ফাইল, অন্য সিস্টেম) এমনভাবে ভুল হতে পারে, যা আপনার কোড কখনো আশা করেনি। যেখানে ঢোকে সেখানেই একবার যাচাই করুন আর পরিষ্কার অবজেক্টে রূপ দিন; বাকি কোড তখন তাকে বিশ্বাস করতে পারে। ClinicQueue-এর ইমপোর্ট করা সারিতে দুটো আসল সমস্যা লুকিয়ে আছে: "9:45" লেখা একটা সময় (যা "10:00"-এর পরে সাজানো হবে, কারণ টেক্সট অক্ষর ধরে ধরে তুলনা হয়) আর বড় হাতের অক্ষরে লেখা "Cancelled" স্ট্যাটাস (যা ER মডেলে ঠিক করা নির্দিষ্ট তালিকায় নেই)।
import datetime
VALID_STATUSES = {"booked", "cancelled", "arrived", "done"}
def parse_appointment(row):
"""Turn one raw row into an Appointment, or raise ValueError saying why."""
if len(row) != len(Appointment._fields):
raise ValueError(f"expected 5 fields, got {len(row)}: {row!r}")
a = Appointment(*row)
if a.status not in VALID_STATUSES:
raise ValueError(f"{a.patient}: unknown status {a.status!r}")
datetime.date.fromisoformat(a.date) # raises ValueError if bad
try:
datetime.time.fromisoformat(a.time)
except ValueError:
message = f"{a.patient}: time must be HH:MM, got {a.time!r}"
raise ValueError(message) from None
return a
def load(rows):
"""Keep the good rows and collect a message for each bad one."""
good, problems = [], []
for row in rows:
try:
good.append(parse_appointment(row))
except ValueError as error:
problems.append(str(error))
return good, problems
new_rows = appointments + [
("Nusrat Jahan", "9:45", "2026-11-10", "booked", "01700000006"),
("Tomas Gomes", "11:00", "2026-11-10", "Cancelled", ""),
]
good, problems = load(new_rows)
print(len(good), "good rows")
for message in problems:
print("problem:", message)5 good rows
problem: Nusrat Jahan: time must be HH:MM, got '9:45'
problem: Tomas Gomes: unknown status 'Cancelled'সৎভাবে এরর সামলানো
- কী ভুল, মানসহ বলুন। "Tomas Gomes: unknown status 'Cancelled'" দেখে রিনা এক মিনিটে সারিটা ঠিক করতে পারেন; "invalid input" দেখে পারেন না।
- বেছে নিন: থামবেন, নাকি জমা করবেন। নতুন বুকিং সেভ করার সময় ভুল অনুরোধ সঙ্গে সঙ্গে বাতিল করুন (fail fast)। দিনের কিউ দেখানোর সময় খালি স্ক্রিনের চেয়ে ঠিক সারিগুলো আর সমস্যার একটা পরিষ্কার তালিকা দেখানো ভালো। কোন ধরনের ব্যর্থতায় কে ভোগেন, তার ওপর বাছাইটা নির্ভর করে।
- এরর কখনো লুকাবেন না।
except: passএকটা জোরালো, ঠিক করা যায় এমন ব্যর্থতাকে নিঃশব্দ ভুল ডেটায় পরিণত করে। শুধু প্রত্যাশিত এররগুলো ধরুন (এখানেValueError), আর সেগুলো দিয়ে কাজের কিছু করুন।
ম্যাজিক নম্বর
ম্যাজিক নম্বর (magic number) হলো এমন একটা আক্ষরিক মান, যার অর্থ কোথাও লেখা নেই: proc-এর 15 আর 12। পাঠককে অনুমান করতে হয় এর মানে কী, আর নিয়ম বদলালে কাউকে প্রতিটা কপি খুঁজে বের করতে হয়, এমনভাবে যাতে "মিনিট" বোঝানো 15 বদলায় কিন্তু কাকতালীয়ভাবে অন্য কিছু বোঝানো 15 না বদলায়। একটা নাম দেওয়া কনস্ট্যান্ট (MINUTES_PER_PATIENT = 15) অর্থটা জানায় আর বদলানোর একটাই জায়গা দেয়। প্রতিটা আক্ষরিক মান ম্যাজিক নয়: 0, 1 আর ফাঁকা স্ট্রিং সাধারণত স্পষ্ট।
ডুপ্লিকেশন
অগোছালো ভার্সনে "তারিখ মেলে আর বাতিল নয়" দুবার যাচাই হয়েছে, আর "ফোন খালি" দুবার। পুনরাবৃত্ত লজিক মানে একটা বাগ অপেক্ষা করছে: একদিন কেউ এক কপিতে "যাঁরা এসে গেছেন তাঁরা SMS পাবেন না" যোগ করবেন আর অন্যটার কথা ভুলে যাবেন। অভিজ্ঞতার নিয়ম DRY (don't repeat yourself, নিজেকে পুনরাবৃত্তি করবেন না) বলে, প্রতিটা নিয়ম এক জায়গায় থাকা উচিত। ডিজাইনের পাতার অন্য নিয়মগুলোর মতো এটাও আইন নয়: যে দুটো কোড আজ দেখতে একই কিন্তু আলাদা নিয়ম বোঝায়, সেগুলো আলাদা রাখাই ভালো হতে পারে, কারণ সেগুলো আলাদা কারণে বদলাবে।
কাজের জায়গায় এটা কোথায় লাগে
- চালু প্রোডাক্টে একজন ডেভেলপারের বেশিরভাগ সময় যায় কোড পড়ায়; পরিষ্কার নাম আর ছোট ফাংশন প্রতিটা কাজ দ্রুত করে।
- টিমগুলো তাদের স্টাইলের সিদ্ধান্ত প্রজেক্টে লিখে রাখে আর ফরম্যাটার ও লিন্টার স্বয়ংক্রিয়ভাবে চালায়, যাতে রিভিউ হয় লজিক নিয়ে।
- "কোডটা যেমন পেয়েছেন তার চেয়ে একটু পরিষ্কার করে রেখে যান": ছোট ছোট রিফ্যাক্টরিং ফিচারের কাজের পাশাপাশি হয়, প্রতিটা নিজস্ব রিভিউ করা পরিবর্তনে।
- মানুষের জন্য লেখা এরর মেসেজ সাপোর্টের সময় বাঁচায়: ফ্রন্ট ডেস্ক ডেভেলপারকে না ডেকেই ভুল ডেটা ঠিক করতে পারে।
সাধারণ ভুল
- একসাথে রিফ্যাক্টরিং আর আচরণ বদলানো। আউটপুট বদলালে কেউ জানে না সেটা ইচ্ছাকৃত কি না। সমাধান: আলাদা ধাপ, প্রতিটার সাথে যাচাই; আচরণের পরিবর্তন পায় নিজস্ব কমিট।
- নিরাপত্তা জাল ছাড়া রিফ্যাক্টরিং। রেকর্ড করা আউটপুট বা টেস্ট ছাড়া "দেখতে তো একই" একটা অনুমান মাত্র। সমাধান: আগে বর্তমান আচরণ ধরে রাখুন।
- খারাপ নাম ব্যাখ্যা করা কমেন্ট।
c = 0 # number of patients-এর জায়গায় হওয়া উচিতpatient_count = 0। সমাধান: আগে নাম বদলান, যা অস্পষ্ট থাকে শুধু তার ওপর কমেন্ট দিন। - রিভিউতে স্টাইল নিয়ে তর্ক। এতে সময় নষ্ট হয় আর ব্যাপারটা ব্যক্তিগত লাগে। সমাধান: একবার একটা স্টাইল গাইডে একমত হন, ফরম্যাটার আর লিন্টারকে সেটা চাপিয়ে দিতে দিন।
- ক্র্যাশ দূর করতে এরর গিলে ফেলা। ক্র্যাশ চলে যায়, আসে ভুল ডেটা। সমাধান: নির্দিষ্ট এরর ধরুন আর পরিষ্কারভাবে জানান।
নিজে চেষ্টা করুন
অনুশীলনী ১-এর কোড:
def chk(p):
# check phone has 10 digits
if len(p) == 11:
if p.isdigit():
return 1
return 0অনুশীলনী ৩-এর কোড:
def m(l):
t = 0
for i in l:
if i[1] != "cancelled":
if i[2] == "child":
t = t + 10
else:
t = t + 15
return t- সহজ:
chk-এর (অনুশীলনী ১-এর কোড) রক্ষণাবেক্ষণযোগ্যতার প্রতিটা সমস্যার তালিকা করুন, আর একটা ভালো ভার্সন লিখুন। - মাঝারি: ধরুন ফারহান যাচাই বাদ দিয়েছিলেন, আর "9:45" সময়ের সারিটা কিউতে পৌঁছে গেছে। 2026-11-10-এর সাজানো কিউতে নুসরাত জাহান কোথায় দেখা যাবেন, আর কেন? ফ্রন্ট ডেস্ক কী দেখবে?
- কঠিন:
mফাংশনটা (অনুশীলনী ৩-এর কোড)(patient, status, kind)ভিজিটের একটা তালিকা থেকে ডাক্তারের পরিকল্পিত মিনিট হিসাব করে। এটাকে রিফ্যাক্টরিং করুন: পরিষ্কার নাম, ম্যাজিক নম্বর নয়, একটা ডকস্ট্রিং, আরkind-এর যাচাই। তারপর দেখান যে একটা নমুনায় আপনার ভার্সনm-এর মতোই ফল দেয়, আর এমন একটা ইনপুটের নাম বলুন যেখানে দুই ভার্সন আলাদা আচরণ করে।
উত্তর
- সমস্যা:
chkআরpনাম কিছুই বলে না; কমেন্টটা পুরোনো হয়ে গেছে (বলে ১০ অঙ্ক, কোড যাচাই করে ১১); 11 একটা ম্যাজিক নম্বর; যেখানে একটা শর্তই যথেষ্ট সেখানে নেস্টেডif;TrueআরFalse-এর বদলে 1 আর 0 ফেরত দেয়। একটা ভালো ভার্সন:PHONE_DIGITS = 11, তারপরdef is_valid_phone(phone): return len(phone) == PHONE_DIGITS and phone.isdigit(), সাথে "True if phone is exactly PHONE_DIGITS digits, nothing else." ধরনের একটা ডকস্ট্রিং। ভালো উত্তরে অন্তত নাম, পুরোনো কমেন্ট আর ম্যাজিক নম্বর ধরা পড়ে, আর নতুন ভার্সন একটা বুলিয়ান ফেরত দেয়। - টেক্সট অক্ষর ধরে ধরে তুলনা হয়। "9:45 Nusrat Jahan ..." শুরু হয় "9" দিয়ে, আর বাকি প্রতিটা লাইন শুরু হয় "0" দিয়ে ("09:00", "09:15", "09:30"), তাই তাঁর লাইন সবগুলোর পরে সাজানো হয়: তিনি সবার শেষে আসেন, যেন ০৯:৩০-এর রোগীর পরে, যদিও তাঁর স্লট ০৯:৪৫-এ আর তালিকাটা দেখতে বিশ্বাসযোগ্য। পরে "10:00"-এর কোনো রোগী থাকলে তিনি তাঁরও পরে আসতেন, কারণ "1" আসে "9"-এর আগে। ফ্রন্ট ডেস্ক কোনো এরর মেসেজ ছাড়াই ভুল ক্রমে রোগীদের ডাকত। এজন্যই সীমানায় ফরম্যাট যাচাই জরুরি: বাগটা নিঃশব্দ, জোরালো নয়।
- নমুনা উত্তর নিচে। ভালো উত্তরে থাকে: বর্ণনামূলক ফাংশনের নাম আর লুপ ভেরিয়েবল; 10 আর 15 একটা নাম দেওয়া ম্যাপিং বা দুটো কনস্ট্যান্টে; এক লাইনের ডকস্ট্রিং; অজানা kind-এর জন্য পরিষ্কার এরর; নমুনা ডেটায় দুই ভার্সন মেলে কি না তার যাচাই। পার্থক্যটা: পুরোনো
mহুবহু "child" নয় এমন যেকোনো kind-কে ১৫ মিনিট ধরে, তাই "Child" বা "baby"-এর মতো টাইপো নিঃশব্দে প্রাপ্তবয়স্কের ভিজিট হয়ে যায়, অথচ নতুন ভার্সনValueErrorতোলে। এটা আচরণের পরিবর্তন, তাই ভালো উত্তর বলে যে এটা একমত হয়ে নিজস্ব ধাপ হিসেবে করা উচিত, রিফ্যাক্টরিংয়ের ভেতরে লুকিয়ে নয়।
অনুশীলনী ৩-এর নমুনা উত্তর:
def m(l):
t = 0
for i in l:
if i[1] != "cancelled":
if i[2] == "child":
t = t + 10
else:
t = t + 15
return t
VISIT_MINUTES = {"child": 10, "adult": 15}
def planned_minutes(visits):
"""Total doctor minutes for the visits that are not cancelled."""
total = 0
for patient, status, kind in visits:
if status == "cancelled":
continue
if kind not in VISIT_MINUTES:
raise ValueError(f"{patient}: unknown visit kind {kind!r}")
total += VISIT_MINUTES[kind]
return total
sample = [
("Rafi Ahmed", "booked", "child"),
("Ayesha Khan", "booked", "adult"),
("Mim Akter", "cancelled", "child"),
("Joseph Das", "arrived", "adult"),
]
print(m(sample), planned_minutes(sample), m(sample) == planned_minutes(sample))40 40 Trueসারসংক্ষেপ
- রক্ষণাবেক্ষণযোগ্য কোড অন্য কেউ পড়তে আর নিরাপদে বদলাতে পারেন; পরিষ্কার নাম, একটা কাজের ছোট ফাংশন আর সমতল কন্ট্রোল ফ্লো বেশিরভাগ কাজ করে দেয়।
- কমেন্ট ব্যাখ্যা করে "কেন", ডকস্ট্রিং বলে ফাংশনটা কী করে; কোড বদলালে কমেন্ট আপডেট করুন বা মুছে দিন।
- PEP 8-এর মতো স্টাইল গাইড ("code is read much more often than it is written"), সাথে একমত হওয়া ফরম্যাটার আর লিন্টার, রিভিউয়ের তর্ক ছাড়াই কোডকে সামঞ্জস্যপূর্ণ রাখে।
- রিফ্যাক্টরিং গঠন বদলায়, আচরণ নয়: আগে আচরণ রেকর্ড করুন, ছোট ধাপ নিন, প্রতিটার পর যাচাই করুন, আর আচরণ আলাদাভাবে বদলান।
- ইনপুট যেখানে ঢোকে সেখানেই যাচাই করুন, এরর পরিষ্কারভাবে জানান আর কখনো লুকাবেন না; ম্যাজিক নম্বরের জায়গায় নাম দেওয়া কনস্ট্যান্ট দিন, আর প্রতিটা নিয়ম এক জায়গায় রাখুন।
এরপর: কোড রিভিউ, ভার্সন কন্ট্রোল ও টিমের কাজের ধারা: একটা টিম কীভাবে একে অপরের কোড যাচাই করে, ব্রাঞ্চ আর পুল রিকোয়েস্ট ব্যবহার করে, আর মূল কোডকে সবসময় রিলিজের জন্য তৈরি রাখে।

