Skip to content

Fix number validator #134

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

Merged
merged 2 commits into from
May 21, 2019
Merged

Fix number validator #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3339e13
Fix number validator
dz0ny May 15, 2019
63f3ffb
Number format added
p1c2u May 21, 2019
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
34 changes: 30 additions & 4 deletions openapi_core/schema/schemas/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
)
from openapi_core.schema.schemas.util import (
forcebool, format_date, format_datetime, format_byte, format_uuid,
format_number,
)
from openapi_core.schema.schemas.validators import (
TypeValidator, AttributeValidator,
Expand Down Expand Up @@ -50,11 +51,19 @@ class Schema(object):
SchemaFormat.BYTE: Format(format_byte, TypeValidator(text_type)),
}

NUMBER_FORMAT_CALLABLE_GETTER = {
SchemaFormat.NONE: Format(format_number, TypeValidator(
integer_types + (float, ), exclude=bool)),
SchemaFormat.FLOAT: Format(float, TypeValidator(float)),
SchemaFormat.DOUBLE: Format(float, TypeValidator(float)),
}

TYPE_VALIDATOR_CALLABLE_GETTER = {
SchemaType.ANY: lambda x: True,
SchemaType.BOOLEAN: TypeValidator(bool),
SchemaType.INTEGER: TypeValidator(integer_types, exclude=bool),
SchemaType.NUMBER: TypeValidator(integer_types, float, exclude=bool),
SchemaType.NUMBER: TypeValidator(
integer_types + (float, ), exclude=bool),
SchemaType.STRING: TypeValidator(
text_type, date, datetime, binary_type, UUID),
SchemaType.ARRAY: TypeValidator(list, tuple),
Expand Down Expand Up @@ -228,16 +237,33 @@ def _unmarshal_string(self, value, custom_formatters=None, strict=True):
"Failed to format value {value} to format {type}: {exception}", value, self.format, exc)

def _unmarshal_integer(self, value, custom_formatters=None, strict=True):
if strict and not isinstance(value, (integer_types, )):
if strict and not isinstance(value, integer_types):
raise InvalidSchemaValue("Value {value} is not of type {type}", value, self.type)

return int(value)

def _unmarshal_number(self, value, custom_formatters=None, strict=True):
if strict and not isinstance(value, (float, )):
if strict and not isinstance(value, (float, ) + integer_types):
raise InvalidSchemaValue("Value {value} is not of type {type}", value, self.type)

return float(value)
Copy link
Collaborator

@p1c2u p1c2u May 21, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm This should stay as Python representation for number is float.

Copy link
Collaborator

@p1c2u p1c2u May 21, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OpenAPI has two numeric types, number and integer, where number includes both integer and floating-point numbers. An optional format keyword serves as a hint for the tools to use a specific numeric type:

Ah yeah you're right. We need format unmarshalling then.

try:
schema_format = SchemaFormat(self.format)
except ValueError:
msg = "Unsupported format {type} unmarshalling for value {value}"
if custom_formatters is not None:
formatnumber = custom_formatters.get(self.format)
if formatnumber is None:
raise InvalidSchemaValue(msg, value, self.format)
else:
raise InvalidSchemaValue(msg, value, self.format)
else:
formatnumber = self.NUMBER_FORMAT_CALLABLE_GETTER[schema_format]

try:
return formatnumber.unmarshal(value)
except ValueError as exc:
raise InvalidCustomFormatSchemaValue(
"Failed to format value {value} to format {type}: {exception}", value, self.format, exc)

def _unmarshal_boolean(self, value, custom_formatters=None, strict=True):
if strict and not isinstance(value, (bool, )):
Expand Down
9 changes: 8 additions & 1 deletion openapi_core/schema/schemas/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import datetime
from distutils.util import strtobool
from json import dumps
from six import string_types, text_type
from six import string_types, text_type, integer_types
import strict_rfc3339
from uuid import UUID

Expand Down Expand Up @@ -36,3 +36,10 @@ def format_uuid(value):

def format_byte(value, encoding='utf8'):
return text_type(b64decode(value), encoding)


def format_number(value):
if isinstance(value, integer_types + (float, )):
return value

return float(value)
29 changes: 26 additions & 3 deletions tests/unit/schema/test_schemas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,12 +262,35 @@ def test_number_string_invalid(self):
with pytest.raises(InvalidSchemaValue):
schema.unmarshal(value)

def test_number_int_invalid(self):
def test_number_int(self):
schema = Schema('number')
value = 1
result = schema.unmarshal(value)

with pytest.raises(InvalidSchemaValue):
schema.unmarshal(value)
assert result == 1
assert type(result) == int

def test_number_float(self):
schema = Schema('number')
value = 1.2
result = schema.unmarshal(value)

assert result == 1.2
assert type(result) == float

def test_number_format_float(self):
schema = Schema('number', schema_format='float')
value = 1.2
result = schema.unmarshal(value)

assert result == 1.2

def test_number_format_double(self):
schema = Schema('number', schema_format='double')
value = 1.2
result = schema.unmarshal(value)

assert result == 1.2


class TestSchemaValidate(object):
Expand Down