Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(db_api): emit warning instead of an exception for rowcount property #628

Merged
merged 4 commits into from Oct 26, 2021
Merged

fix(db_api): emit warning instead of an exception for rowcount property #628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e52f95
feat: emit warning instead of an exception for `rowcount` property
Oct 19, 2021
d70d9c5
Merge branch 'main' into exception_to_warn
larkee Oct 21, 2021
d32b799
Merge branch 'main' into exception_to_warn
larkee Oct 21, 2021
bc57a5e
Merge branch 'main' into exception_to_warn
Oct 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 7 additions & 4 deletions google/cloud/spanner_dbapi/cursor.py
View file
Open in desktop
Expand Up @@ -14,6 +14,9 @@

"""Database cursor for Google Cloud Spanner DB-API."""

import warnings
from collections import namedtuple

import sqlparse

from google.api_core.exceptions import Aborted
Expand All @@ -23,8 +26,6 @@
from google.api_core.exceptions import InvalidArgument
from google.api_core.exceptions import OutOfRange

from collections import namedtuple

from google.cloud import spanner_v1 as spanner
from google.cloud.spanner_dbapi.checksum import ResultsChecksum
from google.cloud.spanner_dbapi.exceptions import IntegrityError
Expand Down Expand Up @@ -120,10 +121,12 @@ def rowcount(self):

:raises: :class:`NotImplemented`.
"""
raise NotImplementedError(
warnings.warn(
"The `rowcount` property is non-operational. Request "
"resulting rows are streamed by the `fetch*()` methods "
"and can't be counted before they are all streamed."
"and can't be counted before they are all streamed.",
UserWarning,
stacklevel=2,
)

def _raise_if_closed(self):
Expand Down
14 changes: 11 additions & 3 deletions tests/unit/spanner_dbapi/test_cursor.py
View file
Open in desktop
Expand Up @@ -61,11 +61,19 @@ def test_property_description(self):
self.assertIsNotNone(cursor.description)
self.assertIsInstance(cursor.description[0], ColumnInfo)

def test_property_rowcount(self):
@mock.patch("warnings.warn")
def test_property_rowcount(self, warn_mock):
connection = self._make_connection(self.INSTANCE, self.DATABASE)
cursor = self._make_one(connection)
with self.assertRaises(NotImplementedError):
cursor.rowcount

cursor.rowcount
warn_mock.assert_called_once_with(
"The `rowcount` property is non-operational. Request "
"resulting rows are streamed by the `fetch*()` methods "
"and can't be counted before they are all streamed.",
UserWarning,
stacklevel=2,
)

def test_callproc(self):
from google.cloud.spanner_dbapi.exceptions import InterfaceError
Expand Down