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

Метод 1: использование подсказки типа «Нет»

Самый простой способ аннотировать функцию void — использовать подсказку типа «Нет». Поскольку функции void не возвращают значение, мы можем использовать «None» для обозначения такого поведения. Вот пример:

from typing import NoneType
def greet() -> NoneType:
    print("Hello, world!")

Метод 2: использование подсказки типа «NoReturn»

Другой подход — использовать подсказку типа «NoReturn», которая указывает, что функция не возвращает нормальный результат. Это полезно, когда функция вызывает исключение или завершает программу. Вот пример:

from typing import NoReturn
def divide(a: int, b: int) -> NoReturn:
    if b == 0:
        raise ValueError("Cannot divide by zero!")
    result = a / b
    print(f"The result is: {result}")

Метод 3: отсутствие подсказки о типе возвращаемого значения

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

def log_message(message: str):
    print(f"Log: {message}")

Метод 4. Использование модуля typing_extensions

Если вам необходимо поддерживать более старые версии Python, не имеющие подсказки типа «NoReturn», вы можете использовать модуль «typing_extensions», который обеспечивает совместимость со старыми версиями Python. Вот пример:

from typing import Optional
from typing_extensions import NoReturn
def process_data(data: Optional[str]) -> NoReturn:
    if data is None:
        print("No data provided.")
        return
    # Process the data

В этой статье мы рассмотрели несколько методов аннотирования void-функций с помощью модуля типизации Python. Мы обсудили использование подсказок типов «None» и «NoReturn», полный отказ от подсказки типа возвращаемого значения и использование модуля «typing_extensions» для совместимости. Включив подсказки типов в свой код, вы можете улучшить его читабельность и включить статическую проверку типов, что приведет к повышению удобства сопровождения и уменьшению количества ошибок.

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