Added support for pendulum Dates (#154)

* Added support for pydantic Dates

* fixed linting

* Fixed import sorting

* Fixed tests

* Fixed pre-commit

* Modified tests to use Date explicitly

* Split out tests into date/dt components

* Fixed failing test; coverage 100%

Author: Woody1193

pydantic_extra_types/pendulum_dt.py

@@ -4,6 +4,7 @@
 """
 
 try:
+    from pendulum import Date as _Date
     from pendulum import DateTime as _DateTime
     from pendulum import parse
 except ModuleNotFoundError:  # pragma: no cover
@@ -72,3 +73,61 @@ def _validate(cls, value: Any, handler: core_schema.ValidatorFunctionWrapHandler
         except Exception as exc:
             raise PydanticCustomError('value_error', 'value is not a valid timestamp') from exc
         return handler(data)
+
+
+class Date(_Date):
+    """
+    A `pendulum.Date` object. At runtime, this type decomposes into pendulum.Date automatically.
+    This type exists because Pydantic throws a fit on unknown types.
+
+    ```python
+    from pydantic import BaseModel
+    from pydantic_extra_types.pendulum_dt import Date
+
+    class test_model(BaseModel):
+        dt: Date
+
+    print(test_model(dt='2021-01-01'))
+
+    #> test_model(dt=Date(2021, 1, 1))
+    ```
+    """
+
+    __slots__: List[str] = []
+
+    @classmethod
+    def __get_pydantic_core_schema__(cls, source: Type[Any], handler: GetCoreSchemaHandler) -> core_schema.CoreSchema:
+        """
+        Return a Pydantic CoreSchema with the Date validation
+
+        Args:
+            source: The source type to be converted.
+            handler: The handler to get the CoreSchema.
+
+        Returns:
+            A Pydantic CoreSchema with the Date validation.
+        """
+        return core_schema.no_info_wrap_validator_function(cls._validate, core_schema.date_schema())
+
+    @classmethod
+    def _validate(cls, value: Any, handler: core_schema.ValidatorFunctionWrapHandler) -> Any:
+        """
+        Validate the date object and return it.
+
+        Args:
+            value: The value to validate.
+            handler: The handler to get the CoreSchema.
+
+        Returns:
+            The validated value or raises a PydanticCustomError.
+        """
+        # if we are passed an existing instance, pass it straight through.
+        if isinstance(value, _Date):
+            return handler(value)
+
+        # otherwise, parse it.
+        try:
+            data = parse(value)
+        except Exception as exc:
+            raise PydanticCustomError('value_error', 'value is not a valid date') from exc
+        return handler(data)

tests/test_pendulum_dt.py

@@ -2,22 +2,35 @@
 import pytest
 from pydantic import BaseModel, ValidationError
 
-from pydantic_extra_types.pendulum_dt import DateTime
+from pydantic_extra_types.pendulum_dt import Date, DateTime
 
 
-class Model(BaseModel):
+class DtModel(BaseModel):
     dt: DateTime
 
 
+class DateModel(BaseModel):
+    d: Date
+
+
 def test_pendulum_dt_existing_instance():
     """
     Verifies that constructing a model with an existing pendulum dt doesn't throw.
     """
     now = pendulum.now()
-    model = Model(dt=now)
+    model = DtModel(dt=now)
     assert model.dt == now
 
 
+def test_pendulum_date_existing_instance():
+    """
+    Verifies that constructing a model with an existing pendulum date doesn't throw.
+    """
+    today = pendulum.today().date()
+    model = DateModel(d=today)
+    assert model.d == today
+
+
 @pytest.mark.parametrize(
     'dt', [pendulum.now().to_iso8601_string(), pendulum.now().to_w3c_string(), pendulum.now().to_iso8601_string()]
 )
@@ -26,14 +39,32 @@ def test_pendulum_dt_from_serialized(dt):
     Verifies that building an instance from serialized, well-formed strings decode properly.
     """
     dt_actual = pendulum.parse(dt)
-    model = Model(dt=dt)
+    model = DtModel(dt=dt)
     assert model.dt == dt_actual
 
 
+def test_pendulum_date_from_serialized():
+    """
+    Verifies that building an instance from serialized, well-formed strings decode properly.
+    """
+    date_actual = pendulum.parse('2024-03-18').date()
+    model = DateModel(d='2024-03-18')
+    assert model.d == date_actual
+
+
 @pytest.mark.parametrize('dt', [None, 'malformed', pendulum.now().to_iso8601_string()[:5], 42])
 def test_pendulum_dt_malformed(dt):
     """
     Verifies that the instance fails to validate if malformed dt are passed.
     """
     with pytest.raises(ValidationError):
-        Model(dt=dt)
+        DtModel(dt=dt)
+
+
+@pytest.mark.parametrize('date', [None, 'malformed', pendulum.today().to_iso8601_string()[:5], 42])
+def test_pendulum_date_malformed(date):
+    """
+    Verifies that the instance fails to validate if malformed date are passed.
+    """
+    with pytest.raises(ValidationError):
+        DateModel(d=date)