Есть ли веская причина принимать в функции Python число с плавающей запятой, а не int?
В большой библиотеке у меня была «ошибка», потому что функция, которая принимает только float, но не int
def foo(penalty: float):
if not isinstance(penalty, float):
raise ValueError(f"`penalty` has to be a float, but is {penalty}")
# some instruction
Я хотел бы открыть PR со следующим:
def foo(penalty: int | float):
if not isinstance(penalty, (int,float)):
raise ValueError(f"`penalty` has to be a float or int, but is {penalty}")
# some instruction
но перед этим я спрашиваю себя: Есть ли веская причина в Python принимать float, но не int?
В конце концов, речь действительно идет о «той библиотеке». Никто здесь не может сказать вам, каковы их требования. И помните, что есть еще тип complex... так что, что касается вашей идеи, просто создайте пиар и посмотрите, что произойдет. Помимо этого... я не могу придумать конкретную причину для этого, но у людей много идей. Может быть, кто-то действительно хочет убедиться, что приходят только числа с плавающей запятой. Где, ну: если так, то это было бы неудобно, и это должно быть объяснено где-то в этом коде.
Вам также следует изменить аннотацию типа в вашем PR.
@MichaelButscher да, хорошее замечание.
Библиотека, о которой идет речь, — трансформеры (от обнимающего лица). Я не хотел писать это в вопросе, чтобы быть общим. Я создам пиар и посмотрю, что произойдет.
Возможно, int может иметь неявное значение, отличное от контекста вызова, но в большинстве случаев int подойдет для того же, что и float.
@MichaelButscher В этом нет необходимости. int уже совместим сfloat.
Ответы 1
Причин может быть несколько:
У чисел с плавающей запятой есть методы, которых нет у целых чисел. Например, методы
fromhexилиhexсуществуют для объектовfloat, но не для объектовint. Если функция использует такие методы, принятие целого числа приведет к сбою.Иногда числа с плавающей запятой особенно необходимы при работе с внешними функциями, например, функция, ожидающая C
double,floatподходит для этой цели, аint— нет.Другие типы принимаются
isinstanceпроверкамиint, напримерboolобъектов, что может быть нежелательно.В Python2 арифметика с целыми числами иногда может давать другие результаты, чем при использовании числа с плавающей запятой. Если библиотека обратно совместима (или была) с Python2, это может быть артефактом этого факта.
Функция может явно ожидать значения, которое может быть выражено только как число с плавающей запятой. Например, если функция ожидает значение от 0 до 1 (не включительно), целое число никогда не будет иметь смысла.
Предположительно, функция могла бы просто преобразовать целое число в число с плавающей запятой по мере необходимости:
if isinstance(arg, int):
arg = float(arg)
Но для производительности, возможно, лучше выдать ошибку и сообщить пользователю, что требуется число с плавающей запятой (поэтому, возможно, пользователь может использовать число с плавающей запятой для начала).
Спасибо за Ваш ответ. После беглого просмотра кода библиотека выполняет с ним только базовые операции (+,/,*), поэтому я думаю, что можно также принять и int. Но ваш ответ полон идей, которые полезно знать.
По крайней мере, для Python 3.x (2.x имело целочисленное деление), если число не передается в скомпилированный модуль расширения (где такая гибкая проверка типов требует больше работы), я не вижу причин отвергать int.