Chương trình học Bài 25 trên tổng số 250 · Hàm
Hàm

Docstring và gợi ý kiểu

Hai nét nhỏ biến một hàm chạy được thành một hàm chuyên nghiệp: một docstring và các gợi ý kiểu.

Một docstring là một chuỗi ký tự đặt ở dòng đầu tiên của thân hàm. Nó giải thích hàm làm gì. Các công cụ và help() đọc nó, và Python lưu nó trên function.__doc__:

def add(a, b):
    """Return the sum of a and b."""
    return a + b

print(add.__doc__)   # Return the sum of a and b.

Ba dấu nháy cho phép một docstring trải dài nhiều dòng, tiện cho các giải thích dài hơn.

Gợi ý kiểu (type hints) chú thích các tham số và giá trị trả về được mong đợi là kiểu gì. Bạn viết name: type cho mỗi tham số và -> type cho giá trị trả về:

def add(a: int, b: int) -> int:
    """Return the sum of a and b."""
    return a + b

Gợi ý kiểu không ép buộc gì khi chạy. Python sẽ không ngăn bạn truyền một chuỗi. Chúng là tài liệu mà trình soạn thảo và công cụ kiểm tra dùng để bắt lỗi sớm, và chúng làm cho chữ ký hàm tự giải thích. Các kiểu gợi ý thường gặp gồm int, float, str, và bool.

Từ đây trở đi, hãy viết hàm có cả hai: một docstring rõ ràng và các gợi ý kiểu trung thực.

Đến lượt bạn

Định nghĩa một hàm multiply với gợi ý kiểu def multiply(a: int, b: int) -> int: và một docstring (dòng đầu tiên của nó) ghi chính xác Return the product of a and b.. Thân hàm phải return a * b.

Bạn thấy vấn đề gì trong bài học này? Hãy báo cáo nó · Hỏi về bài học này

Bài tập này sẽ sớm mở.

Hoàn thành bài học trước đó để mở khóa bài này. Toàn bộ khóa học là miễn phí, không cần tài khoản, và bạn có thể đọc bài học này ngay bây giờ.