starred/sandman2-jeffknupp
1
0
Fork 0
mirror of https://github.com/jeffknupp/sandman2.git synced 2026-04-25 08:35:49 +03:00
Code Issues 45 Projects Releases Packages Wiki Activity

[PR #150] [CLOSED] Scheduled weekly dependency update for week 16 #179

New issue
Closed
opened 2026-02-26 01:33:30 +03:00 by kerem · 0 comments
kerem commented 2026-02-26 01:33:30 +03:00
Owner
Copy link

📋 Pull Request Information

Original PR: https://github.com/jeffknupp/sandman2/pull/150
Author: @pyup-bot
Created: 4/20/2020
Status: ❌ Closed

Base: master ← Head: pyup-scheduled-update-2020-04-20

📝 Commits (10+)

  • 9d3eb12 Update flask from 1.1.1 to 1.1.2
  • d038a52 Update flask-admin from 1.5.3 to 1.5.6
  • 0139262 Update sqlalchemy from 1.3.8 to 1.3.16
  • 4d4a48f Update coverage from 4.5.4 to 5.1
  • ae69f4b Update pytest from 5.2.0 to 5.4.1
  • b015c69 Update pytest-cov from 2.7.1 to 2.8.1
  • 35c6380 Update pytest-flask from 0.15.0 to 1.0.0
  • 737c91c Update six from 1.12.0 to 1.14.0
  • 3c6a3b1 Update wcwidth from 0.1.7 to 0.1.9
  • 958424c Update werkzeug from 0.15.4 to 1.0.1

📊 Changes

1 file changed (+11 additions, -11 deletions)

View changed files

📝 requirements.txt (+11 -11)

📄 Description

Update Flask from 1.1.1 to 1.1.2.

Changelog

1.1.2

-------------

Released 2020-04-03

-   Work around an issue when running the ``flask`` command with an
 external debugger on Windows. :issue:`3297`
-   The static route will not catch all URLs if the ``Flask``
 ``static_folder`` argument ends with a slash. :issue:`3452`
Links

Update Flask-Admin from 1.5.3 to 1.5.6.

Changelog

1.5.6

-----

* SQLAlchemy 1.3.6 compatibility fix
* Python 3.8 support

1.5.5

-----

* Werkzeug 1.0 compatibility fix
* Use fa-circle-o icon for unchecked booleans
* A few SQLAlchemy-related bug fixes

1.5.4

-----

* Fix display of inline x-editable boolean fields on list view
* Add support for several SQLAlchemy-Utils data types
* Support searching on SQLAlchemy hybrid properties
* Extra URL paramaters are now propagated to the next page when searching / filtering
* Add enum34 dependency when running on legacy Python version
* Update Mapbox API v1 URL format
* Update jQuery and moment dependencies in templates
* Fixed a datepicker issue, where only dates up to 2015 were showing up
* Updated Pillow dependency version
Links

Update SQLAlchemy from 1.3.8 to 1.3.16.

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:`.Inspector.get_columns`.
     When reflecting full :class:`.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:`.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:`.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.join` when a left hand
     side can't be located that the :meth:`.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` 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:`.CTE` construct, to allow
     support for Postgresql 12 "MATERIALIZED" and "NOT MATERIALIZED" phrases.
     Pull request courtesy Marat Sharafutdinov.

     .. seealso::

         :meth:`.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.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::

1.3.12

:released: December 16, 2019

 .. change::
     :tags: bug, sql
     :tickets: 5028

     Fixed bug where "distinct" keyword passed to :func:`~.sql.expression.select` would not
     treat a string value as a "label reference" in the same way that the
     :meth:`.select.distinct` does; it would instead raise unconditionally. This
     keyword argument and the others passed to :func:`~.sql.expression.select` will ultimately
     be deprecated for SQLAlchemy 2.0.


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

     Fixed issue involving ``lazy="raise"`` strategy where an ORM delete of an
     object would raise for a simple "use-get" style many-to-one relationship
     that had lazy="raise" configured.  This is inconsistent vs. the change
     introduced in 1.3 as part of :ticket:`4353`, where it was established that
     a history operation that does not expect emit SQL should bypass the
     ``lazy="raise"`` check, and instead effectively treat it as
     ``lazy="raise_on_sql"`` for this case.  The fix adjusts the lazy loader
     strategy to not raise for the case where the lazy load was instructed that
     it should not emit SQL if the object were not present.

 .. change::
     :tags: bug, sql

     Changed the text of the exception for "Can't resolve label reference" to
     include other kinds of label coercions, namely that "DISTINCT" is also in
     this category under the PostgreSQL dialect.


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

     Fixed regression introduced in 1.3.0 related to the association proxy
     refactor in :ticket:`4351` that prevented :func:`.composite` attributes
     from working in terms of an association proxy that references them.

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

     Repaired support for the :class:`.mssql.DATETIMEOFFSET` datatype on PyODBC,
     by adding PyODBC-level result handlers as it does not include native
     support for this datatype.  This includes usage of the Python 3 "timezone"
     tzinfo subclass in order to set up a timezone, which on Python 2 makes
     use of a minimal backport of "timezone" in sqlalchemy.util.


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

     Setting persistence-related flags on :func:`.relationship` while also
     setting viewonly=True will now emit a regular warning, as these flags do
     not make sense for a viewonly=True relationship.   In particular, the
     "cascade" settings have their own warning that is generated based on the
     individual values, such as "delete, delete-orphan", that should not apply
     to a viewonly relationship.   Note however that in the case of "cascade",
     these settings are still erroneously taking effect even though the
     relationship is set up as "viewonly".   In 1.4, all persistence-related
     cascade settings will be disallowed on a viewonly=True relationship in
     order to resolve this issue.

 .. change::
     :tags: bug, sqlite
     :tickets: 5014

     Fixed issue to workaround SQLite's behavior of assigning "numeric" affinity
     to JSON datatypes, first described at :ref:`change_3850`, which returns
     scalar numeric JSON values as a number and not as a string that can be JSON
     deserialized.  The SQLite-specific JSON deserializer now gracefully
     degrades for this case as an exception and bypasses deserialization for
     single numeric values, as from a JSON perspective they are already
     deserialized.



 .. change::
     :tags: bug, orm, py3k
     :tickets: 4990

     Fixed issue where when assigning a collection to itself as a slice, the
     mutation operation would fail as it would first erase the assigned
     collection inadvertently.   As an assignment that does not change  the
     contents should not generate events, the operation is now a no-op. Note
     that the fix only applies to Python 3; in Python 2, the ``__setitem__``
     hook isn't called in this case; ``__setslice__`` is used instead which
     recreates the list item-by-item in all cases.

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

     Fixed issue where by if the "begin" of a transaction failed at the Core
     engine/connection level, such as due to network error or database is locked
     for some transactional recipes, within the context of the :class:`.Session`
     procuring that connection from the conneciton pool and then immediately
     returning it, the ORM :class:`.Session` would not close the connection
     despite this connection not being stored within the state of that
     :class:`.Session`.  This would lead to the connection being cleaned out by
     the connection pool weakref handler within garbage collection which is an
     unpreferred codepath that in some special configurations can emit errors in
     standard error.

.. changelog::

1.3.11

:released: November 11, 2019

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

     Fixed issue in MSSQL dialect where an expression-based OFFSET value in a
     SELECT would be rejected, even though the dialect can render this
     expression inside of a ROW NUMBER-oriented LIMIT/OFFSET construct.


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

     Added accessor :meth:`.Query.is_single_entity` to :class:`.Query`, which
     will indicate if the results returned by this :class:`.Query` will be a
     list of ORM entities, or a tuple of entities or column expressions.
     SQLAlchemy hopes to improve upon the behavior of single entity / tuples in
     future releases such that the behavior would be explicit up front, however
     this attribute should be helpful with the current behavior.  Pull request
     courtesy Patrick Hayes.

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

     Added "Connection was killed" message interpreted from the base
     pymysql.Error class in order to detect closed connection, based on reports
     that this message is arriving via a pymysql.InternalError() object which
     indicates pymysql is not handling it correctly.

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

     The :paramref:`.relationship.omit_join` flag was not intended to be
     manually set to True, and will now emit a warning when this occurs.  The
     omit_join optimization is detected automatically, and the ``omit_join``
     flag was only intended to disable the optimization in the hypothetical case
     that the optimization may have interfered with correct results, which has
     not been observed with the modern version of this feature.   Setting the
     flag to True when it is not automatically detected may cause the selectin
     load feature to not work correctly when a non-default primary join
     condition is in use.


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

     A warning is emitted if a primary key value is passed to :meth:`.Query.get`
     that consists of None for all primary key column positions.   Previously,
     passing a single None outside of a tuple would raise a ``TypeError`` and
     passing a composite None (tuple of None values) would silently pass
     through.   The fix now coerces the single None into a tuple where it is
     handled consistently with the other None conditions.  Thanks to Lev
     Izraelit for the help with this.


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

     The :class:`.BakedQuery` will not cache a query that was modified by a
     :meth:`.QueryEvents.before_compile` event, so that compilation hooks that
     may be applying ad-hoc modifications to queries will take effect on each
     run.  In particular this is helpful for events that modify queries used in
     lazy loading as well as eager loading such as "select in" loading.  In
     order to re-enable caching for a query modified by this event, a new
     flag ``bake_ok`` is added; see :ref:`baked_with_before_compile` for
     details.

     A longer term plan to provide a new form of SQL caching should solve this
     kind of issue more comprehensively.

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

     Fixed test failures which would occur with newer SQLite as of version 3.30
     or greater, due to their addition of nulls ordering syntax as well as new
     restrictions on aggregate functions.  Pull request courtesy Nils Philippsen.



 .. change::
     :tags: bug, installation, windows
     :tickets: 4967

     Added a workaround for a setuptools-related failure that has been observed
     as occurring on Windows installations, where setuptools is not correctly
     reporting a build error when the MSVC build dependencies are not installed
     and therefore not allowing graceful degradation into non C extensions
     builds.

 .. change::
     :tags: bug, sql, py3k
     :tickets: 4931

     Changed the ``repr()`` of the :class:`.quoted_name` construct to use
     regular string repr() under Python 3, rather than running it through
     "backslashreplace" escaping, which can be misleading.

 .. change::
     :tags: bug, oracle, firebird
     :tickets: 4931

     Modified the approach of "name normalization" for the Oracle and Firebird
     dialects, which converts from the UPPERCASE-as-case-insensitive convention
     of these dialects into lowercase-as-case-insensitive for SQLAlchemy, to not
     automatically apply the :class:`.quoted_name` construct to a name that
     matches itself under upper or lower case conversion, as is the case for
     many non-european characters.   All names used within metadata structures
     are converted to :class:`.quoted_name` objects in any case; the change
     here would only affect the output of some inspection functions.

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

     Fixed bug where a table that would have a column label overlap with a plain
     column name, such as "foo.id AS foo_id" vs. "foo.foo_id", would prematurely
     generate the ``._label`` attribute for a column before this overlap could
     be detected due to the use of the ``index=True`` or ``unique=True`` flag on
     the column in conjunction with the default naming convention of
     ``"column_0_label"``.  This would then lead to failures when ``._label``
     were used later to generate a bound parameter name, in particular those
     used by the ORM when generating the WHERE clause for an UPDATE statement.
     The issue has been fixed by using an alternate ``._label`` accessor for DDL
     generation that does not affect the state of the :class:`.Column`.   The
     accessor also bypasses the key-deduplication step as it is not necessary
     for DDL, the naming is now consistently ``"<tablename>_<columnname>"``
     without any subsequent numeric symbols when used in DDL.



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

     Fixed bug where parameter repr as used in logging and error reporting needs
     additional context in order to distinguish between a list of parameters for
     a single statement and a list of parameter lists, as the "list of lists"
     structure could also indicate a single parameter list where the first
     parameter itself is a list, such as for an array parameter.   The
     engine/connection now passes in an additional boolean indicating how the
     parameters should be considered.  The only SQLAlchemy backend that expects
     arrays as parameters is that of  psycopg2 which uses pyformat parameters,
     so this issue has not been too apparent, however as other drivers that use
     positional gain more features it is important that this be supported. It
     also eliminates the need for the parameter repr function to guess based on
     the parameter structure passed.

 .. change::
     :tags: usecase, schema
     :tickets: 4894

     Added DDL support for "computed columns"; these are DDL column
     specifications for columns that have a server-computed value, either upon
     SELECT (known as "virtual") or at the point of which they are INSERTed or
     UPDATEd (known as "stored").  Support is established for Postgresql, MySQL,
     Oracle SQL Server and Firebird. Thanks to Federico Caselli for lots of work
     on this one.

     .. seealso::

         :ref:`computed_ddl`


 .. change::
     :tags: bug, engine, postgresql
     :tickets: 4955

     Fixed bug in :class:`.Inspector` where the cache key generation did not
     take into account arguments passed in the form of tuples, such as the tuple
     of view name styles to return for the PostgreSQL dialect. This would lead
     the inspector to cache too generally for a more specific set of criteria.
     The logic has been adjusted to include every keyword element in the cache,
     as every argument is expected to be appropriate for a cache else the
     caching decorator should be bypassed by the dialect.


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

     Fixed an issue in the :meth:`.Engine.table_names` method where it would
     feed the dialect's default schema name back into the dialect level table
     function, which in the case of SQL Server would interpret it as a
     dot-tokenized schema name as viewed by the mssql dialect, which would
     cause the method to fail in the case where the database username actually
     had a dot inside of it.  In 1.3, this method is still used by the
     :meth:`.MetaData.reflect` function so is a prominent codepath. In 1.4,
     which is the current master development branch, this issue doesn't exist,
     both because :meth:`.MetaData.reflect` isn't using this method nor does the
     method pass the default schema name explicitly.  The fix nonetheless
     guards against the default server name value returned by the dialect from
     being interpreted as dot-tokenized name under any circumstances by
     wrapping it in quoted_name().

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

     Fixed ORM bug where a "secondary" table that referred to a selectable which
     in some way would refer to the local primary table would apply aliasing to
     both sides of the join condition when a relationship-related join, either
     via :meth:`.Query.join` or by :func:`.joinedload`, were generated.  The
     "local" side is now excluded.

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

     Added new accessors to expressions of type :class:`.JSON` to allow for
     specific datatype access and comparison, covering strings, integers,
     numeric, boolean elements.   This revises the documented approach of
     CASTing to string when comparing values, instead adding specific
     functionality into the PostgreSQL, SQlite, MySQL dialects to reliably
     deliver these basic types in all cases.

     .. seealso::

         :class:`.JSON`

         :meth:`.JSON.Comparator.as_string`

         :meth:`.JSON.Comparator.as_boolean`

         :meth:`.JSON.Comparator.as_float`

         :meth:`.JSON.Comparator.as_integer`

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

     Added dialect-level flag ``encoding_errors`` to the cx_Oracle dialect,
     which can be specified as part of :func:`.create_engine`.   This is passed
     to SQLAlchemy's unicode decoding converter under Python 2, and to
     cx_Oracle's ``cursor.var()`` object as the ``encodingErrors`` parameter
     under Python 3, for the very unusual case that broken encodings are present
     in the target database which cannot be fetched unless error handling is
     relaxed.  The value is ultimately one of the Python "encoding errors"
     parameters passed to ``decode()``.

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

     The :func:`.text` construct now supports "unique" bound parameters, which
     will dynamically uniquify themselves on compilation thus allowing multiple
     :func:`.text` constructs with the same bound parameter names to be combined
     together.


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

     The :class:`.sqltypes.NCHAR` datatype will now bind to the
     ``cx_Oracle.FIXED_NCHAR`` DBAPI data bindings when used in a bound
     parameter, which supplies proper comparison behavior against a
     variable-length string.  Previously, the :class:`.sqltypes.NCHAR` datatype
     would bind to ``cx_oracle.NCHAR`` which is not fixed length; the
     :class:`.sqltypes.CHAR` datatype already binds to ``cx_Oracle.FIXED_CHAR``
     so it is now consistent that :class:`.sqltypes.NCHAR` binds to
     ``cx_Oracle.FIXED_NCHAR``.



 .. change::
     :tags: bug, firebird
     :tickets: 4903

     Added additional "disconnect" message "Error writing data to the
     connection" to Firebird disconnection detection.  Pull request courtesy
     lukens.

.. changelog::

1.3.10

:released: October 9, 2019

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

     Fixed bug in SQL Server dialect with new "max_identifier_length" feature
     where the mssql dialect already featured this flag, and the implementation
     did not accommodate for the new initialization hook correctly.


 .. change::
     :tags: bug, oracle
     :tickets: 4898, 4857

     Fixed regression in Oracle dialect that was inadvertently using max
     identifier length of 128 characters on Oracle server 12.2 and greater even
     though the stated contract for the remainder of the 1.3 series is  that
     this value stays at 30 until version SQLAlchemy 1.4.  Also repaired issues
     with the retrieval of the "compatibility" version, and removed the warning
     emitted when the "v$parameter" view was not accessible as this was  causing
     user confusion.

.. changelog::

1.3.9

:released: October 4, 2019

 .. change::
     :tags: usecase, engine
     :tickets: 4857

     Added new :func:`.create_engine` parameter
     :paramref:`.create_engine.max_identifier_length`. This overrides the
     dialect-coded "max identifier length" in order to accommodate for databases
     that have recently changed this length and the SQLAlchemy dialect has
     not yet been adjusted to detect for that version.  This parameter interacts
     with the existing :paramref:`.create_engine.label_length` parameter in that
     it establishes the maximum (and default) value for anonymously generated
     labels.   Additionally, post-connection detection of max identifier lengths
     has been added to the dialect system.  This feature is first being used
     by the Oracle dialect.

     .. seealso::

         :ref:`oracle_max_identifier_lengths` - in the Oracle dialect documentation

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

     The Oracle dialect now emits a warning if Oracle version 12.2 or greater is
     used, and the :paramref:`.create_engine.max_identifier_length` parameter is
     not set.   The version in this specific case defaults to that of the
     "compatibility" version set in the Oracle server configuration, not the
     actual server version.   In version 1.4, the default max_identifier_length
     for 12.2 or greater will move to 128 characters.  In order to maintain
     forwards compatibility, applications should set
     :paramref:`.create_engine.max_identifier_length` to 30 in order to maintain
     the same length behavior, or to 128 in order to test the upcoming behavior.
     This length determines among other things how generated constraint names
     are truncated for statements like ``CREATE CONSTRAINT`` and ``DROP
     CONSTRAINT``, which means a the new length may produce a name-mismatch
     against a name that was generated with the old length, impacting database
     migrations.

     .. seealso::

         :ref:`oracle_max_identifier_lengths` - in the Oracle dialect documentation

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

     Added support for sqlite "URI" connections, which allow for sqlite-specific
     flags to be passed in the query string such as "read only" for Python
     sqlite3 drivers that support this.

     .. seealso::

         :ref:`pysqlite_uri_connections`

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

     Fixed unit test regression released in 1.3.8 that would cause failure for
     Oracle, SQL Server and other non-native ENUM platforms due to new
     enumeration tests added as part of :ticket:`4285` enum sortability in the
     unit of work; the enumerations created constraints that were duplicated on
     name.

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

     Restored adding cx_Oracle.DATETIME to the setinputsizes() call when a
     SQLAlchemy :class:`.Date`, :class:`.DateTime` or :class:`.Time` datatype is
     used, as some complex queries require this to be present.  This was removed
     in the 1.2 series for arbitrary reasons.

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

     Added identifier quoting to the schema name applied to the "use" statement
     which is invoked when a SQL Server multipart schema name is used within  a
     :class:`.Table` that is being reflected, as well as for :class:`.Inspector`
     methods such as :meth:`.Inspector.get_table_names`; this accommodates for
     special characters or spaces in the database name.  Additionally, the "use"
     statement is not emitted if the current database matches the target owner
     database name being passed.

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

     Fixed regression in selectinload loader strategy caused by :ticket:`4775`
     (released in version 1.3.6) where a many-to-one attribute of None would no
     longer be populated by the loader.  While this was usually not noticeable
     due to the lazyloader populating None upon get, it would lead to a detached
     instance error if the object were detached.

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

     Passing a plain string expression to :meth:`.Session.query` is deprecated,
     as all string coercions were removed in :ticket:`4481` and this one should
     have been included.   The :func:`.literal_column` function may be used to
     produce a textual column expression.

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

     Added an explicit error message for the case when objects passed to
     :class:`.Table` are not :class:`.SchemaItem` objects, rather than resolving
     to an attribute error.


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

     A warning is emitted for a condition in which the :class:`.Session` may
     implicitly swap an object out of the identity map for another one with the
     same primary key, detaching the old one, which can be an observed result of
     load operations which occur within the :meth:`.SessionEvents.after_flush`
     hook.  The warning is intended to notify the user that some special
     condition has caused this to happen and that the previous object may not be
     in the expected state.

 .. change::
     :tags: bug, sql
     :tickets: 4837

     Characters that interfere with "pyformat" or "named" formats in bound
     parameters, namely ``%, (, )`` and the space character, as well as a few
     other typically undesirable characters, are stripped early for a
     :func:`.bindparam` that is using an anonymized name, which is typically
     generated automatically from a named column which itself includes these
     characters in its name and does not use a ``.key``, so that they do not
     interfere either with the SQLAlchemy compiler's use of string formatting or
     with the driver-level parsing of the parameter, both of which could be
     demonstrated before the fix.  The change only applies to anonymized
     parameter names that are generated and consumed internally, not end-user
     defined names, so the change should have no impact on any existing code.
     Applies in particular to the psycopg2 driver which does not otherwise quote
     special parameter names, but also strips leading underscores to suit Oracle
     (but not yet leading numbers, as some anon parameters are currently
     entirely numeric/underscore based); Oracle in any case continues to quote
     parameter names that include special characters.

.. changelog::
Links

Update coverage from 4.5.4 to 5.1.

Changelog

5.1

--------------------------

- The JSON report now includes counts of covered and missing branches. Thanks,
Salvatore Zagaria.

- On Python 3.8, try-finally-return reported wrong branch coverage with
decorated async functions (`issue 946`_).  This is now fixed. Thanks, Kjell
Braden.

- The :meth:`~coverage.Coverage.get_option` and
:meth:`~coverage.Coverage.set_option` methods can now manipulate the
``[paths]`` configuration setting.  Thanks to Bernát Gábor for the fix for
`issue 967`_.

.. _issue 946: https://github.com/nedbat/coveragepy/issues/946
.. _issue 967: https://github.com/nedbat/coveragepy/issues/967


.. _changes_504:

5.0.4

----------------------------

- If using the ``[run] relative_files`` setting, the XML report will use
relative files in the ``<source>`` elements indicating the location of source
code.  Closes `issue 948`_.

- The textual summary report could report missing lines with negative line
numbers on PyPy3 7.1 (`issue 943`_).  This is now fixed.

- Windows wheels for Python 3.8 were incorrectly built, but are now fixed.
(`issue 949`_)

- Updated Python 3.9 support to 3.9a4.

- HTML reports couldn't be sorted if localStorage wasn't available. This is now
fixed: sorting works even though the sorting setting isn't retained. (`issue
944`_ and `pull request 945`_). Thanks, Abdeali Kothari.

.. _issue 943: https://github.com/nedbat/coveragepy/issues/943
.. _issue 944: https://github.com/nedbat/coveragepy/issues/944
.. _pull request 945: https://github.com/nedbat/coveragepy/pull/945
.. _issue 948: https://github.com/nedbat/coveragepy/issues/948
.. _issue 949: https://github.com/nedbat/coveragepy/issues/949


.. _changes_503:

5.0.3

----------------------------

- A performance improvement in 5.0.2 didn't work for test suites that changed
directory before combining data, causing "Couldn't use data file: no such
table: meta" errors (`issue 916`_).  This is now fixed.

- Coverage could fail to run your program with some form of "ModuleNotFound" or
"ImportError" trying to import from the current directory. This would happen
if coverage had been packaged into a zip file (for example, on Windows), or
was found indirectly (for example, by pyenv-virtualenv).  A number of
different scenarios were described in `issue 862`_ which is now fixed.  Huge
thanks to Agbonze O. Jeremiah for reporting it, and Alexander Waters and
George-Cristian Bîrzan for protracted debugging sessions.

- Added the "premain" debug option.

- Added SQLite compile-time options to the "debug sys" output.

.. _issue 862: https://github.com/nedbat/coveragepy/issues/862
.. _issue 916: https://github.com/nedbat/coveragepy/issues/916


.. _changes_502:

5.0.2

----------------------------

- Programs that used multiprocessing and changed directories would fail under
coverage.  This is now fixed (`issue 890`_).  A side effect is that debug
information about the config files read now shows absolute paths to the
files.

- When running programs as modules (``coverage run -m``) with ``--source``,
some measured modules were imported before coverage starts.  This resulted in
unwanted warnings ("Already imported a file that will be measured") and a
reduction in coverage totals (`issue 909`_).  This is now fixed.

- If no data was collected, an exception about "No data to report" could happen
instead of a 0% report being created (`issue 884`_).  This is now fixed.

- The handling of source files with non-encodable file names has changed.
Previously, if a file name could not be encoded as UTF-8, an error occurred,
as described in `issue 891`_.  Now, those files will not be measured, since
their data would not be recordable.

- A new warning ("dynamic-conflict") is issued if two mechanisms are trying to
change the dynamic context.  Closes `issue 901`_.

- ``coverage run --debug=sys`` would fail with an AttributeError. This is now
fixed (`issue 907`_).

.. _issue 884: https://github.com/nedbat/coveragepy/issues/884
.. _issue 890: https://github.com/nedbat/coveragepy/issues/890
.. _issue 891: https://github.com/nedbat/coveragepy/issues/891
.. _issue 901: https://github.com/nedbat/coveragepy/issues/901
.. _issue 907: https://github.com/nedbat/coveragepy/issues/907
.. _issue 909: https://github.com/nedbat/coveragepy/issues/909


.. _changes_501:

5.0.1

----------------------------

- If a 4.x data file is the cause of a "file is not a database" error, then use
a more specific error message, "Looks like a coverage 4.x data file, are you
mixing versions of coverage?"  Helps diagnose the problems described in
`issue 886`_.

- Measurement contexts and relative file names didn't work together, as
reported in `issue 899`_ and `issue 900`_.  This is now fixed, thanks to
David Szotten.

- When using ``coverage run --concurrency=multiprocessing``, all data files
should be named with parallel-ready suffixes.  5.0 mistakenly named the main
process' file with no suffix when using ``--append``.  This is now fixed,
closing `issue 880`_.

- Fixed a problem on Windows when the current directory is changed to a
different drive (`issue 895`_).  Thanks, Olivier Grisel.

- Updated Python 3.9 support to 3.9a2.

.. _issue 880: https://github.com/nedbat/coveragepy/issues/880
.. _issue 886: https://github.com/nedbat/coveragepy/issues/886
.. _issue 895: https://github.com/nedbat/coveragepy/issues/895
.. _issue 899: https://github.com/nedbat/coveragepy/issues/899
.. _issue 900: https://github.com/nedbat/coveragepy/issues/900


.. _changes_50:

5.0

--------------------------

Nothing new beyond 5.0b2.


.. _changes_50b2:

5.0b2

----------------------------

- An experimental ``[run] relative_files`` setting tells coverage to store
relative file names in the data file. This makes it easier to run tests in
one (or many) environments, and then report in another.  It has not had much
real-world testing, so it may change in incompatible ways in the future.

- When constructing a :class:`coverage.Coverage` object, `data_file` can be
specified as None to prevent writing any data file at all.  In previous
versions, an explicit `data_file=None` argument would use the default of
".coverage". Fixes `issue 871`_.

- Python files run with ``-m`` now have ``__spec__`` defined properly.  This
fixes `issue 745`_ (about not being able to run unittest tests that spawn
subprocesses), and `issue 838`_, which described the problem directly.

- The ``[paths]`` configuration section is now ordered. If you specify more
than one list of patterns, the first one that matches will be used.  Fixes
`issue 649`_.

- The :func:`.coverage.numbits.register_sqlite_functions` function now also
registers `numbits_to_nums` for use in SQLite queries.  Thanks, Simon
Willison.

- Python 3.9a1 is supported.

- Coverage.py has a mascot: :ref:`Sleepy Snake <sleepy>`.

.. _issue 649: https://github.com/nedbat/coveragepy/issues/649
.. _issue 745: https://github.com/nedbat/coveragepy/issues/745
.. _issue 838: https://github.com/nedbat/coveragepy/issues/838
.. _issue 871: https://github.com/nedbat/coveragepy/issues/871


.. _changes_50b1:

5.0b1

----------------------------

- The HTML and textual reports now have a ``--skip-empty`` option that skips
files with no statements, notably ``__init__.py`` files.  Thanks, Reya B.

- Configuration can now be read from `TOML`_ files.  This requires installing
coverage.py with the ``[toml]`` extra.  The standard "pyproject.toml" file
will be read automatically if no other configuration file is found, with
settings in the ``[tool.coverage.]`` namespace.  Thanks to Frazer McLean for
implementation and persistence.  Finishes `issue 664`_.

- The ``[run] note`` setting has been deprecated. Using it will result in a
warning, and the note will not be written to the data file.  The
corresponding :class:`.CoverageData` methods have been removed.

- The HTML report has been reimplemented (no more table around the source
code). This allowed for a better presentation of the context information,
hopefully resolving `issue 855`_.

- Added sqlite3 module version information to ``coverage debug sys`` output.

- Asking the HTML report to show contexts (``[html] show_contexts=True`` or
``coverage html --show-contexts``) will issue a warning if there were no
contexts measured (`issue 851`_).

.. _TOML: https://github.com/toml-lang/tomlreadme
.. _issue 664: https://github.com/nedbat/coveragepy/issues/664
.. _issue 851: https://github.com/nedbat/coveragepy/issues/851
.. _issue 855: https://github.com/nedbat/coveragepy/issues/855


.. _changes_50a8:

5.0a8

----------------------------

- The :class:`.CoverageData` API has changed how queries are limited to
specific contexts.  Now you use :meth:`.CoverageData.set_query_context` to
set a single exact-match string, or :meth:`.CoverageData.set_query_contexts`
to set a list of regular expressions to match contexts.  This changes the
command-line ``--contexts`` option to use regular expressions instead of
filename-style wildcards.


.. _changes_50a7:

5.0a7

----------------------------

- Data can now be "reported" in JSON format, for programmatic use, as requested
in `issue 720`_.  The new ``coverage json`` command writes raw and summarized
data to a JSON file.  Thanks, Matt Bachmann.

- Dynamic contexts are now supported in the Python tracer, which is important
for PyPy users.  Closes `issue 846`_.

- The compact line number representation introduced in 5.0a6 is called a
"numbits."  The :mod:`coverage.numbits` module provides functions for working
with them.

- The reporting methods used to permanently apply their arguments to the
configuration of the Coverage object.  Now they no longer do.  The arguments
affect the operation of the method, but do not persist.

- A class named "test_something" no longer confuses the ``test_function``
dynamic context setting.  Fixes `issue 829`_.

- Fixed an unusual tokenizing issue with backslashes in comments.  Fixes
`issue 822`_.

- ``debug=plugin`` didn't properly support configuration or dynamic context
plugins, but now it does, closing `issue 834`_.

.. _issue 720: https://github.com/nedbat/coveragepy/issues/720
.. _issue 822: https://github.com/nedbat/coveragepy/issues/822
.. _issue 834: https://github.com/nedbat/coveragepy/issues/834
.. _issue 829: https://github.com/nedbat/coveragepy/issues/829
.. _issue 846: https://github.com/nedbat/coveragepy/issues/846


.. _changes_50a6:

5.0a6

----------------------------

- Reporting on contexts. Big thanks to Stephan Richter and Albertas Agejevas
for the contribution.

- The ``--contexts`` option is available on the ``report`` and ``html``
 commands.  It's a comma-separated list of shell-style wildcards, selecting
 the contexts to report on.  Only contexts matching one of the wildcards
 will be included in the report.

- The ``--show-contexts`` option for the ``html`` command adds context
 information to each covered line.  Hovering over the "ctx" marker at the
 end of the line reveals a list of the contexts that covered the line.

- Database changes:

- Line numbers are now stored in a much more compact way.  For each file and
 context, a single binary string is stored with a bit per line number.  This
 greatly improves memory use, but makes ad-hoc use difficult.

- Dynamic contexts with no data are no longer written to the database.

- SQLite data storage is now faster.  There's no longer a reason to keep the
 JSON data file code, so it has been removed.

- Changes to the :class:`.CoverageData` interface:

- The new :meth:`.CoverageData.dumps` method serializes the data to a string,
 and a corresponding :meth:`.CoverageData.loads` method reconstitutes this
 data.  The format of the data string is subject to change at any time, and
 so should only be used between two installations of the same version of
 coverage.py.

- The :meth:`CoverageData constructor<.CoverageData.__init__>` has a new
 argument, `no_disk` (default: False).  Setting it to True prevents writing
 any data to the disk.  This is useful for transient data objects.

- Added the classmethod :meth:`.Coverage.current` to get the latest started
Coverage instance.

- Multiprocessing support in Python 3.8 was broken, but is now fixed.  Closes
`issue 828`_.

- Error handling during reporting has changed slightly.  All reporting methods
now behave the same.  The ``--ignore-errors`` option keeps errors from
stopping the reporting, but files that couldn't parse as Python will always
be reported as warnings.  As with other warnings, you can suppress them with
the ``[run] disable_warnings`` configuration setting.

- Coverage.py no longer fails if the user program deletes its current
directory. Fixes `issue 806`_.  Thanks, Dan Hemberger.

- The scrollbar markers in the HTML report now accurately show the highlighted
lines, regardless of what categories of line are highlighted.

- The hack to accommodate ShiningPanda_ looking for an obsolete internal data
file has been removed, since ShiningPanda 0.22 fixed it four years ago.

- The deprecated `Reporter.file_reporters` property has been removed.

.. _ShiningPanda: https://wiki.jenkins.io/display/JENKINS/ShiningPanda+Plugin
.. _i

---

<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
## 📋 Pull Request Information **Original PR:** https://github.com/jeffknupp/sandman2/pull/150 **Author:** [@pyup-bot](https://github.com/pyup-bot) **Created:** 4/20/2020 **Status:** ❌ Closed **Base:** `master` ← **Head:** `pyup-scheduled-update-2020-04-20` --- ### 📝 Commits (10+) - [`9d3eb12`](https://github.com/jeffknupp/sandman2/commit/9d3eb1237bcd06f0dded032268ceb5b6965735e8) Update flask from 1.1.1 to 1.1.2 - [`d038a52`](https://github.com/jeffknupp/sandman2/commit/d038a52fb8a002c89e437993e282bf46afd20351) Update flask-admin from 1.5.3 to 1.5.6 - [`0139262`](https://github.com/jeffknupp/sandman2/commit/01392623da7bdb3b3bd0b65540b9b9b2814d4dd9) Update sqlalchemy from 1.3.8 to 1.3.16 - [`4d4a48f`](https://github.com/jeffknupp/sandman2/commit/4d4a48f9206559f36cc298f16020e556aea4c19d) Update coverage from 4.5.4 to 5.1 - [`ae69f4b`](https://github.com/jeffknupp/sandman2/commit/ae69f4b0d986d37b19646a3f8e99e8f12b00aac0) Update pytest from 5.2.0 to 5.4.1 - [`b015c69`](https://github.com/jeffknupp/sandman2/commit/b015c69c225a654187e6623fda7743b5baee7564) Update pytest-cov from 2.7.1 to 2.8.1 - [`35c6380`](https://github.com/jeffknupp/sandman2/commit/35c638058eb66e377b8788c996615727e2577fac) Update pytest-flask from 0.15.0 to 1.0.0 - [`737c91c`](https://github.com/jeffknupp/sandman2/commit/737c91c7b09f2c8e8599b52ac43b873f58c35bba) Update six from 1.12.0 to 1.14.0 - [`3c6a3b1`](https://github.com/jeffknupp/sandman2/commit/3c6a3b13150dd618a9881dacc345c5fc1a3441af) Update wcwidth from 0.1.7 to 0.1.9 - [`958424c`](https://github.com/jeffknupp/sandman2/commit/958424c6a5c1ac1e046e36bdc300f458990f534e) Update werkzeug from 0.15.4 to 1.0.1 ### 📊 Changes **1 file changed** (+11 additions, -11 deletions) <details> <summary>View changed files</summary> 📝 `requirements.txt` (+11 -11) </details> ### 📄 Description ### Update [Flask](https://pypi.org/project/Flask) from **1.1.1** to **1.1.2**. <details> <summary>Changelog</summary> ### 1.1.2 ``` ------------- Released 2020-04-03 - Work around an issue when running the ``flask`` command with an external debugger on Windows. :issue:`3297` - The static route will not catch all URLs if the ``Flask`` ``static_folder`` argument ends with a slash. :issue:`3452` ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/flask - Changelog: https://pyup.io/changelogs/flask/ - Homepage: https://palletsprojects.com/p/flask/ </details> ### Update [Flask-Admin](https://pypi.org/project/Flask-Admin) from **1.5.3** to **1.5.6**. <details> <summary>Changelog</summary> ### 1.5.6 ``` ----- * SQLAlchemy 1.3.6 compatibility fix * Python 3.8 support ``` ### 1.5.5 ``` ----- * Werkzeug 1.0 compatibility fix * Use fa-circle-o icon for unchecked booleans * A few SQLAlchemy-related bug fixes ``` ### 1.5.4 ``` ----- * Fix display of inline x-editable boolean fields on list view * Add support for several SQLAlchemy-Utils data types * Support searching on SQLAlchemy hybrid properties * Extra URL paramaters are now propagated to the next page when searching / filtering * Add enum34 dependency when running on legacy Python version * Update Mapbox API v1 URL format * Update jQuery and moment dependencies in templates * Fixed a datepicker issue, where only dates up to 2015 were showing up * Updated Pillow dependency version ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/flask-admin - Changelog: https://pyup.io/changelogs/flask-admin/ - Repo: https://github.com/flask-admin/flask-admin/ - Docs: https://pythonhosted.org/Flask-Admin/ </details> ### Update [SQLAlchemy](https://pypi.org/project/SQLAlchemy) from **1.3.8** to **1.3.16**. <details> <summary>Changelog</summary> ### 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 &quot;all_tab_comments&quot; 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 &quot;computed&quot; columns, which are now returned as part of the structure returned by :meth:`.Inspector.get_columns`. When reflecting full :class:`.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 &quot;covering&quot; 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 &quot;covering&quot; 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:&quot;Time&quot; 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 &quot;pyproject.toml&quot; 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 &quot;get&quot; against a target many-to-one relationship where an object with the correct primary key is present, however it&#39;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:`.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:`.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.join` when a left hand side can&#39;t be located that the :meth:`.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` 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 &quot;empty tuple&quot; 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&#39;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&#39;s best that these additional modules aren&#39;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 &quot;schema_translate_map&quot; feature would not work with a PostgreSQL native enumeration type (i.e. :class:`.Enum`, :class:`.postgresql.ENUM`) in that while the &quot;CREATE TYPE&quot; 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 &quot;reverse&quot; keyword argument can be provided. .. change:: :tags: bug, general, py3k :tickets: 4849 Applied an explicit &quot;cause&quot; 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 &quot;load context&quot; of the object after the event hook has been called. This ensures that the object remains within the &quot;loader context&quot; 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 &quot;opt-in&quot; 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 &quot;clone&quot; method which will uniquify the parameter name upon deserialize so that it doesn&#39;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 &quot;expanding IN&quot; 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 &quot;secondary&quot; table use about 70% less function calls. .. change:: :tags: usecase, postgresql :tickets: 5040 Added support for prefixes to the :class:`.CTE` construct, to allow support for Postgresql 12 &quot;MATERIALIZED&quot; and &quot;NOT MATERIALIZED&quot; phrases. Pull request courtesy Marat Sharafutdinov. .. seealso:: :meth:`.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 &quot;version_id&quot; feature. This warning is generally unreachable unless using a dialect that sets the &quot;supports_sane_rowcount&quot; 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.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:: ``` ### 1.3.12 ``` :released: December 16, 2019 .. change:: :tags: bug, sql :tickets: 5028 Fixed bug where &quot;distinct&quot; keyword passed to :func:`~.sql.expression.select` would not treat a string value as a &quot;label reference&quot; in the same way that the :meth:`.select.distinct` does; it would instead raise unconditionally. This keyword argument and the others passed to :func:`~.sql.expression.select` will ultimately be deprecated for SQLAlchemy 2.0. .. change:: :tags: bug, orm :tickets: 4997 Fixed issue involving ``lazy=&quot;raise&quot;`` strategy where an ORM delete of an object would raise for a simple &quot;use-get&quot; style many-to-one relationship that had lazy=&quot;raise&quot; configured. This is inconsistent vs. the change introduced in 1.3 as part of :ticket:`4353`, where it was established that a history operation that does not expect emit SQL should bypass the ``lazy=&quot;raise&quot;`` check, and instead effectively treat it as ``lazy=&quot;raise_on_sql&quot;`` for this case. The fix adjusts the lazy loader strategy to not raise for the case where the lazy load was instructed that it should not emit SQL if the object were not present. .. change:: :tags: bug, sql Changed the text of the exception for &quot;Can&#39;t resolve label reference&quot; to include other kinds of label coercions, namely that &quot;DISTINCT&quot; is also in this category under the PostgreSQL dialect. .. change:: :tags: bug, orm :tickets: 5000 Fixed regression introduced in 1.3.0 related to the association proxy refactor in :ticket:`4351` that prevented :func:`.composite` attributes from working in terms of an association proxy that references them. .. change:: :tags: bug, mssql :tickets: 4983 Repaired support for the :class:`.mssql.DATETIMEOFFSET` datatype on PyODBC, by adding PyODBC-level result handlers as it does not include native support for this datatype. This includes usage of the Python 3 &quot;timezone&quot; tzinfo subclass in order to set up a timezone, which on Python 2 makes use of a minimal backport of &quot;timezone&quot; in sqlalchemy.util. .. change:: :tags: bug, orm :tickets: 4993 Setting persistence-related flags on :func:`.relationship` while also setting viewonly=True will now emit a regular warning, as these flags do not make sense for a viewonly=True relationship. In particular, the &quot;cascade&quot; settings have their own warning that is generated based on the individual values, such as &quot;delete, delete-orphan&quot;, that should not apply to a viewonly relationship. Note however that in the case of &quot;cascade&quot;, these settings are still erroneously taking effect even though the relationship is set up as &quot;viewonly&quot;. In 1.4, all persistence-related cascade settings will be disallowed on a viewonly=True relationship in order to resolve this issue. .. change:: :tags: bug, sqlite :tickets: 5014 Fixed issue to workaround SQLite&#39;s behavior of assigning &quot;numeric&quot; affinity to JSON datatypes, first described at :ref:`change_3850`, which returns scalar numeric JSON values as a number and not as a string that can be JSON deserialized. The SQLite-specific JSON deserializer now gracefully degrades for this case as an exception and bypasses deserialization for single numeric values, as from a JSON perspective they are already deserialized. .. change:: :tags: bug, orm, py3k :tickets: 4990 Fixed issue where when assigning a collection to itself as a slice, the mutation operation would fail as it would first erase the assigned collection inadvertently. As an assignment that does not change the contents should not generate events, the operation is now a no-op. Note that the fix only applies to Python 3; in Python 2, the ``__setitem__`` hook isn&#39;t called in this case; ``__setslice__`` is used instead which recreates the list item-by-item in all cases. .. change:: :tags: bug, orm :tickets: 5034 Fixed issue where by if the &quot;begin&quot; of a transaction failed at the Core engine/connection level, such as due to network error or database is locked for some transactional recipes, within the context of the :class:`.Session` procuring that connection from the conneciton pool and then immediately returning it, the ORM :class:`.Session` would not close the connection despite this connection not being stored within the state of that :class:`.Session`. This would lead to the connection being cleaned out by the connection pool weakref handler within garbage collection which is an unpreferred codepath that in some special configurations can emit errors in standard error. .. changelog:: ``` ### 1.3.11 ``` :released: November 11, 2019 .. change:: :tags: bug, mssql :tickets: 4973 Fixed issue in MSSQL dialect where an expression-based OFFSET value in a SELECT would be rejected, even though the dialect can render this expression inside of a ROW NUMBER-oriented LIMIT/OFFSET construct. .. change:: :tags: orm, usecase :tickets: 4934 Added accessor :meth:`.Query.is_single_entity` to :class:`.Query`, which will indicate if the results returned by this :class:`.Query` will be a list of ORM entities, or a tuple of entities or column expressions. SQLAlchemy hopes to improve upon the behavior of single entity / tuples in future releases such that the behavior would be explicit up front, however this attribute should be helpful with the current behavior. Pull request courtesy Patrick Hayes. .. change:: :tags: bug, mysql :tickets: 4945 Added &quot;Connection was killed&quot; message interpreted from the base pymysql.Error class in order to detect closed connection, based on reports that this message is arriving via a pymysql.InternalError() object which indicates pymysql is not handling it correctly. .. change:: :tags: bug, orm :tickets: 4954 The :paramref:`.relationship.omit_join` flag was not intended to be manually set to True, and will now emit a warning when this occurs. The omit_join optimization is detected automatically, and the ``omit_join`` flag was only intended to disable the optimization in the hypothetical case that the optimization may have interfered with correct results, which has not been observed with the modern version of this feature. Setting the flag to True when it is not automatically detected may cause the selectin load feature to not work correctly when a non-default primary join condition is in use. .. change:: :tags: bug, orm :tickets: 4915 A warning is emitted if a primary key value is passed to :meth:`.Query.get` that consists of None for all primary key column positions. Previously, passing a single None outside of a tuple would raise a ``TypeError`` and passing a composite None (tuple of None values) would silently pass through. The fix now coerces the single None into a tuple where it is handled consistently with the other None conditions. Thanks to Lev Izraelit for the help with this. .. change:: :tags: bug, orm :tickets: 4947 The :class:`.BakedQuery` will not cache a query that was modified by a :meth:`.QueryEvents.before_compile` event, so that compilation hooks that may be applying ad-hoc modifications to queries will take effect on each run. In particular this is helpful for events that modify queries used in lazy loading as well as eager loading such as &quot;select in&quot; loading. In order to re-enable caching for a query modified by this event, a new flag ``bake_ok`` is added; see :ref:`baked_with_before_compile` for details. A longer term plan to provide a new form of SQL caching should solve this kind of issue more comprehensively. .. change:: :tags: bug, tests :tickets: 4920 Fixed test failures which would occur with newer SQLite as of version 3.30 or greater, due to their addition of nulls ordering syntax as well as new restrictions on aggregate functions. Pull request courtesy Nils Philippsen. .. change:: :tags: bug, installation, windows :tickets: 4967 Added a workaround for a setuptools-related failure that has been observed as occurring on Windows installations, where setuptools is not correctly reporting a build error when the MSVC build dependencies are not installed and therefore not allowing graceful degradation into non C extensions builds. .. change:: :tags: bug, sql, py3k :tickets: 4931 Changed the ``repr()`` of the :class:`.quoted_name` construct to use regular string repr() under Python 3, rather than running it through &quot;backslashreplace&quot; escaping, which can be misleading. .. change:: :tags: bug, oracle, firebird :tickets: 4931 Modified the approach of &quot;name normalization&quot; for the Oracle and Firebird dialects, which converts from the UPPERCASE-as-case-insensitive convention of these dialects into lowercase-as-case-insensitive for SQLAlchemy, to not automatically apply the :class:`.quoted_name` construct to a name that matches itself under upper or lower case conversion, as is the case for many non-european characters. All names used within metadata structures are converted to :class:`.quoted_name` objects in any case; the change here would only affect the output of some inspection functions. .. change:: :tags: bug, schema :tickets: 4911 Fixed bug where a table that would have a column label overlap with a plain column name, such as &quot;foo.id AS foo_id&quot; vs. &quot;foo.foo_id&quot;, would prematurely generate the ``._label`` attribute for a column before this overlap could be detected due to the use of the ``index=True`` or ``unique=True`` flag on the column in conjunction with the default naming convention of ``&quot;column_0_label&quot;``. This would then lead to failures when ``._label`` were used later to generate a bound parameter name, in particular those used by the ORM when generating the WHERE clause for an UPDATE statement. The issue has been fixed by using an alternate ``._label`` accessor for DDL generation that does not affect the state of the :class:`.Column`. The accessor also bypasses the key-deduplication step as it is not necessary for DDL, the naming is now consistently ``&quot;&lt;tablename&gt;_&lt;columnname&gt;&quot;`` without any subsequent numeric symbols when used in DDL. .. change:: :tags: bug, engine :tickets: 4902 Fixed bug where parameter repr as used in logging and error reporting needs additional context in order to distinguish between a list of parameters for a single statement and a list of parameter lists, as the &quot;list of lists&quot; structure could also indicate a single parameter list where the first parameter itself is a list, such as for an array parameter. The engine/connection now passes in an additional boolean indicating how the parameters should be considered. The only SQLAlchemy backend that expects arrays as parameters is that of psycopg2 which uses pyformat parameters, so this issue has not been too apparent, however as other drivers that use positional gain more features it is important that this be supported. It also eliminates the need for the parameter repr function to guess based on the parameter structure passed. .. change:: :tags: usecase, schema :tickets: 4894 Added DDL support for &quot;computed columns&quot;; these are DDL column specifications for columns that have a server-computed value, either upon SELECT (known as &quot;virtual&quot;) or at the point of which they are INSERTed or UPDATEd (known as &quot;stored&quot;). Support is established for Postgresql, MySQL, Oracle SQL Server and Firebird. Thanks to Federico Caselli for lots of work on this one. .. seealso:: :ref:`computed_ddl` .. change:: :tags: bug, engine, postgresql :tickets: 4955 Fixed bug in :class:`.Inspector` where the cache key generation did not take into account arguments passed in the form of tuples, such as the tuple of view name styles to return for the PostgreSQL dialect. This would lead the inspector to cache too generally for a more specific set of criteria. The logic has been adjusted to include every keyword element in the cache, as every argument is expected to be appropriate for a cache else the caching decorator should be bypassed by the dialect. .. change:: :tags: bug, mssql :tickets: 4923 Fixed an issue in the :meth:`.Engine.table_names` method where it would feed the dialect&#39;s default schema name back into the dialect level table function, which in the case of SQL Server would interpret it as a dot-tokenized schema name as viewed by the mssql dialect, which would cause the method to fail in the case where the database username actually had a dot inside of it. In 1.3, this method is still used by the :meth:`.MetaData.reflect` function so is a prominent codepath. In 1.4, which is the current master development branch, this issue doesn&#39;t exist, both because :meth:`.MetaData.reflect` isn&#39;t using this method nor does the method pass the default schema name explicitly. The fix nonetheless guards against the default server name value returned by the dialect from being interpreted as dot-tokenized name under any circumstances by wrapping it in quoted_name(). .. change:: :tags: bug, orm :tickets: 4974 Fixed ORM bug where a &quot;secondary&quot; table that referred to a selectable which in some way would refer to the local primary table would apply aliasing to both sides of the join condition when a relationship-related join, either via :meth:`.Query.join` or by :func:`.joinedload`, were generated. The &quot;local&quot; side is now excluded. .. change:: :tags: usecase, sql :tickets: 4276 Added new accessors to expressions of type :class:`.JSON` to allow for specific datatype access and comparison, covering strings, integers, numeric, boolean elements. This revises the documented approach of CASTing to string when comparing values, instead adding specific functionality into the PostgreSQL, SQlite, MySQL dialects to reliably deliver these basic types in all cases. .. seealso:: :class:`.JSON` :meth:`.JSON.Comparator.as_string` :meth:`.JSON.Comparator.as_boolean` :meth:`.JSON.Comparator.as_float` :meth:`.JSON.Comparator.as_integer` .. change:: :tags: usecase, oracle :tickets: 4799 Added dialect-level flag ``encoding_errors`` to the cx_Oracle dialect, which can be specified as part of :func:`.create_engine`. This is passed to SQLAlchemy&#39;s unicode decoding converter under Python 2, and to cx_Oracle&#39;s ``cursor.var()`` object as the ``encodingErrors`` parameter under Python 3, for the very unusual case that broken encodings are present in the target database which cannot be fetched unless error handling is relaxed. The value is ultimately one of the Python &quot;encoding errors&quot; parameters passed to ``decode()``. .. change:: :tags: usecase, sql :tickets: 4933 The :func:`.text` construct now supports &quot;unique&quot; bound parameters, which will dynamically uniquify themselves on compilation thus allowing multiple :func:`.text` constructs with the same bound parameter names to be combined together. .. change:: :tags: bug, oracle :tickets: 4913 The :class:`.sqltypes.NCHAR` datatype will now bind to the ``cx_Oracle.FIXED_NCHAR`` DBAPI data bindings when used in a bound parameter, which supplies proper comparison behavior against a variable-length string. Previously, the :class:`.sqltypes.NCHAR` datatype would bind to ``cx_oracle.NCHAR`` which is not fixed length; the :class:`.sqltypes.CHAR` datatype already binds to ``cx_Oracle.FIXED_CHAR`` so it is now consistent that :class:`.sqltypes.NCHAR` binds to ``cx_Oracle.FIXED_NCHAR``. .. change:: :tags: bug, firebird :tickets: 4903 Added additional &quot;disconnect&quot; message &quot;Error writing data to the connection&quot; to Firebird disconnection detection. Pull request courtesy lukens. .. changelog:: ``` ### 1.3.10 ``` :released: October 9, 2019 .. change:: :tags: bug, mssql :tickets: 4857 Fixed bug in SQL Server dialect with new &quot;max_identifier_length&quot; feature where the mssql dialect already featured this flag, and the implementation did not accommodate for the new initialization hook correctly. .. change:: :tags: bug, oracle :tickets: 4898, 4857 Fixed regression in Oracle dialect that was inadvertently using max identifier length of 128 characters on Oracle server 12.2 and greater even though the stated contract for the remainder of the 1.3 series is that this value stays at 30 until version SQLAlchemy 1.4. Also repaired issues with the retrieval of the &quot;compatibility&quot; version, and removed the warning emitted when the &quot;v$parameter&quot; view was not accessible as this was causing user confusion. .. changelog:: ``` ### 1.3.9 ``` :released: October 4, 2019 .. change:: :tags: usecase, engine :tickets: 4857 Added new :func:`.create_engine` parameter :paramref:`.create_engine.max_identifier_length`. This overrides the dialect-coded &quot;max identifier length&quot; in order to accommodate for databases that have recently changed this length and the SQLAlchemy dialect has not yet been adjusted to detect for that version. This parameter interacts with the existing :paramref:`.create_engine.label_length` parameter in that it establishes the maximum (and default) value for anonymously generated labels. Additionally, post-connection detection of max identifier lengths has been added to the dialect system. This feature is first being used by the Oracle dialect. .. seealso:: :ref:`oracle_max_identifier_lengths` - in the Oracle dialect documentation .. change:: :tags: usecase, oracle :tickets: 4857 The Oracle dialect now emits a warning if Oracle version 12.2 or greater is used, and the :paramref:`.create_engine.max_identifier_length` parameter is not set. The version in this specific case defaults to that of the &quot;compatibility&quot; version set in the Oracle server configuration, not the actual server version. In version 1.4, the default max_identifier_length for 12.2 or greater will move to 128 characters. In order to maintain forwards compatibility, applications should set :paramref:`.create_engine.max_identifier_length` to 30 in order to maintain the same length behavior, or to 128 in order to test the upcoming behavior. This length determines among other things how generated constraint names are truncated for statements like ``CREATE CONSTRAINT`` and ``DROP CONSTRAINT``, which means a the new length may produce a name-mismatch against a name that was generated with the old length, impacting database migrations. .. seealso:: :ref:`oracle_max_identifier_lengths` - in the Oracle dialect documentation .. change:: :tags: usecase, sqlite :tickets: 4863 Added support for sqlite &quot;URI&quot; connections, which allow for sqlite-specific flags to be passed in the query string such as &quot;read only&quot; for Python sqlite3 drivers that support this. .. seealso:: :ref:`pysqlite_uri_connections` .. change:: :tags: bug, tests :tickets: 4285 Fixed unit test regression released in 1.3.8 that would cause failure for Oracle, SQL Server and other non-native ENUM platforms due to new enumeration tests added as part of :ticket:`4285` enum sortability in the unit of work; the enumerations created constraints that were duplicated on name. .. change:: :tags: bug, oracle :tickets: 4886 Restored adding cx_Oracle.DATETIME to the setinputsizes() call when a SQLAlchemy :class:`.Date`, :class:`.DateTime` or :class:`.Time` datatype is used, as some complex queries require this to be present. This was removed in the 1.2 series for arbitrary reasons. .. change:: :tags: bug, mssql :tickets: 4883 Added identifier quoting to the schema name applied to the &quot;use&quot; statement which is invoked when a SQL Server multipart schema name is used within a :class:`.Table` that is being reflected, as well as for :class:`.Inspector` methods such as :meth:`.Inspector.get_table_names`; this accommodates for special characters or spaces in the database name. Additionally, the &quot;use&quot; statement is not emitted if the current database matches the target owner database name being passed. .. change:: :tags: bug, orm :tickets: 4872 Fixed regression in selectinload loader strategy caused by :ticket:`4775` (released in version 1.3.6) where a many-to-one attribute of None would no longer be populated by the loader. While this was usually not noticeable due to the lazyloader populating None upon get, it would lead to a detached instance error if the object were detached. .. change:: :tags: bug, orm :tickets: 4873 Passing a plain string expression to :meth:`.Session.query` is deprecated, as all string coercions were removed in :ticket:`4481` and this one should have been included. The :func:`.literal_column` function may be used to produce a textual column expression. .. change:: :tags: usecase, sql :tickets: 4847 Added an explicit error message for the case when objects passed to :class:`.Table` are not :class:`.SchemaItem` objects, rather than resolving to an attribute error. .. change:: :tags: bug, orm :tickets: 4890 A warning is emitted for a condition in which the :class:`.Session` may implicitly swap an object out of the identity map for another one with the same primary key, detaching the old one, which can be an observed result of load operations which occur within the :meth:`.SessionEvents.after_flush` hook. The warning is intended to notify the user that some special condition has caused this to happen and that the previous object may not be in the expected state. .. change:: :tags: bug, sql :tickets: 4837 Characters that interfere with &quot;pyformat&quot; or &quot;named&quot; formats in bound parameters, namely ``%, (, )`` and the space character, as well as a few other typically undesirable characters, are stripped early for a :func:`.bindparam` that is using an anonymized name, which is typically generated automatically from a named column which itself includes these characters in its name and does not use a ``.key``, so that they do not interfere either with the SQLAlchemy compiler&#39;s use of string formatting or with the driver-level parsing of the parameter, both of which could be demonstrated before the fix. The change only applies to anonymized parameter names that are generated and consumed internally, not end-user defined names, so the change should have no impact on any existing code. Applies in particular to the psycopg2 driver which does not otherwise quote special parameter names, but also strips leading underscores to suit Oracle (but not yet leading numbers, as some anon parameters are currently entirely numeric/underscore based); Oracle in any case continues to quote parameter names that include special characters. .. changelog:: ``` </details> <details> <summary>Links</summary> - PyPI: https://pypi.org/project/sqlalchemy - Changelog: https://pyup.io/changelogs/sqlalchemy/ - Homepage: http://www.sqlalchemy.org </details> ### Update [coverage](https://pypi.org/project/coverage) from **4.5.4** to **5.1**. <details> <summary>Changelog</summary> ### 5.1 ``` -------------------------- - The JSON report now includes counts of covered and missing branches. Thanks, Salvatore Zagaria. - On Python 3.8, try-finally-return reported wrong branch coverage with decorated async functions (`issue 946`_). This is now fixed. Thanks, Kjell Braden. - The :meth:`~coverage.Coverage.get_option` and :meth:`~coverage.Coverage.set_option` methods can now manipulate the ``[paths]`` configuration setting. Thanks to Bernát Gábor for the fix for `issue 967`_. .. _issue 946: https://github.com/nedbat/coveragepy/issues/946 .. _issue 967: https://github.com/nedbat/coveragepy/issues/967 .. _changes_504: ``` ### 5.0.4 ``` ---------------------------- - If using the ``[run] relative_files`` setting, the XML report will use relative files in the ``&lt;source&gt;`` elements indicating the location of source code. Closes `issue 948`_. - The textual summary report could report missing lines with negative line numbers on PyPy3 7.1 (`issue 943`_). This is now fixed. - Windows wheels for Python 3.8 were incorrectly built, but are now fixed. (`issue 949`_) - Updated Python 3.9 support to 3.9a4. - HTML reports couldn&#39;t be sorted if localStorage wasn&#39;t available. This is now fixed: sorting works even though the sorting setting isn&#39;t retained. (`issue 944`_ and `pull request 945`_). Thanks, Abdeali Kothari. .. _issue 943: https://github.com/nedbat/coveragepy/issues/943 .. _issue 944: https://github.com/nedbat/coveragepy/issues/944 .. _pull request 945: https://github.com/nedbat/coveragepy/pull/945 .. _issue 948: https://github.com/nedbat/coveragepy/issues/948 .. _issue 949: https://github.com/nedbat/coveragepy/issues/949 .. _changes_503: ``` ### 5.0.3 ``` ---------------------------- - A performance improvement in 5.0.2 didn&#39;t work for test suites that changed directory before combining data, causing &quot;Couldn&#39;t use data file: no such table: meta&quot; errors (`issue 916`_). This is now fixed. - Coverage could fail to run your program with some form of &quot;ModuleNotFound&quot; or &quot;ImportError&quot; trying to import from the current directory. This would happen if coverage had been packaged into a zip file (for example, on Windows), or was found indirectly (for example, by pyenv-virtualenv). A number of different scenarios were described in `issue 862`_ which is now fixed. Huge thanks to Agbonze O. Jeremiah for reporting it, and Alexander Waters and George-Cristian Bîrzan for protracted debugging sessions. - Added the &quot;premain&quot; debug option. - Added SQLite compile-time options to the &quot;debug sys&quot; output. .. _issue 862: https://github.com/nedbat/coveragepy/issues/862 .. _issue 916: https://github.com/nedbat/coveragepy/issues/916 .. _changes_502: ``` ### 5.0.2 ``` ---------------------------- - Programs that used multiprocessing and changed directories would fail under coverage. This is now fixed (`issue 890`_). A side effect is that debug information about the config files read now shows absolute paths to the files. - When running programs as modules (``coverage run -m``) with ``--source``, some measured modules were imported before coverage starts. This resulted in unwanted warnings (&quot;Already imported a file that will be measured&quot;) and a reduction in coverage totals (`issue 909`_). This is now fixed. - If no data was collected, an exception about &quot;No data to report&quot; could happen instead of a 0% report being created (`issue 884`_). This is now fixed. - The handling of source files with non-encodable file names has changed. Previously, if a file name could not be encoded as UTF-8, an error occurred, as described in `issue 891`_. Now, those files will not be measured, since their data would not be recordable. - A new warning (&quot;dynamic-conflict&quot;) is issued if two mechanisms are trying to change the dynamic context. Closes `issue 901`_. - ``coverage run --debug=sys`` would fail with an AttributeError. This is now fixed (`issue 907`_). .. _issue 884: https://github.com/nedbat/coveragepy/issues/884 .. _issue 890: https://github.com/nedbat/coveragepy/issues/890 .. _issue 891: https://github.com/nedbat/coveragepy/issues/891 .. _issue 901: https://github.com/nedbat/coveragepy/issues/901 .. _issue 907: https://github.com/nedbat/coveragepy/issues/907 .. _issue 909: https://github.com/nedbat/coveragepy/issues/909 .. _changes_501: ``` ### 5.0.1 ``` ---------------------------- - If a 4.x data file is the cause of a &quot;file is not a database&quot; error, then use a more specific error message, &quot;Looks like a coverage 4.x data file, are you mixing versions of coverage?&quot; Helps diagnose the problems described in `issue 886`_. - Measurement contexts and relative file names didn&#39;t work together, as reported in `issue 899`_ and `issue 900`_. This is now fixed, thanks to David Szotten. - When using ``coverage run --concurrency=multiprocessing``, all data files should be named with parallel-ready suffixes. 5.0 mistakenly named the main process&#39; file with no suffix when using ``--append``. This is now fixed, closing `issue 880`_. - Fixed a problem on Windows when the current directory is changed to a different drive (`issue 895`_). Thanks, Olivier Grisel. - Updated Python 3.9 support to 3.9a2. .. _issue 880: https://github.com/nedbat/coveragepy/issues/880 .. _issue 886: https://github.com/nedbat/coveragepy/issues/886 .. _issue 895: https://github.com/nedbat/coveragepy/issues/895 .. _issue 899: https://github.com/nedbat/coveragepy/issues/899 .. _issue 900: https://github.com/nedbat/coveragepy/issues/900 .. _changes_50: ``` ### 5.0 ``` -------------------------- Nothing new beyond 5.0b2. .. _changes_50b2: ``` ### 5.0b2 ``` ---------------------------- - An experimental ``[run] relative_files`` setting tells coverage to store relative file names in the data file. This makes it easier to run tests in one (or many) environments, and then report in another. It has not had much real-world testing, so it may change in incompatible ways in the future. - When constructing a :class:`coverage.Coverage` object, `data_file` can be specified as None to prevent writing any data file at all. In previous versions, an explicit `data_file=None` argument would use the default of &quot;.coverage&quot;. Fixes `issue 871`_. - Python files run with ``-m`` now have ``__spec__`` defined properly. This fixes `issue 745`_ (about not being able to run unittest tests that spawn subprocesses), and `issue 838`_, which described the problem directly. - The ``[paths]`` configuration section is now ordered. If you specify more than one list of patterns, the first one that matches will be used. Fixes `issue 649`_. - The :func:`.coverage.numbits.register_sqlite_functions` function now also registers `numbits_to_nums` for use in SQLite queries. Thanks, Simon Willison. - Python 3.9a1 is supported. - Coverage.py has a mascot: :ref:`Sleepy Snake &lt;sleepy&gt;`. .. _issue 649: https://github.com/nedbat/coveragepy/issues/649 .. _issue 745: https://github.com/nedbat/coveragepy/issues/745 .. _issue 838: https://github.com/nedbat/coveragepy/issues/838 .. _issue 871: https://github.com/nedbat/coveragepy/issues/871 .. _changes_50b1: ``` ### 5.0b1 ``` ---------------------------- - The HTML and textual reports now have a ``--skip-empty`` option that skips files with no statements, notably ``__init__.py`` files. Thanks, Reya B. - Configuration can now be read from `TOML`_ files. This requires installing coverage.py with the ``[toml]`` extra. The standard &quot;pyproject.toml&quot; file will be read automatically if no other configuration file is found, with settings in the ``[tool.coverage.]`` namespace. Thanks to Frazer McLean for implementation and persistence. Finishes `issue 664`_. - The ``[run] note`` setting has been deprecated. Using it will result in a warning, and the note will not be written to the data file. The corresponding :class:`.CoverageData` methods have been removed. - The HTML report has been reimplemented (no more table around the source code). This allowed for a better presentation of the context information, hopefully resolving `issue 855`_. - Added sqlite3 module version information to ``coverage debug sys`` output. - Asking the HTML report to show contexts (``[html] show_contexts=True`` or ``coverage html --show-contexts``) will issue a warning if there were no contexts measured (`issue 851`_). .. _TOML: https://github.com/toml-lang/tomlreadme .. _issue 664: https://github.com/nedbat/coveragepy/issues/664 .. _issue 851: https://github.com/nedbat/coveragepy/issues/851 .. _issue 855: https://github.com/nedbat/coveragepy/issues/855 .. _changes_50a8: ``` ### 5.0a8 ``` ---------------------------- - The :class:`.CoverageData` API has changed how queries are limited to specific contexts. Now you use :meth:`.CoverageData.set_query_context` to set a single exact-match string, or :meth:`.CoverageData.set_query_contexts` to set a list of regular expressions to match contexts. This changes the command-line ``--contexts`` option to use regular expressions instead of filename-style wildcards. .. _changes_50a7: ``` ### 5.0a7 ``` ---------------------------- - Data can now be &quot;reported&quot; in JSON format, for programmatic use, as requested in `issue 720`_. The new ``coverage json`` command writes raw and summarized data to a JSON file. Thanks, Matt Bachmann. - Dynamic contexts are now supported in the Python tracer, which is important for PyPy users. Closes `issue 846`_. - The compact line number representation introduced in 5.0a6 is called a &quot;numbits.&quot; The :mod:`coverage.numbits` module provides functions for working with them. - The reporting methods used to permanently apply their arguments to the configuration of the Coverage object. Now they no longer do. The arguments affect the operation of the method, but do not persist. - A class named &quot;test_something&quot; no longer confuses the ``test_function`` dynamic context setting. Fixes `issue 829`_. - Fixed an unusual tokenizing issue with backslashes in comments. Fixes `issue 822`_. - ``debug=plugin`` didn&#39;t properly support configuration or dynamic context plugins, but now it does, closing `issue 834`_. .. _issue 720: https://github.com/nedbat/coveragepy/issues/720 .. _issue 822: https://github.com/nedbat/coveragepy/issues/822 .. _issue 834: https://github.com/nedbat/coveragepy/issues/834 .. _issue 829: https://github.com/nedbat/coveragepy/issues/829 .. _issue 846: https://github.com/nedbat/coveragepy/issues/846 .. _changes_50a6: ``` ### 5.0a6 ``` ---------------------------- - Reporting on contexts. Big thanks to Stephan Richter and Albertas Agejevas for the contribution. - The ``--contexts`` option is available on the ``report`` and ``html`` commands. It&#39;s a comma-separated list of shell-style wildcards, selecting the contexts to report on. Only contexts matching one of the wildcards will be included in the report. - The ``--show-contexts`` option for the ``html`` command adds context information to each covered line. Hovering over the &quot;ctx&quot; marker at the end of the line reveals a list of the contexts that covered the line. - Database changes: - Line numbers are now stored in a much more compact way. For each file and context, a single binary string is stored with a bit per line number. This greatly improves memory use, but makes ad-hoc use difficult. - Dynamic contexts with no data are no longer written to the database. - SQLite data storage is now faster. There&#39;s no longer a reason to keep the JSON data file code, so it has been removed. - Changes to the :class:`.CoverageData` interface: - The new :meth:`.CoverageData.dumps` method serializes the data to a string, and a corresponding :meth:`.CoverageData.loads` method reconstitutes this data. The format of the data string is subject to change at any time, and so should only be used between two installations of the same version of coverage.py. - The :meth:`CoverageData constructor&lt;.CoverageData.__init__&gt;` has a new argument, `no_disk` (default: False). Setting it to True prevents writing any data to the disk. This is useful for transient data objects. - Added the classmethod :meth:`.Coverage.current` to get the latest started Coverage instance. - Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes `issue 828`_. - Error handling during reporting has changed slightly. All reporting methods now behave the same. The ``--ignore-errors`` option keeps errors from stopping the reporting, but files that couldn&#39;t parse as Python will always be reported as warnings. As with other warnings, you can suppress them with the ``[run] disable_warnings`` configuration setting. - Coverage.py no longer fails if the user program deletes its current directory. Fixes `issue 806`_. Thanks, Dan Hemberger. - The scrollbar markers in the HTML report now accurately show the highlighted lines, regardless of what categories of line are highlighted. - The hack to accommodate ShiningPanda_ looking for an obsolete internal data file has been removed, since ShiningPanda 0.22 fixed it four years ago. - The deprecated `Reporter.file_reporters` property has been removed. .. _ShiningPanda: https://wiki.jenkins.io/display/JENKINS/ShiningPanda+Plugin .. _i --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-26 01:33:30 +03:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
pyup-scheduled-update-2026-04-20
pyup-scheduled-update-2024-09-16
pyup-scheduled-update-2023-07-24
pyup-scheduled-update-2023-06-19
pyup-scheduled-update-2023-05-22
pyup-scheduled-update-2023-05-15
pyup-scheduled-update-2023-05-08
dependabot/pip/flask-2.3.2
pyup-scheduled-update-2023-05-01
pyup-scheduled-update-2023-04-03
dependabot/pip/werkzeug-2.2.3
pyup-scheduled-update-2022-11-14
pyup-scheduled-update-2022-10-03
pyup-scheduled-update-2022-08-01
pyup-scheduled-update-2022-06-13
pyup-scheduled-update-2022-05-30
pyup-scheduled-update-2022-03-07
pyup-scheduled-update-2022-01-10
pyup-scheduled-update-2021-11-01
pyup-scheduled-update-2020-10-05
pyup-scheduled-update-2019-09-30
pyup-scheduled-update-2019-07-29
pyup-scheduled-update-2019-07-22
pyup-scheduled-update-2019-05-27
pyup-scheduled-update-2019-03-11
marshmallow
pyup-scheduled-update-2019-02-25
pyup-scheduled-update-2019-02-18
pyup-scheduled-update-2019-01-28
pyup-scheduled-update-2019-01-14
docker
name-map-stupid
swagger
fix-pagination
doc-expansion
specify-schema
No results found.
Labels
Clear labels   
bug

   
duplicate

   
enhancement

   
help wanted

   
invalid

   
pull-request

Mirrored from GitHub Pull Request

  
question

   
refactoring

   
research

   
wontfix
No labels
bug
duplicate
enhancement
help wanted
invalid
pull-request
question
refactoring
research
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/sandman2-jeffknupp#179
No description provided.