PEP 8 và ruff: định dạng code Python đúng chuẩn
Bài 2/10 · Chương 16
Code sạch, kiểm thử và gỡ lỗi
- 9 phút
- Cơ bản
- Python 3.14
- Cập nhật
Trong bài này · 13
PEP 8 là bản quy ước trình bày code Python: đặt tên thế nào, thụt lề bao nhiêu, đặt dấu cách ở đâu, một dòng dài tối đa bao nhiêu ký tự. Bạn theo nó để người khác đọc code của mình như đọc code của chính họ, và để công cụ như ruff tự sửa phần trình bày thay bạn.
Cần biết trước: quy tắc đặt tên biến, cú pháp và thụt lề và pip install.
PEP 8 là gì
PEP là viết tắt của Python Enhancement Proposal, các văn bản đề xuất thay đổi cho Python, và PEP 8 là văn bản về cách trình bày code. Python không bắt bạn theo nó. Đoạn code dưới đây trái PEP 8 ở nhiều chỗ mà vẫn chạy đúng:
def TinhPhiGiao( tongDon ):
if tongDon>=300000 : return 0
return 30000
gia={"cà phê sữa":29000,"bạc xỉu":32000}
print(TinhPhiGiao(gia["cà phê sữa"]*2),TinhPhiGiao( 320000 ))KẾT QUẢ
30000 0Cùng chương trình đó viết theo PEP 8:
def tinh_phi_giao(tong_don):
if tong_don >= 300000:
return 0
return 30000
gia = {"cà phê sữa": 29000, "bạc xỉu": 32000}
print(tinh_phi_giao(gia["cà phê sữa"] * 2), tinh_phi_giao(320000))KẾT QUẢ
30000 0Hai bản in giống hệt nhau. Bản sau tên hàm viết thường nối bằng _, thụt lề bốn dấu cách, mỗi câu lệnh một dòng, có dấu cách quanh >=, *, = và sau dấu phẩy, không có dấu cách sát trong ngoặc, hai dòng trống sau hàm. PEP 8 giống luật đi đường bên phải: xe đi bên trái vẫn chạy được, nhưng ai cũng theo một chiều thì đỡ va nhau.
Đặt tên theo PEP 8
Mỗi loại tên có một kiểu viết riêng, nên chỉ nhìn tên là biết nó là gì:
Loại tên | Kiểu viết | Ví dụ |
|---|---|---|
Biến, hàm, phương thức | chữ thường nối bằng |
|
Hằng | chữ hoa nối bằng |
|
Class | viết hoa chữ cái đầu mỗi từ, không |
|
Module (tên file) | chữ thường, ngắn, được có |
|
PHI_GIAO = 30000
def tinh_phi_giao(tong_don):
if tong_don >= 300000:
return 0
return PHI_GIAO
class HoaDon:
pass
don_hang = HoaDon()
print(type(don_hang).__name__, tinh_phi_giao(250000))KẾT QUẢ
HoaDon 30000Python coi PHI_GIAO là biến bình thường và vẫn cho gán lại. Chữ hoa chỉ báo cho người đọc "đừng sửa giá trị này". Tên tiếng Việt viết không dấu, vì PEP 8 khuyên tên chỉ dùng chữ cái ASCII khi code được nhiều người đọc. Đổi 250000 thành 320000 rồi chạy lại: dòng in ra là HoaDon 0.
Thụt lề, khoảng trắng và độ dài dòng
PEP 8 đặt mỗi mức thụt lề bằng bốn dấu cách, không dùng tab, và giữ mỗi dòng tối đa 79 ký tự (nhiều dự án nới lên 88 hay 100). Dòng dài thì xuống dòng bên trong cặp ngoặc tròn, thay cho dấu \ cuối dòng, và đặt toán tử ở đầu dòng mới:
gia = {"cà phê sữa": 29000, "bạc xỉu": 32000, "trà đào": 35000}
tong_tien = (
gia["cà phê sữa"] * 2
+ gia["bạc xỉu"]
+ gia["trà đào"] * 3
)
print(tong_tien)KẾT QUẢ
195000Trong cặp ngoặc, Python tự nối các dòng thành một biểu thức. Toán tử đứng đầu dòng giúp mắt dò cột bên trái là thấy món nào được cộng. Các dòng import đặt ở đầu file, mỗi module một dòng, module của thư viện chuẩn trước, thư viện cài thêm sau, module của bạn cuối cùng, mỗi nhóm cách nhau một dòng trống.
Tự định dạng bằng ruff format
Nhớ hết PEP 8 không cần thiết: ruff là công cụ cài thêm từ PyPI, sửa phần trình bày thay bạn. Cài bằng pip, trên macOS/Linux gõ python3, trên Windows gõ python:
python3 -m pip install ruffKẾT QUẢ
Successfully installed ruff-0.17.5Số phiên bản trên máy bạn có thể khác. Bài này chạy với ruff 0.17.5 ngày 15/11/2026. Ruff không chạy trong trình duyệt, nên các lệnh của hai mục cuối gõ trong terminal. Lưu đoạn code trái PEP 8 ở đầu bài vào file hoa_don.py, thêm dòng import os lên đầu, rồi chạy:
python3 -m ruff format hoa_don.pyKẾT QUẢ
1 file reformattedruff format viết lại file tại chỗ: thụt lề bốn dấu cách, tách if … : return 0 thành hai dòng, thêm dấu cách quanh toán tử và sau dấu phẩy, thêm hai dòng trống sau hàm. File sau khi chạy:
import os
def TinhPhiGiao(tongDon):
if tongDon >= 300000:
return 0
return 30000
gia = {"cà phê sữa": 29000, "bạc xỉu": 32000}
print(TinhPhiGiao(gia["cà phê sữa"] * 2), TinhPhiGiao(320000))
Tên TinhPhiGiao và tongDon vẫn giữ nguyên: đổi tên có thể làm hỏng nơi khác gọi hàm, nên ruff format không bao giờ đụng tới tên. Dòng import os thừa cũng còn đó, vì nó là việc của lệnh kế tiếp.
Soát lỗi bằng ruff check
ruff check đọc code và báo những chỗ có thể sai: import không dùng, biến gán mà không đọc, except: trần. Chạy trên file vừa định dạng:
python3 -m ruff check --output-format concise hoa_don.pyKẾT QUẢ
hoa_don.py:1:8: F401 [*] `os` imported but unused
Found 1 error.
[*] 1 fixable with `--fix`.Mỗi dòng ghi file, dòng, cột, mã luật (F401) và lời giải thích. Dấu [*] nghĩa là ruff tự sửa được: python3 -m ruff check --fix hoa_don.py xóa dòng import os. Bỏ --output-format concise thì ruff in thêm đoạn code quanh chỗ lỗi và gợi ý sửa. Bộ luật mặc định không kiểm cách đặt tên. Thêm --select N để bật nhóm luật đặt tên theo PEP 8:
python3 -m ruff check --select N --output-format concise hoa_don.pyKẾT QUẢ
hoa_don.py:4:5: N802 Function name `TinhPhiGiao` should be lowercase
hoa_don.py:4:17: N803 Argument name `tongDon` should be lowercase
Found 2 errors.Hai lỗi này ruff không tự sửa: bạn đổi tên bằng tay, ở chỗ định nghĩa và ở từng chỗ gọi. Thói quen tốt là chạy ruff format rồi ruff check trước mỗi lần lưu bài hay gửi code cho người khác.
Kiểm tra nhanh
Với
gia={"bạc xỉu":32000}, lệnhprint(gia [ "bạc xỉu" ]*2)in ra gì?64000- Báo lỗi cú pháp
bạc xỉu bạc xỉu
Những tên nào viết đúng PEP 8 cho loại được ghi kèm?
tong_tiencho một biếnTinhPhiGiaocho một hàmHoaDoncho một classphiGiaocho một hằng
File có
import osmà không dùngos. Chạypython3 -m ruff formattrên file đó thì dòngimport osra sao?- Bị xóa, vì ruff format sửa mọi chỗ trái PEP 8
- Vẫn còn:
ruff checkmới báo nó (F401) và--fixmới xóa - Bị đổi thành
from os import *
Thân hàm có một dòng thụt bằng phím Tab, các dòng khác bằng bốn dấu cách. Chạy file thì sao?
- Chạy bình thường vì hai dòng trông thẳng hàng
- Python tự đổi tab thành bốn dấu cách rồi chạy
- Python dừng với
TabError, một loạiIndentationError
Bài tập
Kiểm tên theo quy ước PEP 8
Một công cụ soát code cần biết tên có theo PEP 8 không. Viết thân dung_kieu_ten(ten, loai), với loai là một trong ba chuỗi:
"ham"(tên biến hay hàm): chỉ có chữ cái thườnga–z, chữ số và_."hang"(tên hằng): chỉ có chữ cái hoaA–Z, chữ số và_."class": chỉ có chữ cáia–z,A–Zvà chữ số, không có_, ký tự đầu là chữ cái hoa.
Với cả ba loại, tên rỗng hay mở đầu bằng chữ số là sai. Chữ cái có dấu (ổ, Đ) không nằm trong các chữ cái trên. Dùng ba chuỗi THUONG, HOA, SO có sẵn.
Ví dụ: dung_kieu_ten("tong_tien", "ham") trả về True, dung_kieu_ten("Hoa_Don", "class") trả về False.
Trả về: tên có đúng kiểu viết không, một bool.
THUONG = "abcdefghijklmnopqrstuvwxyz"
HOA = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
SO = "0123456789"
def dung_kieu_ten(ten, loai):
pass # Viết thân hàm thay cho dòng nàyTóm tắt
PEP 8 là quy ước trình bày code Python. Code trái PEP 8 vẫn chạy, chỉ khó đọc hơn.
Biến và hàm viết
snake_case, hằng viếtCHU_HOA, class viếtCapWords.Thụt lề bốn dấu cách, không tab, trộn tab với dấu cách cho
TabError.Dòng tối đa 79 ký tự, dòng dài xuống dòng trong ngoặc tròn, toán tử đứng đầu dòng mới.
ruff formatsửa phần trình bày nhưng không đổi tên, không xóa import thừa.ruff checkbáo mã luật nhưF401.--fixsửa chỗ có[*], còn--select Nbật luật đặt tên.
Câu hỏi thường gặp
Có phải theo PEP 8 từng chữ một không?
Không bắt buộc. Chính PEP 8 nói đọc dễ quan trọng hơn theo đúng từng quy tắc, và mỗi dự án được chọn độ dài dòng hay kiểu chuỗi riêng. Quan trọng là cả dự án theo một kiểu. Để ruff format giữ kiểu đó thì không ai phải nhớ.
Ruff khác Black và Flake8 thế nào?
ruff format làm việc của Black (tự định dạng), ruff check làm việc của Flake8 cùng nhiều plugin (soát lỗi), trong một công cụ viết bằng Rust nên chạy nhanh. Dự án đang dùng Black hay Flake8 vẫn chạy tốt, dự án mới thì một công cụ ruff là đủ.
Cài ruff cho Python xong thì dùng trong VS Code thế nào?
Cài tiện ích Ruff trong VS Code rồi bật định dạng khi lưu file: mỗi lần lưu, code được sửa như khi chạy ruff format, và lỗi của ruff check hiện gạch chân ngay trong file. Tiện ích dùng ruff đã cài bằng pip hoặc bản có sẵn của nó.
Python code style cho tên có cần tiếng Anh không?
PEP 8 khuyên tên chỉ dùng chữ cái ASCII, nên tên tiếng Việt viết không dấu như tong_tien vẫn đúng chuẩn. Dự án có người nước ngoài cùng đọc thì đặt tên tiếng Anh, như bài đặt tên biến gợi ý.
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.