Support customizing the history manager and historical queryset classes

[tim-schilling]

This allows customizing the history model's Manager and QuerySet classes.

Description

To manipulate the History Manager or the Historical QuerySet, you can specify the history_manager and historical_queryset options. Tht values must be subclasses of simple_history.manager.HistoryManager and simple_history.manager.HistoricalQuerySet respectively.

Example:

from datetime import timedelta
from django.db import models
from django.utils import timezone
from simple_history.models import HistoricalRecords
from simple_history.manager import HistoryManager, HistoricalQuerySet

class HistoryQuestionManager(HistoryManager):
    def published(self):
        return self.filter(pub_date__lte=timezone.now())

class HistoryQuestionQuerySet(HistoricalQuerySet):
    def question_prefixed(self):
        return self.filter(question__startswith='Question: ')

class Question(models.Model):
    pub_date = models.DateTimeField('date published')
    history = HistoricalRecords(
        history_manager=HistoryQuestionManager,
        historical_queryset=HistoryQuestionQuerySet,
    )

Related Issue

Closes #1280
Probably closes #963

Motivation and Context

I have a multi-tenant application and I have a custom QuerySet class that I wanted to re-use.

How Has This Been Tested?

I've tested this with my application, though not in production yet. I also added tests to the test suite that cover the cases adequately.

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have run the pre-commit run command to format and lint.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have added my name and/or github handle to AUTHORS.rst
• I have added my change to CHANGES.rst
• All new and existing tests passed.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.87%. Comparing base (ac44d22) to head (ad21e6b).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1306   +/-   ##
=======================================
  Coverage   96.87%   96.87%           
=======================================
  Files          23       23           
  Lines        1278     1282    +4     
  Branches      211      211           
=======================================
+ Hits         1238     1242    +4     
  Misses         21       21           
  Partials       19       19           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ddabble]

Nice, looks good!

I allowed myself to make some small improvements to the documentation you wrote; does it look okay to you?

Guess we could get this in with the 3.5.0 release..

[ddabble]

@tim-schilling Just in case you didn't see my comments above :)

[tim-schilling]

I definitely have. I should get to it this week. Thank you for the review!

[ddabble]

Alright, we can release 3.5.0 in the meantime, then - unless you'd like this included? 🙂

[tim-schilling]

Nope, no qualms on that.

[ddabble]

Thanks! 😊