Skip to content

Latest commit

 

History

History
347 lines (232 loc) · 9.57 KB

CHANGELOG.rst

File metadata and controls

347 lines (232 loc) · 9.57 KB
Raw

Changelog

4.26.0 (2024-06-19)

  • Support Django 5.1.
  • Optimize sql_fingerprint() a bit, yielding ~2% savings.

4.25.0 (2023-10-11)

  • Support Django 5.0.

4.24.0 (2023-07-10)

  • Drop Python 3.7 support.

4.23.0 (2023-06-14)

  • Support Python 3.12.

4.22.3 (2023-05-30)

  • Fetch the test name from pytest where possible, which pulls in its parametrized name.

    Thanks to Gert Van Gool in PR #537.

4.22.2 (2023-05-30)

  • Avoid crashing when recording cache function calls that pass key or keys as a keyword argument, like cache.set(key="abc", value="def").

    Thanks to Benoît Casoetto in PR #545.

4.22.1 (2023-04-23)

  • Fix compatibility with sqlparse 0.4.4+. sqlparse reverted a change made in 0.4.0 around IN, so the old behaviour in django-perf-rec has been restored. Upgrade to avoid regenerating your performance record files.

4.22.0 (2023-02-25)

  • Support Django 4.2.

4.21.0 (2022-06-05)

  • Support Python 3.11.
  • Support Django 4.1.

4.20.1 (2022-05-18)

  • Fix 'overwrite' mode to prevent file corruption.

    Thanks to Peter Law for the report in Issue #468.

4.20.0 (2022-05-10)

  • Drop support for Django 2.2, 3.0, and 3.1.

4.19.0 (2022-05-10)

  • Add new MODE option, 'overwrite', which creates or updates missing records silently.

    Thanks to Peter Law in PR #461.

4.18.0 (2022-01-10)

  • Drop Python 3.6 support.

4.17.0 (2021-10-05)

  • Support Python 3.10.

4.16.0 (2021-09-28)

  • Support Django 4.0.

4.15.0 (2021-08-20)

  • Add type hints.

4.14.1 (2021-06-22)

  • Support arbitrary collections of keys being passed to Django cache operations. Previously only mappings and sequences were supported, now sets and mapping views will also work.

    Thanks to Peter Law in PR #378.

4.14.0 (2021-06-02)

  • Re-add simplification of SQL IN clauses to always use (...). This was done in 4.6.0 but accidentally reverted with the sqlparse upgrade in 4.8.0.

    Thanks to Dan Palmer for the report in Issue #373.

4.13.1 (2021-04-15)

  • Fix SQL simplication for UPDATE queries without a WHERE clause.

    Thanks to Peter Law for the report in Issue #360.

4.13.0 (2021-03-27)

  • Stop distributing tests to reduce package size. Tests are not intended to be run outside of the tox setup in the repository. Repackagers can use GitHub's tarballs per tag.

  • Add support for hiding some operations from being recorded, via a new capture_operation callable to record. This is potentially useful where a different backend is used in testing than would be used in production and thus a portion of the operations in a context are not representative.

    Thanks to Peter Law in PR #342.

4.12.0 (2021-01-25)

  • Support Django 3.2.

4.11.0 (2020-12-04)

  • Drop Python 3.5 support.

  • Remove ORM patching. Now that only Python 3.6 is supported, the insertion-order of dicts should mean Django's ORM always provides deterministic queries. The two patches django-perf-rec made on the ORM have been removed, and the corresponding dependency on patchy. You may need to regenerate your performance record files.

    This fixes an issue where use of annotate() with dependencies between the annotations could cause a query error after django-perf-rec sorted the annotation names.

    Thanks to Gordon Wrigley for the report in Issue #322.

4.10.0 (2020-11-20)

  • Correctly record calls to cache.get_or_set().

    Thanks to Peter Law for the report in Issue #319.

4.9.0 (2020-11-04)

  • Support Python 3.9.

  • Allow recording of tracebacks alongside db queries or cache operations, selected via a function passed as capture_traceback to record().

    Thanks to Nadege Michel in PR #299.

