Support additional metadata in ib()/field()

Author: python-desert

CHANGELOG.rst

@@ -1,3 +1,17 @@
+2020.01.06 (2020-01-06)
+-----------------------
+
+
+Changes
+^^^^^^^
+
+- Additional metadata are supported in ib() and fields().
+  `#28 <https://github.com/python-desert/desert/issues/28>`_
+
+
+----
+
+
 2020.01.05 (2020-01-05)
 -----------------------
 

src/desert/__init__.py

@@ -61,7 +61,9 @@ def field(marshmallow_field: marshmallow.fields.Field, **kw) -> dataclasses.Fiel
         class A:
             x: int = desert.field(marshmallow.fields.Int())
     """
-    return dataclasses.field(**kw, metadata=metadata(marshmallow_field))
+    meta = metadata(marshmallow_field)
+    meta.update(kw.pop("metadata", {}))
+    return dataclasses.field(**kw, metadata=meta)
 
 
 def ib(marshmallow_field: marshmallow.fields.Field, **kw) -> attr._make._CountingAttr:
@@ -73,7 +75,9 @@ def ib(marshmallow_field: marshmallow.fields.Field, **kw) -> attr._make._Countin
         class A:
             x: int = desert.ib(marshmallow.fields.Int())
     """
-    return attr.ib(**kw, metadata=metadata(marshmallow_field))
+    meta = metadata(marshmallow_field)
+    meta.update(kw.pop("metadata", {}))
+    return attr.ib(**kw, metadata=meta)
 
 
 __version__ = desert._version.__version__

src/desert/_version.py

@@ -1 +1 @@
-__version__ = "2020.01.05"
+__version__ = "2020.01.06"

tests/test_make.py

@@ -191,6 +191,36 @@ class A:
     assert schema.load({"x": timestring}) == A(x=dt)
 
 
+def test_concise_field_metadata():
+    """Concisely create a dataclasses.Field with metadata."""
+
+    @dataclasses.dataclass
+    class A:
+        x: str = desert.field(marshmallow.fields.NaiveDateTime(), metadata={"foo": 1})
+
+    timestring = "2019-10-21T10:25:00"
+    dt = datetime.datetime(year=2019, month=10, day=21, hour=10, minute=25, second=00)
+    schema = desert.schema(A)
+
+    assert schema.load({"x": timestring}) == A(x=dt)
+    assert dataclasses.fields(A)[0].metadata["foo"] == 1
+
+
+def test_concise_attrib_metadata():
+    """Concisely create an attr.ib() with metadata."""
+
+    @attr.dataclass
+    class A:
+        x: str = desert.ib(marshmallow.fields.NaiveDateTime(), metadata={"foo": 1})
+
+    timestring = "2019-10-21T10:25:00"
+    dt = datetime.datetime(year=2019, month=10, day=21, hour=10, minute=25, second=00)
+    schema = desert.schema(A)
+
+    assert schema.load({"x": timestring}) == A(x=dt)
+    assert attr.fields(A).x.metadata["foo"] == 1
+
+
 def test_union(module):
     """Deserialize one of several types."""