What are the differences between type hints and docstrings in Python?

What are the differences between type hints and docstrings in Python?

Type hints are used to indicate the expected data types of function arguments and return values, while docstrings provide documentation about the function's purpose and usage.

Can you give me an example of both?

Sure! Here's a simple example:

def add(a: int, b: int) -> int:
    """Adds two integers and returns the result."""
    return a + b

In this case, a and b are type hints, and the text inside triple quotes is the docstring.

When should I use type hints?

You should use type hints when you want to improve code readability, enable better static type checking, and help IDEs provide better support.

Are there any downsides to using type hints?

One downside is that they can make the code more verbose. Additionally, they are optional, so not using them might lead to inconsistencies in code style.