Rename SerdeScope to Scope

Author: yukinarit

serde/core.py

@@ -40,7 +40,7 @@
 from .numpy import is_numpy_available, is_numpy_type
 
 __all__ = [
-    "SerdeScope",
+    "Scope",
     "gen",
     "add_func",
     "Func",
@@ -78,7 +78,7 @@ def init(debug: bool = False) -> None:
 
 
 @dataclass
-class SerdeScope:
+class Scope:
     """
     Container to store types and functions used in code generation context.
     """
@@ -174,12 +174,12 @@ def gen(
 
 
 def add_func(
-    serde_scope: SerdeScope, func_name: str, func_code: str, globals: Dict[str, Any]
+    serde_scope: Scope, func_name: str, func_code: str, globals: Dict[str, Any]
 ) -> None:
     """
-    Generate a function and add it to a SerdeScope's `funcs` dictionary.
+    Generate a function and add it to a Scope's `funcs` dictionary.
 
-    * `serde_scope`: the SerdeScope instance to modify
+    * `serde_scope`: the Scope instance to modify
     * `func_name`: the name of the function
     * `func_code`: the source code of the function
     * `globals`: global variables that should be accessible to the generated function
@@ -198,7 +198,7 @@ def is_instance(obj: Any, typ: Type[Any]) -> bool:
     Subscripted Generics e.g. `List[int]`.
     """
     if dataclasses.is_dataclass(typ):
-        serde_scope: Optional[SerdeScope] = getattr(typ, SERDE_SCOPE, None)
+        serde_scope: Optional[Scope] = getattr(typ, SERDE_SCOPE, None)
         if serde_scope:
             try:
                 serde_scope.funcs[TYPE_CHECK](obj)

serde/de.py

@@ -64,7 +64,7 @@
     DefaultTagging,
     Field,
     NoCheck,
-    SerdeScope,
+    Scope,
     Tagging,
     TypeCheck,
     add_func,
@@ -214,9 +214,9 @@ def wrap(cls: Type[T]) -> Type[T]:
         # Create a scope storage used by serde.
         # Each class should get own scope. Child classes can not share scope with parent class.
         # That's why we need the "scope.cls is not cls" check.
-        scope: Optional[SerdeScope] = getattr(cls, SERDE_SCOPE, None)
+        scope: Optional[Scope] = getattr(cls, SERDE_SCOPE, None)
         if scope is None or scope.cls is not cls:
-            scope = SerdeScope(cls, reuse_instances_default=reuse_instances_default)
+            scope = Scope(cls, reuse_instances_default=reuse_instances_default)
             setattr(cls, SERDE_SCOPE, scope)
 
         # Set some globals for all generated functions
@@ -331,7 +331,7 @@ def is_dataclass_without_de(cls: Type[Any]) -> bool:
         return False
     if not hasattr(cls, SERDE_SCOPE):
         return True
-    scope: Optional[SerdeScope] = getattr(cls, SERDE_SCOPE)
+    scope: Optional[Scope] = getattr(cls, SERDE_SCOPE)
     return FROM_DICT not in scope.funcs
 
 
@@ -362,7 +362,7 @@ def from_obj(c: Type[T], o: Any, named: bool, reuse_instances: bool) -> T:
     """
 
     def deserializable_to_obj(cls):
-        serde_scope: SerdeScope = getattr(cls, SERDE_SCOPE)
+        serde_scope: Scope = getattr(cls, SERDE_SCOPE)
         func_name = FROM_DICT if named else FROM_ITER
         res = serde_scope.funcs[func_name](
             cls, maybe_generic=maybe_generic, data=o, reuse_instances=reuse_instances

serde/inspect.py

@@ -20,7 +20,7 @@
 from typing import Any
 from typing_extensions import Type
 
-from .core import SERDE_SCOPE, init, logger
+from .core import SERDE_SCOPE, Scope, init, logger
 
 init(True)
 

serde/se.py

@@ -58,7 +58,7 @@
     DefaultTagging,
     Field,
     NoCheck,
-    SerdeScope,
+    Scope,
     Tagging,
     TypeCheck,
     add_func,
@@ -195,9 +195,9 @@ def wrap(cls: Type[T]) -> Type[T]:
         # Create a scope storage used by serde.
         # Each class should get own scope. Child classes can not share scope with parent class.
         # That's why we need the "scope.cls is not cls" check.
-        scope: Optional[SerdeScope] = getattr(cls, SERDE_SCOPE, None)
+        scope: Optional[Scope] = getattr(cls, SERDE_SCOPE, None)
         if scope is None or scope.cls is not cls:
-            scope = SerdeScope(
+            scope = Scope(
                 cls,
                 reuse_instances_default=reuse_instances_default,
                 convert_sets_default=convert_sets_default,
@@ -303,15 +303,15 @@ def is_dataclass_without_se(cls: Type[Any]) -> bool:
         return False
     if not hasattr(cls, SERDE_SCOPE):
         return True
-    scope: Optional[SerdeScope] = getattr(cls, SERDE_SCOPE)
+    scope: Optional[Scope] = getattr(cls, SERDE_SCOPE)
     return TO_DICT not in scope.funcs
 
 
 def to_obj(
     o, named: bool, reuse_instances: bool, convert_sets: bool, c: Optional[Type[Any]] = None
 ):
     def serializable_to_obj(object):
-        serde_scope: SerdeScope = getattr(object, SERDE_SCOPE)
+        serde_scope: Scope = getattr(object, SERDE_SCOPE)
         func_name = TO_DICT if named else TO_ITER
         return serde_scope.funcs[func_name](
             object, reuse_instances=reuse_instances, convert_sets=convert_sets