Python Context Manager (with)
เราใช้ with open(...) มาตั้งแต่บทไฟล์ โดยรู้แค่ว่า “มันปิดไฟล์ให้อัตโนมัติ” บทนี้จะอธิบายว่ากลไกเบื้องหลังคืออะไร และวิธีสร้าง context manager (ตัวจัดการทรัพยากรเปิด-ปิด) ของตัวเอง
ปัญหาที่ with แก้
ทรัพยากรหลายอย่างต้อง “เปิด” แล้วต้อง “ปิด” คู่กันเสมอ เช่น ไฟล์ การเชื่อมต่อฐานข้อมูล ล็อก ถ้าลืมปิด หรือเกิด error ก่อนถึงบรรทัดปิด จะเกิดปัญหา
f = open("data.txt")
content = f.read()
process(content) # ถ้าบรรทัดนี้ error...
f.close() # ...บรรทัดนี้ไม่ถูกเรียก ไฟล์ค้างwith รับประกันว่าส่วน “ปิด” จะถูกเรียกเสมอ ไม่ว่าจะจบปกติหรือ error
with open("data.txt") as f:
content = f.read()
process(content) # error ก็ยังปิดไฟล์ให้with ทำงานยังไง
อ็อบเจกต์ที่ใช้กับ with ได้ ต้องมีสองเมท็อด
__enter__— ทำตอนเข้าบล็อก ค่าที่ return ไปอยู่หลังas__exit__— ทำตอนออกจากบล็อก (ทั้งกรณีปกติและ error)
สร้าง context manager ด้วยคลาส
class Timer:
def __enter__(self):
import time
self.start = time.perf_counter()
return self
def __exit__(self, exc_type, exc_value, traceback):
import time
self.elapsed = time.perf_counter() - self.start
print(f"ใช้เวลา {self.elapsed:.4f} วินาที")
with Timer():
total = sum(range(10_000_000))
# ใช้เวลา 0.1234 วินาทีพารามิเตอร์สามตัวของ __exit__ คือข้อมูล exception ที่เกิดในบล็อก (ถ้าไม่มี error ทั้งสามเป็น None)
จัดการ error ใน __exit__
class DatabaseConnection:
def __enter__(self):
print("เปิดการเชื่อมต่อ")
return self
def __exit__(self, exc_type, exc_value, traceback):
print("ปิดการเชื่อมต่อ")
if exc_type is not None:
print(f" (เกิด {exc_type.__name__}: {exc_value})")
return False # False = ไม่กลบ exception ให้มันโยนต่อ
with DatabaseConnection():
print("ทำงานกับฐานข้อมูล")
raise ValueError("query ผิด")ผลลัพธ์:
เปิดการเชื่อมต่อ
ทำงานกับฐานข้อมูล
ปิดการเชื่อมต่อ
(เกิด ValueError: query ผิด)
Traceback ... ValueError: query ผิดการเชื่อมต่อถูกปิดก่อน แล้ว exception ค่อยโยนต่อ ถ้า __exit__ คืน True จะเป็นการ “กลืน” exception (ใช้ระวัง ๆ)
วิธีที่สั้นกว่า: @contextmanager
contextlib ให้เราเขียน context manager เป็นฟังก์ชัน generator ได้ โค้ดก่อน yield คือ __enter__ โค้ดหลัง yield คือ __exit__
from contextlib import contextmanager
import time
@contextmanager
def timer(label="งาน"):
start = time.perf_counter()
try:
yield
finally:
elapsed = time.perf_counter() - start
print(f"{label} ใช้เวลา {elapsed:.4f} วินาที")
with timer("คำนวณผลรวม"):
total = sum(range(10_000_000))try/finally รอบ yield รับประกันว่าส่วนเก็บกวาดทำงานแม้บล็อกจะ error
ตัวอย่าง: เปลี่ยนโฟลเดอร์ชั่วคราว
from contextlib import contextmanager
import os
@contextmanager
def working_directory(path):
original = os.getcwd()
os.chdir(path)
try:
yield
finally:
os.chdir(original) # กลับที่เดิมเสมอ
print(os.getcwd())
with working_directory("/tmp"):
print(os.getcwd()) # /tmp
print(os.getcwd()) # กลับมาที่เดิมเปิดหลายอย่างพร้อมกัน
with open("input.txt") as src, open("output.txt", "w") as dst:
for line in src:
dst.write(line.upper())ทั้งสองไฟล์ถูกปิดเมื่อออกจากบล็อก
context manager ที่มีในไลบรารีมาตรฐาน
from contextlib import suppress
# แทน try/except pass
with suppress(FileNotFoundError):
os.remove("temp.txt") # ไม่มีไฟล์ก็ไม่ error
import threading
lock = threading.Lock()
with lock: # ล็อก/ปลดล็อกอัตโนมัติ
# critical section
...ตัวอย่างรวม: เขียนไฟล์แบบ atomic
เขียนลงไฟล์ชั่วคราวก่อน ถ้าสำเร็จค่อยเปลี่ยนชื่อทับของจริง — ป้องกันไฟล์เสียถ้าโปรแกรมตายกลางคัน
from contextlib import contextmanager
import os
@contextmanager
def atomic_write(path):
tmp = path + ".tmp"
f = open(tmp, "w", encoding="utf-8")
try:
yield f
f.close()
os.replace(tmp, path) # เปลี่ยนชื่อแบบ atomic
except Exception:
f.close()
os.remove(tmp) # ล้างไฟล์ชั่วคราวถ้าพัง
raise
with atomic_write("config.json") as f:
f.write('{"theme": "dark"}')เช็คความเข้าใจก่อนข้ามบท
- อธิบายได้ว่า
withช่วยจัดการทรัพยากรให้ถูกปิดหรือคืนค่าแม้เกิด error - สร้าง context manager แบบคลาสหรือ
@contextmanagerได้อย่างน้อยหนึ่งแบบ - ลองใช้
withกับไฟล์ แล้วตั้งใจทำให้เกิด exception เพื่อดูว่าไฟล์ยังถูกปิด
สรุป
withรับประกันว่าโค้ดเก็บกวาดถูกเรียกเสมอ แม้บล็อกจะ error- สร้างเองด้วยคลาสที่มี
__enter__/__exit__ - หรือใช้
@contextmanagerเขียนเป็น generator: ก่อนyield= setup, หลังyield(ใน finally) = cleanup contextlib.suppress,threading.Lockเป็น context manager ที่ใช้ได้เลย
บทถัดไปว่าด้วย type hints การระบุชนิดข้อมูลเพื่อให้โค้ดชัดขึ้น