Update sqlalchemy to 1.3.17

[pyup-bot]

This PR updates SQLAlchemy from 1.3.12 to 1.3.17.

Changelog

1.3.17

:released: May 13, 2020

 .. change::
     :tags: bug, oracle
     :tickets: 5246

     Some modifications to how the cx_oracle dialect sets up per-column
     outputtype handlers for LOB and numeric datatypes to adjust for potential
     changes coming in cx_Oracle 8.


 .. change::
     :tags: bug, orm
     :tickets: 5288

     Fixed bug where using :func:`.with_polymorphic` as the target of a join via
     :meth:`.RelationshipComparator.of_type` on a mapper that already has a
     subquery-based with_polymorphic setting that's equivalent to the one
     requested would not correctly alias the ON clause in the join.

 .. change::
     :tags: bug, oracle, performance
     :tickets: 5314

     Changed the implementation of fetching CLOB and BLOB objects to use
     cx_Oracle's native implementation which fetches CLOB/BLOB objects inline
     with other result columns, rather than performing a separate fetch. As
     always, this can be disabled by setting auto_convert_lobs to False.

     As part of this change, the behavior of a CLOB that was given a blank
     string on INSERT now returns None on SELECT, which is now consistent with
     that of VARCHAR on Oracle.


 .. change::
     :tags: usecase, postgresql
     :tickets: 5265

     Added support for columns or type :class:`.ARRAY` of :class:`.Enum`,
     :class:`.JSON` or :class:`_postgresql.JSONB` in PostgreSQL.
     Previously a workaround was required in these use cases.


 .. change::
     :tags: schema
     :tickets: 4138

     Add ``comment`` attribute to :class:`_schema.Column` ``__repr__`` method.

 .. change::
     :tags: bug, orm
     :tickets: 5303

     Fixed issue in the area of where loader options such as selectinload()
     interact with the baked query system, such that the caching of a query is
     not supposed to occur if the loader options themselves have elements such
     as with_polymorphic() objects in them that currently are not
     cache-compatible.  The baked loader could sometimes not fully invalidate
     itself in these some of these scenarios leading to missed eager loads.


 .. change::
     :tags: bug, engine
     :tickets: 5326

     Fixed fairly critical issue where the DBAPI connection could be returned to
     the connection pool while still in an un-rolled-back state. The reset agent
     responsible for rolling back the connection could be corrupted in the case
     that the transaction was "closed" without being rolled back or committed,
     which can occur in some scenarios when using ORM sessions and emitting
     .close() in a certain pattern involving savepoints.   The fix ensures that
     the reset agent is always active.


 .. change::
     :tags: bug, orm
     :tickets: 5304

     Modified the internal "identity set" implementation, which is a set that
     hashes objects on their id() rather than their hash values, to not actually
     call the ``__hash__()`` method of the objects, which are typically
     user-mapped objects.  Some methods were calling this method as a side
     effect of the implementation.


 .. change::
     :tags: usecase, postgresql
     :tickets: 5266

     Raise an explicit :class:`.exc.CompileError` when adding a table with a
     column of type :class:`.ARRAY` of :class:`.Enum` configured with
     :paramref:`.Enum.native_enum` set to ``False`` when
     :paramref:`.Enum.create_constraint` is not set to ``False``

 .. change::
     :tags: bug, schema
     :tickets: 5298

     Fixed issue where an :class:`.Index` that is deferred in being associated
     with a table, such as as when it contains a :class:`.Column` that is not
     associated with any :class:`.Table` yet,  would fail to attach correctly if
     it also contained a non table-oriented expession.


 .. change::
     :tags: change, firebird
     :tickets: 5278

     Adjusted dialect loading for ``firebird://`` URIs so the external
     sqlalchemy-firebird dialect will be used if it has been installed,
     otherwise fall back to the (now deprecated) internal Firebird dialect.

 .. change::
     :tags: bug, mssql, reflection
     :tickets: 5255

     Fix a regression introduced by the reflection of computed column in
     MSSQL when using the legacy TDS version 4.2. The dialect will try
     to detect the protocol version of first connect and run in compatibility
     mode if it cannot detect it.

 .. change::
     :tags: bug, mssql, reflection
     :tickets: 5271

     Fix a regression introduced by the reflection of computed column in
     MSSQL when using SQL server versions before 2012, which does not support
     the ``concat`` function.

 .. change::
     :tags: bug, orm
     :tickets: 5269

     An informative error message is raised when an ORM many-to-one comparison
     is attempted against an object that is not an actual mapped instance.
     Comparisons such as those to scalar subqueries aren't supported;
     generalized comparison with subqueries is better achieved using
     :meth:`~.RelationshipProperty.Comparator.has`.


 .. change::
     :tags: usecase, orm
     :tickets: 5262

     Added an accessor :attr:`.ColumnProperty.Comparator.expressions` which
     provides access to the group of columns mapped under a multi-column
     :class:`.ColumnProperty` attribute.


 .. change::
     :tags: bug, schema
     :tickets: 5316

     A warning is emitted when making use of the :attr:`.MetaData.sorted_tables`
     attribute as well as the :func:`_schema.sort_tables` function, and the
     given tables cannot be correctly sorted due to a cyclic dependency between
     foreign key constraints. In this case, the functions will no longer sort
     the involved tables by foreign key, and a warning will be emitted. Other
     tables that are not part of the cycle will still be returned in dependency
     order. Previously, the sorted_table routines would return a collection that
     would unconditionally omit all foreign keys when a cycle was detected, and
     no warning was emitted.


 .. change::
     :tags: orm, usecase
     :tickets: 5237

     Introduce :paramref:`_orm.relationship.sync_backref` flag in a relationship
     to control if the synchronization events that mutate the in-Python
     attributes are added. This supersedes the previous change :ticket:`5149`,
     which warned that ``viewonly=True`` relationship target of a
     back_populates or backref configuration would be disallowed.

