Python dictionary pop() method removes and returns the specified element from the dictionary.
Python Dictionary pop() Method
Syntax: dict.pop(key, def)
Parameters :
- key : The key whose key-value pair has to be returned and removed.
- def : The default value to return if specified key is not present.
Returns :
- The value associated with the deleted key-value pair, if the key is present.
- Default value if specified if key is not present.
- KeyError, if key not present and default value not specified.
Example of Python Dictionary pop() method
Example 1: Pop an element from the dictionary
Python3
# Python 3 code to demonstrate # working of pop() # initializing dictionary test_dict = { "Nikhil" : 7 , "Akshat" : 1 , "Akash" : 2 } # Printing initial dict print ( "The dictionary before deletion : " + str (test_dict)) # using pop to return and remove key-value pair. pop_ele = test_dict.pop( 'Akash' ) # Printing the value associated to popped key print ( "Value associated to popped key is : " + str (pop_ele)) # Printing dictionary after deletion print ( "Dictionary after deletion is : " + str (test_dict)) |
Output :
The dictionary before deletion : {'Nikhil': 7, 'Akshat': 1, 'Akash': 2}
Value associated to popped key is : 2
Dictionary after deletion is : {'Nikhil': 7, 'Akshat': 1}
Example 2: Python Dictionary pop first element
Python3
# Python 3 code to demonstrate # working of pop() # initializing dictionary test_dict = { "Nikhil" : 7 , "Akshat" : 1 , "Akash" : 2 } # Printing initial dict print ( "The dictionary before deletion : " + str (test_dict)) # using pop to return and remove key-value pair. pop_first = test_dict.pop( "Nikhil" ) # Printing the value associated to popped key print ( "Value associated to popped key is : " + str (pop_first)) # Printing dictionary after deletion print ( "Dictionary after deletion is : " + str (test_dict)) |
Output:
The dictionary before deletion : {'Nikhil': 7, 'Akshat': 1, 'Akash': 2}
Value associated to popped key is : 7
Dictionary after deletion is : {'Akshat': 1, 'Akash': 2}
Example 3: Pop an element not present from the dictionary
The behavior of pop() function is different when the key is not present in dictionary. In this case, it returns the default provided value or KeyError in case even default is not provided.
Python3
# Python 3 code to demonstrate # working of pop() without key # initializing dictionary test_dict = { "Nikhil" : 7 , "Akshat" : 1 , "Akash" : 2 } # Printing initial dict print ( "The dictionary before deletion : " + str (test_dict)) # using pop to return and remove key-value pair # provided default pop_ele = test_dict.pop( 'Manjeet' , 4 ) # Printing the value associated to popped key # Prints 4 print ( "Value associated to popped key is : " + str (pop_ele)) # using pop to return and remove key-value pair # not provided default pop_ele = test_dict.pop( 'Manjeet' ) # Printing the value associated to popped key # KeyError print ( "Value associated to popped key is : " + str (pop_ele)) |
Output :
The dictionary before deletion : {'Nikhil': 7, 'Akshat': 1, 'Akash': 2}
Value associated to popped key is : 4
Traceback (most recent call last):
File "main.py", line 20, in
pop_ele = test_dict.pop('Manjeet')
KeyError: 'Manjeet'