summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/sql/base.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2014-02-25 20:10:52 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2014-02-25 20:10:52 -0500
commitf9492ef90641c2fa55bcd1ecc93ddcef7f82f08d (patch)
treebeff152a4e348a5842ee973d0080af48062df3d4 /lib/sqlalchemy/sql/base.py
parent33f07202ce2d9d34f346e9629dc602d920091cf1 (diff)
downloadsqlalchemy-f9492ef90641c2fa55bcd1ecc93ddcef7f82f08d.tar.gz
docs
Diffstat (limited to 'lib/sqlalchemy/sql/base.py')
-rw-r--r--lib/sqlalchemy/sql/base.py13
1 files changed, 10 insertions, 3 deletions
diff --git a/lib/sqlalchemy/sql/base.py b/lib/sqlalchemy/sql/base.py
index 26007b598..818a07deb 100644
--- a/lib/sqlalchemy/sql/base.py
+++ b/lib/sqlalchemy/sql/base.py
@@ -138,7 +138,14 @@ class _DialectArgDict(_DialectArgDictBase):
class DialectKWArgs(object):
"""Establish the ability for a class to have dialect-specific arguments
- with defaults and validation.
+ with defaults and constructor validation.
+
+ The :class:`.DialectKWArgs` interacts with the
+ :attr:`.DefaultDialect.construct_arguments` present on a dialect.
+
+ .. seealso::
+
+ :attr:`.DefaultDialect.construct_arguments`
"""
@@ -153,7 +160,7 @@ class DialectKWArgs(object):
some_index = Index('a', 'b', mydialect_length=5)
The :meth:`.DialectKWArgs.argument_for` method is a per-argument
- way adding extra arguments to the :attr:`.Dialect.construct_arguments`
+ way adding extra arguments to the :attr:`.DefaultDialect.construct_arguments`
dictionary. This dictionary provides a list of argument names accepted by
various schema-level constructs on behalf of a dialect.
@@ -164,7 +171,7 @@ class DialectKWArgs(object):
:param dialect_name: name of a dialect. The dialect must be locatable,
else a :class:`.NoSuchModuleError` is raised. The dialect must
- also include an existing :attr:`.Dialect.construct_arguments` collection,
+ also include an existing :attr:`.DefaultDialect.construct_arguments` collection,
indicating that it participates in the keyword-argument validation and
default system, else :class:`.ArgumentError` is raised.
If the dialect does not include this collection, then any keyword argument