PublicArchive/sqlalchemy
2
0
Fork 0
mirror of https://github.com/sqlalchemy/sqlalchemy.git synced 2026-05-26 02:22:13 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix as many RST parse warnings as possible.

Browse Source 
Still a few I can't get.   Also 0.9 is EOL so hide the
unreleased notes.

Change-Id: If0e44d4a0b3e78e211f32d5c33b51b1a007c9c69
This commit is contained in:
Mike Bayer
2017-11-03 14:45:18 -04:00
parent 152522b3f2
commit 75bdcd096f
9 changed files with 65 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/build/changelog/changelog_09.rst
Vendored
+1 -3
View File
@@ -1,4 +1,3 @@
=============
0.9 Changelog
=============
@@ -11,7 +10,7 @@
.. include:: changelog_07.rst
:start-line: 5
.. changelog::
.. _unreleased_changelog::
:version: 0.9.11
.. change::
@@ -2047,7 +2046,6 @@
:ref:`relationship_custom_operator`
.. change::
:tags: bug, sqlite
doc/build/changelog/changelog_11.rst
Vendored
+4 -5
View File
@@ -1,5 +1,3 @@
=============
1.1 Changelog
=============
@@ -18,6 +16,7 @@
.. include:: changelog_07.rst
:start-line: 5
.. changelog::
:version: 1.1.15
:include_notes_from: unreleased_11
@@ -614,8 +613,8 @@
processing, as normally takes effect to handle both user-defined
type level conversions as well as dialect-required conversions, such
as those required for JSON datatypes. Additionally, clarified that
the keys in the set_ dictionary should match the "key" of the column,
if distinct from the column name. A warning is emitted
the keys in the ``set_`` dictionary should match the "key" of the
column, if distinct from the column name. A warning is emitted
for remaining column names that don't match column keys; for
compatibility reasons, these are emitted as they were previously.
@@ -658,7 +657,7 @@
:tickets: 3878
Fixed 1.1 regression where "import *" would not work for
sqlalchemy.sql.expression, due to mis-spelled "any_" and "all_"
sqlalchemy.sql.expression, due to mis-spelled ``any_`` and ``all_``
functions.
.. change:: 3880
doc/build/changelog/unreleased_12/4121.rst
Vendored
+4 -4
View File
@@ -2,10 +2,10 @@
:tags: bug, mssql
:tickets: 4121
Fixed bug where sqltypes.BINARY and sqltypes.VARBINARY datatypes
would not include correct bound-value handlers for pyodbc,
which allows the pyodbc.NullParam value to be passed that
helps with FreeTDS.
Fixed bug where sqltypes.BINARY and sqltypes.VARBINARY datatypes
would not include correct bound-value handlers for pyodbc,
which allows the pyodbc.NullParam value to be passed that
helps with FreeTDS.
lib/sqlalchemy/dialects/mssql/__init__.py
+2 -2
View File
@@ -15,7 +15,7 @@ from sqlalchemy.dialects.mssql.base import \
NCHAR, TEXT, NTEXT, DECIMAL, NUMERIC, FLOAT, DATETIME,\
DATETIME2, DATETIMEOFFSET, DATE, TIME, SMALLDATETIME, \
BINARY, VARBINARY, BIT, REAL, IMAGE, TIMESTAMP, ROWVERSION, \
MONEY, SMALLMONEY, UNIQUEIDENTIFIER, SQL_VARIANT, dialect
MONEY, SMALLMONEY, UNIQUEIDENTIFIER, SQL_VARIANT, XML, dialect
__all__ = (
@@ -23,5 +23,5 @@ __all__ = (
'NCHAR', 'TEXT', 'NTEXT', 'DECIMAL', 'NUMERIC', 'FLOAT', 'DATETIME',
'DATETIME2', 'DATETIMEOFFSET', 'DATE', 'TIME', 'SMALLDATETIME',
'BINARY', 'VARBINARY', 'BIT', 'REAL', 'IMAGE', 'TIMESTAMP', 'ROWVERSION',
'MONEY', 'SMALLMONEY', 'UNIQUEIDENTIFIER', 'SQL_VARIANT', 'dialect'
'MONEY', 'SMALLMONEY', 'UNIQUEIDENTIFIER', 'SQL_VARIANT', 'XML', 'dialect'
)
lib/sqlalchemy/dialects/postgresql/dml.py
+33 -32
View File
@@ -54,40 +54,41 @@ class Insert(StandardInsert):
required, but only one of these can be specified.
:param constraint:
The name of a unique or exclusion constraint on the table,
or the constraint object itself if it has a .name attribute.
The name of a unique or exclusion constraint on the table,
or the constraint object itself if it has a .name attribute.
:param index_elements:
A sequence consisting of string column names, :class:`.Column`
objects, or other column expression objects that will be used
to infer a target index.
A sequence consisting of string column names, :class:`.Column`
objects, or other column expression objects that will be used
to infer a target index.
:param index_where:
Additional WHERE criterion that can be used to infer a
conditional target index.
Additional WHERE criterion that can be used to infer a
conditional target index.
:param set_:
Required argument. A dictionary or other mapping object
with column names as keys and expressions or literals as values,
specifying the ``SET`` actions to take.
If the target :class:`.Column` specifies a ".key" attribute distinct
from the column name, that key should be used.
Required argument. A dictionary or other mapping object
with column names as keys and expressions or literals as values,
specifying the ``SET`` actions to take.
If the target :class:`.Column` specifies a ".key" attribute distinct
from the column name, that key should be used.
.. warning:: This dictionary does **not** take into account
Python-specified default UPDATE values or generation functions,
e.g. those specified using :paramref:`.Column.onupdate`.
These values will not be exercised for an ON CONFLICT style of
UPDATE, unless they are manually specified in the
:paramref:`.Insert.on_conflict_do_update.set_` dictionary.
.. warning:: This dictionary does **not** take into account
Python-specified default UPDATE values or generation functions,
e.g. those specified using :paramref:`.Column.onupdate`.
These values will not be exercised for an ON CONFLICT style of
UPDATE, unless they are manually specified in the
:paramref:`.Insert.on_conflict_do_update.set_` dictionary.
:param where:
Optional argument. If present, can be a literal SQL
string or an acceptable expression for a ``WHERE`` clause
that restricts the rows affected by ``DO UPDATE SET``. Rows
not meeting the ``WHERE`` condition will not be updated
(effectively a ``DO NOTHING`` for those rows).
Optional argument. If present, can be a literal SQL
string or an acceptable expression for a ``WHERE`` clause
that restricts the rows affected by ``DO UPDATE SET``. Rows
not meeting the ``WHERE`` condition will not be updated
(effectively a ``DO NOTHING`` for those rows).
.. versionadded:: 1.1
.. versionadded:: 1.1
.. seealso::
@@ -109,19 +110,19 @@ class Insert(StandardInsert):
are optional, but only one of these can be specified.
:param constraint:
The name of a unique or exclusion constraint on the table,
or the constraint object itself if it has a .name attribute.
The name of a unique or exclusion constraint on the table,
or the constraint object itself if it has a .name attribute.
:param index_elements:
A sequence consisting of string column names, :class:`.Column`
objects, or other column expression objects that will be used
to infer a target index.
A sequence consisting of string column names, :class:`.Column`
objects, or other column expression objects that will be used
to infer a target index.
:param index_where:
Additional WHERE criterion that can be used to infer a
conditional target index.
Additional WHERE criterion that can be used to infer a
conditional target index.
.. versionadded:: 1.1
.. versionadded:: 1.1
.. seealso::
lib/sqlalchemy/dialects/postgresql/psycopg2.py
+7 -7
View File
@@ -5,12 +5,11 @@
# This module is part of SQLAlchemy and is released under
# the MIT License: http://www.opensource.org/licenses/mit-license.php
"""
r"""
.. dialect:: postgresql+psycopg2
:name: psycopg2
:dbapi: psycopg2
:connectstring: postgresql+psycopg2://user:password@host:port/dbname\
[?key=value&key=value...]
:connectstring: postgresql+psycopg2://user:password@host:port/dbname[?key=value&key=value...]
:url: http://pypi.python.org/pypi/psycopg2/
psycopg2 Connect Arguments
@@ -31,6 +30,7 @@ psycopg2-specific keyword arguments which are accepted by
Note that the :paramref:`.Connection.execution_options.stream_results`
execution option is a more targeted
way of enabling this mode on a per-execution basis.
* ``use_native_unicode``: Enable the usage of Psycopg2 "native unicode" mode
per connection. True by default.
@@ -56,7 +56,8 @@ psycopg2-specific keyword arguments which are accepted by
* ``use_batch_mode``: This flag allows ``psycopg2.extras.execute_batch``
for ``cursor.executemany()`` calls performed by the :class:`.Engine`.
It is currently experimental but
may well become True by default as it is critical for executemany performance.
may well become True by default as it is critical for executemany
performance.
.. seealso::
@@ -79,10 +80,9 @@ using ``host`` as an additional keyword argument::
create_engine("postgresql+psycopg2://user:password@/dbname?\
host=/var/lib/postgresql")
See also:
.. seealso::
`PQconnectdbParams <http://www.postgresql.org/docs/9.1/static/\
libpq-connect.html#LIBPQ-PQCONNECTDBPARAMS>`_
`PQconnectdbParams <http://www.postgresql.org/docs/9.1/static/libpq-connect.html#LIBPQ-PQCONNECTDBPARAMS>`_
.. _psycopg2_execution_options:
lib/sqlalchemy/dialects/sqlite/base.py
+2 -2
View File
@@ -531,8 +531,7 @@ class DATETIME(_DateTimeMixin, sqltypes.DateTime):
The default string storage format is::
"%(year)04d-%(month)02d-%(day)02d %(hour)02d:%(min)02d:\
%(second)02d.%(microsecond)06d"
"%(year)04d-%(month)02d-%(day)02d %(hour)02d:%(min)02d:%(second)02d.%(microsecond)06d"
e.g.::
@@ -558,6 +557,7 @@ class DATETIME(_DateTimeMixin, sqltypes.DateTime):
Otherwise, if positional groups are used, the datetime() constructor
is called with positional arguments via
``*map(int, match_obj.groups(0))``.
"""
_storage_format = (
lib/sqlalchemy/orm/session.py
+10 -10
View File
@@ -179,25 +179,25 @@ class SessionTransaction(object):
.. seealso::
:meth:`.Session.rollback`
:meth:`.Session.rollback`
:meth:`.Session.commit`
:meth:`.Session.commit`
:meth:`.Session.begin`
:meth:`.Session.begin`
:meth:`.Session.begin_nested`
:meth:`.Session.begin_nested`
:attr:`.Session.is_active`
:attr:`.Session.is_active`
:meth:`.SessionEvents.after_transaction_create`
:meth:`.SessionEvents.after_transaction_create`
:meth:`.SessionEvents.after_transaction_end`
:meth:`.SessionEvents.after_transaction_end`
:meth:`.SessionEvents.after_commit`
:meth:`.SessionEvents.after_commit`
:meth:`.SessionEvents.after_rollback`
:meth:`.SessionEvents.after_rollback`
:meth:`.SessionEvents.after_soft_rollback`
:meth:`.SessionEvents.after_soft_rollback`
"""
lib/sqlalchemy/pool.py
+2 -1
View File
@@ -226,7 +226,7 @@ class Pool(log.Identified):
to the :class:`.Pool`.
:param pre_ping: if True, the pool will emit a "ping" (typically
"SELECT 1", but is dialect-specific) on the connection
"SELECT 1", but is dialect-specific) on the connection
upon checkout, to test if the connection is alive or not. If not,
the connection is transparently re-connected and upon success, all
other pooled connections established prior to that timestamp are
@@ -234,6 +234,7 @@ class Pool(log.Identified):
interpret the disconnection error.
.. versionadded:: 1.2
"""
if logging_name:
self.logging_name = self._orig_logging_name = logging_name