Support total_ordering for waiters and paginators

mypy_boto3_builder/structures/paginator.py

@@ -2,9 +2,13 @@
 Boto3 client Paginator.
 """
 
+import functools
+from typing import Self
+
 from botocore.paginate import Paginator as BotocorePaginator
 
 from mypy_boto3_builder.enums.service_module_name import ServiceModuleName
+from mypy_boto3_builder.exceptions import BuildInternalError
 from mypy_boto3_builder.import_helpers.import_string import ImportString
 from mypy_boto3_builder.service_name import ServiceName
 from mypy_boto3_builder.structures.argument import Argument
@@ -15,6 +19,7 @@
 from mypy_boto3_builder.type_annotations.type_literal import TypeLiteral
 
 
+@functools.total_ordering
 class Paginator(ClassRecord):
     """
     Boto3 client Paginator.
@@ -35,6 +40,33 @@ def __init__(
         self.paginator_name = paginator_name
         self.service_name = service_name
 
+    def __hash__(self) -> int:
+        """
+        Hash paginators by name.
+        """
+        return hash(self.get_sort_key())
+
+    def get_sort_key(self) -> str:
+        """
+        Sort paginators by name.
+        """
+        return self.name
+
+    def __eq__(self, other: object) -> bool:
+        """
+        Whether two annotations are equal.
+        """
+        if not isinstance(other, Paginator):
+            raise BuildInternalError(f"{other} is not Paginator")
+
+        return self.get_sort_key() == other.get_sort_key()
+
+    def __gt__(self: Self, other: Self) -> bool:
+        """
+        Compare two annotations for sorting.
+        """
+        return self.get_sort_key() > other.get_sort_key()
+
     @property
     def boto3_doc_link(self) -> str:
         """

mypy_boto3_builder/structures/waiter.py

@@ -2,9 +2,13 @@
 Boto3 client Waiter.
 """
 
+import functools
+from typing import Self
+
 from botocore.waiter import Waiter as BotocoreWaiter
 
 from mypy_boto3_builder.enums.service_module_name import ServiceModuleName
+from mypy_boto3_builder.exceptions import BuildInternalError
 from mypy_boto3_builder.import_helpers.import_string import ImportString
 from mypy_boto3_builder.service_name import ServiceName
 from mypy_boto3_builder.structures.argument import Argument
@@ -15,6 +19,7 @@
 from mypy_boto3_builder.type_annotations.type_literal import TypeLiteral
 
 
+@functools.total_ordering
 class Waiter(ClassRecord):
     """
     Boto3 client Waiter.
@@ -33,6 +38,33 @@ def __init__(
         self.waiter_name = waiter_name
         self.service_name = service_name
 
+    def __hash__(self) -> int:
+        """
+        Hash paginators by name.
+        """
+        return hash(self.get_sort_key())
+
+    def get_sort_key(self) -> str:
+        """
+        Sort paginators by name.
+        """
+        return self.name
+
+    def __eq__(self, other: object) -> bool:
+        """
+        Whether two annotations are equal.
+        """
+        if not isinstance(other, Waiter):
+            raise BuildInternalError(f"{other} is not Waiter")
+
+        return self.get_sort_key() == other.get_sort_key()
+
+    def __gt__(self: Self, other: Self) -> bool:
+        """
+        Compare two annotations for sorting.
+        """
+        return self.get_sort_key() > other.get_sort_key()
+
     @property
     def boto3_doc_link(self) -> str:
         """