Handle query params as tuples, not as lists - fix #211

src/DatabaseLibrary/assertion.py

@@ -11,7 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from typing import List, Optional
+from typing import Optional, Tuple
 
 from robot.api import logger
 
@@ -27,7 +27,7 @@ def check_if_exists_in_database(
  sansTran: bool = False,
  msg: Optional[str] = None,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  Check if any row would be returned by given the input ``selectStatement``. If there are no results, then this will
@@ -64,7 +64,7 @@ def check_if_not_exists_in_database(
  sansTran: bool = False,
  msg: Optional[str] = None,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  This is the negation of `check_if_exists_in_database`.
@@ -103,7 +103,7 @@ def row_count_is_0(
  sansTran: bool = False,
  msg: Optional[str] = None,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  Check if any rows are returned from the submitted ``selectStatement``. If there are, then this will throw an
@@ -140,7 +140,7 @@ def row_count_is_equal_to_x(
  sansTran: bool = False,
  msg: Optional[str] = None,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  Check if the number of rows returned from ``selectStatement`` is equal to the value submitted. If not, then this
@@ -178,7 +178,7 @@ def row_count_is_greater_than_x(
  sansTran: bool = False,
  msg: Optional[str] = None,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  Check if the number of rows returned from ``selectStatement`` is greater than the value submitted. If not, then
@@ -216,7 +216,7 @@ def row_count_is_less_than_x(
  sansTran: bool = False,
  msg: Optional[str] = None,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  Check if the number of rows returned from ``selectStatement`` is less than the value submitted. If not, then this

src/DatabaseLibrary/query.py

@@ -15,7 +15,7 @@
 import inspect
 import re
 import sys
-from typing import List, Optional
+from typing import List, Optional, Tuple
 
 from robot.api import logger
 
@@ -31,7 +31,7 @@ def query(
  sansTran: bool = False,
  returnAsDict: bool = False,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  Runs a query with the ``selectStatement`` and returns the result as a list of rows.
@@ -98,7 +98,7 @@ def row_count(
  selectStatement: str,
  sansTran: bool = False,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  Uses the input ``selectStatement`` to query the database and returns the number of rows from the query.
@@ -137,7 +137,7 @@ def description(
  selectStatement: str,
  sansTran: bool = False,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  Uses the input ``selectStatement`` to query a table in the db which will be used to determine the description.
@@ -364,7 +364,7 @@ def execute_sql_string(
  sqlString: str,
  sansTran: bool = False,
  alias: Optional[str] = None,
- parameters: Optional[List] = None,
+ parameters: Optional[Tuple] = None,
  omitTrailingSemicolon: Optional[bool] = None,
  ):
  """
@@ -547,7 +547,11 @@ def call_stored_procedure(
  db_connection.client.rollback()
 
  def __execute_sql(
- self, cur, sql_statement: str, omit_trailing_semicolon: Optional[bool] = None, parameters: Optional[List] = None
+ self,
+ cur,
+ sql_statement: str,
+ omit_trailing_semicolon: Optional[bool] = None,
+ parameters: Optional[Tuple] = None,
  ):
  """
  Runs the `sql_statement` using `cur` as Cursor object.