Correct Style for Python functions that mutate the argument

by

The first way:

def change(array):
   array.append(4)

change(array)

is the most idiomatic way to do it. Generally, in python, we expect a function to either mutate the arguments, or return something1. The reason for this is because if a function doesn’t return anything, then it makes it abundantly clear that the function must have had some side-effect in order to justify it’s existence (e.g. mutating the inputs).

On the flip side, if you do things the second way:

def change(array):
  array.append(4)
  return array

array = change(array)

you’re vulnerable to have hard to track down bugs where a mutable object changes all of a sudden when you didn’t expect it to — “But I thought change made a copy”…

1Technically every function returns something, that _something_ just happens to be None …

More Related Contents:

  1. List of lists changes reflected across sublists unexpectedly
  2. Immutable vs Mutable types
  3. Why does using `arg=None` fix Python’s mutable default argument issue?
  4. a mutable type inside an immutable container
  5. Generating sublists using multiplication ( * ) unexpected behavior [duplicate]
  6. Existence of mutable named tuple in Python?
  7. Mutable strings in Python
  8. Why the “mutable default argument fix” syntax is so ugly, asks python newbie
  9. Can lists be mutated? [duplicate]
  10. Why are integers immutable in Python?
  11. Is making in-place operations return the object a bad idea?
  12. Printing Lists as Tabular Data
  13. Sort a list by multiple attributes?
  14. How to reduce a jpeg size to a ‘desired size’?
  15. Why does assigning to my global variables not work in Python?
  16. Is it possible to change sprite colours in Pygame?
  17. Determine if variable is defined in Python [duplicate]
  18. How to use __setattr__ correctly, avoiding infinite recursion
  19. Error – input expected at most 1 argument, got 3
  20. scipy curve_fit doesn’t like math module
  21. Element-wise logical OR in Pandas
  22. Why am I getting a line shadow in a seaborn line plot?
  23. How does boolean operator work on string in python
  24. for loops and iterating through lists – how does “for a[-1] in a:” work?
  25. Does Python have an immutable list?
  26. Is there a difference between “raise exception()” and “raise exception” without parenthesis?
  27. can’t pip install mysql-python
  28. selenium.common.exceptions.TimeoutException error using WebDriverWait with expected_conditions through Selenium and Python
  29. How can I limit iterations of a loop?
  30. How to find/replace text in html while preserving html tags/structure

Leave a Comment