DEV Community

Timevolt
Timevolt

Posted on

The Fellowship of the Code: Applying SOLID Principles in Python

The Quest Begins (The "Why")

I still remember the first time I inherited a codebase that felt like walking into Mordor without a map. A single ReportGenerator class was responsible for fetching data from three different APIs, massaging it into a dozen formats, writing CSV files, emailing stakeholders, and even logging its own progress. Every time the marketing team wanted a new column in the Excel export, I had to crack open that beast, add a conditional, and pray I didn’t break the PDF generation tucked away at the bottom.

It wasn’t just tedious—it was terrifying. A tiny tweak in the email‑sending logic could silently corrupt the CSV output, and debugging felt like defusing a bomb while blindfolded. I spent hours tracing calls, adding print statements, and questioning my life choices. That’s when I realized the real monster wasn’t the missing feature; it was the class trying to do everything.

If you’ve ever felt like you’re stuck in a loop of “fix one thing, break another,” you know exactly what I mean. The quest for cleaner, more maintainable code began with a simple question: What if each piece of my code had only one reason to change?

The Revelation (The Insight)

That question led me straight to the Single Responsibility Principle (SRP)—the “S” in SOLID. In plain English, SRP says: A class should have only one job. When a class wears many hats, change ripples through the codebase like a stone tossed into a pond, and you never know where the next splash will hit.

Applying SRP isn’t about dogma; it’s about giving yourself breathing room. When each class does one thing well, you can swap implementations, test in isolation, and refactor without fear. It’s like discovering a hidden shortcut through the Mines of Moria—you still reach the destination, but the journey is far less perilous.

Let’s see how this plays out in Python, moving from a tangled monolith to a clean, composable set of helpers.

Wielding the Power (Code & Examples)

The Before: A Class Doing Too Much

class ReportGenerator:
    def __init__(self, data_source):
        self.data_source = data_source

    def fetch(self):
        # Pretend this hits a REST API, a DB, and a third‑party service
        raw = self.data_source.get_raw()
        return raw

    def transform(self, raw_data):
        # Clean, pivot, calculate percentages… a lot of logic here
        cleaned = [self._clean_row(r) for r in raw_data]
        pivoted = self._pivot(cleaned)
        return pivoted

    def to_csv(self, data):
        import csv, io
        output = io.StringIO()
        writer = csv.writer(output)
        writer.writerows(data)
        return output.getvalue()

    def to_pdf(self, data):
        # Imagine a heavy PDF‑generation library call
        from fpdf import FPDF
        pdf = FPDF()
        pdf.add_page()
        for row in data:
            pdf.cell(0, 10, txt=str(row), ln=True)
        return pdf.output(dest='S').encode('latin1')

    def email(self, content, recipient):
        import smtplib, ssl
        context = ssl.create_default_context()
        with smtplib.SMTP_SSL("smtp.example.com", 465, context=context) as server:
            server.login("user", "pass")
            server.sendmail("me@example.com", recipient, content)

    def _clean_row(self, row):
        # …private helpers omitted for brevity
        return row

    def _pivot(self, data):
        # …more private helpers
        return data
Enter fullscreen mode Exit fullscreen mode

What’s wrong here?

  • Fetching, transforming, exporting, and emailing are all tangled together.
  • If the email server changes, you risk breaking the CSV logic.
  • Unit testing to_csv requires mocking the data source, the transformation, and the email client—all at once.
  • Adding a new export format (say, Excel) means editing this class again, increasing the chance of a regression.

It’s a classic god‑object, and maintaining it feels like trying to juggle flaming swords while riding a unicycle.

The After: Splitting Responsibilities

Let’s give each concern its own class. We’ll keep the data source abstraction, but everything else gets its own focused component.

# 1️⃣ Data acquisition – only knows how to get raw data
class DataFetcher:
    def __init__(self, data_source):
        self.data_source = data_source

    def fetch(self):
        return self.data_source.get_raw()


# 2️⃣ Transformation – only knows how to shape data
class DataTransformer:
    def transform(self, raw_data):
        cleaned = [self._clean_row(r) for r in raw_data]
        pivoted = self._pivot(cleaned)
        return pivoted

    def _clean_row(self, row):
        # cleaning logic …
        return row

    def _pivot(self, data):
        # pivot logic …
        return data


# 3️⃣ CSV export – only knows how to write CSV
class CSVExporter:
    def export(self, data):
        import csv, io
        output = io.StringIO()
        writer = csv.writer(output)
        writer.writerows(data)
        return output.getvalue()


# 4️⃣ PDF export – only knows how to write PDF
class PDFExporter:
    def export(self, data):
        from fpdf import FPDF
        pdf = FPDF()
        pdf.add_page()
        for row in data:
            pdf.cell(0, 10, txt=str(row), ln=True)
        return pdf.output(dest='S').encode('latin1')


# 5️⃣ Emailer – only knows how to send mail
class Emailer:
    def __init__(self, smtp_host="smtp.example.com", port=465,
                 username="user", password="pass"):
        self.smtp_host = smtp_host
        self.port = port
        self.username = username
        self.password = password

    def send(self, content, recipient):
        import smtplib, ssl
        context = ssl.create_default_context()
        with smtplib.SMTP_SSL(self.smtp_host, self.port, context=context) as server:
            server.login(self.username, self.password)
            server.sendmail("me@example.com", recipient, content)
Enter fullscreen mode Exit fullscreen mode

Now the workflow looks like this:

fetcher   = DataFetcher(my_data_source)
transformer = DataTransformer()
csv_exporter = CSVExporter()
pdf_exporter = PDFExporter()
emailer   = Emailer()

raw      = fetcher.fetch()
clean    = transformer.transform(raw)

csv_data = csv_exporter.export(clean)
pdf_data = pdf_exporter.export(clean)

emailer.send(csv_data, "boss@example.com")
# or emailer.send(pdf_data, "boss@example.com")
Enter fullscreen mode Exit fullscreen mode

Why this feels like a victory:

  • Single reason to change: If the CSV library updates, only CSVExporter touches.
  • Testability: You can instantiate CSVExporter and feed it fake data without pulling in a network or PDF library.
  • Composability: Need Excel? Write an ExcelExporter and plug it in—no existing code gets touched.
  • Readability: Each class name tells you exactly what it does; the orchestration script reads like a short story.

The before‑after contrast is stark: we went from a fragile, hard‑to‑test monolith to a set of small, focused, and reusable pieces. It’s the difference between trying to lift a boulder with your bare hands and using a well‑placed lever.

Why This New Power Matters

Adhering to SRP (and, by extension, the rest of SOLID) doesn’t just make your code look nicer—it changes how you think about problems. You start seeing responsibilities as seams where you can safely cut and recombine. Bugs become localized; refactoring stops feeling like defusing a bomb and starts feeling like rearranging LEGO bricks.

When your team embraces this mindset, onboarding speeds up. New hires can grasp a single class’s purpose in minutes instead of hours. Continuous integration pipelines run faster because tests are smaller and more isolated. And perhaps most importantly, you regain the joy of coding—because you’re no longer constantly firefighting side‑effects you didn’t anticipate.

Think of it as the moment in The Lord of the Rings when the Fellowship splits up: each member takes on a role they’re best suited for, making the overall quest far more manageable. Your codebase deserves that same clarity.

Your Turn

Here’s a little challenge: pick a class in your current project that feels like it’s doing too much. Extract one responsibility into its own class, write a tiny test for it, and watch how the rest of the code breathes easier. Share your before/after snippets in the comments—let’s celebrate those small victories together!

Happy coding, and may your classes always have a single, noble purpose. 🚀

Top comments (0)