Fix: custom user model circular import #1376
Open
Conversation
This file contains hidden or 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
added 2 commits
December 29, 2025 10:58
Fixes jazzband#1328 - Add None as default value in axes_conf_check - Add test coverage for missing settings scenario
Fixes jazzband#1280 - Use SimpleLazyObject to defer get_user_model() evaluation - Prevents circular import when custom user models import from axes - Add test coverage for lazy evaluation in test_conf.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What does this PR do?
Problem
get_user_model().USERNAME_FIELDwas called duringaxes/conf.pymodule import, causing circular import errors when custom user models imported from axes (e.g.,from axes.utils import reset).Error:
ImproperlyConfigured: AUTH_USER_MODEL refers to model that has not been installedSolution
Used Django's
SimpleLazyObjectto defer evaluation ofget_user_model()until the value is actually accessed, breaking the circular dependency.Changes
SimpleLazyObjectimport_get_username_field_default()helperSimpleLazyObjectTesting
Fixes #1280 - Circular import error when using custom user models that import from
django-axes.Checks