Merge branch 'master' into version-0.3-beta

Author: aminalaee

README.md

@@ -39,16 +39,16 @@ Python 3.6+
 $ pip3 install typesystem
 ```
 
-If you'd like you use the form rendering you'll also want to install `jinja2`.
+If you'd like you use the form rendering using `jinja2`:
 
 ```shell
-$ pip3 install jinja2
+$ pip3 install typesystem[jinja2]
 ```
 
-If you'd like you use the YAML tokenization you'll also want to install `pyyaml`.
+If you'd like you use the YAML tokenization using `pyyaml`:
 
 ```shell
-$ pip3 install pyyaml
+$ pip3 install typesystem[pyyaml]
 ```
 
 ## Quickstart

docs/fields.md

@@ -78,6 +78,11 @@ For example: `username = typesystem.String(max_length=100)`
 Validates multi-line strings. Takes the same arguments as `String`.
 Represented in HTML forms as a `<textarea>`.
 
+### Password
+
+Similar to `String` and takes the same arguments.
+Represented in HTML forms as a `<input type="password">`.
+
 ## Boolean data types
 
 ### Boolean
@@ -164,7 +169,7 @@ Used to validate a list of data. For example:
 
 ```python
 # Validates data like `[8, 7, 0, 8, 4, 5]`
-ratings = typesystem.Array(items=typesystem.Integer(min_value=0, max_value=10))
+ratings = typesystem.Array(items=typesystem.Integer(minimum=0, maximum=10))
 ```
 
 **Arguments**:
@@ -215,3 +220,12 @@ owner = typesystem.Reference(to="User", allow_null=True, definitions=definitions
 
 * `to` - Name of schema defined in definitions. **Required**
 * `definitions` - `Definitions` instance. **Required**
+
+## Other data types
+
+### UUID
+
+Validates UUID in the format of 32 hexadecimal characters, separated by hyphens.
+For example `"cd11b0d7-d8b3-4b5c-8159-70f5c9ea96ab"`.
+
+Returns `uuid.UUID` instances.

docs/index.md

@@ -33,10 +33,16 @@ Python 3.6+
 $ pip3 install typesystem
 ```
 
-If you'd like you use the form rendering you'll also want to install `jinja2`.
+If you'd like you use the form rendering using `jinja2`:
 
 ```shell
-$ pip3 install jinja2
+$ pip3 install typesystem[jinja2]
+```
+
+If you'd like you use the YAML tokenization using `pyyaml`:
+
+```shell
+$ pip3 install typesystem[pyyaml]
 ```
 
 ## Quickstart

setup.py

@@ -41,6 +41,10 @@ def get_packages(package):
     packages=get_packages('typesystem'),
     package_data={'typesystem': ['py.typed', 'templates/forms/*.html']},
     install_requires=[],
+    extras_require={
+        "jinja2": ["jinja2"],
+        "pyyaml": ["pyyaml"],
+    },
     python_requires='>=3.6',
     classifiers=[
         'Development Status :: 3 - Alpha',

tests/test_fields.py

@@ -5,6 +5,7 @@
 
 from typesystem.base import Message, ValidationError
 from typesystem.fields import (
+    UUID,
     Array,
     Boolean,
     Choice,
@@ -16,6 +17,7 @@
     Integer,
     Number,
     Object,
+    Password,
     String,
     Time,
     Union,
@@ -715,13 +717,13 @@ def test_datetime():
 
 
 def test_uuid():
-    validator = String(format="uuid")
+    validator = 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")
+    validator = UUID()
     value, error = validator.validate_or_error("1245a678-1234-1234-1234-123412341234")
-    assert error == ValidationError(text="Must be valid UUID format.", code="format")
+    assert error == ValidationError(text="Must be a valid UUID format.", code="format")
 
 
 def test_union():
@@ -831,3 +833,9 @@ def test_validation_error_is_hashable():
     validator = Integer()
     _, error = validator.validate_or_error("abc")
     hash(error)
+
+
+def test_password():
+    validator = Password()
+    value, _ = validator.validate_or_error("secret")
+    assert value == "secret"

tests/test_forms.py

@@ -12,6 +12,7 @@
         "d": typesystem.Choice(
             choices=[("abc", "Abc"), ("def", "Def"), ("ghi", "Ghi")]
         ),
+        "password": typesystem.Password(),
     }
 )
 
@@ -28,18 +29,11 @@ def test_form_rendering():
     assert html.count('<input type="text" ') == 1
     assert html.count("<textarea ") == 1
     assert html.count("<select ") == 1
+    assert html.count('<input type="password" ') == 1
 
 
 def test_password_rendering():
-    password_schema = typesystem.Schema(
-        fields={
-            "password": typesystem.String(format="password"),
-            "active": typesystem.Boolean(read_only=True, default=True),
-        }
-    )
-
-    form = forms.create_form(password_schema)
-    form.validate(data={"password": "secret"})
+    form = forms.create_form(contact, values={"password": "secret"})
     html = str(form)
     assert "secret" not in html
 

typesystem/__init__.py

@@ -1,5 +1,6 @@
 from typesystem.base import Message, ParseError, Position, ValidationError
 from typesystem.fields import (
+    UUID,
     Any,
     Array,
     Boolean,
@@ -12,6 +13,7 @@
     Integer,
     Number,
     Object,
+    Password,
     String,
     Text,
     Time,
@@ -24,7 +26,7 @@
 from typesystem.tokenize.tokenize_json import tokenize_json, validate_json
 from typesystem.tokenize.tokenize_yaml import tokenize_yaml, validate_yaml
 
-__version__ = "0.3.0.dev1"
+__version__ = "0.3.0.dev2"
 __all__ = [
     "Array",
     "Any",
@@ -39,11 +41,13 @@
     "Float",
     "Number",
     "Object",
+    "Password",
     "Reference",
     "String",
     "Text",
     "Time",
     "Union",
+    "UUID",
     # Schemas
     "Schema",
     "Definitions",

typesystem/fields.py

@@ -762,3 +762,13 @@ def validate(self, value: typing.Any) -> typing.Any:
                 raise self.validation_error("only_null")
             raise self.validation_error("const")
         return value
+
+
+class UUID(String):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        super().__init__(format="uuid", **kwargs)
+
+
+class Password(String):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        super().__init__(format="password", **kwargs)

typesystem/formats.py

@@ -155,7 +155,7 @@ def serialize(self, obj: typing.Any) -> typing.Union[str, None]:
 
 
 class UUIDFormat(BaseFormat):
-    errors = {"format": "Must be valid UUID format."}
+    errors = {"format": "Must be a valid UUID format."}
 
     def is_native_type(self, value: typing.Any) -> bool:
         return isinstance(value, uuid.UUID)