Docstrings quando non viene restituito nulla

Question

Che cos'è la convenzione docstring quando una funzione non restituisce nulla?

Ad esempio:

def f(x): 
    """Prints the element given as input 

    Args: 
     x: any element 
    Returns: 
    """ 
    print "your input is %s" % x 
    return 

Cosa devo aggiungere dopo Returns: nella docstring? Niente come è adesso?

Answer 1

Si dovrebbe usare None, come questo è ciò che la vostra funzione in realtà restituisce:

"""Prints the element given as input 

Args: 
    x: any element 
Returns: 
    None 
""" 

Tutte le funzioni in Python restituiscono qualcosa. Se non restituisci esplicitamente un valore, restituirà None per impostazione predefinita:

>>> def func(): 
...  return 
... 
>>> print func() 
None 
>>>