WIP: Oracle named params.

Author: cpburnz

sqlparams/__init__.py

@@ -111,7 +111,7 @@ def __init__(
 		*out_style*:
 
 		-	For all named styles the parameter keys must be valid `Python identifiers`_.
-			They cannot start with a digit. This is to help preven incorrectly
+			They cannot start with a digit. This is to help prevent incorrectly
 			matching common strings such as date-times.
 
 			Named styles:
@@ -127,6 +127,14 @@ def __init__(
 
 				.. NOTE:: This is not defined by `PEP 249`_.
 
+			-	"named_oracle" indicates parameters will use the named style supported
+				by Oracle which allows for case-insensitive unquoted parameters and
+				case-sensitive quoted parameters::
+
+					... WHERE name = :name OR name = :"name"
+
+				.. NOTE:: This is not defined by `PEP 249`_.
+
 			-	"pyformat" indicates parameters will use the named Python extended
 				format style::
 

sqlparams/_converting.py

@@ -75,7 +75,7 @@ def __init__(
 
 		self._out_quotes: bool = out_style.param_quotes and allow_out_quotes
 		"""
-		*_out_quotes* (:class:`bool`) whether enclosing out parameters in double
+		*_out_quotes* (:class:`bool`) whether to enclose out parameters in double
 		quotes.
 		"""
 
@@ -1120,6 +1120,9 @@ def __regex_replace(
 				out_replacements = []
 				for i, sub_value in enumerate(value):
 					out_name = f"_{in_num_str}_{i}"
+					if self._out_quotes:
+						out_name = _quote_oracle_param(out_name)
+
 					out_repl = self._out_format.format(param=out_name)
 					out_names.append(out_name)
 					out_replacements.append(out_repl)
@@ -1130,6 +1133,9 @@ def __regex_replace(
 			else:
 				# Convert numeric parameter.
 				out_name = "_" + in_num_str
+				if self._out_quotes:
+					out_name = _quote_oracle_param(out_name)
+
 				out_repl = self._out_format.format(param=out_name)
 				param_conversions.append((False, in_index, out_name))
 				return out_repl
@@ -1882,6 +1888,9 @@ def __regex_replace(
 				out_replacements = []
 				for i, sub_value in enumerate(value):
 					out_name = f"_{in_index}_{i}"
+					if self._out_quotes:
+						out_name = _quote_oracle_param(out_name)
+
 					out_repl = self._out_format.format(param=out_name)
 					out_names.append(out_name)
 					out_replacements.append(out_repl)
@@ -1892,6 +1901,9 @@ def __regex_replace(
 			else:
 				# Convert ordinal parameter.
 				out_name = f"_{in_index}"
+				if self._out_quotes:
+					out_name = _quote_oracle_param(out_name)
+
 				out_repl = self._out_format.format(param=out_name)
 				param_conversions.append((False, in_index, out_name))
 				return out_repl

tests/test_1_general.py

@@ -13,22 +13,46 @@ class Test(unittest.TestCase):
 	the :class:`~sqlparams.SQLParams` class.
 	"""
 
-	# 1: Test assumptions about byte encoding.
-
 	def test_1_decode_bytes(self):
 		"""
 		Test decoding bytes.
 		"""
-		decoded = bytes(bytearray(range(0,256))).decode(sqlparams._BYTES_ENCODING)
-		expected = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~\x7f\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f\xa0\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf\xb0\xb1\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff"
+		decoded = bytes(bytearray(range(0, 256))).decode(sqlparams._BYTES_ENCODING)
+		expected = (
+			"\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f\x10\x11\x12"
+			"\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f"
+			" !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcde"
+			"fghijklmnopqrstuvwxyz{|}~"
+			"\x7f\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f\x90"
+			"\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f\xa0\xa1\xa2"
+			"\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf\xb0\xb1\xb2\xb3\xb4"
+			"\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6"
+			"\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8"
+			"\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea"
+			"\xeb\xec\xed\xee\xef\xf0\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc"
+			"\xfd\xfe\xff"
+		)
 		self.assertEqual(decoded, expected)
 
 	def test_1_encode_bytes(self):
 		"""
 		Test encoding bytes.
 		"""
 		encoded = "".join(map(chr, range(0,256))).encode(sqlparams._BYTES_ENCODING)
-		expected = b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~\x7f\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f\xa0\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf\xb0\xb1\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff"
+		expected = (
+			b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f\x10\x11\x12"
+			b"\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f"
+			b" !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcd"
+			b"efghijklmnopqrstuvwxyz{|}~"
+			b"\x7f\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f"
+			b"\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f\xa0"
+			b"\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf\xb0\xb1"
+			b"\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2"
+			b"\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3"
+			b"\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0\xe1\xe2\xe3\xe4"
+			b"\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0\xf1\xf2\xf3\xf4\xf5"
+			b"\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff"
+		)
 		self.assertEqual(encoded, expected)
 
 	def test_2_format_bytes(self):
@@ -342,8 +366,7 @@ def test_5_strip_comments_multi_last(self) -> None:
 
 	def test_5_strip_comments_multi_trailing(self) -> None:
 		"""
-		Test to make sure multiline comments do not consume trailing
-		comments.
+		Test to make sure multiline comments do not consume trailing comments.
 		"""
 		# Create instance.
 		query = sqlparams.SQLParams('named', 'qmark', strip_comments=True)
@@ -398,8 +421,8 @@ def test_5_strip_comments_single(self) -> None:
 
 	def test_5_strip_comments_single_last(self) -> None:
 		"""
-		Test to make sure single line comment at the end of the string is
-		handled properly.
+		Test to make sure single line comment at the end of the string is handled
+		properly.
 		"""
 		# Create instance.
 		query = sqlparams.SQLParams('named', 'qmark', strip_comments=True)
@@ -426,8 +449,7 @@ def test_5_strip_comments_single_last(self) -> None:
 
 	def test_5_strip_comments_single_trailing(self) -> None:
 		"""
-		Test to make sure single line comments do not consume trailing
-		comments.
+		Test to make sure single line comments do not consume trailing comments.
 		"""
 		# Create instance.
 		query = sqlparams.SQLParams('named', 'qmark', strip_comments=True)

tests/test_2_named_to_ordinal.py

@@ -622,7 +622,12 @@ def test_3_multiple(self):
 			FROM users
 			WHERE id = ? OR name = ? OR altid = ? OR altname = ?;
 		"""
-		dest_params = [src_params['id'], src_params['name'], src_params['id'], src_params['name']]
+		dest_params = [
+			src_params['id'],
+			src_params['name'],
+			src_params['id'],
+			src_params['name'],
+		]
 
 		# Format SQL with params.
 		sql, params = query.format(src_sql, src_params)
@@ -656,7 +661,10 @@ def test_3_multiple_many(self):
 			FROM users
 			WHERE id = ? OR name = ? OR altid = ? OR altname = ?;
 		"""
-		dest_params = [[__row['id'], __row['name'], __row['id'], __row['name']] for __row in src_params]
+		dest_params = [
+			[__row['id'], __row['name'], __row['id'], __row['name']]
+			for __row in src_params
+		]
 
 		# Format SQL with params.
 		sql, many_params = query.formatmany(src_sql, src_params)