How to know function return type and argument types?

👻 Check our latest review to choose the best laptop for Machine Learning engineers and Deep learning tasks!

While I am aware of the duck-typing concept of Python, I sometimes struggle with the type of arguments of functions, or the type of the return value of the function.

Now, if I wrote the function myself, I DO know the types. But what if somebody wants to use and call my functions, how is he/she expected to know the types? I usually put type information in the function"s docstring (like: "...the id argument should be an integer..." and "... the function will return a (string, [integer]) tuple.")

But is looking up the information in the docstring (and putting it there, as a coder) really the way it is supposed to be done?

Edit: While the majority of answers seem to direct towards "yes, document!" I feel this is not always very easy for "complex" types.
For example: how to describe concisely in a docstring that a function returns a list of tuples, with each tuple of the form (node_id, node_name, uptime_minutes) and that the elements are respectively a string, string and integer?
The docstring PEP documentation doesn"t give any guidelines on that.
I guess the counterargument will be that in that case classes should be used, but I find python very flexible because it allows passing around these things using lists and tuples, i.e. without classes.

👻 Read also: what is the best laptop for engineering students?

How to know function return type and argument types? __del__: Questions

import time
time.sleep(5)   # Delays for 5 seconds. You can also use a float value.

import time
while True:
    print("This prints once a minute.")
    time.sleep(60) # Delay for 1 minute (60 seconds).

from time import sleep
sleep(0.1) # Time in seconds

How to know function return type and argument types? __del__: Questions

We hope this article has helped you to resolve the problem. Apart from How to know function return type and argument types?, check other __del__-related topics.

Want to excel in Python? See our review of the best Python online courses 2023. If you are interested in Data Science, check also how to learn programming in R.

By the way, this material is also available in other languages:

• Italiano How to know function return type and argument types?
• Deutsch How to know function return type and argument types?
• Français How to know function return type and argument types?
• Español How to know function return type and argument types?
• Türk How to know function return type and argument types?
• Русский How to know function return type and argument types?
• Português How to know function return type and argument types?
• Polski How to know function return type and argument types?
• Nederlandse How to know function return type and argument types?
• 中文 How to know function return type and argument types?
• 한국어 How to know function return type and argument types?
• 日本語 How to know function return type and argument types?
• हिन्दी How to know function return type and argument types?