⭐ Python Developer · Chặng 5Bài 4/5Bài học~45 phút

Context manager trong Python: with, __enter__, contextlib

Hiểu câu lệnh with, tự viết context manager bằng __enter__, __exit__ và contextlib, dùng suppress, ExitStack để dọn tài nguyên.

Context manager trong Python: with, __enter__, contextlib

Học xong bài này, bạn sẽ

  • Hiểu with đảm bảo dọn dẹp tài nguyên
  • Viết context manager bằng class và contextlib.contextmanager
  • Dùng suppress, ExitStack, chdir có sẵn

Nên học trước: Closure và decorator

Nội dung bài viết
  1. 1. with làm gì
  2. 2. Tự viết bằng class
  3. 3. Cách ngắn hơn: contextlib.contextmanager
  4. 4. Ví dụ thực tế: giao dịch ghi file an toàn
  5. 5. Công cụ có sẵn trong contextlib
  6. Tóm tắt
  7. Bài tập

Mở file thì phải đóng, lấy khóa thì phải nhả, mở kết nối CSDL thì phải ngắt, kể cả khi giữa chừng có lỗi. Câu lệnh with bảo đảm việc "dọn dẹp" luôn xảy ra. Bạn đã dùng with open(...) từ chặng 3; bài này giải thích cơ chế bên dưới và dạy bạn tự viết context manager cho tài nguyên của riêng mình.

1. with làm gì

# (minh họa) hai đoạn tương đương
with open("a.txt", encoding="utf-8") as f:
    xu_ly(f)

f = open("a.txt", encoding="utf-8")
try:
    xu_ly(f)
finally:
    f.close()

Đối tượng dùng được sau with là context manager: có phương thức __enter__ (chạy khi vào khối, giá trị trả về gán cho biến sau as) và __exit__ (chạy khi ra khỏi khối, dù bình thường, return, break hay có ngoại lệ).

2. Tự viết bằng class

import time


class DemGio:
    def __init__(self, ten):
        self.ten = ten

    def __enter__(self):
        self.bat_dau = time.perf_counter()
        return self                              # gán cho biến sau "as"

    def __exit__(self, loai_loi, loi, traceback):
        self.giay = time.perf_counter() - self.bat_dau
        trang_thai = "lỗi " + loai_loi.__name__ if loai_loi else "xong"
        print(f"[{self.ten}] {trang_thai} sau {self.giay:.1f}s")
        return False                             # False: không nuốt ngoại lệ


with DemGio("nhập dữ liệu") as dg:
    time.sleep(0.2)
print(round(dg.giay, 1))

try:
    with DemGio("tính toán"):
        1 / 0
except ZeroDivisionError:
    print("Ngoại lệ vẫn bay ra ngoài")
[nhập dữ liệu] xong sau 0.2s
0.2
[tính toán] lỗi ZeroDivisionError sau 0.0s
Ngoại lệ vẫn bay ra ngoài

__exit__ nhận ba thông tin về ngoại lệ (đều là None nếu không có lỗi). Trả True thì ngoại lệ bị nuốt, trả False hoặc None thì ngoại lệ tiếp tục bay ra. Gần như lúc nào bạn cũng nên để ngoại lệ bay ra.

3. Cách ngắn hơn: contextlib.contextmanager

import os
from contextlib import contextmanager
from pathlib import Path


@contextmanager
def tam_doi_thu_muc(duong_dan):
    cu = Path.cwd()
    os.chdir(duong_dan)          # phần trước yield = __enter__
    try:
        yield Path.cwd()         # giá trị cho "as"; khối with chạy tại đây
    finally:
        os.chdir(cu)             # phần sau yield = __exit__, đặt trong finally


Path("du_lieu").mkdir(exist_ok=True)
goc = Path.cwd()
with tam_doi_thu_muc("du_lieu") as hien_tai:
    print(hien_tai.name)
print(Path.cwd() == goc)
du_lieu
True

Một generator có đúng một yield + decorator @contextmanager là đủ. Bắt buộc bọc yield trong try/finally: nếu khối with ném lỗi, lỗi xuất hiện tại dòng yield, và không có finally thì phần dọn dẹp không chạy. (Từ Python 3.11 thư viện chuẩn đã có sẵn contextlib.chdir; tự viết ở đây để hiểu cơ chế.)

4. Ví dụ thực tế: giao dịch ghi file an toàn

Ghi đè file cấu hình mà chương trình bị tắt giữa chừng thì file hỏng, mất cả bản cũ. Cách an toàn: ghi vào file tạm, xong xuôi mới thay thế file thật.

import json
import os
from contextlib import contextmanager
from pathlib import Path


@contextmanager
def ghi_an_toan(p: Path):
    tam = p.with_suffix(p.suffix + ".tmp")
    f = open(tam, "w", encoding="utf-8")
    try:
        yield f
        f.close()
        os.replace(tam, p)            # thay thế nguyên tử: hoặc file mới, hoặc file cũ
    except BaseException:
        f.close()
        tam.unlink(missing_ok=True)   # có lỗi: bỏ file tạm, file thật giữ nguyên
        raise


