summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/sql/expression.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2008-12-01 05:04:55 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2008-12-01 05:04:55 +0000
commit8617b3fe344f6613472f00cc318edc3d709e35cf (patch)
treeecedb9a68fbe84589ef454a960dc4a03e01e234a /lib/sqlalchemy/sql/expression.py
parent181424b743ba59ec2b6631b4d914df136757d2fd (diff)
downloadsqlalchemy-8617b3fe344f6613472f00cc318edc3d709e35cf.tar.gz
propagate docstrings for column/fk collections
Diffstat (limited to 'lib/sqlalchemy/sql/expression.py')
-rw-r--r--lib/sqlalchemy/sql/expression.py20
1 files changed, 13 insertions, 7 deletions
diff --git a/lib/sqlalchemy/sql/expression.py b/lib/sqlalchemy/sql/expression.py
index 4b47a119f..3d66ff21b 100644
--- a/lib/sqlalchemy/sql/expression.py
+++ b/lib/sqlalchemy/sql/expression.py
@@ -1851,25 +1851,31 @@ class FromClause(Selectable):
@util.memoized_property
def _columns(self):
+ """Return the collection of Column objects contained by this FromClause."""
+
self._export_columns()
return self._columns
-
+
@util.memoized_property
def _primary_key(self):
+ """Return the collection of Column objects which comprise the primary key of this FromClause."""
+
self._export_columns()
return self._primary_key
-
+
@util.memoized_property
def _foreign_keys(self):
+ """Return the collection of ForeignKey objects which this FromClause references."""
+
self._export_columns()
return self._foreign_keys
-
- columns = property(attrgetter('_columns'))
- primary_key = property(attrgetter('_primary_key'))
- foreign_keys = property(attrgetter('_foreign_keys'))
+
+ columns = property(attrgetter('_columns'), doc=_columns.__doc__)
+ primary_key = property(attrgetter('_primary_key'), doc=_primary_key.__doc__)
+ foreign_keys = property(attrgetter('_foreign_keys'), doc=_foreign_keys.__doc__)
# synonyms for 'columns'
- c = _select_iterable = property(attrgetter('columns'))
+ c = _select_iterable = property(attrgetter('columns'), doc=_columns.__doc__)
def _export_columns(self):
"""Initialize column collections."""