Как проверить, содержит ли словарь в Python только определенные типы

Введение

В этом практическом занятии (lab) вы научитесь проверять, содержит ли словарь (dictionary) на Python только определенные типы для своих ключей и значений. В рамках этого занятия акцент делается на понимании важности проверки типов в словарях для обеспечения целостности данных.

Вы начнете с создания примерного словаря и изучения концепции проверки типов. Затем вы узнаете, как использовать функцию isinstance() вместе с функцией all() для проверки того, что все ключи и значения в словаре соответствуют ожидаемым типам данных. Этот практический опыт предоставит вам навыки для проверки содержимого словаря и поддержания надежности кода.

Skills Graph

Понимание проверки типов в словарях

На этом этапе мы рассмотрим важность проверки типов в словарях (dictionaries) на Python. Словарь представляет собой гибкую структуру данных, которая может хранить пары ключ-значение. Однако, чтобы обеспечить целостность и надежность вашего кода, важно понимать, как проверять типы ключей и значений, хранящихся в словаре.

В Python словари определяются с использованием фигурных скобок {}. Каждый элемент в словаре состоит из ключа и соответствующего значения, разделенных двоеточием :.

Начнем с создания простого словаря:

## Create a dictionary
my_dict = {
    "name": "Alice",
    "age": 30,
    "city": "New York"
}

print(my_dict)

Сохраните приведенный выше код в файле с именем type_checking.py в директории ~/project. Вы можете использовать редактор VS Code для создания и редактирования этого файла.

Теперь выполните скрипт, используя следующую команду в терминале:

python ~/project/type_checking.py

Вы должны увидеть следующий вывод:

{'name': 'Alice', 'age': 30, 'city': 'New York'}

В этом словаре ключи являются строками ("name", "age", "city"), а значения - это строка ("Alice"), целое число (30) и еще одна строка ("New York").

Проверка типов становится важной, когда вы хотите убедиться, что данные, хранящиеся в вашем словаре, соответствуют вашим ожиданиям. Например, вы можете хотеть проверить, что возраст всегда является целым числом или что имя всегда является строкой.

Рассмотрим сценарий, когда вы хотите добавить новую пару ключ-значение в словарь, но при этом убедиться, что значение имеет определенный тип.

Откройте файл type_checking.py в VS Code и измените его следующим образом:

## Create a dictionary
my_dict = {
    "name": "Alice",
    "age": 30,
    "city": "New York"
}

## Function to add a key-value pair with type checking
def add_item(dictionary, key, value, expected_type):
    if isinstance(value, expected_type):
        dictionary[key] = value
        print(f"Added {key}: {value} to the dictionary.")
    else:
        print(f"Error: {key} must be of type {expected_type.__name__}.")

## Example usage
add_item(my_dict, "occupation", "Engineer", str)
add_item(my_dict, "salary", 75000, int)
add_item(my_dict, "is_active", True, bool)
add_item(my_dict, "height", "5.8", float) ## Intentionally incorrect type

print(my_dict)

В этом коде мы определяем функцию add_item, которая принимает словарь, ключ, значение и ожидаемый тип в качестве входных параметров. Функция использует функцию isinstance() для проверки, является ли значение ожидаемого типа. Если это так, пара ключ-значение добавляется в словарь. В противном случае выводится сообщение об ошибке.

Выполните скрипт еще раз:

python ~/project/type_checking.py

Вы должны увидеть следующий вывод:

Added occupation: Engineer to the dictionary.
Added salary: 75000 to the dictionary.
Added is_active: True to the dictionary.
Error: height must be of type float.
{'name': 'Alice', 'age': 30, 'city': 'New York', 'occupation': 'Engineer', 'salary': 75000, 'is_active': True}

Как вы можете видеть, функция add_item успешно добавила пары ключ-значение "occupation", "salary" и "is_active" в словарь, так как их значения соответствовали ожидаемым типам. Однако, для "height" была выведена ошибка, потому что предоставленное значение ("5.8") является строкой, в то время как ожидаемый тип был float.

Этот пример демонстрирует базовую концепцию проверки типов в словарях. В следующих шагах мы рассмотрим более продвинутые техники обеспечения безопасности типов в вашем коде на Python.

Проверка типов ключей и значений

На предыдущем этапе мы узнали, как проверять тип значений при добавлении их в словарь. Теперь давайте углубимся и рассмотрим, как проверить типы как ключей, так и значений в словаре.

Важно убедиться, что ключи в словаре являются неизменяемыми типами, такими как строки, числа или кортежи. Значения, с другой стороны, могут быть любого типа. Давайте изменим наш файл type_checking.py, чтобы включить проверку типа ключей.

Откройте файл type_checking.py в VS Code и измените его следующим образом:

## Create a dictionary
my_dict = {
    "name": "Alice",
    "age": 30,
    "city": "New York"
}