.. changelog::

1.3.16

:released: April 7, 2020

 .. change::
     :tags: oracle, usecase
     :tickets: 5200

     Implemented AUTOCOMMIT isolation level for Oracle when using cx_Oracle.
     Also added a fixed default isolation level of READ COMMITTED for Oracle.


 .. change::
     :tags: bug, mysql
     :tickets: 5239

     Fixed issue in MySQL dialect when connecting to a psuedo-MySQL database
     such as that provided by ProxySQL, the up front check for isolation level
     when it returns no row will not prevent the dialect from continuing to
     connect. A warning is emitted that the isolation level could not be
     detected.


 .. change::
     :tags: bug, tests
     :tickets: 5201

     Fixed an issue that prevented the test suite from running with the
     recently released py.test 5.4.0.


 .. change::
     :tags: bug, oracle, reflection
     :tickets: 5146

     Fixed regression / incorrect fix caused by fix for :ticket:`5146` where the
     Oracle dialect reads from the "all_tab_comments" view to get table comments
     but fails to accommodate for the current owner of the table being
     requested, causing it to read the wrong comment if multiple tables of the
     same name exist in multiple schemas.


 .. change::
     :tags: types, enum
     :tickets: 5183

     The :class:`.Enum` type now supports the parameter :paramref:`.Enum.length`
     to specify the length of the VARCHAR column to create when using
     non native enums by setting :paramref:`.Enum.native_enum` to ``False``

 .. change::
     :tags: bug, orm
     :tickets: 5228

     Fixed bug in :func:`_orm.selectinload` loading option where two or more
     loaders that represent different relationships with the same string key
     name as referenced from a single :func:`_orm.with_polymorphic` construct
     with multiple subclass mappers would fail to invoke each subqueryload
     separately, instead making use of a single string-based slot that would
     prevent the other loaders from being invoked.


 .. change::
     :tags: schema, reflection
     :tickets: 5063

     Added support for reflection of "computed" columns, which are now returned
     as part of the structure returned by :meth:`_reflection.Inspector.get_columns`.
     When reflecting full :class:`_schema.Table` objects, computed columns will
     be represented using the :class:`.Computed` construct.

 .. change::
     :tags: orm, performance
     :tickets: 5162

     Modified the queries used by subqueryload and selectinload to no longer
     ORDER BY the primary key of the parent entity;  this ordering was there to
     allow the rows as they come in to be copied into lists directly with a
     minimal level of Python-side collation.   However, these ORDER BY clauses
     can negatively impact the performance of the query as in many scenarios
     these columns are derived from a subquery or are otherwise not actual
     primary key columns such that SQL planners cannot make use of indexes. The
     Python-side collation uses the native itertools.group_by() to collate the
     incoming rows, and has been modified to allow multiple
     row-groups-per-parent to be assembled together using list.extend(), which
     should still allow for relatively fast Python-side performance.  There will
     still be an ORDER BY present for a relationship that includes an explicit
     order_by parameter, however this is the only ORDER BY that will be added to
     the query for both kinds of loading.

 .. change::
     :tags: mssql, mysql, oracle, usecase
     :tickets: 5137

     Added support for :meth:`.ColumnOperators.is_distinct_from` and
     :meth:`.ColumnOperators.isnot_distinct_from` to SQL Server,
     MySQL, and Oracle.

 .. change::
     :tags: sqlite, usecase
     :tickets: 5164

     Implemented AUTOCOMMIT isolation level for SQLite when using pysqlite.

 .. change::
     :tags: bug, postgresql
     :tickets: 5205

     Fixed issue where a "covering" index, e.g. those which have an  INCLUDE
     clause, would be reflected including all the columns in INCLUDE clause as
     regular columns.  A warning is now emitted if these additional columns are
     detected indicating that they are currently ignored.  Note that full
     support for "covering" indexes is part of :ticket:`4458`.  Pull request
     courtesy Marat Sharafutdinov.

 .. change::
     :tags: sql, types
     :tickets: 5052

     Add ability to literal compile a :class:`DateTime`, :class:`Date`
     or :class:`Time` when using the string dialect for debugging purposes.
     This change does not impact real dialect implementation that retain
     their current behavior.

 .. change::
     :tags: installer
     :tickets: 5207

     Ensured that the "pyproject.toml" file is not included in builds, as the
     presence of this file indicates to pip that a pep-517 installation process
     should be used.  As this mode of operation appears to be not well supported
     by current tools / distros, these problems are avoided within the scope
     of SQLAlchemy installation by omitting the file.


 .. change::
     :tags: bug, orm
     :tickets: 5210

     Fixed issue where a lazyload that uses session-local "get" against a target
     many-to-one relationship where an object with the correct primary key is
     present, however it's an instance of a sibling class, does not correctly
     return None as is the case when the lazy loader actually emits a load for
     that row.

 .. change::
     :tags: bug, orm, declarative
     :tickets: 5238

     The string argument accepted as the first positional argument by the
     :func:`_orm.relationship` function when using the Declarative API is no longer
     interpreted using the Python ``eval()`` function; instead, the name is dot
     separated and the names are looked up directly in the name resolution
     dictionary without treating the value as a Python expression.  However,
     passing a string argument to the other :func:`_orm.relationship` parameters
     that necessarily must accept Python expressions will still use ``eval()``;
     the documentation has been clarified to ensure that there is no ambiguity
     that this is in use.

     .. seealso::

         :ref:`declarative_relationship_eval` - details on string evaluation

