summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2014-12-27 16:54:32 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2014-12-27 16:54:32 -0500
commit5343d24fee5219de002a8efba8bc882f8b3d4b5b (patch)
treece994df2b8df10ed08e070192c0a05dfbb2e9ee5
parent544e72bcb6af1ca657b1762f105634372eca3bc0 (diff)
downloadsqlalchemy-5343d24fee5219de002a8efba8bc882f8b3d4b5b.tar.gz
corrections
-rw-r--r--doc/build/changelog/changelog_10.rst2
-rw-r--r--doc/build/conf.py8
-rw-r--r--doc/build/core/connections.rst9
-rw-r--r--doc/build/core/constraints.rst4
-rw-r--r--doc/build/core/ddl.rst33
-rw-r--r--doc/build/core/functions.rst3
-rw-r--r--doc/build/core/internals.rst7
-rw-r--r--doc/build/orm/internals.rst3
-rw-r--r--lib/sqlalchemy/dialects/postgresql/base.py2
-rw-r--r--lib/sqlalchemy/engine/__init__.py1
-rw-r--r--lib/sqlalchemy/engine/base.py2
-rw-r--r--lib/sqlalchemy/ext/hybrid.py2
-rw-r--r--lib/sqlalchemy/schema.py1
-rw-r--r--lib/sqlalchemy/sql/ddl.py2
-rw-r--r--lib/sqlalchemy/sql/type_api.py2
15 files changed, 53 insertions, 28 deletions
diff --git a/doc/build/changelog/changelog_10.rst b/doc/build/changelog/changelog_10.rst
index ceed4d912..3564ecde1 100644
--- a/doc/build/changelog/changelog_10.rst
+++ b/doc/build/changelog/changelog_10.rst
@@ -861,7 +861,7 @@
.. change::
:tags: bug, orm, py3k
- The :class:`.IdentityMap` exposed from :class:`.Session.identity_map`
+ The :class:`.IdentityMap` exposed from :attr:`.Session.identity_map`
now returns lists for ``items()`` and ``values()`` in Py3K.
Early porting to Py3K here had these returning iterators, when
they technically should be "iterable views"..for now, lists are OK.
diff --git a/doc/build/conf.py b/doc/build/conf.py
index 02784bdae..22b377fa1 100644
--- a/doc/build/conf.py
+++ b/doc/build/conf.py
@@ -37,7 +37,7 @@ extensions = [
'zzzeeksphinx',
'changelog',
'sphinx_paramlinks',
- 'corrections'
+ #'corrections'
]
# Add any paths that contain templates here, relative to this directory.
@@ -79,7 +79,9 @@ autodocmods_convert_modname = {
"sqlalchemy.sql.selectable": "sqlalchemy.sql.expression",
"sqlalchemy.sql.dml": "sqlalchemy.sql.expression",
"sqlalchemy.sql.ddl": "sqlalchemy.schema",
- "sqlalchemy.sql.base": "sqlalchemy.sql.expression"
+ "sqlalchemy.sql.base": "sqlalchemy.sql.expression",
+ "sqlalchemy.engine.base": "sqlalchemy.engine",
+ "sqlalchemy.engine.result": "sqlalchemy.engine",
}
autodocmods_convert_modname_w_class = {
@@ -192,7 +194,7 @@ html_title = "%s %s Documentation" % (project, version)
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['static']
+html_static_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
diff --git a/doc/build/core/connections.rst b/doc/build/core/connections.rst
index 248309a2e..bb04b9496 100644
--- a/doc/build/core/connections.rst
+++ b/doc/build/core/connections.rst
@@ -559,6 +559,9 @@ The above will respond to ``create_engine("mysql+foodialect://")`` and load the
Connection / Engine API
=======================
+.. autoclass:: BaseRowProxy
+ :members:
+
.. autoclass:: Connection
:members:
@@ -568,16 +571,16 @@ Connection / Engine API
.. autoclass:: Engine
:members:
-.. autoclass:: sqlalchemy.engine.ExceptionContext
+.. autoclass:: ExceptionContext
:members:
.. autoclass:: NestedTransaction
:members:
-.. autoclass:: sqlalchemy.engine.ResultProxy
+.. autoclass:: ResultProxy
:members:
-.. autoclass:: sqlalchemy.engine.RowProxy
+.. autoclass:: RowProxy
:members:
.. autoclass:: Transaction
diff --git a/doc/build/core/constraints.rst b/doc/build/core/constraints.rst
index 554d003bb..15d0405fe 100644
--- a/doc/build/core/constraints.rst
+++ b/doc/build/core/constraints.rst
@@ -7,11 +7,11 @@
Defining Constraints and Indexes
=================================
-.. _metadata_foreignkeys:
-
This section will discuss SQL :term:`constraints` and indexes. In SQLAlchemy
the key classes include :class:`.ForeignKeyConstraint` and :class:`.Index`.
+.. _metadata_foreignkeys:
+
Defining Foreign Keys
---------------------
diff --git a/doc/build/core/ddl.rst b/doc/build/core/ddl.rst
index cee6f876e..6607ac9f8 100644
--- a/doc/build/core/ddl.rst
+++ b/doc/build/core/ddl.rst
@@ -223,65 +223,72 @@ DDL Expression Constructs API
.. autoclass:: DDLElement
:members:
:undoc-members:
-
+
.. autoclass:: DDL
:members:
:undoc-members:
-
+
+
+.. autoclass:: _DDLCompiles
+ :members:
+
+
+.. autoclass:: _CreateDropBase
+ :members:
.. autoclass:: CreateTable
:members:
:undoc-members:
-
+
.. autoclass:: DropTable
:members:
:undoc-members:
-
+
.. autoclass:: CreateColumn
:members:
:undoc-members:
-
+
.. autoclass:: CreateSequence
:members:
:undoc-members:
-
+
.. autoclass:: DropSequence
:members:
:undoc-members:
-
+
.. autoclass:: CreateIndex
:members:
:undoc-members:
-
+
.. autoclass:: DropIndex
:members:
:undoc-members:
-
+
.. autoclass:: AddConstraint
:members:
:undoc-members:
-
+
.. autoclass:: DropConstraint
:members:
:undoc-members:
-
+
.. autoclass:: CreateSchema
:members:
:undoc-members:
-
+
.. autoclass:: DropSchema
:members:
:undoc-members:
-
+
diff --git a/doc/build/core/functions.rst b/doc/build/core/functions.rst
index d284d125f..90164850d 100644
--- a/doc/build/core/functions.rst
+++ b/doc/build/core/functions.rst
@@ -22,6 +22,7 @@ return types are in use.
.. automodule:: sqlalchemy.sql.functions
:members:
:undoc-members:
-
+ :exclude-members: func
+
diff --git a/doc/build/core/internals.rst b/doc/build/core/internals.rst
index 1a85e9e6c..81b4f1a81 100644
--- a/doc/build/core/internals.rst
+++ b/doc/build/core/internals.rst
@@ -7,6 +7,9 @@ Some key internal constructs are listed here.
.. currentmodule: sqlalchemy
+.. autoclass:: sqlalchemy.schema.ColumnCollectionMixin
+ :members:
+
.. autoclass:: sqlalchemy.engine.interfaces.Compiled
:members:
@@ -29,6 +32,10 @@ Some key internal constructs are listed here.
:members:
+.. autoclass:: sqlalchemy.log.Identified
+ :members:
+
+
.. autoclass:: sqlalchemy.sql.compiler.IdentifierPreparer
:members:
diff --git a/doc/build/orm/internals.rst b/doc/build/orm/internals.rst
index 4b6802394..07cc2b472 100644
--- a/doc/build/orm/internals.rst
+++ b/doc/build/orm/internals.rst
@@ -33,6 +33,9 @@ sections, are listed here.
:members:
+.. autoclass:: sqlalchemy.orm.identity.IdentityMap
+ :members:
+
.. autoclass:: sqlalchemy.orm.base.InspectionAttr
:members:
diff --git a/lib/sqlalchemy/dialects/postgresql/base.py b/lib/sqlalchemy/dialects/postgresql/base.py
index d1fcbef3e..d870dd295 100644
--- a/lib/sqlalchemy/dialects/postgresql/base.py
+++ b/lib/sqlalchemy/dialects/postgresql/base.py
@@ -266,7 +266,7 @@ will emit to the database::
The Postgresql text search functions such as ``to_tsquery()``
and ``to_tsvector()`` are available
-explicitly using the standard :attr:`.func` construct. For example::
+explicitly using the standard :data:`.func` construct. For example::
select([
func.to_tsvector('fat cats ate rats').match('cat & rat')
diff --git a/lib/sqlalchemy/engine/__init__.py b/lib/sqlalchemy/engine/__init__.py
index cf75871bf..3857bdf1e 100644
--- a/lib/sqlalchemy/engine/__init__.py
+++ b/lib/sqlalchemy/engine/__init__.py
@@ -72,6 +72,7 @@ from .base import (
)
from .result import (
+ BaseRowProxy,
BufferedColumnResultProxy,
BufferedColumnRow,
BufferedRowResultProxy,
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py
index 918ee0e37..ee8267c5c 100644
--- a/lib/sqlalchemy/engine/base.py
+++ b/lib/sqlalchemy/engine/base.py
@@ -743,7 +743,7 @@ class Connection(Connectable):
a subclass of :class:`.Executable`, such as a
:func:`~.expression.select` construct
* a :class:`.FunctionElement`, such as that generated
- by :attr:`.func`, will be automatically wrapped in
+ by :data:`.func`, will be automatically wrapped in
a SELECT statement, which is then executed.
* a :class:`.DDLElement` object
* a :class:`.DefaultGenerator` object
diff --git a/lib/sqlalchemy/ext/hybrid.py b/lib/sqlalchemy/ext/hybrid.py
index e2739d1de..d89a13fc9 100644
--- a/lib/sqlalchemy/ext/hybrid.py
+++ b/lib/sqlalchemy/ext/hybrid.py
@@ -145,7 +145,7 @@ usage of the absolute value function::
return func.abs(cls.length) / 2
Above the Python function ``abs()`` is used for instance-level
-operations, the SQL function ``ABS()`` is used via the :attr:`.func`
+operations, the SQL function ``ABS()`` is used via the :data:`.func`
object for class-level expressions::
>>> i1.radius
diff --git a/lib/sqlalchemy/schema.py b/lib/sqlalchemy/schema.py
index 4b6ad1988..95ebd05db 100644
--- a/lib/sqlalchemy/schema.py
+++ b/lib/sqlalchemy/schema.py
@@ -35,6 +35,7 @@ from .sql.schema import (
UniqueConstraint,
_get_table_key,
ColumnCollectionConstraint,
+ ColumnCollectionMixin
)
diff --git a/lib/sqlalchemy/sql/ddl.py b/lib/sqlalchemy/sql/ddl.py
index 1f2c448ea..534322c8d 100644
--- a/lib/sqlalchemy/sql/ddl.py
+++ b/lib/sqlalchemy/sql/ddl.py
@@ -370,7 +370,7 @@ class DDL(DDLElement):
:class:`.DDLEvents`
- :mod:`sqlalchemy.event`
+ :ref:`event_toplevel`
"""
diff --git a/lib/sqlalchemy/sql/type_api.py b/lib/sqlalchemy/sql/type_api.py
index d414daf2a..03fed3878 100644
--- a/lib/sqlalchemy/sql/type_api.py
+++ b/lib/sqlalchemy/sql/type_api.py
@@ -252,7 +252,7 @@ class TypeEngine(Visitable):
The construction of :meth:`.TypeEngine.with_variant` is always
from the "fallback" type to that which is dialect specific.
The returned type is an instance of :class:`.Variant`, which
- itself provides a :meth:`~sqlalchemy.types.Variant.with_variant`
+ itself provides a :meth:`.Variant.with_variant`
that can be called repeatedly.
:param type_: a :class:`.TypeEngine` that will be selected