- try to document how to get columns from constraints.

unfortunately Sphinx refuses to work correctly for the columns
attribute so we just add a lame message to contains_column().

(cherry picked from commit f211ad254d53b85aae319b41cc7b206f3e693660)

diff --git a/doc/build/core/constraints.rst b/doc/build/core/constraints.rst
index 9bf510d6a3f5582179f62de8abb2364e2c65bf4d..a979f3d7a093c33409fcee18618f0b2d73771cb2 100644 (file)
--- a/doc/build/core/constraints.rst
+++ b/doc/build/core/constraints.rst
@@ -435,6 +435,13 @@ Constraints API
 .. autoclass:: Constraint
     :members:
 
+.. autoclass:: ColumnCollectionMixin
+    :members:
+
+.. autoclass:: ColumnCollectionConstraint
+    :members:
+    :inherited-members:
+
 .. autoclass:: CheckConstraint
     :members:
     :inherited-members:
@@ -457,6 +464,7 @@ Constraints API
     :members:
     :inherited-members:
 
+
 .. autofunction:: sqlalchemy.schema.conv
 
 .. _schema_indexes:

diff --git a/doc/build/core/internals.rst b/doc/build/core/internals.rst
index 81b4f1a81a3de44c7808aeb2b68460195a26e2f5..56b6162e9f750275084886ab6ba63bba667d3f96 100644 (file)
--- a/doc/build/core/internals.rst
+++ b/doc/build/core/internals.rst
@@ -7,9 +7,6 @@ Some key internal constructs are listed here.
 
 .. currentmodule: sqlalchemy
 
-.. autoclass:: sqlalchemy.schema.ColumnCollectionMixin
-    :members:
-
 .. autoclass:: sqlalchemy.engine.interfaces.Compiled
     :members:
 

diff --git a/lib/sqlalchemy/sql/schema.py b/lib/sqlalchemy/sql/schema.py
index 8e7145284a06de570efc219b596ca3ffa553277c..a61389c777638b559ed1b184a6475d5f822dc886 100644 (file)
--- a/lib/sqlalchemy/sql/schema.py
+++ b/lib/sqlalchemy/sql/schema.py
@@ -2309,6 +2309,7 @@ def _to_schema_column_or_string(element):
 
 
 class ColumnCollectionMixin(object):
+
     columns = None
     """A :class:`.ColumnCollection` of :class:`.Column` objects.
 
@@ -2372,6 +2373,13 @@ class ColumnCollectionConstraint(ColumnCollectionMixin, Constraint):
         return self._schema_item_copy(c)
 
     def contains_column(self, col):
+        """Return True if this constraint contains the given column.
+
+        Note that this object also contains an attribute ``.columns``
+        which is a :class:`.ColumnCollection` of :class:`.Column` objects.
+
+        """
+
         return self.columns.contains_column(col)
 
     def __iter__(self):