fix: use Literal type for comment_position and simplify sqlcommenter logic

Author: RiyaChaturvedi37

instrumentation/opentelemetry-instrumentation-dbapi/src/opentelemetry/instrumentation/dbapi/__init__.py

@@ -160,7 +160,7 @@
 import functools
 import logging
 import re
-from typing import Any, Awaitable, Callable, Generic, TypeVar
+from typing import Any, Awaitable, Callable, Generic, Literal, TypeVar
 
 from wrapt import wrap_function_wrapper
 
@@ -199,6 +199,8 @@
     "MySQLdb": "mysqlclient",
 }
 
+CommentPositionT = Literal["start", "end"]
+
 _logger = logging.getLogger(__name__)
 
 ConnectionT = TypeVar("ConnectionT")
@@ -216,7 +218,7 @@ def trace_integration(  # pylint: disable=too-many-positional-arguments
     db_api_integration_factory: type[DatabaseApiIntegration] | None = None,
     enable_attribute_commenter: bool = False,
     commenter_options: dict[str, Any] | None = None,
-    comment_position: str = "end",
+    comment_position: CommentPositionT = "end",
 ):
     """Integrate with DB API library.
     https://www.python.org/dev/peps/pep-0249/
@@ -267,7 +269,7 @@ def wrap_connect(  # pylint: disable=too-many-positional-arguments
     db_api_integration_factory: type[DatabaseApiIntegration] | None = None,
     commenter_options: dict[str, Any] | None = None,
     enable_attribute_commenter: bool = False,
-    comment_position: str = "end",
+    comment_position: CommentPositionT = "end",
 ):
     """Integrate with DB API library.
     https://www.python.org/dev/peps/pep-0249/
@@ -349,7 +351,7 @@ def instrument_connection(  # pylint: disable=too-many-positional-arguments
     connect_module: Callable[..., Any] | None = None,
     enable_attribute_commenter: bool = False,
     db_api_integration_factory: type[DatabaseApiIntegration] | None = None,
-    comment_position: str = "end",
+    comment_position: CommentPositionT = "end",
 ) -> TracedConnectionProxy[ConnectionT]:
     """Enable instrumentation in a database connection.
 
@@ -431,7 +433,7 @@ def __init__(  # pylint: disable=too-many-positional-arguments
         commenter_options: dict[str, Any] | None = None,
         connect_module: Callable[..., Any] | None = None,
         enable_attribute_commenter: bool = False,
-        comment_position: str = "end",
+        comment_position: CommentPositionT = "end",
     ):
         if connection_attributes is None:
             self.connection_attributes = {

opentelemetry-instrumentation/src/opentelemetry/instrumentation/sqlcommenter_utils.py

@@ -12,16 +12,15 @@ def _add_sql_comment(sql, comment_position="end", **meta) -> str:
     meta.update(**_add_framework_tags())
     comment = _generate_sql_comment(**meta)
     sql = sql.strip()
+    if sql.endswith(";"):
+        sql = sql[:-1]
+        end = ";"
+    else:
+        end = ""
     if comment_position == "start":
-        if sql.endswith(";"):
-            sql = comment + " " + sql[:-1] + ";"
-        else:
-            sql = comment + " " + sql
+        sql = comment + " " + sql + end
     else:
-        if sql.endswith(";"):
-            sql = sql[:-1] + comment + ";"
-        else:
-            sql = sql + comment
+        sql = sql + comment + end
     return sql