Introduction to the Observer Pattern

Welcome back! We're continuing our exploration of Behavioral Patterns. In this lesson, we will delve into the Observer Pattern, another fundamental pattern that emphasizes object communication and responsibility distribution. This pattern allows an object, known as the subject, to maintain a list of its dependents, called observers, and notify them automatically of any state changes, usually by calling one of their methods.

Previously, we looked at the Command Pattern, which encapsulates a request as an object. Now, let's build on that knowledge and explore how the Observer Pattern facilitates communication between objects in a seamless and efficient manner.

Core Components of the Observer Pattern

In this lesson, you will learn how to implement the Observer Pattern by understanding its main components and their roles. The Observer Pattern typically involves a Subject, Observer, Concrete Observer, and Client.

We'll start by defining the Observer class that lays out the interface for receiving updates.

from abc import ABC, abstractmethod

class Subscriber(ABC):
    @abstractmethod
    def update(self, news):
        pass

In this code snippet, the Subscriber class defines the update method. This method will be called by the subject to notify subscribers of any updates.

Next, we need to create the NewsPublisher class, which acts as the Subject. This class maintains a list of subscribers and provides methods to add and remove subscribers, as well as to notify them.

class NewsPublisher:
    def __init__(self):
        self.subscribers = []

    def add_subscriber(self, subscriber):
        self.subscribers.append(subscriber)

    def remove_subscriber(self, subscriber):
        self.subscribers.remove(subscriber)

    def publish(self, news):
        for subscriber in self.subscribers:
            subscriber.update(news)

The NewsPublisher class has three methods: add_subscriber to add a new subscriber, remove_subscriber to remove an existing subscriber, and publish to notify all subscribers of new news.

Now, let's implement a concrete observer, which in this case will be a specific type of subscriber. This observer will define how to handle the updates received from the subject.

class ConcreteSubscriber(Subscriber):
    def __init__(self, name):
        self.name = name

    def update(self, news):
        print(f'{self.name} received news: {news}')

The ConcreteSubscriber class extends the Subscriber base class and implements the update method to print the news received.

Finally, let's see how these components work together in the main function, which serves as the client in this pattern.

if __name__ == "__main__":
    news_publisher = NewsPublisher()
    subscriber1 = ConcreteSubscriber("Subscriber 1")
    subscriber2 = ConcreteSubscriber("Subscriber 2")

    news_publisher.add_subscriber(subscriber1)
    news_publisher.add_subscriber(subscriber2)

    news_publisher.publish("Breaking News 1")
    # Output:
    # Subscriber 1 received news: Breaking News 1
    # Subscriber 2 received news: Breaking News 1
    
    news_publisher.remove_subscriber(subscriber1)
    news_publisher.publish("Breaking News 2")
    # Output:
    # Subscriber 2 received news: Breaking News 2

In the main function, we first create an instance of NewsPublisher and two ConcreteSubscriber objects. We then add the subscribers to the publisher, publish some news, remove one subscriber, and publish another piece of news to see how the system reacts to these state changes.

Full Code Example

Here is the complete code put together:

from abc import ABC, abstractmethod

class Subscriber(ABC):
    @abstractmethod
    def update(self, news):
        pass

class NewsPublisher:
    def __init__(self):
        self.subscribers = []

    def add_subscriber(self, subscriber):
        self.subscribers.append(subscriber)

    def remove_subscriber(self, subscriber):
        self.subscribers.remove(subscriber)

    def publish(self, news):
        for subscriber in self.subscribers:
            subscriber.update(news)

class ConcreteSubscriber(Subscriber):
    def __init__(self, name):
        self.name = name

    def update(self, news):
        print(f'{self.name} received news: {news}')

if __name__ == "__main__":
    news_publisher = NewsPublisher()
    subscriber1 = ConcreteSubscriber("Subscriber 1")
    subscriber2 = ConcreteSubscriber("Subscriber 2")

    news_publisher.add_subscriber(subscriber1)
    news_publisher.add_subscriber(subscriber2)

    news_publisher.publish("Breaking News 1")
    # Output:
    # Subscriber 1 received news: Breaking News 1
    # Subscriber 2 received news: Breaking News 1
    
    news_publisher.remove_subscriber(subscriber1)
    news_publisher.publish("Breaking News 2")
    # Output:
    # Subscriber 2 received news: Breaking News 2
Conclusion

Mastering the Observer Pattern is crucial for designing systems where objects need to maintain synchronized states. This pattern promotes loose coupling, enhances code readability, and improves maintainability.

Consider a news publishing system where multiple subscribers (users) receive updates whenever new articles are published. The Observer Pattern ensures that all subscribers are automatically notified of the new news without the publisher needing to maintain direct dependencies on each subscriber. This design greatly simplifies future system extensions, as new subscriber types can be added without modifying existing code.

The Observer Pattern unlocks the ability to create highly responsive and well-structured software systems. Let's move on to the practice section and see these concepts in action!

Sign up
Join the 1M+ learners on CodeSignal
Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal