Merged PR 5173: Feat: Cursor class Implementation Basics with Tests

#### AI description  (iteration 1)
#### PR Classification
New feature

#### PR Summary
This pull request implements the basic functionality of the `Cursor` class along with associated tests.
- `mssql_python/cursor.py`: Implemented various data retrieval functions, execute methods, and cursor initialization.
- `mssql_python/connection.py`: Removed the `_get_data` method.
- Added `build-pyd-pipeline.yml` to automate the build and push of the `ddbc_bindings.pyd` file.

Related work items: #32921

Author: bewithgaurav

build-pyd-pipeline.yml

@@ -0,0 +1,41 @@
+trigger:
+  branches:
+    include:
+    - pybind11_win_test
+  paths:
+    include:
+    - mssql_python/pybind/ddbc_bindings.cpp
+    - mssql_python/pybind/CMakeLists.txt
+
+jobs:
+- job: BuildOnWindows
+  pool:
+    vmImage: 'windows-2019'
+  steps:
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '3.x'
+      addToPath: true
+  - script: |
+      pip install pybind11
+    displayName: 'Install pybind11'
+  - script: |
+      cd mssql_python\pybind
+      mkdir build
+      cd build  
+      cmake -DPython3_EXECUTABLE="python3" -DCMAKE_BUILD_TYPE=Debug ..
+      cmake --build . --config Debug
+      move /Y Debug\ddbc_bindings.pyd ..\..\ddbc_bindings.pyd
+    displayName: 'Build and move .pyd file'
+  - script: |
+      git config --global user.name "$(Build.RequestedFor)"
+      git config --global user.email "$(Build.RequestedForEmail)"
+      git config --global credential.helper store
+      echo "https://$(System.AccessToken):@dev.azure.com" > ~/.git-credentials
+      git checkout pybind11_win_test
+      git add mssql_python/ddbc_bindings.pyd
+      git commit -m "Add generated ddbc_bindings.pyd"
+      git push https://$(System.AccessToken)@dev.azure.com/sqlclientdrivers/mssql-python/_git/mssql-python HEAD:pybind11_win_test
+    displayName: 'Commit and push .pyd file'
+    env:
+      SYSTEM_ACCESSTOKEN: $(System.AccessToken)

main.py

@@ -4,4 +4,18 @@
 conn_str = os.getenv("DB_CONNECTION_STRING")
 conn = connect(conn_str)
 
+cursor = conn.cursor()
+cursor.execute("SELECT database_id, name from sys.databases;")
+row = cursor.fetchmany(1)
+print(row)
+
+cursor.execute("SELECT database_id, name from sys.databases;")
+row = cursor.fetchone()
+print(row)
+
+cursor.execute("SELECT database_id, name from sys.databases;")
+row = cursor.fetchall()
+print(row)
+
+cursor.close()
 conn.close()

mssql_python/connection.py

@@ -1,6 +1,6 @@
 import ctypes
 from mssql_python.cursor import Cursor
-from mssql_python.logging_config import setup_logging
+from mssql_python.logging_config import setup_logging, ENABLE_LOGGING
 from mssql_python.constants import ConstantsODBC as odbc_sql_const
 from mssql_python.helpers import add_driver_to_connection_str, check_error
 import logging
@@ -115,17 +115,20 @@ def _connect_to_db(self) -> None:
             DatabaseError: If there is an error while trying to connect to the database.
             InterfaceError: If there is an error related to the database interface.
         """
-        logging.info("Connecting to the database")
+        if ENABLE_LOGGING:
+            logging.info("Connecting to the database")
         try:
             ret = ddbc_bindings.DDBCSQLDriverConnect(
                 self.hdbc.value, # Connection handle
                 0, # Window handle
                 self.connection_str # Connection string
             )
             check_error(odbc_sql_const.SQL_HANDLE_DBC.value, self.hdbc.value, ret)
-            logging.info("Connection established successfully.")
+            if ENABLE_LOGGING:
+                logging.info("Connection established successfully.")
         except Exception as e:
-            logging.error("An error occurred while connecting to the database: %s", e)
+            if ENABLE_LOGGING:
+                logging.error("An error occurred while connecting to the database: %s", e)
             raise
 
     @property
@@ -165,9 +168,11 @@ def setautocommit(self, value: bool) -> None:
             )
             check_error(odbc_sql_const.SQL_HANDLE_DBC.value, self.hdbc.value, ret)
             self._autocommit = value
-            logging.info("Autocommit mode set to %s.", value)
+            if ENABLE_LOGGING:
+                logging.info("Autocommit mode set to %s.", value)
         except Exception as e:
-            logging.error("An error occurred while setting autocommit mode: %s", e)
+            if ENABLE_LOGGING:
+                logging.error("An error occurred while setting autocommit mode: %s", e)
             raise Exception("DatabaseError: Failed to set autocommit mode") from e
 
 
@@ -212,9 +217,11 @@ def commit(self) -> None:
                 odbc_sql_const.SQL_COMMIT.value # Commit the transaction
             )
             check_error(odbc_sql_const.SQL_HANDLE_DBC.value, self.hdbc.value, ret)
-            logging.info("Transaction committed successfully.")
+            if ENABLE_LOGGING:
+                logging.info("Transaction committed successfully.")
         except Exception as e:
-            logging.error("An error occurred while committing the transaction: %s", e)
+            if ENABLE_LOGGING:
+                logging.error("An error occurred while committing the transaction: %s", e)
             raise Exception("DatabaseError: Failed to commit the transaction") from e
 
     def rollback(self) -> None:
@@ -236,9 +243,11 @@ def rollback(self) -> None:
                 odbc_sql_const.SQL_ROLLBACK.value # Roll back the transaction
             )
             check_error(odbc_sql_const.SQL_HANDLE_DBC.value, self.hdbc.value, ret)
-            logging.info("Transaction rolled back successfully.")
+            if ENABLE_LOGGING:
+                logging.info("Transaction rolled back successfully.")
         except Exception as e:
-            logging.error("An error occurred while rolling back the transaction: %s", e)
+            if ENABLE_LOGGING:
+                logging.error("An error occurred while rolling back the transaction: %s", e)
             raise Exception("DatabaseError: Failed to roll back the transaction") from e
 
     def close(self) -> None:
@@ -263,8 +272,9 @@ def close(self) -> None:
             ret = ddbc_bindings.DDBCSQLFreeHandle(odbc_sql_const.SQL_HANDLE_DBC.value, self.hdbc.value)
             check_error(odbc_sql_const.SQL_HANDLE_DBC.value, self.hdbc.value, ret)
 
-            
-            logging.info("Connection closed successfully.")
+            if ENABLE_LOGGING:
+                logging.info("Connection closed successfully.")
         except Exception as e:
-            logging.error("An error occurred while closing the connection: %s", e)
+            if ENABLE_LOGGING:
+                logging.error("An error occurred while closing the connection: %s", e)
             raise Exception("DatabaseError: Failed to close the connection") from e

mssql_python/constants.py

@@ -17,12 +17,90 @@ class ConstantsODBC(Enum):
     SQL_ATTR_ODBC_VERSION = 200
     SQL_ATTR_ASYNC_ENABLE = 4
     SQL_ATTR_ASYNC_STMT_EVENT = 29
+    SQL_ATTR_AUTOCOMMIT = 102
     SQL_ERROR = -1
     SQL_INVALID_HANDLE = -2
     SQL_NULL_HANDLE = 0
     SQL_OV_ODBC3 = 3
     SQL_COMMIT = 0
     SQL_ROLLBACK = 1
-    SQL_ATTR_AUTOCOMMIT = 102
+    SQL_SMALLINT = 5
+    SQL_CHAR = 1
+    SQL_WCHAR = -8
+    SQL_WVARCHAR = -9
+    SQL_BIT = -7
+    SQL_TINYINT = -6
+    SQL_BIGINT = -5
+    SQL_BINARY = -2
+    SQL_VARBINARY = -3
+    SQL_LONGVARBINARY = -4
+    SQL_LONGVARCHAR = -1
+    SQL_UNKNOWN_TYPE = 0
+    SQL_NUMERIC = 2
+    SQL_DECIMAL = 3
+    SQL_INTEGER = 4
+    SQL_FLOAT = 6
+    SQL_REAL = 7
+    SQL_DOUBLE = 8
+    SQL_DATETIME = 9
+    SQL_INTERVAL = 10
+    SQL_TIMESTAMP = 11
+    SQL_DATE = 9
+    SQL_TIME = 10
+    SQL_VARCHAR = 12
+    SQL_TYPE_DATE = 91
+    SQL_TYPE_TIME = 92
+    SQL_TYPE_TIMESTAMP = 93
+    SQL_TYPE_TIMESTAMP_WITH_TIMEZONE = 95
+    SQL_GUID = -11
+    SQL_XML = 241
+    SQL_SMALLDATETIME = 58
+    SQL_TIMESTAMPOFFSET = 43
+    SQL_DATETIME2 = 42
+    SQL_SMALLMONEY = 122
+    SQL_MONEY = 60
+    SQL_WLONGVARCHAR = -10
+    SQL_C_BIT = -7
+    SQL_C_TINYINT = -6
+    SQL_C_SBIGINT = -25
+    SQL_C_BINARY = -2
     SQL_AUTOCOMMIT_ON = 1
     SQL_AUTOCOMMIT_OFF = 0
+    SQL_C_VARBINARY = -3
+    SQL_C_LONGVARBINARY = -4
+    SQL_C_LONGVARCHAR = -1
+    SQL_C_CHAR = -8
+    SQL_C_NUMERIC = 2
+    SQL_C_DECIMAL = 3
+    SQL_C_LONG = 4
+    SQL_C_SHORT = 5
+    SQL_C_FLOAT = 7
+    SQL_C_DOUBLE = 8
+    SQL_C_TYPE_DATE = 91
+    SQL_C_TYPE_TIME = 92
+    SQL_C_TYPE_TIMESTAMP = 93
+    SQL_C_TYPE_TIMESTAMP_WITH_TIMEZONE = 95
+    SQL_C_GUID = -11
+    SQL_DESC_TYPE = 2
+    SQL_DESC_LENGTH = 3
+    SQL_DESC_NAME = 4
+    SQL_ATTR_ROW_ARRAY_SIZE = 27
+    SQL_ATTR_ROWS_FETCHED_PTR = 26
+    SQL_ATTR_ROW_STATUS_PTR = 25
+    SQL_FETCH_NEXT = 1
+    SQL_ROW_SUCCESS = 0
+    SQL_ROW_SUCCESS_WITH_INFO = 1
+    SQL_ROW_NOROW = 100
+    SQL_ATTR_CURSOR_TYPE = 6
+    SQL_CURSOR_FORWARD_ONLY = 0
+    SQL_CURSOR_STATIC = 3
+    SQL_CURSOR_KEYSET_DRIVEN = 2
+    SQL_CURSOR_DYNAMIC = 3
+    SQL_NULL_DATA = -1
+    SQL_C_DEFAULT = 99
+    SQL_ATTR_ROW_BIND_TYPE = 5
+    SQL_BIND_BY_COLUMN = 0
+    SQL_PARAM_INPUT = 1
+    SQL_PARAM_OUTPUT = 2
+    SQL_PARAM_INPUT_OUTPUT = 3
+    SQL_C_WCHAR = -8