simple_search_list_txn should return None, not 0. (#8187)

matrix-org · Aug 27, 2020 · c9fa696 · c9fa696
1 parent 5649b7f
commit c9fa696
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/changelog.d/8187.misc b/changelog.d/8187.misc
@@ -0,0 +1 @@
+Add type hints to `synapse.storage.database`.
diff --git a/synapse/storage/database.py b/synapse/storage/database.py
@@ -28,7 +28,6 @@
     Optional,
     Tuple,
     TypeVar,
-    Union,
     overload,
 )
 
@@ -1655,7 +1654,7 @@ def simple_search_list_txn(
         term: Optional[str],
         col: str,
         retcols: Iterable[str],
-    ) -> Union[List[Dict[str, Any]], int]:
+    ) -> Optional[List[Dict[str, Any]]]:
         """Executes a SELECT query on the named table, which may return zero or
         more rows, returning the result as a list of dicts.
 
@@ -1667,14 +1666,14 @@ def simple_search_list_txn(
             retcols: the names of the columns to return
 
         Returns:
-            0 if no term is given, otherwise a list of dictionaries.
+            None if no term is given, otherwise a list of dictionaries.
         """
         if term:
             sql = "SELECT %s FROM %s WHERE %s LIKE ?" % (", ".join(retcols), table, col)
             termvalues = ["%%" + term + "%%"]
             txn.execute(sql, termvalues)
         else:
-            return 0
+            return None
 
         return cls.cursor_to_dict(txn)