renaming decorators

Author: giograno

src/py_avro_schema/_alias.py

@@ -25,12 +25,12 @@ def get_fully_qualified_name(py_type: type) -> str:
     return qualname
 
 
-def register_aliases(aliases: list[FQN]):
+def register_type_aliases(aliases: list[FQN]):
     """
     Decorator to register aliases for a given type.
 
     Example::
-        @register_aliases(aliases=["py_avro_schema.OldAddress"])
+        @register_type_aliases(aliases=["py_avro_schema.OldAddress"])
         class Address(TypedDict):
             street: str
             number: int
@@ -45,12 +45,12 @@ def _wrapper(cls):
     return _wrapper
 
 
-def register_alias(alias: FQN):
+def register_type_alias(alias: FQN):
     """
     Decorator to register a single alias for a given type.
 
     Example::
-        @register_alias(alias="py_avro_schema.OldAddress")
+        @register_type_alias(alias="py_avro_schema.OldAddress")
         class Address(TypedDict):
             street: str
             number: int

tests/test_dataclass.py

@@ -19,7 +19,7 @@
 import pytest
 
 import py_avro_schema as pas
-from py_avro_schema._alias import register_aliases
+from py_avro_schema._alias import register_type_aliases
 from py_avro_schema._testing import assert_schema
 
 
@@ -401,7 +401,7 @@ class PyType:
 
 
 def test_dataclass_repeated_enum_field():
-    @register_aliases(aliases=["test_dataclass.OldEnum"])
+    @register_type_aliases(aliases=["test_dataclass.OldEnum"])
     class PyTypeEnum(enum.Enum):
         RED = "RED"
         GREEN = "GREEN"

tests/test_plain_class.py

@@ -15,12 +15,12 @@
 import pytest
 
 import py_avro_schema
-from py_avro_schema._alias import register_aliases
+from py_avro_schema._alias import register_type_aliases
 from py_avro_schema._testing import assert_schema
 
 
 def test_plain_class_with_type_hints():
-    @register_aliases(aliases=["test_plain_class.OldPyType"])
+    @register_type_aliases(aliases=["test_plain_class.OldPyType"])
     class PyType:
         """A port, not using dataclass"""
 

tests/test_typed_dict.py

@@ -1,6 +1,6 @@
 from typing import TypedDict
 
-from py_avro_schema._alias import register_alias
+from py_avro_schema._alias import register_type_alias
 from py_avro_schema._testing import assert_schema
 
 
@@ -28,7 +28,7 @@ class User(TypedDict):
 
 
 def test_type_dict_nested():
-    @register_alias("test_typed_dict.OldAddress")
+    @register_type_alias("test_typed_dict.OldAddress")
     class Address(TypedDict):
         street: str
         number: int