Why do these list methods (append, sort, extend, remove, clear, reverse) return None rather than the resulting list?

by

The general design principle in Python is for functions that mutate an object in-place to return None. I’m not sure it would have been the design choice I’d have chosen, but it’s basically to emphasise that a new object is not returned.

Guido van Rossum (our Python BDFL) states the design choice on the Python-Dev mailing list:

I’d like to explain once more why I’m so adamant that sort() shouldn’t
return ‘self’.

This comes from a coding style (popular in various other languages, I
believe especially Lisp revels in it) where a series of side effects
on a single object can be chained like this:

x.compress().chop(y).sort(z)

which would be the same as

x.compress()
x.chop(y)
x.sort(z)

I find the chaining form a threat to readability; it requires that the
reader must be intimately familiar with each of the methods. The
second form makes it clear that each of these calls acts on the same
object, and so even if you don’t know the class and its methods very
well, you can understand that the second and third call are applied to
x (and that all calls are made for their side-effects), and not to
something else.

I’d like to reserve chaining for operations that return new values,
like string processing operations:

y = x.rstrip("\n").split(":").lower()

There are a few standard library modules that encourage chaining of
side-effect calls (pstat comes to mind). There shouldn’t be any new
ones; pstat slipped through my filter when it was weak.

More Related Contents:

  1. How do i search for 2 of the same numbers in a list? (python) [closed]
  2. How to remove an element from a list by index
  3. List of lists changes reflected across sublists unexpectedly
  4. Strange result when removing item from a list while iterating over it
  5. How to merge lists into a list of tuples?
  6. Explanation of how nested list comprehension works?
  7. How can I compare two lists in python and return matches
  8. TypeError: ‘list’ object is not callable in python
  9. Difference between del, remove, and pop on lists
  10. Find intersection of two nested lists?
  11. What exactly does the .join() method do?
  12. Interleave multiple lists of the same length in Python
  13. Pythonic way to check if a list is sorted or not
  14. Compute list difference
  15. Python: Finding differences between elements of a list
  16. Why does foo.append(bar) affect all elements in a list of lists?
  17. List comprehension vs. lambda + filter
  18. Python – use list as function parameters
  19. Append to a list defined in a tuple – is it a bug? [duplicate]
  20. List of dicts to/from dict of lists
  21. String to list in Python
  22. How to extract parameters from a list and pass them to a function call [duplicate]
  23. Transpose nested list in python
  24. Combine lists with common elements
  25. How do I split a string into a list?
  26. Generate a list of datetimes between an interval
  27. case-insensitive list sorting, without lowercasing the result?
  28. How do I prepend to a short python list?
  29. Finding first and last index of some value in a list in Python
  30. Python: why does my list change when I’m not actually changing it?

Leave a Comment