Python check if element in dict

Check if Key exists in Dictionary – Python

In this article we will discuss six different ways to check if key exists in a Dictionary in Python.

Table of Contents

Suppose we have a dictionary of string and int i.e.

# Dictionary of string and int word_freq =

Now we want to check if key ‘test’ exist in this dictionary or not.

There are different ways to do this. Let’s discuss them one by one.

Check if key in Python Dictionary using if-in statement

We can directly use the ‘in operator’ with the dictionary to check if a key exist in dictionary or nor. The expression,

Frequently Asked:

Will evaluate to a boolean value and if key exist in dictionary then it will evaluate to True, otherwise False. Let’s use this to check if key is in dictionary or not. For example,

# Dictionary of string and int word_freq = < "Hello": 56, "at": 23, "test": 43, "this": 78 >key = 'test' # python check if key in dict using "in" if key in word_freq: print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary")

Yes, key: 'test' exists in dictionary

Here it confirms that the key ‘test’ exist in the dictionary.

Now let’s test a negative example i.e. check if key ‘sample’ exist in the dictionary or not i.e.

# Dictionary of string and int word_freq = < "Hello": 56, "at": 23, "test": 43, "this": 78 >key = 'sample' # python check if key in dict using "in" if key in word_freq: print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary")

No, key: 'sample' does not exists in dictionary

Here it confirms that the key ‘sample’ does not exist in the dictionary.

Check if Dictionary has key using get() function

In python, the dict class provides a method get() that accepts a key and a default value i.e.

Behavior of this function,

• If given key exists in the dictionary, then it returns the value associated with this key,
• If given key does not exists in dictionary, then it returns the passed default value argument.
• If given key does not exists in dictionary and Default value is also not provided, then it returns None.

Let’s use get() function to check if given key exists in dictionary or not,

# Dictionary of string and int word_freq = < "Hello": 56, "at": 23, "test": 43, "this": 78 >key = 'sample' # check if key exists in dictionary by checking if get() returned None if word_freq.get(key) is not None: print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary")

No, key: 'sample' does not exists in dictionary

Here it confirmed that the key ‘sample’ does not exist in the dictionary.

We passed ‘sample’ argument in the get() function, without any default value. As our dictionary does not contain ant key ‘sample’ and no default value is provided, therefore it returned None.

If we pass the default value along with the key and if key does not exist in the dictionary, then it returns the default value. For example,

key = 'sample' # check if key exists in dictionary by checking if get() returned default value if word_freq.get(key, -1) != -1: print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary")

No, key: 'sample' does not exists in dictionary

Here it confirmed that the key ‘sample’ does not exist in the dictionary.

We passed ‘sample’ argument in the get() function, along with the default value -1. As our dictionary does not contain ant key ‘sample’, so get() function returned the the default value.

We cannot always be sure with the result of dict.get(), that key exists in dictionary or not . Therefore, we should use dict.get() to check existence of key in dictionary only if we are sure that there cannot be an entry of key with given default value.

Check if key in Python Dictionary using keys()

keys() function of the dictionary returns a sequence of all keys in the dictionary. So, we can use ‘in’ keyword with the returned sequence of keys to check if key exist in the dictionary or not. For example,

word_freq = < "Hello": 56, "at": 23, "test": 43, "this": 78 >key = 'test' if key in word_freq.keys(): print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary")

Yes, key: 'test' exists in dictionary

Here it confirms that the key ‘test’ exist in the dictionary.

Check if key in Python Dictionary using try/except

If we try to access the value of key that does not exist in the dictionary, then it will raise KeyError. This can also be a way to check if exist in dict or not i.e.

def check_key_exist(test_dict, key): try: value = test_dictPython check if element in dict return True except KeyError: return False # Dictionary of string and int word_freq = < "Hello": 56, "at": 23, "test": 43, "this": 78 >key = 'test' # check if dictionary has key in python if check_key_exist(word_freq, key): print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary")

Yes, key: 'test' exists in dictionary

Here it confirms that the key ‘test’ exist in the dictionary.

In function check_key_exist(), it access the value of given key. If key does not exist then KeyError occurs, in that case it returns False, otherwise it returns True

Check if key not in Python Dictionary using ‘if not in’ statement

In all the above example, we checked if key exist in dictionary or not. But if want to check if key doesn’t exist in dictionary then we can directly use ‘not in’ with dictionary i.e.

word_freq = < "Hello": 56, "at": 23, "test": 43, "this": 78 >key = 'sample' # Check if key not in dict python if key not in word_freq: print(f"No, key: '' does not exists in dictionary") else: print(f"Yes, key: '' exists in dictionary")

No, key: 'sample' does not exists in dictionary

Here it confirms that the key ‘test’ exist in the dictionary.

Check if key exist in Python Dictionary using has_key()

dict provides a function has_key() to check if key exist in dictionary or not. But this function is discontinued in python 3. So, below example will run in python 2.7 only i.e.