## Function to add a key-value pair with type checking for both key and value
def add_item(dictionary, key, value, expected_key_type, expected_value_type):
    if not isinstance(key, expected_key_type):
        print(f"Error: Key must be of type {expected_key_type.__name__}.")
        return
    if not isinstance(value, expected_value_type):
        print(f"Error: Value must be of type {expected_value_type.__name__}.")
        return
    dictionary[key] = value
    print(f"Added {key}: {value} to the dictionary.")

## Example usage
add_item(my_dict, "occupation", "Engineer", str, str)
add_item(my_dict, "salary", 75000, str, int)
add_item(my_dict, 123, "Some Value", str, str) ## Intentionally incorrect key type

print(my_dict)

В этом обновленном коде функция add_item теперь принимает expected_key_type и expected_value_type в качестве аргументов. Она проверяет, являются ли предоставленные ключ и значение ожидаемых типов, используя функцию isinstance(). Если ключ или значение имеют неправильный тип, выводится сообщение об ошибке, и функция завершает работу без добавления элемента в словарь.

Теперь выполните скрипт:

python ~/project/type_checking.py

Вы должны увидеть следующий вывод:

Added occupation: Engineer to the dictionary.
Added salary: 75000 to the dictionary.
Error: Key must be of type str.
{'name': 'Alice', 'age': 30, 'city': 'New York', 'occupation': 'Engineer', 'salary': 75000}

Вывод показывает, что пары ключ-значение "occupation" и "salary" были успешно добавлены в словарь, так как и их ключи, и значения соответствовали ожидаемым типам. Однако, когда мы попытались добавить пару ключ-значение с целочисленным ключом (123), функция вывела сообщение об ошибке, так как ожидаемый тип ключа был str.

Проверка типов как ключей, так и значений помогает сохранить согласованность и правильность ваших данных. Это предотвращает непредвиденные ошибки и обеспечивает ожидаемое поведение вашего словаря.

Использование функции all() вместе с isinstance()

На этом этапе мы рассмотрим, как использовать функцию all() в сочетании с isinstance() для эффективной проверки типов всех ключей и значений в словаре. Этот подход особенно полезен, когда вам нужно проверить весь словарь на соответствие заданным ожидаемым типам.

Функция all() в Python возвращает True, если все элементы итерируемого объекта являются истинными. Мы можем использовать эту функцию для перебора элементов словаря и проверки, соответствуют ли все ключи и значения ожидаемым типам.

Давайте изменим наш файл type_checking.py, чтобы включить этот подход.

Откройте файл type_checking.py в VS Code и измените его следующим образом:

## Create a dictionary
my_dict = {
    "name": "Alice",
    "age": 30,
    "city": "New York"
}

## Function to check types of all keys and values in a dictionary
def check_dictionary_types(dictionary, expected_key_type, expected_value_type):
    key_types_correct = all(isinstance(key, expected_key_type) for key in dictionary)
    value_types_correct = all(isinstance(value, expected_value_type) for value in dictionary.values())

    if key_types_correct and value_types_correct:
        print("All keys and values have the correct types.")
        return True
    else:
        print("Not all keys and values have the correct types.")
        return False

## Example usage
check_dictionary_types(my_dict, str, (str, int)) ## Expecting keys to be strings and values to be either strings or integers

my_dict["zip"] = "10001"
check_dictionary_types(my_dict, str, (str, int))

my_dict["country"] = 123
check_dictionary_types(my_dict, str, (str, int))

В этом коде функция check_dictionary_types принимает словарь, ожидаемый тип ключа и ожидаемый тип значения в качестве входных параметров. Она использует функцию all() с генераторным выражением для проверки, являются ли все ключи ожидаемого типа и все значения ожидаемого типа. Если оба условия выполняются, выводится сообщение об успехе и возвращается True. В противном случае выводится сообщение об ошибке и возвращается False.

Выполните скрипт:

python ~/project/type_checking.py

Вы должны увидеть следующий вывод:

All keys and values have the correct types.
All keys and values have the correct types.
Not all keys and values have the correct types.

Первый вызов функции check_dictionary_types возвращает True, так как все ключи являются строками, а все значения - либо строками, либо целыми числами. Второй вызов также возвращает True после добавления ключа "zip". Однако, третий вызов возвращает False после добавления ключа "country" с целочисленным значением, так как теперь один из ключей является целым числом, что нарушает ожидаемый тип ключа.

Использование функции all() вместе с isinstance() предоставляет лаконичный и эффективный способ проверки типов всех элементов в словаре, обеспечивая целостность данных и предотвращая непредвиденные ошибки в вашем коде на Python.

Резюме

В этом практическом занятии мы начали с понимания важности проверки типов в словарях Python, которые представляют собой гибкие структуры данных для хранения пар ключ-значение. Мы создали примерный словарь со строковыми ключами и значениями смешанного типа (строки и целые числа) и подчеркнули необходимость обеспечения целостности данных путем проверки типов ключей и значений.

Первый этап показал важность проверки типов, чтобы убедиться, что данные, хранящиеся в словаре, соответствуют ожидаемым типам. Например, чтобы убедиться, что возраст всегда является целым числом, а имя - строкой. В рамках практического занятия мы создали файл type_checking.py и запустили его, чтобы отобразить содержимое словаря.