SOLID - Single Responsibility Principle (SRP)

SOLID - Single Responsibility Principle (SRP)

The Single Responsibility Principle states that a class should have only one reason to change. In other words, a class should have a single responsibility or purpose. Here's an example:

class FileManager:
    def read_file(self, file_path):
        # Code to read the file

    def write_file(self, file_path, content):
        # Code to write content to the file

    def compress_file(self, file_path):
        # Code to compress the file

    def decompress_file(self, file_path):
        # Code to decompress the file

In the above example, the FileManager class violates the SRP because it has multiple responsibilities. It handles file reading, writing, compression, and decompression. A better approach would be to separate these responsibilities into distinct classes, each with a single responsibility. For example:

class FileReader:
    def read_file(self, file_path):
        # Code to read the file

class FileWriter:
    def write_file(self, file_path, content):
        # Code to write content to the file

class FileCompressor:
    def compress_file(self, file_path):
        # Code to compress the file

class FileDecompressor:
    def decompress_file(self, file_path):
        # Code to decompress the file

By adhering to the SRP, each class now has a single responsibility and can be independently modified without affecting the others. This promotes better maintainability and modularity in the codebase.

Popular posts from this blog

Atom - Jupyter / Hydrogen

Image
I will show you how to use the Atom editor with Jupyter Notebook to debug Python/Django views using Hydrogen plugin. On the Internet you can find some examples using this setup to debug Python but I found nothing related to Django, so I decided to publish this notes. This is not a high performance setup, because it involves many technologies at several layers. This is more a proof of concept of nowadays technologies which are available to the programmer's toolbox. This notes has been written during the development and improvement of the automated tests of the Virtual Library of FAPESP ( http://www.bv.fapesp.br ). The environment The diagram below shows an actual infrastructure to use this setup in a development environment. Technologies It is not expected that you know all of the technologies in detail, but there are some trick points. This paper is oriented for Python programmer who already use Atom and Jupyter and enjoy explore the edges of these tools. ...
Read more

Metodologias em ação

Image
O objetivo desse artigo é apresentar algumas metodologias atuais relacionadas à TI, na perspectiva das suas aplicações dentro de uma empresa. A estrutura de cada empresa pode variar muito, dessa maneira irei adotar uma estrutura clássica em formato de pirâmide, representada na figura abaixo para efeitos da nossa análise. As metodologias apresentadas, dificilmente serão utilizadas exatamente como estão sendo estudadas aqui pois não é comum a necessidade de utilizá-las em uma empresa todas ao mesmo tempo, apesar de ser possível. Isso dependerá do tipo de empresa, da estrutura que a mesma possui e como a empresa aplica a TI nos seus negócios. Também será feita uma breve análise do relacionamento entre as diversas metodologias quando adotadas em conjunto. A pirâmide representa a hierarquia em uma empresa tradicional, com o board of directors ficando no topo, abaixo a gerência senior com os CEO, CIO, CSO, CFO etc, abaixo a gerência operacional e abaixo os departamentos operacionais. Qual o ...
Read more

Design Patterns - Observer

Design Patterns - Observer A simple Python code example to illustrate the Observer Pattern for an ETL-like scenario. The "Extract Microservice" observes changes in a data source and notifies its registered observers (data extractors) to perform data extraction. We'll use a basic Publisher-Subscriber pattern to demonstrate the concept of the Observer Pattern. Observer interface class Observer: def update(self, data): pass Extract Microservice (Subject) class ExtractMicroservice: def __init__(self): self.observers = [] def register_observer(self, observer): self.observers.append(observer) def unregister_observer(self, observer): self.observers.remove(observer) def notify_observers(self, data): for observer in self.observers: observer.update(data) def start_extraction(self): # Simulate data extraction process data = ["Data 1", "Data 2", "Data 3",...
Read more