[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

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

Wednesday, September 28, 2022

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

[Python Mastery] What does it mean to "master" Python?

Wednesday, September 28, 2022

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

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

Wednesday, September 28, 2022

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.

[Python Dependency Pitfalls] How to set the world on fire

Tuesday, September 27, 2022

Hey there, #1 on my list of dependency management pitfalls is there for a good reason: It lead to a single developer causing mayhem and breaking thousands of open-source projects around the world in

[Python Dependency Pitfalls] A total mess?

Monday, September 26, 2022

Hey there, Recently I watched a Pythonista ask for advice on setting up a Python project on his work machine. This new developer had some prior experience with NodeJS and had just started to get his

Elon Musk claims Apple 'threatened to withhold’ Twitter app

Tuesday, November 29, 2022

The Morning After Now available on your smart speaker and wherever you get your podcasts Apple Podcasts | Spotify | Google Play | iHeart Radio It's Tuesday, November 29, 2022. Elon Musk claims that

Those Giant Car Bows Are Totally Real and You Can Buy One

Tuesday, November 29, 2022

Read in Browser Logo for Review Geek November 29, 2022 If you've ever bought a gigantic present for someone so large that wrapping it in paper would be about as much effort as painting your house,

Post from Syncfusion Blogs on 11/29/2022

Tuesday, November 29, 2022

New blogs from Syncfusion Preact vs. React Top 15 VS Code Extensions Every Developer Should Know More from the Syncfusion Ecosystem Bold Reports: Paginated Reports and Analytics Bold Desk: Customizable

📃 Edge#247: Classifying ML Interpretability Methods

Tuesday, November 29, 2022

In this issue: we classify ML interpretability methods; we explore the building blocks of interpretability by Google Research; we explain TensorWatch, an open-source framework for debugging ML models.

Tesla Model 3 redesign 🚗, new GPT-3 released 🤖, lessons from being laid off 👨‍💻

Tuesday, November 29, 2022

Telsa is developing a revamped version of the Model 3. Sign Up | View Online | Sponsor Daily Update 2022-11-29 New survey reveals % of business decisions made based on actual data (Sponsor) Is '

Give back to open source on Giving Tuesday, 3 Git commands to level up your skill, and more

Tuesday, November 29, 2022

Write a C++ extension module for Python Write a C++ extension module for Python Opensource.com THE LATEST Give back to open source on Giving Tuesday Here are 18 ways to support and donate to free and

Power BI Weekly #184 - 29th November 2022

Tuesday, November 29, 2022

Power BI Weekly Newsletter Issue #184 powered by endjin Welcome to the 184th edition of Power BI Weekly! Absolutely no word from the Power BI team this week, so we'll jump straight into the

DeveloPassion's Newsletter - Black Friday Experiments

Tuesday, November 29, 2022

Hello everyone! I'm Sébastien Dubois, your host. You're receiving this email because you signed up fo DeveloPassion's Newsletter - Black Friday Experiments By Sébastien Dubois • Issue #97 •

[Last chance to register] Future-proof your observability platform with OpenTelemetry and Elastic

Tuesday, November 29, 2022

Join our Nov. 30 webinar to learn more. ㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤㅤ elastic | Search. Observe. Protect Future-proof your observability platform with OpenTelemetry and Elastic

Guide to FFmpeg — Photography for geeks — and Git Notes

Monday, November 28, 2022

Issue #965 — Top 20 stories of November 29, 2022 Issue #965 — November 29, 2022 You receive this email because you are subscribed to Hacker News Digest. You can open it in the browser if you prefer. 1