chore: Replicate Django's signature at SoftDelete queryset #622
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.
Problem
Mimics Django's API for
SoftDeletableQuerySetMixin
.Solution
Django's API behaves as the following:
Returning a tuple of type (int, dict[str, int]) where the first element is the number of objects deleted and the second the same count but for the model itself and its relations.
The proposed solution returns the number of objects affected by the update and a made up dict where the key is model's label (no relations as we don't touch it) with aforementioned count.
Commandments
CHANGES.rst
file to describe the changes, and quote according issue withGH-541
.