4.8.0 (2020-10-10)

  • Drop Django 2.0 and 2.1 support.
  • Upgrade for sqlparse 0.4.0+. This required changing how SQL lists of one element are simplified, e.g. IN (1) will now be simplified to IN (#) instead of IN (...). You should regenerate your performance record files to match.

4.7.0 (2020-06-15)

  • Add Django 3.1 support.

4.6.1 (2020-05-21)

  • Create YAML files as non-executable. This will not be applied to existing files, modify their permissions if necessary, or delete and recreate.

    Thanks to Peter Law for the report in Issue #264.

4.6.0 (2020-05-20)

  • Drop Django 1.11 support. Only Django 2.0+ is supported now.

  • Simplify SQL IN clauses to always use (...). Now x IN (1) and x IN (1,2) both simplify to x IN (...).

    Thanks to Dan Palmer in PR #263.

4.5.0 (2019-11-25)

  • Update Python support to 3.5-3.8, as 3.4 has reached its end of life.
  • Converted setuptools metadata to configuration file. This meant removing the __version__ attribute from the package. If you want to inspect the installed version, use importlib.metadata.version("django-perf-rec") (docs / backport).
  • Fix Q() Patchy patch for Django 2.0+ with non-ANDed Q()'s.

4.4.0 (2019-05-09)

  • Normalize SQL whitespace. This will change fingerprinted SQL in some cases.

4.3.0 (2019-04-26)

  • Add support for Django 2.2.

4.2.0 (2019-04-13)

  • Work with, and require, sqlparse > 0.3.0.

4.1.0 (2019-03-04)

  • Fix a bug in automatic test record naming when two different modules had a test with the same class + name that ran one after another.
  • Fix Python 3.7 DeprecationWarning for collections.abc (Python 3.7 not officially supported yet).

4.0.0 (2019-02-01)

  • Drop Python 2 support, only Python 3.4+ is supported now.
  • Drop Django 1.8, 1.9, and 1.10 support. Only Django 1.11+ is supported now.
  • Dropped requirements for kwargs-only and six.

3.1.1 (2018-12-03)

  • Fix to actually obey the HIDE_COLUMNS option.

3.1.0 (2018-12-02)

  • Add the HIDE_COLUMNS option in settings to disable replacing column lists with ... in all places.

3.0.0 (2018-07-17)

  • Don't replace columns in ORDER BY, GROUP BY and HAVING clauses.

2.2.0 (2018-01-24)

  • Use kwargs-only library rather than vendored copy.
  • Erase volatile part of PostgreSQL cursor name.

2.1.0 (2017-05-29)

  • Exposed the automatic naming logic used in record() in two new functions get_perf_path() and get_record_name(), in order to ease creation of test records from calls outside of tests.
  • Made the automatic test detection work when running under a Pytest fixture.
  • Stopped throwing warnings on Python 3.
  • Fixed loading empty performance record files.

2.0.1 (2017-03-02)

  • Make cascaded delete queries deterministic on Django <1.10, with another Patchy patch to make it match the order from 1.10+.

2.0.0 (2017-02-09)

  • Arguments to record must be passed as keyword arguments.
  • file_name is removed as an argument to record following its deprecation in release 1.1.0.

1.1.1 (2016-10-30)

  • Fix django session keys not being fingerprinted.
  • Show diff when records don't match (when not on pytest).
  • Add new 'MODE' setting with three modes. This allows customization of the behaviour for missing performance records. The new 'none' mode is particularly useful for CI servers as it makes tests fail if their corresponding performance records have not been committed.

1.1.0 (2016-10-26)

  • Fix automatic filenames for tests in .pyc files.
  • Add the path argument to record which allows specifying a relative directory or filename to use. This deprecates the file_name argument, which will be removed in a future major release. For more info see the README.

1.0.4 (2016-10-23)

  • Work with sqlparse 0.2.2

1.0.3 (2016-10-07)

  • Stopped setup.py installing tests module.

1.0.2 (2016-09-23)

  • Confirmed Django 1.8 and 1.10 support.

1.0.1 (2016-09-20)

  • Fix install_requires in setup.py.

1.0.0 (2016-09-19)

  • Initial version with record() that can record database queries and cache operations and error if they change between test runs.