From 98f72b40a896761a65b048cc3722ff2dac4cf2b1 Mon Sep 17 00:00:00 2001 From: Patrick Hayes Date: Wed, 23 Oct 2019 15:32:10 -0700 Subject: [PATCH] PR feedback --- lib/sqlalchemy/orm/query.py | 17 +++++++++++++++-- test/orm/test_query.py | 10 ++++++---- 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py index ad5ed412bc..da7c04b7c5 100644 --- a/lib/sqlalchemy/orm/query.py +++ b/lib/sqlalchemy/orm/query.py @@ -645,13 +645,26 @@ class Query(Generative): . .. versionadded:: 1.2.5 + .. seealso:: + + :meth:`.Query.is_single_entity` + """ self._only_return_tuples = value @property def is_single_entity(self): - """Returns True if this query returns a single entity for each instance in its - result list, and False if this query returns a tuple of entities for each result. + """Indicates if this :class:`.Query` returns tuples or single entities. + + Returns True if this query returns a single entity for each instance + in its result list, and False if this query returns a tuple of entities + for each result. + + .. versionadded:: 1.3.11 + + .. seealso:: + + :meth:`.Query.only_return_tuples` """ return ( diff --git a/test/orm/test_query.py b/test/orm/test_query.py index 1f38dbcd20..cdbeba1382 100644 --- a/test/orm/test_query.py +++ b/test/orm/test_query.py @@ -55,7 +55,9 @@ from sqlalchemy.sql import operators from sqlalchemy.testing import AssertsCompiledSQL from sqlalchemy.testing import fixtures from sqlalchemy.testing import is_ +from sqlalchemy.testing import is_false from sqlalchemy.testing import is_not_ +from sqlalchemy.testing import is_true from sqlalchemy.testing import mock from sqlalchemy.testing.assertions import assert_raises from sqlalchemy.testing.assertions import assert_raises_message @@ -97,14 +99,14 @@ class OnlyReturnTuplesTest(QueryTest): def test_single_entity_false(self): User = self.classes.User query = create_session().query(User).only_return_tuples(False) - assert query.is_single_entity is True + is_true(query.is_single_entity) row = query.first() assert isinstance(row, User) def test_single_entity_true(self): User = self.classes.User query = create_session().query(User).only_return_tuples(True) - assert query.is_single_entity is False + is_false(query.is_single_entity) row = query.first() assert isinstance(row, collections_abc.Sequence) @@ -115,7 +117,7 @@ class OnlyReturnTuplesTest(QueryTest): .query(User.id, User) .only_return_tuples(False) ) - assert query.is_single_entity is False + is_false(query.is_single_entity) row = query.first() assert isinstance(row, collections_abc.Sequence) @@ -126,7 +128,7 @@ class OnlyReturnTuplesTest(QueryTest): .query(User.id, User) .only_return_tuples(True) ) - assert query.is_single_entity is False + is_false(query.is_single_entity) row = query.first() assert isinstance(row, collections_abc.Sequence) -- 2.47.3