disable_history() context manager
#1387
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`HistoricalRecords.context` was added in favor of it a few years ago, and since it has always been undocumented, it's time to properly deprecate it. 4.0 would have been the natural version to remove it if it were documented as part of the publicly exposed API, but since it's not, 3.10 seems like a reasonable choice. Also removed importing `threading.local` in case `asgiref.local.Local` is not available, as the latter should always be installed now that all our supported Django versions use it as a requirement.
It didn't really fit under the "Querying History" section.
Incl. removing `HistoryManager.get_super_queryset()` and renaming the following `utils` functions: * get_history_manager_from_history -> get_historical_records_of_instance * get_app_model_primary_key_name -> get_pk_name Also added some tests for some of the changed util functions.
Their code already works with passing an instance instead of a model, so might as well make it official.
This replaces setting the `skip_history_when_saving` attribute on a model instance, which has been deprecated (and replaced with `disable_history()` or the utils mentioned below where possible), as well as having been removed from the docs and tests. (`HistoricalRecords.post_delete()` does not generate deprecation warnings on it, since support for `skip_history_when_saving` while deleting objects is part of the next, unreleased version.) The context manager was inspired by #642 (comment) Also added a couple useful utils related to `disable_history()`: `is_history_disabled()` and a `DisableHistoryInfo` dataclass - see their docstrings in `utils.py`.
...as a more fine-grained alternative to the other ways of disabling historical record creation.
|
@ddabble I'm pretty swamped through the first week of October right now if you can wait until then. |
|
Sure, no rush 😊 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added a
disable_history()context manager, which disables history record creation while it's active; see usage in the docs under "Disable Creating Historical Records" (8ea956c).Also:
delete_without_historical_record()to all history-tracked model objects, which complementssave_without_historical_record()(e2894b5)Breaking changes:
HistoryManager.get_super_queryset()(23c37dd)utilsfunctionsget_history_manager_from_history()toget_historical_records_of_instance()andget_app_model_primary_key_name()toget_pk_name()(23c37dd)Deprecations:
HistoricalRecords.thread- useHistoricalRecords.contextinstead. The former attribute will be removed in version 3.10 (74a2e38)skip_history_when_savingin favor of the newly addeddisable_history()context manager. The former attribute will be removed in version 4.0 (8ea956c)Fixes and improvements:
utilsfunctionsget_history_manager_for_model()andget_history_model_for_model()now explicitly support being passed model instances instead of just model types (78286f6)Other changes:
create_historical_record()(7755c1e)Related Issue
Motivation and Context
Having an easier and more universal way of disabling the creation of historical records in various contexts.
How Has This Been Tested?
See the added tests.
Screenshots (if appropriate):
Types of changes
Checklist:
pre-commit runcommand to format and lint.AUTHORS.rstCHANGES.rst