[type validation] skip unresolved forward ref (#3376)

* skip if unresolved forward ref

* make style

* Update src/huggingface_hub/dataclasses.py

Co-authored-by: Lucain <[email protected]>

* add forward ref in test cases

* update the test

* fix

* maybe like this?

* update tests

---------

Co-authored-by: Lucain <[email protected]>
Co-authored-by: Lucain <[email protected]>

Author: zucchini-nlp

src/huggingface_hub/dataclasses.py

@@ -5,6 +5,7 @@
     Any,
     Callable,
     Dict,
+    ForwardRef,
     List,
     Literal,
     Optional,
@@ -325,6 +326,8 @@ def type_validator(name: str, value: Any, expected_type: Any) -> None:
         validator(name, value, args)
     elif isinstance(expected_type, type):  # simple types
         _validate_simple_type(name, value, expected_type)
+    elif isinstance(expected_type, ForwardRef) or isinstance(expected_type, str):
+        return
     else:
         raise TypeError(f"Unsupported type for field '{name}': {expected_type}")
 

tests/test_utils_strict_dataclass.py

@@ -29,6 +29,30 @@ def strictly_positive(value: int):
         raise ValueError(f"Value must be strictly positive, got {value}")
 
 
+def dtype_validation(value: "ForwardDtype"):
+    if not isinstance(value, str):
+        raise ValueError(f"Value must be string, got {value}")
+
+    if isinstance(value, str) and value not in ["float32", "bfloat16", "float16"]:
+        raise ValueError(f"Value must be one of `[float32, bfloat16, float16]` but got {value}")
+
+
+@strict
+@dataclass
+class ConfigForwardRef:
+    """Test forward reference handling.
+
+    In practice, forward reference types are not validated so a custom validator is highly recommended.
+    """
+
+    forward_ref_validated: "ForwardDtype" = validated_field(validator=dtype_validation)
+    forward_ref: "ForwardDtype" = "float32"  # type is not validated by default
+
+
+class ForwardDtype(str):
+    """Dummy class to simulate a forward reference (e.g. `torch.dtype`)."""
+
+
 @strict
 @dataclass
 class Config:
@@ -62,6 +86,26 @@ def test_default_values():
     assert config.hidden_size == 1024
 
 
+def test_forward_ref_validation_is_skipped():
+    config = ConfigForwardRef(forward_ref="float32", forward_ref_validated="float32")
+    assert config.forward_ref == "float32"
+    assert config.forward_ref_validated == "float32"
+
+    # The `forward_ref_validated` has proper validation added in field-metadata and will be validated
+    with pytest.raises(StrictDataclassFieldValidationError):
+        ConfigForwardRef(forward_ref_validated="float64")
+
+    with pytest.raises(StrictDataclassFieldValidationError):
+        ConfigForwardRef(forward_ref_validated=-1)
+
+    with pytest.raises(StrictDataclassFieldValidationError):
+        ConfigForwardRef(forward_ref_validated="not_dtype")
+
+    # The `forward_ref` type is not validated => user can input anything
+    ConfigForwardRef(forward_ref=-1, forward_ref_validated="float32")
+    ConfigForwardRef(forward_ref=["float32"], forward_ref_validated="float32")
+
+
 def test_invalid_type_initialization():
     with pytest.raises(StrictDataclassFieldValidationError):
         Config(model_type={"type": "bert"}, vocab_size=30000, hidden_size=768)