Skip to content

Commit

Permalink
fix type error in pyfloat when max_value is None (#1908)
Browse files Browse the repository at this point in the history
  • Loading branch information
@HugoJP1
HugoJP1 authored Sep 19, 2023
1 parent 7acf718 commit d2ce122
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 29 deletions.
90 changes: 62 additions & 28 deletions faker/providers/python/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,11 +161,21 @@ def pyfloat(
raise ValueError("Max value must fit within left digits")
if left_digits is not None and min_value and math.ceil(math.log10(abs(min_value))) > left_digits:
raise ValueError("Min value must fit within left digits")
if max_value is not None and max_value < -(10**sys.float_info.dig + 1):
raise ValueError(f"Max value must be greater than {-10**sys.float_info.dig - 1}")
if min_value is not None and min_value > 10**sys.float_info.dig - 1:
raise ValueError(f"Min value must be less than {10**sys.float_info.dig - 1}")

left_digits_requested = left_digits is not None
right_digits_requested = right_digits is not None
# Make sure at least either left or right is set
if left_digits is None and right_digits is None:
needed_left_digits = max(1, math.ceil(math.log10(max(abs(max_value or 1), abs(min_value or 1)))))
right_digits = self.random_int(1, sys.float_info.dig - needed_left_digits)
if (sys.float_info.dig - needed_left_digits) < 1:
right_digits = 0
else:
right_digits = self.random_int(1, sys.float_info.dig - needed_left_digits)


# If only one side is set, choose #digits for other side

Check failure on line 180 in faker/providers/python/__init__.py

View workflow job for this annotation

GitHub Actions / flake8 

too many blank lines (2)
if (left_digits is None) ^ (right_digits is None):
Expand All @@ -181,32 +191,67 @@ def pyfloat(
f"{sys.float_info.dig})",
)

sign = ""
if (min_value is not None) or (max_value is not None):
# Copy values to ensure we're not modifying the original values and thus going out of bounds
left_min_value = min_value
left_max_value = max_value
temp_min_value = min_value
temp_max_value = max_value
# Make sure left_digits still respected
if left_digits is not None:
if max_value is None:
left_max_value = 10**left_digits # minus smallest representable, adjusted later
if min_value is None:
left_min_value = -(10**left_digits) # plus smallest representable, adjusted later
if max_value is None:
temp_max_value = 10 ** (left_digits + right_digits)
if min_value is not None:
temp_min_value = min_value * 10 ** right_digits
if min_value is None:
temp_min_value = -(10 ** (left_digits + right_digits))
if max_value is not None:
if max_value < temp_min_value:
temp_min_value = max_value - 1
temp_max_value = max_value * 10 ** right_digits

if max_value is not None and max_value < 0:
left_max_value += 1 # as the random_int will be generated up to max_value - 1
temp_max_value += 1 # as the random_int will be generated up to max_value - 1
if min_value is not None and min_value < 0:
left_min_value += 1 # as we then append digits after the left_number
left_number = self._safe_random_int(
left_min_value,
left_max_value,
positive,
temp_min_value += 1 # as we then append digits after the left_number

opposite_signs = (temp_min_value * temp_max_value) < 0
if opposite_signs and left_digits_requested:
positive_number = self._safe_random_int(
10 ** (left_digits + right_digits - 1),
temp_max_value,
positive=True,
)
negative_number = self._safe_random_int(
temp_min_value,
-(10 ** (left_digits + right_digits - 1)),
positive=False,
)
number = self.random_element((positive_number, negative_number))
else:
number = self._safe_random_int(
temp_min_value,
temp_max_value,
positive,
)

params_requested = (
right_digits_requested or left_digits_requested or ((min_value is None) ^ (max_value is None))
)
if params_requested:
result = (
float(f"{str(number)[:-right_digits]}.{str(number)[-right_digits:]}")
if right_digits
else float(number)
)
else:
fix_right_digits_len = right_digits > 0
result = float(f"{number}.{self.random_number(right_digits, fix_len=fix_right_digits_len)}")

else:
sign = "+" if positive else self.random_element(("+", "-"))
left_number = self.random_number(left_digits)
fix_left_digits_len = left_digits > 0
left_number = self.random_number(left_digits, fix_len=fix_left_digits_len)
fix_right_digits_len = right_digits > 0
result = float(f"{sign}{left_number}.{self.random_number(right_digits, fix_len=fix_right_digits_len)}")

result = float(f"{sign}{left_number}.{self.random_number(right_digits)}")
if positive and result == 0:
if right_digits:
result = float("0." + "0" * (right_digits - 1) + "1")
Expand All @@ -220,17 +265,6 @@ def pyfloat(
result = min(result, 10**left_digits - 1)
result = max(result, -(10**left_digits + 1))

# It's possible for the result to end up > than max_value or < than min_value
# When this happens we introduce some variance so we're not always the exactly the min_value or max_value.
# Which can happen a lot depending on the difference of the values.
# Ensure the variance is bound by the difference between the max and min
if max_value is not None:
if result > max_value:
result = result - (result - max_value + self.generator.random.uniform(0, max_value - min_value))
if min_value is not None:
if result < min_value:
result = result + (min_value - result + self.generator.random.uniform(0, max_value - min_value))

return result

def _safe_random_int(self, min_value: float, max_value: float, positive: bool) -> int:
Expand Down
29 changes: 28 additions & 1 deletion tests/providers/test_python.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ def test_min_value_and_left_digits(self):
self.assertGreaterEqual(result, 0)

def test_max_value(self):
max_values = (0, 10, -1000, 1000, 999999)
max_values = (0, 10, -1000, 1000, 999999, 100000000000001.0, -1000000000000001.0)

for max_value in max_values:
result = self.fake.pyfloat(max_value=max_value)
Expand Down Expand Up @@ -210,6 +210,33 @@ def test_max_and_min_value_positive_with_decimals(self):
self.assertLessEqual(result, 200.321)
self.assertGreaterEqual(result, 100.123)

def test_max_none_and_min_value_with_decimals(self):
"""
Combining the max_value and min_value keyword arguments with
positive value for min and None for max produces numbers with
left and right digits specified produced numbers greater than
the supplied min_value.
"""
for _ in range(1000):
result = self.fake.pyfloat(min_value=99884.7, max_value=None, left_digits=5, right_digits=2)
self.assertGreaterEqual(result, 99884.7)
assert len(str(result).strip("-").split(".")[0]) == 5
assert len(str(result).strip("-").split(".")[1]) <= 2

def test_min_none_and_max_value_with_decimals(self):
"""
Combining the max_value and min_value keyword arguments with
positive value for max and None for min produces numbers with
left and right digits specified produced numbers greater than
the supplied min_value.
"""
for _ in range(1000):
result = self.fake.pyfloat(min_value=None, max_value=11000.3, left_digits=5, right_digits=2)
self.assertLessEqual(result, 11000.3)
assert len(str(result).strip("-").split(".")[0]) == 5
assert len(str(result).strip("-").split(".")[1]) <= 2


def test_max_and_min_value_negative(self):

Check failure on line 240 in tests/providers/test_python.py

View workflow job for this annotation

GitHub Actions / flake8 

too many blank lines (2)
"""
Combining the max_value and min_value keyword arguments with
Expand Down

0 comments on commit d2ce122

Please sign in to comment.