[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] Q&A

Friday, July 16, 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

[Python Dependency Pitfalls] What dev managers expect from Python candidates

Friday, July 16, 2021

Hey there, My friend Og is a senior manager at Red Hat and works with a large team of developers and quality engineers using Python. I got to pick his brain on what he thought were the most important

[Sublime + Python Setup] Grumpy old greybeard with a whitespace problem

Wednesday, July 14, 2021

One fateful day, the Agile Gods that be decided to “add some firepower” to my little team… And so, developer Paul joined (name changed to protect the guilty). Before I dive into this story, let me ask

[PythonistaCafe] Why PythonistaCafe exists

Wednesday, July 14, 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

[PythonistaCafe] What makes PythonistaCafe different

Tuesday, July 13, 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

Is drawing a Red independent from an Ace?

Wednesday, July 28, 2021

Statistics, Probability Theory, InterviewQs Is drawing a Red independent from an Ace? Statistics Probability Theory Forward this email to a friend or colleague and challenge them to solve it. Hi, I

iPhone sales are up 50 percent year over year

Wednesday, July 28, 2021

Now available on your smart speaker and wherever you get your podcasts Apple Podcasts | Spotify | Google Play | iHeart Radio It's Wednesday, July 28, 2021. The curse of buying new tech at the wrong

Facebook's digital universe 🌎, Discord threads 🎮, water on Jupiter's moon 🌊

Wednesday, July 28, 2021

Facebook will create a product team to work on the metaverse. The team will be part of Facebook's Reality Labs. TLDR Daily Update 2021-07-28 Tomorrow: Hungry? - Lunch on us during the Digital

Great Resignation: Top reasons employees are quitting now

Wednesday, July 28, 2021

Microsoft warns of credential-stealing NTLM relay attacks; clean up your Gmail inbox with this mass delete trick Subscription | Read Online | Twitter Facebook LinkedIn Top Story of the Day July 27,

Element raises $30M to boost Matrix — The Insecurity Industry — and Mammals dream about the world they are about to experience before they are born

Tuesday, July 27, 2021

Issue #477 — Top 20 stories of July 28, 2021 Issue #477 — July 28, 2021 You receive this email because you are subscribed to Hacker News Digest. You can open it in the browser if you prefer. 1 Element

[PythonistaCafe] What makes PythonistaCafe different

Tuesday, July 27, 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

Daily Crunch - No-code startup Bubble pops with $100 million Series A round

Tuesday, July 27, 2021

TechCrunch Newsletter TechCrunch logo The Daily Crunch logo Tuesday, July 27, 2021 • By Alex Wilhelm Hello and welcome to Daily Crunch for July 27, 2021. Today is a good day not only because the US

Lights, Camera, Blockbuster

Tuesday, July 27, 2021

Whether it's Iron Man, Star Wars, or Fight Club, the technical know-how for film creation is complex and fascinating. Read on to find out the unbelievable behind-the-scenes processes. Project

Python Collections, SciPy's New Build System, What To Know About the "operator" Module, and More

Tuesday, July 27, 2021

Python's `collections`: A Buffet of Specialized Data Types #483 – JULY 27, 2021 VIEW IN BROWSER The PyCoder's Weekly Logo Python's collections : A Buffet of Specialized Data Types Python

JSK Daily for Jul 27, 2021

Tuesday, July 27, 2021

JSK Daily for Jul 27, 2021 View this email in your browser A community curated daily e-mail of JavaScript news JavaScript Currying: A Comprehensive Guide Currying is an advanced technique of working