summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/sql/compiler.py
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2016-01-08 16:27:37 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2016-01-08 16:27:37 -0500
commit777e25694f1567ff61655d86a91be6264186c13e (patch)
treecee370b6a3c8d305cce45b4dc05f73c4fee73cb3 /lib/sqlalchemy/sql/compiler.py
parent1539268cf705bff0c7b02814266fc1867dc82d2c (diff)
downloadsqlalchemy-777e25694f1567ff61655d86a91be6264186c13e.tar.gz
- fix docstrings
Diffstat (limited to 'lib/sqlalchemy/sql/compiler.py')
-rw-r--r--lib/sqlalchemy/sql/compiler.py31
1 files changed, 16 insertions, 15 deletions
diff --git a/lib/sqlalchemy/sql/compiler.py b/lib/sqlalchemy/sql/compiler.py
index 2fe6ea02c..98ab60aaa 100644
--- a/lib/sqlalchemy/sql/compiler.py
+++ b/lib/sqlalchemy/sql/compiler.py
@@ -168,11 +168,11 @@ class Compiled(object):
def __init__(self, dialect, statement, bind=None,
compile_kwargs=util.immutabledict()):
- """Construct a new ``Compiled`` object.
+ """Construct a new :class:`.Compiled` object.
- :param dialect: ``Dialect`` to compile against.
+ :param dialect: :class:`.Dialect` to compile against.
- :param statement: ``ClauseElement`` to be compiled.
+ :param statement: :class:`.ClauseElement` to be compiled.
:param bind: Optional Engine or Connection to compile this
statement against.
@@ -288,11 +288,9 @@ class _CompileLabel(visitors.Visitable):
class SQLCompiler(Compiled):
+ """Default implementation of :class:`.Compiled`.
- """Default implementation of Compiled.
-
- Compiles ClauseElements into SQL strings. Uses a similar visit
- paradigm as visitors.ClauseVisitor but implements its own traversal.
+ Compiles :class:`.ClauseElement` objects into SQL strings.
"""
@@ -335,17 +333,20 @@ class SQLCompiler(Compiled):
def __init__(self, dialect, statement, column_keys=None,
inline=False, **kwargs):
- """Construct a new ``DefaultCompiler`` object.
+ """Construct a new :class:`.SQLCompiler` object.
+
+ :param dialect: :class:`.Dialect` to be used
+
+ :param statement: :class:`.ClauseElement` to be compiled
- dialect
- Dialect to be used
+ :param column_keys: a list of column names to be compiled into an
+ INSERT or UPDATE statement.
- statement
- ClauseElement to be compiled
+ :param inline: whether to generate INSERT statements as "inline", e.g.
+ not formatted to return any generated defaults
- column_keys
- a list of column names to be compiled into an INSERT or UPDATE
- statement.
+ :param kwargs: additional keyword arguments to be consumed by the
+ superclass.
"""
self.column_keys = column_keys