Fix type hint for param fields in Index, allowing tuples of any length (

#1336)
tortoise · Feb 12, 2023 · 19e2824 · 19e2824
1 parent d8fef5f
commit 19e2824
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/tortoise/contrib/mysql/indexes.py b/tortoise/contrib/mysql/indexes.py
@@ -11,7 +11,7 @@ class FullTextIndex(Index):
     def __init__(
         self,
         *expressions: Term,
-        fields: Optional[Tuple[str]] = None,
+        fields: Optional[Tuple[str, ...]] = None,
         name: Optional[str] = None,
         parser_name: Optional[str] = None,
     ):

diff --git a/tortoise/contrib/postgres/indexes.py b/tortoise/contrib/postgres/indexes.py
@@ -13,7 +13,7 @@ class PostgreSQLIndex(PartialIndex):
     def __init__(
         self,
         *expressions: Term,
-        fields: Optional[Tuple[str]] = None,
+        fields: Optional[Tuple[str, ...]] = None,
         name: Optional[str] = None,
         condition: Optional[dict] = None,
     ):

diff --git a/tortoise/indexes.py b/tortoise/indexes.py
@@ -16,14 +16,14 @@ class Index:
     def __init__(
         self,
         *expressions: Term,
-        fields: Optional[Tuple[str]] = None,
+        fields: Optional[Tuple[str, ...]] = None,
         name: Optional[str] = None,
     ):
         """
         All kinds of index parent class, default is BTreeIndex.
 
         :param expressions: The expressions of on which the index is desired.
-        :param fields: A list or tuple of the name of the fields on which the index is desired.
+        :param fields: A tuple of names of the fields on which the index is desired.
         :param name: The name of the index.
         :raises ValueError: If params conflict.
         """
@@ -69,7 +69,7 @@ class PartialIndex(Index):
     def __init__(
         self,
         *expressions: Term,
-        fields: Optional[Tuple[str]] = None,
+        fields: Optional[Tuple[str, ...]] = None,
         name: Optional[str] = None,
         condition: Optional[dict] = None,
     ):