Python เขียนโค้ดตามมาตรฐาน PEP 8



PEP 8 เป็นเอกสารแนะนำสไตล์การเขียนโค้ด Python ที่ชุมชนยึดถือเป็นมาตรฐาน จุดประสงค์คือให้โค้ด Python จากคนละคนละที่อ่านแล้วรู้สึกคุ้นเหมือนกัน โค้ดถูกอ่านบ่อยกว่าถูกเขียน การเขียนให้อ่านง่ายจึงคุ้มค่า

การเยื้องบรรทัด (Indentation)

ใช้ 4 ช่องว่าง ต่อระดับ ไม่ใช้ Tab และห้ามผสม Tab กับ space

def calculate(x):
    if x > 0:
        return x * 2
    return 0

ความยาวบรรทัด

PEP 8 เดิมกำหนด 79 ตัวอักษร ปัจจุบันหลายทีมใช้ 88 (ค่าเริ่มต้นของ black) หรือ 100 เลือกสักค่าแล้วใช้ให้ทั้งโปรเจกต์เหมือนกัน

บรรทัดยาวตัดด้วยวงเล็บ

total = (first_value
         + second_value
         + third_value)

result = some_function(
    argument_one,
    argument_two,
    argument_three,
)

การเว้นวรรครอบตัวดำเนินการ

# ดี
x = 1
y = x + 2
if x == 1 and y > 0:
    ...

# ไม่ดี
x=1
y = x+2
if x==1 and y>0:
    ...

ไม่เว้นวรรครอบ = เมื่อเป็นค่า default ของพารามิเตอร์ (ที่ไม่มี type hint)

def greet(name, greeting="สวัสดี"):     # ไม่เว้น
    ...

def greet(name: str, greeting: str = "สวัสดี"):   # เว้น เมื่อมี type hint
    ...

การตั้งชื่อ

สิ่งที่ตั้งชื่อรูปแบบตัวอย่าง
ตัวแปร, ฟังก์ชันsnake_caseuser_name, calculate_total()
ค่าคงที่UPPER_CASEMAX_RETRIES, PI
คลาสPascalCaseBankAccount, HttpClient
ภายใน (ไม่เปิดใช้)นำหน้าด้วย __internal_cache
MAX_CONNECTIONS = 10

class OrderProcessor:
    def process_order(self, order_id):
        retry_count = 0
        ...

หลีกเลี่ยงชื่อตัวเดียวที่กำกวม (l, I, O) และชื่อที่ไม่สื่อความหมาย (data, temp, x — นอกจากในลูปสั้น ๆ)

บรรทัดว่าง

  • 2 บรรทัดว่างระหว่างฟังก์ชัน/คลาสระดับบนสุด
  • 1 บรรทัดว่างระหว่างเมท็อดในคลาส
  • ใช้บรรทัดว่างในฟังก์ชันเพื่อแยกกลุ่มตรรกะ (แต่อย่าเยอะเกิน)
def first_function():
    ...


def second_function():
    step_one()
    step_two()

    step_three()      # แยกกลุ่มด้วยบรรทัดว่าง

การจัด import

เรียงเป็น 3 กลุ่ม คั่นด้วยบรรทัดว่าง

# 1. standard library
import os
import sys
from datetime import datetime

# 2. third-party
import requests
import pandas as pd

# 3. โมดูลในโปรเจกต์ตัวเอง
from myapp.models import User
from myapp.utils import slugify

หนึ่ง import ต่อบรรทัด และเลี่ยง from module import *

เขียนเงื่อนไขให้อ่านง่าย

# ดี
if items:                    # ลิสต์ไม่ว่าง
    ...
if user is None:
    ...
if not found:
    ...

# ไม่ดี
if len(items) > 0:
    ...
if user == None:
    ...
if found == False:
    ...

(ตัวอย่างข้างบนเทียบเฉพาะรูปแบบเงื่อนไข ... แทนเนื้อโค้ดจริง) เทียบกับ None ใช้ is / is not เสมอ ไม่ใช่ ==

คอมเมนต์และ docstring

def calculate_discount(price, is_member):
    """คำนวณราคาหลังหักส่วนลด

    สมาชิกได้ส่วนลด 10%, ราคาตั้งแต่ 1000 บาทได้เพิ่มอีก 5%
    """
    discount = 0.10 if is_member else 0
    if price >= 1000:
        discount += 0.05          # ส่วนลดพิเศษสำหรับยอดสูง
    return price * (1 - discount)
  • docstring บอก “ทำอะไร” คอมเมนต์บอก “ทำไม” ไม่ใช่ “ทำอะไร” ที่โค้ดบอกอยู่แล้ว
  • คอมเมนต์ที่ล้าสมัยแย่กว่าไม่มีคอมเมนต์ อัปเดตให้ตรงกับโค้ดเสมอ

ปล่อยให้เครื่องมือจัดการ

ไม่ต้องจำ PEP 8 ทั้งหมด ใช้เครื่องมืออัตโนมัติ

คำสั่ง pip install, black, ruff ในหัวข้อนี้พิมพ์ใน เทอร์มินัล ไม่ใช่ใน Python shell

black — จัดฟอร์แมตให้อัตโนมัติ

pip install black
black myfile.py          # จัดไฟล์เดียว
black .                  # จัดทั้งโปรเจกต์

black มีความเห็นชัดเจน ไม่ต้องตั้งค่าอะไร รันแล้วโค้ดสวยตามมาตรฐานทันที

ruff — ตรวจและแก้ปัญหาสไตล์ (เร็วมาก)

pip install ruff
ruff check .            # ตรวจ
ruff check --fix .      # แก้ที่แก้ได้อัตโนมัติ
ruff format .           # จัดฟอร์แมต (แทน black ได้)

ruff เป็นเครื่องมือยุคใหม่ที่รวม linter หลายตัวไว้ในตัวเดียว เขียนด้วย Rust จึงเร็วมาก

ตั้งค่าใน pyproject.toml

[tool.ruff]
line-length = 88

[tool.ruff.lint]
select = ["E", "F", "I"]     # pycodestyle, pyflakes, isort

รันอัตโนมัติด้วย pre-commit

ตั้งให้ black/ruff รันทุกครั้งก่อน git commit ผ่านเครื่องมือ pre-commit โค้ดที่เข้า repo จะสไตล์ตรงกันเสมอ

เช็คความเข้าใจก่อนข้ามบท

  • อ่านโค้ดแล้วสังเกต indentation, ชื่อ, การเว้นวรรค และลำดับ import ได้
  • ใช้ formatter/linter เพื่อช่วยรักษาสไตล์แทนการจำทุกข้อเอง
  • ลองปรับโค้ดเก่าหนึ่งไฟล์ให้ชื่อฟังก์ชันและตัวแปรอ่านเป็นมาตรฐานขึ้น

สรุป

  • 4 ช่องว่างต่อระดับ, snake_case สำหรับฟังก์ชัน/ตัวแปร, PascalCase สำหรับคลาส
  • เทียบ None ด้วย is, เช็คลิสต์ว่างด้วย if items:
  • จัด import เป็น 3 กลุ่ม: standard / third-party / โปรเจกต์
  • ใช้ black และ ruff จัดการสไตล์อัตโนมัติ ไม่ต้องจำกฎเอง

บทถัดไปกลับไปเจาะ f-string ขั้นสูงและการจัดรูปแบบตัวเลข