Sorting Out .sort() and sorted()
Sometimes sorting a Python list can make it mysteriously disappear. This happens even to experienced Python programmers who use .sort() when they should have used sorted() instead. The differences between these two ways of sorting a list are presented in this blog.
Author: Eric Olsen, Senior DTX Services Consultant and Instructor, Ph.D.
If you have a Python list, there are two basic ways to get it sorted. First, you can use the method built into the list object: .sort(). Second, you could use the top-level Python function sorted(). They have similar capabilities, controlled by the same keyword arguments (key and reverse). So, how do you know which one you should use in a particular place in your code?
The .sort() Method
One of the several methods built into Python list objects is .sort(). This is an in-place sort. It directly acts on the list, changing the order of items in it.
>>> l = [4, 2, 1, 3] >>> l.sort() >>> print(l) [1, 2, 3, 4]
Note that the call to .sort(), like a call to any Python method or function, returns a value. In the case of .sort(), the return value is the object None.
>>> m = l.sort() >>> print(m) None
This can cause problems when you are trying to save your sorted list to a new variable name (as in the example above), or when you are trying to run a for loop over a sorted list:
>>> for item in l.sort(): ... print(item) TypeError: 'NoneType' object is not iterable
It can also cause problems when trying to return a sorted list from a function:
>>> def build_list(): ... x = ['c', 'a', 'd', 'b'] ... return(x.sort()) >>> m = build_list() >>> print(m) None
All of these problems are the result of expecting a list’s .sort() method to return the list, rather than the None object that it actually returns. Remember that this method is used for in-place sorting only – it acts directly on the given list, replacing the current contents with new sorted contents.
The sorted() Function
In contrast, the sorted() function makes a copy of your list as it sorts it and returns that copy to you. As a result, it does two important things. First, it leaves the original list intact. Second, it hands you a sorted list object that you can store, use in a loop, or return from a function.
>>> l = [4, 2, 1, 3] >>> m = sorted(l) >>> print(l) # unchanged [4, 2, 1, 3] >>> print(m) # sorted [1, 2, 3, 4]
In each case where .sort() went wrong above, you should use sorted() instead.
Note that sorted() can also sort objects other than lists. Anything that is iterable (e.g., tuples, dictionaries, etc.) can be sorted.
Use .sort() for in-place list sorts. This operation returns a None, making it unsuitable for saving as a new list, using in loops, returning from functions, and any other context where you need a list object to continue. This in-place behavior can yield minor speed ups for larger lists compared to the sorted() approach since a copy is not being made during execution.
Use sorted() where you want to preserve the order of the original list but need a sorted list object to do some task. This generally happens when you want to save a sorted copy of your list, when you want to run a loop in a sorted order, or when you want to return a sorted list from a function.
About the Author
Eric Olsen holds a Ph.D. in history from the University of Pennsylvania, a M.S. in software engineering from Pennsylvania State University, and a B.A. in computer science from Utah State University. Eric spent three decades working in software development in a variety of fields, including atmospheric physics research, remote sensing and GIS, retail, and banking. In each of these fields, Eric focused on building software systems to automate and standardize the many repetitive, time-consuming, and unstable processes that he encountered.
About Enthought Training
Enthought Training supports scientists and engineers as they solve the problems of today while developing the creative thinking needed to realize the possibilities of digital technologies. Attend our upcoming courses and gain the knowledge and experience to tackle challenges with scientific data. Learn more here.
ChatGPT on Software Engineering
Recently, I’ve been working on a new course offering in Enthought Academy titled Software Engineering for Scientists and Engineers course. I’ve focused on distilling the…
What’s in a __name__?
if __name__ == “__main__”: When I was new to Python, I ran into a mysterious block of code that looked something like: def main(): …
Why Python? Of all of the questions that I have been asked as the instructor of an Enthought Python course, this has been one of…
Accelerating Science: the Classical Mechanics Perspective
When thinking about enhancing R&D processes, Newton’s second law of motion provides the perfect framework. Classical mechanics teaches us that putting a body into motion…
Retuning the Heavens: Machine Learning and Ancient Astronomy
What can we learn about machine learning from ancient astronomy? When thinking about Machine Learning it is easy to be model-centric and get caught up…
Announcing Enthought Academy
Dear Students and Friends of Enthought, I am pleased to announce Enthought Academy—the culmination of over twenty years of teaching Scientific Python. Since our founding…
Extracting Target Labels from Deep Learning Classification Models
In the blog post Configuring a Neural Network Output Layer we highlighted how to correctly set up an output layer for deep learning models. Here,…
Exploring Python Objects
Introduction When we teach our foundational Python class, one of the things we do is make sure that our students know how to explore Python…
Choosing the Right Number of Clusters
Introduction When I first started my machine learning journey, K-means clustering was one of the first algorithms I was introduced to – and it is…
Prospecting for Data on the Web
Introduction At Enthought we teach a lot of scientists and engineers about using Python and the ecosystem of scientific Python packages for processing, analyzing, and…