[Sublime + Python Setup] The Ctrl+s "Heisenbug"

"What the **** is going on?!" I heard Keith yell.

Returning from my lunch break and in a helpful mood I grabbed my coffee mug and shuffled over to my coworker's desk.

"What's wrong?"

Keith was working on a ticket to fix an issue with our Python-based web portal. The result of some numerical calculation was way off. It seemed like a straightforward algorithmic fix…

"I think this Python code is haunted or something," said Keith as I sat down next to him. "Opening and saving this source file fixes one bug, but then 5 others show up!"

Two hours of swearing and pair-programming later, our investigation of the "haunted code" revealed the following steps to reproduce the issue:

First, we check out the original version of the affected source file from Git. Bug A shows up. So far, so expected.

Next, we open the file in Sublime Text and, without making any edits, immediately hit Ctrl+S to save it again. Now bug A is gone—only to have brand new bugs B, C, and D show up!

Umm…

We were stumped.

"Maybe it's some odd whitespace issue…"

You see, whitespace has a meaning in Python. It uses whitespace indentation levels to determine how code blocks are nested.

Personally, I really like the idea of "semantic whitespace". But occasionally it can lead to pure hell. Take a look at the screenshot below:

Image

Running this script you'd expect to get 10 × 10 = 100 as the answer.

However, by using a mixture of space and tab (\t) characters, you can get this program to print "10"—a completely bogus answer:

For Python indenting, a tab is counted as equivalent to 8 spaces…

And code that looked correct on our screens was actually way off for the Python interpreter:

def square(x):
    result = 0
    for i in range(x):
        result += x
<\t>return result  # ← 1 tab character
^^^^               #   instead of 4 spaces

Remember, one tab is equal to 8 spaces. So this mixture of tab and spaces gets parsed as the following:

def square(x):
    result = 0
    for i in range(x):
        result += x
        return result  # ← 1 tab == 8 spaces

Now the return-statement is indented one level too far. It breaks out of the loop after the first iteration —

D'Oh!

Now by merely re-saving the file in Sublime these tab characters were converted to 4 space characters each. Thus fixing the original indentation problem, but also introducing several new ones elsewhere in the code…

Double D'Oh!

In the end Keith and I easily spent 20 or more developer hours on tracking down various bugs caused by inconsistent whitespace throughout the code base.

It was a nightmare of a bug to fix, and what frustrated me the most about it was how easily it could've been avoided in the first place:

Had we used static code analysis tools back then we would've caught these problems much more easily. Code linting tools would've simply highlighted this whitespace issue right in our editors (and on our build server):

Image

For this reason I'm a big proponent of static code analysis tools now. They can help you detect and void certain bugs and classes of errors completely.

A code linter can catch functional bugs like misspelled identifiers, or reveal code quality issues like unused variables or imports.

I won't say automated code analysis is a miracle cure (sometimes it feels like it) —

But usually the Return on Investment for these tools is simply through the roof. They help reduce debugging and code review time with just a tiny initial time investment.

Now, as awesome as these tools sound, there are some common gotchas to integrating them with Sublime Text:

If you're not careful, integrated code linting can get overly verbose and distracting—and it can slow your editing experience down to a crawl…

To see how to set up silky smooth code linting for Python in less than 10 minutes, click here for more.

— Dan Bader

Older messages

[PythonistaCafe] Why PythonistaCafe exists

Sunday, August 1, 2021

Hey there, In one of my last emails I talked about how some online communities in the tech space devolve over time and turn into cesspools of negativity. This relates directly to how and why I started

[Sublime + Python Setup] How to become a happier & more productive Python dev

Saturday, July 31, 2021

Hey there, I really struggled with setting up an effective development environment as a new Python developer. It was difficult to build the right habits and to find a set of tools I enjoyed to use.

[PythonistaCafe] What makes PythonistaCafe different

Saturday, July 31, 2021

Hey there, Mastering Python is *not* just about getting the books and courses to study—to be successful you also need a way to stay motivated and to grow your abilities in the long run. Many

[PythonistaCafe] Q&A

Saturday, July 31, 2021

Hey there, At this point you should have a pretty good idea of what PythonistaCafe is about and what makes it special. In this email I want to answer some common questions that I get asked about the

[PythonistaCafe] What's in PythonistaCafe for you?

Friday, July 30, 2021

Hey there, A couple of years ago I'd become quite interested in martial arts. Hours upon hours of watching "The Karate Kid" growing up must've taken their toll on me... And so, I

Remote working jobs row shows how much tech has changed

Monday, September 27, 2021

Ransomware attackers targeted this company. Then defenders discovered something curious ZDNet Facebook Twitter LinkedIn ZDNet Insights September 27, 2021 Remote working jobs row shows how much tech has

Office space capacity

Monday, September 27, 2021

SQL, Database Querying, InterviewQs Office space capacity SQL Database Querying Forward this email to a friend or colleague and challenge them to solve it. Hi, You are given a table of office sites

Already hyping the iPhone 14

Monday, September 27, 2021

Now available on your smart speaker and wherever you get your podcasts Apple Podcasts | Spotify | Google Play | iHeart Radio It's Monday, September 27, 2021. Is this a record? No sooner has the

GCP Newsletter #261

Monday, September 27, 2021

Welcome to issue #261 September 27th, 2021 News Cloud Deploy Official Blog Introducing Google Cloud Deploy: Managed continuous delivery to GKE - The new Google Cloud Deploy managed services makes it

Import AI 267: Tigers VS humans; synthetic voices; agri-robots

Monday, September 27, 2021

What happens when AI assistants become AI directors? How large can a computer get before distances between processors and memory offset scaling gains View this email in your browser Welcome to Import

Amazon haircuts 💇, OpenAI book summarization 📚, AlphaBay founder returns 👨‍💻

Monday, September 27, 2021

Amazon's first hair salon in London opened to the public at the end of May. TLDR Daily Update 2021-09-27 Discover a future without legacy and join the No‑Code revolution at Unqork Create 2021 (

Issue #64 - Busy - New Owners, FSE Themes, Upcoming Projects

Monday, September 27, 2021

Read on Website WP Weekly 64 / Busy It is super busy for the WordPress ecosystem from every direction. Be it the crowded aspect of who acquired who, a slew of new product launches, WordPress themes

[PythonistaCafe] Q&A

Monday, September 27, 2021

Hey there, At this point you should have a pretty good idea of what PythonistaCafe is about and what makes it special. In this email I want to answer some common questions that I get asked about the

SRE Weekly Issue #289

Monday, September 27, 2021

View on sreweekly.com A message from our sponsor, StackHawk: Semgrep and StackHawk are showing you what's new with automated security testing on September 30. Grab your spot: https://sthwk.com/

Congratulations, Mini, you made the stupidest turn signals ever — and JSFuck (2012)

Sunday, September 26, 2021

Issue #538 — Top 20 stories of September 27, 2021 Issue #538 — September 27, 2021 You receive this email because you are subscribed to Hacker News Digest. You can open it in the browser if you prefer.