{"id":349,"date":"2017-08-27T18:38:25","date_gmt":"2017-08-27T18:38:25","guid":{"rendered":"http:\/\/sonny.cslu.ohsu.edu\/~gormanky\/blog\/?p=349"},"modified":"2019-09-18T14:41:51","modified_gmt":"2019-09-18T14:41:51","slug":"how-why-and-when-to-flatten-your-conditionals","status":"publish","type":"post","link":"https:\/\/www.wellformedness.com\/blog\/how-why-and-when-to-flatten-your-conditionals\/","title":{"rendered":"How, why, and when to flatten your conditionals"},"content":{"rendered":"

You may be tempted to write code that looks a little like this:<\/p>\n

for item in items:\r\n     if not condition_1(item):\r\n         if not condition_2(item, False):\r\n             if not condition_3(item, 3, 3):\r\n                 if not condition_4(item):\r\n                     do_work(item)<\/code><\/pre>\n
But please, don’t. Flatten your conditionals instead.<\/p>\n
How to flatten your conditionals<\/h1>\n
There is a relatively straightforward alternative to the above. Instead, we use continue<\/tt>\u00a0expressions to short-circuit the cascade. This looks a little bit like this:<\/p>\n
for item in items:\r\n     if condition_1(item):\r\n         continue\r\n     if condition_2(item, False):\r\n         continue\r\n     if condition_3(item, 3, 3):\r\n         continue\r\n     if condition_4(item):\r\n         continue\r\n     do_work(item)<\/code><\/pre>\n
That’s pretty much all there’s to it.<\/p>\n
Perhaps you’re not inside of a loop, but rather inside of a “nullable” function or method (i.e., one which may reasonably return None<\/span>); \u00a0that’s okay, replace continue<\/tt> with return<\/tt>. Perhaps there’s more than one item<\/tt> you’re possibly shipping off to do_work<\/tt> on; that’s okay, wrap the conditionals in a function and use return<\/tt> to short-circuit evaluation. Perhaps you want to terminal the entire loop, not just this iteration thereof; that’s okay, replace continue<\/tt> with break<\/tt>.<\/p>\n
Why to flatten your conditionals<\/h1>\n
The flattened loop is much easier to read. There is no indentation (or bracketing) to track. The fact that each of the conditional expressions is at the same indentation (bracketing) level makes it clear that we’re just dealing with a cascade of conditionals, all of which are handled the same. Realistically, one can only visually parse 3-4 levels of indentation; the Linux kernel, for example, uses an 8-character indent and forbids more than 3 levels of indentation<\/a>. Flattening your conditionals means you don’t have to deal with that very often.<\/p>\n
When to flatten your conditionals<\/h1>\n
It’s perhaps preferable to write your early code with nested conditional statements. It may turn out that you need to do some work in one of the medial else:<\/tt> clauses (which we’ve elided here), which can make flattening the conditionals hard. But once you’re writing comments about the conditionals in the cascade, and preparing to share your code with others, it’s time to do away with more than a few layers of indentation.<\/p>\n","protected":false},"excerpt":{"rendered":"
You may be tempted to write code that looks a little like this: for item in items: if not condition_1(item): if not condition_2(item, False): if not condition_3(item, 3, 3): if not condition_4(item): do_work(item) But please, don’t. Flatten your conditionals instead. How to flatten your conditionals There is a relatively straightforward alternative to the above. Instead, … Continue reading “How, why, and when to flatten your conditionals”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_crdt_document":"","footnotes":""},"categories":[3,8],"tags":[],"class_list":["post-349","post","type-post","status-publish","format-standard","hentry","category-dev","category-python"],"_links":{"self":[{"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/posts\/349","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/comments?post=349"}],"version-history":[{"count":4,"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/posts\/349\/revisions"}],"predecessor-version":[{"id":813,"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/posts\/349\/revisions\/813"}],"wp:attachment":[{"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/media?parent=349"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/categories?post=349"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.wellformedness.com\/blog\/wp-json\/wp\/v2\/tags?post=349"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}