Upload dataclass.py with huggingface_hub

dataclass.py

@@ -1,9 +1,10 @@
 import copy
 import dataclasses
 import functools
+import warnings
 from abc import ABCMeta
 from inspect import Parameter, Signature
-from typing import Any, final
+from typing import Any, Dict, final
 
 _FIELDS = "__fields__"
 
@@ -36,8 +37,10 @@ class Field:
     final: bool = False
     abstract: bool = False
     required: bool = False
+    deprecated: bool = False
     internal: bool = False
     origin_cls: type = None
+    metadata: Dict[str, str] = dataclasses.field(default_factory=dict)
 
     def get_default(self):
         if self.default_factory is not None:
@@ -51,6 +54,12 @@ class FinalField(Field):
         self.final = True
 
 
+@dataclasses.dataclass
+class DeprecatedField(Field):
+    def __post_init__(self):
+        self.deprecated = True
+
+
 @dataclasses.dataclass
 class RequiredField(Field):
     def __post_init__(self):
@@ -111,7 +120,7 @@ class UnexpectedArgumentError(TypeError):
     pass
 
 
-standart_variables = dir(object)
+standard_variables = dir(object)
 
 
 def is_possible_field(field_name, field_value):
@@ -125,7 +134,7 @@ def is_possible_field(field_name, field_value):
         bool: True if the name-value pair can represent a field, False otherwise.
     """
     return (
-        field_name not in standart_variables
+        field_name not in standard_variables
         and not field_name.startswith("__")
         and not callable(field_value)
     )
@@ -229,6 +238,10 @@ def required_fields(cls):
     return [field for field in fields(cls) if field.required]
 
 
+def deprecated_fields(cls):
+    return [field for field in fields(cls) if field.deprecated]
+
+
 def abstract_fields(cls):
     return [field for field in fields(cls) if field.abstract]
 
@@ -241,6 +254,10 @@ def is_final_field(field):
     return field.final
 
 
+def is_deprecated_field(field):
+    return field.deprecated
+
+
 def get_field_default(field):
     if field.default_factory is not None:
         return field.default_factory()
@@ -394,6 +411,7 @@ class Dataclass(metaclass=DataclassMeta):
         """Initialize fields based on kwargs.
 
         Checks for abstract fields when an instance is created.
+        Warn when a deprecated is used
         """
         _init_fields = [field for field in fields(self) if field.init]
         _init_fields_names = [field.name for field in _init_fields]
@@ -401,6 +419,12 @@ class Dataclass(metaclass=DataclassMeta):
             field.name for field in _init_fields if field.also_positional
         ]
 
+        _init_deprecated_fields = [field for field in _init_fields if field.deprecated]
+        for dep_field in _init_deprecated_fields:
+            warnings.warn(
+                dep_field.metadata["deprecation_msg"], DeprecationWarning, stacklevel=2
+            )
+
         for name in _init_positional_fields_names[: len(argv)]:
             if name in kwargs:
                 raise TypeError(