Is it ok to skip "return None"?
Solution 1:
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.
Solution 2:
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
.
Solution 3:
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.
Solution 4:
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.
Solution 5:
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.