Sớm hay muộn, bạn sẽ đọc một hàm như def handler(*args, **kwargs) và tự hỏi nó chấp nhận điều gì. Python *args và **kwargs cho phép một hàm nhận số lượng đối số linh hoạt. Chúng cung cấp năng lượng cho các trình trang trí, trình bao bọc và nhiều API thư viện.

Hướng dẫn này trình bày cách chúng hoạt động theo cả hai hướng, cùng với những cách mới hơn mà Python cho phép bạn kiểm soát cách gọi một hàm. Chúng tôi đã chạy từng ví dụ trên Python 3.13 và kết quả hiển thị là từ lần chạy đó.

*args làm gì

Một tham số được viết bằng một dấu sao sẽ thu thập bất kỳ đối số vị trí bổ sung nào vào một bộ dữ liệu:

def total(*args):
    print(type(args).__name__, args)
    return sum(args)

print(total(1, 2, 3))
# tuple (1, 2, 3)
# 6

print(total())
# tuple ()
# 0

Không có đối số, bạn chỉ cần lấy một bộ dữ liệu trống để hàm vẫn hoạt động. Tên args là một quy ước. *numbers sẽ hoạt động giống nhau và tên mang tính mô tả nhiều hơn thường sẽ tốt hơn.

**kwargs làm gì

Hai ngôi sao thu thập bất kỳ đối số từ khóa bổ sung nào vào từ điển:

def describe(**kwargs):
    print(type(kwargs).__name__, kwargs)

describe(name="Asha", city="Pune")
# dict {'name': 'Asha', 'city': 'Pune'}

Bởi vì nó là một từ điển bình thường nên bạn có thể lặp lại nó, tra cứu các khóa bằng get() và chuyển nó đi. Các khóa giữ nguyên thứ tự mà chúng được chuyển.

Thứ tự tham số

Khi bạn kết hợp các loại tham số, Python yêu cầu một thứ tự cụ thể:

1. Thông số vị trí thông thường
2. *args
3. Thông số chỉ từ khóa
4. **kwargs

def order(item, qty=1, *extras, priority=False, **notes):
    print(item, qty, extras, priority, notes)

order("pen")
# pen 1 () False {}

order("pen", 2, "gift wrap", "card", priority=True, note="leave at door")
# pen 2 ('gift wrap', 'card') True {'note': 'leave at door'}

Thông báo priority. Bởi vì nó xuất hiện sau *extras nên nó chỉ có thể được đặt theo tên, do đó, một đối số vị trí sai lệch không bao giờ có thể vô tình đặt nó. Không được phép đặt **kwargs sớm hơn và thử nghiệm của chúng tôi đã đưa ra SyntaxError: ​​”đối số không thể tuân theo đối số từ khóa var”.

Giải nén khi gọi

Các ngôi sao tương tự hoạt động ngược lại tại vị trí cuộc gọi. Một ngôi sao trải một danh sách hoặc bộ dữ liệu thành các đối số vị trí và hai ngôi sao trải một từ điển thành các đối số từ khóa:

nums = [4, 5, 6]
total(*nums)            # same as total(4, 5, 6) -> 15

settings = {"name": "Ben", "city": "Delhi"}
describe(**settings)    # same as describe(name="Ben", city="Delhi")

Việc giải nén hoạt động với mọi chức năng, không chỉ những chức năng sử dụng *args và **kwargs. Điều đó rất hữu ích khi cấu hình xuất hiện dưới dạng từ điển:

def connect(host, port, timeout=5):
    return f"{host}:{port} (timeout {timeout})"

connect(**{"host": "db.local", "port": 5432})
# 'db.local:5432 (timeout 5)'

connect(**{"host": "db.local", "port": 5432, "ssl": True})
# TypeError: connect() got an unexpected keyword argument 'ssl'

Lỗi đó rất hữu ích. Hàm không có **kwargs sẽ từ chối các tùy chọn không xác định, do đó lỗi đánh máy trong tên cài đặt sẽ không thành công thay vì bị âm thầm bỏ qua.

Đối số chỉ từ khóa

Ký tự trống * trong chữ ký, không có tên, có nghĩa là “mọi thứ sau này phải được chuyển bằng từ khóa”:

def make_user(name, *, admin=False):
    return name, admin

make_user("Asha", admin=True)
# ('Asha', True)

make_user("Asha", True)
# TypeError: make_user() takes 1 positional argument but 2 were given

Đây là một cách tuyệt vời để bảo vệ cờ boolean. Cách gọi như make_user("Asha", True) buộc người đọc phải đoán True nghĩa là gì. Yêu cầu admin=True làm cho mọi cuộc gọi đều tự giải thích.

Đối số chỉ có vị trí

Kể từ Python 3.8, / đánh dấu các tham số chỉ có thể được truyền theo vị trí:

def area(width, height, /):
    return width * height

area(3, 4)                 # 12
area(width=3, height=4)
# TypeError: area() got some positional-only arguments
#   passed as keyword arguments: 'width, height'

Điều này cho phép thư viện đổi tên các tham số đó sau này mà không vi phạm mã của bất kỳ ai, vì không ai có thể phụ thuộc vào tên. Một số phần mềm tích hợp hoạt động theo cách này. Ví dụ: len(obj=[1]) không hoạt động.

Đồ trang trí và giấy gói

Đây là lý do chính trong thế giới thực để sử dụng cả hai cùng nhau. Một trình bao bọc thường cần chấp nhận bất kỳ đối số nào mà hàm ban đầu nhận và chuyển chúng không thay đổi:

import functools, time

