1. Definition
The Memento Design Pattern allows for the ability to restore an object to its previous state, which can be useful for operations like undo.
2. Problem Statement
Sometimes it's necessary to record the internal state of an object without exposing its internal structure and without breaking the principles of encapsulation. For example, in applications that provide undo functionality.
3. Solution
The Memento pattern achieves this by introducing three actor classes: Originator, Caretaker, and Memento. The Originator is the object whose state we want to save. The Caretaker is the one that keeps the list of states (mementos). Memento is the value object where the state of the Originator is stored.
4. Real-World Use Cases
1. Text editor undo mechanism.
2. Game save and load functionality.
3. Snapshot functionality in VMs or databases.
5. Implementation Steps
1. Create a Memento class that only the Originator can read and write.
2. The Originator class creates a memento containing a snapshot of its internal state and can also restore its state from a memento.
3. The Caretaker class keeps track of multiple mementos but never operates on them.
6. Implementation in Python
# Memento
class Memento:
def __init__(self, state):
self._state = state
def get_saved_state(self):
return self._state
# Originator
class Originator:
_state = ""
def set(self, state):
self._state = state
def save_to_memento(self):
return Memento(self._state)
def restore_from_memento(self, memento):
self._state = memento.get_saved_state()
# Caretaker
class Caretaker:
_saved_states = []
def add_memento(self, memento):
self._saved_states.append(memento)
def get_memento(self, index):
return self._saved_states[index]
# Client code
originator = Originator()
caretaker = Caretaker()
originator.set("State1")
originator.set("State2")
caretaker.add_memento(originator.save_to_memento())
originator.set("State3")
caretaker.add_memento(originator.save_to_memento())
originator.set("State4")
print("Current State:", originator._state)
originator.restore_from_memento(caretaker.get_memento(1))
print("Restored to State:", originator._state)
Output:
Current State: State4
Restored to State: State3
Explanation:
1. The Originator first sets its state to different values and saves these states using Mementos via the Caretaker.
2. The Caretaker holds these states without actually examining or modifying them.
3. The Originator's state is set to "State4", but then we decide to restore it to a previous state ("State3") using a memento retrieved from the Caretaker.
4. This showcases the undo functionality and the principle of encapsulation as the state is never directly accessed or modified by anyone other than the Originator.
7. When to use?
Use the Memento Pattern when:
1. You need to implement a snapshot of an object's state so that you can restore the snapshot later.
2. Direct exposure of an object's private data or details isn't acceptable, but you still want to save its state.
3. You want a structured way to implement the undo mechanism in your applications.
Design Pattern
Related Python Source Code Examples:
Python string literals
Python string length example
Python String join() method example
Python string split() method example
Python String index() method example
Python string find() method example
Python string startswith() method example
Python string endswith() method example
Python String lower() method example
Python String upper() method example
Python string title() method example
Python string capitalize() method example
Python string islower() method example
Python string istitle() method example
Python string isupper() method example
Python string swapcase() method example
Python string strip() method example
Python string replace() method example
Python string isdigit() method example
Python string isdecimal() method example
Python string isnumeric() method example
Python string isalpha() method example
Python string isalnum() method example
Write a python program to concatenate strings in different ways
Python program to create a new string by appending s2 in the middle of s1
Split a given string on asterisk into several substrings and display each substring in Python
Write a Python program to count all lower case, upper case, digits, and special symbols from a given string
Write a python program to return a string such that the string is arranged from lowercase letters and then uppercase letters
Write a Python Class to Reverse a String Word by Word
Write a python class to implement pow(x, n)
Write a python class to convert an integer to a Roman numeral
Write a python program to find the factorial of a number using recursion
Write a Python program to convert temperature in Celsius to Fahrenheit
Write a Python program to find the largest number among the three input numbers
Write a Python program to print only even numbers using the function
Write a python program to filter integer, float, string from a list
Write a python program to check whether the given number is greater than 50 and also divisible by 2 using nested if else
Write a python program to demonstrate a simple class creation
Write a python program to demonstrate the object as an argument
Write a python program to demonstrate an object as an argument with default values
Write a python program to demonstrate method overriding
Write a Python program for Linear Search and Binary Search
Python list - insert, remove, append, len, pop and clear example
Write a python program to add two numbers
Write a python program to get the python version
Write a python program to check whether the first and last letters of the given word is vowel or not ?
Write a python program to count the number of digits
Write a python program to filter integer, float, string from a list
Write a python program to find the average of 10 numbers
Write a python program to traverse a list and print the values in it
Write a python program to print first 20 natural numbers using while loop
Write a python program to print the square of all numbers from 1 to 10
Write a python program to get the sum of digits
Write a python program to print right angle triangle pattern using *
Write a python program to remove vowels in a word
Write a python program to find absolute value using function
Wrtie a python program to demonstrate the use of variable length arguments
Write a python program to demonstrate the use of default arguments
Write a python program to demonstrate the use of keyword arguments
Write a python program to print a simple list using functions
Write a python program to find the max values in a list using function
Given a string of odd length greater 7, return a string made of the middle three chars of a given String
Arrange string characters such that lowercase letters should come first
Write a Python program to Count all lower case, upper case, digits, and special symbols from a given string
Write a Python program to Find all occurrences in a given string ignoring the case
Given an input string, count occurrences of all characters within a string and return the details as dictionary
Write a Python program to Split a given string on asterisk into several substrings and display each substring
Write a Python program to Check whether the given string startswith 'h'
Write a python program to concatenate strings in different ways
Write a python program to return a string such that the string is arranged from lowercase letters and then uppercase letters
Write a python program to repeat a givent string multiple times
Write a python program to create a simple list and nested list with different datatypes
Write a python program to add elements to an existing list from user input
Write a python program to reverse a given list
Write a python program to convert a list to tuple using tuple function
Write a python program to check whether the user given input is equal to the current working directory or not
Write a Python program for Linear Search and Binary Search
Selection Sort Algorithm in Python
Bubble Sort Algorithm in Python
Bogo Sort Algorithm in Python
Bucket Sort Algorithm in Python
Comb Sort Algorithm in Python
Counting Sort Algorithm in Python
Heap Sort Algorithm in Python
Insertion Sort Algorithm in Python
Merge Sort Algorithm in Python
Quick Sort Algorithm in Python
Shell Sort Algorithm in Python
Interpolation Search Algorithm in Python
Stack Implementation in Python
Queue Implementation in Python
Deque Implementation in Python
Singly Linked List Implementation in Python
Doubly Linked List Implementation in Python
Circular Linked List Implementation in Python
PriorityQueue Implementation in Python
Circular Queue Implementation in Python
Binary Search Tree Implementation in Python
Stack Implementation Using Linked List in Python
Stack Implementation Using Doubly Linked List in Python
Python - Convert Binary to Decimal Example
Python - Convert Binary to Hexadecimal Example
Python - Convert Binary to Octal Example
Python - Convert Decimal to Binary Example
Python - Convert Decimal to Octal Example
Python Convert String to Int
Python Convert String to DateTime
Python Convert String to Date
Python Convert String to JSON
Python Convert String to Number
Python Convert String to List
Python Convert String to Float
Python Convert String to Bytes
Python Convert List to String
Python Convert List to Set
Python Convert List to Dictionary
Python Convert List to Tuple
Python Convert List to JSON
Python Convert List to Array
Python Convert List to String With Commas
Python Convert List to Dataframe
Python Convert Set to List
Python Convert Set to String
Python Convert Set to Tuple
Python Convert Set to Dictionary
Python Convert Set to JSON
Python Convert Set to Comma Separated String
Python Convert Dictionary to JSON
Python Convert Dictionary to Dataframe
Python Convert Dictionary to String
Python Convert Dictionary to List
Python Convert Dictionary Keys to List
Python Convert Dictionary Values to List
Python Convert Dictionary to Tuple
Python Convert Array to String
Python Convert Array to String With Commas
Python Convert Array to List
Python Convert Array to Set
Python Convert Array to JSON
Python Convert Array to Dictionary
Python Convert Array to Tuple
Python Convert Int to String
Python Convert Int to Binary
Python Convert Int to Float
Python Convert Date to String
Python Convert Date to Epoch
Python Convert Date to Unix Timestamp
Python Convert Date to DateTime
Python Convert Date to DateTime
Python Convert Date to Timestamp
Python Convert Date String to DateTime
Python Convert Date String to Epoch
Python Convert Tuple to String
Python Convert Tuple to List
Python Convert Tuple to Dictionary
Python Convert Tuple to Comma Separated String
Python Convert Tuple to Array
Python Convert Tuple to JSON
Python Convert JSON to String
Python Convert JSON to Dictionary
Python Convert JSON to Array
Python Convert JSON to XML
Python Convert JSON to List
Python
Python Design Patterns
Comments
Post a Comment