From e83459d37d6ce687fbfd0fc5162707243d04611a Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Mon, 9 Jun 2008 01:49:59 +0000 Subject: [PATCH] docstrings for instances()/iterate_instances() --- lib/sqlalchemy/orm/query.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py index df775a1772..43a7c41a3a 100644 --- a/lib/sqlalchemy/orm/query.py +++ b/lib/sqlalchemy/orm/query.py @@ -1042,9 +1042,26 @@ class Query(object): return self.iterate_instances(result, querycontext) def instances(self, cursor, __context=None): + """Given a ResultProxy cursor as returned by connection.execute(), return an ORM result as a list. + + e.g.:: + + result = engine.execute("select * from users") + users = session.query(User).instances(result) + + """ return list(self.iterate_instances(cursor, __context)) def iterate_instances(self, cursor, __context=None): + """Given a ResultProxy cursor as returned by connection.execute(), return an ORM result as an iterator. + + e.g.:: + + result = engine.execute("select * from users") + for u in session.query(User).iterate_instances(result): + print u + + """ session = self.session context = __context -- 2.47.3