FEAT: Add to_dict(), keys(), values(), items(), __contains__ to Row

[jahnvi480]

Work Item / Issue Reference

AB#45369

GitHub Issue: #606

---

Summary

This pull request adds new dictionary-like methods and membership testing to the Row class in mssql_python/row.py, and introduces corresponding unit tests to ensure their correct behavior. These enhancements make Row instances more intuitive and compatible with Python's mapping protocol, improving usability and testability.

Enhancements to the Row class:

• Added keys(), values(), and items() methods to Row, allowing access to column names, values, and (name, value) pairs in a dictionary-like fashion.
• Implemented a to_dict() method to return the row as a plain dictionary mapping column names to values.
• Added support for the in operator to test for column membership, including case-insensitive matching when a lowercase column map is provided.

Testing improvements:

• Added tests for to_dict(), keys(), values(), and items() methods to verify they behave like their dict counterparts.
• Added tests for the in operator, including both case-sensitive and case-insensitive membership checks.

[Copilot]

Pull request overview

Adds dict-like helpers (keys(), values(), items(), to_dict()) and __contains__ to the Row class so rows behave more like mappings, addressing issue #606. New unit tests cover each helper and the case-insensitive membership path.

Changes:

• Add keys(), values(), items(), to_dict() to Row, sourced from self._column_map and self._values.
• Add __contains__ with case-insensitive fallback via self._column_map_lower.
• Add four new tests in tests/test_001_globals.py exercising the helpers and in operator (case-sensitive and case-insensitive).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
mssql_python/row.py	Implements the new mapping-style methods and membership protocol on Row.
tests/test_001_globals.py	Adds tests for to_dict, keys/values/items, and __contains__ (case-sensitive + insensitive).

Key concern: in real cursor-built rows, _column_map stores each column under both its original-cased name and a lowercase alias, so keys()/items()/to_dict() will emit each column twice and len(keys()) != len(values()). The new tests use a hand-built column_map without the lowercase aliases, so they don't catch this — see the inline comment for details and suggested directions.

---

💡 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: 6690 out of 8261 📁 Project: mssql-python

---

Diff Coverage

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

• mssql_python/row.py (100%)

Summary

• Total: 23 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.9%
mssql_python.pybind.logger_bridge.hpp: 70.8%
mssql_python.pybind.ddbc_bindings.cpp: 76.3%
mssql_python.__init__.py: 77.3%
mssql_python.pybind.connection.connection.cpp: 77.3%
mssql_python.ddbc_bindings.py: 79.6%
mssql_python.row.py: 81.8%
mssql_python.logging.py: 85.5%
mssql_python.connection.py: 85.6%

---

🔗 Quick Links

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

[bewithgaurav]

perf regression on Row.__init__ from the column_names kwarg - fix suggestion + details inline
two other suggestions on type annotations, docstring)

[bewithgaurav]

regression caused from previous suggestion:

_get_column_names() reads self._cursor.description lazily on first call. if the cursor re-executes before keys()/to_dict() is called on an old row, the old row picks up the new query's column names. repro:

cursor.execute("SELECT 1 AS OrderID, 'Widget' AS Product, 9.99 AS Price")
order = cursor.fetchone()

cursor.execute("SELECT 100 AS CustomerID, 'Alice' AS Name")
customer = cursor.fetchone()

order.to_dict()
# expected: {'OrderID': 1, 'Product': 'Widget', 'Price': 9.99}
# actual:   {'CustomerID': 1, 'Name': 'Widget'}
# Price silently dropped (zip truncates 3 values to 2 columns)

fix: snapshot cursor.description at construction time instead of reading it live. one pointer assignment, no computation:

def __init__(self, ...):
    self._column_names = None
    self._description = cursor.description if cursor else None

def _get_column_names(self) -> tuple:
    if self._column_names is not None:
        return self._column_names
    if self._description:
        column_names = tuple(desc[0] for desc in self._description)
    elif self._column_map:
        ...

still lazy, still zero-cost if keys()/to_dict() is never called, but safe on cursor reuse.

[bewithgaurav]

just checked during testing, adding keys(), values(), items(), to_dict() shadows column attribute access for any column with those names. repro:

cursor.execute("SELECT 'timeout' AS keys, '30' AS [values]")
row = cursor.fetchone()

row.keys    # before PR: 'timeout'  (via __getattr__)
row.keys    # after PR:  <bound method Row.keys>
row["keys"] # still works: 'timeout'

class methods win over __getattr__ in Python's MRO. this is a silent breaking change for existing code using row.keys or row.values as column attribute access.

[bewithgaurav]

to_dict() silently loses data when the query has duplicate column names. common in joins:

cursor.execute("""
    SELECT e.id, e.name, m.id, m.name
    FROM employees e LEFT JOIN employees m ON e.manager_id = m.id
""")
row = cursor.fetchone()

list(row)       # [1, 'Alice', 2, 'Bob']  — 4 values
row.to_dict()   # {'id': 2, 'name': 'Bob'} — 2 entries, Alice gone

lets discuss approaching this