FEAT: Row string-key indexing

[jahnvi480]

Work Item / Issue Reference

AB#45119

GitHub Issue: #582

---

Summary

This pull request enhances the usability of the Row class by allowing access to row values using column names as string keys (e.g., row["col"]), in addition to existing integer index and attribute access. It also introduces case-insensitive string-key access when the cursor's lowercase attribute is enabled. Comprehensive tests have been added to ensure correct behavior for these new access patterns.

Enhancements to Row Access Patterns

• Updated the Row.__getitem__ method in mssql_python/row.py to support accessing values by column name as a string key, including case-insensitive lookup when the cursor's lowercase attribute is set.

Testing Additions

• Added test_row_string_key_indexing and test_row_string_key_case_insensitive_with_lowercase to tests/test_001_globals.py to verify string-key and case-insensitive access, as well as backward compatibility with integer and slice access.
• Added test_row_string_key_indexing to tests/test_004_cursor.py to test string-key access on real query results, ensuring consistency with index and attribute access and correct error handling for missing keys.

[Copilot]

Pull request overview

This PR restores/extends Row usability by allowing row["ColumnName"] access (in addition to positional and attribute access), addressing the regression reported in #582.

Changes:

• Updated Row.__getitem__ to accept string keys that map to column names.
• Added unit and integration tests covering string-key access and expected error behavior.
• Added a test intending to cover case-insensitive string-key lookup when lowercase mode is enabled.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
mssql_python/row.py	Adds string-key handling to Row.__getitem__ (including an intended case-insensitive path).
tests/test_001_globals.py	Adds unit tests for string-key indexing and a case-insensitive variant.
tests/test_004_cursor.py	Adds an integration test verifying string-key indexing against real query results.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

📊 Code Coverage Report

🔥 Diff Coverage 100%

🎯 Overall Coverage 80%

📈 Total Lines Covered: 6685 out of 8289 📁 Project: mssql-python

---

Diff Coverage

Diff: main...HEAD, staged and unstaged changes

• mssql_python/cursor.py (100%)
• mssql_python/row.py (100%)

Summary

• Total: 29 lines
• Missing: 0 lines
• Coverage: 100%

---

📋 Files Needing Attention

📉 Files with overall lowest coverage (click to expand)

mssql_python.pybind.logger_bridge.cpp: 59.2%
mssql_python.pybind.ddbc_bindings.h: 59.7%
mssql_python.pybind.logger_bridge.hpp: 70.8%
mssql_python.pybind.ddbc_bindings.cpp: 76.1%
mssql_python.row.py: 76.9%
mssql_python.__init__.py: 77.3%
mssql_python.pybind.connection.connection.cpp: 77.5%
mssql_python.ddbc_bindings.py: 79.6%
mssql_python.connection.py: 85.4%
mssql_python.logging.py: 85.5%

---

🔗 Quick Links

⚙️ Build Summary	📋 Coverage Details
View Azure DevOps Build	Browse Full Coverage Report

[bewithgaurav]

on a 2nd look, found a perf problem with column map (lowercase), can benefit from caching
requesting changes for the same

[bewithgaurav]

just added a test suggestion for e2e scenario - non-blocker
diff code coverage covers unit tests and is already at 100% so can skip
PR lgtm

[bewithgaurav]

nit: suggesting a test for the real cursor-built lowercase path end-to-end. the unit test covers Row with an injected column_map_lower, and this integration test covers string-key access with lowercase=False. what's missing is mixed-case DB columns + lowercase=True through an actual cursor. test_lowercase_attribute already has that exact table setup but only checks description column

rough shape for a test which can be e2e:

• create table with mixed-case columns (ID INT, UserName VARCHAR(50))
• insert a row
• set mssql_python.lowercase = True, open a fresh cursor, execute SELECT
• verify string-key access: row["username"] and row["USERNAME"] both return the value
• verify attribute access: row.username and row.USERNAME both work
• verify exact-case still works: row["id"] (lowercase, since that's what the cursor emits when lowercase is on)
• verify missing key still raises KeyError
• restore mssql_python.lowercase in finally