1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
|
from __future__ import annotations
from decimal import ROUND_DOWN, Decimal, localcontext
from sys import float_info
from typing import TYPE_CHECKING, Any, Protocol, TypeVar, cast
from polyfactory.exceptions import ParameterException
from polyfactory.utils.deprecation import check_for_deprecated_parameters
from polyfactory.value_generators.primitives import create_random_decimal, create_random_float, create_random_integer
if TYPE_CHECKING:
from random import Random
T = TypeVar("T", Decimal, int, float)
class NumberGeneratorProtocol(Protocol[T]):
"""Protocol for custom callables used to generate numerical values"""
def __call__(self, random: "Random", minimum: T | None = None, maximum: T | None = None) -> T:
"""Signature of the callable.
:param random: An instance of random.
:param minimum: A minimum value.
:param maximum: A maximum value.
:return: The generated numeric value.
"""
...
def almost_equal_floats(value_1: float, value_2: float, *, delta: float = 1e-8) -> bool:
"""Return True if two floats are almost equal
:param value_1: A float value.
:param value_2: A float value.
:param delta: A minimal delta.
:returns: Boolean dictating whether the floats can be considered equal - given python's problematic comparison of floats.
"""
return abs(value_1 - value_2) <= delta
def is_multiply_of_multiple_of_in_range(
minimum: T,
maximum: T,
multiple_of: T,
) -> bool:
"""Determine if at least one multiply of `multiple_of` lies in the given range.
:param minimum: T: A minimum value.
:param maximum: T: A maximum value.
:param multiple_of: T: A value to use as a base for multiplication.
:returns: Boolean dictating whether at least one multiply of `multiple_of` lies in the given range between minimum and maximum.
"""
# if the range has infinity on one of its ends then infinite number of multipliers
# can be found within the range
# if we were given floats and multiple_of is really close to zero then it doesn't make sense
# to continue trying to check the range
if (
isinstance(minimum, float)
and isinstance(multiple_of, float)
and minimum / multiple_of in [float("+inf"), float("-inf")]
):
return False
multiplier = round(minimum / multiple_of)
step = 1 if multiple_of > 0 else -1
# since rounding can go either up or down we may end up in a situation when
# minimum is less or equal to `multiplier * multiple_of`
# or when it is greater than `multiplier * multiple_of`
# (in this case minimum is less than `(multiplier + 1)* multiple_of`). So we need to check
# that any of two values is inside the given range. ASCII graphic below explain this
#
# minimum
# -----------------+-------+-----------------------------------+----------------------------
#
#
# minimum
# -------------------------+--------+--------------------------+----------------------------
#
# since `multiple_of` can be a negative number adding +1 to `multiplier` drives `(multiplier + 1) * multiple_of``
# away from `minimum` to the -infinity. It looks like this:
# minimum
# -----------------------+--------------------------------+------------------------+--------
#
# so for negative `multiple_of` we want to subtract 1 from multiplier
for multiply in [multiplier * multiple_of, (multiplier + step) * multiple_of]:
multiply_float = float(multiply)
if (
almost_equal_floats(multiply_float, float(minimum))
or almost_equal_floats(multiply_float, float(maximum))
or minimum < multiply < maximum
):
return True
return False
def passes_pydantic_multiple_validator(value: T, multiple_of: T) -> bool:
"""Determine whether a given value passes the pydantic multiple_of validation.
:param value: A numeric value.
:param multiple_of: Another numeric value.
:returns: Boolean dictating whether value is a multiple of value.
"""
if multiple_of == 0:
return True
mod = float(value) / float(multiple_of) % 1
return almost_equal_floats(mod, 0.0) or almost_equal_floats(mod, 1.0)
def get_increment(t_type: type[T]) -> T:
"""Get a small increment base to add to constrained values, i.e. lt/gt entries.
:param t_type: A value of type T.
:returns: An increment T.
"""
values: dict[Any, Any] = {
int: 1,
float: float_info.epsilon,
Decimal: Decimal("0.001"),
}
return cast("T", values[t_type])
def get_value_or_none(
t_type: type[T],
lt: T | None = None,
le: T | None = None,
gt: T | None = None,
ge: T | None = None,
max_digits: int | None = None,
decimal_places: int | None = None,
) -> tuple[T | None, T | None]:
"""Return an optional value.
:param equal_value: An GE/LE value.
:param constrained: An GT/LT value.
:param increment: increment
:returns: Optional T.
"""
if ge is not None:
minimum_value = ge
elif gt is not None:
minimum_value = gt + get_increment(t_type)
else:
minimum_value = None
if le is not None:
maximum_value = le
elif lt is not None:
maximum_value = lt - get_increment(t_type)
else:
maximum_value = None
if max_digits is not None:
max_whole_digits = 10
whole_digits = max_digits - decimal_places if decimal_places is not None else max_digits
maximum = (
Decimal(10**whole_digits - 1) if whole_digits < max_whole_digits else Decimal(10**max_whole_digits - 1)
)
minimum = maximum * (-1)
if minimum_value is None or minimum_value < minimum:
minimum_value = t_type(minimum)
elif minimum_value > maximum:
msg = f"minimum value must be less than {maximum}"
raise ParameterException(msg)
if maximum_value is None or maximum_value > maximum:
maximum_value = t_type(maximum if maximum > 0 else Decimal(1))
elif maximum_value < minimum:
msg = f"maximum value must be greater than {minimum}"
raise ParameterException(msg)
return minimum_value, maximum_value
def get_constrained_number_range(
t_type: type[T],
random: Random,
lt: T | None = None,
le: T | None = None,
gt: T | None = None,
ge: T | None = None,
multiple_of: T | None = None,
max_digits: int | None = None,
decimal_places: int | None = None,
) -> tuple[T | None, T | None]:
"""Return the minimum and maximum values given a field_meta's constraints.
:param t_type: A primitive constructor - int, float or Decimal.
:param random: An instance of Random.
:param lt: Less than value.
:param le: Less than or equal value.
:param gt: Greater than value.
:param ge: Greater than or equal value.
:param multiple_of: Multiple of value.
:param decimal_places: Number of decimal places.
:param max_digits: Maximal number of digits.
:returns: a tuple of optional minimum and maximum values.
"""
seed = t_type(random.random() * 10)
minimum, maximum = get_value_or_none(
lt=lt, le=le, gt=gt, ge=ge, t_type=t_type, max_digits=max_digits, decimal_places=decimal_places
)
if minimum is not None and maximum is not None and maximum < minimum:
msg = "maximum value must be greater than minimum value"
raise ParameterException(msg)
if multiple_of is None:
if minimum is not None and maximum is None:
return (minimum, seed) if minimum == 0 else (minimum, minimum + seed) # pyright: ignore[reportGeneralTypeIssues]
if maximum is not None and minimum is None:
return maximum - seed, maximum
else:
if multiple_of == 0.0: # TODO: investigate @guacs # noqa: FIX002
msg = "multiple_of can not be zero"
raise ParameterException(msg)
if (
minimum is not None
and maximum is not None
and not is_multiply_of_multiple_of_in_range(minimum=minimum, maximum=maximum, multiple_of=multiple_of)
):
msg = "given range should include at least one multiply of multiple_of"
raise ParameterException(msg)
return minimum, maximum
def generate_constrained_number(
random: Random,
minimum: T | None,
maximum: T | None,
multiple_of: T | None,
method: "NumberGeneratorProtocol[T]",
) -> T:
"""Generate a constrained number, output depends on the passed in callbacks.
:param random: An instance of random.
:param minimum: A minimum value.
:param maximum: A maximum value.
:param multiple_of: A multiple of value.
:param method: A function that generates numbers of type T.
:returns: A value of type T.
"""
if minimum is None or maximum is None:
return multiple_of if multiple_of is not None else method(random=random)
if multiple_of is None:
return method(random=random, minimum=minimum, maximum=maximum)
if multiple_of >= minimum:
return multiple_of
result = minimum
while not passes_pydantic_multiple_validator(result, multiple_of):
result = round(method(random=random, minimum=minimum, maximum=maximum) / multiple_of) * multiple_of
return result
def handle_constrained_int(
random: Random,
multiple_of: int | None = None,
gt: int | None = None,
ge: int | None = None,
lt: int | None = None,
le: int | None = None,
) -> int:
"""Handle constrained integers.
:param random: An instance of Random.
:param lt: Less than value.
:param le: Less than or equal value.
:param gt: Greater than value.
:param ge: Greater than or equal value.
:param multiple_of: Multiple of value.
:returns: An integer.
"""
minimum, maximum = get_constrained_number_range(
gt=gt,
ge=ge,
lt=lt,
le=le,
t_type=int,
multiple_of=multiple_of,
random=random,
)
return generate_constrained_number(
random=random,
minimum=minimum,
maximum=maximum,
multiple_of=multiple_of,
method=create_random_integer,
)
def handle_constrained_float(
random: Random,
multiple_of: float | None = None,
gt: float | None = None,
ge: float | None = None,
lt: float | None = None,
le: float | None = None,
) -> float:
"""Handle constrained floats.
:param random: An instance of Random.
:param lt: Less than value.
:param le: Less than or equal value.
:param gt: Greater than value.
:param ge: Greater than or equal value.
:param multiple_of: Multiple of value.
:returns: A float.
"""
minimum, maximum = get_constrained_number_range(
gt=gt,
ge=ge,
lt=lt,
le=le,
t_type=float,
multiple_of=multiple_of,
random=random,
)
return generate_constrained_number(
random=random,
minimum=minimum,
maximum=maximum,
multiple_of=multiple_of,
method=create_random_float,
)
def validate_max_digits(
max_digits: int,
minimum: Decimal | None,
decimal_places: int | None,
) -> None:
"""Validate that max digits is greater than minimum and decimal places.
:param max_digits: The maximal number of digits for the decimal.
:param minimum: Minimal value.
:param decimal_places: Number of decimal places
:returns: 'None'
"""
check_for_deprecated_parameters("2.19.1", parameters=(("minimum", minimum),))
if max_digits <= 0:
msg = "max_digits must be greater than 0"
raise ParameterException(msg)
if decimal_places is not None and max_digits < decimal_places:
msg = "max_digits must be greater or equal than decimal places"
raise ParameterException(msg)
def handle_decimal_length(
generated_decimal: Decimal,
decimal_places: int | None,
max_digits: int | None,
) -> Decimal:
"""Handle the length of the decimal.
:param generated_decimal: A decimal value.
:param decimal_places: Number of decimal places.
:param max_digits: Maximal number of digits.
"""
with localcontext() as ctx:
ctx.rounding = ROUND_DOWN
list_decimal = str(generated_decimal).strip("-0").split(".")
decimal_parts = 2
if len(list_decimal) == decimal_parts:
whole, decimals = list_decimal
if decimal_places is not None and len(decimals) > decimal_places:
return round(generated_decimal, decimal_places)
if max_digits is not None and len(whole) + len(decimals) > max_digits:
max_decimals = max_digits - len(whole)
return round(generated_decimal, max_decimals)
return generated_decimal
def handle_constrained_decimal(
random: Random,
multiple_of: Decimal | None = None,
decimal_places: int | None = None,
max_digits: int | None = None,
gt: Decimal | None = None,
ge: Decimal | None = None,
lt: Decimal | None = None,
le: Decimal | None = None,
) -> Decimal:
"""Handle a constrained decimal.
:param random: An instance of Random.
:param multiple_of: Multiple of value.
:param decimal_places: Number of decimal places.
:param max_digits: Maximal number of digits.
:param lt: Less than value.
:param le: Less than or equal value.
:param gt: Greater than value.
:param ge: Greater than or equal value.
:returns: A decimal.
"""
minimum, maximum = get_constrained_number_range(
gt=gt,
ge=ge,
lt=lt,
le=le,
multiple_of=multiple_of,
max_digits=max_digits,
decimal_places=decimal_places,
t_type=Decimal,
random=random,
)
if max_digits is not None:
validate_max_digits(max_digits=max_digits, minimum=None, decimal_places=decimal_places)
generated_decimal = generate_constrained_number(
random=random,
minimum=minimum,
maximum=maximum,
multiple_of=multiple_of,
method=create_random_decimal,
)
return handle_decimal_length(
generated_decimal=generated_decimal,
max_digits=max_digits,
decimal_places=decimal_places,
)
|