Paginator typing

Author: jieter

django_tables2/data.py

@@ -167,8 +167,7 @@ def set_table(self, table):
     @property
     def ordering(self):
         """
-        Returns the list of order by aliases that are enforcing ordering on the
-        data.
+        Returns the list of order by aliases that are enforcing ordering on the data.
 
         If the data is unordered, an empty sequence is returned. If the
         ordering can not be determined, `None` is returned.
@@ -185,7 +184,7 @@ def ordering(self):
         except StopIteration:
             pass
 
-    def order_by(self, aliases):
+    def order_by(self, aliases: OrderByTuple):
         """
         Order the data based on order by aliases (prefixed column names) in the
         table.

django_tables2/paginators.py

@@ -62,7 +62,7 @@ def __init__(self, object_list, per_page, look_ahead=None, **kwargs):
 
         super().__init__(object_list, per_page, **kwargs)
 
-    def validate_number(self, number):
+    def validate_number(self, number: float | int) -> int:
         """Validate the given 1-based page number."""
         try:
             if isinstance(number, float) and not number.is_integer():
@@ -74,7 +74,7 @@ def validate_number(self, number):
             raise EmptyPage(_("That page number is less than 1"))
         return number
 
-    def page(self, number):
+    def page(self, number: float | int) -> Page:
         # Number might be None, because the total number of pages is not known in this paginator.
         # If an unknown page is requested, serve the first page.
         number = self.validate_number(number or 1)
@@ -98,20 +98,20 @@ def page(self, number):
             self._final_num_pages = number
         return Page(objects, number, self)
 
-    def is_last_page(self, number):
+    def is_last_page(self, number: float | int) -> bool:
         return number == self._final_num_pages
 
     def _get_count(self):
         raise NotImplementedError
 
     count = property(_get_count)
 
-    def _get_num_pages(self):
+    def _get_num_pages(self) -> int:
         return self._num_pages
 
     num_pages = property(_get_num_pages)
 
-    def _get_page_range(self):
+    def _get_page_range(self) -> range:
         raise NotImplementedError
 
     page_range = property(_get_page_range)