UUID field (#63)

* added UUID_REGEX and UUIDFormat class

* added UUIDFormat to fields.py

* added tests

* lint

Author: thomasjiangcy

tests/test_fields.py

@@ -1,6 +1,7 @@
 import datetime
 import decimal
 import re
+import uuid
 
 from typesystem.base import Message, ValidationError
 from typesystem.fields import (
@@ -713,6 +714,16 @@ def test_datetime():
     assert error == ValidationError(text="Must be a real datetime.", code="invalid")
 
 
+def test_uuid():
+    validator = String(format="uuid")
+    value, error = validator.validate_or_error("93e19019-c7a6-45fe-8936-f6f4d550f35f")
+    assert value == uuid.UUID("93e19019-c7a6-45fe-8936-f6f4d550f35f")
+
+    validator = String(format="uuid")
+    value, error = validator.validate_or_error("1245a678-1234-1234-1234-123412341234")
+    assert error == ValidationError(text="Must be valid UUID format.", code="format")
+
+
 def test_union():
     validator = Union(any_of=[Integer(), String()])
     value, error = validator.validate_or_error("abc")

tests/test_schemas.py

@@ -1,5 +1,6 @@
 import datetime
 import decimal
+import uuid
 
 import pytest
 
@@ -171,6 +172,17 @@ class InventoryItem(typesystem.Schema):
     assert item["price"] == 123.45
 
 
+def test_schema_uuid_serialization():
+    class User(typesystem.Schema):
+        id = typesystem.String(format="uuid")
+        username = typesystem.String()
+
+    item = User(id="b769df4a-18ec-480f-89ef-8ea961a82269", username="tom")
+
+    assert item.id == uuid.UUID("b769df4a-18ec-480f-89ef-8ea961a82269")
+    assert item["id"] == "b769df4a-18ec-480f-89ef-8ea961a82269"
+
+
 def test_schema_with_callable_default():
     class Example(typesystem.Schema):
         created = typesystem.Date(default=datetime.date.today)

typesystem/__init__.py

@@ -1,4 +1,4 @@
-from typesystem.base import ParseError, ValidationError, Message, Position
+from typesystem.base import Message, ParseError, Position, ValidationError
 from typesystem.fields import (
     Any,
     Array,

typesystem/fields.py

@@ -13,6 +13,7 @@
     "date": formats.DateFormat(),
     "time": formats.TimeFormat(),
     "datetime": formats.DateTimeFormat(),
+    "uuid": formats.UUIDFormat(),
 }
 
 

typesystem/formats.py

@@ -1,6 +1,7 @@
 import datetime
 import re
 import typing
+import uuid
 
 from typesystem.base import ValidationError
 
@@ -18,6 +19,10 @@
     r"(?P<tzinfo>Z|[+-]\d{2}(?::?\d{2})?)?$"
 )
 
+UUID_REGEX = re.compile(
+    r"[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"
+)
+
 
 class BaseFormat:
     errors: typing.Dict[str, str] = {}
@@ -130,3 +135,20 @@ def validate(self, value: typing.Any) -> datetime.datetime:
     #     if value.endswith('+00:00'):
     #         value = value[:-6] + 'Z'
     #     return value
+
+
+class UUIDFormat(BaseFormat):
+    errors = {"format": "Must be valid UUID format."}
+
+    def is_native_type(self, value: typing.Any) -> bool:
+        return isinstance(value, uuid.UUID)
+
+    def validate(self, value: typing.Any) -> uuid.UUID:
+        match = UUID_REGEX.match(value)
+        if not match:
+            raise self.validation_error("format")
+
+        return uuid.UUID(value)
+
+    def serialize(self, obj: typing.Any) -> str:
+        return str(obj)