Tự viết module Python và if __name__ == "__main__"
Bài 6/14 · Chương 9
Module, gói và môi trường
- 7 phút
- Cơ bản
- Python 3.14
- Cập nhật
Trong bài này · 12
Một module Python bạn tự viết chỉ là một file .py chứa hằng và hàm, đặt cạnh file chính để file đó import vào dùng. Bạn tách module khi cùng một hàm, như hàm đếm số buổi học, cần cho nhiều chương trình, để sửa một chỗ là mọi nơi dùng đều được sửa.
Cần biết trước: import và module, tách chương trình thành hàm và assert.
Tạo module đầu tiên
Trên máy, bạn mở trình soạn thảo, tạo file lich_hoc.py cạnh file chính và viết vào đó:
BUOI = ("Thứ 2", "Thứ 4", "Thứ 6")
def so_buoi(so_tuan):
return so_tuan * len(BUOI)
Tên file bỏ đuôi .py là tên module, nên file chính viết import lich_hoc. Trên trang này mỗi lần chạy bắt đầu trong một thư mục trống, nên ví dụ dưới tự ghi file lich_hoc.py trước rồi mới import. Dòng Path(...).write_text(...) chỉ làm việc ghi file đó; bài pathlib dạy kỹ cách ghi file này:
from pathlib import Path
ma_module = '''BUOI = ("Thứ 2", "Thứ 4", "Thứ 6")
def so_buoi(so_tuan):
return so_tuan * len(BUOI)
'''
Path("lich_hoc.py").write_text(ma_module, encoding="utf-8")
import lich_hoc
print(lich_hoc.BUOI)
print(lich_hoc.so_buoi(10))KẾT QUẢ
('Thứ 2', 'Thứ 4', 'Thứ 6')
30Từ đây, module của bạn dùng y như module của thư viện chuẩn: lich_hoc.BUOI, lich_hoc.so_buoi(10), hay from lich_hoc import so_buoi. Hãy hình dung module như một ngăn kéo có dán nhãn tên file: file chính chỉ cần biết nhãn, không cần biết đồ trong ngăn được làm ra thế nào. Python tìm module trước hết trong thư mục của file chính, nên hai file phải nằm cùng thư mục.
Đổi len(BUOI) thành 2 rồi chạy lại: dòng cuối in 20.
Import chạy cả file module
Khi import, Python chạy file module một lượt từ trên xuống, ở lần import đầu. Mọi file có sẵn một biến __name__: trong file bạn chạy trực tiếp nó là "__main__", trong file được import nó là tên module:
from pathlib import Path
ma_module = '''print("Đang nạp lich_hoc, __name__ là", __name__)
'''
Path("lich_hoc.py").write_text(ma_module, encoding="utf-8")
import lich_hoc
import lich_hoc
print("File chính, __name__ là", __name__)KẾT QUẢ
Đang nạp lich_hoc, __name__ là lich_hoc
File chính, __name__ là __main__Dù có hai dòng import lich_hoc, dòng "Đang nạp" chỉ in một lần: lần thứ hai Python dùng lại module đã nạp. Trong lich_hoc.py, __name__ là "lich_hoc"; trong file chính, nơi bạn bấm Chạy, nó là "__main__".
Khối if __name__ == "__main__"
Khối if __name__ == "__main__": chỉ chạy khi chính file đó là file bạn chạy, không chạy khi file được import. Đây là chỗ để các dòng assert tự kiểm hàm của module:
from pathlib import Path
ma_module = '''def so_buoi(so_tuan):
return so_tuan * 3
if __name__ == "__main__":
assert so_buoi(10) == 30
print("Tự kiểm lich_hoc: đạt")
'''
Path("lich_hoc.py").write_text(ma_module, encoding="utf-8")
import lich_hoc
print(lich_hoc.so_buoi(4))KẾT QUẢ
12Lần này import không in dòng tự kiểm, vì trong lich_hoc.py biến __name__ là "lich_hoc". Trên máy, bạn chạy thẳng file module bằng lệnh python (bài trình thông dịch nói cách chạy một file), và khi đó khối tự kiểm chạy. Trên Windows thay python3 bằng python:
python3 lich_hoc.pyKẾT QUẢ
Tự kiểm lich_hoc: đạtMột file nhờ vậy làm được hai việc: là module cho file khác dùng, và là chương trình tự kiểm chính nó. Khi có nhiều module cùng một chủ đề, bạn gom chúng vào một thư mục gọi là package.
Đừng đặt tên file trùng module chuẩn
Python tìm module trong thư mục của file chính trước thư viện chuẩn. Trên máy, một file của bạn tên calendar.py, random.py hay json.py sẽ che mất module chuẩn cùng tên.
Trên trang, random và json đã được nạp trước khi code của bạn chạy nên file trùng tên không che được chúng; trên máy thì che.
Một thư mục __pycache__ có thể xuất hiện cạnh module trên máy bạn: Python lưu sẵn bản dịch của module ở đó để lần sau nạp nhanh hơn. Đổi tên file thì xóa luôn thư mục này cũng được, Python tự tạo lại.
Kiểm tra nhanh
Trong ví dụ có hai dòng
import lich_hocliền nhau, dòng "Đang nạp lich_hoc" được in mấy lần?- Một lần
- Hai lần
- Không lần nào
Khi file
lich_hoc.pyđược import, biến__name__bên trong nó có giá trị gì?"__main__""lich_hoc""lich_hoc.py"
Trên máy, đặt cạnh file chính, những file nào che mất một module của thư viện chuẩn?
random.pylich_hoc.pycalendar.pyrandom_so.py
Trong khung bẫy đặt dòng tự kiểm ở cấp cao nhất của module, điều gì xảy ra khi file chính import nó?
- Python báo lỗi vì module không được có
assert - Các dòng tự kiểm bị bỏ qua
- Các dòng tự kiểm chạy và in ra, ngay trong file chính
- Python báo lỗi vì module không được có
Bài tập
Tìm file trùng tên module chuẩn
Một công cụ dọn dự án cảnh báo những file sẽ che module của thư viện chuẩn. Viết thân hàm file_trung_ten(cac_file, module_chuan): cac_file là list tên file trong thư mục dự án, module_chuan là set tên các module chuẩn. Một file trùng tên khi nó có đuôi .py và phần trước .py có đúng trong module_chuan.
Ví dụ file_trung_ten(["random.py", "randoms.py"], {"random"}) trả về ["random.py"].
Hàm không sửa cac_file của nơi gọi hàm.
Trả về: tên các file trùng, theo thứ tự trong cac_file, một list.
def file_trung_ten(cac_file, module_chuan):
pass # Viết thân hàm thay cho dòng nàyTóm tắt
Một file
.pylà một module; tên module là tên file bỏ đuôi.py.File chính
import lich_hocđược khilich_hoc.pynằm cùng thư mục.Import chạy cả file module một lần, ở lần import đầu.
__name__là"__main__"trong file chạy trực tiếp, là tên module trong file được import.Đặt code tự kiểm trong
if __name__ == "__main__":để import không chạy nó.Trên máy, tên file trùng module chuẩn (
random.py,calendar.py) che mất module đó.
Câu hỏi thường gặp
Dòng if __name__ == __main__ trong Python dùng để làm gì?
Để một file vừa làm module vừa chạy được như chương trình. Code trong khối đó chỉ chạy khi bạn chạy trực tiếp file, nên đặt ở đó các dòng assert tự kiểm hay một ví dụ dùng hàm. File khác import module thì khối đó bị bỏ qua, như ví dụ trong bài.
Tạo module Python ở thư mục khác thì import thế nào?
Cách gọn là gom các module vào một thư mục con làm package rồi import theo đường dẫn chấm, như import tien_ich.lich_hoc. Bài package dạy cách tổ chức đó. Thêm thư mục tùy ý vào chỗ Python tìm module là việc của sys.path, bài sys nói kỹ.
Sửa module rồi mà file chính vẫn chạy code cũ thì sao?
Trong một lần chạy, Python chỉ nạp module một lần, nên sửa file lúc chương trình đang chạy (như trong một notebook) thì phải chạy lại từ đầu. Chạy file chính bằng lệnh python mỗi lần thì luôn nạp bản mới nhất. Bài import có giải thích việc nạp một lần.
Tự viết module Python thì đặt tên file thế nào?
Dùng chữ thường không dấu, nối bằng dấu gạch dưới, như lich_hoc.py, tien_ich.py, vì tên file phải là một tên Python hợp lệ để viết sau import. Tránh tên trùng module chuẩn, và tránh dấu gạch ngang: lich-hoc.py không import được.
Chủ đề
Bài này có hữu ích?
Hỏi đáp
Tham vấn chuyên môn
Nhà sáng lập AIDev và VietPlatform · Thạc sĩ AI MSE
- Tốt nghiệp thủ khoa xuất sắc Thạc sĩ AI MSE.
- Đồng sáng lập, CTO E-University, SVOnline: số hóa 10+ đại học, 40.000+ sinh viên.
- Xây hệ thống AI cho doanh nghiệp tại VietPlatform.