PEP8 best docstring practice when function has multiple different return

Question

I have the following function:

def eg_fun(eg:int):
    """example function
    """
   
    if eg > 2:
        return 2, 4
    else:
        return 'no', None

In the function definition how I can put different returning Tuple?

If I would have a single return type I writing: def eg_fun(eg:int) -> Tuple[int, int]:

But in this case I have two different return type, the first one is Tuple[int, int] while the second one is Tuple[str, None]

Paul Rudi · Accepted Answer · 2022-09-26T15:02:15.507

1

If you are running python 3.10 -> Tuple[int, int] | Tuple [str, None] should work

edited Sep 26 '22 at 15:02

answered Sep 26 '22 at 15:01

Paul Rudi

I'm using python 3.9 – Will Sep 26 '22 at 17:06
1

Then you should use `Union[Tuple[int, int], Tuple[str, None]]`. – Paul Rudi Sep 27 '22 at 07:03

1 Answers1