.. changelog::

1.3.15

:released: March 11, 2020

 .. change::
     :tags: bug, orm
     :tickets: 5194

     Adjusted the error message emitted by :meth:`_query.Query.join` when a left hand
     side can't be located that the :meth:`_query.Query.select_from` method is the
     best way to resolve the issue.  Also, within the 1.3 series, used a
     deterministic ordering when determining the FROM clause from a given column
     entity passed to :class:`_query.Query` so that the same expression is determined
     each time.


 .. change::
     :tags: orm, bug
     :tickets: 5196

     Fixed regression in 1.3.14 due to :ticket:`4849` where a sys.exc_info()
     call failed to be invoked correctly when a flush error would occur. Test
     coverage has been added for this exception case.


.. changelog::

1.3.14

:released: March 10, 2020

 .. change::
     :tags: bug, sql, postgresql
     :tickets: 5181

     Fixed bug where a CTE of an INSERT/UPDATE/DELETE that also uses RETURNING
     could then not be SELECTed from directly, as the internal state of the
     compiler would try to treat the outer SELECT as a DELETE statement itself
     and access nonexistent state.


 .. change::
     :tags: bug, orm
     :tickets: 5110

     Fixed regression caused in 1.3.13 by :ticket:`5056` where a refactor of the
     ORM path registry system made it such that a path could no longer be
     compared to an empty tuple, which can occur in a particular kind of joined
     eager loading path.   The "empty tuple" use case has been resolved so that
     the path registry is compared to a path registry in all cases;  the
     :class:`.PathRegistry` object itself now implements ``__eq__()`` and
     ``__ne__()`` methods which will take place for all equality comparisons and
     continue to succeed in the not anticipated case that a non-
     :class:`.PathRegistry` object is compared, while emitting a warning that
     this object should not be the subject of the comparison.



 .. change::
     :tags: bug, orm
     :tickets: 5149

     Setting a relationship to viewonly=True which is also the target of a
     back_populates or backref configuration will now emit a warning and
     eventually be disallowed. back_populates refers specifically to mutation
     of an attribute or collection, which is disallowed when the attribute is
     subject to viewonly=True.   The viewonly attribute is not subject to
     persistence behaviors which means it will not reflect correct results
     when it is locally mutated.

 .. change::
     :tags: bug, oracle
     :tickets: 5146

     Fixed a reflection bug where table comments could only be retrieved for
     tables actually owned by the user but not for tables visible to the user
     but owned by someone else.  Pull request courtesy Dave Hirschfeld.

 .. change::
     :tags: bug, performance
     :tickets: 5180

     Revised an internal change to the test system added as a result of
     :ticket:`5085` where a testing-related module per dialect would be loaded
     unconditionally upon making use of that dialect, pulling in SQLAlchemy's
     testing framework as well as the ORM into the module import space.   This
     would only impact initial startup time and memory to a modest extent,
     however it's best that these additional modules aren't reverse-dependent on
     straight Core usage.

 .. change::
     :tags: bug, installation
     :tickets: 5138

     Vendored the ``inspect.formatannotation`` function inside of
     ``sqlalchemy.util.compat``, which is needed for the vendored version of
     ``inspect.formatargspec``.  The function is not documented in cPython and
     is not guaranteed to be available in future Python versions.


 .. change::
     :tags: bug, mssql
     :tickets: 5132

     Fixed issue where the :class:`_mssql.DATETIMEOFFSET` type would not
     accommodate for the ``None`` value, introduced as part of the series of
     fixes for this type first introduced in :ticket:`4983`, :ticket:`5045`.
     Additionally, added support for passing a backend-specific date formatted
     string through this type, as is typically allowed for date/time types on
     most other DBAPIs.

 .. change::
     :tags: bug, engine
     :tickets: 5182

     Expanded the scope of cursor/connection cleanup when a statement is
     executed to include when the result object fails to be constructed, or an
     after_cursor_execute() event raises an error, or autocommit / autoclose
     fails.  This allows the DBAPI cursor to be cleaned up on failure and for
     connectionless execution allows the connection to be closed out and
     returned to the connection pool, where previously it waiting until garbage
     collection would trigger a pool return.

 .. change::
     :tags: bug, postgresql
     :tickets: 5158

     Fixed issue where the "schema_translate_map" feature would not work with a
     PostgreSQL native enumeration type (i.e. :class:`.Enum`,
     :class:`_postgresql.ENUM`) in that while the "CREATE TYPE" statement would
     be emitted with the correct schema, the schema would not be rendered in
     the CREATE TABLE statement at the point at which the enumeration was
     referenced.


 .. change::
     :tags: usecase, ext
     :tickets: 5114

     Added keyword arguments to the :meth:`.MutableList.sort` function so that a
     key function as well as the "reverse" keyword argument can be provided.


 .. change::
     :tags: bug, general, py3k
     :tickets: 4849

     Applied an explicit "cause" to most if not all internally raised exceptions
     that are raised from within an internal exception catch, to avoid
     misleading stacktraces that suggest an error within the handling of an
     exception.  While it would be preferable to suppress the internally caught
     exception in the way that the ``__suppress_context__`` attribute would,
     there does not as yet seem to be a way to do this without suppressing an
     enclosing user constructed context, so for now it exposes the internally
     caught exception as the cause so that full information about the context
     of the error is maintained.

 .. change::
     :tags: orm, bug
     :tickets: 5121

     Fixed an additional regression in the same area as that of :ticket:`5080`
     introduced in 1.3.0b3 via :ticket:`4468` where the ability to create a
     joined option across a :func:`.with_polymorphic` into a relationship
     against the base class of that with_polymorphic, and then further into
     regular mapped relationships would fail as the base class component would
     not add itself to the load path in a way that could be located by the
     loader strategy. The changes applied in :ticket:`5080` have been further
     refined to also accommodate this scenario.

 .. change::
     :tags: bug, postgresql, reflection
     :tickets: 5170

     Fixed bug where PostgreSQL reflection of CHECK constraints would fail to
     parse the constraint if the SQL text contained newline characters. The
     regular expression has been adjusted to accommodate for this case. Pull
     request courtesy Eric Borczuk.

 .. change::
     :tags: usecase, orm
     :tickets: 5129

     Added a new flag :paramref:`.InstanceEvents.restore_load_context` and
     :paramref:`.SessionEvents.restore_load_context` which apply to the
     :meth:`.InstanceEvents.load`, :meth:`.InstanceEvents.refresh`, and
     :meth:`.SessionEvents.loaded_as_persistent` events, which when set will
     restore the "load context" of the object after the event hook has been
     called.  This ensures that the object remains within the "loader context"
     of the load operation that is already ongoing, rather than the object being
     transferred to a new load context due to refresh operations which may have
     occurred in the event. A warning is now emitted when this condition occurs,
     which recommends use of the flag to resolve this case.  The flag is
     "opt-in" so that there is no risk introduced to existing applications.

     The change additionally adds support for the ``raw=True`` flag to
     session lifecycle events.

 .. change::
     :tags: bug, mysql
     :tickets: 5173

     Fixed issue in MySQL :meth:`.mysql.Insert.on_duplicate_key_update` construct
     where using a SQL function or other composed expression for a column argument
     would not properly render the ``VALUES`` keyword surrounding the column
     itself.