p = Path("cau_hinh.json")
p.write_text('{"phien_ban": 1}', encoding="utf-8")
try:
    with ghi_an_toan(p) as f:
        f.write('{"phien_ban": 2, ')
        raise RuntimeError("mất điện giữa chừng")
except RuntimeError:
    pass
print(json.loads(p.read_text(encoding="utf-8")))

with ghi_an_toan(p) as f:
    json.dump({"phien_ban": 2}, f)
print(json.loads(p.read_text(encoding="utf-8")), list(Path(".").glob("*.tmp")))
{'phien_ban': 1}
{'phien_ban': 2} []

os.replace đổi tên trong một bước duy nhất ở mức hệ điều hành, nên file cấu hình không bao giờ ở trạng thái "ghi được một nửa". Người dùng chỉ cần viết with ghi_an_toan(p) as f:, mọi chi tiết khó nằm gọn trong context manager.

5. Công cụ có sẵn trong contextlib

from contextlib import ExitStack, suppress
from pathlib import Path

with suppress(FileNotFoundError):       # bỏ qua đúng một loại lỗi, gọn hơn try/except/pass
    Path("khong_ton_tai.txt").unlink()

for ten in ("a.txt", "b.txt", "c.txt"):
    Path(ten).write_text(ten[0] * 3, encoding="utf-8")

with ExitStack() as stack:              # mở số lượng file không biết trước
    cac_file = [stack.enter_context(open(t, encoding="utf-8")) for t in ("a.txt", "b.txt", "c.txt")]
    print([f.read() for f in cac_file])
print(all(f.closed for f in cac_file))
['aaa', 'bbb', 'ccc']
True

Bạn sẽ gặp context manager ở khắp nơi: sqlite3 và Session của SQLAlchemy (chặng 8), httpx.Client (chặng 7, 10), threading.Lock (chặng 10), pytest.raises (chặng 6). Nhìn thấy tài nguyên cần "mở – đóng", hãy nghĩ ngay đến with.

Tóm tắt

  • with = __enter__ khi vào, __exit__ khi ra, kể cả khi lỗi.
  • Viết bằng class (__enter__/__exit__) hoặc @contextmanager + một yield trong try/finally.
  • __exit__ trả False để không nuốt ngoại lệ.
  • suppress, ExitStack, chdir (3.11+) có sẵn trong contextlib.

Bài tập

Bài 1. Đếm giờ bằng contextmanager

Viết lại DemGio ở mục 2 bằng @contextmanager: in thời gian chạy khối lệnh kèm trạng thái, kể cả khi có lỗi.

Xem đáp án
import time
from contextlib import contextmanager


@contextmanager
def dem_gio(ten):
    bat_dau = time.perf_counter()
    trang_thai = "xong"
    try:
        yield
    except BaseException as e:
        trang_thai = f"lỗi {type(e).__name__}"
        raise
    finally:
        print(f"[{ten}] {trang_thai} sau {time.perf_counter() - bat_dau:.1f}s")


with dem_gio("ngủ"):
    time.sleep(0.1)
try:
    with dem_gio("chia"):
        1 / 0
except ZeroDivisionError:
    pass
[ngủ] xong sau 0.1s
[chia] lỗi ZeroDivisionError sau 0.0s

Bài 2. Tạm đổi biến môi trường

Viết context manager tam_dat_env(ten, gia_tri) đặt biến môi trường trong khối with, ra khỏi khối thì khôi phục giá trị cũ (hoặc xóa nếu trước đó chưa có). Rất hữu ích khi kiểm thử.

Xem đáp án
import os
from contextlib import contextmanager


@contextmanager
def tam_dat_env(ten: str, gia_tri: str):
    cu = os.environ.get(ten)
    os.environ[ten] = gia_tri
    try:
        yield
    finally:
        if cu is None:
            del os.environ[ten]
        else:
            os.environ[ten] = cu


with tam_dat_env("CHE_DO", "kiem_thu"):
    print(os.environ["CHE_DO"])
print(os.environ.get("CHE_DO"))
kiem_thu
None

pytest có sẵn fixture monkeypatch.setenv làm đúng việc này; bạn sẽ dùng ở chặng 6.

Nguồn tham khảo: The with statement; contextlib; os.replace.

Bài tập thực hành

  1. Viết context manager dem_gio(ten) in thời gian chạy khối lệnh, kể cả khi có lỗi.
  2. Viết context manager tam_doi_thu_muc(duong_dan) đổi thư mục làm việc rồi trả lại.

Làm xong bài tập mới chuyển sang bài tiếp theo: tự viết code là cách duy nhất để nhớ lâu.

Bài tiếp theo
Ban biên tập HocFree

Chúng tôi viết những bài hướng dẫn dễ hiểu, thực tế để ai cũng có thể tự học lập trình và AI, hoàn toàn miễn phí.