Python Package Changelog
Kolo consists of a python package and a VSCode extension. This is the changelog for the
kolo python package. To view the changelog of the VSCode Extension go here
We recommend using the latest version of the kolo python package and VSCode extension. That way you’ll run the most stable and feature-rich versions
Remove support for json traces (
use_msgpack=false) that was deprecated in
tupleas a msgpack extension type to maintain hashability after deserializing.
frozensetas msgpack extension types.
Add support for custom field parsers for test generation.
datestrings in test generation.
Support parsing negative
timedeltastrings in test generation.
Convert non-string SQL Literal values to python values in test generation.
Improve generated asserts for delete queries in test generation.
Improve merging of generated asserts to simplify generated tests.
delete-old-tracescommands deprecated in
Stop officially supporting Django 4.1.
Add an early version of an editor agnostic kolo experience accessible via
Fix some invalid timestamps in Kolo’s internal trace format when tracing a test that mocks time with
Improve parsing of
INSERTqueries in test generation.
Support generating a test from a trace including multiple request/response sections. Previously we only used the first request/response pair.
Avoid duplicate arguments to
queryset.filterin generated assert code for delete queries.
Always include a request body when mocking outbound requests in generated tests. Previously we only supported json body data.
Avoid crashing on unhashable query data in test generation.
Fix validation of a msgpack trace downloaded from the Kolo dashboard.
Add support for using msgpack as an internal format for traces with the
use_msgpackconfig option. This is on by default and requires version
2.15.0of the VSCode Extension. Support for json traces (
use_msgpack=false) is deprecated and will be removed in a future version.
Add support for Python 3.12.
Log an error when a trace is too big to save to Kolo’s sqlite database.
Use timezone-aware datetimes in test generation.
Avoid generating code leading to a
MultipleObjectsReturnedexception in test generation.
__builtins__from module locals to save space and make raw traces more readable.
Increase the default busy timeout for Kolo’s sqlite database to 60s (from 5s).
Add a lower bound (
3.6.0) for the required version of asgiref.
Fix handling of foreign key values in generated asserts for update queries.
Stop creating test model instances with
Noneas a primary key in test generation.
Remove unnecessary blank lines between asserts in generated tests.
refresh_from_dbcalls from generated tests when there are no associated asserts.
Merge generated asserts from insert, update and delete database queries together.
Improve support for generic foreign keys in test generation.
Make asgiref dependency explicit so Kolo can be used with older Django versions.
Add support for generating tests using factory boy factories.
Change the behaviour of the
trace_processorsconfig value to append new processors instead of overriding the existing processors. This means you don’t need to copy the list of all Kolo’s default processors when adding your own custom processor.
Add support for fields with custom column names in Kolo test generation.
Change test generation import style to a more human style.
Add extra hooks to Kolo’s default test generation templates to enable further customisation of generated tests.
Improve the quality of test asserts generated from database queries.
Handle traces including bulk creates better in test generation.
Add preliminary support for sharing traces via Kolo Dashboard.
Track Django checks to allow better filtering in VSCode.
Track Django test database creation to allow better filtering in VSCode.
Stop filtering out module creation frames from traces. This allows better visibility of import flow.
Fix file path resolution edge-case on Windows for Python 3.8 and 3.9.
Fix a deprecation warning for Content-Type header parsing.
Turn off special handling of
simplejson.dumpssince this was adding unexpected entries to
MagicMock.mock_callsin traced tests.
NaNand infinite float values to
nullwhen encoding json.
kolo trace listto allow customising the results.
Add support for configuring Kolo in
pyproject.tomlin addition to
.kolo/config.toml. Fixes https://github.com/kolofordjango/kolo/issues/46.
Track Django setup logic entrypoint to allow better filtering in VSCode.
Improve stability of experimental threading support.
Really fix disabling of experimental threading support in the Rust extension.
Fix disabling of experimental threading support in the Rust extension.
Disable experimental threading support by default.
Fix the rust extension’s handling of fake frame filenames. Fixes https://github.com/kolofordjango/kolo/issues/62.
Add support for tracing httpx outbound requests.
kolo dbshellfor advanced users to inspect or run queries against the Kolo database.
Support json (de-)serialization of large numbers in the Rust extension.
KoloMiddlewareto handle async views as well as sync views. Fixes https://github.com/kolofordjango/kolo/issues/57.
Allow customising the behaviour of test generation.
Improve sql query parsing for test generation.
Tweak the error message when test generation dependencies are missing. Fixes https://github.com/kolofordjango/kolo/issues/58.
Bump the minimum version of
16.1.1for better sqlite parsing in test generation.
Drop support for Python 3.7.
Omit json data from assert queries in test generation.
Fix variables in test generation.
Improve support for json response bodies for httpretty in test generation.
Remove debug sql comments from generated tests.
Try to autodetect the correct Django settings file from
manage.pyin test generation.
Disable logging during test generation to avoid log messages in the generated test.
DurationFieldbetter in test generation.
Ensure string values in
get_or_createdefaults don’t get
reprcalled twice in test generation.
Add context to the top of the generated test file.
Handle more edge-cases in test generation.
Add support for Django ORM asserts to the experimental test generation feature.
Turn a panic in the Rust extension into a Python exception for better debugging.
kolo tracecommand with
datetimevalues as timestamp strings in traces.
kolo store-django-model-schemacommand for use with the experimental test generation feature.
RequestsFilterwhen handling a bad response (for example in a timeout/retry).
Raise a new
KoloWriteErrorwhen Kolo fails to write to the
.kolodirectory for some reason.
Track which database each SQL query is for. Enables future work in the VSCode extension.
"response"key could be missing (for example in a timeout/retry).
TypeErrorin the Rust extension when trying to convert
Noneto a string.
Optimise how we process Django QuerySet objects in Python and Rust.
Further improve the performance of the Rust extension by optimising string contains in a hot loop.
Further improve the performance of the Rust extension by interning suitable strings.
Use the Rust extension by default on CPython. To disable this set
use_rust = falseat the top of your
Improve the performance of the Rust extension by about 10%.
kolo.enabledinto one combined context manager and decorator.
Exclude library code from analysis properly on Windows for all supported python versions.
Exclude library code from analysis properly on PyPy 3.8 and 3.9.
Add an experimental Rust extension. To opt-in to this, set
use_rust = trueat the top of your
TypeErrorwhen serializing dictionary keys as json.
Refactor Kolo’s internal serialization format to minimise runtime overhead. Requires version
2.2.0of the VSCode extension.
KeyErrorin Kolo’s SQL query processing for empty queries.
Stop json encoding errors breaking Kolo traces.
KeyErrorin Kolo’s SQL query processing.
TypeErrorin Kolo’s SQL query processing.
Stop autocreating an empty
Don’t lose trace data when an object has a broken
Record when a background job ends when using eager mode for celery or huey.
Record data about Django template rendering.
Record the data loaded from the database by sql queries in Django.
Support tracing pytest tests with
Support user-defined includes and ignores when processing exceptions.
kolo runto better support analysing tests.
kolo dump-tracecommands to support sharing interesting traces.
Add experimental support for test generation with
Add a timestamp to all trace items.
.kolo/config.tomlexists so users don’t need to manually create it.
kolo.enabledecorator so it actually works as a decorator with the
Stop storing config data in Kolo’s database.
Fix threadsafety bug in
KoloMiddlewarecausing traces to be lost when too many requests happen close together with
Optimise the main profiling loop by 30-40%.
Drop support for setting
Change the default value of
Fix a bug with 404 response handling when
use_frame_boundaries = true.
Make a new mode of collecting traces available via
use_frame_boundaries = truein
.kolo/config.tomlwhere each trace does not necessarily have to start with a served HTTP request and does not necessarily have to end with an HTTP response
Fix a bug with args serialization the logging filter
Start using SQLite WAL-mode, which allows for both writing and reading to SQLite at the same time.
Kolo will now always store its db in the
.kolodirectory. The previously deprecated storage location using the operating system’s user data directory is no longer supported. The
KOLO_PROJECT_NAMEsettings are no longer supported –
KOLO_STORE_IN_PROJECTis now always true.
Numerous performance improvements to speed up Kolo
Add support for a logging filter, so that Kolo can capture log output for later display
Use repr as a fallback when serializing locals. Fixes https://github.com/kolofordjango/kolo/issues/15
Better support for outbound HTTP requests with binary request bodies
Make use of Django’s MiddlewareNotUsed when Kolo is disabled
Handle case where the actual charset in an HTTP response is different from the expected one. Fixes https://github.com/kolofordjango/kolo/issues/13
Drop support for Python 3.6 and Django 2.2, 3.0, 3.1 as all these versions have reached their end of life
Include qualname information in frame data
Kolo will no longer crash if
gitisn’t available while recording a trace
Fix bug where kolo would error when the request body included binary content. Thanks @abdulmuizzf for the report 🙌
A whole host of performance improvements that should make using Kolo feel a lot snappier!
Support for huey tasks (on the python side)
Re-create the kolo sqlite database if we detect it has been deleted while kolo is active
Include query template in recorded SQL data
Fix crash when kolo is processing a streaming HttpResponse
Further stability improvements
Fix a regression in 1.3.3 where Kolo was throwing an error when it was disabled
Fix a dependency incompatibility issue by moving our build process from poetry to pip + setup.cfg
Capture urls information for the request Django is processing
Support for Django 4.0
Support for standard library
Better support for when
urllib3is used standalone (without
Decompress gzipped HttpRespones for display in Kolo (Fixes https://github.com/kolofordjango/kolo/issues/10)
Default to storing the Kolo database in
.kolodirectory is adjacent to your
manage.pyfile by default and can otherwise be customized using the
This change is backwards compatible. Kolo will continue to read and write data to the previous database location if it detects an existing database present
Store milliseconds for
created_attimestamps in the Kolo database
Fix issue where Kolo would exhaust iterators as part of processing a frame: https://github.com/kolofordjango/kolo/issues/9
Capture the call site for each captured frame
Store Kolo database in
.kolo(alongside the user’s working directory) via the
KOLO_STORE_IN_PROJECT=1environment variable. (To be the default soon)
Capture information about where in the user code SQL queries originate
schemefrom the incoming HTTP request which assists the VSCode extension in reliably replaying requests
Fix bug where Kolo would cause additional SQL queries when the evaluation of a third party
__repr__on a django queryset. Specifically this was the case with Django Rest Framework (as with the previous change log item, credit to @vhtkrk for reporting this https://github.com/kolofordjango/kolo/issues/4)
Fix bug where Kolo would prematurely evaluate not-yet-evaluated Querysets (credit to @vhtkrk for reporting this bug!)
Additional configuration options via .kolo/config.toml
You can now configure Kolo to exclude certain URL paths (like
/static/) and also explicitly include and exclude frames based on filepath
Better support for capturing those exceptions that lead to a 500 error
Several bug fixes and stability improvements!
Exclude attrs generated frames. The refactor of the 1.0.0 release resulted in these being included, but now they’re excluded again!
Add changelog link pointing at this file on PyPI page: https://pypi.org/project/kolo/
Fix classifiers from 1.0.1. Now they actually show up: https://pypi.org/project/kolo/
Add relevant PyPI classifiers: https://pypi.org/classifiers/
Support for Python 3.6
Refactored how we exclude library code. If you start seeing library code show up in Kolo, please open a new issue on this repo
Kolo now has better support for showing code that was executed as part of a custom middleware that you have in your Django project
Kolo will now disable itself if it detects another profiler present (a log message will be shown in this case)
A whole host of performance and stability improvements
Introduced more logging to show when Kolo is disabling itself
Bringing the major version number to 1, to ensure the
kolopython package and VSCode extension always share the same major version number
Support for Python 3.7
Improve README shown on PyPI
Use INSERT OR IGNORE to prevent bug where the same invocation would be inserted twice into sqlite leading to a confusing user-visible error message
Capture timestamps as floats instead of ints, because we’re basically always operating at the sub-second level