- Nothing changed yet.
Important: This release drops compatibility with old, unsupported
versions of Python and Django (see details below). If you still use
those versions, you should pin django-cid < 3
.
- Add support of Django 3.2, 4.0, 4.1 and 4.2.
- backward incompatible Drop support of Python 3.7 and prior versions. Only Python 3.8 and later are supported.
- backward incompatible Drop support of Django 3.0 and prior versions. Only Django 3.1 and later are supported.
- Add
CID_SQL_STATEMENT_TEMPLATE
setting to customize the position of the correlation relative to the original SQL statement. Contributed by Cauê Garcia Polimanti (@CaueP).
- Under Python 3.7 and later, use context variables (with the contextvars module) instead of a thread-local variable to avoid state bleeding in concurrent code.
- Add support of Django 3.1.
- Remove support of Python 3.5.
- Under Python 3.7 and later, use context variables (with the contextvars module) instead of a thread-local variable to avoid state bleeding in concurrent code. Version 2.2 had a bug that caused context variables to never be used. Thread-local variables were always used.
- Add support of Django 3.0
- backward incompatible Drop support of Django 2.1.
- backward incompatible Drop support of Python 3.4.
- backward incompatible Drop support of Django 1.11 and Django 2.0.
- Add
CID_GENERATOR
setting to allow the customization of the correlation id.
- bugfix: Fix packaging bug (introduced in version 1.2) that
caused two extra packages
tests
andsandbox
to be installed.
- bugfix: Fix bug (introduced in version 1.0) that caused the correlation id to be reused across all requests that were processed by the same thread.
- Allow to concatenate an upstream correlation id with a
locally-generated one, with a new
CID_CONCATENATE_IDS
setting.
Warning: this release includes changes that are not backward compatible. Be sure to read the details below to know if and how you can migrate.
backward incompatible Drop support of Django 1.10 and earlier.
backward incompatible Drop support of Python 2.
Add support of Django 2. Version 0.x could already be used with Django 2 but tests were not run against it. They now are.
Generate cid outside of the middleware when
GENERATE_CID
is enabled, so that it's available even if the middleware is not used.Fix support of Django 1.11 in database backends.
Add PostGIS database backend.
Add
CID_SQL_COMMENT_TEMPLATE
to customize how the cid is included as comments in SQL queries.backward incompatible Change the app name to be used in INSTALLED_APPS.
Migration from version 0.x: if you had
cid
inINSTALLED_APPS
, replace it bycid.apps.CidAppConfig
. If you did not, add the latter.backward incompatible Drop compatibility with
MIDDLEWARE_CLASSES
. You should use theMIDDLEWARE
setting. If you already did, no change is necessary.If you really must use the old
MIDDLEWARE_CLASSES
setting, includeCidOldStyleMiddleware
instead ofCidMiddleware
.
- Added support for Django 1.10 middleware (thanks @qbey)
- Made CID repsonse header configurable, and optional (thanks @dbaty)
- First release on PyPI.