{"id":880,"date":"2021-06-26T09:38:22","date_gmt":"2021-06-26T13:38:22","guid":{"rendered":"https:\/\/www.alpharithms.com\/?p=880"},"modified":"2022-06-16T15:23:55","modified_gmt":"2022-06-16T19:23:55","slug":"python-all-function","status":"publish","type":"post","link":"https:\/\/www.alpharithms.com\/python-all-function-223809\/","title":{"rendered":"Python’s all(): Built-in Function for Searching Among the Many"},"content":{"rendered":"

The Python all() function is a built-in that evaluates an entire collection for truthiness. It can be used in static syntax or more dynamic implementations involving such features as list comprehension and generators. It can be used in combination with other language features to built powerful and succinct conditional statements.<\/p>\n

The all()<\/code> function’s possible use-cases are limited by little more than a developer’s imagination and in this article, I’ll showcase some basic usage, a few advanced cases, and hopefully illustrate why Every Python programmer should become intimately familiar with the built-in all()<\/code> function.<\/p>\n

TL;DR<\/strong> – The all() function tests an entire collection for conditions evaluating to True<\/code><\/p>\n

# Have a collection of integers\r\n>>> nums = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]\r\n\r\n# Check all items are integers\r\n>>> all(int(x) for x in nums)\r\n\r\n# That's a bingo\r\nTrue<\/pre>\n
Basic Usage<\/h2>\n
Python’s all function is used to check all members in a collection for truthiness<\/em>. There are many iterable types in Python including lists, dictionaries, sets, generators, and even strings. Each of these data types can be used along with the all<\/code> function. It can be compared to the more semantic for all in a list, check each is True<\/em>. Let’s consider some canonical use cases.<\/p>\n
Case 1: Basic Truth Testing<\/h3>\n
# Create a list\r\nl = [0, 1, 2, 3, 4, 5]\r\n\r\nall(l)\r\n>>> False\r\n<\/pre>\n
This example demonstrates the core behavior of the all function: testing all items in an iterable for a True or False value. In this case, the failing member is the first element; the 0 (equivalent of False). For example:<\/p>\n
# Check the numerical value of False\r\n>>> 0 == False\r\n\r\nTrue\r\n\r\n# Check the numerical value of True\r\n>>> 1 == True\r\n\r\nTrue\r\n\r\n# Check for other values of True\r\n>>> 1 == True and 2 == True and 3 == True and 4 == True and 5 == True\r\n\r\nFalse\r\n\r\n# Remove the 0 element from list, use all\r\n>>> all([1, 2, 3, 4, 5)]\r\n\r\nTrue\r\n\r\n# Check an empty list\r\n>>> all([])\r\n\r\nTrue<\/pre>\n
These examples may seem mildly infuriating. That is the sweet feeling of learning something new! Per the official Python documentation<\/a>, the all<\/code> function will; Return True if all elements of the iterable are true (or if the iterable is empty).\u00a0<\/em>I find this statement confusing and would re-phrase it as such:<\/p>\n
Returns True if all elements of the iterable are not False. The statements x is not False<\/code> and x is True<\/code> are equivalent\u00a0logically\u00a0but the former offers better clarity in this context.<\/em><\/p>\n
With this in mind, let’s reconsider the first example and why it evaluated to False<\/code> using the all<\/code> function.<\/p>\n
# Create a list l = [0, 1, 2, 3, 4, 5]\r\n>>> all(l)\r\n\r\nFalse\r\n\r\n# Create another list \r\nl_2 = [1, 2, 3, 4, 5]\r\n>>> all(l_2)\r\n\r\nTrue<\/pre>\n
The entirety of any logic-based function is\u00a0always<\/em> tough to grasp. These examples are intended to better illustrate the nuances of the all<\/code> function such that the following, more advanced cases, can be better understood.<\/p>\n
Other Examples<\/h2>\n
I find most applications for my use of the all function to be somewhat dynamic. In most cases, I’m using comprehension syntax to check large numbers of membership as a conditional statement<\/em><\/a> for executing some other logic. In other words, taking advantage of Python’s succinct syntax! Consider the following example:<\/p>\n
from string import printable\r\n\r\n# Check if all letters of a string are in the \r\n# string.printable variable (ASCII characters)\r\nif all(x in printable for x in 'hello, world!'):\r\n    print(\"All Letters are ASCII!\")\r\nelse:\r\n    print(\"Non-ASCII letters found!\")\r\n\r\n# The result:\r\nAll letters as ASCII!<\/pre>\n
In this example, the all()<\/code> function is used to check that every letter in the string \"hello, world!\"<\/code> is found within the string.printable<\/code> variable.<\/p>\n
Note<\/strong>: The string.printable<\/code> variable is equal to the following string (minus a few whitespaces):<\/p>\n
0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!\"#$%&'()*+,-.\/:;<=>?@[\\]^_`{|}~<\/pre>\n
Check out this ASCII table<\/a> for more information on these types of character sets. This example showcases a basic use-case of the all() function that one might encounter in the wild. Testing for multiple membership conditions is a powerful way to make decisions with complex or dynamic data. Let’s consider a more complex example.<\/p>\n
Combining Statements<\/h3>\n
Here we’ll see an example where the all()<\/code> function is used in combination with another one of the Python builtins; the any()<\/code> function. Using a very contrived set of data, we’ll check that one of the color values is present in all of the data entries’ key values:<\/p>\n
# Define a set of values\r\ncolors = ['red', 'blue', 'green']\r\nnumbers = [1, 2, 3]\r\n\r\n# Generate some random data\r\n>>> data = {\r\n    choice(colors) + \"-\" + choice(colors): choice(numbers) * choice(numbers)\r\n    for x in range(10)\r\n}\r\n{'blue-blue': 3, 'blue-red': 2, 'red-blue': 2, 'green-green': 6, 'red-green': 1, 'blue-green': 2}\r\n\r\n# Check that ALL members in 'data' contain ANY member of 'colors'\r\n>>> all(any(x in y for y in data.keys()) for x in colors)\r\nTrue\r\n<\/pre>\n
This exemplifies not only how the all()<\/code> function can be used dynamically but also the joys of using Python comprehension statements. Apologies for the bizarre construction of the data<\/code> object\u2014I was having a shortfall of imagination!<\/p>\n
Note<\/strong>: Check out this article for a deeper look at Python’s any() built-in function.<\/a><\/p>\n
Extracting Items into Another Collection<\/h3>\n
Python’s all()<\/code> method can be used to extract subsets from collections where conditional membership is needed. Consider the following [very contrived] example:<\/p>\n
# Create some random collection of numbers\r\nnum_pairs = [(1, 3), (2, 4), (3, 6, 9), (1, 2, 3, 4), (4, 6, 8)]\r\n\r\n# Extract any pair of numbers where only even numbers are present\r\nevens = [x for x in num_pairs if all(n % 2 == 0 for n in x)]\r\n\r\n>>> evens\r\n \r\n# Results in sub-sets containing\r\n# only all-even values\r\n[(2, 4), (4, 6, 8)]<\/pre>\n
This showcases the use of the all()<\/code> function to check each tuple in the collection for only even values. For any tuple containing no non-even values (odd == not False) Python’s comprehension syntax will collect that item into the new evens<\/code> collection.<\/p>\n
Advanced Considerations<\/h2>\n
There are some possible performance issues when testing large collections for membership. In the following example, I’ll use the all()<\/code> function to check a list of 100,000,000 million randomly generated 1’s and 0’s to ensure all members are integer values. Before I check, however, I’ll add a single non-integer 'z'<\/code> character to the end of the collection<\/strong>.<\/p>\n
# Create a list 100MMK 1's or 0's, chosen randomly\r\nimport random\r\nnums = list(random.choice([0, 1]) for x in range(10**8))\r\n\r\n# Add the letter \"z\" to the end\r\nnums.append('z')\r\n\r\n# Test that all members are numerical\r\nimport timeit\r\n>>> timeit.timeit(lambda: all(type(x) == int for x in nums))\r\n\r\n# Total Execution Time\r\n5.397376900000005\r\n<\/pre>\n
This code does the following:<\/p>\n
    \n
  1. Creates a list of 100,000,000 1’s and 0’s in random order<\/li>\n
  2. Append a single 'z'<\/code> character to the end<\/li>\n
  3. Test that all items in the list are integer values<\/li>\n<\/ol>\n
    Note the total runtime of this code is ~5.40 seconds with a ‘z’ character at the end of the sequence. This time reflects the all()<\/code> functions need to iterate over\u00a0every<\/em> single element before it can be sure all are integers.<\/p>\n
    Now imagine that the 'z'<\/code> character was placed at the beginning. Without proper checks in place, one might find themselves iterating over an entire collection before determining truthiness. For example, counting the total number occurrences of a non-integer item and comparing that to 0.<\/p>\n
    The developers of Python are clever. The moment a condition evaluates to a non-Truthy value the all()<\/code> function will shortcircuit rather than evaluating completely. Consider the above example, this time with the character 'z'<\/code> added to the start of the collection<\/strong>.<\/p>\n
    # Create a list 100MM 1's or 0's, chosen randomly\r\nimport random\r\nnums = list(random.choice([0, 1]) for x in range(10**8))\r\n\r\n# Add the letter \"z\" to the start\r\nnums.insert(0, 'z')\r\n\r\n# Test that all members are numerical\r\nimport timeit\r\ntimeit.timeit(lambda: all(type(x) == int for x in nums), number=1)\r\n\r\n# A reeaaly small value\r\n2.600000001962144e-06\r\n<\/pre>\n
    Do you need to know this to enjoy the all()<\/code> function? Absolutely not. I find a better understanding of how functions were developed, especially the consideration made for performance issues, helps clarify their application. I’m a nerd like that.<\/p>\n
    Final Thoughts<\/h2>\n
    The Python all()<\/code> function is one of the most useful tools of the language in my opinion. Its ability to batch-test truthiness comes in handy on a daily basis in my experience. Other languages and lambda their way into similar utility but few offer the out-of-the-box, performant, native syntax that Python does. Combined with generators, comprehensions, and a little imagination\u2014the all()<\/code> function can make one feel\u00a0really<\/em> smart (until code review time, anyway!)<\/p>\n","protected":false},"excerpt":{"rendered":"
    The Python all() function is a built-in that evaluates an entire collection for truthiness. It can be used in static syntax or more dynamic implementations involving such features as list comprehension and generators. It can be used in combination with other language features to built powerful and succinct conditional statements. The all() function’s possible use-cases […]<\/p>\n","protected":false},"author":2,"featured_media":884,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[655,10],"tags":[222,69,370,368,369,367,143],"acf":[],"_links":{"self":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts\/880"}],"collection":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/comments?post=880"}],"version-history":[{"count":4,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts\/880\/revisions"}],"predecessor-version":[{"id":2348,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/posts\/880\/revisions\/2348"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/media\/884"}],"wp:attachment":[{"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/media?parent=880"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/categories?post=880"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.alpharithms.com\/wp-json\/wp\/v2\/tags?post=880"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
The 0<\/code> element of the first list is causing the all<\/code> statement to evaluate to False<\/code>. This is because the numerical value 0 is equivalent to False under-the-hood. Read this article<\/a> for more on how Python (and other programming languages<\/a>) represent numbers internally. Removing the 0<\/code> leaves only non-zero elements\u2014which evaluate to\u00a0not-False<\/em>.<\/p>\n