Chú thích hàm là một số biểu thức ngẫu nhiên được viết bằng hàm và chúng được đánh giá tại thời điểm biên dịch. Chúng không tồn tại trong thời gian chạy và không có ý nghĩa gì đối với python. Chúng được sử dụng và giải thích bởi bên thứ ba hoặc thư viện python bên ngoài
Như chúng ta đã biết, các chú thích hàm được sử dụng bởi các thư viện bên thứ ba vì các thư viện khác nhau có những lợi ích khác nhau từ các chú thích hàm này. Ví dụ
- Chú thích hàm với chuỗi có thể được sử dụng làm thông báo tại thời điểm biên dịch để mô tả chức năng của các phương thức, lớp và biến khác nhau
- [def fxn[a. "int", b. "phao"=5. 0] -> "int"]
Trong ví dụ trên, các chú thích này có thể được sử dụng để xác định kiểu dữ liệu của các tham số vì python hỗ trợ kiểm tra kiểu động và không có cách nào để kiểm tra kiểu trả về hoặc kiểu dữ liệu. Các thư viện như mypy sử dụng các loại chú thích này
Cú pháp chú thích hàm
Chú thích chức năng có thể được viết theo nhiều cách trong một chức năng như sau
1. Chú thích chức năng cho các tham số đơn giản
Bằng cách này, chúng ta có thể sử dụng dấu hai chấm sau tên đối số và sau đó chúng ta có thể viết biểu thức sau dấu hai chấm. Biểu thức có thể là bất kỳ thứ gì giống như bất kỳ kiểu dữ liệu nào của đối số hoặc bất kỳ chuỗi nào chứa bất kỳ thông báo nào
Ví dụ
2. Chú thích chức năng cho các tham số dư thừa
Nếu chúng ta muốn số lượng đối số tùy ý làm tham số hàm có cùng biểu thức thì chúng ta có thể sử dụng cách chú thích hàm này
Ví dụ
3. Chú thích chức năng cho các tham số lồng nhau
Nếu chúng ta muốn chuyển danh sách trong lệnh gọi hàm dưới dạng đối số, thì chúng ta phải áp dụng riêng các chú thích hàm trên các phần tử riêng lẻ
Ví dụ
4. Chú thích hàm cho kiểu trả về
Chú thích của kiểu trả về được thực hiện bởi toán tử '->'
Ví dụ
Chúng ta có thể hiểu các chú thích hàm trong Python bằng ví dụ sau
Ví dụ
đầu ra
Giải trình
Trong đoạn mã trên, chúng ta có hàm được sử dụng để tính n số Fibonacci bắt đầu. Nó lấy n và một danh sách trống làm đối số và trả về danh sách chứa câu trả lời
Trong phần mô tả hàm, chúng ta đã định nghĩa rằng n sẽ có kiểu số nguyên và biến res sẽ có kiểu danh sách. Với chú thích hàm, chúng tôi cũng đã xác định rằng kiểu trả về sẽ là một danh sách
Ghi chú. chúng ta có thể truy cập tất cả các chú thích hàm mà chúng ta đã sử dụng trong hàm bằng nhiều phương pháp khác nhau
1. Sử dụng '__annotations__'
Thuộc tính __annotations__ được sử dụng để lấy tất cả các chú thích trong một hàm. Nó trả về từ điển chứa các cặp khóa và giá trị trong đó khóa sẽ là đối số và giá trị sẽ là biểu thức riêng lẻ của chúng
ví dụ 2
đầu ra
Giải trình
Trong đoạn mã trên, chúng ta đã sử dụng các chú thích hàm trong hàm trả về danh sách n số Fibonacci bắt đầu
Ngoài ra, chúng tôi đã in chú thích hàm bằng thuộc tính '__annotations__' và chúng tôi nhận được kết quả ở dạng từ điển
2. Sử dụng mô-đun python tiêu chuẩn
Trong Python, có một mô-đun tiêu chuẩn có tên là pydoc có thể được sử dụng để lấy các chú thích hàm
pydoc. hàm help[] cung cấp một môi trường shell nơi chúng ta có thể lấy bất kỳ thông tin nào liên quan đến bất kỳ tệp nào và chúng ta cũng có thể dễ dàng nhận được các chú thích của bất kỳ hàm nào
3. Sử dụng mô-đun kiểm tra
Trong python, chúng tôi có một mô-đun tiêu chuẩn khác có tên là kiểm tra. Mô-đun này cung cấp thông tin về bất kỳ tệp, mô-đun, lớp hoặc đối tượng nào
Nó có rất nhiều chức năng để lấy thông tin. Kiểm tra chức năng getfullargspec của mô-đun sẽ được sử dụng để lấy chi tiết chú thích chức năng và tất cả thông tin khác
ví dụ 3
đầu ra
Giải trình
Trong đoạn mã trên, chúng tôi đã sử dụng hàm getfullargspec và chúng tôi có đầy đủ thông tin chi tiết về hàm, bao gồm cả chú thích hàm
Các kiểu dữ liệu của biến, tham số hàm và kiểu trả về của hàm được mô tả thông qua các chú thích là các cụm từ Python tùy ý
Để cung cấp các tính năng hiệu quả và tiết kiệm thời gian như gợi ý cú pháp, gợi ý kiểu dữ liệu trong IDE, kiểm tra kiểu dữ liệu, tạo tài liệu do rô bốt hoặc AI điều khiển và tự động hoàn thành mã, các chú thích cố gắng làm cho mã nguồn dễ truy cập hơn và
Chú thích hàm và biến là hai loại chú thích có sẵn trong Python. Với việc sử dụng các ví dụ thích hợp, chúng ta sẽ thảo luận về cả hai dạng chú thích Python trong bài đăng này
Chú thích biến là gì?
Python sử dụng các biểu thức được gọi là chú thích biến để mô tả các kiểu dữ liệu của biến sâu hơn. Cú pháp cho các chú thích biến được đưa ra trong phần sau
Ví dụ 1.
Các biểu thức cho chú thích được bắt đầu bằng dấu hai chấm “hoặc. ” và được đặt giữa tên biến và giá trị ban đầu. Để hiểu rõ hơn về khái niệm này, hãy tham khảo mã Python sau. Chúng tôi đã sử dụng các kiểu dữ liệu Python tích hợp cho các biểu thức trong ví dụ sau. Hình ảnh đính kèm minh họa mã mẫu tổng thể.
Đây là kết quả được tạo bởi mã trước đó được hiển thị
Chuỗi cũng có thể được sử dụng để mô tả các biến tại chỗ. Điều này được hiển thị trong mã như bạn có thể thấy trong phần sau
Kèm theo là đầu ra
Để truy cập mọi chú thích, hãy sử dụng thuộc tính “__annotations___”. Thuộc tính này là một từ điển với các biến là khóa và biểu thức chú thích là giá trị. Các chức năng không được bao phủ bởi thuộc tính này. Nó chỉ cung cấp thông tin về các biến. Đối với điều này, hãy xem mã Python sau
Kết quả của việc sử dụng “_annotations_” trong mã Python được thấy trong phần sau
Cho đến nay chúng ta chỉ nói về các kiểu dữ liệu đơn giản, bao gồm int, float và str. Bây giờ chúng ta hãy xem cách tạo các biểu thức chú thích cho các kiểu dữ liệu phức tạp hơn như danh sách, bộ dữ liệu, tập hợp, danh sách đối tượng, v.v. Chúng tôi sẽ sử dụng mô-đun loại cho việc này
Thư viện chuẩn của Python bao gồm mô-đun kiểu. Với sự trợ giúp của một ví dụ, hãy tìm hiểu cách áp dụng nó cho các kiểu dữ liệu phức tạp. Đối với điều này, hãy xem mã Python sau
Sau đây là kết quả
Các dạng chung của danh sách, bộ và tập hợp được đại diện bởi các lớp Danh sách, Tuple và Tập hợp trong mô-đun kiểu. Các lớp chung khác tồn tại ngoài ba lớp này bao gồm Dict, FrozenSet, DefaultDict và OrderedDict
Bạn có thể sử dụng các lớp chung này để cung cấp cho các biến các biểu thức chú thích. Theo sau các lớp là các con trỏ trong ngoặc vuông [] tới các lớp chung khác, mô tả chuỗi, kiểu dữ liệu nguyên thủy hoặc các lớp từ cùng một mô-đun
Phần tiếp theo của bài viết này sẽ thảo luận về cách sử dụng chúng để lập biểu thức hàm
Chú thích chức năng là gì?
Trong PEP-3107, các chú thích chức năng được phác thảo. Mục tiêu chính là thiết lập một phương thức thống nhất để kết nối thông tin với các đối số của hàm và trả về các giá trị. Nhiều thành viên của cộng đồng đã phát hiện ra các trường hợp sử dụng sáng tạo, mặc dù họ đã sử dụng các kỹ thuật khác nhau bao gồm việc bổ sung các tính năng độc đáo cho đối tượng chức năng và tạo các trình trang trí tùy chỉnh và định dạng chuỗi tài liệu
Điều quan trọng là phải nhận ra rằng Python không cung cấp bất kỳ ngữ nghĩa nào cho các chú thích. Nó chỉ cung cấp hỗ trợ cú pháp tuyệt vời để gắn thẻ siêu dữ liệu và một cách đơn giản để truy cập nó. Chú thích cũng hoàn toàn tùy chọn
Ví dụ 2.
Hãy xem một ví dụ. Đây là một hàm gọi là func[] in tổng của ba đầu vào – một, hai và ba. Đáng chú ý, func[] không trả lại bất cứ thứ gì. Một, đối số đầu tiên, không được chú thích. Loại số nguyên được chú thích cho tham số thứ ba, “ba” trong khi chuỗi “chú thích hai” được chú thích cho đầu vào thứ hai, “hai. ” Kiểu float được chỉ định bên cạnh giá trị trả về. Lưu ý cú pháp “->” [được đưa ra bên dưới] khi chú thích giá trị trả về. Hình ảnh đính kèm minh họa mã mẫu tổng thể.
Việc thực thi chức năng không bị ảnh hưởng bởi các chú thích. Hãy sử dụng các đối số int và string tương ứng khi sử dụng hàm func[] hai lần. Trong cả hai lần, func[] thực hiện hành động thích hợp và bỏ qua các chú thích
Hình ảnh đính kèm minh họa mã mẫu tổng thể
Đây là kết quả của việc áp dụng cả hai chức năng
Ví dụ 3.
Để được hỗ trợ, đây là một chương trình ví dụ khác. Hàm create_user[] chấp nhận ba giá trị – tên, tuổi và sở thích – và tạo từ điển hoặc chính tả, như có thể thấy trong hình ảnh sau. Hàm tạo người dùng [] lấy danh sách các bộ dữ liệu xác định danh sách người dùng. Cách tiếp cận này mang lại một danh sách các từ điển.
Biến kiểu dict u1 lưu kết quả của lệnh gọi phương thức tới phương thức tạo user[]
Ngoài ra, biến loại List[dict] người dùng giữ kết quả của lệnh gọi hàm đối với phương thức tạo người dùng[]. Hình ảnh đính kèm minh họa mã mẫu tổng thể
Tất cả tên, tuổi và sở thích của người dùng được hiển thị ở đây
Chỉ thông tin về các biến được cung cấp bởi thuộc tính “__annotations__”. Chúng ta có thể sử dụng thuộc tính “__annotations__” để truy xuất thông tin chú thích về các chức năng. Bạn có thể hiểu khái niệm này với đoạn mã sau. Hình ảnh đính kèm minh họa mã mẫu tổng thể
Tất cả các thông tin chú thích được bao gồm trong từ điển đầu ra. Hãy nhớ rằng khóa của từ điển cho kiểu trả về là “return”. Chìa khóa của tham số là tên tham số
Phần kết luận
Python là một ngôn ngữ lập trình mạnh mẽ với kiểu gõ động. Nó được hỗ trợ bởi một loạt các thư viện và chức năng và có một cú pháp đơn giản tương tự như viết tiếng Anh đơn giản. Chú thích là một trong những tùy chọn này. Mục đích của chú thích là làm cho mã nguồn dễ đọc hơn và dễ hiểu hơn. Chú thích hàm và biến là hai loại chú thích chính được sử dụng trong Python. Chúng tôi đã đề cập đến cả hai dạng chú thích Python trong bài viết này với sự trợ giúp của các ví dụ có liên quan