Avoid Common Python Pitfalls: Iteration, List Comprehensions, and Code Style

Iteration and the misuse of range

Beginners often reach for range to iterate over sequences, but using it for index‑based loops can cause off‑by‑one bugs because range includes the start value and excludes the stop value. Instead, iterate directly over the iterable, or use enumerate when the index is truly needed.

Common justifications for range and better alternatives:

Need an index – replace with direct iteration or enumerate.

Iterating two sequences in parallel – use zip.

Iterating a slice of a sequence – slice the sequence itself, adding a comment to explain the intent.

When dealing with very large sequences, slicing incurs significant overhead; in performance‑critical loops consider using xrange (Python 2) or generator expressions.

Proper use of list comprehensions

Instead of a multi‑line loop that builds a list, rewrite it as a list comprehension for brevity and readability. List comprehensions also support nested loops and conditional filters, but they should not be used when exception handling is required.

Examples:

Simple transformation: [func(x) for x in iterable].

Nested loops: [f(x, y) for x in xs for y in ys].

Conditional inclusion: [x for x in data if condition(x)].

Performance considerations for membership tests

Checking membership in a list is O(n), while a set or dict key lookup is O(1). For repeated checks, build a set (or dict if you need to associate values) once before the loop.

Variable scope and leakage

Python’s variable scope is broader than many other languages; a name not found in the local scope is looked up in the enclosing (global) scope. This can lead to unexpected NameError or logic bugs. Use sentinel values (commonly None) and initialize variables before loops to avoid “leaked” references.

When a function needs to modify a global variable, the global keyword is required; reading a global does not need it.

Global (module‑level) namespace best practices

Reserve the module’s top‑level namespace for constants (use ALL_CAPS naming) and avoid placing mutable state there. Pass parameters explicitly to functions instead of relying on globals.

PEP 8 and general code style

Follow the PEP 8 style guide: consistent indentation, meaningful naming, and appropriate whitespace. Test containers for emptiness with a simple truthy check ( if container:) rather than len(container) > 0. Use bool(x) when you need an explicit Boolean result.

When checking for None, use the identity comparison is None instead of truthiness checks to distinguish it from other falsy values like 0 or empty containers.