Làm thế nào để biết kiểu trả về của hàm và các kiểu đối số?

Trong khi tôi biết về khái niệm gõ vịt của Python, đôi khi tôi gặp khó khăn với loại đối số của các hàm hoặc loại giá trị trả về của hàm.

Bây giờ, nếu tôi tự viết hàm, tôi biết các kiểu. Nhưng điều gì sẽ xảy ra nếu ai đó muốn sử dụng và gọi các hàm của tôi, làm thế nào mà anh ấy / cô ấy dự kiến ​​biết các loại? Tôi thường đặt thông tin kiểu trong chuỗi docstring của hàm (như: "...the id argument should be an integer..."và "... the function will return a (string, [integer]) tuple.")

Nhưng việc tra cứu thông tin trong docstring (và đặt nó ở đó, với tư cách là một người viết mã) có thực sự là cách mà nó được cho là được thực hiện?

Chỉnh sửa: Trong khi phần lớn các câu trả lời dường như hướng đến "vâng, tài liệu!" Tôi cảm thấy điều này không phải lúc nào cũng dễ dàng đối với những loại 'phức tạp'.
Ví dụ: làm thế nào để mô tả ngắn gọn trong docstring rằng một hàm trả về danh sách các bộ giá trị, với mỗi bộ giá trị có dạng (node_id, node_name, uptime_minutes) và các phần tử tương ứng là một chuỗi, chuỗi và số nguyên?
Tài liệu docstring PEP không đưa ra bất kỳ hướng dẫn nào về điều đó.
Tôi đoán đối số sẽ là trong trường hợp đó các lớp nên được sử dụng, nhưng tôi thấy python rất linh hoạt vì nó cho phép truyền những thứ này bằng cách sử dụng danh sách và bộ giá trị, tức là không có lớp.

Mọi thứ đã thay đổi một chút kể từ năm 2011! Bây giờ có các gợi ý kiểu trong Python 3.5 mà bạn có thể sử dụng để chú thích các đối số và trả về kiểu hàm của bạn. Ví dụ điều này:

def greeting(name):
  return 'Hello, {}'.format(name)

bây giờ có thể được viết như sau:

def greeting(name: str) -> str:
  return 'Hello, {}'.format(name)

Như bây giờ bạn có thể thấy các loại, có một số loại kiểm tra loại tĩnh tùy chọn sẽ giúp bạn và người kiểm tra loại của bạn điều tra mã của bạn.

để biết thêm giải thích, tôi khuyên bạn nên xem bài đăng trên blog về gợi ý loại trong blog PyCharm .

Đây là cách hoạt động của các ngôn ngữ động. Tuy nhiên, không phải lúc nào cũng là điều tốt, đặc biệt là nếu tài liệu kém - có ai đã cố gắng sử dụng một framework python được tài liệu kém không? Đôi khi bạn phải quay lại đọc nguồn.

Dưới đây là một số chiến lược để tránh sự cố khi gõ vịt:

• tạo ngôn ngữ cho miền vấn đề của bạn
• điều này sẽ giúp bạn đặt tên đúng
• sử dụng các loại để thể hiện các khái niệm trong ngôn ngữ miền của bạn
• tham số chức năng tên bằng cách sử dụng từ vựng ngôn ngữ miền

Ngoài ra, một trong những điểm quan trọng nhất:

• giữ dữ liệu cục bộ nhất có thể!

Chỉ nên có một số loại được xác định rõ ràng và được ghi chép lại. Bất kỳ điều gì khác nên rõ ràng bằng cách xem mã: Đừng có các loại tham số kỳ lạ đến từ xa mà bạn không thể tìm ra bằng cách xem xét vùng lân cận của mã ...

Có liên quan, (và cả liên quan đến docstrings), có một kỹ thuật trong python được gọi là doctests. Sử dụng tài liệu đó để ghi lại cách các phương pháp của bạn dự kiến ​​sẽ được sử dụng - và đồng thời có phạm vi kiểm tra đơn vị tốt!

Có, bạn nên sử dụng docstrings để làm cho các lớp và hàm của bạn thân thiện hơn với các lập trình viên khác:

Thêm: http://www.python.org/dev/peps/pep-0257/#what-is-a-docstring

Một số trình chỉnh sửa cho phép bạn xem docstrings trong khi nhập, vì vậy nó thực sự giúp công việc dễ dàng hơn.

Tôi đã tham dự một khóa học về khóa học, trong đó có bài học, chúng tôi được dạy về công thức thiết kế.

Dưới định dạng docstring tôi thấy preety hữu ích.

vùng xác định (cơ sở, chiều cao):
    '' '(number, number) -> number # ** TypeContract **
    Trả về diện tích của một đường gấp khúc với cơ sở kích thước # ** Mô tả **
    và chiều cao

    >>> area (10,5) # ** Ví dụ **
    25.0
    >> khu vực (2,5,3)
    3,75
    ''
    return (cơ sở * chiều cao) / 2 

Tôi nghĩ nếu docstrings được viết theo cách này, nó có thể giúp ích rất nhiều cho các nhà phát triển.

Liên kết tới video [Hãy xem video] : https://www.youtube.com/watch?v=QAPg6Vb_LgI

Vâng, đúng vậy.

Trong Python, một hàm không phải lúc nào cũng phải trả về một biến cùng kiểu (mặc dù mã của bạn sẽ dễ đọc hơn nếu các hàm của bạn luôn trả về cùng một kiểu). Điều đó có nghĩa là bạn không thể chỉ định một kiểu trả về duy nhất cho hàm.

Theo cách tương tự, các tham số không phải lúc nào cũng phải cùng loại.

Ví dụ: làm thế nào để mô tả ngắn gọn trong docstring rằng một hàm trả về danh sách các bộ giá trị, với mỗi bộ giá trị có dạng (node_id, node_name, uptime_minutes) và các phần tử tương ứng là một chuỗi, chuỗi và số nguyên?

Ừm ... Không có mô tả "ngắn gọn" nào về điều này. Nó phức tạp. Bạn đã thiết kế nó phức tạp. Và nó yêu cầu tài liệu phức tạp trong docstring.

Xin lỗi, nhưng phức tạp là - tốt - phức tạp.

Có, vì nó là một ngôn ngữ nhập động;)

Đọc cái này để tham khảo: PEP 257

Docstrings (và tài liệu nói chung). Python 3 giới thiệu các chú thích hàm (tùy chọn), như được mô tả trong PEP 3107 (nhưng đừng bỏ qua docstrings)