Is it ok to skip "return None"?

Question:

I wonder if it is bad manner to skip return None, when it is not needed.

Example:

def foo1(x):
    if [some condition]:
        return Baz(x)
    else:
        return None

def foo2(x):
    if [some condition]:
        return Baz(x)

bar1 = foo1(x)
bar2 = foo2(x)

In both cases, when condition is false, function will return with None.

Asked By: Tomasz Wysocki

||

Answers:

Yes and No.

In the simplest case, it is ok to skip “return None” because it returns None in only single negative condition.

But if there are nested condition evaluation and multiple scenarios where a function could return None. I tend to include them as visual documentation of the scenarios.

[Editing: Based on comment below]

return or return None

I prefer “return None” to bare “return” as It is explicit and later, no one will be in doubt if the return meant returning None or was it an error as something was missing.

Answered By: pyfunc

Yes, if you do not return any value from a Python function, it returns None. So, whether to explicitly return None is a stylistic decision.

Personally, I prefer to always return a value for clarity.

Answered By: JAL

Like you said, return None is (almost) never needed.

But you should consider that the intention of your code is much clearer with an explicit return None. Remember: a piece of code also needs to be readable by human-beings, and being explicit usually helps.

Answered By: rsenna

To expound on what others have said, I use a return None if the function is supposed to return a value. In Python, all functions return a value, but often we write functions that only ever return None, because their return value is ignored. In some languages, these would be called procedures.

So if a function is supposed to return a value, then I make sure all code paths have a return, and that the return has a value, even if it is None.

If a function “doesn’t” return a value, that is, if it is never called by someone using its return value, then it’s ok to end without a return, and if I need to return early, I use the bare form, return.

Answered By: Ned Batchelder
def foo1(x):
    try:
        return Baz(x)
    except:
        raise ValueError('Incorrect value fo Bac')

or

def foo3(x):
    return Baz(x) if <condition> else False

I do not believe in half defined function, but this False can be usefull in search type failure pruning.

Answered By: Tony Veijalainen

The more I think about it, the less I think the case you describe shows good practice. It forces the client to discriminate, so client code would almost always look like:

b = foo1(123)
if b is not None:
    ...

You couldn’t even write:

if b:
    ...

since, if Baz.__nonzero__ is overwritten, b could evaluate to False, even if it’s not None. It would be better to have a Null-Baz instance (AKA Null Object), e.g.:

class Baz(object):
    def some_method(self):
        """some action:"""
        ...
    ...

class BazNull(Baz):
    def some_method(self):
        """nothing happens here"""
    ...

Baz.Null = BazNull()

...

def foo1(x):
    if some_condition:
        return Baz(x)
    else:
        return Baz.Null

...

b = foo1(123)
b.some_method()

The point is: help the client (who might be yourself!) to keep Cyclomatic Complexity low. The fewer branches, the better.

Answered By: pillmuncher

I disagree with a lot of the answers here.
Explicit is better than implicit but sometimes less is more when it comes to readability.

def get_cat():
    if cat_is_alive():
        return Cat()
# vs     

def get_cat():
    if cat_is_alive():
        return Cat()
    return None

In this particular example you have 2 extra lines that really provide no beneficial information since all functions return None by default.

Additionally explicitness of return None disappears even more with the usage of type hints:

def get_cat() -> Union[Cat, None]:
    if cat_is_alive():
        return Cat()

Including return None here is a double redundancy: None is returned by default and it’s indicated explicitly in the type hint markup.

Imho avoid trailing return None they are absolutely pointless and ugly.

Answered By: Granitosaurus

Don’t return None unnecessarily.

def foo2(x):
    if [some condition]:
        return Baz(x)

is the more readable.

Since every single function in Python implicitly has return None; adding such a universal statement is unnecessary.

Answered By: Paul Draper
Categories: questions Tags: , ,
Answers are sorted by their score. The answer accepted by the question owner as the best is marked with
at the top-right corner.