Is it pythonic for a function to return multiple values?

by

Absolutely (for the example you provided).

Tuples are first class citizens in Python

There is a builtin function divmod() that does exactly that.

q, r = divmod(x, y) # ((x - x%y)/y, x%y) Invariant: div*y + mod == x

There are other examples: zip, enumerate, dict.items. 

for i, e in enumerate([1, 3, 3]):
    print "index=%d, element=%s" % (i, e)

# reverse keys and values in a dictionary
d = dict((v, k) for k, v in adict.items()) # or 
d = dict(zip(adict.values(), adict.keys()))

BTW, parentheses are not necessary most of the time.
Citation from Python Library Reference:

Tuples may be constructed in a number of ways:

  • Using a pair of parentheses to denote the empty tuple: ()
  • Using a trailing comma for a singleton tuple: a, or (a,)
  • Separating items with commas: a, b, c or (a, b, c)
  • Using the tuple() built-in: tuple() or tuple(iterable)

Functions should serve single purpose

Therefore they should return a single object. In your case this object is a tuple. Consider tuple as an ad-hoc compound data structure. There are languages where almost every single function returns multiple values (list in Lisp).

Sometimes it is sufficient to return (x, y) instead of Point(x, y).

Named tuples

With the introduction of named tuples in Python 2.6 it is preferable in many cases to return named tuples instead of plain tuples.

>>> import collections
>>> Point = collections.namedtuple('Point', 'x y')
>>> x, y = Point(0, 1)
>>> p = Point(x, y)
>>> x, y, p
(0, 1, Point(x=0, y=1))
>>> p.x, p.y, p[0], p[1]
(0, 1, 0, 1)
>>> for i in p:
...   print(i)
...
0
1

More Related Contents:

  1. Trying to use a returned value without the other parts of a function [closed]
  2. How can I return two values from a function in Python?
  3. Returning tuple with a single item from a function
  4. Is it ok to skip “return None”?
  5. Python – Class.function().function()
  6. Function to return results in a dictionary in Python
  7. Why does this recursion return 0?
  8. Why is the output of my function printing out “None”?
  9. How to get the original variable name of variable passed to a function
  10. UnboundLocalError with nested function scopes
  11. Passing functions with arguments to another function in Python?
  12. What does it mean to “call” a function in Python? [closed]
  13. Python: Passing variables between functions
  14. Return value from button click
  15. Using a dictionary to select function to execute
  16. Calling a function upon button press
  17. Python: dynamically create function at runtime
  18. How to access a function inside a function?
  19. How to get current function into a variable?
  20. Efficient evaluation of a function at every cell of a NumPy array
  21. Why should functions always return the same type?
  22. In Python, what does ” mean?
  23. break and continue in function
  24. Python functions with multiple parameter brackets
  25. How to make function decorators and chain them together in Python?
  26. I have a string whose content is a function name, how to refer to the corresponding function in Python?
  27. Check if all values in list are greater than a certain number
  28. Possible to change a function’s repr in python?
  29. python function default parameter is evaluated only once? [duplicate]
  30. Store functions in list and call them later [duplicate]

Leave a Comment