From ee7fcf311068ca233de43eaec241ccc965c626a2 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Sun, 7 Dec 2008 06:30:00 +0000 Subject: - re-documented Table and Column constructors, fixed case sensitivity description [ticket:1231] - turned on autoclass_content="both". Need to specify __init__ docstring with a newline after the """. - other docs --- lib/sqlalchemy/engine/base.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'lib/sqlalchemy/engine/base.py') diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py index 97624280e..3a0c1af18 100644 --- a/lib/sqlalchemy/engine/base.py +++ b/lib/sqlalchemy/engine/base.py @@ -10,8 +10,13 @@ Defines the basic components used to interface DB-API modules with higher-level statement-construction, connection-management, execution and result contexts. + """ +__all__ = ['BufferedColumnResultProxy', 'BufferedColumnRow', 'BufferedRowResultProxy', 'Compiled', 'Connectable', + 'Connection', 'DefaultRunner', 'Dialect', 'Engine', 'ExecutionContext', 'NestedTransaction', 'ResultProxy', + 'RootTransaction', 'RowProxy', 'SchemaIterator', 'StringIO', 'Transaction', 'TwoPhaseTransaction', 'connection_memoize'] + import inspect, StringIO from sqlalchemy import exc, schema, util, types, log from sqlalchemy.sql import expression @@ -467,7 +472,12 @@ class Compiled(object): class Connectable(object): - """Interface for an object that can provide an Engine and a Connection object which correponds to that Engine.""" + """Interface for an object which supports execution of SQL constructs. + + The two implementations of ``Connectable`` are :class:`Connection` and + :class:`Engine`. + + """ def contextual_connect(self): """Return a Connection object which may be part of an ongoing context.""" -- cgit v1.2.1