Skip to content

Update oas_models.py to support multipleOf #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kevinmcody wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update oas_models.py to support multipleOf #139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 59 additions & 4 deletions src/OpenApiLibCore/models/oas_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
from functools import cached_property
from random import choice, randint, sample, shuffle, uniform
from sys import float_info
from decimal import Decimal, ROUND_CEILING, ROUND_FLOOR
from typing import (
Annotated,
Any,
Expand Down Expand Up @@ -331,7 +332,7 @@ class IntegerSchema(SchemaBase[int], frozen=True):
exclusiveMaximum: int | bool | None = None
minimum: int | None = None
exclusiveMinimum: int | bool | None = None
multipleOf: int | None = None # TODO: implement support
multipleOf: int | None = None
const: int | None = None
enum: list[int] | None = None
nullable: bool = False
Expand Down Expand Up @@ -390,7 +391,29 @@ def get_valid_value(
if self.enum is not None:
return choice(self.enum), self

return randint(self._min_value, self._max_value), self
if self.multipleOf is None:
return randint(self._min_value, self._max_value), self

step = self.multipleOf
if step <= 0:
logger.debug(f"multipleOf must be > 0, got {self.multipleOf}")
return randint(self._min_value, self._max_value), self

# k_min and k_max are the bounds for the integer k, which will be chosen randomly,
# then multiplied by the step (multipleOf) to get a valid value.
k_min = -(-self._min_value // step) # the "double negative" essentially turns floor division into ceiling division
k_max = self._max_value // step # floor division

if k_min > k_max:
logger.debug(
f"No number satisfies bounds [{self._min_value}, {self._max_value}] "
f"and multipleOf {self.multipleOf}"
)
return randint(self._min_value, self._max_value), self

# choose a k randomly between k_min and k_max, then multiply by step
value = randint(k_min, k_max) * step
return value, self

def get_values_out_of_bounds(self, current_value: int) -> list[int]: # pylint: disable=unused-argument
invalid_values: list[int] = []
Expand All @@ -401,6 +424,8 @@ def get_values_out_of_bounds(self, current_value: int) -> list[int]: # pylint:
if self._max_value < self._max_int:
invalid_values.append(self._max_value + 1)

# TODO: handle multipleOf for out of bounds values

if invalid_values:
return invalid_values

Expand Down Expand Up @@ -452,7 +477,7 @@ class NumberSchema(SchemaBase[float], frozen=True):
exclusiveMaximum: int | float | bool | None = None
minimum: int | float | None = None
exclusiveMinimum: int | float | bool | None = None
multipleOf: int | None = None # TODO: implement support
multipleOf: int | float | None = None
const: int | float | None = None
enum: list[int | float] | None = None
nullable: bool = False
Expand Down Expand Up @@ -507,7 +532,35 @@ def get_valid_value(
if self.enum is not None:
return choice(self.enum), self

return uniform(self._min_value, self._max_value), self
if self.multipleOf is None:
return uniform(self._min_value, self._max_value), self

#Convert multipleOf and bounds to Decimal to avoid float rounding errors.
step = Decimal(str(self.multipleOf))
if step <= 0:
logger.debug(f"multipleOf must be > 0, got {self.multipleOf}")
return uniform(self._min_value, self._max_value), self

min_value = Decimal(str(self._min_value))
max_value = Decimal(str(self._max_value))

#k_min and k_max are the bounds for the integer k, which will be chosen randomly,
# then multiplied by the step (multipleOf) to get a valid value.
# dividing by step and using ceiling/floor ensures then rounding ensures that k_min and k_max
# are the smallest/largest integers that satisfy the bounds when multiplied by step.
k_min = int((min_value / step).to_integral_value(rounding=ROUND_CEILING))
k_max = int((max_value / step).to_integral_value(rounding=ROUND_FLOOR))

if k_min > k_max:
logger.debug(
f"No number satisfies bounds [{self._min_value}, {self._max_value}] "
f"and multipleOf {self.multipleOf}"
)
return uniform(self._min_value, self._max_value), self

#choose a k randomly between k_min and k_max, then multiply by step
value = float(Decimal(randint(k_min, k_max)) * step)
return value, self

def get_values_out_of_bounds(self, current_value: float) -> list[float]: # pylint: disable=unused-argument
invalid_values: list[float] = []
Expand All @@ -518,6 +571,8 @@ def get_values_out_of_bounds(self, current_value: float) -> list[float]: # pyli
if self._max_value < self._max_float:
invalid_values.append(self._max_value + 0.000000001)

# TODO: handle multipleOf for out of bounds values

if invalid_values:
return invalid_values

Expand Down