Python Enums: Replace Magic Values with Named Constants

Crafting readable, maintainable, and organized code is a North Star of Software Engineering. Let's look at a quick tip that nudges us towards this ideal.

Have you encountered Enums in #Python yet?

Enums, short for "enumerations", represent a distinct set of values. They help enhance code quality in several ways:

1️⃣ Readability: Attach descriptive names to values, simplifying code comprehension.
2️⃣ Type-safety: Minimize the risk of assigning invalid values.
3️⃣ Code organization: Cluster related values together.
4️⃣ Eliminate magic values: Define values in a single location, rather than scattering them throughout your code.
5️⃣ Better maintainability: Modify values centrally, reducing scattered updates.

from enum import Enum

class Direction(Enum):

    NORTH = "N"
    SOUTH = "S"
    EAST = "E"
    WEST = "W"

# Accessing the enum:
print(Direction.NORTH)       # Direction.NORTH
print(Direction.NORTH.name)  # 'NORTH'
print(Direction.NORTH.value) # 'N'

Coding isn't just about getting it to work; it's about clarity, maintainability, and minimizing errors. Enums in Python can be a helpful tool in this journey! 🧰

Found it useful? Subscribe to my Analytics newsletter at notjustsql.com.

Enjoyed this? Here are some related articles you might find useful:

Using Enums in Python

Comments

Python for Data Engineers

Python Showdown: Namedtuple vs SimpleNamespace vs DataClass

More from this blog

pre_ and post_operations in Dataform

BigQuery Object Tables: A Practical Introduction

BigQuery BigLake Tables Explained: What They Are and When to Use Them

BigQuery Saves Your Query Results — Here's How to Find Them

Parameters in BigQuery

Command Palette

Comments

Python for Data Engineers

Python Showdown: Namedtuple vs SimpleNamespace vs DataClass

More from this blog