def timed(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        start = time.perf_counter()
        result = func(*args, **kwargs)
        print(f"{func.__name__} took {time.perf_counter() - start:.4f}s")
        return result
    return wrapper

@timed
def slow_add(a, b, delay=0.01):
    time.sleep(delay)
    return a + b

print(slow_add(2, 3, delay=0.02))
# slow_add took 0.0205s
# 5

Trình bao bọc hoàn toàn không cần biết các tham số của slow_add, vì vậy nó hoạt động với mọi chức năng. Con số thời gian của bạn sẽ khác một chút. Hướng dẫn của chúng tôi về Trình trang trí Python giải thích functools.wraps và các chi tiết khác.

Tùy chọn hợp nhất

** cũng hoạt động bên trong từ điển, cung cấp một cách gọn gàng để áp dụng các phần ghi đè lên trên các giá trị mặc định:

defaults = {"theme": "light", "lang": "en"}

def build(**overrides):
    return {**defaults, **overrides}

build(theme="dark")
# {'theme': 'dark', 'lang': 'en'}

Phím sau sẽ thắng nên ghi đè thay thế mặc định. Các lớp con cũng sử dụng mẫu này, như trong super().__init__(*args, **kwargs), để chuyển các đối số bổ sung cho lớp cha. Xem Các lớp và đối tượng Python để biết thêm về super().

Bảng cheat

Khi nào nên tránh chúng

Tính linh hoạt có giá của nó. Hàm được xác định là def create(**kwargs) không cho người đọc biết gì về những tùy chọn tồn tại và người chỉnh sửa không thể tự động hoàn thành chúng. Lỗi chính tả có thể diễn ra âm thầm qua nhiều lớp trước khi có bất kỳ lỗi nào xảy ra.

Vì vậy, hãy ưu tiên các tham số rõ ràng khi bạn biết hàm cần gì. Sử dụng *args và **kwargs khi bạn thực sự cần sự linh hoạt: trình bao bọc, trình trang trí, chuyển tiếp đối số sang hàm khác hoặc đầu vào có độ dài thay đổi thực sự như total(*numbers). Nếu một hàm cần nhiều tùy chọn được đặt tên thì dataclass cũng có thể rõ ràng hơn.

Những lỗi thường gặp

Sử dụng giá trị mặc định có thể thay đổi

Đây không phải là về các ngôi sao mà nó thường xuất hiện gần chúng. Giá trị mặc định được tạo một lần khi hàm được xác định và sau đó được chia sẻ giữa các lệnh gọi:

def bad(items=[]):
    items.append(1)
    return items

print(bad(), bad())
# [1, 1] [1, 1]

Cả hai cuộc gọi đều trả về cùng một danh sách, lúc đó chứa hai mục. Sử dụng items=None và tạo một danh sách mới bên trong hàm.

Các lỗi khác

• Quên giải nén. Gọi total(nums) sẽ chuyển qua một danh sách thay vì ba số. Viết total(*nums).
• Nuốt lỗi chính tả. Một hàm chấp nhận **kwargs nhưng bỏ qua các phím không xác định sẽ ẩn các tùy chọn sai chính tả. Xác thực chúng hoặc tránh **kwargs.
• Truyền cùng một đối số hai lần. f(1, **{"a": 2}), trong đó a là tham số đầu tiên, sẽ gây ra lỗi “nhiều giá trị”.
• Không chuyển tiếp trong trình bao bọc. Việc gọi func(args, kwargs) truyền một bộ dữ liệu và một lệnh. Dạng đúng là func(*args, **kwargs).

Nhập gợi ý cho *args và **kwargs

Gợi ý nhập vào *args và **kwargs mô tả từng giá trị riêng lẻ chứ không phải toàn bộ bộ sưu tập. Điều này khiến nhiều người ngạc nhiên:

def total(*prices: float) -> float:
    return sum(prices)      # prices is tuple[float, ...]

def tag(**attrs: str) -> str:
    return " ".join(f'{k}="{v}"' for k, v in attrs.items())   # dict[str, str]

total(1.5, 2.5)                  # 4.0
tag(id="x", role="button")       # id="x" role="button"

Ở đây prices được coi là một bộ số float và attrs là một từ điển của các chuỗi. Khi đối số từ khóa có các loại khác nhau, Python 3.12 đã thêm một tùy chọn chính xác: TypedDict kết hợp với Unpack.

from typing import TypedDict, Unpack

class Options(TypedDict, total=False):
    timeout: float
    retries: int

def fetch(url: str, **opts: Unpack[Options]) -> None: ...

Sau đó, trình kiểm tra loại như mypy hoặc Pyright có thể từ chối fetch(url, retries="3") hoặc tên tùy chọn sai chính tả, điều mà **kwargs đơn giản không bao giờ có thể làm được. Tuy nhiên, hành vi thời gian chạy không thay đổi. Khi chúng tôi chạy fetch("u", retries="3") trong Python 3.13, nó đã thực thi mà không có khiếu nại nào, vì bản thân Python không thực thi các gợi ý loại.

Nếu bạn thấy mình đang ghi lại một danh sách dài các khóa được chấp nhận cho **kwargs, hãy cân nhắc việc thay thế chúng bằng các tham số chỉ có từ khóa rõ ràng. Sau đó, người chỉnh sửa có thể tự động hoàn thành chúng và các lỗi sẽ được phát hiện ngay lập tức.

Lời kết

Hãy nhớ hai hướng. Theo một định nghĩa, các ngôi sao tập hợp lại. Trong một cuộc gọi, họ giải nén. Thêm đối số chỉ từ khóa để làm cho cuộc gọi rõ ràng hơn và dành **kwargs cho mã chuyển tiếp đối số thực sự. Để thực hành, hãy viết một trình trang trí nhỏ ghi lại mọi đối số của cuộc gọi và sử dụng nó trên một số chức năng khác nhau.

Câu hỏi thường gặp

Tiếp tục học hỏi