if word_freq.has_key('test'): print("Yes 'test' key exists in dict") else: print("No 'test' key does not exists in dict")

Yes, key: 'test' exists in dictionary

Here it confirms that the key ‘test’ exist in the dictionary.

The complete example is as follows.

def check_key_exist(test_dict, key): try: value = test_dictPython check if element in dict return True except KeyError: return False def main(): # Dictionary of string and int word_freq = < "Hello": 56, "at": 23, "test": 43, "this": 78 >print("*** Python: check if key in dictionary using if-in statement***") key = 'test' # python check if key in dict using "in" if key in word_freq: print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary") key = 'sample' # python check if key in dict using "in" if key in word_freq: print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary") print("*** Python: check if dict has key using get() function ***") key = 'sample' # check if key exists in dictionary by checking if get() returned None if word_freq.get(key) is not None: print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary") key = 'sample' # check if key exists in dictionary by checking if get() returned default value if word_freq.get(key, -1) != -1: print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary") print('python check if key in dict using keys()') key = 'test' if key in word_freq.keys(): print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary") print('python check if key in dict using try/except') print('python check if key in dictionary using try/except') key = 'test' # check if dictionary has key in python if check_key_exist(word_freq, key): print(f"Yes, key: '' exists in dictionary") else: print(f"No, key: '' does not exists in dictionary") print('check if key not in dictionary in python using if not in statement') key = 'sample' # Check if key not in dict python if key not in word_freq: print(f"No, key: '' does not exists in dictionary") else: print(f"Yes, key: '' exists in dictionary") print('check if key not in dictionary in python using has_keys') if __name__ == '__main__': main()

*** Python: check if key in dictionary using if-in statement*** Yes, key: 'test' exists in dictionary No, key: 'sample' does not exists in dictionary *** Python: check if dict has key using get() function *** No, key: 'sample' does not exists in dictionary No, key: 'sample' does not exists in dictionary python check if key in dict using keys() Yes, key: 'test' exists in dictionary python check if key in dict using try/except python check if key in dictionary using try/except Yes, key: 'test' exists in dictionary check if key not in dictionary in python using if not in statement No, key: 'sample' does not exists in dictionary check if key not in dictionary in python using has_keys

Related posts:

Источник

How to check if key exists in a python dictionary?

In this tutorial, we look at methods to check if a key exists in a dictionary in Python. We also break down the code to facilitate further understanding.

However, in case you are here only for the solution use this link.

Table of Contents — check if key exists in dictionary python

If you are here to learn how to check if a key exists in a dictionary in python it is most likely because of these two reasons. Either you are new to python or you tried using the has_key methods and received an error.

The latter is because python3 has removed the has_key methods. However, there are other equally efficient methods to check if a key exists in a dictionary.

Why do we check if a key exists in a python dictionary?

Dictionaries are common and extensively used data types in python. They are used to store key-value pairs and these values are accessed by their respective keys.

This is why it is a good practice to check if the key exists before you try to access its relevant value. Doing so would reduce the likelihood of facing errors.

Now let’s look at the different ways you can use to check if a key exists in a dictionary in Python.

Using the in operator to check if key exists in dictionary python:

In this method, we use the membership operator; in . This operator is used to check if one value is a member of another. It returns a boolean value.

In our case, we use the in operator to check if the key is a member of the dictionary.

Code to check if a key exists in dictionary in python:

dict_1 = if "a" in dict_1: print("Exists") else: print("Does not exist") #Output = "Exists" 

dict_1 = if "d" in dict_1: print("Exists") else: print("Does not exist") #Output = "Does not exist" 

Similarly, the not in operator can also be used to check if a key does not exist in a dictionary.

However, remember the in operator is case sensitive hence you could either ensure all your keys are in the same case or you could use the upper() or lower() methods respectively.

Checking if key exists using the get() method

The get() method is a dictionary method that returns the value of the associated key. If the key is not present it returns either a default value (if passed) or it returns None.

Using this method we can pass a key and check if a key exists in the python dictionary.

Syntax of get()

Here dict is the name of the dictionary you intent to work with

Parameters

Keyname — The keyname of the value to intent to return value — Optional, this value is returned in case the key does not exist

Code to check if the key exists in a dictionary using get()

dict_1 = if dict_1.get("a") is not None: print("Exists") else: print("Does not exist") #Output = "Exists" 

dict_1 = if dict_1.get("d") is not None: print("Exists") else: print("Does not exist") #Output = "Does not exist" 

While using this method keep in mind that this would not be accurate in case you have a key with the value None. If you don’t, this method will work fine.

This method returns the values, you could store them in a variable in case you intend to use it.

Closing Thoughts

Although both the aforementioned methods have their limitations, these are more efficient in comparison to the other methods.

Other methods include iterating over the dictionary and then comparing all the keys with a variable containing the key name.

Although all those methods work, they aren’t efficient and should only be used to facilitate understanding of the concepts. But in case you are a learner, do try them out.

Источник