.. changelog::

1.3.13

:released: January 22, 2020

 .. change::
     :tags: bug, postgresql
     :tickets: 5039

     Fixed issue where the PostgreSQL dialect would fail to parse a reflected
     CHECK constraint that was a boolean-valued function (as opposed to a
     boolean-valued expression).

 .. change::
     :tags: bug, ext
     :tickets: 5086

     Fixed bug in sqlalchemy.ext.serializer where a unique
     :class:`.BindParameter` object could conflict with itself if it were
     present in the mapping itself, as well as the filter condition of the
     query, as one side would be used against the non-deserialized version and
     the other side would use the deserialized version.  Logic is added to
     :class:`.BindParameter` similar to its "clone" method which will uniquify
     the parameter name upon deserialize so that it doesn't conflict with its
     original.


 .. change::
     :tags: usecase, sql
     :tickets: 5079

     A function created using :class:`.GenericFunction` can now specify that the
     name of the function should be rendered with or without quotes by assigning
     the :class:`.quoted_name` construct to the .name element of the object.
     Prior to 1.3.4, quoting was never applied to function names, and some
     quoting was introduced in :ticket:`4467` but no means to force quoting for
     a mixed case name was available.  Additionally, the :class:`.quoted_name`
     construct when used as the name will properly register its lowercase name
     in the function registry so that the name continues to be available via the
     ``func.`` registry.

     .. seealso::

         :class:`.GenericFunction`


 .. change::
     :tags: bug, engine
     :tickets: 5048

     Fixed issue where the collection of value processors on a
     :class:`.Compiled` object would be mutated when "expanding IN" parameters
     were used with a datatype that has bind value processors; in particular,
     this would mean that when using statement caching and/or baked queries, the
     same compiled._bind_processors collection would be mutated concurrently.
     Since these processors are the same function for a given bind parameter
     namespace every time, there was no actual negative effect of this issue,
     however, the execution of a :class:`.Compiled` object should never be
     causing any changes in its state, especially given that they are intended
     to be thread-safe and reusable once fully constructed.


 .. change::
     :tags: tests, postgresql
     :tickets: 5057

     Improved detection of two phase transactions requirement for the PostgreSQL
     database by testing that max_prepared_transactions is set to a value
     greater than 0.  Pull request courtesy Federico Caselli.


 .. change::
     :tags: bug, orm, engine
     :tickets: 5056, 5050, 5071

     Added test support and repaired a wide variety of unnecessary reference
     cycles created for short-lived objects, mostly in the area of ORM queries.
     Thanks much to Carson Ip for the help on this.


 .. change::
     :tags: orm, bug
     :tickets: 5107

     Fixed regression in loader options introduced in 1.3.0b3 via :ticket:`4468`
     where the ability to create a loader option using
     :meth:`.PropComparator.of_type` targeting an aliased entity that is an
     inheriting subclass of the entity which the preceding relationship refers
     to would fail to produce a matching path.   See also :ticket:`5082` fixed
     in this same release which involves a similar kind of issue.

 .. change::
     :tags: bug, tests
     :tickets: 4946

     Fixed a few test failures which would occur on Windows due to SQLite file
     locking issues, as well as some timing issues in connection pool related
     tests; pull request courtesy Federico Caselli.


 .. change::
     :tags: orm, bug
     :tickets: 5082

     Fixed regression in joined eager loading introduced in 1.3.0b3 via
     :ticket:`4468` where the ability to create a joined option across a
     :func:`.with_polymorphic` into a polymorphic subclass using
     :meth:`.RelationshipProperty.of_type` and then further along regular mapped
     relationships would fail as the polymorphic subclass would not add itself
     to the load path in a way that could be located by the loader strategy.  A
     tweak has been made to resolve this scenario.


 .. change::
     :tags: performance, orm

     Identified a performance issue in the system by which a join is constructed
     based on a mapped relationship.   The clause adaption system would be used
     for the majority of join expressions including in the common case where no
     adaptation is needed.   The conditions under which this adaptation occur
     have been refined so that average non-aliased joins along a simple
     relationship without a "secondary" table use about 70% less function calls.


 .. change::
     :tags: usecase, postgresql
     :tickets: 5040

     Added support for prefixes to the :class:`_expression.CTE` construct, to allow
     support for Postgresql 12 "MATERIALIZED" and "NOT MATERIALIZED" phrases.
     Pull request courtesy Marat Sharafutdinov.

     .. seealso::

         :meth:`_expression.HasCTE.cte`

 .. change::
     :tags: bug, mssql
     :tickets: 5045

     Fixed issue where a timezone-aware ``datetime`` value being converted to
     string for use as a parameter value of a :class:`_mssql.DATETIMEOFFSET`
     column was omitting the fractional seconds.

 .. change::
     :tags: bug, orm
     :tickets: 5068

     Repaired a warning in the ORM flush process that was not covered by  test
     coverage when deleting objects that use the "version_id" feature. This
     warning is generally unreachable unless using a dialect that sets the
     "supports_sane_rowcount" flag to False, which  is not typically the case
     however is possible for some MySQL configurations as well as older Firebird
     drivers, and likely some third party dialects.

 .. change::
     :tags: bug, orm
     :tickets: 5065

     Fixed bug where usage of joined eager loading would not properly wrap the
     query inside of a subquery when :meth:`_query.Query.group_by` were used against
     the query.   When any kind of result-limiting approach is used, such as
     DISTINCT, LIMIT, OFFSET, joined eager loading embeds the row-limited query
     inside of a subquery so that the collection results are not impacted.   For
     some reason, the presence of GROUP BY was never included in this criterion,
     even though it has a similar effect as using DISTINCT.   Additionally, the
     bug would prevent using GROUP BY at all for a joined eager load query for
     most database platforms which forbid non-aggregated, non-grouped columns
     from being in the query, as the additional columns for the joined eager
     load would not be accepted by the database.



.. changelog::

Links

• PyPI: https://pypi.org/project/sqlalchemy
• Changelog: https://pyup.io/changelogs/sqlalchemy/
• Homepage: http://www.sqlalchemy.org