Skip to content

Doc bug: cursor_description attribute on Row object #657

Closed

Description

Describe the bug

According to the documentation for Row:

Attributes
cursor_description A copy of the Cursor.description object from the Cursor that created this row. This contains the column names and data types of the columns. See [Cursor.description](https://github.com/microsoft/mssql-python/wiki/Cursor#description)

... that doesn't seem to be true. The row class exposes no such attribute. I'm fine with that and I think #613 will satisfy most use cases here. So I think the doc just needs to get updated.

Activity

  1. github-actions commented on Jul 1, 2026

    @github-actions

    Hi Adam Machanic (@amachanic), thank you for opening this issue!

    Our team will review it shortly. We aim to triage all new issues within 24-48 hours and get back to you.

    If you have additional information to share, please feel free to update the issue.

    Thank you for your patience!

  2. jahnvi480 commented on Jul 2, 2026

    @jahnvi480
    Contributor

    Thanks for reporting this @amachanic. I can confirm this is indeed a documentation bug — the Row class does not expose a cursor_description attribute. The class internally holds a _cursor reference but never surfaces cursor.description as a public property.

    Fix needed: The Row wiki page should have the cursor_description attribute removed from the Attributes section, since it was never implemented.

  3. added
    documentationImprovements or additions to documentation
    area: api-compliancePython API behavior and typing: DB-API 2.0, exceptions, type stubs, new APIs.
    and removed
    triage neededFor new issues, not triaged yet.
    on Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

FIXEDarea: api-compliancePython API behavior and typing: DB-API 2.0, exceptions, type stubs, new APIs.documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions